mirror of
https://github.com/grafana/grafana.git
synced 2025-02-25 18:55:37 -06:00
Docs: Add documentation for the new encryption providers (#44604)
* Add docs for Google Cloud KMS provider * Minor changes to Google KMS provider * Add docs for Hashicorp Vault provider * Review suggestion Co-authored-by: Mitch Seaman <mjseaman@users.noreply.github.com> * Commit suggested change Co-authored-by: Mitch Seaman <mjseaman@users.noreply.github.com> * Remove confusing instruction * Add example of key file path * Add links to new providers * Add path description Co-authored-by: Mitch Seaman <mjseaman@users.noreply.github.com>
This commit is contained in:
Tania B
GitHub
parent
d87cd6f26c
commit
07d207a3f0
@ -13,5 +13,7 @@ Grafana integrates with the following key management systems:
|
||||
|
||||
- [AWS KMS]({{< relref "/using-aws-kms-to-encrypt-database-secrets.md" >}})
|
||||
- [Azure Key Vault]({{< relref "/using-azure-key-vault-to-encrypt-database-secrets.md" >}})
|
||||
- [Google Cloud KMS]({{< relref "/using-google-cloud-kms-to-encrypt-database-secrets.md" >}})
|
||||
- [Hashicorp Key Vault]({{< relref "/using-hashicorp-key-vault-to-encrypt-database-secrets.md" >}})
|
||||
|
||||
Refer to [Database encryption]({{< relref "../../administration/database-encryption.md" >}}) to learn more about how Grafana encrypts secrets in the database.
|
||||
|
||||
@ -0,0 +1,70 @@
|
||||
+++
|
||||
title = "Google Cloud KMS"
|
||||
description = "Using Google Cloud KMS to encrypt database secrets"
|
||||
keywords = ["grafana", "Google Cloud KMS integration"]
|
||||
weight = 3
|
||||
+++
|
||||
|
||||
# Using Google Cloud KMS to encrypt database secrets
|
||||
|
||||
You can use an encryption key from Google Cloud Key Management Service to encrypt secrets in the Grafana database.
|
||||
|
||||
**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 "../../administration/configuration/#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.
|
||||
|
||||
2. [Create a symmetric encryption key](https://cloud.google.com/kms/docs/creating-keys#create_a_key) in the key ring.
|
||||
|
||||
3. [Create a service account](https://cloud.google.com/iam/docs/creating-managing-service-accounts#creating) and assign it a role: it can be a predefined role or custom role with permissions to encrypt and decrypt secrets with Key Management Service.
|
||||
|
||||
4. [Create a service account key and save its JSON file](https://cloud.google.com/iam/docs/creating-managing-service-account-keys#creating) to you computer, for example, as `~/.config/gcloud/sample-project-credentials.json`.
|
||||
|
||||
5. From within Grafana, turn on [envelope encryption]({{< relref "../../administration/envelope-encryption.md" >}}).
|
||||
|
||||
6. Add your Google Cloud KMS details to the Grafana configuration file; depending on your operating system, is usually named `grafana.ini`:
|
||||
<br><br>a. Add a new section to the configuration file, with a name in the format of `[security.encryption.azurekv.<KEY-NAME>]`, where `<KEY-NAME>` is any name that uniquely identifies this key among other provider keys.
|
||||
<br><br>b. Fill in the section with the following values:
|
||||
<br>
|
||||
|
||||
- `key_id`: encryption key ID, refer to [Getting the ID for a Key](https://cloud.google.com/kms/docs/getting-resource-ids#getting_the_id_for_a_key_and_version).
|
||||
- `credentials_file`: full path to service account key JSON file on your computer.
|
||||
|
||||
An example of a Google Cloud KMS provider section in the `grafana.ini` file is as follows:
|
||||
|
||||
```
|
||||
# Example of Google Cloud KMS provider setup
|
||||
;[security.encryption.googlekms.example-encryption-key]
|
||||
# Google Cloud KMS key ID
|
||||
key_id = 1234abcd-12ab-34cd-56ef-1234567890ab
|
||||
# Full path to a JSON file with a service account key
|
||||
credentials_file = ~/.config/gcloud/sample-project-credentials.json
|
||||
```
|
||||
|
||||
7. Update the `[security]` section of the `grafana.ini` configuration file with the new Encryption Provider key that you created:
|
||||
|
||||
```
|
||||
[security]
|
||||
# previous encryption key, used for legacy alerts, decrypting existing secrets or used as default provider when external providers are not configured
|
||||
secret_key = AaaaAaaa
|
||||
# encryption provider key in the format <PROVIDER>.<KEY-NAME>
|
||||
encryption_provider = googlekms.example-encryption-key
|
||||
# list of configured key providers, space separated
|
||||
available_encryption_providers = googlekms.example-encryption-key
|
||||
```
|
||||
|
||||
**> Note:** The encryption key stored in the `secret_key` field is still used by Grafana’s legacy alerting system to encrypt secrets. Do not change or remove that value.
|
||||
|
||||
8. [Restart Grafana](https://grafana.com/docs/grafana/latest/installation/restart-grafana/).
|
||||
|
||||
9. (Optional) From the command line and the root directory of Grafana Enterprise, re-encrypt all of the secrets within the Grafana database with the new key using the following command:
|
||||
|
||||
`grafana-cli admin secrets-migration re-encrypt`
|
||||
|
||||
If you do not re-encrypt existing secrets, then they will remain encrypted by the previous encryption key. Users will still be able to access them.
|
||||
|
||||
**> Note:** This process could take a few minutes to complete, depending on the number of secrets (such as data sources or alert notification channels) in your database. Users might experience errors while this process is running, and alert notifications might not be sent.
|
||||
|
||||
**> Note:** If you are updating this encryption key during the initial setup of Grafana before any data sources, alert notification channels, or dashboards have been created, then this step is not necessary because there are no secrets in Grafana to migrate.
|
||||
@ -0,0 +1,77 @@
|
||||
+++
|
||||
title = "Hashicorp Vault"
|
||||
description = "Using Hashicorp Vault to encrypt database secrets"
|
||||
keywords = ["grafana", "Hashicorp Vault integration"]
|
||||
weight = 3
|
||||
+++
|
||||
|
||||
# Using Google Cloud KMS to encrypt database secrets
|
||||
|
||||
You can use an encryption key from Google Cloud Key Management Service to encrypt secrets in the Grafana database.
|
||||
|
||||
**Prerequisites:**
|
||||
|
||||
- Permissions to manage Hashicorp Vault to enable secrets engines and issue tokens.
|
||||
- Access to the Grafana [configuration]({{< relref "../../administration/configuration/#config-file-locations" >}}) file
|
||||
|
||||
1. [Enable the transit secrets engine](https://www.vaultproject.io/docs/secrets/transit#setup) in Hashicorp Vault.
|
||||
|
||||
2. [Create a named encryption key](https://www.vaultproject.io/docs/secrets/transit#setup).
|
||||
|
||||
3. [Create a periodic service token](https://learn.hashicorp.com/tutorials/vault/tokens#periodic-service-tokens).
|
||||
|
||||
4. From within Grafana, turn on [envelope encryption]({{< relref "../../administration/envelope-encryption.md" >}}).
|
||||
|
||||
5. Add your Hashicorp Vault details to the Grafana configuration file; depending on your operating system, is usually named `grafana.ini`:
|
||||
<br><br>a. Add a new section to the configuration file, with a name in the format of `[security.encryption.hashicorpvault.<KEY-NAME>]`, where `<KEY-NAME>` is any name that uniquely identifies this key among other provider keys.
|
||||
<br><br>b. Fill in the section with the following values:
|
||||
<br>
|
||||
|
||||
- `token`: a periodic service token used to authenticate within Hashicorp Vault.
|
||||
- `url`: URL of the Hashicorp Vault server.
|
||||
- `transit_engine_path`: mount point of the transit engine.
|
||||
- `key_ring`: name of the encryption key.
|
||||
- `token_renewal_interval`: specifies how often to renew token; should be less than the `period` value of a periodic service token.
|
||||
|
||||
An example of a Hashicorp Vault provider section in the `grafana.ini` file is as follows:
|
||||
|
||||
```
|
||||
# Example of Hashicorp Vault provider setup
|
||||
;[security.encryption.hashicorpvault.example-encryption-key]
|
||||
# Token used to authenticate within Vault. We suggest to use periodic tokens: more on token types https://www.vaultproject.io/docs/concepts/tokens#service-tokens
|
||||
;token =
|
||||
# Location of the Hashicorp Vault server
|
||||
;url = http://localhost:8200
|
||||
# Mount point of the transit secret engine
|
||||
;transit_engine_path = transit
|
||||
# Key ring name
|
||||
;key_ring = grafana-encryption-key
|
||||
# Specifies how often to check if a token needs to be renewed, should be less than a token's period value
|
||||
token_renewal_interval = 5m
|
||||
```
|
||||
|
||||
6. Update the `[security]` section of the `grafana.ini` configuration file with the new Encryption Provider key that you created:
|
||||
|
||||
```
|
||||
[security]
|
||||
# previous encryption key, used for legacy alerts, decrypting existing secrets or used as default provider when external providers are not configured
|
||||
secret_key = AaaaAaaa
|
||||
# encryption provider key in the format <PROVIDER>.<KEY-NAME>
|
||||
encryption_provider = hashicorpvault.example-encryption-key
|
||||
# list of configured key providers, space separated
|
||||
available_encryption_providers = hashicorpvault.example-encryption-key
|
||||
```
|
||||
|
||||
**> Note:** The encryption key stored in the `secret_key` field is still used by Grafana’s legacy alerting system to encrypt secrets. Do not change or remove that value.
|
||||
|
||||
7. [Restart Grafana](https://grafana.com/docs/grafana/latest/installation/restart-grafana/).
|
||||
|
||||
8. (Optional) From the command line and the root directory of Grafana Enterprise, re-encrypt all of the secrets within the Grafana database with the new key using the following command:
|
||||
|
||||
`grafana-cli admin secrets-migration re-encrypt`
|
||||
|
||||
If you do not re-encrypt existing secrets, then they will remain encrypted by the previous encryption key. Users will still be able to access them.
|
||||
|
||||
**> Note:** This process could take a few minutes to complete, depending on the number of secrets (such as data sources or alert notification channels) in your database. Users might experience errors while this process is running, and alert notifications might not be sent.
|
||||
|
||||
**> Note:** If you are updating this encryption key during the initial setup of Grafana before any data sources, alert notification channels, or dashboards have been created, then this step is not necessary because there are no secrets in Grafana to migrate.
|
||||
Loading…
Reference in New Issue
Block a user