mqtt source MQTT Source

Provided by: "Apache Software Foundation"

Support Level for this Kamelet is: "Preview"

Allows receiving messages from any endpoint that supports the MQTT protocol, such as a message broker.

Configuration Options

The following table summarizes the configuration options available for the mqtt-source Kamelet:

Property Name Description Type Default Example

brokerUrl *

Broker URL

The URL of the broker where to establish the connection

string

"tcp://mosquitto:1883"

topic *

Topic

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 broker

string

username

Username

Username to use when connecting to the MQTT broker

string

Fields marked with an asterisk (*) are mandatory.

Dependencies

At runtime, the mqtt-source Kamelet relies upon the presence of the following dependencies:

  • camel:paho

  • camel:kamelet

Usage

This section describes how you can use the mqtt-source.

Knative Source

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

mqtt-source-binding.yaml
apiVersion: camel.apache.org/v1alpha1
kind: KameletBinding
metadata:
  name: mqtt-source-binding
spec:
  source:
    ref:
      kind: Kamelet
      apiVersion: camel.apache.org/v1alpha1
      name: mqtt-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 mqtt-source-binding.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 mqtt-source-binding.yaml

Procedure for using the Kamel CLI

Configure and run the source by using the following command:

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

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

Kafka Source

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

mqtt-source-binding.yaml
apiVersion: camel.apache.org/v1alpha1
kind: KameletBinding
metadata:
  name: mqtt-source-binding
spec:
  source:
    ref:
      kind: Kamelet
      apiVersion: camel.apache.org/v1alpha1
      name: mqtt-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 mqtt-source-binding.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 mqtt-source-binding.yaml

Procedure for using the Kamel CLI

Configure and run the source by using the following command:

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

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