Create GCP API Key for Pricing Data

The OneLens agent uses OpenCost to collect cost allocation data from GKE clusters. OpenCost requires a Google Cloud API key with access to the Cloud Billing API to fetch real-time GCP pricing information, including compute instance rates, storage costs, and network egress.

Without this key, OpenCost cannot retrieve pricing data and the cost metrics collected by the agent will be unavailable.

Prerequisites

• Access to the Google Cloud Console with one of the following:

  • Owner

  • Editor

  • Roles roles/serviceusage.apiKeysAdmin + roles/serviceusage.serviceUsageAdmin

• The GCP project should be linked to a billing account.

Step-by-Step Guide

1

Open Google Cloud Console

Navigate to https://console.cloud.google.com and select the project where your GKE cluster is running.

2

Enable the Cloud Billing API

1. In the left navigation menu, go to APIs & Services → Library.

2. In the search bar, type Cloud Billing API.

3. Click Cloud Billing API from the results.

4. If the API is not already enabled, click Enable.

5. Wait for the API to be enabled. This takes a few seconds.

If the API is already enabled, you will see a Manage button instead of Enable. You can proceed to the next step.

3

Create the API Key

1. In the left navigation menu, go to APIs & Services → Credentials.

2. At the top of the page, click + CREATE CREDENTIALS.

3. Select API key from the dropdown menu.

4. A dialog will appear with your newly created API key.

5. Copy the API key and store it securely. You will need it during OneLens agent installation.

4

Restrict the API Key (Recommended)

Restricting the key ensures it can only be used to access the Cloud Billing API and nothing else.

1. In the API key created dialog, click Edit API key or click the key name in the Credentials list.

2. Under Set an application restriction (optional), select None or configure IP restrictions if your cluster has a fixed egress IP.

3. Under API restrictions:

   • Select Restrict key.

   • Click the Select APIs dropdown.

   • Search for and select Cloud Billing API.

   • Click OK.

4. Click Save at the bottom of the page.

5

Provide the API Key During Installation

Pass the API key as an environment variable when running the OneLens deployer:

--set-string job.env.GCP_API_KEY="<YOUR_API_KEY>"

The installer will automatically configure OpenCost to use this key for fetching GCP pricing data.

What Data Does This Key Access?

The API key OpenCost uses accesses only the following:

Authentication	Data Returned	Used by OpenCost?
API key	Public list prices only	Yes

An API key can only access public pricing data. This is the same pricing information published on Google's service-specific pricing pages, for example, Compute Engine pricing and Cloud Storage pricing. The API key simply provides programmatic access to these public rates.