Skip to content

Commit

Permalink
docs: polishing docs for manual authentication
Browse files Browse the repository at this point in the history
  • Loading branch information
frisso authored and fra98 committed Dec 20, 2024
1 parent 7c70835 commit 05c1030
Show file tree
Hide file tree
Showing 3 changed files with 96 additions and 85 deletions.
18 changes: 10 additions & 8 deletions docs/advanced/manual-peering.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
# Manual peering
# Custom peering

In the [peer two clusters](../usage/peer.md) section of this documentation, we used the `liqoctl peer`, which automatically configure each single module of Liqo to create a peering between two clusters. However, in some cases where:
In the [peer two clusters](../usage/peer.md) section of this documentation, we used the `liqoctl peer` command, which automatically configures all the Liqo modules (namely _networking_, _authentication_, and _offloading_) to create a peering between two clusters. However, there are some cases in which the automatic process is not appropriate, and the user would like to customize advanced parameters, overcome specific network constraints, and more, hence a more granular tuning for the peering process is needed.
For instance, we list here some cases in which the automatic peering is not a suitable choice:

- you want to configure Liqo peerings via a [declarative approach](./peering/peering-via-cr.md) via CRs.
- it is required to configure the WireGuard gateway server on the cluster consumer (e.g. the nodes of the cluster provider are [behind a NAT or a physical load balancer](./nat.md))
- The consumer needs to create multiple requests for resources (ResourceSlice) or you want to customize the way resources are distributed on virtual nodes
- you would like to configure Liqo the peerings via a [declarative approach](./peering/peering-via-cr.md), i.e., with Kubernetes CRs;
- you need to configure the WireGuard gateway server on the consumer cluster (e.g. the nodes of the provider cluster are [behind a NAT or a physical load balancer](./nat.md));
- the consumer needs to create multiple requests for resources (ResourceSlice) or you would like to customize how resources are distributed across virtual nodes.

you might need to configure each single module separatly, or to interact with a specific module to obtain the desired result.

In this section, you will discover how to interact with each Liqo module without using the automatic peering method.
To overcome the above necessities, Liqo allows to configure each module separately, with a more granual control.
This section shows how to interact with each individual Liqo module to better tune your peering process.

## Prerequirements

Expand All @@ -21,3 +21,5 @@ Check each module specific documentation to understand how to configure it:
- [Networking](/advanced/peering/inter-cluster-network)
- [Authentication](/advanced/peering/inter-cluster-authentication)
- [Offloading](/advanced/peering/offloading-in-depth)

Furthermore, an additional section describes how to interact with the above modules using [Kubernetes CRs](/advanced/peering/peering-via-cr), hence using a fully declarative approach.
Loading

0 comments on commit 05c1030

Please sign in to comment.