Local file (for Development)

Detailed information on the local file secret store component

This Dapr secret store component reads plain text JSON from a given file and does not use authentication.

Warning

This approach to secret management is not recommended for production environments.

Component format

To setup local file based secret store create a component of type secretstores.local.file. Create a file with the following content in your ./components directory:

  1. apiVersion: dapr.io/v1alpha1
  2. kind: Component
  3. metadata:
  4.   name: local-secret-store
  5.   namespace: default
  6. spec:
  7.   type: secretstores.local.file
  8.   version: v1
  9.   metadata:
  10.   - name: secretsFile
  11.     value: [path to the JSON file]
  12.   - name: nestedSeparator
  13.     value: ":"

Spec metadata fields

FieldRequiredDetailsExample
secretsFileYThe path to the file where secrets are stored“path/to/file.json”
nestedSeparatorNUsed by the store when flattening the JSON hierarchy to a map. Defaults to “:”“:”

Setup JSON file to hold the secrets

Given the following json:

  1. {
  2.     "redisPassword": "your redis password",
  3.     "connectionStrings": {
  4.         "sql": "your sql connection string",
  5.         "mysql": "your mysql connection string"
  6.     }
  7. }

The store will load the file and create a map with the following key value pairs:

flattened keyvalue
“redis”“your redis password”
“connectionStrings:sql”“your sql connection string”
“connectionStrings:mysql”“your mysql connection string”

Use the flattened key (connectionStrings:sql) to access the secret.

Last modified May 26, 2021: Update to point to 1.2 (#1518) (c690379)