Feature/mtm 58268/document mqtt service topic limiting #2464
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…nd expected behaviour when exceeding limit
abor-c8y
requested review from
scmi-c8y,
rohitjoshi-c8y,
gapa-c8y,
slc-softwareag and
tjegorow-c8y
|
Preview available here |
MWindel
reviewed
Sep 26, 2024
| @@ -40,6 +40,29 @@ Other than that you are free to use any topic name which is compatible with the | |||
| Wildcard topics (`+`, `#`) and system topics starting with `$` are not supported. | |||
| {{< /c8y-admon-info >}} | |||
|
|
|||
| #### Topic limit {#topic-limit} | |||
|
|
|||
| MQTT Service has the ability to limit the total number of topics that a single tenant can create, current default is no limit. | |||
There was a problem hiding this comment.
Suggested change
| MQTT Service has the ability to limit the total number of topics that a single tenant can create, current default is no limit. | |
| MQTT Service has the ability to limit the total number of topics that a single tenant can create. The current default is no limit. |
content/device-integration/mqtt-service-bundle/implementation.md
Outdated
Show resolved
Hide resolved
content/device-integration/mqtt-service-bundle/implementation.md
Outdated
Show resolved
Hide resolved
| the delivery of the packet is prevented. | ||
|
|
||
| In the case of MQTT 5 clients have access to reason code and reason string describing the failure when using QoS 1 via acknowledgements, | ||
| reason code being QUOTA_EXCEEDED: 0x97. |
There was a problem hiding this comment.
Suggested change
| reason code being QUOTA_EXCEEDED: 0x97. | |
| reason code being `QUOTA_EXCEEDED: 0x97`. |
|
|
||
| In the case of MQTT 5 clients have access to reason code and reason string describing the failure when using QoS 1 via acknowledgements, | ||
| reason code being QUOTA_EXCEEDED: 0x97. | ||
| In the case of MQTT 3.1 and 3.1.1 clients only have access to reason code describing the failure when using QoS 1 via acknowledgements and only |
There was a problem hiding this comment.
Suggested change
| In the case of MQTT 3.1 and 3.1.1 clients only have access to reason code describing the failure when using QoS 1 via acknowledgements and only | |
| In the case of MQTT 3.1 and 3.1.1 clients only have access to the reason code describing the failure when using QoS 1 via acknowledgements and only |
| In the case of MQTT 5 clients have access to reason code and reason string describing the failure when using QoS 1 via acknowledgements, | ||
| reason code being QUOTA_EXCEEDED: 0x97. | ||
| In the case of MQTT 3.1 and 3.1.1 clients only have access to reason code describing the failure when using QoS 1 via acknowledgements and only | ||
| for SUBSCRIBE packets, where the reason code is 0x80. |
There was a problem hiding this comment.
Suggested change
| for SUBSCRIBE packets, where the reason code is 0x80. | |
| for the SUBSCRIBE packets, where the reason code is `0x80`. |
| reason code being QUOTA_EXCEEDED: 0x97. | ||
| In the case of MQTT 3.1 and 3.1.1 clients only have access to reason code describing the failure when using QoS 1 via acknowledgements and only | ||
| for SUBSCRIBE packets, where the reason code is 0x80. | ||
| For PUBLISH packets, client will be disconnected with no further information as per the MQTT specification. |
There was a problem hiding this comment.
Suggested change
| For PUBLISH packets, client will be disconnected with no further information as per the MQTT specification. | |
| For PUBLISH packets, the client will be disconnected with no further information as per the MQTT specification. |
content/device-integration/mqtt-service-bundle/implementation.md
Outdated
Show resolved
Hide resolved
| #### Topic cleanup {#topic-cleanup} | ||
|
|
||
| MQTT Service will automatically remove topics which are no longer in use, topics are recognized as inactive when there are no subscriptions and | ||
| internal publisher to the topic is closed. The publisher is responsible for publishing modified MQTT Service messages to the correct topic and these |
There was a problem hiding this comment.
Suggested change
| internal publisher to the topic is closed. The publisher is responsible for publishing modified MQTT Service messages to the correct topic and these | |
| the internal publisher to the topic is closed. The publisher is responsible for publishing the modified MQTT service messages to the correct topic. These |
There was a problem hiding this comment.
Alternative that adds this below. 'These sounded like the messages as it was the only plural entity in the previous sentence, so below I've changed 'These' to 'The publishers' to be clearer. I also improved the following sentence
| @@ -1,4 +1,4 @@ | |||
| --- | |||
| title: Introduction | |||
| title: MQTT Service | |||
There was a problem hiding this comment.
Suggested change
| title: MQTT Service | |
| title: MQTT service |
gapa-c8y
reviewed
Oct 8, 2024
content/device-integration/mqtt-service-bundle/implementation.md
Outdated
Show resolved
Hide resolved
gapa-c8y
approved these changes
Oct 9, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Additional sections outlining changes included in MQTT Service topic limiting feature.
Details regarding receiving errors for topic limit related failures for MQTT 3 clients via error topic are absent as this is yet to be implemented: https://github.com/Cumulocity-IoT/c8y-mqtt-service/pull/153