mqtt-kafka Binding

Zilla runtime mqtt-kafka binding.

mqtt_kafka_proxy:
  type: mqtt-kafka
  kind: proxy
  options:
    server: mqtt-1.example.com:1883
    topics:
      sessions: mqtt-sessions
      messages: mqtt-messages
      retained: mqtt-retained
    clients:
      - place/{identity}/#
  routes:
    - when:
        - publish:
            - topic: place/+/device/#
        - subscribe:
            - topic: place/+/device/#
      with:
        messages: mqtt-devices
      exit: kafka_cache_client
  exit: kafka_cache_client

Summary

Defines a binding with mqtt-kafka support, with proxy behavior.

Configuration

Properties

• kind*
• options
  • options.server
  • options.topics
    • topics.sessions*
    • topics.messages*
    • topics.retained*
  • options.clients
• routes
• routes[].guarded
• routes[].when
  • when[].publish
    • publish[].topic
  • when[].subscribe
    • subscribe[].topic
• routes[].exit*
• routes[].with
  • with.messages
• exit

* required

kind*

enum [ "proxy" ]

Behave as a mqtt-kafka proxy.

options

object

mqtt-kafka-specific options for configuring the kafka topics that the proxy will use to route mqtt messages and session states; and define server reference of the MQTT server in Zilla

options.server

string

The server reference used by the MQTT server in Zilla. This config enables scaling of the MQTT server when running multiple Zilla instances as it uses server redirection.

options:
  server: mqtt-1.example.com:1883

options.topics

object

The kafka topics Zilla needs when routing MQTT messages

options:
  topics:
    sessions: mqtt-sessions
    messages: mqtt-messages
    retained: mqtt-retained

topics.sessions*

string

Compacted Kafka topic for storing mqtt session states. Cleanup policy must be log compacted.

topics.messages*

string

The default Kafka topic used for routing mqtt messages.

topics.retained*

string

Compacted Kafka topic for storing mqtt retained messages.

options.clients

array of string

Pattern defining how to extract client identity from the topic. Using this we can ensure that all messages for the same client identity are produced to Kafka on the same topic partition.

options:
  clients:
    - place/{identity}/#

routes

array of object

Conditional mqtt-kafka-specific routes when adapting mqtt topic streams to kafka topic streams.

routes:
  - when:
      - publish:
          - topic: place/+/device/#
      - subscribe:
          - topic: place/+/device/#
    with:
      messages: mqtt-devices
    exit: kafka_cache_client

routes[].guarded

object as named map of string:string array

List of roles required by each named guard to authorize this route.

routes:
  - guarded:
      my_guard:
        - publish:clients

routes[].when

array of object

List of conditions (any match) to match this route when adapting mqtt topic streams to kafka topic streams.
Read more: When a route matches

routes:
  - when:
      - publish:
          - topic: place/#
      - subscribe:
          - topic: place/#

when[].publish

array of object

Array of MQTT topic filters matching topic names for publish.

- publish:
    - topic: place/#
    - topic: subs/#

publish[].topic

string

MQTT topic filter pattern.

when[].subscribe

array of object

Array of MQTT topic filters matching topic names for subscribe.

- subscribe:
    - topic: place/#
    - topic: subs/#

subscribe[].topic

string

MQTT topic filter pattern.

routes[].exit*

string

Next binding when following this route.

routes[].with

object

Kafka parameters for matched route when adapting mqtt topic streams to kafka topic streams.

with:
  messages: mqtt-devices

with.messages

string

Kafka topic to use for the route.

exit

string

Default exit binding when no conditional routes are viable.

exit: kafka_cache_client

---

* required