Skip to content

Conversation

@scmi-c8y
Copy link
Contributor

@scmi-c8y scmi-c8y commented Oct 27, 2025

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.

@scmi-c8y scmi-c8y self-assigned this Oct 27, 2025
@scmi-c8y scmi-c8y requested a review from BeateRixen as a code owner October 27, 2025 17:07
@scmi-c8y scmi-c8y changed the title Rework MQTT Service overview for GA MTM-64962 Rework MQTT Service overview for GA Oct 27, 2025
@github-actions
Copy link
Contributor

github-actions bot commented Oct 27, 2025

Preview available here

@scmi-c8y scmi-c8y changed the base branch from develop to mqtt-service-ga-integration November 12, 2025 14:39
Comment on lines +33 to +36
* [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.
Copy link
Contributor

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

@bbyreddy
Copy link
Contributor

bbyreddy commented Nov 13, 2025

Nitpick:
In the MQTT service introduction section, we refer mention "Connecting MQTT devicesshows how to integrate devices with the service, using either the Core MQTT protocols or generic MQTT messaging."
Just to keep it consistent, we can say "Core MQTT or generic MQTT device protocols". We use "generic MQTT device protocol" in the "Protocols and clients" table.

"device message format" and "device protocols" are used synonymously. Possibility to unify?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants