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:
apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
name: local-secret-store
namespace: default
spec:
type: secretstores.local.file
version: v1
metadata:
- name: secretsFile
value: [path to the JSON file]
- name: nestedSeparator
value: ":"
Spec metadata fields
| Field | Required | Details | Example |
|---|---|---|---|
| secretsFile | Y | The path to the file where secrets are stored | "path/to/file.json" |
| nestedSeparator | N | Used by the store when flattening the JSON hierarchy to a map. Defaults to ":" | ":" |
Setup JSON file to hold the secrets
Given the following json:
{
"redisPassword": "your redis password",
"connectionStrings": {
"sql": "your sql connection string",
"mysql": "your mysql connection string"
}
}
The store will load the file and create a map with the following key value pairs:
| flattened key | value |
|---|---|
| “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.
Related links
- Secrets building block
- How-To: Retrieve a secret
- How-To: Reference secrets in Dapr components
- Secrets API reference
Last modified May 22, 2021: docs: clean up white noise (#1491) (fe1ab8eb)