Skip to content

N
nexpie-grafana-theme
Commit 6e0728ad by Daniel Lee Committed by Erik Sundell
Options

stackdriver: some tweaks to the text on the config page and in docs

parent 6abbf5b3
Showing with 9 additions and 9 deletions
docs/sources/features/datasources/stackdriver.md
...@@ -37,7 +37,7 @@ Grafana ships with built-in support for Google Stackdriver. Just add it as a dat ...@@ -37,7 +37,7 @@ Grafana ships with built-in support for Google Stackdriver. Just add it as a dat
There are two ways to authenticate the Stackdriver plugin - either by uploading a Google JWT file, or by automatically retrieving credentials from Google metadata server. The latter option is only available when running Grafana on GCE virtual machine. There are two ways to authenticate the Stackdriver plugin - either by uploading a Google JWT file, or by automatically retrieving credentials from Google metadata server. The latter option is only available when running Grafana on GCE virtual machine.
### Using a Google JWT File ### Using a Google Service Account Key File
To authenticate with the Stackdriver API, you need to create a Google Cloud Platform (GCP) Service Account for the Project you want to show data for. A Grafana datasource integrates with one GCP Project. If you want to visualize data from multiple GCP Projects then you need to create one datasource per GCP Project. To authenticate with the Stackdriver API, you need to create a Google Cloud Platform (GCP) Service Account for the Project you want to show data for. A Grafana datasource integrates with one GCP Project. If you want to visualize data from multiple GCP Projects then you need to create one datasource per GCP Project.
...@@ -78,7 +78,7 @@ Click on the links above and click the `Enable` button: ...@@ -78,7 +78,7 @@ Click on the links above and click the `Enable` button:
### Using GCE Default Service Account ### Using GCE Default Service Account
If Grafana is running on a Google Compute Engine (GCE) virtual machine, it is possible for Grafana to automatically retrieve default credentials from the metadata server. This has the advantage of not needing to generate a private key file for the service account and also not having to upload the file to Grafana. However for this to work, there are a few preconditions that needs to be met. If Grafana is running on a Google Compute Engine (GCE) virtual machine, it is possible for Grafana to automatically retrieve default credentials from the metadata server. This has the advantage of not needing to generate a private key file for the service account and also not having to upload the file to Grafana. However for this to work, there are a few preconditions that need to be met.
1. First of all, you need to create a Service Account that can be used by the GCE virtual machine. See detailed instructions on how to do that [here](https://cloud.google.com/compute/docs/access/create-enable-service-accounts-for-instances#createanewserviceaccount). 1. First of all, you need to create a Service Account that can be used by the GCE virtual machine. See detailed instructions on how to do that [here](https://cloud.google.com/compute/docs/access/create-enable-service-accounts-for-instances#createanewserviceaccount).
2. Make sure the GCE virtual machine instance is being run as the service account that you just created. See instructions [here](https://cloud.google.com/compute/docs/access/create-enable-service-accounts-for-instances#using). 2. Make sure the GCE virtual machine instance is being run as the service account that you just created. See instructions [here](https://cloud.google.com/compute/docs/access/create-enable-service-accounts-for-instances#using).
...@@ -206,7 +206,7 @@ Example Result: `monitoring.googleapis.com/uptime_check/http_status has this val ...@@ -206,7 +206,7 @@ Example Result: `monitoring.googleapis.com/uptime_check/http_status has this val
It's now possible to configure datasources using config files with Grafana's provisioning system. You can read more about how it works and all the settings you can set for datasources on the [provisioning docs page](/administration/provisioning/#datasources) It's now possible to configure datasources using config files with Grafana's provisioning system. You can read more about how it works and all the settings you can set for datasources on the [provisioning docs page](/administration/provisioning/#datasources)
Here is a provisioning example using JWT authentication type. Here is a provisioning example using the JWT (Service Account key file) authentication type.
```yaml ```yaml
apiVersion: 1 apiVersion: 1
......
public/app/plugins/datasource/stackdriver/partials/config.html
<div class="gf-form-group"> <div class="gf-form-group">
<div class="grafana-info-box"> <div class="grafana-info-box">
<h4>Stackdriver Authentication</h4> <h4>Stackdriver Authentication</h4>
<p>There are two ways to authenticate the Stackdriver plugin - either by uploading a Google JWT file, or by <p>There are two ways to authenticate the Stackdriver plugin - either by uploading a Service Account key file, or by
automatically retrieving credentials from Google metadata server. The latter option is only available automatically retrieving credentials from the Google metadata server. The latter option is only available
when running Grafana on GCE virtual machine.</p> when running Grafana on a GCE virtual machine.</p>
<h5>Uploading a JWT file</h5> <h5>Uploading a Service Account Key File</h5>
<p> <p>
First you need to create a Google Cloud Platform (GCP) Service Account for First you need to create a Google Cloud Platform (GCP) Service Account for
the Project you want to show data for. A Grafana datasource integrates with one GCP Project. If you want to the Project you want to show data for. A Grafana datasource integrates with one GCP Project. If you want to
...@@ -20,8 +20,8 @@ ...@@ -20,8 +20,8 @@
<h5>GCE Default Service Account</h5> <h5>GCE Default Service Account</h5>
<p> <p>
If Grafana is running on a Google Compute Engine (GCE) virtual machine, it is possible for Grafana to If Grafana is running on a Google Compute Engine (GCE) virtual machine, it is possible for Grafana to
automatically retrieve default project id and authentication token from the metadata server. In order for this to automatically retrieve the default project id and authentication token from the metadata server. In order for this to
work, you need to make sure that you have a service account that is setup as default account for the virtual work, you need to make sure that you have a service account that is setup as the default account for the virtual
machine and that the service account has been given read access to the Stackdriver Monitoring API. machine and that the service account has been given read access to the Stackdriver Monitoring API.
</p> </p>
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment