|
1 | | -# simple-kafka-mqtt-connector |
2 | | -This application receives messages from a mqtt broker and sends the messages to a kafka cluster. Topic mapping is configurable. |
| 1 | +# A simple MQTT to Apache Kafka Connector |
| 2 | + |
| 3 | + |
| 4 | + |
| 5 | +## Usage |
| 6 | + |
| 7 | +#### Prerequisites |
| 8 | +* Java 8 or higher |
| 9 | + |
| 10 | + |
| 11 | +#### Configuration |
| 12 | + |
| 13 | +* Edit the application.properties-file |
| 14 | + |
| 15 | +* kafka.host = IP THROUGH WHICH THE KAFKA BROKER WILL BE REACHED [HOSTNAME|IP] |
| 16 | +* kafka.port = [INTEGER] |
| 17 | +* kafka.client.id = [STRING] |
| 18 | + |
| 19 | +* mqtt.host = IP THROUGH WHICH THE MQTT BROKER WILL BE REACHED [HOSTNAME|IP] |
| 20 | +* mqtt.port = [INTEGER] |
| 21 | +* mqtt.client.id = [STRING] |
| 22 | +* mqtt.qos = Quality of service for MQTT - [INTEGER] Allowed[0,1,2] |
| 23 | + |
| 24 | +* topic.mapping = How are topics routed from MQTT to Kafka - (Separators >>> and ;) Example mqttTopicA>>>kafkaTopicA;mqttTopicB>>>kafkaTopicB;mqttTopicC>>>kafkaTopicC |
| 25 | + |
| 26 | +#### How to build |
| 27 | + |
| 28 | +* Run: `mvn clean install` |
| 29 | + |
| 30 | + |
| 31 | +#### How to run |
| 32 | + |
| 33 | +* Place the jar with dependencies and your edited application.properties-file in the same directory |
| 34 | + |
| 35 | +* Open a bash or CMD in the same directory as the .jar |
| 36 | + |
| 37 | +* Run: `java -jar simple_kafka_mqtt_connector-0.0.1-SNAPSHOT-jar-with-dependencies.jar` |
| 38 | + |
| 39 | + |
| 40 | +## Usage with Docker |
| 41 | + |
| 42 | +* Docker Hub https://hub.docker.com/r/arthurgrigo/simple-kafka-mqtt-connector |
| 43 | + |
| 44 | +* Run (edit enviroment variables to your needs!) : `docker run -d -t -i -e KAFKA_HOST='localhost' -e KAFKA_PORT=9092 -e KAFKA_CLIENT_ID='testing-kafka-producer-1' -e MQTT_HOST='localhost' -e MQTT_PORT=1883 -e MQTT_CLIENT_ID='mqtt-client-1' -e MQTT_QOS=2 -e TOPIC_MAPPING='robotgroup001/robot001>>>test;robotgroup001/robot002>>>test02;robotgroup001/robot003>>>test03' --name simple-kafka-mqtt-connector arthurgrigo/simple-kafka-mqtt-connector:latest` |
| 45 | + |
| 46 | + |
| 47 | +## Usage with Docker-Compose |
| 48 | + |
| 49 | +* See [docker-compose-examples](docker-compose) |
| 50 | + |
| 51 | +####Standalone |
| 52 | + |
| 53 | +* Stand-alone container |
| 54 | + |
| 55 | +* [docker-compose.yml](docker-compose/standalone/docker-compose.yml) |
| 56 | + |
| 57 | +* Run: `docker-compose up -d` |
| 58 | + |
| 59 | + |
| 60 | +####Full Stack |
| 61 | + |
| 62 | +* Full Stack (mqtt-broker, zookeeper, kafka-broker, simple-kafka-mqtt-connector) |
| 63 | + |
| 64 | +* [docker-compose.yml](docker-compose/fullstack/docker-compose.yml) |
| 65 | + |
| 66 | +* [env.list](docker-compose/fullstack/env.list) |
| 67 | + |
| 68 | +* Place docker-compose.yml and env.list in the same directory |
| 69 | + |
| 70 | +* Edit env.list to your needs! |
| 71 | + |
| 72 | +* Run: `docker-compose up -d` |
| 73 | + |
| 74 | + |
| 75 | +## License |
| 76 | +See [LICENSE](LICENSE) file for License |
0 commit comments