Skip to content

Commit 6e57717

Browse files
committed
docs(liqoctl): peer command added description of server service position flag
1 parent 393985b commit 6e57717

File tree

3 files changed

+7
-4
lines changed

3 files changed

+7
-4
lines changed

docs/advanced/manual-peering.md

-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,6 @@
33
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:
44

55
- you want to configure Liqo peerings via a [declarative approach](./peering/peering-via-cr.md) via CRs.
6-
- 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))
76
- The consumer needs to create multiple requests for resources (ResourceSlice) or you want to customize the way resources are distributed on virtual nodes
87

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

docs/advanced/nat.md

+5-2
Original file line numberDiff line numberDiff line change
@@ -9,12 +9,15 @@ This page describes how to configure Liqo in the above scenarios.
99

1010
![The provider is behind a NAT](../_static/images/advanced/nat/provider-nat.svg)
1111

12-
The `liqoctl peer` command configures the gateway server on the provider cluster.
12+
The `liqoctl peer` command by default configures the gateway server on the provider cluster.
1313
However, there may be cases where the provider cluster's nodes are not directly reachable, such as when they are behind a NAT, while the consumer cluster is directly accessible.
1414
For instance, in the image above, cluster 2 is behind a NAT and is therefore not directly reachable.
1515

1616
This problem can be solved by swapping the roles of the gateways, hence configuring the client on the cluster provider and the server on the consumer.
17-
To do so, you need to use [manual peering](./manual-peering.md), setting the inter-cluster network up separately.
17+
To do so, you have two options:
18+
19+
- run the `liqoctl peer` command with the `--server-service-location=Consumer` flag
20+
- perform a [manual peering](./manual-peering.md), setting the inter-cluster network up separately
1821

1922
![The gateway server has been on the consumer side](../_static/images/advanced/nat/consumer-nat.svg)
2023

docs/usage/peer.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,8 @@ To perform a peering without having access to both clusters, you need to manuall
3636
The peering command enables all 3 liqo modules and performs the following steps:
3737

3838
1. **enables networking**.
39-
Exchanges network configurations and creates the two **gateways** (server in the provider, client in the consumer) to let the two clusters communicate over a secure tunnel.
39+
Exchanges network configurations and creates the two **gateways** (one acting as _server_ and located in the provider cluster, another acting as _client_ in the consumer cluster) to let the two clusters communicate over a secure tunnel.
40+
The location of the client/server gateway can be customized when creating the peering using the `--server-service-location` flag in `liqoctl`.
4041
2. **enables authentication**.
4142
Authenticates the consumer with the provider.
4243
In this step, the consumer obtains an `Identity` (*kubeconfig*) to replicate resources to the provider cluster.

0 commit comments

Comments
 (0)