4.1 KiB
| type | title | linkTitle | description | aliases | |
|---|---|---|---|---|---|
| docs | KubeMQ | KubeMQ | Detailed documentation on the KubeMQ pubsub component |
|
Component format
To setup KubeMQ pub/sub, create a component of type pubsub.kubemq. See [this guide]({{< ref "howto-publish-subscribe.md#step-1-setup-the-pubsub-component" >}}) 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
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) |
| 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
{{< tabs "Self-Hosted" "Kubernetes">}}
{{% codetab %}}
- Obtain KubeMQ Key by visiting https://account.kubemq.io/login/register and register for a key.
- Wait for an email confirmation with your Key
You can run a KubeMQ broker with Docker:
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
{{% /codetab %}}
{{% codetab %}}
- Obtain KubeMQ Key by visiting https://account.kubemq.io/login/register and register for a key.
- Wait for an email confirmation with your Key
Then Run the following kubectl commands:
kubectl apply -f https://deploy.kubemq.io/init
kubectl apply -f https://deploy.kubemq.io/key/<your-key>
{{% /codetab %}}
{{< /tabs >}}
Install KubeMQ CLI
Go to KubeMQ CLI and download the latest version of the CLI.
Browse KubeMQ Dashboard
{{< tabs "Self-Hosted" "Kubernetes">}}
{{% codetab %}}
Open a browser and navigate to http://localhost:8080
{{% /codetab %}}
{{% codetab %}} With KubeMQCTL installed, run the following command:
kubemqctl get dashboard
Or, with kubectl installed, run port-forward command:
kubectl port-forward svc/kubemq-cluster-api -n kubemq 8080:8080
{{% /codetab %}}
{{< /tabs >}}
## KubeMQ Documentation
Visit [KubeMQ Documentation](https://docs.kubemq.io/) for more information.
## Related links
- [Basic schema for a Dapr component]({{< ref component-schema >}})
- Read [this guide]({{< ref "howto-publish-subscribe.md#step-2-publish-a-topic" >}}) for instructions on configuring pub/sub components
- [Pub/sub building block]({{< ref pubsub >}})