Skip to content

Commit

Permalink
Updated the order of the pages in the documentation section
Browse files Browse the repository at this point in the history
  • Loading branch information
frisso authored and palexster committed Jun 23, 2021
1 parent 272693a commit eb3fe7d
Show file tree
Hide file tree
Showing 6 changed files with 19 additions and 20 deletions.
5 changes: 2 additions & 3 deletions docs/pages/User/Install/_index.md
Expand Up @@ -5,8 +5,7 @@ weight: 4

### Pre-Installation

Liqo can be used with different topologies and scenarios. This impacts several installation parameters you will configure (e.g., API Server, Authentication). In
the [scenarios pages](./pre-install), we present some common patterns used to expose and interconnect clusters.
Liqo can be used with different topologies and scenarios. This impacts several installation parameters you will configure (e.g., API Server, Authentication). The [scenarios page](./pre-install) presents some common patterns used to expose and interconnect clusters.

### Installation

Expand All @@ -22,4 +21,4 @@ Liqo can be installed on existing clusters or deployed to newly created clusters

#### Peer your clusters

When you have installed Liqo on your clusters, you can decide to peer them to offload your applications on a different cluster as documented in [Post-Install section](/user/post-install)
When you have installed Liqo on your clusters, you can decide to peer them to offload your applications on a different cluster as documented in [Post-Install section](/user/post-install).
2 changes: 1 addition & 1 deletion docs/pages/User/Install/platforms/aks.md
@@ -1,6 +1,6 @@
---
title: AKS
weight: 1
weight: 2
---

#### About AKS
Expand Down
2 changes: 1 addition & 1 deletion docs/pages/User/Install/platforms/gke.md
@@ -1,6 +1,6 @@
---
title: GKE
weight: 2
weight: 3
---

* [Introduction](#introduction)
Expand Down
2 changes: 1 addition & 1 deletion docs/pages/User/Install/platforms/k3s.md
@@ -1,6 +1,6 @@
---
title: K3s
weight: 3
weight: 5
---

## About K3s
Expand Down
6 changes: 3 additions & 3 deletions docs/pages/User/Install/platforms/k8s.md
@@ -1,6 +1,6 @@
---
title: Kubeadm K8s
weight: 3
title: K8s with Kubeadm
weight: 4
---

### About Kubeadm
Expand All @@ -15,7 +15,7 @@ Liqo supports several CNIs as mentioned in the following table:

| CNI | Version | Support | Notes |
| ---------------------- | ------------------------------ | -------------------------------------- | --------------------------- |
| [Calico](#calico) | v3.17.2 | Yes, with minor configurations | |
| [Calico](#calico) | v3.17.2 | Yes, with minor configurations | |
| Flannel | v0.13.0 | Yes | |
| Cilium | v1.9.4 | Yes, but only using kube-proxy | |
| Weavenet | v2.8.1 | Yes | |
Expand Down
22 changes: 11 additions & 11 deletions docs/pages/User/Install/pre-install.md
@@ -1,11 +1,11 @@
---
title: Pre-Install
weight: 2
weight: 1
---

## Introduction

Liqo can be installed on every sort of clusters, either in on premise or cloud clusters. To peer two cluster together, they should (1) discover each other and (2) negotiate parameters and activate the peering.
Liqo can be installed on different types of clusters, either on-premise or on public cloud providers. To peer two cluster together, they must (1) discover each other, (2) negotiate the required parameters and (3) activate the peering.

As presented in a [dedicated section](/user/post-install/discovery), Liqo has several mechanisms to handle new clusters discovery (LAN, DNS, Manual). Despite LAN discovery is limited to very specific use-cases (when clusters are in the same broadcast domain), DNS and Manual discovery can be applied to many scenarios.
However, the clusters should satisfy few peering requirements. In particular, the configuration depends on the type of connectivity between the two clusters.
Expand All @@ -20,16 +20,16 @@ Liqo requires the following services to be reciprocally accessible on both clust

Depending on the physical setup of your cluster, you need to properly configure, at install time, how those services are exposed and can be reached by remote clusters. Below we present some common scenarios that Liqo can handle. Once you identify yours, you can refer to the *table* of each section to find how to determine the right values you should specify.

The exposition parameters can be configured at installation time using the [Liqo Helm Chart](/user/install/chart_values) and updated after the installation by issuing an ``helm update`` after changing them in your values.yml. If you need more information about Helm and how charts can be configured, you can have a look at the [Helm official documentation](https://helm.sh/docs/). Pay attention that changing exposition parameters may affect and break active peerings. We suggest disabling all peerings before changing the Liqo exposition configuration.
The exposition parameters can be configured at installation time using the [Liqo Helm Chart](/user/install/chart_values) and updated after the installation by issuing an ``helm update`` after changing them in your values.yml. If you need more information about Helm and how charts can be configured, you can have a look at the [Helm official documentation](https://helm.sh/docs/). Pay attention that changing exposition parameters may affect and break active peerings. We suggest to disable all peerings before changing the Liqo exposition configuration.

### Cloud to cloud

![](/images/scenarios/cloud-to-cloud.svg)

Two managed clusters peered together through the Internet. It is possible to have a multi-cloud setup (AKS to AKS, GKE to GKE, and AKS to GKE). In this scenario, the services should be exposed using Public IPs/URLs.

| | Cluster A (Cloud) | Cluster B (Cloud) |
| --------- | -------- | --------- |
| | Cluster A (Cloud) | Cluster B (Cloud) |
| --------- | ----------------- | ----------------- |
| **Auth Server** | LoadBalancer/ingress | LoadBalancer/Ingress |
| **API server** | Provided by the Cloud Provider| Provided by the Cloud Provider |
| **Network gateway** | LoadBalancer/Node Port | LoadBalancer/Node Port |
Expand All @@ -42,8 +42,8 @@ At least one among Cluster A and Cluster B should have the **Network Gateway** I

On-premise cluster (K3s or K8s) exposed through the Internet peered with a Managed cluster (AKS or GKE).

| | Cluster A (On-prem) | Cluster B (Cloud) |
| --------- | -------- | --------- |
| | Cluster A (On-prem) | Cluster B (Cloud) |
| --------- | ------------------- | ----------------- |
| **Auth Server** | LoadBalancer/Ingress | LoadBalancer/Ingress |
| **API server** | Ingress/Public IP | Provided by the Cloud Provider |
| **Network gateway** | LoadBalancer/Node Port | LoadBalancer/Node Port |
Expand All @@ -57,8 +57,8 @@ In addition, at least one among Cluster A and Cluster B should have the **Networ

When the On-premise cluster is exposed through a NAT, the configuration slightly changes:

| | Cluster A (On-prem behind NAT) | Cluster B (Cloud) |
| --------- | -------- | --------- |
| | Cluster A (On-prem behind NAT) | Cluster B (Cloud) |
| --------- | ------------------------------ | ----------------- |
| **Auth Server** | NodePort with port-forwarding | LoadBalancer/ingress |
| **API server** | Port-forwarding | Provided |
| **Network gateway** | NodePort with port-forwarding | LoadBalancer |
Expand All @@ -72,8 +72,8 @@ In this situation, the "cloud" cluster should have the Network Gateway exposed a
Clusters (K3s or K8s) in the same LAN may rely on the mDNS-based Liqo discovery mechanism.
The Liqo discovery mechanism based on mDNS will handle the discovery automatically.

| | Cluster A (On-prem) | Cluster B (On-prem) |
| --------- | -------- | --------- |
| | Cluster A (On-prem) | Cluster B (On-prem) |
| --------- | ------------------- | ------------------- |
| **Auth Server** | NodePort | NodePort |
| **API server** | Exposed | Exposed |
| **Network gateway** | NodePort | NodePort |
Expand Down

0 comments on commit eb3fe7d

Please sign in to comment.