Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Docs] improve NAT and manual peering documentation #2827

Draft
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

claudiolor
Copy link
Contributor

Description

This PR improves documentation about manual peering and the way to configure the network when there is a NAT in the topology

@adamjensenbot
Copy link
Collaborator

Hi @claudiolor. Thanks for your PR!

I am @adamjensenbot.
You can interact with me issuing a slash command in the first line of a comment.
Currently, I understand the following commands:

  • /rebase: Rebase this PR onto the master branch (You can add the option test=true to launch the tests
    when the rebase operation is completed)
  • /merge: Merge this PR into the master branch
  • /build Build Liqo components
  • /test Launch the E2E and Unit tests
  • /hold, /unhold Add/remove the hold label to prevent merging with /merge

Make sure this PR appears in the liqo changelog, adding one of the following labels:

  • kind/breaking: 💥 Breaking Change
  • kind/feature: 🚀 New Feature
  • kind/bug: 🐛 Bug Fix
  • kind/cleanup: 🧹 Code Refactoring
  • kind/docs: 📝 Documentation

@claudiolor claudiolor changed the title docs: improve NAT and manual peering documentation [Docs] improve NAT and manual peering documentation Nov 21, 2024
@frisso
Copy link
Member

frisso commented Nov 22, 2024

Two comments on the picture.

  1. Typo: "gatway" instead of "gateway" :-)
  2. To me, one of the biggest advantage of the manual Liqo peering is that for the network setup we don't care who is the provider, and who is the consumer. I think this should be stated clearly in the documentation, ans possibly reflected in the picture, where clusters could be named "cluster1" and "cluster2" instead of "consumer/provider".

Finally, did you try if SVG images (instead of PNG) work?
Apparently they are supported now: https://stackoverflow.com/questions/13808020/include-an-svg-hosted-on-github-in-markdown

@fra98 fra98 added the kind/docs Improvements or additions to documentation label Nov 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/docs Improvements or additions to documentation size/L
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants