Binary Store component specs on Dapr Docs

AWS S3

Mon, 01 Jan 0001 00:00:00 +0000

The AWS S3 Binary Store stores files as objects in an Amazon S3 bucket. It can also connect to S3-compatible services such as MinIO, Ceph, or Cloudflare R2. The component is alpha and uses Dapr’s built-in AWS authentication profile.

Component format

apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
 name: s3-files
spec:
 type: binarystore.aws.s3
 version: v1
 metadata:
 - name: bucket
 value: "binary-files"
 - name: prefix
 value: "uploads"

Configure AWS credentials for the sidecar through the AWS authentication profile and your AWS environment or workload identity. Avoid putting access keys directly in the component manifest.

Azure Blob Storage

Mon, 01 Jan 0001 00:00:00 +0000

The Azure Blob Storage Binary Store stores each file as a blob in the configured container. The component is alpha.

Component format

The following example authenticates with a connection string:

apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
 name: azure-files
spec:
 type: binarystore.azure.blobstorage
 version: v1
 metadata:
 - name: connectionString
 value: "<AZURE_STORAGE_CONNECTION_STRING>"
 - name: containerName
 value: "binary-files"

Warning

The example shows a connection string as a plain value. Use a Dapr secret store to keep credentials out of component manifests.

Authentication

The component supports three authentication methods:

Azure Data Lake Storage Gen2

Mon, 01 Jan 0001 00:00:00 +0000

The Azure Data Lake Storage Gen2 Binary Store stores each file in the configured filesystem. The component is alpha.

Component format

The following example authenticates with a connection string:

apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
 name: data-lake-files
spec:
 type: binarystore.azure.datalake
 version: v1
 metadata:
 - name: connectionString
 value: "<AZURE_STORAGE_CONNECTION_STRING>"
 - name: fileSystemName
 value: "binary-files"

Warning

The example shows a connection string as a plain value. Use a Dapr secret store to keep credentials out of component manifests.

Authentication

The component supports three authentication methods:

Google Cloud Storage Bucket

Mon, 01 Jan 0001 00:00:00 +0000

The Google Cloud Storage Binary Store stores each file as an object in the configured bucket. The component is alpha and uses Dapr’s built-in GCP authentication profile.

Component format

apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
 name: gcp-files
spec:
 type: binarystore.gcp.bucket
 version: v1
 metadata:
 - name: bucket
 value: "binary-files"
 - name: prefix
 value: "uploads"

Configure credentials for the sidecar using Google Cloud’s Application Default Credentials or an appropriate workload identity. Do not store service account keys directly in the component manifest.

In-memory

Mon, 01 Jan 0001 00:00:00 +0000

The in-memory Binary Store keeps files in the Dapr sidecar process. It is useful for local development, tests, and demos, but it is not durable: data is not written to disk, is lost when the process stops, and is not shared between sidecar instances.

Component format

Create a component of type binarystore.in-memory:

apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
 name: local-files
spec:
 type: binarystore.in-memory
 version: v1
 metadata:
 - name: prefix
 value: "uploads"
 - name: maxSize
 value: "8Mi"
 - name: maxTotalSize
 value: "1Gi"

For example, an application request for report.pdf is stored under the component’s uploads prefix. The prefix is optional.

OCI Object Storage

Mon, 01 Jan 0001 00:00:00 +0000

The OCI Object Storage Binary Store stores each file as an object in the configured bucket. The component is alpha.

Component format

The following example authenticates using an OCI configuration file:

apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
 name: oci-files
spec:
 type: binarystore.oci.objectstorage
 version: v1
 metadata:
 - name: configFileAuthentication
 value: "true"
 - name: configFilePath
 value: "/home/app/.oci/config"
 - name: configFileProfile
 value: "DEFAULT"
 - name: bucketName
 value: "binary-files"
 - name: compartmentOCID
 value: "<COMPARTMENT_OCID>"
 - name: namespace
 value: "<OBJECT_STORAGE_NAMESPACE>"

The configuration file must be available at the specified path inside the sidecar’s environment. Protect credentials in the file using your deployment’s secret-management practices.