4.5 KiB
type | title | linkTitle | description | aliases | |
---|---|---|---|---|---|
docs | KubeMQ binding spec | KubeMQ | Detailed documentation on the KubeMQ binding component |
|
Component format
To setup KubeMQ binding create a component of type bindings.kubemq
. See [this guide]({{< ref "howto-bindings.md#1-create-a-binding" >}}) on how to create and apply a binding configuration.
apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
name: binding-topic
spec:
type: bindings.kubemq
version: v1
metadata:
- name: address
value: "localhost:50000"
- name: channel
value: "queue1"
- name: direction
value: "input, output"
Spec metadata fields
Field | Required | Details | Example |
---|---|---|---|
address |
Y | Address of the KubeMQ server | "localhost:50000" |
channel |
Y | The Queue channel name | "queue1" |
authToken |
N | Auth JWT token for connection. Check out KubeMQ Authentication | "ew..." |
autoAcknowledged |
N | Sets if received queue message is automatically acknowledged | "true" or "false" (default is "false" ) |
pollMaxItems |
N | Sets the number of messages to poll on every connection | "1" |
pollTimeoutSeconds |
N | Sets the time in seconds for each poll interval | "3600" |
direction |
N | The direction of the binding | "input" , "output" , "input, output" |
Binding support
This component supports both input and output binding interfaces.
Create a KubeMQ broker
{{< tabs "Self-Hosted" "Kubernetes">}}
{{% codetab %}}
- Obtain KubeMQ 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.
- 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 for more information.
Related links
- [Basic schema for a Dapr component]({{< ref component-schema >}})
- [Bindings building block]({{< ref bindings >}})
- [How-To: Trigger application with input binding]({{< ref howto-triggers.md >}})
- [How-To: Use bindings to interface with external resources]({{< ref howto-bindings.md >}})
- [Bindings API reference]({{< ref bindings_api.md >}})