scottk/vault
1
0
Fork 0
mirror of https://github.com/optim-enterprises-bv/vault.git synced 2025-11-01 19:17:58 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs/vault-helm: updates for v0.28.0 release (#26282)

Browse Source
This commit is contained in:
Theron Voran
2024-04-12 13:37:56 -07:00
committed by GitHub
parent 8605230df7
commit e4f9d024c8
10 changed files with 24 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
website/content/docs/configuration/service-registration/kubernetes.mdx
View File

@@ -71,7 +71,7 @@ metadata:
vault-initialized: "true" vault-initialized: "true"
vault-perf-standby: "false" vault-perf-standby: "false"
vault-sealed: "false" vault-sealed: "false"
vault-version: 1.15.2 vault-version: 1.16.1
``` ```
After shutdowns, Vault pods will bear the following labels: After shutdowns, Vault pods will bear the following labels:
@@ -86,7 +86,7 @@ metadata:
vault-initialized: "false" vault-initialized: "false"
vault-perf-standby: "false" vault-perf-standby: "false"
vault-sealed: "true" vault-sealed: "true"
vault-version: 1.15.2 vault-version: 1.16.1
``` ```
## Label definitions ## Label definitions
@@ -102,7 +102,7 @@ metadata:
- `vault-sealed` `(string: "true"/"false")` – Vault sealed is updated dynamically each - `vault-sealed` `(string: "true"/"false")` – Vault sealed is updated dynamically each
time Vault's sealed/unsealed status changes. True indicates that Vault is currently sealed. False indicates that Vault time Vault's sealed/unsealed status changes. True indicates that Vault is currently sealed. False indicates that Vault
is currently unsealed. is currently unsealed.
- `vault-version` `(string: "1.15.2")` – Vault version is a string that will not change during a pod's lifecycle. - `vault-version` `(string: "1.16.1")` – Vault version is a string that will not change during a pod's lifecycle.
## Working with vault's service discovery labels ## Working with vault's service discovery labels
@@ -156,7 +156,7 @@ $ vault write -f sys/replication/performance/primary/enable \
In conjunction with the pod labels and the `OnDelete` upgrade strategy, upgrades are much easier to orchestrate: In conjunction with the pod labels and the `OnDelete` upgrade strategy, upgrades are much easier to orchestrate:
```shell-session ```shell-session
$ helm upgrade vault --set='server.image.tag=1.15.2' $ helm upgrade vault --set='server.image.tag=1.16.1'
$ kubectl delete pod --selector=vault-active=false \ $ kubectl delete pod --selector=vault-active=false \
--selector=vault-version=1.2.3 --selector=vault-version=1.2.3

12
website/content/docs/platform/k8s/helm/configuration.mdx
View File

@@ -79,7 +79,7 @@ and consider if they're appropriate for your deployment.
- `repository` (`string: "hashicorp/vault-k8s"`) - The name of the Docker image for Vault Agent Injector. - `repository` (`string: "hashicorp/vault-k8s"`) - The name of the Docker image for Vault Agent Injector.
- `tag` (`string: "1.3.1"`) - The tag of the Docker image for the Vault Agent Injector. **This should be pinned to a specific version when running in production.** Otherwise, other changes to the chart may inadvertently upgrade your admission controller. - `tag` (`string: "1.4.1"`) - The tag of the Docker image for the Vault Agent Injector. **This should be pinned to a specific version when running in production.** Otherwise, other changes to the chart may inadvertently upgrade your admission controller.
- `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. - `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.
@@ -87,7 +87,7 @@ and consider if they're appropriate for your deployment.
- `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. - `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.
- `tag` (`string: "1.15.2"`) - The tag of the Vault Docker image to use for the Vault Agent Sidecar. **Vault 1.3.1+ is required by the admission controller**. - `tag` (`string: "1.16.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**.
- `agentDefaults` - Values that configure the injected Vault Agent containers default values. - `agentDefaults` - Values that configure the injected Vault Agent containers default values.
@@ -351,7 +351,7 @@ and consider if they're appropriate for your deployment.
- `repository` (`string: "hashicorp/vault"`) - The name of the Docker image for the containers running Vault. - `repository` (`string: "hashicorp/vault"`) - The name of the Docker image for the containers running Vault.
- `tag` (`string: "1.15.2"`) - 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. - `tag` (`string: "1.16.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.
- `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. - `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.
@@ -724,6 +724,8 @@ and consider if they're appropriate for your deployment.
"sample/annotation2": "bar" "sample/annotation2": "bar"
``` ```
- `configAnnotation` (`boolean: false`) - Add an annotation to the server configmap and the statefulset pods, `vaultproject.io/config-checksum`, that is a hash of the Vault configuration. This can be used together with an OnDelete deployment strategy to help identify which pods still need to be deleted during a deployment to pick up any configuration changes.
- `service` - Values that configure the Kubernetes service created for Vault. These options are also used for the `active` and `standby` services when [`ha`](#ha) is enabled. - `service` - Values that configure the Kubernetes service created for Vault. These options are also used for the `active` and `standby` services when [`ha`](#ha) is enabled.
- `enabled` (`boolean: true`) - When set to `true`, a Kubernetes service will be created for Vault. - `enabled` (`boolean: true`) - When set to `true`, a Kubernetes service will be created for Vault.
@@ -1088,7 +1090,7 @@ and consider if they're appropriate for your deployment.
- `repository` (`string: "hashicorp/vault-csi-provider"`) - The name of the Docker image for the Vault CSI Provider. - `repository` (`string: "hashicorp/vault-csi-provider"`) - The name of the Docker image for the Vault CSI Provider.
- `tag` (`string: "1.4.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. - `tag` (`string: "1.4.2"`) - 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.
- `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. - `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.
@@ -1237,7 +1239,7 @@ and consider if they're appropriate for your deployment.
- `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. - `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.
- `tag` (`string: "1.15.2"`) - The tag of the Vault Docker image to use for the Vault Agent Sidecar. - `tag` (`string: "1.16.1"`) - The tag of the Vault Docker image to use for the Vault Agent Sidecar.
- `logFormat` (`string: "standard"`) - - `logFormat` (`string: "standard"`) -
- `logLevel` (`string: "info"`) - - `logLevel` (`string: "info"`) -

2
website/content/docs/platform/k8s/helm/enterprise.mdx
View File

@@ -33,7 +33,7 @@ In your chart overrides, set the values of [`server.image`](/vault/docs/platform
server: server:
image: image:
repository: hashicorp/vault-enterprise repository: hashicorp/vault-enterprise
tag: 1.15.2-ent tag: 1.16.1-ent
enterpriseLicense: enterpriseLicense:
secretName: vault-ent-license secretName: vault-ent-license
``` ```

4
website/content/docs/platform/k8s/helm/examples/enterprise-dr-with-raft.mdx
View File

@@ -23,7 +23,7 @@ First, create the primary cluster:
```shell ```shell
helm install vault-primary hashicorp/vault \ helm install vault-primary hashicorp/vault \
--set='server.image.repository=hashicorp/vault-enterprise' \ --set='server.image.repository=hashicorp/vault-enterprise' \
--set='server.image.tag=1.15.2-ent' \ --set='server.image.tag=1.16.1-ent' \
--set='server.ha.enabled=true' \ --set='server.ha.enabled=true' \
--set='server.ha.raft.enabled=true' --set='server.ha.raft.enabled=true'
``` ```
@@ -75,7 +75,7 @@ disaster recovery replication.
```shell ```shell
helm install vault-secondary hashicorp/vault \ helm install vault-secondary hashicorp/vault \
--set='server.image.repository=hashicorp/vault-enterprise' \ --set='server.image.repository=hashicorp/vault-enterprise' \
--set='server.image.tag=1.15.2-ent' \ --set='server.image.tag=1.16.1-ent' \
--set='server.ha.enabled=true' \ --set='server.ha.enabled=true' \
--set='server.ha.raft.enabled=true' --set='server.ha.raft.enabled=true'
``` ```

4
website/content/docs/platform/k8s/helm/examples/enterprise-perf-with-raft.mdx
View File

@@ -23,7 +23,7 @@ First, create the primary cluster:
```shell ```shell
helm install vault-primary hashicorp/vault \ helm install vault-primary hashicorp/vault \
--set='server.image.repository=hashicorp/vault-enterprise' \ --set='server.image.repository=hashicorp/vault-enterprise' \
--set='server.image.tag=1.15.2-ent' \ --set='server.image.tag=1.16.1-ent' \
--set='server.ha.enabled=true' \ --set='server.ha.enabled=true' \
--set='server.ha.raft.enabled=true' --set='server.ha.raft.enabled=true'
``` ```
@@ -74,7 +74,7 @@ With the primary cluster created, next create a secondary cluster.
```shell ```shell
helm install vault-secondary hashicorp/vault \ helm install vault-secondary hashicorp/vault \
--set='server.image.repository=hashicorp/vault-enterprise' \ --set='server.image.repository=hashicorp/vault-enterprise' \
--set='server.image.tag=1.15.2-ent' \ --set='server.image.tag=1.16.1-ent' \
--set='server.ha.enabled=true' \ --set='server.ha.enabled=true' \
--set='server.ha.raft.enabled=true' --set='server.ha.raft.enabled=true'
``` ```

2
website/content/docs/platform/k8s/helm/examples/enterprise-with-raft.mdx
View File

@@ -15,7 +15,7 @@ Integrated Storage (raft) can be enabled using the `server.ha.raft.enabled` valu
```shell ```shell
helm install vault hashicorp/vault \ helm install vault hashicorp/vault \
--set='server.image.repository=hashicorp/vault-enterprise' \ --set='server.image.repository=hashicorp/vault-enterprise' \
--set='server.image.tag=1.15.2-ent' \ --set='server.image.tag=1.16.1-ent' \
--set='server.ha.enabled=true' \ --set='server.ha.enabled=true' \
--set='server.ha.raft.enabled=true' --set='server.ha.raft.enabled=true'
``` ```

4
website/content/docs/platform/k8s/helm/run.mdx
View File

@@ -409,14 +409,14 @@ Next, list the Helm versions and choose the desired version to install.
```bash ```bash
$ helm search repo hashicorp/vault $ helm search repo hashicorp/vault
NAME CHART VERSION APP VERSION DESCRIPTION NAME CHART VERSION APP VERSION DESCRIPTION
hashicorp/vault 0.27.0 1.15.2 Official HashiCorp Vault Chart hashicorp/vault 0.28.0 1.16.1 Official HashiCorp Vault Chart
``` ```
Next, test the upgrade with `--dry-run` first to verify the changes sent to the Next, test the upgrade with `--dry-run` first to verify the changes sent to the
Kubernetes cluster. Kubernetes cluster.
```shell-session ```shell-session
$ helm upgrade vault hashicorp/vault --version=0.27.0 \ $ helm upgrade vault hashicorp/vault --version=0.28.0 \
--set='server.image.repository=vault' \ --set='server.image.repository=vault' \
--set='server.image.tag=123.456' \ --set='server.image.tag=123.456' \
--dry-run --dry-run

2
website/content/docs/platform/k8s/injector/annotations.mdx
View File

@@ -28,7 +28,7 @@ them, optional commands to run, etc.
- `vault.hashicorp.com/agent-image` - name of the Vault docker image to use. This - `vault.hashicorp.com/agent-image` - name of the Vault docker image to use. This
value overrides the default image configured in the injector and is usually value overrides the default image configured in the injector and is usually
not needed. Defaults to `hashicorp/vault:1.15.6`. not needed. Defaults to `hashicorp/vault:1.16.1`.
- `vault.hashicorp.com/agent-init-first` - configures the pod to run the Vault Agent - `vault.hashicorp.com/agent-init-first` - configures the pod to run the Vault Agent
init container first if `true` (last if `false`). This is useful when other init init container first if `true` (last if `false`). This is useful when other init

6
website/content/partials/helm/install.mdx
View File

@@ -2,6 +2,7 @@
# List the available releases # List the available releases
$ helm search repo hashicorp/vault -l $ helm search repo hashicorp/vault -l
NAME CHART VERSION APP VERSION DESCRIPTION NAME CHART VERSION APP VERSION DESCRIPTION
hashicorp/vault 0.28.0 1.16.1 Official HashiCorp Vault Chart
hashicorp/vault 0.27.0 1.15.2 Official HashiCorp Vault Chart hashicorp/vault 0.27.0 1.15.2 Official HashiCorp Vault Chart
hashicorp/vault 0.26.1 1.15.1 Official HashiCorp Vault Chart hashicorp/vault 0.26.1 1.15.1 Official HashiCorp Vault Chart
hashicorp/vault 0.26.0 1.15.1 Official HashiCorp Vault Chart hashicorp/vault 0.26.0 1.15.1 Official HashiCorp Vault Chart
@@ -9,9 +10,8 @@ hashicorp/vault 0.25.0 1.14.0 Official HashiCorp Vault Chart
hashicorp/vault 0.24.0 1.13.1 Official HashiCorp Vault Chart hashicorp/vault 0.24.0 1.13.1 Official HashiCorp Vault Chart
hashicorp/vault 0.23.0 1.12.1 Official HashiCorp Vault Chart hashicorp/vault 0.23.0 1.12.1 Official HashiCorp Vault Chart
hashicorp/vault 0.22.1 1.12.0 Official HashiCorp Vault Chart hashicorp/vault 0.22.1 1.12.0 Official HashiCorp Vault Chart
hashicorp/vault 0.22.0 1.11.3 Official HashiCorp Vault Chart
... ...
# Install version 0.27.0 # Install version 0.28.0
$ helm install vault hashicorp/vault --version 0.27.0 $ helm install vault hashicorp/vault --version 0.28.0
``` ```

2
website/content/partials/helm/repo.mdx
View File

@@ -4,5 +4,5 @@ $ helm repo add hashicorp https://helm.releases.hashicorp.com
$ helm search repo hashicorp/vault $ helm search repo hashicorp/vault
NAME CHART VERSION APP VERSION DESCRIPTION NAME CHART VERSION APP VERSION DESCRIPTION
hashicorp/vault 0.27.0 1.15.2 Official HashiCorp Vault Chart hashicorp/vault 0.28.0 1.16.1 Official HashiCorp Vault Chart
``` ```