KubeMQ

Detailed documentation on the KubeMQ pubsub component

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.

  1. apiVersion: dapr.io/v1alpha1
  2. kind: Component
  3. metadata:
  4. name: kubemq-pubsub
  5. spec:
  6. type: pubsub.kubemq
  7. version: v1
  8. metadata:
  9. - name: address
  10. value: localhost:50000
  11. - name: store
  12. value: false
  13. - name: consumerID
  14. value: channel1

Spec metadata fields

FieldRequiredDetailsExample
addressYAddress of the KubeMQ server“localhost:50000”
storeNtype of pubsub, true: pubsub persisted (EventsStore), false: pubsub in-memory (Events)true or false (default is false)
consumerIDNConsumer 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.“channel1”
clientIDNName for client id connectionsub-client-12345
authTokenNAuth JWT token for connection Check out KubeMQ Authenticationew…
groupNSubscriber group for load balancingg1
disableReDeliveryNSet if message should be re-delivered in case of error coming from applicationtrue or false (default is false)

Create a KubeMQ broker

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

You can run a KubeMQ broker with Docker:

  1. docker run -d -p 8080:8080 -p 50000:50000 -p 9090:9090 -e KUBEMQ_TOKEN=<your-key> kubemq/kubemq

You can then interact with the server using the client port: localhost:50000

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

Then Run the following kubectl commands:

  1. kubectl apply -f https://deploy.kubemq.io/init
  1. kubectl apply -f https://deploy.kubemq.io/key/<your-key>

Install KubeMQ CLI

Go to KubeMQ CLI and download the latest version of the CLI.

Browse KubeMQ Dashboard

Open a browser and navigate to http://localhost:8080

With KubeMQCTL installed, run the following command:

  1. kubemqctl get dashboard

Or, with kubectl installed, run port-forward command:

  1. kubectl port-forward svc/kubemq-cluster-api -n kubemq 8080:8080

KubeMQ Documentation

Visit KubeMQ Documentation for more information.

Last modified March 21, 2024: Merge pull request #4082 from newbe36524/v1.13 (f4b0938)