Update multi-cluster user guide and templates #3853

luolanzone · 2022-06-01T14:12:50Z

Add a quick start guide.
Update the user guide with Multi-cluster Gateway.

Signed-off-by: Lan Luo luola@vmware.com
Signed-off-by: Jianjun Shen shenj@vmware.com

codecov-commenter · 2022-06-01T14:20:58Z

Codecov Report

Merging #3853 (97aca3f) into main (87918f6) will increase coverage by 0.08%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##             main    #3853      +/-   ##
==========================================
+ Coverage   64.33%   64.42%   +0.08%     
==========================================
  Files         290      288       -2     
  Lines       41225    41252      +27     
==========================================
+ Hits        26524    26575      +51     
+ Misses      12578    12548      -30     
- Partials     2123     2129       +6

Flag	Coverage Δ
kind-e2e-tests	`51.77% <ø> (+0.11%)`	⬆️
unit-tests	`44.32% <ø> (+0.06%)`	⬆️

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

Impacted Files	Coverage Δ
pkg/agent/ipassigner/ip_assigner_linux.go	`47.28% <0.00%> (-11.85%)`	⬇️
pkg/version/version.go	`42.85% <0.00%> (-9.53%)`	⬇️
pkg/controller/networkpolicy/store/addressgroup.go	`87.20% <0.00%> (-3.49%)`	⬇️
pkg/agent/openflow/client.go	`67.87% <0.00%> (-1.51%)`	⬇️
pkg/controller/serviceexternalip/controller.go	`68.67% <0.00%> (-1.21%)`	⬇️
...ntroller/networkpolicy/networkpolicy_controller.go	`70.17% <0.00%> (-0.66%)`	⬇️
pkg/controller/networkpolicy/status_controller.go	`71.37% <0.00%> (-0.41%)`	⬇️
pkg/agent/controller/egress/egress_controller.go	`73.93% <0.00%> (-0.35%)`	⬇️
pkg/agent/agent.go	`53.80% <0.00%> (-0.26%)`	⬇️
pkg/ovs/openflow/ofctrl_bridge.go	`56.86% <0.00%> (-0.20%)`	⬇️
... and 15 more

jianjuns · 2022-06-01T17:16:47Z

multicluster/config/samples/clusterset_init/multicluster_clusterset_template.yaml

@@ -1,15 +1,15 @@
 apiVersion: multicluster.crd.antrea.io/v1alpha1
 kind: ClusterClaim
 metadata:
-  name: leadercluster-id


Could we change to clusterSet.k8s.io as we talked?

yes, I will change this one today.

Changed it to clusterset.k8s.io due to upper case is not allowed in metadata's name.

jianjuns · 2022-06-02T00:18:04Z

@luolanzone : I updated the quick-start doc. The biggest change is that it now talks about two clusters, with one to be both leader and member. Could you check? I plan to revise the user guide too.

jianjuns · 2022-06-02T00:19:37Z

docs/multicluster/quick-start.md

+
+In this quick start guide, we will set up a Antrea Multi-cluster ClusterSet with
+two clusters. One cluster will serve as both the leader and a member cluster,
+while another cluster will be a member only. The diagram belows shows the two


@luolanzone : I feel we better to have a simple diagram to show the two clusters (with cluster ID), and ClusterSet (with leader and member cluster information).

Sure, I haven't had the chance to draw the diagram yesterday, I will add it.

A few comments for the diagram:

What you think we have a box for the ClusterSet that contains the two clusters? We can add ClusterSet ID there.

Add something like "leader" to the leader mc-controller to indicate it is the controller for leader.

And some way to indicate the Gateway Node too.

Could we add apiserver IP to Cluster A

Could we indicate Cluster A is "leader and member", and Cluster B is "member"

We should change the Node names in the diagram and commands (e.g. node-a1/a2 and node-b1/b2)

jianjuns · 2022-06-02T01:57:34Z

docs/multicluster/user-guide.md

 ```

+## Multi-cluster Gateway Configuration


I moved it here to be before the feature consumption sections. But have not review and update the section yet.

jianjuns · 2022-06-02T01:58:08Z

docs/multicluster/user-guide.md

@@ -503,6 +591,17 @@ Events:
  Warning ACNPImportFailed     2m11s  resourceimport-controller  ACNP Tier random does not exist in the importing cluster test-cluster-west
 ```

+## Build Antrea Multi-cluster Image


This is not really for users. But anyway, I moved it to the end of the doc.

jianjuns · 2022-06-02T01:59:09Z

docs/multicluster/user-guide.md

+cluster, one in leader mode and another in member mode. There is no deployment
+dependency between member and leader clusters when you have a dedicated leader
+cluster. But to run both leader and member controllers in one cluster, you need
+to follow the deployment sequence below:


Is it still true? @luolanzone

I think there is no dependency even the cluster run both leader and member if user is using 'kubectl apply', but if user is using kubectl create -f, CRD installation will fail since some of them are already existing like ClusterClaim.

If it is true, we should remove the words around ordering.

luolanzone · 2022-06-02T04:24:48Z

multicluster/config/samples/clusterset_init/multicluster_membercluster_template.yaml

-    - clusterID: test-cluster-east
-  namespace: antrea-mcs-ns
+    - clusterID: test-cluster-leader
+    - clusterID: test-cluster-member


@hjiajing Could you help to review these changes in templates? I hope it has minor impact to CI, thanks.

@luolanzone : please update the ObjectMeta.Name first.

sure, I am working the diagram, will submit a new commit once is done.

jianjuns

Re-paste my comments for the diagram:

What you think we have a box for the ClusterSet that contains the two clusters? We can add ClusterSet ID there.
Add something like "leader" to the leader mc-controller to indicate it is the controller for leader.
And some way to indicate the Gateway Node too.
Could we add apiserver IP to Cluster A
Could we indicate Cluster A is "leader and member", and Cluster B is "member"
We should change the Node names in the diagram and commands (e.g. node-a1/a2 and node-b1/b2)

jianjuns · 2022-06-02T19:03:17Z

docs/multicluster/quick-start.md

+
+```bash
+$kubectl apply -f https://github.com/antrea-io/antrea/releases/download/$TAG/antrea-multicluster-member.yml
+$kubectl apply -f https://github.com/antrea-io/antrea/releases/download/$TAG/antrea-multicluster-leader-global.yml


Do we need to apply antrea-multicluster-leader-global.yml for a dual-role cluster? In the user guide, earlier you wrote it is necessary, as antrea-multicluster-member.yml already import all CRDs.

If we do need to apply all YAMLs and the order does not matter, I would apply leader YAMLs first, which is easier to understand. @luolanzone

yes, we removed those unnecessary CRDs which was both in leader and member yamls, so we need to apply antrea-multicluster-leader-global.yml for a dual-role cluster, I will move it.

Done, the diagram is also updated.

jianjuns · 2022-06-05T21:10:16Z

docs/multicluster/quick-start.md

+
+```bash
+$kubectl apply -f https://github.com/antrea-io/antrea/releases/download/$TAG/antrea-multicluster-leader-global.yml
+$kubectl apply -f https://github.com/antrea-io/antrea/releases/download/$TAG/antrea-multicluster-member.yml


I noticed you added this line in your last update, but antrea-multicluster-member.yml is already applied in line 60. Should we remove this line?

I also revised the diagram a little. Check.

I removed the extra step to apply member manifest. The revised diagram looks good to me, but I changed the background to white so it can show in browser's dark mode clearly.

jianjuns · 2022-06-06T03:41:06Z

docs/multicluster/quick-start.md

+$sed 's/changeme/antrea-multicluster/g' antrea-multicluster-leader-namespaced.yml | kubectl apply -f -
+$kubectl apply -f https://github.com/antrea-io/antrea/releases/download/$TAG/antrea-multicluster-member.yml
+```
+


It might be good to add a command to check the deployment results that can show both leader & member mc-controller Deployments and Pods.

Does something like work: kc get all -A -l="app=xyz"

What should be the "xyz".

@luolanzone

sure, I will add it, it can be kubectl get all -A -l="component=antrea-mc-controller", should I add a sample output?

Yes, better to have a sample output.

hjiajing · 2022-06-06T05:43:40Z

@luolanzone Hi Lan. I changed multiclusterv1alpha1.WellKnownClusterClaimClusterSet from clusterSet.k8s.io to clusterset.k8s.io. I don't know if this change will affect you in this PR. Just a reminder.

luolanzone · 2022-06-06T05:47:27Z

@hjiajing , I will check, thanks for the reminder, please make sure e2e is passed after you change the ID.

Add a quick start guide. Update the user guide with Multi-cluster Gateway. Signed-off-by: Lan Luo <luola@vmware.com> Co-authored-by: Jianjun Shen <shenj@vmware.com>

luolanzone · 2022-06-07T07:02:54Z

Hi @jianjuns I also changed the WellKnownClusterClaimClusterSet from "clusterSet.k8s.io"` "clusterset.k8s.io" in this PR and all other related strings, maybe do a rebase later if @hjiajing 's antctl bootstrap is merged first. and I changed your sign-off info to co-author in the commit, otherwise, there will be no extra co-author information.

jianjuns · 2022-06-08T03:20:02Z

/skip-all

luolanzone requested a review from jianjuns June 1, 2022 14:12

jianjuns changed the title ~~Update MC user guide and templates~~ Update multi-cluster user guide and templates Jun 1, 2022

jianjuns reviewed Jun 1, 2022

View reviewed changes

jianjuns force-pushed the mc-user-guide branch 3 times, most recently from 18b8999 to 3ab0d4f Compare June 2, 2022 00:16

jianjuns reviewed Jun 2, 2022

View reviewed changes

jianjuns force-pushed the mc-user-guide branch from 3ab0d4f to f27e3d1 Compare June 2, 2022 01:55

jianjuns reviewed Jun 2, 2022

View reviewed changes

jianjuns force-pushed the mc-user-guide branch from f27e3d1 to fd98be2 Compare June 2, 2022 02:02

luolanzone requested a review from hjiajing June 2, 2022 04:23

luolanzone commented Jun 2, 2022

View reviewed changes

jianjuns force-pushed the mc-user-guide branch from fd98be2 to 40e0f56 Compare June 2, 2022 05:11

luolanzone added the area/multi-cluster Issues or PRs related to multi cluster. label Jun 2, 2022

luolanzone force-pushed the mc-user-guide branch 2 times, most recently from 50352f7 to 82d7a67 Compare June 2, 2022 07:47

jianjuns reviewed Jun 2, 2022

View reviewed changes

jianjuns force-pushed the mc-user-guide branch 2 times, most recently from ae7696c to c4003f8 Compare June 2, 2022 21:15

jianjuns mentioned this pull request Jun 3, 2022

Add docs for theia and policy recommendation CLI antrea-io/theia#36

Merged

jianjuns force-pushed the mc-user-guide branch from c4003f8 to ecc2134 Compare June 3, 2022 01:51

luolanzone force-pushed the mc-user-guide branch 2 times, most recently from c247938 to 455968a Compare June 4, 2022 12:46

jianjuns reviewed Jun 5, 2022

View reviewed changes

jianjuns force-pushed the mc-user-guide branch 4 times, most recently from 7850531 to 2c2813e Compare June 5, 2022 22:43

luolanzone force-pushed the mc-user-guide branch from 2c2813e to 76500ad Compare June 6, 2022 01:05

jianjuns reviewed Jun 6, 2022

View reviewed changes

luolanzone force-pushed the mc-user-guide branch from 76500ad to ad490a5 Compare June 6, 2022 04:16

jianjuns force-pushed the mc-user-guide branch from 3240a57 to f23d3e5 Compare June 6, 2022 17:33

luolanzone force-pushed the mc-user-guide branch from f23d3e5 to 5be01e8 Compare June 7, 2022 06:58

Update example ClusterSet SVG for Multi-cluster quick-start

97aca3f

Add a quick start guide. Update the user guide with Multi-cluster Gateway. Signed-off-by: Lan Luo <luola@vmware.com> Co-authored-by: Jianjun Shen <shenj@vmware.com>

luolanzone force-pushed the mc-user-guide branch from 5be01e8 to 97aca3f Compare June 7, 2022 06:59

luolanzone added this to the Antrea v1.7 release milestone Jun 7, 2022

jianjuns approved these changes Jun 8, 2022

View reviewed changes

jianjuns merged commit 62a0145 into antrea-io:main Jun 8, 2022

luolanzone deleted the mc-user-guide branch July 14, 2022 09:31

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update multi-cluster user guide and templates #3853

Update multi-cluster user guide and templates #3853

luolanzone commented Jun 1, 2022 •

edited

codecov-commenter commented Jun 1, 2022 •

edited

jianjuns Jun 1, 2022

luolanzone Jun 2, 2022

luolanzone Jun 2, 2022

jianjuns commented Jun 2, 2022

jianjuns Jun 2, 2022

luolanzone Jun 2, 2022

jianjuns Jun 2, 2022 •

edited

jianjuns Jun 2, 2022

jianjuns Jun 2, 2022

jianjuns Jun 2, 2022

luolanzone Jun 2, 2022

jianjuns Jun 2, 2022

luolanzone Jun 2, 2022

jianjuns Jun 2, 2022

luolanzone Jun 2, 2022

jianjuns left a comment •

edited

jianjuns Jun 2, 2022

luolanzone Jun 4, 2022 •

edited

luolanzone Jun 4, 2022

jianjuns Jun 5, 2022

jianjuns Jun 5, 2022

luolanzone Jun 6, 2022

jianjuns Jun 6, 2022

jianjuns Jun 6, 2022 •

edited

luolanzone Jun 6, 2022

jianjuns Jun 6, 2022

luolanzone Jun 6, 2022

hjiajing commented Jun 6, 2022

luolanzone commented Jun 6, 2022

luolanzone commented Jun 7, 2022 •

edited

jianjuns commented Jun 8, 2022

Update multi-cluster user guide and templates #3853

Update multi-cluster user guide and templates #3853

Conversation

luolanzone commented Jun 1, 2022 • edited

codecov-commenter commented Jun 1, 2022 • edited

Codecov Report

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jianjuns commented Jun 2, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jianjuns Jun 2, 2022 • edited

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

jianjuns left a comment • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

luolanzone Jun 4, 2022 • edited

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

jianjuns Jun 6, 2022 • edited

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

hjiajing commented Jun 6, 2022

luolanzone commented Jun 6, 2022

luolanzone commented Jun 7, 2022 • edited

jianjuns commented Jun 8, 2022

luolanzone commented Jun 1, 2022 •

edited

codecov-commenter commented Jun 1, 2022 •

edited

jianjuns Jun 2, 2022 •

edited

jianjuns left a comment •

edited

luolanzone Jun 4, 2022 •

edited

jianjuns Jun 6, 2022 •

edited

luolanzone commented Jun 7, 2022 •

edited