Update documentation for vault-helm v0.22.1 release (#17695)

hashicorp · Oct 28, 2022 · 965f8c2 · 965f8c2
1 parent c56b198
commit 965f8c2
Show file tree

Hide file tree

Showing 10 changed files with 34 additions and 28 deletions.
diff --git a/website/content/docs/configuration/service-registration/kubernetes.mdx b/website/content/docs/configuration/service-registration/kubernetes.mdx
@@ -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:
 
 ```shell-session
-$ helm upgrade vault --set='server.image.tag=1.11.3'
+$ helm upgrade vault --set='server.image.tag=1.12.0'
 
 $ kubectl delete pod --selector=vault-active=false \
     --selector=vault-version=1.2.3

diff --git a/website/content/docs/platform/k8s/helm/configuration.mdx b/website/content/docs/platform/k8s/helm/configuration.mdx
@@ -77,15 +77,15 @@ and consider if they're appropriate for your deployment.
 
     - `repository` (`string: "hashicorp/vault-k8s"`) - The name of the Docker image for Vault Agent Injector.
 
-    - `tag` (`string: "1.0.0"`) - 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.0.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.
 
   - `agentImage` - Values that configure the Vault Agent sidecar 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.11.3"`) - 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.12.0"`) - 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.
 
@@ -309,7 +309,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.
 
-    - `tag` (`string: "1.11.3"`) - 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.12.0"`) - 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.
 

diff --git a/website/content/docs/platform/k8s/helm/enterprise.mdx b/website/content/docs/platform/k8s/helm/enterprise.mdx
@@ -33,7 +33,7 @@ In your chart overrides, set the values of [`server.image`](/docs/platform/k8s/h
 server:
   image:
     repository: hashicorp/vault-enterprise
-    tag: 1.11.3-ent
+    tag: 1.12.0-ent
   enterpriseLicense:
     secretName: vault-ent-license
 ```

diff --git a/website/content/docs/platform/k8s/helm/examples/enterprise-dr-with-raft.mdx b/website/content/docs/platform/k8s/helm/examples/enterprise-dr-with-raft.mdx
@@ -23,7 +23,7 @@ First, create the primary cluster:
 ```shell
 helm install vault-primary hashicorp/vault \
   --set='server.image.repository=hashicorp/vault-enterprise' \
-  --set='server.image.tag=1.11.3-ent' \
+  --set='server.image.tag=1.12.0-ent' \
   --set='server.ha.enabled=true' \
   --set='server.ha.raft.enabled=true'
 ```
@@ -75,7 +75,7 @@ disaster recovery replication.
 ```shell
 helm install vault-secondary hashicorp/vault \
   --set='server.image.repository=hashicorp/vault-enterprise' \
-  --set='server.image.tag=1.11.3-ent' \
+  --set='server.image.tag=1.12.0-ent' \
   --set='server.ha.enabled=true' \
   --set='server.ha.raft.enabled=true'
 ```

diff --git a/website/content/docs/platform/k8s/helm/examples/enterprise-perf-with-raft.mdx b/website/content/docs/platform/k8s/helm/examples/enterprise-perf-with-raft.mdx
@@ -23,7 +23,7 @@ First, create the primary cluster:
 ```shell
 helm install vault-primary hashicorp/vault \
   --set='server.image.repository=hashicorp/vault-enterprise' \
-  --set='server.image.tag=1.11.3-ent' \
+  --set='server.image.tag=1.12.0-ent' \
   --set='server.ha.enabled=true' \
   --set='server.ha.raft.enabled=true'
 ```
@@ -74,7 +74,7 @@ With the primary cluster created, next create a secondary cluster.
 ```shell
 helm install vault-secondary hashicorp/vault \
   --set='server.image.repository=hashicorp/vault-enterprise' \
-  --set='server.image.tag=1.11.3-ent' \
+  --set='server.image.tag=1.12.0-ent' \
   --set='server.ha.enabled=true' \
   --set='server.ha.raft.enabled=true'
 ```

diff --git a/website/content/docs/platform/k8s/helm/examples/enterprise-with-raft.mdx b/website/content/docs/platform/k8s/helm/examples/enterprise-with-raft.mdx
@@ -15,7 +15,7 @@ Integrated Storage (raft) can be enabled using the `server.ha.raft.enabled` valu
 ```shell
 helm install vault hashicorp/vault \
   --set='server.image.repository=hashicorp/vault-enterprise' \
-  --set='server.image.tag=1.11.3-ent' \
+  --set='server.image.tag=1.12.0-ent' \
   --set='server.ha.enabled=true' \
   --set='server.ha.raft.enabled=true'
 ```

diff --git a/website/content/docs/platform/k8s/helm/run.mdx b/website/content/docs/platform/k8s/helm/run.mdx
@@ -409,14 +409,14 @@ Next, list the Helm versions and choose the desired version to install.
 ```bash
 $ helm search repo hashicorp/vault
 NAME           	CHART VERSION	APP VERSION	DESCRIPTION
-hashicorp/vault	0.22.0       	1.11.3     	Official HashiCorp Vault Chart
+hashicorp/vault	0.22.1       	1.12.0     	Official HashiCorp Vault Chart
 ```
 
 Next, test the upgrade with `--dry-run` first to verify the changes sent to the
 Kubernetes cluster.
 
 ```shell-session
-$ helm upgrade vault hashicorp/vault --version=0.22.0 \
+$ helm upgrade vault hashicorp/vault --version=0.22.1 \
     --set='server.image.repository=vault' \
     --set='server.image.tag=123.456' \
     --dry-run

diff --git a/website/content/docs/platform/k8s/injector/annotations.mdx b/website/content/docs/platform/k8s/injector/annotations.mdx
@@ -28,7 +28,7 @@ them, optional commands to run, etc.
 
 - `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
-  not needed. Defaults to `hashicorp/vault:1.11.3`.
+  not needed. Defaults to `hashicorp/vault:1.12.0`.
 
 - `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
@@ -120,11 +120,13 @@ them, optional commands to run, etc.
   memory limits.
 
 - `vault.hashicorp.com/agent-limits-ephemeral` - configures the ephemeral
-  storage limit on the Vault Agent containers. Defaults to `128Mi`. Setting this
-  to an empty string disables ephemeral storage limits. Also available as a
-  command-line option (`-ephemeral-storage-limit`) or environment variable
-  (`AGENT_INJECT_EPHEMERAL_LIMIT`) to set the default for all injected Agent
-  containers.
+  storage limit on the Vault Agent containers. Defaults to unset, which
+  disables ephemeral storage limits. Also available as a command-line option
+  (`-ephemeral-storage-limit`) or environment variable (`AGENT_INJECT_EPHEMERAL_LIMIT`)
+  to set the default for all injected Agent containers. **Note:** Pod limits are
+  equal to the sum of all container limits. Setting this limit without setting it
+  for other containers will also affect the limits of other containers in the pod.
+  See [Kubernetes resources documentation][k8s-resources] for more details.
 
 - `vault.hashicorp.com/agent-requests-cpu` - configures the CPU requests on the
   Vault Agent containers. Defaults to `250m`. Setting this to an empty string disables
@@ -135,12 +137,14 @@ them, optional commands to run, etc.
   memory requests.
 
 - `vault.hashicorp.com/agent-requests-ephemeral` - configures the ephemeral
-  storage requests on the Vault Agent Containers. Defaults to `64Mi`. Setting
-  this to an empty string disables ephemeral storage requests (and will default
-  to the ephemeral limit if set). Also available as a command-line option
-  (`-ephemeral-storage-request`) or environment variable
-  (`AGENT_INJECT_EPHEMERAL_REQUEST`) to set the default for all injected Agent
-  containers.
+  storage requests on the Vault Agent Containers. Defaults to unset, which
+  disables ephemeral storage requests (and will default to the ephemeral limit
+  if set). Also available as a command-line option (`-ephemeral-storage-request`)
+  or environment variable (`AGENT_INJECT_EPHEMERAL_REQUEST`) to set the default
+  for all injected Agent containers. **Note:** Pod requests are equal to the sum
+  of all container requests. Setting this limit without setting it for other
+  containers will also affect the requests of other containers in the pod. See
+  [Kubernetes resources documentation][k8s-resources] for more details.
 
 - `vault.hashicorp.com/agent-revoke-on-shutdown` - configures whether the sidecar
   will revoke it's own token before shutting down. This setting will only be applied
@@ -303,3 +307,5 @@ etc.
   (`-disable-keep-alives`) or environment variable
   (`AGENT_INJECT_DISABLE_KEEP_ALIVES`) to set the default for all injected
   Agents.
+
+[k8s-resources]: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#resource-requests-and-limits-of-pod-and-container
diff --git a/website/content/partials/helm/install.mdx b/website/content/partials/helm/install.mdx
@@ -2,15 +2,15 @@
 # List the available releases
 $ helm search repo hashicorp/vault -l
 NAME           	CHART VERSION	APP VERSION	DESCRIPTION
+hashicorp/vault	0.22.1       	1.12.0     	Official HashiCorp Vault Chart
 hashicorp/vault	0.22.0       	1.11.3     	Official HashiCorp Vault Chart
 hashicorp/vault	0.21.0       	1.11.2     	Official HashiCorp Vault Chart
 hashicorp/vault	0.20.1       	1.10.3     	Official HashiCorp Vault Chart
 hashicorp/vault	0.20.0       	1.10.3     	Official HashiCorp Vault Chart
 hashicorp/vault	0.19.0       	1.9.2      	Official HashiCorp Vault Chart
 hashicorp/vault	0.18.0       	1.9.0      	Official HashiCorp Vault Chart
-hashicorp/vault	0.17.1       	1.8.4      	Official HashiCorp Vault Chart
 ...
 
-# Install version 0.22.0
-$ helm install vault hashicorp/vault --version 0.22.0
+# Install version 0.22.1
+$ helm install vault hashicorp/vault --version 0.22.1
 ```
diff --git a/website/content/partials/helm/repo.mdx b/website/content/partials/helm/repo.mdx
@@ -4,5 +4,5 @@ $ helm repo add hashicorp https://helm.releases.hashicorp.com
 
 $ helm search repo hashicorp/vault
 NAME           	CHART VERSION	APP VERSION	DESCRIPTION
-hashicorp/vault	0.22.0       	1.11.3     	Official HashiCorp Vault Chart
+hashicorp/vault	0.22.1       	1.12.0     	Official HashiCorp Vault Chart
 ```