mqtt5 source MQTT 5 Source

Provided by: "Apache Software Foundation"

Support Level for this Kamelet is: "Stable"

Allows receiving messages from 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-source 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 subscribe to.

string

mytopic

clientId

Client ID

The client ID to use when connecting to the resource.

string

mqtt-source

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-source 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-source.

Knative source

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

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

Prerequisite

You have Camel K installed on the cluster.

Procedure for using the cluster CLI

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

  2. Run the source by using the following command:

    kubectl apply -f mqtt5-source-pipe.yaml

Procedure for using the Kamel CLI

Configure and run the source by using the following command:

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

This command creates the Kamelet Pipe in the current namespace on the cluster.

Kafka source

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

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

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-source-pipe.yaml file to your local drive, and then edit it as needed for your configuration.

  2. Run the source by using the following command:

    kubectl apply -f mqtt5-source-pipe.yaml

Procedure for using the Kamel CLI

Configure and run the source by using the following command:

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

This command creates the Kamelet Pipe in the current namespace on the cluster.

Kamelet source file

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

Back to top