Skip to content

docs: add permission to publish retained messages to AWS IoT Core policy#3724

Merged
reubenmiller merged 2 commits intothin-edge:mainfrom
reubenmiller:docs-aws-policy-allow-publish-retained-message
Jul 4, 2025
Merged

docs: add permission to publish retained messages to AWS IoT Core policy#3724
reubenmiller merged 2 commits intothin-edge:mainfrom
reubenmiller:docs-aws-policy-allow-publish-retained-message

Conversation

@reubenmiller
Copy link
Copy Markdown
Contributor

@reubenmiller reubenmiller commented Jul 4, 2025

Proposed changes

Update the docs about the AWS IoT Core where the iot:RetainPublish permission was missing which can result in the thin-edge.io bridge being disconnected from the server if the user publishes a retained message directly to the bridge topic.

The existing system test was also extended to include publishing retained messages. The policy change used within the test is included in the robotframework-aws library (hence the bump in the library's version.

Note: The AWS IoT Core policy actions/permissions are detailed here.

Types of changes

  • Bugfix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Improvement (general improvements like code refactoring that doesn't explicitly fix a bug or add any new functionality)
  • Documentation Update (if none of the other choices apply)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)

Paste Link to the issue


Checklist

  • I have read the CONTRIBUTING doc
  • I have signed the CLA (in all commits with git commit -s. You can activate automatic signing by running just prepare-dev once)
  • I ran just format as mentioned in CODING_GUIDELINES
  • I used just check as mentioned in CODING_GUIDELINES
  • I have added tests that prove my fix is effective or that my feature works
  • I have added necessary documentation (if appropriate)

Further comments

If iot:RetainPublish is not allowed, then the client will be disconnected by
AWS if it tries to publish a retained message

Signed-off-by: reubenmiller <reuben.d.miller@gmail.com>
Signed-off-by: reubenmiller <reuben.d.miller@gmail.com>
@reubenmiller reubenmiller requested review from a team and didier-wenzek as code owners July 4, 2025 12:25
@reubenmiller reubenmiller temporarily deployed to Test Pull Request July 4, 2025 12:25 — with GitHub Actions Inactive
@reubenmiller reubenmiller added documentation Improvements or additions to documentation theme:aws Theme: AWS cloud related topics labels Jul 4, 2025
@codecov
Copy link
Copy Markdown

codecov bot commented Jul 4, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

📢 Thoughts on this report? Let us know!

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Jul 4, 2025

Robot Results

✅ Passed ❌ Failed ⏭️ Skipped Total Pass % ⏱️ Duration
653 0 3 653 100 1h50m47.101518999s

@reubenmiller reubenmiller added this pull request to the merge queue Jul 4, 2025
Merged via the queue into thin-edge:main with commit bea5cb8 Jul 4, 2025
34 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation theme:aws Theme: AWS cloud related topics

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants