Documentation
Start typing to search…

GCP onboarding

Get started with Umbrella Cost on GCP by following our onboarding guide, which walks you through the initial steps.

As part of the onboarding process, you'll set up a billing data set with within your GCP environment. This data will be automatically read by Umbrella Cost every day to ensure seamless integration and accurate monitoring of your cloud cost and usage.

⚠️

Note

Before you begin, make sure you have permission to create a billing export and a Service Account in your GCP console.


  1. From the Accounts dropdown list, click Add Account and then click the GCP icon.
  1. Choose how you would like to complete the onboarding:
    • Automatically (coming soon✨)
    • Manually

GCP manual onboarding

The main steps of the onboarding process are as follows

  1. Create a billing dataset on BigQuery
  2. Enable APIs for Umbrella Cost
  3. Create a service account on GCP
  4. Provide access to the BigQuery billing dataset
  5. Onboard your account in Umbrella Cost
  6. Connect an additional project (optional)
  7. Add GKE labels (optional)

Create a billing dataset on Big Query

GCP billing cost data is saved on a BigQuery dataset. To create this dataset and generate the billing report data, follow the steps described in the following GCP article:
https://cloud.google.com/billing/docs/how-to/export-data-bigquery-setup

💡

Note

for the Cloud Billing export choose the Detailed usage cost data type.

After completing this step, make a note of the following information when you enable the cost export:

  • GCP project ID hosting the BigQuery data set
  • Billing dataset name
  • Billing table name

The following image shows how your BigQuery should look on the designated project (the names may be different).


Enable APIs for Umbrella Cost

Enable the Recommender API + Cloud Resource Manager API on the chosen project.

Create a service account on GCP

  1. Choose the project that contains the billing dataset you created in the first step.
  2. Navigate to the IAM & Admin > Service Account page.
  3. Click CREATE SERVICE ACCOUNT.
  1. Provide a name for the service account and click Create and Continue.
  2. In the second step (Grant this service account access to the project), add the following roles, and then click Done:
    • Monitoring Viewer
    • Compute Viewer
    • Compute Recommender Viewer
    • BigQuery Job User
  1. Click on the service account you just created. Navigate to the KEYS tab, and click Create new key.
  1. Choose the JSON key type and click CREATE (this will download a JSON file to your computer).

Make a note of the Service Account email and JSON file. These will be used later on during the account onboarding in the Umbrella Cost UI.

Provide access to the BigQuery billing dataset

  1. Navigate to the BigQuery service and find the dataset you created with the billing export.
  2. Click the three dots next to it and choose Share < Manage Permissions.
  1. Click the ADD PRINCIPAL option. Enter the Service Account email address, add the BigQuery Data Viewer role to it, and click Save.

Onboard your account in Umbrella Cost

Enter the parameters you saved from the previous steps and click on Next.


Connecting additional projects (optional)

Connecting additional projects enables Umbrella Cost to analyze multiple projects in one single authorized service account. Provide the permission at the Organization level so that it will applied to all of the projects at once.

  1. Choose the organization scope.
  1. From the left menu, click on IAM & Admin > IAM, and click GRANT ACCESS.
  1. Under the principal, add the service account email you created for Umbrella Cost, choose the Compute Viewer role permissions, and click Save.

When the account is processed in Umbrella Cost, all projects will be connected and you will see recommendations for them.
You can see the project status under the Accounts > Projects page.


Add K8s labels (optional)

To see your Google Kubernetes Engine (GKE) data in Umbrella Cost:

  1. The project where your clusters are located must be connected to Umbrella Cost. You can find instructions on how to connect them here .
  2. Add your GKE labels. You can find the instructions here .
    Then, enter the project ID (where the GKE dataset is located), and the GKE dataset name, and click on Next. Note: Upon completing GCP instructions, send the following information to Umbrella Cost support:
    • Project ID
    • GKE dataset name
    • Big Query table name (for validation)

Validation and invoice processing

Your GCP account details will be validated by Umbrella Cost, and we will process your billing invoice.
This step can take up to 24 hours. Note that you can close this tab, and we will send you an email once the validation is done and you can see data in the Umbrella Cost platform.


Congratulations!🎊
With this step completed, you're now poised to access data on the Umbrella Cost platform, granting you improved visibility into your cloud environment. Get ready to optimize costs and make informed decisions with ease!


🚨

Important

Time periods in the GCP Cloud Billing report use the Pacific Time Zone (PST) and observe daylight saving time shifts. However, Umbrella uses the UTC time zone. You may notice some cloud cost differences between Umbrella Cost and the GCP Cloud Billing report due to the time zone difference.

Updated 12 days ago

What’s Next