restructures directories, correct relrefs (#57131)

This commit is contained in:
Christopher Moyer
2022-10-18 15:06:58 -05:00
committed by GitHub
parent 2a8a82e2af
commit e5fc1b85e0
5 changed files with 11 additions and 11 deletions
@@ -14,7 +14,7 @@ You can use an encryption key from AWS Key Management Service to encrypt secrets
**Prerequisites:**
- An AWS account with permission to view and create KMS keys and programmatic credentials to access those keys
- Access to the Grafana [configuration]({{< relref "../../configure-grafana/#config-file-locations" >}}) file
- Access to the Grafana [configuration]({{< relref "../../../configure-grafana/#config-file-locations" >}}) file
1. Create a symmetric API key either from the AWS Management Console or by using the AWS KMS API.
<br><br>For detailed instructions, refer to [Creating keys](https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html).
@@ -14,7 +14,7 @@ You can use an encryption key from Azure Key Vault to encrypt secrets in the Gra
**Prerequisites:**
- An Azure account with permission to view and create Key Vault keys and programmatic credentials to access those keys
- Access to the Grafana [configuration]({{< relref "../../configure-grafana/#config-file-locations" >}}) file
- Access to the Grafana [configuration]({{< relref "../../../configure-grafana/#config-file-locations" >}}) file
1. [Create a vault](https://docs.microsoft.com/en-us/azure/key-vault/general/quick-create-portal#create-a-vault).
@@ -14,7 +14,7 @@ You can use an encryption key from Google Cloud Key Management Service to encryp
**Prerequisites:**
- A Google Cloud account with permission to list and create KMS keys and service accounts to access those keys
- Access to the Grafana [configuration]({{< relref "../../configure-grafana/#config-file-locations" >}}) file
- Access to the Grafana [configuration]({{< relref "../../../configure-grafana/#config-file-locations" >}}) file
1. [Create a key ring](https://cloud.google.com/kms/docs/creating-keys#kms-create-key-ring-console) in Google Cloud KMS.
@@ -14,7 +14,7 @@ You can use an encryption key from Hashicorp Vault to encrypt secrets in the Gra
**Prerequisites:**
- Permissions to manage Hashicorp Vault to enable secrets engines and issue tokens.
- Access to the Grafana [configuration]({{< relref "../../configure-grafana/#config-file-locations" >}}) file
- Access to the Grafana [configuration]({{< relref "../../../configure-grafana/#config-file-locations" >}}) file
1. [Enable the transit secrets engine](https://www.vaultproject.io/docs/secrets/transit#setup) in Hashicorp Vault.
@@ -10,11 +10,11 @@ weight: 500
# Integrate Grafana with Hashicorp Vault
If you manage your secrets with [Hashicorp Vault](https://www.hashicorp.com/products/vault), you can use them for [Configuration]({{< relref "../../configure-grafana/" >}}) and [Provisioning]({{< relref "../../../administration/provisioning/" >}}).
If you manage your secrets with [Hashicorp Vault](https://www.hashicorp.com/products/vault), you can use them for [Configuration]({{< relref "../../../configure-grafana/" >}}) and [Provisioning]({{< relref "../../../../administration/provisioning/" >}}).
> **Note:** Available in [Grafana Enterprise]({{< relref "../../../enterprise/" >}}) and [Grafana Cloud Advanced]({{< ref "/docs/grafana-cloud" >}}).
> **Note:** Available in [Grafana Enterprise]({{< relref "../../../../introduction/grafana-enterprise/" >}}) and [Grafana Cloud Advanced]({{< ref "/docs/grafana-cloud" >}}).
> **Note:** If you have Grafana [set up for high availability]({{< relref "../../set-up-for-high-availability/" >}}), then we advise not to use dynamic secrets for provisioning files.
> **Note:** If you have Grafana [set up for high availability]({{< relref "../../../set-up-for-high-availability/" >}}), then we advise not to use dynamic secrets for provisioning files.
> Each Grafana instance is responsible for renewing its own leases. Your data source leases might expire when one of your Grafana servers shuts down.
## Configuration
@@ -56,7 +56,7 @@ token = s.sAZLyI0r7sFLMPq6MWtoOhAN # replace with your key
## Using the Vault expander
After you configure Vault, you must set the configuration or provisioning files you wish to
use Vault. Vault configuration is an extension of configuration's [variable expansion]({{< relref "../../configure-grafana/#variable-expansion" >}}) and follows the
use Vault. Vault configuration is an extension of configuration's [variable expansion]({{< relref "../../../configure-grafana/#variable-expansion" >}}) and follows the
`$__vault{<argument>}` syntax.
The argument to Vault consists of three parts separated by a colon:
@@ -94,12 +94,12 @@ $__vault{database:database/creds/grafana:username}
### Examples
The following examples show you how to set your [configuration]({{< relref "../../configure-grafana/" >}}) or [provisioning]({{< relref "../../../administration/provisioning/" >}}) files to use Vault to retrieve configuration values.
The following examples show you how to set your [configuration]({{< relref "../../../configure-grafana/" >}}) or [provisioning]({{< relref "../../../../administration/provisioning/" >}}) files to use Vault to retrieve configuration values.
#### Configuration
The following is a partial example for using Vault to set up a Grafana configuration file's email and database credentials.
Refer to [Configuration]({{< relref "../../configure-grafana/" >}}) for more information.
Refer to [Configuration]({{< relref "../../../configure-grafana/" >}}) for more information.
```ini
[smtp]
@@ -120,7 +120,7 @@ password = $__vault{database:database/creds/grafana:password}
The following is a full examples of a provisioning YAML file setting up a MySQL data source using Vault's
database secrets engine.
Refer to [Provisioning]({{< relref "../../../administration/provisioning/" >}}) for more information.
Refer to [Provisioning]({{< relref "../../../../administration/provisioning/" >}}) for more information.
**provisioning/custom.yaml**