Type '/' to Search

»Configuration

The chart is highly customizable using Helm configuration values. Each value has a default tuned for an optimal getting started experience with Vault. Before going into production, please review the parameters below and consider if they're appropriate for your deployment.

  • global - These global values affect multiple components of the chart.

    • enabled (boolean: true) - The master enabled/disabled configuration. If this is true, most components will be installed by default. If this is false, no components will be installed by default and manually opting-in is required, such as by setting server.enabled to true.

    • imagePullSecrets (array: []) - References secrets to be used when pulling images from private registries. See Pull an Image from a Private Registry for more details.

      • name: (string: required) - Name of the secret containing files required for authentication to private image registries.

    • tlsDisable (boolean: true) - When set to true, changes URLs from https to http (such as the VAULT_ADDR=http://127.0.0.1:8200 environment variable set on the Vault pods).

    • openshift (boolean: false) - If true, enables configuration specific to OpenShift such as NetworkPolicy, SecurityContext, and Route.

    • psp - Values that configure Pod Security Policy.

      • enable (boolean: false) - When set to true, enables Pod Security Policies for Vault and Vault Agent Injector.

      • annotations (dictionary: {}) - This value defines additional annotations to add to the Pod Security Policies. This can either be YAML or a YAML-formatted multi-line templated string.

        annotations:
  seccomp.security.alpha.kubernetes.io/allowedProfileNames: docker/default,runtime/default
  apparmor.security.beta.kubernetes.io/allowedProfileNames: runtime/default
  seccomp.security.alpha.kubernetes.io/defaultProfileName:  runtime/default
  apparmor.security.beta.kubernetes.io/defaultProfileName:  runtime/default
# or
annotations: |
  seccomp.security.alpha.kubernetes.io/allowedProfileNames: docker/default,runtime/default
  apparmor.security.beta.kubernetes.io/allowedProfileNames: runtime/default
  seccomp.security.alpha.kubernetes.io/defaultProfileName:  runtime/default
  apparmor.security.beta.kubernetes.io/defaultProfileName:  runtime/default

        annotations:  seccomp.security.alpha.kubernetes.io/allowedProfileNames: docker/default,runtime/default  apparmor.security.beta.kubernetes.io/allowedProfileNames: runtime/default  seccomp.security.alpha.kubernetes.io/defaultProfileName:  runtime/default  apparmor.security.beta.kubernetes.io/defaultProfileName:  runtime/default# orannotations: |  seccomp.security.alpha.kubernetes.io/allowedProfileNames: docker/default,runtime/default  apparmor.security.beta.kubernetes.io/allowedProfileNames: runtime/default  seccomp.security.alpha.kubernetes.io/defaultProfileName:  runtime/default  apparmor.security.beta.kubernetes.io/defaultProfileName:  runtime/default

  • injector - Values that configure running a Vault Agent Injector Admission Webhook Controller within Kubernetes.

    • enabled (boolean: true) - When set to true, the Vault Agent Injector Admission Webhook controller will be created.

    • externalVaultAddr (string: "") - External vault server address for the injector to use. Setting this will disable deployment of the vault server, and only deploy the injector. A service account with token review permissions is automatically created if server.serviceAccount.create=true is set for the external Vault server to use.

    • replicas (int: 1) - The number of pods to deploy to create a highly available cluster of Vault Agent Injectors. Requires Vault K8s 0.7.0 to have more than 1 replica.

    • leaderElector - Values that configure the Vault Agent Injector leader election for HA deployments.

      • enabled (boolean: true) - When set to true, enables leader election for Vault Agent Injector. This is required when using auto-tls and more than 1 replica.

      • image - Values that configure the Vault Agent Injector Leader Election image.

        • repository (string: "gcr.io/google_containers/leader-elector") - The name of the leader election image for the Vault Agent Injector.

        • tag (string: "0.4") - The tag of the Docker image for the Leader Election. This should be pinned to a specific version when running in production.

      • ttl (string: "60s") - The frequency in which leader elections are performed in the Vault Agent Injector cluster.

    • image - Values that configure the Vault Agent Injector Docker image.

      • repository (string: "hashicorp/vault-k8s") - The name of the Docker image for Vault Agent Injector.

      • tag (string: "0.10.2") - 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: "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.7.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.

    • agentDefaults - Values that configure the injected Vault Agent containers default values.

      • cpuLimit (string: "500m") - The default CPU limit for injected Vault Agent containers.

      • cpuRequest (string: "250m") - The default CPU request for injected Vault Agent containers.

      • memLimit (string: "128Mi") - The default memory limit for injected Vault Agent containers.

      • memRequest (string: "64Mi") - The default memory request for injected Vault Agent containers.

      • template (string: "map") - The default template type for rendered secrets if no custom templates are defined. Possible values include map and json.

    • metrics - Values that configure the Vault Agent Injector metric exporter.

      • enabled (boolean: false) - When set to true, the Vault Agent Injector exports Prometheus metrics at the /metrics path.

    • authPath (string: "auth/kubernetes") - Mount path of the Vault Kubernetes Auth Method.

    • logLevel (string: "info") - Configures the log verbosity of the injector. Supported log levels: trace, debug, error, warn, info.

    • logFormat (string: "standard") - Configures the log format of the injector. Supported log formats: "standard", "json".

    • revokeOnShutdown (boolean: false) - Configures all Vault Agent sidecars to revoke their token when shutting down.

    • resources (dictionary: {}) - The resource requests and limits (CPU, memory, etc.) for each container of the server. This should be a YAML dictionary of a Kubernetes ResourceRequirements object. If this isn't specified, then the pods won't request any specific amount of resources, which limits the ability for Kubernetes to make efficient use of compute resources.
      Setting this is highly recommended.

      resources:
  requests:
    memory: '10Gi'
  limits:
    memory: '10Gi'

      resources:  requests:    memory: '10Gi'  limits:    memory: '10Gi'

    • namespaceSelector (dictionary: {}) - The selector used by the admission webhook controller to limit what namespaces where injection can happen. If set to null, all non-system namespaces are eligible for injection.

      # Selectors are defined as a YAML dictionary.
# In this example, all namespaces with the label "injection: enabled" are eligible:
namespaceSelector:
  matchLabels:
    injection: enabled

      # Selectors are defined as a YAML dictionary.# In this example, all namespaces with the label "injection: enabled" are eligible:namespaceSelector:  matchLabels:    injection: enabled

    • objectSelector (dictionary: {}) - The selector used by the admission webhook controller to limit what objects can be effected by mutation.

      # Selectors are defined as a YAML dictionary.
# In this example, all namespaces with the label "injection: enabled" are eligible:
objectSelector:
  matchLabels:
    injection: enabled

      # Selectors are defined as a YAML dictionary.# In this example, all namespaces with the label "injection: enabled" are eligible:objectSelector:  matchLabels:    injection: enabled

    • extraLabels (dictionary: {}) - This value defines additional labels for Vault Agent Injector pods.

      extraLabels:
  'sample/label1': 'foo'
  'sample/label2': 'bar'

      extraLabels:  'sample/label1': 'foo'  'sample/label2': 'bar'

    • certs - The certs section configures how the webhook TLS certs are configured. These are the TLS certs for the Kube apiserver communicating to the webhook. By default, the injector will generate and manage its own certs, but this requires the ability for the injector to update its own MutatingWebhookConfiguration. In a production environment, custom certs should probably be used. Configure the values below to enable this.

      • secretName (string: "") - secretName is the name of the Kubernetes secret that has the TLS certificate and private key to serve the injector webhook. If this is null, then the injector will default to its automatic management mode.

      • caBundle (string: "") - The PEM-encoded CA public certificate bundle for the TLS certificate served by the injector. This must be specified as a string and can't come from a secret because it must be statically configured on the Kubernetes MutatingAdmissionWebhook resource. This only needs to be specified if secretName is not null.

      • certName (string: "tls.crt") - The name of the certificate file within the secretName secret.

      • keyName (string: "tls.key") - The name of the key file within the secretName secret.

    • extraEnvironmentVars (dictionary: {}) - Extra environment variables to set in the injector deployment.

    • affinity - This value defines the affinity for Vault Agent Injector pods. It defaults to allowing only a single pod on each node, which minimizes risk of the cluster becoming unusable if a node is lost. If you need to run more pods per node (for example, testing on Minikube), set this value to null.

      # Recommended default server affinity:
affinity: |
  podAntiAffinity:
    requiredDuringSchedulingIgnoredDuringExecution:
    - labelSelector:
        matchLabels:
          app.kubernetes.io/name: {{ template "vault.name" . }}-agent-injector
          app.kubernetes.io/instance: "{{ .Release.Name }}"
          component: webhook
      topologyKey: kubernetes.io/hostname

      # Recommended default server affinity:affinity: |  podAntiAffinity:    requiredDuringSchedulingIgnoredDuringExecution:    - labelSelector:        matchLabels:          app.kubernetes.io/name: {{ template "vault.name" . }}-agent-injector          app.kubernetes.io/instance: "{{ .Release.Name }}"          component: webhook      topologyKey: kubernetes.io/hostname

    • tolerations (string: null) - Toleration Settings for injector pods. This should be a multi-line string matching the Toleration array in a PodSpec.

    • nodeSelector (string: null) - nodeSelector labels for injector pod assignment, formatted as a muli-line string.

    • priorityClassName (string: "") - Priority class for injector pods

    • annotations (dictionary: {}) - This value defines additional annotations for injector pods. This can either be YAML or a YAML-formatted multi-line templated string.

      annotations:
  "sample/annotation1": "foo"
  "sample/annotation2": "bar"
# or
annotations: |
  "sample/annotation1": "foo"
  "sample/annotation2": "bar"

      annotations:  "sample/annotation1": "foo"  "sample/annotation2": "bar"# orannotations: |  "sample/annotation1": "foo"  "sample/annotation2": "bar"

    • failurePolicy (string: "Ignore") - When set to Fail, an error calling the webhook causes the admission to fail and the API request to be rejected. When set to Ignore, an error calling the webhook is ignored and the API request is allowed to continue. Allowed values: Fail, Ignore.

    • service - The service section configures the Kubernetes service for the Vault Agent Injector.

      • annotations (dictionary: {}) - This value defines additional annotations to add to the Vault Agent Injector service. This can either be YAML or a YAML-formatted multi-line templated string.

        annotations:
  "sample/annotation1": "foo"
  "sample/annotation2": "bar"
# or
annotations: |
  "sample/annotation1": "foo"
  "sample/annotation2": "bar"

        annotations:  "sample/annotation1": "foo"  "sample/annotation2": "bar"# orannotations: |  "sample/annotation1": "foo"  "sample/annotation2": "bar"

    • hostNetwork (boolean: false) - When set to true, configures the Vault Agent Injector to run on the host network. This is useful when alternative cluster networking is used.

    • port (int: 8080) - Configures the port the Vault Agent Injector listens on.

  • server - Values that configure running a Vault server within Kubernetes.

    • enabled (boolean: true) - When set to true, the Vault server will be created.

    • enterpriseLicense -

      Enterprise
      This value refers to a Kubernetes secret that you have created that contains your enterprise license. If you are not using an enterprise image or if you plan to introduce the license key via another route, then leave secretName blank ("") or set it to null. Requires Vault Enterprise 1.8 or later.

      • secretName (string: "") - The name of the Kubernetes secret that holds the enterprise license. The secret must be in the same namespace that Vault is installed into.

      • secretKey (string: "license") - The key within the Kubernetes secret that holds the enterprise license.

    • image - Values that configure the Vault Docker image.

      • repository (string: "vault") - The name of the Docker image for the containers running Vault.

      • tag (string: "1.7.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.

      • 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.

    • updateStrategyType (string: "OnDelete") - Configure the Update Strategy Type for the StatefulSet.

    • logLevel (string: "") - Configures the Vault server logging verbosity. If set this will override values defined in the Vault configuration file. Supported log levels include: trace, debug, info, warn, error.

    • logFormat (string: "") - Configures the Vault server logging format. If set this will override values defined in the Vault configuration file. Supported log formats include: standard, json.

    • resources (dictionary: {}) - The resource requests and limits (CPU, memory, etc.) for each container of the server. This should be a YAML dictionary of a Kubernetes ResourceRequirements object. If this isn't specified, then the pods won't request any specific amount of resources, which limits the ability for Kubernetes to make efficient use of compute resources. Setting this is highly recommended.

      resources:
  requests:
    memory: '10Gi'
  limits:
    memory: '10Gi'

      resources:  requests:    memory: '10Gi'  limits:    memory: '10Gi'

    • ingress - Values that configure Ingress services for Vault.

      • enabled (boolean: false) - When set to true, an Ingress service will be created.

      • labels (dictionary: {}) - Labels for the ingress service.

      • annotations (dictionary: {}) - This value defines additional annotations to add to the Ingress service. This can either be YAML or a YAML-formatted multi-line templated string.

        annotations:
  kubernetes.io/ingress.class: nginx
  kubernetes.io/tls-acme: "true"
# or
annotations: |
  kubernetes.io/ingress.class: nginx
  kubernetes.io/tls-acme: "true"

        annotations:  kubernetes.io/ingress.class: nginx  kubernetes.io/tls-acme: "true"# orannotations: |  kubernetes.io/ingress.class: nginx  kubernetes.io/tls-acme: "true"

      • extraPaths (array: {}) - Configures extra paths to prepend to the host configuration. This is useful when working with annotation based services.

        extraPaths: 
  - path: /*
    backend:
      serviceName: ssl-redirect
      servicePort: use-annotation

        extraPaths:   - path: /*    backend:      serviceName: ssl-redirect      servicePort: use-annotation

      • hosts - Values that configure the Ingress host rules.

        • host (string: required): Name of the host to use for Ingress.

        • paths (array: []): Deprecated: server.ingress.extraPaths should be used instead. A list of paths that will be directed to the Vault service. At least one path is required.

        paths:
  - /
  - /vault

        paths:  - /  - /vault

    • route - Values that configure Route services for Vault in OpenShift

      • enabled (boolean: false) - When set to true, a Route for Vault will be created.

      • labels (dictionary: {}) - Labels for the Route

      • annotations (dictionary: {}) - Annotations to add to the Route. This can either be YAML or a YAML-formatted multi-line templated string.

      • host (string: "chart-example.local") - Sets the hostname for the Route.

    • tls - Values that configure the Ingress TLS rules.

      • hosts (array: []): List of the hosts defined in the Common Name of the TLS Certificate.

      • secretName (string: null): Name of the secret containing the required TLS files such as certificates and keys.

      hosts:
  - sslexample.foo.com
  - sslexample.bar.com
  secretName: testsecret-tls

      hosts:  - sslexample.foo.com  - sslexample.bar.com  secretName: testsecret-tls

    • authDelegator - Values that configure the Cluster Role Binding attached to the Vault service account.

      • enabled (boolean: true) - When set to true, a Cluster Role Binding will be bound to the Vault service account. This Cluster Role Binding has the necessary privileges for Vault to use the Kubernetes Auth Method.

    • readinessProbe - Values that configure the readiness probe for the Vault pods.

      • enabled (boolean: true) - When set to true, a readiness probe will be applied to the Vault pods.

      • path (string: "") - When set to a value, enables HTTP/HTTPS probes instead of using the default exec probe. The http/https scheme is controlled by the tlsDisable value.

      • failureThreshold (int: 2) - When set to a value, configures how many probe failures will be tolerated by Kubernetes.

      • initialDelaySeconds (int: 5) - When set to a value, configures the number of seconds after the container has started before probe initiates.

      • periodSeconds (int: 5) - When set to a value, configures how often (in seconds) to perform the probe.

      • successThreshold (int: 1) - When set to a value, configures the minimum consecutive successes for the probe to be considered successful after having failed.

      • timeoutSeconds (int: 3) - When set to a value, configures the number of seconds after which the probe times out.

      readinessProbe:
  enabled: true
  path: /v1/sys/health?standbyok=true
  failureThreshold: 2
  initialDelaySeconds: 5
  periodSeconds: 5
  successThreshold: 1
  timeoutSeconds: 3

      readinessProbe:  enabled: true  path: /v1/sys/health?standbyok=true  failureThreshold: 2  initialDelaySeconds: 5  periodSeconds: 5  successThreshold: 1  timeoutSeconds: 3

    • livenessProbe - Values that configure the liveliness probe for the Vault pods.

      • enabled (boolean: false) - When set to true, a liveliness probe will be applied to the Vault pods.

      • path (string: "/v1/sys/health?standbyok=true") - When set to a value, enables HTTP/HTTPS probes instead of using the default exec probe. The http/https scheme is controlled by the tlsDisable value.

      • initialDelaySeconds (int: 60) - Sets the initial delay of the liveliness probe when the container starts.

      • failureThreshold (int: 2) - When set to a value, configures how many probe failures will be tolerated by Kubernetes.

      • periodSeconds (int: 5) - When set to a value, configures how often (in seconds) to perform the probe.

      • successThreshold (int: 1) - When set to a value, configures the minimum consecutive successes for the probe to be considered successful after having failed.

      • timeoutSeconds (int: 3) - When set to a value, configures the number of seconds after which the probe times out.

      livelinessProbe:
  enabled: true
  path: /v1/sys/health?standbyok=true
  initialDelaySeconds: 60
  failureThreshold: 2
  periodSeconds: 5
  successThreshold: 1
  timeoutSeconds: 3

      livelinessProbe:  enabled: true  path: /v1/sys/health?standbyok=true  initialDelaySeconds: 60  failureThreshold: 2  periodSeconds: 5  successThreshold: 1  timeoutSeconds: 3

    • preStopSleepSeconds (int: 5) - Used to set the sleep time during the preStop step.

    • postStart (array: []) - Used to define commands to run after the pod is ready. This can be used to automate processes such as initialization or bootstrapping auth methods.

    postStart:
  - /bin/sh
  - -c
  - /vault/userconfig/myscript/run.sh

    postStart:  - /bin/sh  - -c  - /vault/userconfig/myscript/run.sh

    • extraInitContainers (array: null) - extraInitContainers is a list of init containers. Specified as a YAML list. This is useful if you need to run a script to provision TLS certificates or write out configuration files in a dynamic way.

    • extraContainers (array: null) - The extra containers to be applied to the Vault server pods.

    extraContainers:
  - name: mycontainer
    image: 'app:0.0.0'
    env: ...

    extraContainers:  - name: mycontainer    image: 'app:0.0.0'    env: ...
    • extraEnvironmentVars (dictionary: {}) - The extra environment variables to be applied to the Vault server.
    # Extra Environment Variables are defined as key/value strings.
extraEnvironmentVars:
  GOOGLE_REGION: global
  GOOGLE_PROJECT: myproject
  GOOGLE_APPLICATION_CREDENTIALS: /vault/userconfig/myproject/myproject-creds.json

    # Extra Environment Variables are defined as key/value strings.extraEnvironmentVars:  GOOGLE_REGION: global  GOOGLE_PROJECT: myproject  GOOGLE_APPLICATION_CREDENTIALS: /vault/userconfig/myproject/myproject-creds.json

    • shareProcessNamespace (boolean: false) - Enables process namespace sharing between Vault and the extraContainers. This is useful if Vault must be signaled, e.g. to send a SIGHUP for log rotation.

    • extraArgs (string: null) - The extra arguments to be applied to the Vault server startup command.

      extraArgs: '-config=/path/to/extra/config.hcl -log-format=json'

      extraArgs: '-config=/path/to/extra/config.hcl -log-format=json'

    • extraSecretEnvironmentVars (string: null) - The extra environment variables populated from a secret to be applied to the Vault server. This should be a multi-line key/value string.

      • envName (string: required) - Name of the environment variable to be populated in the Vault container.

      • secretName (string: required) - Name of Kubernetes secret used to populate the environment variable defined by envName.

      • secretKey (string: required) - Name of the key where the requested secret value is located in the Kubernetes secret.

      # Extra Environment Variables populated from a secret.
extraSecretEnvironmentVars:
  - envName: AWS_SECRET_ACCESS_KEY
    secretName: vault
    secretKey: AWS_SECRET_ACCESS_KEY

      # Extra Environment Variables populated from a secret.extraSecretEnvironmentVars:  - envName: AWS_SECRET_ACCESS_KEY    secretName: vault    secretKey: AWS_SECRET_ACCESS_KEY

    • extraVolumes (array: []) - Deprecated: please use volumes instead. A list of extra volumes to mount to Vault servers. This is useful for bringing in extra data that can be referenced by other configurations at a well known path, such as TLS certificates. The value of this should be a list of objects. Each object supports the following keys:

      • type (string: required) - Type of the volume, must be one of "configMap" or "secret". Case sensitive.

      • name (string: required) - Name of the configMap or secret to be mounted. This also controls the path that it is mounted to. The volume will be mounted to /vault/userconfig/<name> by default unless path is configured.

      • path (string: /vault/userconfigs) - Name of the path where a configMap or secret is mounted. If not specified the volume will be mounted to /vault/userconfig/<name of volume>.

      • defaultMode (string: "420") - Default mode of the mounted files.

      extraVolumes:
  - type: 'secret'
    name: 'vault-certs'
    path: '/etc/pki'

      extraVolumes:  - type: 'secret'    name: 'vault-certs'    path: '/etc/pki'

    • volumes (array: []) - A list of volumes made available to all containers. This takes standard Kubernetes volume definitions.

      volumes:
  - name: plugins
    emptyDir: {}

      volumes:  - name: plugins    emptyDir: {}

    • volumeMounts (array: []) - A list of volumes mounts made available to all containers. This takes standard Kubernetes volume definitions.

      volumeMounts:
  - mountPath: /usr/local/libexec/vault
    name: plugins
    readOnly: true

      volumeMounts:  - mountPath: /usr/local/libexec/vault    name: plugins    readOnly: true

    • affinity - This value defines the affinity for server pods. It defaults to allowing only a single pod on each node, which minimizes risk of the cluster becoming unusable if a node is lost. If you need to run more pods per node (for example, testing on Minikube), set this value to null.

    # Recommended default server affinity:
affinity: |
  podAntiAffinity:
    requiredDuringSchedulingIgnoredDuringExecution:
    - labelSelector:
      matchLabels:
        app: {{ template "vault.name" . }}
        release: "{{ .Release.Name }}"
        component: server
      topologyKey: kubernetes.io/hostname

    # Recommended default server affinity:affinity: |  podAntiAffinity:    requiredDuringSchedulingIgnoredDuringExecution:    - labelSelector:      matchLabels:        app: {{ template "vault.name" . }}        release: "{{ .Release.Name }}"        component: server      topologyKey: kubernetes.io/hostname
    • tolerations (string: null) - This value defines the tolerations that are acceptable when being scheduled. This should be a multi-line string matching the Toleration array in a PodSpec.
    tolerations: |
  - key: 'node.kubernetes.io/unreachable'
    operator: 'Exists'
    effect: 'NoExecute'
    tolerationSeconds: 6000

    tolerations: |  - key: 'node.kubernetes.io/unreachable'    operator: 'Exists'    effect: 'NoExecute'    tolerationSeconds: 6000
    • nodeSelector - This value defines additional node selection criteria for more control over where the Vault servers are deployed. This should be formatted as a multi-line string.
    nodeSelector: |
  disktype: ssd

    nodeSelector: |  disktype: ssd

    • networkPolicy - Values that configure the Vault Network Policy.

      • enabled (boolean: false) - When set to true, enables a Network Policy for the Vault cluster.

      • egress (array: []) - This value configures the egress network policy rules.

      egress:
  - to:
      - ipBlock:
          cidr: 10.0.0.0/24
    ports:
      - protocol: TCP
        port: 8200

      egress:  - to:      - ipBlock:          cidr: 10.0.0.0/24    ports:      - protocol: TCP        port: 8200

    • priorityClassName (string: "") - Priority class for server pods

    • extraLabels (dictionary: {}) - This value defines additional labels for server pods.

    extraLabels:
  'sample/label1': 'foo'
  'sample/label2': 'bar'

    extraLabels:  'sample/label1': 'foo'  'sample/label2': 'bar'
    • annotations (dictionary: {}) - This value defines additional annotations for server pods. This can either be YAML or a YAML-formatted multi-line templated string.
    annotations:
  "sample/annotation1": "foo"
  "sample/annotation2": "bar"
# or
annotations: |
  "sample/annotation1": "foo"
  "sample/annotation2": "bar"

    annotations:  "sample/annotation1": "foo"  "sample/annotation2": "bar"# orannotations: |  "sample/annotation1": "foo"  "sample/annotation2": "bar"

    • service - Values that configure the Kubernetes service created for Vault. These options are also used for the active and standby services when ha is enabled.

      • enabled (boolean: true) - When set to true, a Kubernetes service will be created for Vault.

      • clusterIP (string) - ClusterIP controls whether an IP address (cluster IP) is attached to the Vault service within Kubernetes. By default the Vault service will be given a Cluster IP address, set to None to disable. When disabled Kubernetes will create a "headless" service. Headless services can be used to communicate with pods directly through DNS instead of a round robin load balancer.

      • type (string: "ClusterIP") - Sets the type of service to create, such as NodePort.

      • port (int: 8200) - Port on which Vault server is listening inside the pod.

      • targetPort (int: 8200) - Port on which the service is listening.

      • nodePort (int:) - When type is set to NodePort, the bound node port can be configured using this value. A random port will be assigned if this is left blank.

      • annotations (dictionary: {}) - This value defines additional annotations for the service. This can either be YAML or a YAML-formatted multi-line templated string.

      annotations:
  "sample/annotation1": "foo"
  "sample/annotation2": "bar"
# or
annotations: |
  "sample/annotation1": "foo"
  "sample/annotation2": "bar"

      annotations:  "sample/annotation1": "foo"  "sample/annotation2": "bar"# orannotations: |  "sample/annotation1": "foo"  "sample/annotation2": "bar"

    • serviceAccount - Values that configure the Kubernetes service account created for Vault.

      • create (boolean: true): If set to true, creates a service account used by Vault.

      • name (string: ""): Name of the service account to use. If not set and create is true, a name is generated using the name of the installation (default is "vault").

      • annotations (dictionary: {}) - This value defines additional annotations for the service account. This can either be YAML or a YAML-formatted multi-line templated string.

      annotations:
  "sample/annotation1": "foo"
  "sample/annotation2": "bar"
# or
annotations: |
  "sample/annotation1": "foo"
  "sample/annotation2": "bar"

      annotations:  "sample/annotation1": "foo"  "sample/annotation2": "bar"# orannotations: |  "sample/annotation1": "foo"  "sample/annotation2": "bar"

    • dataStorage - This configures the volume used for storing Vault data when not using external storage such as Consul.

      • enabled (boolean: true) - Enables a persistent volume to be created for storing Vault data when not using an external storage service.

      • size (string: 10Gi) - Size of the volume to be created for Vault's data storage when not using an external storage service.

      • storageClass (string: null) - Name of the storage class to use when creating the data storage volume.

      • mountPath (string: /vault/data) - Configures the path in the Vault pod where the data storage will be mounted.

      • accessMode (string: ReadWriteOnce) - Type of access mode of the storage device. See the official Kubernetes for more information.

      • annotations (dictionary: {}) - This value defines additional annotations to add to the data PVCs. This can either be YAML or a YAML-formatted multi-line templated string.

      annotations:
  kubernetes.io/my-pvc: foobar
# or
annotations: |
  kubernetes.io/my-pvc: foobar

      annotations:  kubernetes.io/my-pvc: foobar# orannotations: |  kubernetes.io/my-pvc: foobar

    • auditStorage - This configures the volume used for storing Vault's audit logs. See the Vault documentation for more information.

      • enabled (boolean: true) - Enables a persistent volume to be created for storing Vault's audit logs.

      • size (string: 10Gi) - Size of the volume to be created for Vault's audit logs.

      • storageClass (string: null) - Name of the storage class to use when creating the audit storage volume.

      • mountPath (string: /vault/audit) - Configures the path in the Vault pod where the audit storage will be mounted.

      • accessMode (string: ReadWriteOnce) - Type of access mode of the storage device.

      • annotations (dictionary: {}) - This value defines additional annotations to add to the audit PVCs. This can either be YAML or a YAML-formatted multi-line templated string.

      annotations:
  kubernetes.io/my-pvc: foobar
# or
annotations: |
  kubernetes.io/my-pvc: foobar

      annotations:  kubernetes.io/my-pvc: foobar# orannotations: |  kubernetes.io/my-pvc: foobar

    • dev - This configures dev mode for the Vault server.

      • enabled (boolean: false) - Enables dev mode for the Vault server. This mode is useful for experimenting with Vault without needing to unseal.

      • devRootToken (string: "root") - Configures the root token for the Vault development server.

    • standalone - This configures standalone mode for the Vault server.

      • enabled (boolean: true) - Enables standalone mode for the Vault server. This mode uses the file storage backend and requires a volume for persistence (dataStorage).

      • config (string: "{}") - A raw string of extra HCL or JSON configuration for Vault servers. This will be saved as-is into a ConfigMap that is read by the Vault servers. This can be used to add additional configuration that isn't directly exposed by the chart.

      # ExtraConfig values are formatted as a multi-line string:
config: |
  api_addr = "http://POD_IP:8200"

  listener "tcp" {
    tls_disable = 1
    address     = "0.0.0.0:8200"
  }

  storage "file" {
    path = "/vault/data"
  }

      # ExtraConfig values are formatted as a multi-line string:config: |  api_addr = "http://POD_IP:8200"
  listener "tcp" {    tls_disable = 1    address     = "0.0.0.0:8200"  }
  storage "file" {    path = "/vault/data"  }

      This can also be set using Helm's --set flag (vault-helm v0.1.0 and later), using the following syntax:

      --set server.standalone.config='{ listener "tcp" { address = "0.0.0.0:8200" }'

      --set server.standalone.config='{ listener "tcp" { address = "0.0.0.0:8200" }'

    • ha - This configures ha mode for the Vault server.

      • enabled (boolean: false) - Enables ha mode for the Vault server. This mode uses a highly available backend storage (such as Consul) to store Vault's data. By default this is configured to use Consul Helm. For a complete list of storage backends, see the Vault documentation.

      • apiAddr: (string: "{}") - Set the API address configuration for a Vault cluster. If set to an empty string, the pod IP address is used.

      • raft - This configures raft integrated storage mode for the Vault server.

        • enabled (boolean: false) - Enables raft integrated storage mode for the Vault server. This mode uses persistent volumes for storage.

        • setNodeId (boolean: false) - Set the Node Raft ID to the name of the pod.

        • config (string: "{}") - A raw string of extra HCL or JSON configuration for Vault servers. This will be saved as-is into a ConfigMap that is read by the Vault servers. This can be used to add additional configuration that isn't directly exposed by the chart.

      • replicas (int: 5) - The number of pods to deploy to create a highly available cluster of Vault servers.

      • updatePartition (int: 0) - If an updatePartition is specified, all Pods with an ordinal that is greater than or equal to the partition will be updated when the StatefulSet’s .spec.template is updated. If set to 0, this disables partition updates. For more information see the official Kubernetes documentation.

      • config (string: "{}") - A raw string of extra HCL or JSON configuration for Vault servers. This will be saved as-is into a ConfigMap that is read by the Vault servers. This can be used to add additional configuration that isn't directly exposed by the chart.

      # ExtraConfig values are formatted as a multi-line string:
config: |
  ui = true
  api_addr = "http://POD_IP:8200"
  listener "tcp" {
      tls_disable = 1
      address     = "0.0.0.0:8200"
  }

  storage "consul" {
      path = "vault"
      address = "HOST_IP:8500"
  }

      # ExtraConfig values are formatted as a multi-line string:config: |  ui = true  api_addr = "http://POD_IP:8200"  listener "tcp" {      tls_disable = 1      address     = "0.0.0.0:8200"  }
  storage "consul" {      path = "vault"      address = "HOST_IP:8500"  }

      This can also be set using Helm's --set flag (vault-helm v0.1.0 and later), using the following syntax:

      --set server.ha.config='{ listener "tcp" { address = "0.0.0.0:8200" }'

      --set server.ha.config='{ listener "tcp" { address = "0.0.0.0:8200" }'

    • disruptionBudget - Values that configures the disruption budget policy. See the official Kubernetes documentation for more information.

      • enabled (boolean: true) - Enables disruption budget policy to limit the number of pods that are down simultaneously from voluntary disruptions.

      • maxUnavailable (int: null) - The maximum number of unavailable pods. By default, this will be automatically computed based on the server.replicas value to be (n/2)-1. If you need to set this to 0, you will need to add a --set 'server.disruptionBudget.maxUnavailable=0' flag to the helm chart installation command because of a limitation in the Helm templating language.

    • statefulset - This configures settings for the Vault Statefulset.

      • annotations (dictionary: {}) - This value defines additional annotations to add to the Vault statefulset. This can either be YAML or a YAML-formatted multi-line templated string.

        annotations:
  kubernetes.io/my-statefulset: foobar
# or
annotations: |
  kubernetes.io/my-statefulset: foobar

        annotations:  kubernetes.io/my-statefulset: foobar# orannotations: |  kubernetes.io/my-statefulset: foobar

  • ui - Values that configure the Vault UI.

    • enabled (boolean: false) - If true, the UI will be enabled. The UI will only be enabled on Vault servers. If server.enabled is false, then this setting has no effect. To expose the UI in some way, you must configure ui.service.

    • serviceType (string: ClusterIP) - The service type to register. This defaults to ClusterIP. The available service types are documented on the Kubernetes website.

    • publishNotReadyAddresses (boolean: true) - If set to true, will route traffic to Vault pods that aren't ready (if they're sealed or uninitialized.

    • activeVaultPodOnly (boolean: false) - If set to true, the UI service will only route to the active pod in a Vault HA cluster.

    • serviceNodePort (int: null) - Sets the Node Port value when using serviceType: NodePort on the Vault UI service.

    • externalPort (int: 8200) - Sets the external port value of the service.

    • targetPort (int: 8200) - Sets the target port value of the service.

    • loadBalancerSourceRanges (string) - This value defines additional source CIDRs when using serviceType: LoadBalancer. This should be formatted as a multi-line string.

    loadBalancerSourceRanges:
  - 10.0.0.0/16
  - 120.78.23.3/32

    loadBalancerSourceRanges:  - 10.0.0.0/16  - 120.78.23.3/32

    • loadBalancerIP (string) - This value defines the IP address of the load balancer when using serviceType: LoadBalancer.

    • annotations (dictionary: {}) - This value defines additional annotations for the UI service. This can either be YAML or a YAML-formatted multi-line templated string.

    annotations:
  "sample/annotation1": "foo"
  "sample/annotation2": "bar"
# or
annotations: |
  "sample/annotation1": "foo"
  "sample/annotation2": "bar"

    annotations:  "sample/annotation1": "foo"  "sample/annotation2": "bar"# orannotations: |  "sample/annotation1": "foo"  "sample/annotation2": "bar"

  • csi - Values that configure running the Vault CSI Provider.

    • enabled (boolean: false) - When set to true, the Vault CSI Provider daemonset will be created.

    • image - Values that configure the Vault CSI Provider Docker image.

      • repository (string: "hashicorp/vault-csi-provider") - The name of the Docker image for the Vault CSI Provider.

      • tag (string: "0.3.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.

      • 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.

    • volumes (array: []) - A list of volumes made available to all containers. This takes standard Kubernetes volume definitions.

      volumes:
  - name: plugins
    emptyDir: {}

      volumes:  - name: plugins    emptyDir: {}

    • volumeMounts (array: []) - A list of volumes mounts made available to all containers. This takes standard Kubernetes volume mount definitions.

      volumeMounts:
  - mountPath: /usr/local/libexec/vault
    name: plugins
    readOnly: true

      volumeMounts:  - mountPath: /usr/local/libexec/vault    name: plugins    readOnly: true

    • resources (dictionary: {}) - The resource requests and limits (CPU, memory, etc.) for each of the CSI containers. This should be a YAML dictionary of a Kubernetes ResourceRequirements objects. If this isn't specified, then the pods won't request any specific amount of resources, which limits the ability for Kubernetes to make efficient use of compute resources.
      Setting this is highly recommended.

      resources:
  requests:
    memory: '10Gi'
  limits:
    memory: '10Gi'

      resources:  requests:    memory: '10Gi'  limits:    memory: '10Gi'

    • daemonSet - Values that configure the Vault CSI Provider daemonSet.

      • updateStrategy - Values that configure the Vault CSI Provider update strategy.

        • type (string: "RollingUpdate") - The type of update strategy to be used when the daemonset is updated using Helm upgrades.

        • maxUnavailable (int: null) - The maximum number of unavailable pods during an upgrade.

      • annotations (dictionary: {}) - This value defines additional annotations to add to the Vault CSI Provider daemonset. This can either be YAML or a YAML-formatted multi-line templated string.

        annotations:
  foo: bar
# or
annotations: |
  foo: bar

        annotations:  foo: bar# orannotations: |  foo: bar

    • pod - Values that configure the Vault CSI Provider pod.

      • annotations (dictionary: {}) - This value defines additional annotations to add to the Vault CSI Provider pods. This can either be YAML or a YAML-formatted multi-line templated string.

        annotations:
  foo: bar
# or
annotations: |
  foo: bar

        annotations:  foo: bar# orannotations: |  foo: bar

      • tolerations (string: null) - Toleration Settings for CSI pods. This should be a multi-line string matching the Toleration array in a PodSpec.

  • serviceAccount - Values that configure the Vault CSI Provider's serviceaccount.

    • annotations (dictionary: {}) - This value defines additional annotations for the serviceAccount definition. This can either be YAML or a YAML-formatted multi-line templated string.

      annotations:
  foo: bar
# or
annotations: |
  foo: bar

      annotations:  foo: bar# orannotations: |  foo: bar

  • readinessProbe - Values that configure the readiness probe for the Vault CSI Provider pods.

    • failureThreshold (int: 2) - When set to a value, configures how many probe failures will be tolerated by Kubernetes.

    • initialDelaySeconds (int: 5) - When set to a value, configures the number of seconds after the container has started before probe initiates.

    • periodSeconds (int: 5) - When set to a value, configures how often (in seconds) to perform the probe.

    • successThreshold (int: 1) - When set to a value, configures the minimum consecutive successes for the probe to be considered successful after having failed.

    • timeoutSeconds (int: 3) - When set to a value, configures the number of seconds after which the probe times out.

  • livenessProbe - Values that configure the liveliness probe for the Vault CSI Provider pods.

    • initialDelaySeconds (int: 5) - Sets the initial delay of the liveliness probe when the container starts.

    • failureThreshold (int: 2) - When set to a value, configures how many probe failures will be tolerated by Kubernetes.

    • periodSeconds (int: 5) - When set to a value, configures how often (in seconds) to perform the probe.

    • successThreshold (int: 1) - When set to a value, configures the minimum consecutive successes for the probe to be considered successful after having failed.

    • timeoutSeconds (int: 3) - When set to a value, configures the number of seconds after which the probe times out.

  • debug (bool: false) - When set to true, enables debug logging on the Vault CSI Provider daemonset.

  • extraArgs (string: array) - The extra arguments to be applied to the CSI pod startup command.