Configure Google authentication
Requests from a Grafana plugin to Google are made on behalf of an Identity and Access Management (IAM) role or IAM user. The IAM user or IAM role must have the associated policies to perform certain API actions. Since these policies are specific to each data source, refer to the data source documentation for details.
All requests to Google APIs are performed on the server-side by the Grafana backend. You can authenticate a Grafana plugin to Google by uploading a Google JSON Web Token (JWT) file, or by automatically retrieving credentials from the Google metadata server. The latter option is available only when running Grafana on a GCE virtual machine.
Use a Google Service Account key file
To authenticate the Grafana plugin with the Google API, create a Google Cloud Platform (GCP) Service Account for the Project you want to show data.
Each Grafana data source integrates with one GCP Project. To visualize data from multiple GCP Projects, create one data source per GCP Project.
Create a GCP Service Account and key file
-
Navigate to the APIs and Services Credentials page.
-
Click on the Create credentials dropdown and select the Service account option.
-
In Service account name, enter a name for the account.
-
From the Role dropdown, choose the roles required by the specific plugin.
-
Click Done.
-
Use the newly created account to create a service account key. A JSON key file is created and downloaded to your computer.
-
Store the key file in a secure place, because it grants access to your Google data.
-
In the Grafana data source configuration page, upload the key file. The file’s contents are encrypted and saved in the Grafana database. Remember to save the file after uploading.
Create a GCP service account for multiple projects
You can create a service account and key file that can be used to access multiple projects. Follow steps 1-5 above, then:
-
Note the email address of the service account, it will look a little strange like
[email protected]. -
Navigate to the other project(s) you want to access.
-
Add the service account email address to the IAM page of each project, and grant it the required roles.
-
Navigate back to the original project’s service account and create a service account key. A JSON key file is created and downloaded to your computer
-
Store the key file in a secure place, because it grants access to your Google data.
-
In the Grafana data source configuration page, upload the key file. The file’s contents are encrypted and saved in the Grafana database. Remember to save the file after uploading.
Configure a GCE default service account
When Grafana is running on a Google Compute Engine (GCE) virtual machine, Grafana can automatically retrieve default credentials from the metadata server. As a result, there is no need to generate a private key file for the service account. You also do not need to upload the file to Grafana. The following preconditions must be met before Grafana can retrieve default credentials.
-
You must create a Service Account for use by the GCE virtual machine. For more information, refer to Create new service account.
-
Verify that the GCE virtual machine instance is running as the service account that you created. For more information, refer to setting up an instance to run as a service account.
-
Allow access to the specified API scope.
For more information about creating and enabling service accounts for GCE instances, refer to enabling service accounts for instances in Google documentation.