Skip to content

docs: add required ports information for cloud connections#3194

Merged
reubenmiller merged 1 commit intothin-edge:mainfrom
reubenmiller:docs-port-usage
Oct 21, 2024
Merged

docs: add required ports information for cloud connections#3194
reubenmiller merged 1 commit intothin-edge:mainfrom
reubenmiller:docs-port-usage

Conversation

@reubenmiller
Copy link
Copy Markdown
Contributor

Proposed changes

Add information about which ports are required by thin-edge.io to communicate to each cloud.

This work was spawned from a debug session which a customer which was using thin-edge.io behind a strictly controlled network and firewall rules needed to be created before thin-edge.io could connect to the appropriate cloud.

An additional "Debug section" could also be added, however it was decided it would be a better UX to create built-in command to do the connectivity checks like "can I reach the network" to give clear guidance on how to check these scenearios.

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)
  • I ran cargo fmt as mentioned in CODING_GUIDELINES
  • I used cargo clippy 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

@reubenmiller reubenmiller added the documentation Improvements or additions to documentation label Oct 18, 2024
Copy link
Copy Markdown
Contributor

@didier-wenzek didier-wenzek left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approved

Signed-off-by: Reuben Miller <reuben.d.miller@gmail.com>
@github-actions
Copy link
Copy Markdown
Contributor

Robot Results

✅ Passed ❌ Failed ⏭️ Skipped Total Pass % ⏱️ Duration
510 0 2 510 100 1h26m59.392509s

@reubenmiller reubenmiller added this pull request to the merge queue Oct 21, 2024
Merged via the queue into thin-edge:main with commit a5758ee Oct 21, 2024
@reubenmiller reubenmiller added the theme:c8y Theme: Cumulocity related topics label Dec 16, 2024
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:c8y Theme: Cumulocity related topics

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants