Storing the Snapshot Agent Config in Vault

This topic describes how to configure the Consul Helm chart to use a snapshot agent config stored in Vault.

Overview

To use an ACL replication token stored in Vault, we will follow the steps outlined in the Data Integration section:

One time setup in Vault

  1. Store the secret in Vault.
  2. Create a Vault policy that authorizes the desired level of access to the secret.

Setup per Consul datacenter

  1. Create Vault Kubernetes auth roles that link the policy to each Consul on Kubernetes service account that requires access.
  2. Update the Consul on Kubernetes helm chart.

Prerequisites

Prior to setting up the data integration between Vault and Consul on Kubernetes, you will need to have:

  1. Read and completed the steps in the Systems Integration section of Vault as a Secrets Backend.
  2. Read the Data Integration Overview section of Vault as a Secrets Backend.

One time setup in Vault

Store the Secret in Vault

First, store the snapshot agent config in Vault:

  1. $ vault kv put secret/consul/snapshot-agent-config key="<snapshot agent JSON config>"
  1. $ vault kv put secret/consul/snapshot-agent-config key="<snapshot agent JSON config>"

Create a Vault policy that authorizes the desired level of access to the secret

Note: The secret path referenced by the Vault Policy below will be your client.snapshotAgent.configSecret.secretName Helm value.

Next, you will need to create a policy that allows read access to this secret:

  1. path "secret/data/consul/snapshot-agent-config" {
  2.   capabilities = ["read"]
  3. }

Snapshot Agent Config - 图1

snapshot-agent-config-policy.hcl

  1. path "secret/data/consul/snapshot-agent-config" {
  2.   capabilities = ["read"]
  3. }

Apply the Vault policy by issuing the vault policy write CLI command:

  1. $ vault policy write snapshot-agent-config-policy snapshot-agent-config-policy.hcl
  1. $ vault policy write snapshot-agent-config-policy snapshot-agent-config-policy.hcl

Setup per Consul datacenter

Next, you will create a Kubernetes auth role for the Consul snapshot agent:

  1. $ vault write auth/kubernetes/role/consul-server \
  2.     bound_service_account_names=<Consul snapshot agent service account> \
  3.     bound_service_account_namespaces=<Consul installation namespace> \
  4.     policies=snapshot-agent-config-policy \
  5.     ttl=1h
  1. $ vault write auth/kubernetes/role/consul-server \
  2.     bound_service_account_names=<Consul snapshot agent service account> \
  3.     bound_service_account_namespaces=<Consul installation namespace> \
  4.     policies=snapshot-agent-config-policy \
  5.     ttl=1h

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:

  1. $ helm template --release-name ${RELEASE_NAME} -s templates/client-snapshot-agent-serviceaccount.yaml hashicorp/consul
  1. $ helm template --release-name ${RELEASE_NAME} -s templates/client-snapshot-agent-serviceaccount.yaml hashicorp/consul

Update the Consul on Kubernetes helm chart

Now that you have configured Vault, you can configure the Consul Helm chart to use the snapshot agent config in Vault:

  1. global:
  2.   secretsBackend:
  3.     vault:
  4.       enabled: true
  5.       consulSnapshotAgentRole: snapshot-agent
  6. client:
  7.   snapshotAgent:
  8.     configSecret:
  9.       secretName: secret/data/consul/snapshot-agent-config
  10.       secretKey: key

Snapshot Agent Config - 图2

values.yaml

  1. global:
  2.   secretsBackend:
  3.     vault:
  4.       enabled: true
  5.       consulSnapshotAgentRole: snapshot-agent
  6. client:
  7.   snapshotAgent:
  8.     configSecret:
  9.       secretName: secret/data/consul/snapshot-agent-config
  10.       secretKey: key

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.