Dapr Tutorials

• 1: Define a component
• 2: Tutorial: Configure state store and pub/sub message broker

1 - Define a component

When building an app, you’d most likely create your own component file definitions, depending on the building block and specific component that you’d like to use.

In this tutorial, you will create a component definition file to interact with the secrets building block API:

• Create a local JSON secret store.
• Register the secret store with Dapr using a component definition file.
• Obtain the secret using the Dapr HTTP API.

Step 1: Create a JSON secret store

1. Create a new directory named my-components to hold the new secret and component file:

   mkdir my-components
   

2. Navigate into this directory.

   cd my-components
   

3. Dapr supports many types of secret stores, but for this tutorial, create a local JSON file named mysecrets.json with the following secret:

{
   "my-secret" : "I'm Batman"
}

Step 2: Create a secret store Dapr component

1. Create a new file localSecretStore.yaml with the following contents:

   apiVersion: dapr.io/v1alpha1
   kind: Component
   metadata:
     name: my-secret-store
     namespace: default
   spec:
     type: secretstores.local.file
     version: v1
     metadata:
     - name: secretsFile
       value: ./mysecrets.json
     - name: nestedSeparator
       value: ":"
   

In the above file definition:

• type: secretstores.local.file tells Dapr to use the local file component as a secret store.
• The metadata fields provide component-specific information needed to work with this component. In this case, the secret store JSON path is relative to where you call dapr run.

Step 3: Run the Dapr sidecar

Launch a Dapr sidecar that will listen on port 3500 for a blank application named myapp:

PowerShell environment:

dapr run --app-id myapp --dapr-http-port 3500 --resources-path ../

non-PowerShell environment:

dapr run --app-id myapp --dapr-http-port 3500 --resources-path .

Step 4: Get a secret

In a separate terminal, run:

• HTTP API (Bash)
• HTTP API (PowerShell)

curl http://localhost:3500/v1.0/secrets/my-secret-store/my-secret

Invoke-RestMethod -Uri 'http://localhost:3500/v1.0/secrets/my-secret-store/my-secret'

Output:

{"my-secret":"I'm Batman"}

2 - Tutorial: Configure state store and pub/sub message broker

To get up and running with the state and Pub/sub building blocks, you’ll need two components:

• A state store component for persistence and restoration.
• As pub/sub message broker component for async-style message delivery.

A full list of supported components can be found here:

• Supported state stores
• Supported pub/sub message brokers

For this tutorial, we describe how to get up and running with Redis.

Step 1: Create a Redis store

Dapr can use any Redis instance, either:

• Containerized on your local dev machine, or
• A managed cloud service.

If you already have a Redis store, move on to the configuration section.

• Self-Hosted
• Kubernetes
• Azure
• AWS
• GCP

helm repo add bitnami https://charts.bitnami.com/bitnami
helm repo update
helm install redis bitnami/redis --set image.tag=6.2

$ kubectl get pods
NAME             READY   STATUS    RESTARTS   AGE
redis-master-0   1/1     Running   0          69s
redis-replicas-0    1/1     Running   0          69s
redis-replicas-1    1/1     Running   0          22s

Step 2: Configure Dapr components

Dapr defines resources to use for building block functionality with components. These steps go through how to connect the resources you created above to Dapr for state and pub/sub.

Locate your component files

• Self-Hosted
• Kubernetes

Create State store component

Create a file named redis-state.yaml, and paste the following:

• Self-Hosted
• Kubernetes

apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
  name: statestore
  namespace: default
spec:
  type: state.redis
  version: v1
  metadata:
  - name: redisHost
    value: localhost:6379
  - name: redisPassword
    secretKeyRef:
      name: redis
      key: redis-password
  # uncomment below for connecting to redis cache instances over TLS (ex - Azure Redis Cache)
  # - name: enableTLS
  #   value: true 

apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
  name: statestore
  namespace: default
spec:
  type: state.redis
  version: v1
  metadata:
  - name: redisHost
    value: <REPLACE WITH HOSTNAME FROM ABOVE - for Redis on Kubernetes it is redis-master.default.svc.cluster.local:6379>
  - name: redisPassword
    secretKeyRef:
      name: redis
      key: redis-password
  # uncomment below for connecting to redis cache instances over TLS (ex - Azure Redis Cache)
  # - name: enableTLS
  #   value: true 

Create Pub/sub message broker component

Create a file called redis-pubsub.yaml, and paste the following:

• Self-Hosted
• Kubernetes

apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
  name: pubsub
  namespace: default
spec:
  type: pubsub.redis
  version: v1
  metadata:
  - name: redisHost
    value: localhost:6379
  - name: redisPassword
    secretKeyRef:
      name: redis
      key: redis-password
 # uncomment below for connecting to redis cache instances over TLS (ex - Azure Redis Cache)
  # - name: enableTLS
  #   value: true 

apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
  name: pubsub
  namespace: default
spec:
  type: pubsub.redis
  version: v1
  metadata:
  - name: redisHost
    value: <REPLACE WITH HOSTNAME FROM ABOVE - for Redis on Kubernetes it is redis-master.default.svc.cluster.local:6379>
  - name: redisPassword
    secretKeyRef:
      name: redis
      key: redis-password
 # uncomment below for connecting to redis cache instances over TLS (ex - Azure Redis Cache)
  # - name: enableTLS
  #   value: true 

Hard coded passwords (not recommended)

For development purposes only, you can skip creating Kubernetes secrets and place passwords directly into the Dapr component file:

apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
  name: statestore
  namespace: default
spec:
  type: state.redis
  version: v1
  metadata:
  - name: redisHost
    value: <HOST>
  - name: redisPassword
    value: <PASSWORD>
  # uncomment below for connecting to redis cache instances over TLS (ex - Azure Redis Cache)
  # - name: enableTLS
  #   value: true 

apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
  name: pubsub
  namespace: default
spec:
  type: pubsub.redis
  version: v1
  metadata:
  - name: redisHost
    value: <HOST>
  - name: redisPassword
    value: <PASSWORD>
  # uncomment below for connecting to redis cache instances over TLS (ex - Azure Redis Cache)
  # - name: enableTLS
  #   value: true 

Step 3: Apply the configuration

• Self-Hosted
• Kubernetes

kubectl apply -f redis-state.yaml
kubectl apply -f redis-pubsub.yaml

Next steps

Try out a Dapr quickstart