Pub/sub brokers component specs on Dapr Docs

Apache Kafka

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

Component format

To set up Apache Kafka pub/sub, create a component of type pubsub.kafka. See the pub/sub broker component file to learn how ConsumerID is automatically generated. Read the How-to: Publish and Subscribe guide on how to create and apply a pub/sub configuration.

All component metadata field values can carry templated metadata values, which are resolved on Dapr sidecar startup. For example, you can choose to use {namespace} as the consumerGroup to enable using the same appId in different namespaces using the same topics as described in this article.

AWS SNS/SQS

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

Component format

To set up AWS SNS/SQS pub/sub, create a component of type pubsub.aws.snssqs.

By default, the AWS SNS/SQS component:

Generates the SNS topics
Provisions the SQS queues
Configures a subscription of the queues to the topics

Note

If you only have a publisher and no subscriber, only the SNS topics are created.

However, if you have a subscriber, SNS, SQS, and the dynamic or static subscription thereof are generated.

Azure Event Hubs

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

Component format

To set up an Azure Event Hubs pub/sub, create a component of type pubsub.azure.eventhubs. See the pub/sub broker component file to learn how ConsumerID is automatically generated. Read the How-to: Publish and Subscribe guide on how to create and apply a pub/sub configuration.

Apart from the configuration metadata fields shown below, Azure Event Hubs also supports Azure Authentication mechanisms.

apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
 name: eventhubs-pubsub
spec:
 type: pubsub.azure.eventhubs
 version: v1
 metadata:
 # Either connectionString or eventHubNamespace is required
 # Use connectionString when *not* using Microsoft Entra ID
 - name: connectionString
 value: "Endpoint=sb://{EventHubNamespace}.servicebus.windows.net/;SharedAccessKeyName={PolicyName};SharedAccessKey={Key};EntityPath={EventHub}"
 # Use eventHubNamespace when using Microsoft Entra ID
 - name: eventHubNamespace
 value: "namespace"
 - name: consumerID # Optional. If not supplied, the runtime will create one.
 value: "channel1"
 - name: enableEntityManagement
 value: "false"
 - name: enableInOrderMessageDelivery
 value: "false"
 # The following four properties are needed only if enableEntityManagement is set to true
 - name: resourceGroupName
 value: "test-rg"
 - name: subscriptionID
 value: "value of Azure subscription ID"
 - name: partitionCount
 value: "1"
 - name: messageRetentionInDays
 value: "3"
 # Checkpoint store attributes
 - name: storageAccountName
 value: "myeventhubstorage"
 - name: storageAccountKey
 value: "112233445566778899"
 - name: storageContainerName
 value: "myeventhubstoragecontainer"
 # Alternative to passing storageAccountKey
 - name: storageConnectionString
 value: "DefaultEndpointsProtocol=https;AccountName=<account>;AccountKey=<account-key>"

Warning

The above example uses secrets as plain strings. It is recommended to use a secret store for the secrets as described here.

Spec metadata fields

Field	Required	Details	Example
`connectionString`	Y*	Connection string for the Event Hub or the Event Hub namespace. * Mutually exclusive with `eventHubNamespace` field. * Required when not using Microsoft Entra ID Authentication	`"Endpoint=sb://{EventHubNamespace}.servicebus.windows.net/;SharedAccessKeyName={PolicyName};SharedAccessKey={Key};EntityPath={EventHub}"` or `"Endpoint=sb://{EventHubNamespace}.servicebus.windows.net/;SharedAccessKeyName={PolicyName};SharedAccessKey={Key}"`
`eventHubNamespace`	Y*	The Event Hub Namespace name. * Mutually exclusive with `connectionString` field. * Required when using Microsoft Entra ID Authentication	`"namespace"`
`consumerID`	N	Consumer ID (consumer tag) organizes one or more consumers into a group. Consumers with the same consumer ID work as one virtual consumer; for example, a message is processed only once by one of the consumers in the group. If the `consumerID` is not provided, the Dapr runtime set it to the Dapr application ID (`appID`) value.	Can be set to string value (such as `"channel1"` in the example above) or string format value (such as `"{podName}"`, etc.). See all of template tags you can use in your component metadata.
`enableEntityManagement`	N	Boolean value to allow management of the EventHub namespace and storage account. Default: `false`	`"true", "false"`
`enableInOrderMessageDelivery`	N	Input/Output	Boolean value to allow messages to be delivered in the order in which they were posted. This assumes `partitionKey` is set when publishing or posting to ensure ordering across partitions. Default: `false`
`storageAccountName`	Y	Storage account name to use for the checkpoint store.	`"myeventhubstorage"`
`storageAccountKey`	Y*	Storage account key for the checkpoint store account. * When using Microsoft Entra ID, it’s possible to omit this if the service principal has access to the storage account too.	`"112233445566778899"`
`storageConnectionString`	Y*	Connection string for the checkpoint store, alternative to specifying `storageAccountKey`	`"DefaultEndpointsProtocol=https;AccountName=myeventhubstorage;AccountKey=<account-key>"`
`storageContainerName`	Y	Storage container name for the storage account name.	`"myeventhubstoragecontainer"`
`resourceGroupName`	N	Name of the resource group the Event Hub namespace is part of. Required when entity management is enabled	`"test-rg"`
`subscriptionID`	N	Azure subscription ID value. Required when entity management is enabled	`"azure subscription id"`
`partitionCount`	N	Number of partitions for the new Event Hub namespace. Used only when entity management is enabled. Default: `"1"`	`"2"`
`messageRetentionInDays`	N	Number of days to retain messages for in the newly created Event Hub namespace. Used only when entity management is enabled. Default: `"1"`	`"90"`

Microsoft Entra ID authentication

The Azure Event Hubs pub/sub component supports authentication using all Microsoft Entra ID mechanisms. For further information and the relevant component metadata fields to provide depending on the choice of Microsoft Entra ID authentication mechanism, see the docs for authenticating to Azure.

Azure Service Bus Queues

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

Component format

To set up Azure Service Bus Queues pub/sub, create a component of type pubsub.azure.servicebus.queues. See the pub/sub broker component file to learn how ConsumerID is automatically generated. Read the How-to: Publish and Subscribe guide on how to create and apply a pub/sub configuration.

This component uses queues on Azure Service Bus; see the official documentation for the differences between topics and queues. For using topics, see the Azure Service Bus Topics pubsub component.

Azure Service Bus Topics

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

Component format

To set up Azure Service Bus Topics pub/sub, create a component of type pubsub.azure.servicebus.topics. See the pub/sub broker component file to learn how ConsumerID is automatically generated. Read the How-to: Publish and Subscribe guide on how to create and apply a pub/sub configuration.

This component uses topics on Azure Service Bus; see the official documentation for the differences between topics and queues.
For using queues, see the Azure Service Bus Queues pubsub component.

GCP

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

Create a Dapr component

To set up GCP pub/sub, create a component of type pubsub.gcp.pubsub. See the pub/sub broker component file to learn how ConsumerID is automatically generated. Read the How-to: Publish and Subscribe guide on how to create and apply a pub/sub configuration.

apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
 name: gcp-pubsub
spec:
 type: pubsub.gcp.pubsub
 version: v1
 metadata:
 - name: type
 value: service_account
 - name: projectId
 value: <PROJECT_ID> # replace
 - name: endpoint # Optional.
 value: "http://localhost:8085"
 - name: consumerID # Optional - defaults to the app's own ID
 value: <CONSUMER_ID>
 - name: identityProjectId
 value: <IDENTITY_PROJECT_ID> # replace
 - name: privateKeyId
 value: <PRIVATE_KEY_ID> #replace
 - name: clientEmail
 value: <CLIENT_EMAIL> #replace
 - name: clientId
 value: <CLIENT_ID> # replace
 - name: authUri
 value: https://accounts.google.com/o/oauth2/auth
 - name: tokenUri
 value: https://oauth2.googleapis.com/token
 - name: authProviderX509CertUrl
 value: https://www.googleapis.com/oauth2/v1/certs
 - name: clientX509CertUrl
 value: https://www.googleapis.com/robot/v1/metadata/x509/<PROJECT_NAME>.iam.gserviceaccount.com #replace PROJECT_NAME
 - name: privateKey
 value: <PRIVATE_KEY> # replace x509 cert
 - name: disableEntityManagement
 value: "false"
 - name: enableMessageOrdering
 value: "false"
 - name: orderingKey # Optional
 value: <ORDERING_KEY>
 - name: maxReconnectionAttempts # Optional
 value: 30
 - name: connectionRecoveryInSec # Optional
 value: 2
 - name: deadLetterTopic # Optional
 value: <EXISTING_PUBSUB_TOPIC>
 - name: maxDeliveryAttempts # Optional
 value: 5
 - name: maxOutstandingMessages # Optional
 value: 1000
 - name: maxOutstandingBytes # Optional
 value: 1000000000
 - name: maxConcurrentConnections # Optional
 value: 10

Warning

The above example uses secrets as plain strings. It is recommended to use a secret store for the secrets as described here.

Spec metadata fields

Field	Required	Details	Example
projectId	Y	GCP project ID	`myproject-123`
endpoint	N	GCP endpoint for the component to use. Only used for local development (for example) with GCP Pub/Sub Emulator. The `endpoint` is unnecessary when running against the GCP production API.	`"http://localhost:8085"`
`consumerID`	N	The Consumer ID organizes one or more consumers into a group. Consumers with the same consumer ID work as one virtual consumer; for example, a message is processed only once by one of the consumers in the group. If the `consumerID` is not provided, the Dapr runtime set it to the Dapr application ID (`appID`) value. The `consumerID`, along with the `topic` provided as part of the request, are used to build the Pub/Sub subscription ID	Can be set to string value (such as `"channel1"`) or string format value (such as `"{podName}"`, etc.). See all of template tags you can use in your component metadata.
identityProjectId	N	If the GCP pubsub project is different from the identity project, specify the identity project using this attribute	`"myproject-123"`
privateKeyId	N	If using explicit credentials, this field should contain the `private_key_id` field from the service account json document	`"my-private-key"`
privateKey	N	If using explicit credentials, this field should contain the `private_key` field from the service account json	`-----BEGIN PRIVATE KEY-----MIIBVgIBADANBgkqhkiG9w0B`
clientEmail	N	If using explicit credentials, this field should contain the `client_email` field from the service account json	`"myservice@myproject-123.iam.gserviceaccount.com"`
clientId	N	If using explicit credentials, this field should contain the `client_id` field from the service account json	`106234234234`
authUri	N	If using explicit credentials, this field should contain the `auth_uri` field from the service account json	`https://accounts.google.com/o/oauth2/auth`
tokenUri	N	If using explicit credentials, this field should contain the `token_uri` field from the service account json	`https://oauth2.googleapis.com/token`
authProviderX509CertUrl	N	If using explicit credentials, this field should contain the `auth_provider_x509_cert_url` field from the service account json	`https://www.googleapis.com/oauth2/v1/certs`
clientX509CertUrl	N	If using explicit credentials, this field should contain the `client_x509_cert_url` field from the service account json	`https://www.googleapis.com/robot/v1/metadata/x509/myserviceaccount%40myproject.iam.gserviceaccount.com`
disableEntityManagement	N	When set to `"true"`, topics and subscriptions do not get created automatically. Default: `"false"`	`"true"`, `"false"`
enableMessageOrdering	N	When set to `"true"`, subscribed messages will be received in order, depending on publishing and permissions configuration.	`"true"`, `"false"`
orderingKey	N	The key provided in the request. It’s used when `enableMessageOrdering` is set to `true` to order messages based on such key.	“my-orderingkey”
maxReconnectionAttempts	N	Defines the maximum number of reconnect attempts. Default: `30`	`30`
connectionRecoveryInSec	N	Time in seconds to wait between connection recovery attempts. Default: `2`	`2`
deadLetterTopic	N	Name of the GCP Pub/Sub Topic. This topic must exist before using this component.	`"myapp-dlq"`
maxDeliveryAttempts	N	Maximum number of attempts to deliver the message. If `deadLetterTopic` is specified, `maxDeliveryAttempts` is the maximum number of attempts for failed processing of messages. Once that number is reached, the message will be moved to the dead-letter topic. Default: `5`	`5`
type	N	DEPRECATED GCP credentials type. Only `service_account` is supported. Defaults to `service_account`	`service_account`
maxOutstandingMessages	N	Maximum number of outstanding messages a given streaming-pull connection can have. Default: `1000`	`50`
maxOutstandingBytes	N	Maximum number of outstanding bytes a given streaming-pull connection can have. Default: `1000000000`	`1000000000`
maxConcurrentConnections	N	Maximum number of concurrent streaming-pull connections to be maintained. Default: `10`	`2`
ackDeadline	N	Message acknowledgement duration deadline. Default: `20s`	`1m`

Warning

If enableMessageOrdering is set to “true”, the roles/viewer or roles/pubsub.viewer role will be required on the service account in order to guarantee ordering in cases where order tokens are not embedded in the messages. If this role is not given, or the call to Subscription.Config() fails for any other reason, ordering by embedded order tokens will still function correctly.

GCP Credentials

Since the GCP Pub/Sub component uses the GCP Go Client Libraries, by default it authenticates using Application Default Credentials. This is explained further in the Authenticate to GCP Cloud services using client libraries guide.

In-memory

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

The in-memory pub/sub component operates within a single Dapr sidecar. This is primarily meant for development purposes. State is not replicated across multiple sidecars and is lost when the Dapr sidecar is restarted.

Component format

apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
 name: pubsub
spec:
 type: pubsub.in-memory
 version: v1
 metadata: []

Note: in-memory does not require any specific metadata for the component to work, however spec.metadata is a required field.

JetStream

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

Component format

To set up JetStream pub/sub, create a component of type pubsub.jetstream. See the pub/sub broker component file to learn how ConsumerID is automatically generated. Read the How-to: Publish and Subscribe guide on how to create and apply a pub/sub configuration.

apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
 name: jetstream-pubsub
spec:
 type: pubsub.jetstream
 version: v1
 metadata:
 - name: natsURL
 value: "nats://localhost:4222"
 - name: jwt # Optional. Used for decentralized JWT authentication.
 value: "eyJhbGciOiJ...6yJV_adQssw5c"
 - name: seedKey # Optional. Used for decentralized JWT authentication.
 value: "SUACS34K232O...5Z3POU7BNIL4Y"
 - name: tls_client_cert # Optional. Used for TLS Client authentication.
 value: "/path/to/tls.crt"
 - name: tls_client_key # Optional. Used for TLS Client authentication.
 value: "/path/to/tls.key"
 - name: token # Optional. Used for token based authentication.
 value: "my-token"
 - name: name
 value: "my-conn-name"
 - name: streamName
 value: "my-stream"
 - name: durableName 
 value: "my-durable-subscription"
 - name: queueGroupName
 value: "my-queue-group"
 - name: startSequence
 value: 1
 - name: startTime # In Unix format
 value: 1630349391
 - name: flowControl
 value: false
 - name: ackWait
 value: 10s
 - name: maxDeliver
 value: 5
 - name: backOff
 value: "50ms, 1s, 10s"
 - name: maxAckPending
 value: 5000
 - name: replicas
 value: 1
 - name: memoryStorage
 value: false
 - name: rateLimit
 value: 1024
 - name: heartbeat
 value: 15s
 - name: ackPolicy
 value: explicit
 - name: deliverPolicy
 value: all
 - name: domain
 value: hub
 - name: apiPrefix
 value: PREFIX

Spec metadata fields

Field	Required	Details	Example
natsURL	Y	NATS server address URL	`"nats://localhost:4222"`
jwt	N	NATS decentralized authentication JWT	`"eyJhbGciOiJ...6yJV_adQssw5c"`
seedKey	N	NATS decentralized authentication seed key	`"SUACS34K232O...5Z3POU7BNIL4Y"`
tls_client_cert	N	NATS TLS Client Authentication Certificate	`"/path/to/tls.crt"`
tls_client_key	N	NATS TLS Client Authentication Key	`"/path/to/tls.key"`
token	N	NATS token based authentication	`"my-token"`
name	N	NATS connection name	`"my-conn-name"`
streamName	N	Name of the JetStream Stream to bind to	`"my-stream"`
durableName	N	Durable name	`"my-durable"`
queueGroupName	N	Queue group name	`"my-queue"`
startSequence	N	Start Sequence	`1`
startTime	N	Start Time in Unix format	`1630349391`
flowControl	N	Flow Control	`true`
ackWait	N	Ack Wait	`10s`
maxDeliver	N	Max Deliver	`15`
backOff	N	BackOff	`"50ms, 1s, 5s, 10s"`
maxAckPending	N	Max Ack Pending	`5000`
replicas	N	Replicas	`3`
memoryStorage	N	Memory Storage	`false`
rateLimit	N	Rate Limit	`1024`
heartbeat	N	Heartbeat	`10s`
ackPolicy	N	Ack Policy	`explicit`
deliverPolicy	N	One of: all, last, new, sequence, time	`all`
domain	N	[JetStream Leafondes]	`HUB`
apiPrefix	N	[JetStream Leafnodes]	`PREFIX`

Create a NATS server

You can run a NATS Server with JetStream enabled locally using Docker:

KubeMQ

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

Component format

To set up KubeMQ pub/sub, create a component of type pubsub.kubemq. See the pub/sub broker component file to learn how ConsumerID is automatically generated. Read the How-to: Publish and Subscribe guide on how to create and apply a pub/sub configuration.

apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
 name: kubemq-pubsub
spec:
 type: pubsub.kubemq
 version: v1
 metadata:
 - name: address
 value: localhost:50000
 - name: store
 value: false
 - name: consumerID
 value: channel1

Spec metadata fields

Field	Required	Details	Example
address	Y	Address of the KubeMQ server	`"localhost:50000"`
store	N	type of pubsub, true: pubsub persisted (EventsStore), false: pubsub in-memory (Events)	`true` or `false` (default is `false`)
consumerID	N	Consumer ID (consumer tag) organizes one or more consumers into a group. Consumers with the same consumer ID work as one virtual consumer; for example, a message is processed only once by one of the consumers in the group. If the `consumerID` is not provided, the Dapr runtime set it to the Dapr application ID (`appID`) value.	Can be set to string value (such as `"channel1"` in the example above) or string format value (such as `"{podName}"`, etc.). See all of template tags you can use in your component metadata.
clientID	N	Name for client id connection	`sub-client-12345`
authToken	N	Auth JWT token for connection Check out KubeMQ Authentication	`ew...`
group	N	Subscriber group for load balancing	`g1`
disableReDelivery	N	Set if message should be re-delivered in case of error coming from application	`true` or `false` (default is `false`)

Create a KubeMQ broker

Obtain KubeMQ Key.
Wait for an email confirmation with your Key

You can run a KubeMQ broker with Docker:

MQTT

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

Component format

To set up MQTT pub/sub, create a component of type pubsub.mqtt. See the pub/sub broker component file to learn how ConsumerID is automatically generated. Read the How-to: Publish and Subscribe guide on how to create and apply a pub/sub configuration.

apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
 name: mqtt-pubsub
spec:
 type: pubsub.mqtt
 version: v1
 metadata:
 - name: url
 value: "tcp://[username][:password]@host.domain[:port]"
 - name: qos
 value: 1
 - name: retain
 value: "false"
 - name: cleanSession
 value: "false"
 - name: consumerID
 value: "channel1"

Warning

The above example uses secrets as plain strings. It is recommended to use a secret store for the secrets as described here.

Spec metadata fields

Field	Required	Details	Example
url	Y	Address of the MQTT broker. Can be `secretKeyRef` to use a secret reference. Use the `tcp://` URI scheme for non-TLS communication. Use the `ssl://` URI scheme for TLS communication.	`"tcp://[username][:password]@host.domain[:port]"`
consumerID	N	The client ID used to connect to the MQTT broker for the consumer connection. Defaults to the Dapr app ID. Note: if `producerID` is not set, `-consumer` is appended to this value for the consumer connection	Can be set to string value (such as `"channel1"` in the example above) or string format value (such as `"{podName}"`, etc.). See all of template tags you can use in your component metadata.
producerID	N	The client ID used to connect to the MQTT broker for the producer connection. Defaults to `{consumerID}-producer`.	`"myMqttProducerApp"`
qos	N	Indicates the Quality of Service Level (QoS) of the message (more info). Defaults to `1`.	`0`, `1`, `2`
retain	N	Defines whether the message is saved by the broker as the last known good value for a specified topic. Defaults to `"false"`.	`"true"`, `"false"`
cleanSession	N	Sets the `clean_session` flag in the connection message to the MQTT broker if `"true"` (more info). Defaults to `"false"`.	`"true"`, `"false"`
caCert	Required for using TLS	Certificate Authority (CA) certificate in PEM format for verifying server TLS certificates.	`"-----BEGIN CERTIFICATE-----\n<base64-encoded DER>\n-----END CERTIFICATE-----"`
clientCert	Required for using TLS	TLS client certificate in PEM format. Must be used with `clientKey`.	`"-----BEGIN CERTIFICATE-----\n<base64-encoded DER>\n-----END CERTIFICATE-----"`
clientKey	Required for using TLS	TLS client key in PEM format. Must be used with `clientCert`. Can be `secretKeyRef` to use a secret reference.	`"-----BEGIN RSA PRIVATE KEY-----\n<base64-encoded PKCS8>\n-----END RSA PRIVATE KEY-----"`

Enabling message delivery retries

The MQTT pub/sub component has no built-in support for retry strategies. This means that the sidecar sends a message to the service only once. If the service marks the message as not processed, the message won’t be acknowledged back to the broker. Only if broker resends the message, would it would be retried.

MQTT3

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

Component format

To set up a MQTT3 pub/sub, create a component of type pubsub.mqtt3. See the pub/sub broker component file to learn how ConsumerID is automatically generated. Read the How-to: Publish and Subscribe guide on how to create and apply a pub/sub configuration.

apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
 name: mqtt-pubsub
spec:
 type: pubsub.mqtt3
 version: v1
 metadata:
 - name: url
 value: "tcp://[username][:password]@host.domain[:port]"
 # Optional
 - name: retain
 value: "false"
 - name: cleanSession
 value: "false"
 - name: qos
 value: "1"
 - name: consumerID
 value: "channel1"

Warning

The above example uses secrets as plain strings. It is recommended to use a secret store for the secrets as described here.

Spec metadata fields

Field	Required	Details	Example
`url`	Y	Address of the MQTT broker. Can be `secretKeyRef` to use a secret reference. Use the `tcp://` URI scheme for non-TLS communication. Use the `ssl://` URI scheme for TLS communication.	`"tcp://[username][:password]@host.domain[:port]"`
`consumerID`	N	The client ID used to connect to the MQTT broker. Defaults to the Dapr app ID.	Can be set to string value (such as `"channel1"` in the example above) or string format value (such as `"{podName}"`, etc.). See all of template tags you can use in your component metadata.
`retain`	N	Defines whether the message is saved by the broker as the last known good value for a specified topic. Defaults to `"false"`.	`"true"`, `"false"`
`cleanSession`	N	Sets the `clean_session` flag in the connection message to the MQTT broker if `"true"` (more info). Defaults to `"false"`.	`"true"`, `"false"`
`caCert`	Required for using TLS	Certificate Authority (CA) certificate in PEM format for verifying server TLS certificates.	See example below
`clientCert`	Required for using TLS	TLS client certificate in PEM format. Must be used with `clientKey`.	See example below
`clientKey`	Required for using TLS	TLS client key in PEM format. Must be used with `clientCert`. Can be `secretKeyRef` to use a secret reference.	See example below
`qos`	N	Indicates the Quality of Service Level (QoS) of the message (more info). Defaults to `1`.	`0`, `1`, `2`

Communication using TLS

To configure communication using TLS, ensure that the MQTT broker (for example, emqx) is configured to support certificates and provide the caCert, clientCert, clientKey metadata in the component configuration. For example:

Pulsar

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

Component format

To set up Apache Pulsar pub/sub, create a component of type pubsub.pulsar. See the pub/sub broker component file to learn how ConsumerID is automatically generated. Read the How-to: Publish and Subscribe guide on how to create and apply a pub/sub configuration.

For more information on Apache Pulsar, read the official docs.

apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
 name: pulsar-pubsub
spec:
 type: pubsub.pulsar
 version: v1
 metadata:
 - name: host
 value: "localhost:6650"
 - name: enableTLS
 value: "false"
 - name: tenant
 value: "public"
 - name: token
 value: "eyJrZXlJZCI6InB1bHNhci1wajU0cXd3ZHB6NGIiLCJhbGciOiJIUzI1NiJ9.eyJzd"
 - name: consumerID
 value: "channel1"
 - name: namespace
 value: "default"
 - name: persistent
 value: "true"
 - name: disableBatching
 value: "false"
 - name: receiverQueueSize
 value: "1000"
 - name: <topic-name>.jsonschema # sets a json schema validation for the configured topic
 value: |
 {
 "type": "record",
 "name": "Example",
 "namespace": "test",
 "fields": [
 {"name": "ID","type": "int"},
 {"name": "Name","type": "string"}
 ]
 }
 - name: <topic-name>.avroschema # sets an avro schema validation for the configured topic
 value: |
 {
 "type": "record",
 "name": "Example",
 "namespace": "test",
 "fields": [
 {"name": "ID","type": "int"},
 {"name": "Name","type": "string"}
 ]
 }

Warning

The above example uses secrets as plain strings. It is recommended to use a secret store for the secrets. This component supports storing the token parameter and any other sensitive parameter and data as Kubernetes Secrets.

Spec metadata fields

Field	Required	Details	Example
host	Y	Address of the Pulsar broker. Default is `"localhost:6650"`	`"localhost:6650"` OR `"http://pulsar-pj54qwwdpz4b-pulsar.ap-sg.public.pulsar.com:8080"`
enableTLS	N	Enable TLS. Default: `"false"`	`"true"`, `"false"`
tenant	N	The topic tenant within the instance. Tenants are essential to multi-tenancy in Pulsar, and spread across clusters. Default: `"public"`	`"public"`
consumerID	N	Used to set the subscription name or consumer ID.	Can be set to string value (such as `"channel1"` in the example above) or string format value (such as `"{podName}"`, etc.). See all of template tags you can use in your component metadata.
namespace	N	The administrative unit of the topic, which acts as a grouping mechanism for related topics. Default: `"default"`	`"default"`
persistent	N	Pulsar supports two kinds of topics: persistent and non-persistent. With persistent topics, all messages are durably persisted on disks (if the broker is not standalone, messages are durably persisted on multiple disks), whereas data for non-persistent topics is not persisted to storage disks.
disableBatching	N	disable batching.When batching enabled default batch delay is set to 10 ms and default batch size is 1000 messages,Setting `disableBatching: true` will make the producer to send messages individually. Default: `"false"`	`"true"`, `"false"`
receiverQueueSize	N	Sets the size of the consumer receiver queue. Controls how many messages can be accumulated by the consumer before it is explicitly called to read messages by Dapr. Default: `"1000"`	`"1000"`
redeliveryDelay	N	Delay before redelivering a message that was not acknowledged by the app. Default: `"30s"`	`"30s"`, `"200ms"`
batchingMaxPublishDelay	N	batchingMaxPublishDelay set the time period within which the messages sent will be batched,if batch messages are enabled. If set to a non zero value, messages will be queued until this time interval or batchingMaxMessages (see below) or batchingMaxSize (see below). There are two valid formats, one is the fraction with a unit suffix format, and the other is the pure digital format that is processed as milliseconds. Valid time units are “ns”, “us” (or “µs”), “ms”, “s”, “m”, “h”. Default: `"10ms"`	`"10ms"`, `"10"`
batchingMaxMessages	N	batchingMaxMessages set the maximum number of messages permitted in a batch.If set to a value greater than 1, messages will be queued until this threshold is reached or batchingMaxSize (see below) has been reached or the batch interval has elapsed. Default: `"1000"`	`"1000"`
batchingMaxSize	N	batchingMaxSize sets the maximum number of bytes permitted in a batch. If set to a value greater than 1, messages will be queued until this threshold is reached or batchingMaxMessages (see above) has been reached or the batch interval has elapsed. Default: `"128KB"`	`"131072"`
compressionType	N	Sets the compression type for messages sent by the producer. Default: `"none"`	`"none"`, `"lz4"`, `"zlib"`, `"zstd"`
compressionLevel	N	Sets the compression level used when `compressionType` is enabled. Default: `"default"`	`"default"`, `"faster"`, `"better"`
.jsonschema	N	Enforces JSON schema validation for the configured topic.
.avroschema	N	Enforces Avro schema validation for the configured topic.
.rawschema	N	Registers the provided Avro or JSON schema as-is instead of wrapping it in a CloudEvents envelope schema. Default: `"false"`	`"true"`, `"false"`
publicKey	N	A public key to be used for publisher and consumer encryption. Value can be one of two options: file path for a local PEM cert, or the cert data string value
privateKey	N	A private key to be used for consumer encryption. Value can be one of two options: file path for a local PEM cert, or the cert data string value
keys	N	A comma delimited string containing names of Pulsar session keys. Used in conjunction with `publicKey` for publisher encryption
processMode	N	Enable processing multiple messages at once. Default: `"async"`	`"async"`, `"sync"`
subscribeType	N	Pulsar supports four kinds of subscription types. Default: `"shared"`	`"shared"`, `"exclusive"`, `"failover"`, `"key_shared"`
subscribeInitialPosition	N	Subscription position is the initial position which the cursor is set when start consuming. Default: `"latest"`	`"latest"`, `"earliest"`
subscribeMode	N	Subscription mode indicates the cursor persistence, durable subscription retains messages and persists the current position. Default: `"durable"`	`"durable"`, `"non_durable"`
partitionKey	N	Sets the key of the message for routing policy. Default: `""`
`maxConcurrentHandlers`	N	Defines the maximum number of concurrent message handlers. Default: `100`	`10`
replicateSubscriptionState	N	Enable replication of subscription state across geo-replicated Pulsar clusters. Default: `"false"`	`"true"`, `"false"`

Authenticate using Token

To authenticate to pulsar using a static JWT token, you can use the following metadata field:

RabbitMQ

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

Component format

To set up RabbitMQ pub/sub, create a component of type pubsub.rabbitmq. See the pub/sub broker component file to learn how ConsumerID is automatically generated. Read the How-to: Publish and Subscribe guide on how to create and apply a pub/sub configuration.

apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
 name: rabbitmq-pubsub
spec:
 type: pubsub.rabbitmq
 version: v1
 metadata:
 - name: connectionString
 value: "amqp://localhost:5672"
 - name: protocol
 value: amqp 
 - name: hostname
 value: localhost 
 - name: username
 value: username
 - name: password
 value: password 
 - name: consumerID
 value: channel1
 - name: durable
 value: false
 - name: deletedWhenUnused
 value: false
 - name: autoAck
 value: false
 - name: deliveryMode
 value: 0
 - name: requeueInFailure
 value: false
 - name: prefetchCount
 value: 0
 - name: reconnectWait
 value: 0
 - name: concurrencyMode
 value: parallel
 - name: publisherConfirm
 value: false
 - name: enableDeadLetter # Optional enable dead Letter or not
 value: true
 - name: maxLen # Optional max message count in a queue
 value: 3000
 - name: maxLenBytes # Optional maximum length in bytes of a queue.
 value: 10485760
 - name: exchangeKind
 value: fanout
 - name: saslExternal
 value: false
 - name: ttlInSeconds
 value: 60
 - name: clientName
 value: {podName}
 - name: heartBeat
 value: 10s
 - name: publishMessagePropertiesToMetadata
 value: "true"

Warning

The above example uses secrets as plain strings. It is recommended to use a secret store for the secrets as described here.

Spec metadata fields

Field	Required	Details	Example
connectionString	Y*	The RabbitMQ connection string. *Mutually exclusive with protocol, hostname, username, password field	`amqp://user:pass@localhost:5672`
protocol	N*	The RabbitMQ protocol. *Mutually exclusive with connectionString field	`amqp`
hostname	N*	The RabbitMQ hostname. *Mutually exclusive with connectionString field	`localhost`
username	N*	The RabbitMQ username. *Mutually exclusive with connectionString field	`username`
password	N*	The RabbitMQ password. *Mutually exclusive with connectionString field	`password`
consumerID	N	Consumer ID (consumer tag) organizes one or more consumers into a group. Consumers with the same consumer ID work as one virtual consumer; for example, a message is processed only once by one of the consumers in the group. If the `consumerID` is not provided, the Dapr runtime set it to the Dapr application ID (`appID`) value.	Can be set to string value (such as `"channel1"` in the example above) or string format value (such as `"{podName}"`, etc.). See all of template tags you can use in your component metadata.
durable	N	Whether or not to use durable queues. Defaults to `"false"`	`"true"`, `"false"`
deletedWhenUnused	N	Whether or not the queue should be configured to auto-delete Defaults to `"true"`	`"true"`, `"false"`
autoAck	N	Whether or not the queue consumer should auto-ack messages. Defaults to `"false"`	`"true"`, `"false"`
deliveryMode	N	Persistence mode when publishing messages. Defaults to `"0"`. RabbitMQ treats `"2"` as persistent, all other numbers as non-persistent	`"0"`, `"2"`
requeueInFailure	N	Whether or not to requeue when sending a negative acknowledgement in case of a failure. Defaults to `"false"`	`"true"`, `"false"`
prefetchCount	N	Number of messages to prefetch. Consider changing this to a non-zero value for production environments. Defaults to `"0"`, which means that all available messages will be pre-fetched.	`"2"`
publisherConfirm	N	If enabled, client waits for publisher confirms after publishing a message. Defaults to `"false"`	`"true"`, `"false"`
reconnectWait	N	How long to wait (in seconds) before reconnecting if a connection failure occurs	`"0"`
concurrencyMode	N	`parallel` is the default, and allows processing multiple messages in parallel (limited by the `app-max-concurrency` annotation, if configured). Set to `single` to disable parallel processing. In most situations there’s no reason to change this.	`parallel`, `single`
enableDeadLetter	N	Enable forwarding Messages that cannot be handled to a dead-letter topic. Defaults to `"false"`	`"true"`, `"false"`
maxLen	N	The maximum number of messages of a queue and its dead letter queue (if dead letter enabled). If both `maxLen` and `maxLenBytes` are set then both will apply; whichever limit is hit first will be enforced. Defaults to no limit.	`"1000"`
maxLenBytes	N	Maximum length in bytes of a queue and its dead letter queue (if dead letter enabled). If both `maxLen` and `maxLenBytes` are set then both will apply; whichever limit is hit first will be enforced. Defaults to no limit.	`"1048576"`
exchangeKind	N	Exchange kind of the rabbitmq exchange. Defaults to `"fanout"`.	`"fanout"`,`"topic"`
saslExternal	N	With TLS, should the username be taken from an additional field (for example, CN). See RabbitMQ Authentication Mechanisms. Defaults to `"false"`.	`"true"`, `"false"`
ttlInSeconds	N	Set message TTL at the component level, which can be overwritten by message level TTL per request.	`"60"`
caCert	Required for using TLS	Certificate Authority (CA) certificate in PEM format for verifying server TLS certificates.	`"-----BEGIN CERTIFICATE-----\n<base64-encoded DER>\n-----END CERTIFICATE-----"`
clientCert	Required for using TLS	TLS client certificate in PEM format. Must be used with `clientKey`.	`"-----BEGIN CERTIFICATE-----\n<base64-encoded DER>\n-----END CERTIFICATE-----"`
clientKey	Required for using TLS	TLS client key in PEM format. Must be used with `clientCert`. Can be `secretKeyRef` to use a secret reference.	`"-----BEGIN RSA PRIVATE KEY-----\n<base64-encoded PKCS8>\n-----END RSA PRIVATE KEY-----"`
clientName	N	This RabbitMQ client-provided connection name is a custom identifier. If set, the identifier is mentioned in RabbitMQ server log entries and management UI. Can be set to {uuid}, {podName}, or {appID}, which is replaced by Dapr runtime to the real value.	`"app1"`, `{uuid}`, `{podName}`, `{appID}`
heartBeat	N	Defines the heartbeat interval with the server, detecting the aliveness of the peer TCP connection with the RabbitMQ server. Defaults to `10s` .	`"10s"`
`publishMessagePropertiesToMetadata`	N	Whether to publish AMQP message properties (headers, message ID, etc.) to the metadata.	“true”, “false”

Communication using TLS

To configure communication using TLS, ensure that the RabbitMQ nodes have TLS enabled and provide the caCert, clientCert, clientKey metadata in the component configuration. For example:

Redis Streams

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

Component format

To set up Redis Streams pub/sub, create a component of type pubsub.redis. See the pub/sub broker component file to learn how ConsumerID is automatically generated. Read the How-to: Publish and Subscribe guide on how to create and apply a pub/sub configuration.

apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
 name: redis-pubsub
spec:
 type: pubsub.redis
 version: v1
 metadata:
 - name: redisHost
 value: localhost:6379
 - name: redisPassword
 value: "KeFg23!"
 - name: consumerID
 value: "channel1"
 - name: useEntraID
 value: "true"
 - name: enableTLS
 value: "false"

Warning

The above example uses secrets as plain strings. It is recommended to use a secret store for the secrets as described here.

Spec metadata fields

Field	Required	Details	Example
redisHost	Y	Connection-string for the redis host. If `"redisType"` is `"cluster"`, it can be multiple hosts separated by commas or just a single host. When using Redis Sentinel (`"failover"` is `"true"`), multiple sentinel addresses can also be provided as comma-separated values.	`localhost:6379`, `redis-master.default.svc.cluster.local:6379`, `sentinel1:26379,sentinel2:26379,sentinel3:26379`
redisPassword	N	Password for Redis host. No Default. Can be `secretKeyRef` to use a secret reference	`""`, `"KeFg23!"`
redisUsername	N	Username for Redis host. Defaults to empty. Make sure your redis server version is 6 or above, and have created acl rule correctly.	`""`, `"default"`
consumerID	N	The consumer group ID.	Can be set to string value (such as `"channel1"` in the example above) or string format value (such as `"{podName}"`, etc.). See all of template tags you can use in your component metadata.
useEntraID	N	Implements EntraID support for Azure Cache for Redis. Before enabling this: The `redisHost` name must be specified in the form of `"server:port"` TLS must be enabled Learn more about this setting under Create a Redis instance > Azure Cache for Redis	`"true"`, `"false"`
enableTLS	N	If the Redis instance supports TLS with public certificates, can be configured to be enabled or disabled. Defaults to `"false"`	`"true"`, `"false"`
clientCert	N	The content of the client certificate, used for Redis instances that require client-side certificates. Must be used with `clientKey` and `enableTLS` must be set to true. It is recommended to use a secret store as described here	`"----BEGIN CERTIFICATE-----\nMIIC..."`
clientKey	N	The content of the client private key, used in conjunction with `clientCert` for authentication. It is recommended to use a secret store as described here	`"----BEGIN PRIVATE KEY-----\nMIIE..."`
redeliverInterval	N	The interval between checking for pending messages to redeliver. Can use either be Go duration string (for example “ms”, “s”, “m”) or milliseconds number. Defaults to `"60s"`. `"0"` disables redelivery.	`"30s"`, `"5000"`
processingTimeout	N	The amount time that a message must be pending before attempting to redeliver it. Can use either be Go duration string ( for example “ms”, “s”, “m”) or milliseconds number. Defaults to `"15s"`. `"0"` disables redelivery.	`"60s"`, `"600000"`
queueDepth	N	The size of the message queue for processing. Defaults to `"100"`.	`"1000"`
concurrency	N	The number of concurrent workers that are processing messages. Defaults to `"10"`.	`"15"`
redisType	N	The type of redis. There are two valid values, one is `"node"` for single node mode, the other is `"cluster"` for redis cluster mode. Defaults to `"node"`.	`"cluster"`
redisDB	N	Database selected after connecting to redis. If `"redisType"` is `"cluster"` this option is ignored. Defaults to `"0"`.	`"0"`
redisMaxRetries	N	Maximum number of times to retry commands before giving up. Default is to not retry failed commands.	`"5"`
redisMinRetryInterval	N	Minimum backoff for redis commands between each retry. Default is `"8ms"`; `"-1"` disables backoff.	`"8ms"`
redisMaxRetryInterval	N	Maximum backoff for redis commands between each retry. Default is `"512ms"`;`"-1"` disables backoff.	`"5s"`
dialTimeout	N	Dial timeout for establishing new connections. Defaults to `"5s"`.	`"5s"`
readTimeout	N	Timeout for socket reads, if set to `"0s"`, the read will be blocking. If reached, redis commands will fail with a timeout instead of blocking. Defaults to `"0s"`, `"-1"` for no timeout.	`"3s"`
writeTimeout	N	Timeout for socket writes. If reached, redis commands will fail with a timeout instead of blocking. Defaults is readTimeout.	`"3s"`
poolSize	N	Maximum number of socket connections. Default is 10 connections per every CPU as reported by runtime.NumCPU.	`"20"`
poolTimeout	N	Amount of time client waits for a connection if all connections are busy before returning an error. Default is readTimeout + 1 second.	`"5s"`
maxConnAge	N	Connection age at which the client retires (closes) the connection. Default is to not close aged connections.	`"30m"`
minIdleConns	N	Minimum number of idle connections to keep open in order to avoid the performance degradation associated with creating new connections. Defaults to `"0"`.	`"2"`
idleCheckFrequency	N	Frequency of idle checks made by idle connections reaper. Default is `"1m"`. `"-1"` disables idle connections reaper.	`"-1"`
idleTimeout	N	Amount of time after which the client closes idle connections. Should be less than server’s timeout. Default is `"5m"`. `"-1"` disables idle timeout check.	`"10m"`
failover	N	Property to enable failover configuration. Needs sentinelMasterName to be set. When enabled, redisHost should contain the sentinel addresses. Defaults to `"false"`	`"true"`, `"false"`
sentinelMasterName	N	The sentinel master name. See Redis Sentinel Documentation	`""`, `"mymaster"`
sentinelUsername	N	Username for Redis Sentinel. Applicable only when “failover” is true, and Redis Sentinel has authentication enabled	`"username"`
sentinelPassword	N	Password for Redis Sentinel. Applicable only when “failover” is true, and Redis Sentinel has authentication enabled	`"password"`
maxLenApprox	N	Maximum number of items inside a stream.The old entries are automatically evicted when the specified length is reached, so that the stream is left at a constant size. Defaults to unlimited.	`"10000"`
streamTTL	N	TTL duration for stream entries. Entries older than this duration will be evicted. This is an approximate value, as it’s implemented using Redis stream’s `MINID` trimming with the ‘~’ modifier. The actual retention may include slightly more entries than strictly defined by the TTL, as Redis optimizes the trimming operation for efficiency by potentially keeping some additional entries.	`"30d"`

Create a Redis instance

Dapr can use any Redis instance - containerized, running on your local dev machine, or a managed cloud service, provided the version of Redis is 5.x or 6.x.

RocketMQ

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

Component format

To set up RocketMQ pub/sub, create a component of type pubsub.rocketmq. See the pub/sub broker component file to learn how ConsumerID is automatically generated. Read the How-to: Publish and Subscribe guide on how to create and apply a pub/sub configuration.

apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
 name: rocketmq-pubsub
spec:
 type: pubsub.rocketmq
 version: v1
 metadata:
 - name: instanceName
 value: dapr-rocketmq-test
 - name: consumerGroup
 value: dapr-rocketmq-test-g-c
 - name: producerGroup 
 value: dapr-rocketmq-test-g-p
 - name: consumerID
 value: channel1
 - name: nameSpace
 value: dapr-test
 - name: nameServer
 value: "127.0.0.1:9876,127.0.0.2:9876"
 - name: retries
 value: 3
 - name: consumerModel
 value: "clustering"
 - name: consumeOrderly
 value: false

Warning

The above example uses secrets as plain strings. It is recommended to use a secret store for the secrets as described here.

Spec metadata fields

Field	Required	Details	default	Example
instanceName	N	Instance name	`time.Now().String()`	`dapr-rocketmq-test`
consumerGroup	N	Consumer group name. Recommend. If `producerGroup` is `null`，`groupName` is used.		`dapr-rocketmq-test-g-c`
producerGroup (consumerID)	N	Producer group name. Recommended. If `producerGroup` is `null`，`consumerID` is used. If `consumerID` also is null, `groupName` is used.		`dapr-rocketmq-test-g-p`
consumerID	N	Consumer ID (consumer tag) organizes one or more consumers into a group. Consumers with the same consumer ID work as one virtual consumer; for example, a message is processed only once by one of the consumers in the group. If the `consumerID` is not provided, the Dapr runtime set it to the Dapr application ID (`appID`) value.	Can be set to string value (such as `"channel1"` in the example above) or string format value (such as `"{podName}"`, etc.). See all of template tags you can use in your component metadata.
groupName	N	Consumer/Producer group name. Depreciated.		`dapr-rocketmq-test-g`
nameSpace	N	RocketMQ namespace		`dapr-rocketmq`
nameServerDomain	N	RocketMQ name server domain		`https://my-app.net:8080/nsaddr`
nameServer	N	RocketMQ name server, separated by “,” or “;”		`127.0.0.1:9876;127.0.0.2:9877,127.0.0.3:9877`
accessKey	N	Access Key (Username)		`"admin"`
secretKey	N	Secret Key (Password)		`"password"`
securityToken	N	Security Token
retries	N	Number of retries to send a message to broker	`3`	`3`
producerQueueSelector (queueSelector)	N	Producer Queue selector. There are five implementations of queue selector: `hash`, `random`, `manual`, `roundRobin`, `dapr`.	`dapr`	`hash`
consumerModel	N	Message model that defines how messages are delivered to each consumer client. RocketMQ supports two message models: `clustering` and `broadcasting`.	`clustering`	`broadcasting` , `clustering`
fromWhere (consumeFromWhere)	N	Consuming point on consumer booting. There are three consuming points: `CONSUME_FROM_LAST_OFFSET`, `CONSUME_FROM_FIRST_OFFSET`, `CONSUME_FROM_TIMESTAMP`	`CONSUME_FROM_LAST_OFFSET`	`CONSUME_FROM_LAST_OFFSET`
consumeTimestamp	N	Backtracks consumption time with second precision. Time format is `yyyymmddhhmmss`. For example, `20131223171201` implies the time of 17:12:01 and date of December 23, 2013	`time.Now().Add(time.Minute * (-30)).Format("20060102150405")`	`20131223171201`
consumeOrderly	N	Determines if it’s an ordered message using FIFO order.	`false`	`false`
consumeMessageBatchMaxSize	N	Batch consumption size out of range `[1, 1024]`	`512`	`10`
consumeConcurrentlyMaxSpan	N	Concurrently max span offset. This has no effect on sequential consumption. Range: `[1, 65535]`	`1000`	`1000`
maxReconsumeTimes	N	Max re-consume times. `-1` means 16 times. If messages are re-consumed more than {@link maxReconsumeTimes} before success, they’ll be directed to a deletion queue.	Orderly message is `MaxInt32`; Concurrently message is `16`	`16`
autoCommit	N	Enable auto commit	`true`	`false`
consumeTimeout	N	Maximum amount of time a message may block the consuming thread. Time unit: Minute	`15`	`15`
consumerPullTimeout	N	The socket timeout in milliseconds
pullInterval	N	Message pull interval	`100`	`100`
pullBatchSize	N	The number of messages pulled from the broker at a time. If `pullBatchSize` is `null`, use `ConsumerBatchSize`. `pullBatchSize` out of range `[1, 1024]`	`32`	`10`
pullThresholdForQueue	N	Flow control threshold on queue level. Each message queue will cache a maximum of 1000 messages by default. Consider the `PullBatchSize` - the instantaneous value may exceed the limit. Range: `[1, 65535]`	`1024`	`1000`
pullThresholdForTopic	N	Flow control threshold on topic level. The value of `pullThresholdForQueue` will be overwritten and calculated based on `pullThresholdForTopic` if it isn’t unlimited. For example, if the value of `pullThresholdForTopic` is 1000 and 10 message queues are assigned to this consumer, then `pullThresholdForQueue` will be set to 100. Range: `[1, 6553500]`	`-1(Unlimited)`	`10`
pullThresholdSizeForQueue	N	Limit the cached message size on queue level. Consider the `pullBatchSize` - the instantaneous value may exceed the limit. The size of a message is only measured by message body, so it’s not accurate. Range: `[1, 1024]`	`100`	`100`
pullThresholdSizeForTopic	N	Limit the cached message size on topic level. The value of `pullThresholdSizeForQueue` will be overwritten and calculated based on `pullThresholdSizeForTopic` if it isn’t unlimited. For example, if the value of `pullThresholdSizeForTopic` is 1000 MiB and 10 message queues are assigned to this consumer, then `pullThresholdSizeForQueue` will be set to 100 MiB. Range: `[1, 102400]`	`-1`	`100`
content-type	N	Message content type.	`"text/plain"`	`"application/cloudevents+json; charset=utf-8"`, `"application/octet-stream"`
logLevel	N	Log level	`warn`	`info`
sendTimeOut	N	Send message timeout to connect RocketMQ’s broker, measured in nanoseconds. Deprecated.	3 seconds	`10000000000`
sendTimeOutSec	N	Timeout duration for publishing a message in seconds. If `sendTimeOutSec` is `null`, `sendTimeOut` is used.	3 seconds	`3`
mspProperties	N	The RocketMQ message properties in this collection are passed to the APP in Data Separate multiple properties with “,”		`key,mkey`

For backwards-compatibility reasons, the following values in the metadata are supported, although their use is discouraged.

Solace-AMQP

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

Component format

To set up Solace-AMQP pub/sub, create a component of type pubsub.solace.amqp. See the pub/sub broker component file to learn how ConsumerID is automatically generated. Read the How-to: Publish and Subscribe guide on how to create and apply a pub/sub configuration.

apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
 name: solace
spec:
 type: pubsub.solace.amqp
 version: v1
 metadata:
 - name: url
 value: 'amqp://localhost:5672'
 - name: username
 value: 'default'
 - name: password
 value: 'default'
 - name: consumerID
 value: 'channel1'

Warning

The above example uses secrets as plain strings. It is recommended to use a secret store for the secrets as described here.

Spec metadata fields

Field	Required	Details	Example
url	Y	Address of the AMQP broker. Can be `secretKeyRef` to use a secret reference. Use the `amqp://` URI scheme for non-TLS communication. Use the `amqps://` URI scheme for TLS communication.	`"amqp://host.domain[:port]"`
username	Y	The username to connect to the broker. Only required if anonymous is not specified or set to `false` .	`default`
password	Y	The password to connect to the broker. Only required if anonymous is not specified or set to `false`.	`default`
consumerID	N	Consumer ID (consumer tag) organizes one or more consumers into a group. Consumers with the same consumer ID work as one virtual consumer; for example, a message is processed only once by one of the consumers in the group. If the `consumerID` is not provided, the Dapr runtime set it to the Dapr application ID (`appID`) value.	Can be set to string value (such as `"channel1"` in the example above) or string format value (such as `"{podName}"`, etc.). See all of template tags you can use in your component metadata.
anonymous	N	To connect to the broker without credential validation. Only works if enabled on the broker. A username and password would not be required if this is set to `true`.	`true`
caCert	Required for using TLS	Certificate Authority (CA) certificate in PEM format for verifying server TLS certificates.	`"-----BEGIN CERTIFICATE-----\n<base64-encoded DER>\n-----END CERTIFICATE-----"`
clientCert	Required for using TLS	TLS client certificate in PEM format. Must be used with `clientKey`.	`"-----BEGIN CERTIFICATE-----\n<base64-encoded DER>\n-----END CERTIFICATE-----"`
clientKey	Required for using TLS	TLS client key in PEM format. Must be used with `clientCert`. Can be `secretKeyRef` to use a secret reference.	`"-----BEGIN RSA PRIVATE KEY-----\n<base64-encoded PKCS8>\n-----END RSA PRIVATE KEY-----"`

Communication using TLS

To configure communication using TLS: