Skip to content
This repository has been archived by the owner on Feb 1, 2023. It is now read-only.

Latest commit

 

History

History
74 lines (54 loc) · 3.84 KB

credentials.md

File metadata and controls

74 lines (54 loc) · 3.84 KB

Read this on the main serverless docs site

Google - Credentials

The Serverless Framework needs access to account credentials for your Google Cloud account so that it can create and manage resources on your behalf.

Create a Google Cloud Billing Account

You need a Billing Account with a credit card attached to use Google Cloud Functions. Here's how to create one:

  1. Click here, to go to the screen to create a new Billing Account.
  2. Enter the name of the Billing Account and enter your billing information. Then click Submit to enable billing.
  3. A Billing Account will exist already offering you a free trial. Please note that this will not work for Google Cloud Functions. Only a Billing Account with a valid credit card will work.

If necessary, a more detailed guide on creating a Billing Account can be found here.

Create a new Google Cloud Project

A Google Cloud Project is required to use Google Cloud Functions. Here's how to create one:

  1. Go to the Google Cloud Console.
  2. There is a dropdown near the top left of the screen (near the search bar that lists your projects). Click it and select "Create Project".
  3. Enter a Project name and select the Billing Account you created in the steps above (or any Billing Account with a valid credit card attached).
  4. Click on "Create" to start the creation process.
  5. Wait until the Project was successfully created and Google will redirect you to your new Project.
  6. Verify your currently within your new Project by looking at the dropdown next to the search bar. This should mark your new Project as selected.

Enable the necessary APIs

You need to enable the following APIs so that Serverless can create the corresponding resources.

Go to the API dashboard, select your project and enable the following APIs (if not already enabled):

  • Google Cloud Functions
  • Google Cloud Deployment Manager
  • Google Cloud Storage
  • Stackdriver Logging

Get credentials

You need to create credentials Serverless can use to create resources in your Project.

  1. Go to the Google Cloud API Manager and select "Credentials" on the left.
  2. Click on "Create credentials" and select "Service account key".
  3. Select "New service account" in the "Service account" dropdown.
  4. Enter a name for your "Service account name" (e.g. "serverless-framework").
  5. Select "Project" --> "Owner" as the "Role".
  6. The "Key type" should be "JSON".
  7. Click on "Create" to create your private key.
  8. That's your so called keyfile which should be downloaded on your machine.
  9. Save the keyfile somewhere secure. We recommend making a folder in your root folder and putting it there. Like this, ~/.gcloud/keyfile.json. You can change the file name from keyfile to anything. Remember the path you saved it to.

Update the provider config in serverless.yml

Open up your serverless.yml file and update the provider section with your Google Cloud Project id and the path to your keyfile.json file (this path needs to be absolute!). It should look something like this:

provider:
  name: google
  runtime: nodejs
  project: my-serverless-project-1234
  credentials: ~/.gcloud/keyfile.json