mqtt5 sink MQTT v5 Sink

Provided by: "Apache Software Foundation"

Support Level for this Kamelet is: "Stable"

Allows sending messages to any endpoint that supports the MQTT v5 protocol, such as a message broker.

Configuration Options

The following table summarizes the configuration options available for the mqtt5-sink Kamelet:

Property Name Description Type Default Example

brokerUrl

Broker URL

Required The URL of the broker where to establish the connection.

string

tcp://mosquitto:1883

topic

Topic

Required The topic to send messages to.

string

mytopic

password

Password

Password to use when connecting to the MQTT v5 compliant broker.

string

username

Username

Username to use when connecting to the MQTT v5 compliant broker.

string

Dependencies

At runtime, the mqtt5-sink Kamelet relies upon the presence of the following dependencies:

  • camel:paho-mqtt5

  • camel:kamelet

Camel JBang usage

Prerequisites

  • You’ve installed JBang.

  • You have executed the following command:

jbang app install camel@apache/camel

Supposing you have a file named route.yaml with this content:

- route:
    from:
      uri: "kamelet:timer-source"
      parameters:
        period: 10000
        message: 'test'
      steps:
        - to:
            uri: "kamelet:log-sink"

You can now run it directly through the following command

camel run route.yaml

Camel K Environment Usage

This section describes how you can use the mqtt5-sink.

Knative sink

You can use the mqtt5-sink Kamelet as a Knative sink by binding it to a Knative object.

mqtt5-sink-binding.yaml
apiVersion: camel.apache.org/v1
kind: KameletBinding
metadata:
  name: mqtt5-sink-binding
spec:
  source:
    ref:
      kind: Channel
      apiVersion: messaging.knative.dev/v1
      name: mychannel
  sink:
    ref:
      kind: Kamelet
      apiVersion: camel.apache.org/v1
      name: mqtt5-sink
    properties:
      brokerUrl: tcp://mosquitto:1883
      topic: mytopic

Prerequisite

You have Camel K installed on the cluster.

Procedure for using the cluster CLI

  1. Save the mqtt5-sink-binding.yaml file to your local drive, and then edit it as needed for your configuration.

  2. Run the sink by using the following command:

    kubectl apply -f mqtt5-sink-binding.yaml

Procedure for using the Kamel CLI

Configure and run the sink by using the following command:

kamel bind channel:mychannel -p "sink.brokerUrl=tcp://mosquitto:1883" -p "sink.topic=mytopic" mqtt5-sink

This command creates the KameletBinding in the current namespace on the cluster.

Kafka sink

You can use the mqtt5-sink Kamelet as a Kafka sink by binding it to a Kafka topic.

mqtt5-sink-binding.yaml
apiVersion: camel.apache.org/v1
kind: KameletBinding
metadata:
  name: mqtt5-sink-binding
spec:
  source:
    ref:
      kind: KafkaTopic
      apiVersion: kafka.strimzi.io/v1beta1
      name: my-topic
  sink:
    ref:
      kind: Kamelet
      apiVersion: camel.apache.org/v1
      name: mqtt5-sink
    properties:
      brokerUrl: tcp://mosquitto:1883
      topic: mytopic

Prerequisites

  • You’ve installed Strimzi.

  • You’ve created a topic named my-topic in the current namespace.

  • You have Camel K installed on the cluster.

Procedure for using the cluster CLI

  1. Save the mqtt5-sink-binding.yaml file to your local drive, and then edit it as needed for your configuration.

  2. Run the sink by using the following command:

    kubectl apply -f mqtt5-sink-binding.yaml

Procedure for using the Kamel CLI

Configure and run the sink by using the following command:

kamel bind kafka.strimzi.io/v1beta1:KafkaTopic:my-topic -p "sink.brokerUrl=tcp://mosquitto:1883" -p "sink.topic=mytopic" mqtt5-sink

This command creates the KameletBinding in the current namespace on the cluster.

Kamelet source file

https://github.com/apache/camel-kamelets/blob/main/kamelets/mqtt5-sink.kamelet.yaml

Back to top