Detailed documentation on the RocketMQ pubsub component

Component format

To setup RocketMQ pubsub, create a component of type pubsub.rocketmq. See this guide on how to create and apply a pubsub configuration.

kind: Component
  name: rocketmq-pubsub
  type: pubsub.rocketmq
  version: v1
    - name: nameServer
      value: "http://localhost:9876"
    - name: accessKey
      value: "admin"
    - name: secretKey
      value: "password"
    - name: consumerGroup
      value: "GID_0001"
    - name: retries
      value: 10

Spec metadata fields

Field Required Details Example
accessKey N Access Key (Username) "admin"
secretKey N Secret Key (Password) "password"
nameServer N Name server address ";"
nameServerDomain N Name server domain ""
nameSpace N Namespace of the producer/consumer "namespace"
groupName N Producer group name for RocketMQ publishers "my_unique_group_name"
consumerGroup N Consumer group name for RocketMQ subscribers "my_unique_group_name"
content-type N Message content-type, e.g., "application/cloudevents+json; charset=utf-8", "application/octet-stream" "text/plain"
retries N Number of times to retry to connect rocketmq’s broker, optional 0
sendTimeOut N Timeout duration for publishing a message in nanoseconds 0

Setup RocketMQ

See to setup a local RocketMQ instance.

Per-call metadata fields

Partition Key

When invoking the RocketMQ pub/sub, it’s possible to provide an optional partition key by using the metadata query param in the request url.

You need to specify rocketmq-tag,"rocketmq-key" in metadata


curl -X POST http://localhost:3500/v1.0/publish/myRocketMQ/myTopic?metadata.rocketmq-tag=?&metadata.rocketmq-key=? \
  -H "Content-Type: application/json" \
  -d '{
        "data": {
          "message": "Hi"