The documentation you are viewing is for Dapr v1.6 which is an older version of Dapr. For up-to-date documentation, see the latest version.

HashiCorp Vault

Detailed information on the HashiCorp Vault secret store component

Create the Vault component

To setup HashiCorp Vault secret store create a component of type secretstores.hashicorp.vault. See this guide on how to create and apply a secretstore configuration. See this guide on referencing secrets to retrieve and use the secret with Dapr components.

kind: Component
  name: vault
  namespace: default
  type: secretstores.hashicorp.vault
  version: v1
  - name: vaultAddr
    value: [vault_address] # Optional. Default: ""
  - name: caCert # Optional. This or caPath or caPem
    value: "[ca_cert]"
  - name: caPath # Optional. This or CaCert or caPem
    value: "[path_to_ca_cert_file]"
  - name: caPem # Optional. This or CaCert or CaPath
    value : "[encoded_ca_cert_pem]"
  - name: skipVerify # Optional. Default: false
    value : "[skip_tls_verification]"
  - name: tlsServerName # Optional.
    value : "[tls_config_server_name]"
  - name: vaultTokenMountPath # Required if vaultToken not provided. Path to token file.
    value : "[path_to_file_containing_token]"
  - name: vaultToken # Required if vaultTokenMountPath not provided. Token value.
    value : "[path_to_file_containing_token]"
  - name: vaultKVPrefix # Optional. Default: "dapr"
    value : "[vault_prefix]"
  - name: vaultKVUsePrefix # Optional. default: "true"
    value: "[true/false]"

Spec metadata fields

Field Required Details Example
vaultAddr N The address of the Vault server. Defaults to "" ""
caCert N Certificate Authority use only one of the options. The encoded cacerts to use "cacerts"
caPath N Certificate Authority use only one of the options. The path to a CA cert file "path/to/cacert/file"
caPem N Certificate Authority use only one of the options. The encoded cacert pem to use "encodedpem"
skipVerify N Skip TLS verification. Defaults to "false" "true", "false"
tlsServerName N TLS config server name "tls-server"
vaultTokenMountPath Y Path to file containing token "path/to/file"
vaultToken Y Token for authentication within Vault. "tokenValue"
vaultKVPrefix N The prefix in vault. Defaults to "dapr" "dapr", "myprefix"
vaultKVUsePrefix N If false, vaultKVPrefix is forced to be empty. If the value is not given or set to true, vaultKVPrefix is used when accessing the vault. Setting it to false is needed to be able to use the BulkGetSecret method of the store. "true", "false"

Setup Hashicorp Vault instance

Setup Hashicorp Vault using the Vault documentation:

For Kubernetes, you can use the Helm Chart: