MTM-56141 Update MQTT Service documentation with all necessary inform…

…ation about private preview
Cumulocity-IoT · Apr 19, 2024 · 7403f68 · 7403f68
1 parent d67ca7f
commit 7403f68
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 5 deletions.
diff --git a/content/device-integration/mqtt-service-bundle/implementation.md b/content/device-integration/mqtt-service-bundle/implementation.md
@@ -81,13 +81,17 @@ both message header and body. The header size varies, but its minimum is 2 bytes
 
 ### Features {#features}
 
-#### Authentication {#authentication}
+#### Authentication and authorization {#authentication-and-authorization}
 
 Authentication types supported by MQTT Service are:
 
 *   Username and password. The MQTT username must include the tenant ID and username in the format `<tenantID>/<username>`.
 *   Device certificates - not yet supported. This will be added in a future release.
 
+{{< c8y-admon-req >}}
+The MQTT user which is used to connect to the MQTT Service must have the `MQTT_SERVICE_ADMIN` role assigned.
+{{< /c8y-admon-req >}}
+
 #### ClientId {#client-id}
 
 The MQTT ClientId field identifies the connected client. ClientId may consist of up to 128 alphanumeric characters.

diff --git a/content/device-integration/mqtt-service-bundle/overview.md b/content/device-integration/mqtt-service-bundle/overview.md
@@ -4,6 +4,17 @@ layout: redirect
 title: Overview
 ---
 
+{{< c8y-admon-preview >}}
+This feature is in Private Preview, that is, it is not enabled by default and maybe subject to change in the future.
+Please reach out to the [product support](/additional-resources/contacting-support/) if you are interested in this feature.
+{{< /c8y-admon-preview >}}
+
+{{< c8y-admon-req >}}
+To work with the MQTT Service, the following requirements have to be met:
+* The {{< product-c8y-iot >}} Messaging Service must be available on your {{< product-c8y-iot >}} platform.
+* MQTT Service must be enabled for your tenant.
+{{< /c8y-admon-req >}}
+
 MQTT Service is the new MQTT endpoint implementation of {{< product-c8y-iot >}} which provides the following benefits:
 
 * Support for publishing and subscribing arbitrary payloads on any MQTT topic. The topics that are used by the existing {{< product-c8y-iot >}} MQTT implementation are not permitted for use with MQTT Service.
@@ -14,10 +25,6 @@ MQTT Service is the new MQTT endpoint implementation of {{< product-c8y-iot >}}
 This section does not describe the basics of MQTT communication. If you are unfamiliar with MQTT, we recommend 
 you to consult one of the numerous introductions on the internet. Some references can be found on the [MQTT website](https://mqtt.org/mqtt-specification/).
 
-### Requirements {#requirements}
-
-MQTT Service is in final stages of development now, available as a private preview only. Please reach out to [product support](/additional-resources/contacting-support/) if interested.
-
 ### Architecture {#architecture}
 
 MQTT Service works together with the Messaging Service to provide a framework for highly customizable and flexible MQTT message processing solutions.