Skip to content

Commit f1e496c

Browse files
authored
vault: updating helm docs for v0.31.0 release (#1007)
1 parent 04c1f2b commit f1e496c

File tree

9 files changed

+47
-25
lines changed

9 files changed

+47
-25
lines changed

content/vault/v1.20.x/content/docs/configuration/service-registration/kubernetes.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ metadata:
7070
vault-initialized: "true"
7171
vault-perf-standby: "false"
7272
vault-sealed: "false"
73-
vault-version: 1.20.1
73+
vault-version: 1.20.4
7474
```
7575

7676
After shutdowns, Vault pods will bear the following labels:
@@ -85,7 +85,7 @@ metadata:
8585
vault-initialized: "false"
8686
vault-perf-standby: "false"
8787
vault-sealed: "true"
88-
vault-version: 1.20.1
88+
vault-version: 1.20.4
8989
```
9090

9191
## Label definitions
@@ -101,7 +101,7 @@ metadata:
101101
- `vault-sealed` `(string: "true"/"false")` – Vault sealed is updated dynamically each
102102
time Vault's sealed/unsealed status changes. True indicates that Vault is currently sealed. False indicates that Vault
103103
is currently unsealed.
104-
- `vault-version` `(string: "1.20.1")` – Vault version is a string that will not change during a pod's lifecycle.
104+
- `vault-version` `(string: "1.20.4")` – Vault version is a string that will not change during a pod's lifecycle.
105105

106106
## Working with vault's service discovery labels
107107

@@ -117,7 +117,7 @@ metadata:
117117
labels:
118118
app.kubernetes.io/instance: vault
119119
app.kubernetes.io/name: vault
120-
helm.sh/chart: vault-0.30.1
120+
helm.sh/chart: vault-0.31.0
121121
name: vault-active-us-east
122122
namespace: default
123123
spec:
@@ -155,7 +155,7 @@ $ vault write -f sys/replication/performance/primary/enable \
155155
In conjunction with the pod labels and the `OnDelete` upgrade strategy, upgrades are much easier to orchestrate:
156156

157157
```shell-session
158-
$ helm upgrade vault --set='server.image.tag=1.20.1'
158+
$ helm upgrade vault --set='server.image.tag=1.20.4'
159159
160160
$ kubectl delete pod --selector=vault-active=false \
161161
--selector=vault-version=1.2.3

content/vault/v1.20.x/content/docs/deploy/kubernetes/helm/configuration.mdx

Lines changed: 28 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ and consider if they're appropriate for your deployment.
8787

8888
- `repository` (`string: "hashicorp/vault"`) - The name of the Docker image for the Vault Agent sidecar. This should be set to the official Vault Docker image.
8989
90-
- `tag` (`string: "1.20.1"`) - The tag of the Vault Docker image to use for the Vault Agent Sidecar. **Vault 1.3.1+ is required by the admission controller**.
90+
- `tag` (`string: "1.20.4"`) - The tag of the Vault Docker image to use for the Vault Agent Sidecar. **Vault 1.3.1+ is required by the admission controller**.
9191

9292
- `agentDefaults` - Values that configure the injected Vault Agent containers default values.
9393

@@ -351,7 +351,7 @@ and consider if they're appropriate for your deployment.
351351

352352
- `repository` (`string: "hashicorp/vault"`) - The name of the Docker image for the containers running Vault.
353353
354-
- `tag` (`string: "1.20.1"`) - The tag of the Docker image for the containers running Vault. **This should be pinned to a specific version when running in production.** Otherwise, other changes to the chart may inadvertently upgrade your admission controller.
354+
- `tag` (`string: "1.20.4"`) - The tag of the Docker image for the containers running Vault. **This should be pinned to a specific version when running in production.** Otherwise, other changes to the chart may inadvertently upgrade your admission controller.
355355

356356
- `pullPolicy` (`string: "IfNotPresent"`) - The pull policy for container images. The default pull policy is `IfNotPresent` which causes the Kubelet to skip pulling an image if it already exists.
357357

@@ -1099,7 +1099,7 @@ and consider if they're appropriate for your deployment.
10991099

11001100
- `repository` (`string: "hashicorp/vault-csi-provider"`) - The name of the Docker image for the Vault CSI Provider.
11011101
1102-
- `tag` (`string: "1.5.1"`) - The tag of the Docker image for the Vault CSI Provider.. **This should be pinned to a specific version when running in production.** Otherwise, other changes to the chart may inadvertently upgrade your CSI provider.
1102+
- `tag` (`string: "1.6.0"`) - The tag of the Docker image for the Vault CSI Provider.. **This should be pinned to a specific version when running in production.** Otherwise, other changes to the chart may inadvertently upgrade your CSI provider.
11031103

11041104
- `pullPolicy` (`string: "IfNotPresent"`) - The pull policy for container images. The default pull policy is `IfNotPresent` which causes the Kubelet to skip pulling an image if it already exists locally.
11051105

@@ -1159,11 +1159,11 @@ and consider if they're appropriate for your deployment.
11591159

11601160
- `extraLabels` (`dictionary: {}`) - This value defines additional labels for the CSI provider daemonset.
11611161

1162-
- `providersDir` (`string: "/etc/kubernetes/secrets-store-csi-providers"`) - Provider host path (must match the CSI provider's path)
1162+
- `providersDir` (`string: "/var/run/secrets-store-csi-providers"`) - Provider host path (must match the CSI provider's path)
11631163
11641164
- `kubeletRootDir` (`string: "/var/lib/kubelet"`) - Kubelet host path
11651165

1166-
- `securityContext` - Security context for the pod template and container in the csi provider daemonSet
1166+
- `securityContext` - Security context for the pod template and container in the csi provider daemonSet. If `global.openshift=true`, the container securityContext defaults to `privileged: true`.
11671167

11681168
- `pod` (`dictionary: {}`) - Pod-level securityContext. May be specified as YAML or a YAML-formatted multi-line templated string.
11691169

@@ -1255,7 +1255,7 @@ and consider if they're appropriate for your deployment.
12551255

12561256
- `repository` (`string: "hashicorp/vault"`) - The name of the Docker image for the Vault Agent sidecar. This should be set to the official Vault Docker image.
12571257
1258-
- `tag` (`string: "1.20.1"`) - The tag of the Vault Docker image to use for the Vault Agent Sidecar.
1258+
- `tag` (`string: "1.20.4"`) - The tag of the Vault Docker image to use for the Vault Agent Sidecar.
12591259

12601260
- `logFormat` (`string: "standard"`) -
12611261
- `logLevel` (`string: "info"`) -
@@ -1270,6 +1270,20 @@ and consider if they're appropriate for your deployment.
12701270
cpu: '250m'
12711271
```
12721272

1273+
- `securityContext`
1274+
- `container` (`dictionary: {}`) - Security context for the Vault Agent sidecar container. Defaults to:
1275+
1276+
```yaml
1277+
allowPrivilegeEscalation: false
1278+
capabilities:
1279+
drop:
1280+
- ALL
1281+
readOnlyRootFilesystem: true
1282+
runAsNonRoot: true
1283+
runAsUser: 100
1284+
runAsGroup: 1000
1285+
```
1286+
12731287
- `serverTelemetry` - Values the configure metrics and telemetry. Enabling these features requires setting
12741288
the `telemetry {}` stanza in the Vault configuration. See the [telemetry](/vault/docs/configuration/telemetry)
12751289
[docs](/vault/docs/internals/telemetry) for more on the Vault configuration.
@@ -1342,6 +1356,14 @@ and consider if they're appropriate for your deployment.
13421356
key: token
13431357
```
13441358

1359+
- `metricRelabelings` (`array: []`) - Metric relabeling rules to apply to samples before ingestion. See the prometheus [API reference](https://prometheus-operator.dev/docs/api-reference/api/#monitoring.coreos.com/v1.RelabelConfig) for more details. Example:
1360+
1361+
```yaml
1362+
metricRelabelings:
1363+
- sourceLabels: [cluster]
1364+
targetLabel: vault_cluster
1365+
```
1366+
13451367
- `prometheusRules` - Values that configure Prometheus rules.
13461368

13471369
- `enabled` (`boolean: false`) - Deploy the PrometheusRule custom resource for AlertManager-based

content/vault/v1.20.x/content/docs/deploy/kubernetes/helm/enterprise.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ In your chart overrides, set the values of [`server.image`](/vault/docs/platform
3333
server:
3434
image:
3535
repository: hashicorp/vault-enterprise
36-
tag: 1.20.1-ent
36+
tag: 1.20.4-ent
3737
enterpriseLicense:
3838
secretName: vault-ent-license
3939
```

content/vault/v1.20.x/content/docs/deploy/kubernetes/helm/examples/enterprise-dr-with-raft.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ First, create the primary cluster:
2323
```shell
2424
helm install vault-primary hashicorp/vault \
2525
--set='server.image.repository=hashicorp/vault-enterprise' \
26-
--set='server.image.tag=1.20.1-ent' \
26+
--set='server.image.tag=1.20.4-ent' \
2727
--set='server.ha.enabled=true' \
2828
--set='server.ha.raft.enabled=true'
2929
```
@@ -75,7 +75,7 @@ disaster recovery replication.
7575
```shell
7676
helm install vault-secondary hashicorp/vault \
7777
--set='server.image.repository=hashicorp/vault-enterprise' \
78-
--set='server.image.tag=1.20.1-ent' \
78+
--set='server.image.tag=1.20.4-ent' \
7979
--set='server.ha.enabled=true' \
8080
--set='server.ha.raft.enabled=true'
8181
```

content/vault/v1.20.x/content/docs/deploy/kubernetes/helm/examples/enterprise-perf-with-raft.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ First, create the primary cluster:
2323
```shell
2424
helm install vault-primary hashicorp/vault \
2525
--set='server.image.repository=hashicorp/vault-enterprise' \
26-
--set='server.image.tag=1.20.1-ent' \
26+
--set='server.image.tag=1.20.4-ent' \
2727
--set='server.ha.enabled=true' \
2828
--set='server.ha.raft.enabled=true'
2929
```
@@ -74,7 +74,7 @@ With the primary cluster created, next create a secondary cluster.
7474
```shell
7575
helm install vault-secondary hashicorp/vault \
7676
--set='server.image.repository=hashicorp/vault-enterprise' \
77-
--set='server.image.tag=1.20.1-ent' \
77+
--set='server.image.tag=1.20.4-ent' \
7878
--set='server.ha.enabled=true' \
7979
--set='server.ha.raft.enabled=true'
8080
```

content/vault/v1.20.x/content/docs/deploy/kubernetes/helm/examples/enterprise-with-raft.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Integrated Storage (raft) can be enabled using the `server.ha.raft.enabled` valu
1515
```shell
1616
helm install vault hashicorp/vault \
1717
--set='server.image.repository=hashicorp/vault-enterprise' \
18-
--set='server.image.tag=1.20.1-ent' \
18+
--set='server.image.tag=1.20.4-ent' \
1919
--set='server.ha.enabled=true' \
2020
--set='server.ha.raft.enabled=true'
2121
```

content/vault/v1.20.x/content/docs/deploy/kubernetes/helm/run.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -409,14 +409,14 @@ Next, list the Helm versions and choose the desired version to install.
409409
```bash
410410
$ helm search repo hashicorp/vault
411411
NAME CHART VERSION APP VERSION DESCRIPTION
412-
hashicorp/vault 0.30.1 1.20.1 Official HashiCorp Vault Chart
412+
hashicorp/vault 0.31.0 1.20.4 Official HashiCorp Vault Chart
413413
```
414414

415415
Next, test the upgrade with `--dry-run` first to verify the changes sent to the
416416
Kubernetes cluster.
417417

418418
```shell-session
419-
$ helm upgrade vault hashicorp/vault --version=0.30.1 \
419+
$ helm upgrade vault hashicorp/vault --version=0.31.0 \
420420
--set='server.image.repository=vault' \
421421
--set='server.image.tag=123.456' \
422422
--dry-run

content/vault/v1.20.x/content/partials/helm/install.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,16 @@
22
# List the available releases
33
$ helm search repo hashicorp/vault -l
44
NAME CHART VERSION APP VERSION DESCRIPTION
5-
hashicorp/vault 0.30.1 1.20.1 Official HashiCorp Vault Chart
6-
hashicorp/vault 0.30.0 1.19.0 Official HashiCorp Vault Chart
5+
hashicorp/vault 0.31.0 1.20.4 Official HashiCorp Vault Chart
6+
hashicorp/vault 0.30.1 1.20.1 Official HashiCorp Vault Chart
7+
hashicorp/vault 0.30.0 1.19.0 Official HashiCorp Vault Chart
78
hashicorp/vault 0.29.1 1.18.1 Official HashiCorp Vault Chart
89
hashicorp/vault 0.29.0 1.18.1 Official HashiCorp Vault Chart
910
hashicorp/vault 0.28.1 1.17.2 Official HashiCorp Vault Chart
1011
hashicorp/vault 0.28.0 1.16.1 Official HashiCorp Vault Chart
1112
hashicorp/vault 0.27.0 1.15.2 Official HashiCorp Vault Chart
12-
hashicorp/vault 0.26.1 1.15.1 Official HashiCorp Vault Chart
1313
...
1414

15-
# Install version 0.30.1
16-
$ helm install vault hashicorp/vault --version 0.30.1
15+
# Install version 0.31.0
16+
$ helm install vault hashicorp/vault --version 0.31.0
1717
```

content/vault/v1.20.x/content/partials/helm/repo.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,5 +4,5 @@ $ helm repo add hashicorp https://helm.releases.hashicorp.com
44
55
$ helm search repo hashicorp/vault
66
NAME CHART VERSION APP VERSION DESCRIPTION
7-
hashicorp/vault 0.30.1 1.20.1 Official HashiCorp Vault Chart
7+
hashicorp/vault 0.31.0 1.20.4 Official HashiCorp Vault Chart
88
```

0 commit comments

Comments
 (0)