You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: content/en/agent/configuration/secrets-management.md
+64-31Lines changed: 64 additions & 31 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -31,7 +31,7 @@ Instead of hardcoding sensitive values like API keys or passwords in plaintext w
31
31
32
32
**Note**: This option is not available for FIPS-enabled Agents at this time.
33
33
34
-
Starting in Agent version `7.70`, the Datadog Agent natively supports several secret management solutions. Two new settings have been introduced to `datadog.yaml`: `secret_backend_type` and `secret_backend_config`.
34
+
Starting in Agent version `7.70`, the Datadog Agent natively supports several secret management solutions. Two new settings have been introduced to `datadog.yaml`: `secret_backend_type` and `secret_backend_config`.
35
35
36
36
`secret_backend_type` is used to specify which secret management solution to use, and `secret_backend_config` holds additional configuration relevant to that solution.
37
37
@@ -44,7 +44,7 @@ secret_backend_config:
44
44
```
45
45
46
46
47
-
More specific setup instructions depend on the backend type used. Refer to the appropriate section bellow for further information:
47
+
More specific setup instructions depend on the backend type used. Refer to the appropriate section bellow for further information:
After configuring the Agent to use AWS Secrets, you can reference any secrets in your configurations with `ENC[secretId;secretKey]`.
83
+
After configuring the Agent to use AWS Secrets, you can reference any secrets in your configurations with `ENC[secretId;secretKey]`.
84
84
85
85
The ENC notation is composed of:
86
86
* `secretId`: either the secret "friendly name" (for example, `/DatadogAgent/Production`) or the ARN (for example, `arn:aws:secretsmanager:us-east-1:123456789012:secret:/DatadogAgent/Production-FOga1K`).
1. Run your HashiCorp Vault. See the [official HashiCorp Vault documentation][3001] for more information.
428
+
1. Run your HashiCorp Vault. See the [official HashiCorp Vault documentation][3001] for more information.
429
429
2. Write a policy that gives the permission to pull secrets from your vault. Create a `*.hcl` file, and include the following permission if using Secrets Engine Version 1:
430
430
```
431
431
path "<your mount path>/<additional subpath>" {
@@ -448,7 +448,7 @@ path "sys/mounts" {
448
448
```
449
449
3. Run `vault policy write <policy_name> <path_to_*.hcl_file>`
450
450
451
-
4. Choose the method of authenticating to your vault. If using the AWS instance profile method, run `vault auth enable aws`.
451
+
4. Choose the method of authenticating to your vault. If using the AWS instance profile method, run `vault auth enable aws`.
452
452
453
453
##### AWS instance profile instructions
454
454
@@ -468,7 +468,7 @@ The following example fetches the API key value from HashiCorp Vault leveraging
### Option 2: Using the built-in Script for Kubernetes and Docker
@@ -833,9 +833,22 @@ On Windows, your executable must:
833
833
834
834
**Note**: Your executable shares the same environment variables as the Agent.
835
835
836
-
## Refreshing API/APP keys at runtime
836
+
## Refreshing secrets at runtime
837
837
838
-
Starting in Agent version v7.67, you can configure the Agent to refresh its API and APP keys at regular intervals without requiring a restart. This relies on the API key and APP key being pulled as secrets.
838
+
Starting in Agent version v7.67, you can configure the Agent to refresh resolved secrets at regular intervals without requiring a restart.
839
+
840
+
Secret refresh can be set as an interval:
841
+
```yaml
842
+
secret_refresh_interval: 3600 # refresh every hour
843
+
```
844
+
845
+
Or triggered manually:
846
+
```shell
847
+
datadog-agent secret refresh
848
+
```
849
+
850
+
### API/APP key refresh
851
+
API/APP keys can be refreshed at runtime if they are pulled as secrets.
839
852
840
853
To enable this, set `secret_refresh_interval` (in seconds) in your `datadog.yaml` file:
841
854
```yaml
@@ -857,9 +870,29 @@ You can disable this behavior by setting:
857
870
secret_refresh_scatter: false
858
871
```
859
872
860
-
To refresh manually, use:
861
-
```
862
-
datadog-agent secret refresh
873
+
### Autodiscovery check secrets refresh
874
+
As of Agent v7.76, scheduled [Autodiscovery][1] checks can refresh secrets at runtime as long as the configured template
0 commit comments