Skip to content

Commit

Permalink
docs: liqoctl install on AKS private clusters
Browse files Browse the repository at this point in the history
  • Loading branch information
aleoli authored and adamjensenbot committed Jun 9, 2022
1 parent 3c2720a commit 8a38697
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 2 deletions.
6 changes: 6 additions & 0 deletions docs/installation/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -102,6 +102,12 @@ liqoctl install aks --resource-group-name "${AKS_RESOURCE_GROUP}" \
By default, the cluster is assigned the same name as that specified through the `--resource-name` parameter.
Alternatively, you can manually specify a different name with the `--cluster-name` *liqoctl* flag.
```{admonition} Note
If you are running an [AKS private cluster](https://docs.microsoft.com/en-us/azure/aks/private-clusters), you may need to set the `--disable-endpoint-check` *liqoctl* flag, since the API Server in your kubeconfig may be different from the one retrieved from the Azure APIs.
Additionally, since your API Server is not accessible from the public Internet, you shall leverage the [in-band peering approach](FeaturesPeeringInBandControlPlane) towards the clusters not attached to the same Azure Virtual Network.
```
````
````{tab} EKS
Expand Down
6 changes: 4 additions & 2 deletions docs/usage/peer.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Ensure you selected the correct target cluster before issuing *liqoctl* commands

## Out-of-band control plane

Briefly, the procedure to establish an out-of-band control plane peering consists of a first step performed on the *provider*, to **retrieve the set of information** required (i.e., authentication endpoint and token, cluster ID, ...), followed by the creation of the necessary resources to **start the actual peering**.
Briefly, the procedure to establish an [out-of-band control plane peering](FeaturesPeeringOutOfBandControlPlane) consists of a first step performed on the *provider*, to **retrieve the set of information** required (i.e., authentication endpoint and token, cluster ID, ...), followed by the creation of the necessary resources to **start the actual peering**.
The remainder of the process, including identity retrieval, resource negotiation and network tunnel establishment is **performed automatically** by Liqo, through a mutual exchange of information and negotiation between the two clusters involved.

### Information retrieval
Expand Down Expand Up @@ -111,9 +111,11 @@ node representing the local cluster.
Hence, the same command shall be executed on both clusters to completely tear down a bidirectional peering.
```

(UsagePeerInBand)=

## In-band control plane

Briefly, the procedure to establish an in-band control plane peering consists of a first step performed by *liqoctl*, which interacts alternatively with both clusters to **establish the cross-cluster VPN tunnel**, exchange the **authentication tokens** and configure the Liqo control plane traffic to flow inside the VPN.
Briefly, the procedure to establish an [in-band control plane peering](FeaturesPeeringInBandControlPlane) consists of a first step performed by *liqoctl*, which interacts alternatively with both clusters to **establish the cross-cluster VPN tunnel**, exchange the **authentication tokens** and configure the Liqo control plane traffic to flow inside the VPN.
The remainder of the process, including identity retrieval and resource negotiation, is **performed automatically** by Liqo, through a mutual exchange of information and negotiation between the two clusters involved.

<!-- markdownlint-disable-next-line no-duplicate-heading -->
Expand Down

0 comments on commit 8a38697

Please sign in to comment.