Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Backport of docs/consul: rename the Vault secret engine for Consul integration into release/1.13.x #20096

Closed
wants to merge 3 commits into from
Closed

Backport of docs/consul: rename the Vault secret engine for Consul integration into release/1.13.x #20096

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a7f7e8a
docs/consul: rename the Vault secret engine for Consul integration (#…
krastin Jan 5, 2024
927e94b
empty commit: restart CDCI
krastin Jan 9, 2024
a617c71
Merge branch 'release/1.13.x' into krastin/vault-for-consul-backport13
krastin Jan 10, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions ...t/docs/k8s/deployment-configurations/vault/data-integration/bootstrap-token.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Prior to setting up the data integration between Vault and Consul on Kubernetes,
First, generate and store the ACL bootstrap token in Vault. You will only need to perform this action once:

```shell-session
$ vault kv put secret/consul/bootstrap-token token="$(uuidgen | tr '[:upper:]' '[:lower:]')"
$ vault kv put consul-kv/secret/bootstrap-token token="$(uuidgen | tr '[:upper:]' '[:lower:]')"
```

## Create Vault policy
Expand All @@ -41,7 +41,7 @@ The path to the secret referenced in the `path` resource is the same value that
<CodeBlockConfig filename="bootstrap-token-policy.hcl">

```HCL
path "secret/data/consul/bootstrap-token" {
path "consul-kv/data/secret/bootstrap-token" {
capabilities = ["read"]
}
```
Expand Down Expand Up @@ -88,7 +88,7 @@ global:
manageSystemACLsRole: consul-server-acl-init
acls:
bootstrapToken:
secretName: secret/data/consul/bootstrap-token
secretName: consul-kv/data/secret/bootstrap-token
secretKey: token
```

Expand Down
6 changes: 3 additions & 3 deletions ...ocs/k8s/deployment-configurations/vault/data-integration/enterprise-license.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Prior to setting up the data integration between Vault and Consul on Kubernetes,
First, store the enterprise license in Vault:

```shell-session
$ vault kv put secret/consul/license key="<enterprise license>"
$ vault kv put consul-kv/secret/enterpriselicense key="<enterprise license>"
```

## Create Vault policy
Expand All @@ -41,7 +41,7 @@ The path to the secret referenced in the `path` resource is the same value that
<CodeBlockConfig filename="license-policy.hcl">

```HCL
path "secret/data/consul/license" {
path "consul-kv/data/secret/enterpriselicense" {
capabilities = ["read"]
}
```
Expand Down Expand Up @@ -103,7 +103,7 @@ global:
consulServerRole: consul-server
consulClientRole: consul-client
enterpriseLicense:
secretName: secret/data/consul/enterpriselicense
secretName: consul-kv/data/secret/enterpriselicense
secretKey: key
```

Expand Down
6 changes: 3 additions & 3 deletions ...te/content/docs/k8s/deployment-configurations/vault/data-integration/gossip.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Prior to setting up the data integration between Vault and Consul on Kubernetes,
First, generate and store the gossip key in Vault. You will only need to perform this action once:

```shell-session
$ vault kv put secret/consul/gossip key="$(consul keygen)"
$ vault kv put consul-kv/secret/gossip key="$(consul keygen)"
```
## Create Vault policy

Expand All @@ -40,7 +40,7 @@ The path to the secret referenced in the `path` resource is the same value that
<CodeBlockConfig filename="gossip-policy.hcl">

```HCL
path "secret/data/consul/gossip" {
path "consul-kv/data/secret/gossip" {
capabilities = ["read"]
}
```
Expand Down Expand Up @@ -101,7 +101,7 @@ global:
consulServerRole: consul-server
consulClientRole: consul-client
gossipEncryption:
secretName: secret/data/consul/gossip
secretName: consul-kv/data/secret/gossip
secretKey: key
```

Expand Down
6 changes: 5 additions & 1 deletion ...ite/content/docs/k8s/deployment-configurations/vault/data-integration/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,10 +122,14 @@ For example, if your Consul on Kubernetes servers need access to [Gossip encrypt

1. Enterprise License

<Note>
Vault API calls to version 2 of the Key-Value secrets engine require the `data` field in the path configuration. In the following example, the key-value data in `consul-kv/secret/enterpriselicense` becomes accessible for Vault API calls on the `consul-kv/data/secret/enterpriselicense` path.
</Note>

<CodeBlockConfig filename="license-policy.hcl">

```HCL
path "secret/data/consul/license" {
path "consul-kv/data/secret/enterpriselicense" {
capabilities = ["read"]
}
```
Expand Down
6 changes: 3 additions & 3 deletions ...t/docs/k8s/deployment-configurations/vault/data-integration/partition-token.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Prior to setting up the data integration between Vault and Consul on Kubernetes,
First, generate and store the ACL partition token in Vault. You will only need to perform this action once:

```shell-session
$ vault kv put secret/consul/partition-token token="$(uuidgen | tr '[:upper:]' '[:lower:]')"
$ vault kv put consul-kv/secret/partition-token token="$(uuidgen | tr '[:upper:]' '[:lower:]')"
```

## Create Vault policy
Expand All @@ -42,7 +42,7 @@ The path to the secret referenced in the `path` resource is the same value that
<CodeBlockConfig filename="partition-token-policy.hcl">

```HCL
path "secret/data/consul/partition-token" {
path "consul-kv/data/secret/consul/partition-token" {
capabilities = ["read"]
}
```
Expand Down Expand Up @@ -90,7 +90,7 @@ global:
adminPartitionsRole: consul-partition-init
acls:
partitionToken:
secretName: secret/data/consul/partition-token
secretName: consul-kv/data/secret/partition-token
secretKey: token
```

Expand Down
6 changes: 3 additions & 3 deletions ...docs/k8s/deployment-configurations/vault/data-integration/replication-token.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Prior to setting up the data integration between Vault and Consul on Kubernetes,
First, generate and store the ACL replication token in Vault. You will only need to perform this action once:

```shell-session
$ vault kv put secret/consul/replication-token token="$(uuidgen | tr '[:upper:]' '[:lower:]')"
$ vault kv put consul-kv/secret/replication-token token="$(uuidgen | tr '[:upper:]' '[:lower:]')"
```

## Create Vault policy
Expand All @@ -41,7 +41,7 @@ The path to the secret referenced in the `path` resource is the same value that
<CodeBlockConfig filename="replication-token-policy.hcl">

```HCL
path "secret/data/consul/replication-token" {
path "consul-kv/data/secret/replication-token" {
capabilities = ["read"]
}
```
Expand Down Expand Up @@ -88,7 +88,7 @@ global:
manageSystemACLsRole: consul-server-acl-init
acls:
replicationToken:
secretName: secret/data/consul/replication-token
secretName: consul-kv/data/secret/replication-token
secretKey: token
```

Expand Down
6 changes: 3 additions & 3 deletions .../k8s/deployment-configurations/vault/data-integration/snapshot-agent-config.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Prior to setting up the data integration between Vault and Consul on Kubernetes,
First, store the snapshot agent config in Vault:

```shell-session
$ vault kv put secret/consul/snapshot-agent-config key="<snapshot agent JSON config>"
$ vault kv put consul-kv/secret/snapshot-agent-config key="<snapshot agent JSON config>"
```

## Create Vault policy
Expand All @@ -41,7 +41,7 @@ The path to the secret referenced in the `path` resource is the same values that
<CodeBlockConfig filename="snapshot-agent-config-policy.hcl">

```HCL
path "secret/data/consul/snapshot-agent-config" {
path "consul-kv/data/secret/snapshot-agent-config" {
capabilities = ["read"]
}
```
Expand Down Expand Up @@ -89,7 +89,7 @@ global:
client:
snapshotAgent:
configSecret:
secretName: secret/data/consul/snapshot-agent-config
secretName: consul-kv/data/secret/snapshot-agent-config
secretKey: key
```

Expand Down
2 changes: 1 addition & 1 deletion website/content/docs/k8s/deployment-configurations/vault/systems-integration.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ The following secrets can be stored in Vault KV secrets engine, which is meant t
In order to store any of these secrets, we must enable the [Vault KV secrets engine - Version 2](https://www.vaultproject.io/docs/secrets/kv/kv-v2).

```shell-session
$ vault secrets enable -path=consul kv-v2
$ vault secrets enable -path=consul-kv kv-v2
```

## Vault PKI Engine
Expand Down
36 changes: 26 additions & 10 deletions website/content/docs/k8s/deployment-configurations/vault/wan-federation.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,7 @@ Repeat the following steps for each datacenter in the cluster:
1. Enable [Vault KV secrets engine - Version 2](https://www.vaultproject.io/docs/secrets/kv/kv-v2) in order to store the [Gossip Encryption Key](/docs/k8s/helm#v-global-acls-replicationtoken) and the ACL Replication token ([`global.acls.replicationToken`](/docs/k8s/helm#v-global-acls-replicationtoken)).

```shell-session
$ vault secrets enable -path=consul kv-v2
$ vault secrets enable -path=consul-kv kv-v2
```

1. Enable Vault PKI Engine in order to leverage Vault for issuing Consul Server TLS certificates.
Expand Down Expand Up @@ -314,12 +314,16 @@ Repeat the following steps for each datacenter in the cluster:
1. Store the ACL Replication Token, Gossip Encryption Key, and Root CA certificate secrets in Vault.

```shell-session
$ vault kv put consul/secret/gossip key="$(consul keygen)"
$ vault kv put consul-kv/secret/gossip key="$(consul keygen)"
```

```shell-session
$ vault kv put consul/secret/replication token="$(uuidgen | tr '[:upper:]' '[:lower:]')"
```
$ vault kv put consul-kv/secret/bootstrap token="$(uuidgen | tr '[:upper:]' '[:lower:]')"
```

```shell-session
$ vault kv put consul-kv/secret/replication token="$(uuidgen | tr '[:upper:]' '[:lower:]')"
```
```shell-session
$ vault write pki/root/generate/internal common_name="Consul CA" ttl=87600h
```
Expand All @@ -328,15 +332,23 @@ Repeat the following steps for each datacenter in the cluster:

```shell-session
$ vault policy write gossip - <<EOF
path "consul/data/secret/gossip" {
path "consul-kv/data/secret/gossip" {
capabilities = ["read"]
}
EOF
```

```shell-session
$ vault policy write bootstrap-token - <<EOF
path "consul-kv/data/secret/bootstrap" {
capabilities = ["read"]
}
EOF
```

```shell-session
$ vault policy write replication-token - <<EOF
path "consul/data/secret/replication" {
path "consul-kv/data/secret/replication" {
capabilities = ["read"]
}
EOF
Expand Down Expand Up @@ -462,11 +474,15 @@ Repeat the following steps for each datacenter in the cluster:
enabled: true
acls:
manageSystemACLs: true
createReplicationToken: true
bootstrapToken:
secretName: consul-kv/data/secret/bootstrap
secretKey: token
replicationToken:
secretName: consul/data/secret/replication
secretName: consul-kv/data/secret/replication
secretKey: token
gossipEncryption:
secretName: consul/data/secret/gossip
secretName: consul-kv/data/secret/gossip
secretKey: key
server:
replicas: 1
Expand Down Expand Up @@ -645,10 +661,10 @@ Repeat the following steps for each datacenter in the cluster:
acls:
manageSystemACLs: true
replicationToken:
secretName: consul/data/secret/replication
secretName: consul-kv/data/secret/replication
secretKey: token
gossipEncryption:
secretName: consul/data/secret/gossip
secretName: consul-kv/data/secret/gossip
secretKey: key
server:
replicas: 1
Expand Down
Loading