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] Add declarative peering section #2813

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

claudiolor
Copy link
Contributor

Description

This PR add the documentation for the creation of peerings via a declarative approach, by applying CRs.

How Has This Been Tested?

N/A

@claudiolor claudiolor added kind/docs Improvements or additions to documentation and removed size/L labels Nov 12, 2024
@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


## Declarative configuration of namespace offloading

While offloading is independent from the network, which means that it is possible to negotiate resources and configure a namespace offloading without the inter-cluster network enabled, **a [working authentication configuration](#declarative-configuration-of-clusters-authentication) is a pre-requisite to enable offloading**.
Copy link
Member

@frisso frisso Nov 13, 2024

Choose a reason for hiding this comment

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

Suggested change
While offloading is independent from the network, which means that it is possible to negotiate resources and configure a namespace offloading without the inter-cluster network enabled, **a [working authentication configuration](#declarative-configuration-of-clusters-authentication) is a pre-requisite to enable offloading**.
While offloading is independent from the network, which means that it is possible to negotiate resources and configure a namespace offloading without the inter-cluster network enabled (either because it is not needed, or because is provided by a third-party mechanism), **a [working authentication configuration](#declarative-configuration-of-clusters-authentication) is instead a mandatory pre-requisite**.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I believe there might be cases in which inter-cluster network is actually not required (e.g. I need to offload some pods that do not require to "talk" with pods or services on the local cluster).
Maybe we can add a section somewhere (like in manual peering) where we explain the inter-dependency between the modules, and here add reference to that section.
Explaing everything here seems a little out of context to me, as I just wanted to say: "do not proceed with this guide if you didn't configure the authentication module"

Copy link
Member

Choose a reason for hiding this comment

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

Got it. Modified accordingly.

Copy link
Member

@frisso frisso left a comment

Choose a reason for hiding this comment

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

Looks very good to me.
Minor comments, mainly small rephrasing.

@claudiolor claudiolor force-pushed the clo/declarive-peering-docs branch 2 times, most recently from f4b8613 to 142d250 Compare November 15, 2024 12:08
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