Bindings components

Guidance on setting up Dapr bindings components

Dapr integrates with external resources to allow apps to both be triggered by external events and interact with the resources. Each binding component has a name and this name is used when interacting with the resource.

As with other building block components, binding components are extensible and can be found in the components-contrib repo.

A binding in Dapr is described using a Component file with the following fields:

  1. apiVersion: dapr.io/v1alpha1
  2. kind: Component
  3. metadata:
  4.   name: <NAME>
  5.   namespace: <NAMESPACE>
  6. spec:
  7.   type: bindings.<NAME>
  8.   version: v1
  9.   metadata:
  10.   - name: <KEY>
  11.     value: <VALUE>
  12.   - name: <KEY>
  13.     value: <VALUE>
  14. ...

The type of binding is determined by the type field, and things like connection strings and other metadata are put in the .metadata section.

Different supported bindings will have different specific fields that would need to be configured. For example, when configuring a binding for Azure Blob Storage, the file would look like this:

  1. apiVersion: dapr.io/v1alpha1
  2. kind: Component
  3. metadata:
  4.   name: <NAME>
  5. spec:
  6.   type: bindings.azure.blobstorage
  7.   version: v1
  8.   metadata:
  9.   - name: storageAccount
  10.     value: myStorageAccountName
  11.   - name: storageAccessKey
  12.     value: ***********
  13.   - name: container
  14.     value: container1
  15.   - name: decodeBase64
  16.     value: <bool>
  17.   - name: getBlobRetryCount
  18.     value: <integer>

Apply the configuration

Once you have created the component’s YAML file, follow these instructions to apply it based on your hosting environment:

To run locally, create a components dir containing the YAML file and provide the path to the dapr run command with the flag --resources-path.

To deploy in Kubernetes, assuming your component file is named mybinding.yaml, run:

  1. kubectl apply -f mybinding.yaml

Supported bindings

Visit the bindings reference for a full list of supported resources.