-
Notifications
You must be signed in to change notification settings - Fork 26
MTM-64962 Rework MQTT Service overview for GA #3852
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: mqtt-service-ga-integration
Are you sure you want to change the base?
MTM-64962 Rework MQTT Service overview for GA #3852
Conversation
|
Preview available here |
Co-authored-by: Beate Rixen <[email protected]>
| * [Overview](#overview) presents the key features and high-level architecture of the service. | ||
| * [MQTT protocol implementation](#implementation) discusses the supported MQTT protocol versions and features. | ||
| * [Connecting MQTT devices](#connecting-devices) shows how to integrate devices with the service, using either the Core MQTT protocols or generic MQTT messaging. | ||
| * [Connecting microservice and applications](#pulsar-client) explains how to develop clients that communicate with generic MQTT devices. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Begs the question - because we're having to put in a navigation 'guide' here, doesn't that mean our section headings could be better? Not everybody reads doc linearly, so if somebody can locate the relevant section just from the tree on the left, that'd be better.
My modest and hastily written suggestions:
- Key features and high-level architecture
- Supported MQTT versions and features
- Integrating MQTT devices with the service
- Developing clients to communicate with MQTT devices
|
Nitpick: "device message format" and "device protocols" are used synonymously. Possibility to unify? |
Still a work in progress but ready for a first round of review. The basic approach is to pitch the MQTT Service as a unified MQTT endpoint that supports Cumulocity as well as generic device protocols, and that is optimised for device integration use cases. It talks about some things that don't yet exist but that should be there in the GA. Some points are repeated several times (e.g., device isolation) in the hope that readers will notice them at least once. I removed the "MQTT Service vs. Core MQTT" table because most of it was covered elsewhere, and we don't want to pitch them against each other so much now that the service also supports the core protocols.
Note: This PR targets an integration branch where we can collect all the MQTT Service GA docs for publishing together.