2022-04-07 18:16:24 +00:00
---
layout: docs
page_title: Storing the Snapshot Agent Config in Vault
description: >-
Configuring the Consul Helm chart to use a snapshot agent config stored in Vault.
---
# Storing the Snapshot Agent Config in Vault
2022-06-17 16:23:54 +00:00
This topic describes how to configure the Consul Helm chart to use a snapshot agent config stored in Vault.
2022-04-07 18:16:24 +00:00
## Overview
2023-01-25 16:52:43 +00:00
To use an ACL replication token stored in Vault, follow the steps outlined in the [Data Integration](/consul/docs/k8s/deployment-configurations/vault/data-integration) section.
2022-04-07 18:16:24 +00:00
2022-07-15 16:35:42 +00:00
Complete the following steps once:
2022-04-07 18:16:24 +00:00
1. Store the secret in Vault.
1. Create a Vault policy that authorizes the desired level of access to the secret.
2022-07-15 16:35:42 +00:00
Repeat the following steps for each datacenter in the cluster:
2022-04-07 18:16:24 +00:00
1. Create Vault Kubernetes auth roles that link the policy to each Consul on Kubernetes service account that requires access.
2022-06-17 16:23:54 +00:00
1. Update the Consul on Kubernetes helm chart.
## Prerequisites
2022-11-18 17:33:02 +00:00
Before you set up data integration between Vault and Consul on Kubernetes, complete the following prerequisites:
2023-01-25 16:52:43 +00:00
1. Read and completed the steps in the [Systems Integration](/consul/docs/k8s/deployment-configurations/vault/systems-integration) section of [Vault as a Secrets Backend](/consul/docs/k8s/deployment-configurations/vault).
2. Read the [Data Integration Overview](/consul/docs/k8s/deployment-configurations/vault/data-integration) section of [Vault as a Secrets Backend](/consul/docs/k8s/deployment-configurations/vault).
2022-04-07 18:16:24 +00:00
2022-07-15 16:35:42 +00:00
## Store the Secret in Vault
2022-04-07 18:16:24 +00:00
First, store the snapshot agent config in Vault:
```shell-session
2024-01-05 11:22:56 +00:00
$ vault kv put consul-kv/secret/snapshot-agent-config key="<snapshot agent JSON config>"
2022-04-07 18:16:24 +00:00
```
2022-07-15 16:35:42 +00:00
## Create Vault policy
2022-04-07 18:16:24 +00:00
2022-07-15 16:35:42 +00:00
Next, you will need to create a policy that allows read access to this secret.
2022-04-07 18:16:24 +00:00
2022-07-15 16:35:42 +00:00
The path to the secret referenced in the `path` resource is the same values that you will configure in the `client.snapshotAgent.configSecret.secretName` Helm configuration (refer to [Update Consul on Kubernetes Helm chart](#update-consul-on-kubernetes-helm-chart)).
2022-04-07 18:16:24 +00:00
<CodeBlockConfig filename="snapshot-agent-config-policy.hcl">
```HCL
2024-01-05 11:22:56 +00:00
path "consul-kv/data/secret/snapshot-agent-config" {
2022-04-07 18:16:24 +00:00
capabilities = ["read"]
}
```
</CodeBlockConfig>
Apply the Vault policy by issuing the `vault policy write` CLI command:
```shell-session
$ vault policy write snapshot-agent-config-policy snapshot-agent-config-policy.hcl
```
2022-07-15 16:35:42 +00:00
## Create Vault Authorization Roles for Consul
2022-04-07 18:16:24 +00:00
2022-11-18 17:33:02 +00:00
Next, add this policy to your Consul server Kubernetes auth role:
2022-04-07 18:16:24 +00:00
```shell-session
$ vault write auth/kubernetes/role/consul-server \
2022-11-18 17:33:02 +00:00
bound_service_account_names=<Consul server service account> \
2022-04-07 18:16:24 +00:00
bound_service_account_namespaces=<Consul installation namespace> \
policies=snapshot-agent-config-policy \
ttl=1h
```
2022-11-18 17:33:02 +00:00
Note that if you have other policies associated
with the Consul server service account that are not in the example, you need to include those as well.
2022-04-07 18:16:24 +00:00
To find out the service account name of the Consul snapshot agent,
you can run the following `helm template` command with your Consul on Kubernetes values file:
```shell-session
2022-11-18 17:33:02 +00:00
$ helm template --release-name ${RELEASE_NAME} -s templates/server-serviceaccount.yaml hashicorp/consul -f values.yaml
2022-04-07 18:16:24 +00:00
```
2022-07-15 16:35:42 +00:00
## Update Consul on Kubernetes Helm chart
2022-04-07 18:16:24 +00:00
Now that you have configured Vault, you can configure the Consul Helm chart to
2022-07-15 16:35:42 +00:00
use the snapshot agent configuration in Vault:
2022-04-07 18:16:24 +00:00
<CodeBlockConfig filename="values.yaml">
```yaml
global:
secretsBackend:
vault:
enabled: true
2022-11-18 17:33:02 +00:00
consulServerRole: consul-server
2022-04-07 18:16:24 +00:00
client:
snapshotAgent:
configSecret:
2024-01-05 11:22:56 +00:00
secretName: consul-kv/data/secret/snapshot-agent-config
2022-04-07 18:16:24 +00:00
secretKey: key
```
</CodeBlockConfig>
Note that `client.snapshotAgent.configSecret.secretName` is the path of the secret in Vault.
This should be the same path as the one you included in your Vault policy.
`client.snapshotAgent.configSecret.secretKey` is the key inside the secret data. This should be the same
as the key you passed when creating the snapshot agent config secret in Vault.