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.

Sign up for GitHub

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

Jump to bottom

Update Multi-cluster user guide #4889

Merged
merged 1 commit into from
Apr 25, 2023
Merged

Update Multi-cluster user guide #4889

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 23 additions & 8 deletions docs/multicluster/user-guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,10 +63,10 @@ when applying or downloading an Antrea YAML manifest.
[multi-cluster Pod-to-Pod connectivity](#multi-cluster-pod-to-pod-connectivity),
in particular configuration (please check the corresponding sections to learn more
information), requires an Antrea Multi-cluster Gateway to be set up in each member
cluster to route Service and Pod traffic across clusters. To support Multi-cluster
Gateways, `antrea-agent` must be deployed with the `Multicluster` feature enabled
in a member cluster. You can set the following configuration parameters in
`antrea-agent.conf` of the Antrea deployment manifest to enable the `Multicluster`
cluster by default to route Service and Pod traffic across clusters. To support
Multi-cluster Gateways, `antrea-agent` must be deployed with the `Multicluster`
feature enabled in a member cluster. You can set the following configuration parameters
in `antrea-agent.conf` of the Antrea deployment manifest to enable the `Multicluster`
feature:

```yaml
Expand All @@ -81,6 +81,12 @@ antrea-agent.conf: |
namespace: "" # Change to the Namespace where antrea-mc-controller is deployed.
```

In order for Multi-cluster features to work, it is necessary for `enableGateway` to be set to true by
the user, except when Pod-to-Pod direct connectivity already exists (e.g., provided by the cloud provider)
and `endpointIPType` is configured as `PodIP`. Details can be found in [Multi-cluster Services](#multi-cluster-service).
Please note that [Multi-cluster NetworkPolicy](#multi-cluster-networkpolicy) always requires
Gateway.

Prior to Antrea v1.11.0, Multi-cluster Gateway only works with Antrea `encap` traffic
mode, and all member clusters in a ClusterSet must use the same tunnel type. Since
Antrea v1.11.0, Multi-cluster Gateway also works with the Antrea `noEncap`, `hybrid`
Expand Down Expand Up @@ -353,10 +359,19 @@ spec:

## Multi-cluster Gateway Configuration

Multi-cluster Gateways are required to support multi-cluster Service access
across member clusters. Each member cluster should have one Node served as its
Multi-cluster Gateway. Multi-cluster Service traffic is routed among clusters
through the tunnels between Gateways.
Multi-cluster Gateways are responsible for establishing tunnels between clusters.
Each member cluster should have one Node serving as its Multi-cluster Gateway.
Multi-cluster Service traffic is routed among clusters through the tunnels between
Gateways.

Below is a table about communication support for different configurations.

| Pod-to-Pod connectivity provided by underlay | Gateway Enabled | MC EndpointTypes | Cross-cluster Service/Pod communications |
| -------------------------------------------- | --------------- | ----------------- | ---------------------------------------- |
| No | No | N/A | No |
| Yes | No | PodIP | Yes |
| No | Yes | PodIP/ClusterIP | Yes |
| Yes | Yes | PodIP/ClusterIP | Yes |

After a member cluster joins a ClusterSet, and the `Multicluster` feature is
enabled on `antrea-agent`, you can select a Node of the cluster to serve as
Expand Down