Revise Multi-cluster Gateway descriptions in user docs #3899

jianjuns · 2022-06-15T05:21:14Z

Revise the descriptions about Multi-cluster Gateway configuration.
Add descriptions about the gateway-ip annotation.
Remove unnecessary descriptions about implementations from the user
documents.

Signed-off-by: Jianjun Shen [email protected]

luolanzone

LGTM, two nits:

luolanzone · 2022-06-15T05:28:05Z

docs/multicluster/user-guide.md

+its Multi-cluster Gateway. Multi-cluster Service traffic are routed among clusters
+through the tunnels between Gateways.
+
+


Extra empty line?

luolanzone · 2022-06-15T05:30:46Z

docs/multicluster/user-guide.md

+there are several possibilities:
+
+* By default, the K8s Node's `InternalIP` is used as `gatewayIP` too.
+* You can choose to use the K8ds Node's `ExternalIP` as `gatewayIP`, by changing


Suggested change

* You can choose to use the K8ds Node's `ExternalIP` as `gatewayIP`, by changing

* You can choose to use the K8s Node's `ExternalIP` as `gatewayIP`, by changing

luolanzone · 2022-06-15T05:36:31Z

docs/multicluster/user-guide.md

-Gateways.
+remote Gateways of other member clusters. Multi-cluster Controller discovers the
+IP addresses from the K8s Node resource of the Gateway Node. It will always use
+use `InternalIP` of the K8s Node as the Gateway's `internalIP`. For `gatewayIP`,


extra use

codecov-commenter · 2022-06-15T05:51:57Z

Codecov Report

Merging #3899 (02c0bf6) into main (59fc30a) will increase coverage by 0.01%.
The diff coverage is n/a.

❗ Current head 02c0bf6 differs from pull request most recent head 3ff19be. Consider uploading reports for the commit 3ff19be to get more accurate results

@@            Coverage Diff             @@
##             main    #3899      +/-   ##
==========================================
+ Coverage   35.16%   35.18%   +0.01%     
==========================================
  Files         122      122              
  Lines       17123    17123              
==========================================
+ Hits         6022     6024       +2     
+ Misses      10602    10601       -1     
+ Partials      499      498       -1

Flag	Coverage Δ
integration-tests	`35.18% <ø> (+0.01%)`	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files	Coverage Δ
antrea/pkg/ovs/openflow/ofctrl_bridge.go	`69.41% <0.00%> (+0.39%)`	⬆️

jianjuns · 2022-06-15T15:28:50Z

@luolanzone : I made a few more revisions, and added description about encap mode and tunnel type.

luolanzone

LGTM, two nits:

docs/multicluster/user-guide.md

luolanzone · 2022-06-16T01:30:05Z

docs/multicluster/user-guide.md

+exported network information. For example, in cluster `test-cluster-west`, you
+you can see a `ClusterInfoImport` CR with name `test-cluster-east-clusterinfo`
+is created for cluster `test-cluster-east`. You can check the
+`ClusterInfoImport` with command: `kubectl get clusterinfoimport -o yaml`,


Suggested change

`ClusterInfoImport` with command: `kubectl get clusterinfoimport -o yaml`,

`ClusterInfoImport` with command: `kubectl get clusterinfoimport test-cluster-east-clusterinfo -o yaml`,

I feel no need to specify name here. Anyway readers can understand they can add name if they want. In most cases, they will not, to list all clusters.

jianjuns · 2022-06-16T02:35:29Z

docs/multicluster/user-guide.md

-the ClusterNetworkPolicy spec they wish to be replicated. The ResourceExport should be created in the
-Namespace which implements the Common Area of the ClusterSet. In future releases, some additional tooling
-may become available to automate the creation of such ResourceExport and make ACNP replication easier.
+To achieve such ACNP replication across clusters, admins can, in the acting


I changed this section to remove "Common Area" as it is never mentioned in this doc.

jianjuns · 2022-06-16T02:37:09Z

docs/multicluster/user-guide.md

-in leader cluster will create two `ResourceImport` contains all exported Service and
-Endpoints'. you can check the created resources in the leader cluster which should be
-like below:
+For example, once you export the `default/nginx` Service in member cluster


Revised this section to remove "Multi-cluster Controller", etc. and some internal behaviors, as no need to talk about design in user guide.

jianjuns · 2022-06-16T02:37:50Z

docs/multicluster/user-guide.md

+Service from `test-cluster-east` will be routed to the backend `nginx` Pods in
+`test-cluster-west` through the Multi-cluster Gateways.
+
+As part of the Service export/import process, in the leader cluster, two


I feel no need to talk about this internal logic in user doc, but anyway we can keep it.

jianjuns · 2022-06-16T02:39:12Z

docs/multicluster/user-guide.md

-Then you can go to the member cluster `test-cluster-east` to check the new created
-Service and Endpoints with name `kube-system/antrea-mc-nginx` and a ServiceImport named
-`kube-system/nginx`. If there is already an existing Service created by users in the
-member cluster `test-cluster-east` also named `nginx` in Namespace `kube-system`, which


Do you mean a Service with name antrea-mc-nginx? It is rather uncommon. Guess no need to mention that.

jianjuns · 2022-06-16T02:40:16Z

docs/multicluster/user-guide.md

+For example, once you export the `default/nginx` Service in member cluster
+`test-cluster-west`, it will be exported to member cluster `test-cluster-east`
+through the leader cluster. A Service and an Endpoints with name
+`default/antrea-mc-nginx` will be created in `test-cluster-east`, as well as


I changed Namespace to "default", as not common to create Services in kube-system. Could you check?

jianjuns · 2022-06-16T02:41:31Z

docs/multicluster/user-guide.md

+multi-cluster Service resources will be updated accordingly. A few cases below
+are worth to note:
+
+1. When there are more than one ServiceExports created for a single Service, the


I am trying to revise the description (as hard to understand the previous version). Could you check?

luolanzone · 2022-06-16T02:40:38Z

docs/multicluster/user-guide.md

-like below:
+For example, once you export the `default/nginx` Service in member cluster
+`test-cluster-west`, it will be exported to member cluster `test-cluster-east`
+through the leader cluster. A Service and an Endpoints with name


Suggested change

through the leader cluster. A Service and an Endpoints with name

through the leader cluster. A Service and an Endpoint with name

The resource kind is indeed Endpoints.

OK, we can keep it, I am actually confused with this one since I saw both an Endpoints and an Endpoint in our docs and comments.

I already removed all "Endpoint" or changed to "endpoint".

docs/multicluster/user-guide.md

luolanzone · 2022-06-16T04:16:49Z

docs/multicluster/user-guide.md

+Service resources will be updated accordingly. The two cases below are worth to
+note:
+
+1. When there are more than one ServiceExports created for a single Service, the


Suggested change

1. When there are more than one ServiceExports created for a single Service, the

1. When there are more than one ServiceExports from different member clusters created for a single Service, the

luolanzone · 2022-06-16T04:18:16Z

docs/multicluster/user-guide.md

+
+1. When there are more than one ServiceExports created for a single Service, the
+   Service might not be exported correctly, and updates to the Service will not
+   be handled, until users remove the redundant ServiceExports.


Suggested change

be handled, until users remove the redundant ServiceExports.

be handled, until users remove the redundant ServiceExports or correct the Service to make its definition consistent in each member cluster.

luolanzone · 2022-06-16T04:23:04Z

docs/multicluster/user-guide.md

+creation of ResourceExports for ACNPs, and provide a user-friendly way to define
+Multi-cluster NetworkPolicies to be enforced in the ClusterSet.
+
+replication easier.


Forgot to remove?

Thanks. Fixed

Revise the descriptions about Multi-cluster Gateway configuration. Add descriptions about the `gateway-ip` annotation. Remove unnecessary descriptions about implementations from the user documents. Signed-off-by: Jianjun Shen <[email protected]>

luolanzone

LGTM

jianjuns · 2022-06-16T14:12:13Z

/skip-all

jianjuns added kind/documentation Categorizes issue or PR as related to a documentation. area/multi-cluster Issues or PRs related to multi cluster. labels Jun 15, 2022

jianjuns requested a review from luolanzone June 15, 2022 05:21

jianjuns force-pushed the multicluster-doc branch from b7dfe06 to 02c0bf6 Compare June 15, 2022 05:22

luolanzone previously approved these changes Jun 15, 2022

View reviewed changes

luolanzone reviewed Jun 15, 2022

View reviewed changes

jianjuns dismissed luolanzone’s stale review via 3ff19be June 15, 2022 06:06

jianjuns force-pushed the multicluster-doc branch from 02c0bf6 to 3ff19be Compare June 15, 2022 06:06

luolanzone previously approved these changes Jun 15, 2022

View reviewed changes

jianjuns dismissed luolanzone’s stale review via 44ff64e June 15, 2022 15:28

jianjuns force-pushed the multicluster-doc branch from 3ff19be to 44ff64e Compare June 15, 2022 15:28

jianjuns force-pushed the multicluster-doc branch from 44ff64e to 8a5db87 Compare June 15, 2022 15:32

luolanzone previously approved these changes Jun 16, 2022

View reviewed changes

jianjuns dismissed luolanzone’s stale review via 4df2049 June 16, 2022 02:30

jianjuns force-pushed the multicluster-doc branch from 8a5db87 to 4df2049 Compare June 16, 2022 02:30

jianjuns commented Jun 16, 2022

View reviewed changes

jianjuns force-pushed the multicluster-doc branch 4 times, most recently from 19267b0 to 3516019 Compare June 16, 2022 03:06

luolanzone reviewed Jun 16, 2022

View reviewed changes

jianjuns force-pushed the multicluster-doc branch from 3516019 to dc1df80 Compare June 16, 2022 05:54

luolanzone approved these changes Jun 16, 2022

View reviewed changes

jianjuns merged commit c14e8ba into antrea-io:main Jun 16, 2022

jianjuns mentioned this pull request Jun 16, 2022

Automated cherry pick of #3638: Update Multi-cluster architecture doc #3899: Revise Multi-cluster Gateway descriptions in user docs #3908

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Revise Multi-cluster Gateway descriptions in user docs #3899

Revise Multi-cluster Gateway descriptions in user docs #3899

jianjuns commented Jun 15, 2022

luolanzone left a comment

luolanzone Jun 15, 2022

luolanzone Jun 15, 2022

luolanzone Jun 15, 2022

codecov-commenter commented Jun 15, 2022 •

edited

Loading

jianjuns commented Jun 15, 2022

luolanzone left a comment

luolanzone Jun 16, 2022

jianjuns Jun 16, 2022

jianjuns Jun 16, 2022

jianjuns Jun 16, 2022

jianjuns Jun 16, 2022

jianjuns Jun 16, 2022

jianjuns Jun 16, 2022

jianjuns Jun 16, 2022

luolanzone Jun 16, 2022

jianjuns Jun 16, 2022

luolanzone Jun 16, 2022

jianjuns Jun 16, 2022

luolanzone Jun 16, 2022

luolanzone Jun 16, 2022

luolanzone Jun 16, 2022

jianjuns Jun 16, 2022

luolanzone left a comment

jianjuns commented Jun 16, 2022

		its Multi-cluster Gateway. Multi-cluster Service traffic are routed among clusters
		through the tunnels between Gateways.

	* You can choose to use the K8ds Node's `ExternalIP` as `gatewayIP`, by changing
	* You can choose to use the K8s Node's `ExternalIP` as `gatewayIP`, by changing

	`ClusterInfoImport` with command: `kubectl get clusterinfoimport -o yaml`,
	`ClusterInfoImport` with command: `kubectl get clusterinfoimport test-cluster-east-clusterinfo -o yaml`,

	through the leader cluster. A Service and an Endpoints with name
	through the leader cluster. A Service and an Endpoint with name

	1. When there are more than one ServiceExports created for a single Service, the
	1. When there are more than one ServiceExports from different member clusters created for a single Service, the

	be handled, until users remove the redundant ServiceExports.
	be handled, until users remove the redundant ServiceExports or correct the Service to make its definition consistent in each member cluster.

Revise Multi-cluster Gateway descriptions in user docs #3899

Revise Multi-cluster Gateway descriptions in user docs #3899

Conversation

jianjuns commented Jun 15, 2022

luolanzone left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

codecov-commenter commented Jun 15, 2022 • edited Loading

Codecov Report

jianjuns commented Jun 15, 2022

luolanzone left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

luolanzone left a comment

Choose a reason for hiding this comment

jianjuns commented Jun 16, 2022

codecov-commenter commented Jun 15, 2022 •

edited

Loading