Antctl multicluster Doc for antctl.md #3414

bangqipropel · 2022-03-07T23:35:01Z

No description provided.

codecov-commenter · 2022-03-07T23:58:04Z

Codecov Report

Merging #3414 (e80cfcb) into main (a539b78) will decrease coverage by 10.47%.
The diff coverage is n/a.

@@             Coverage Diff             @@
##             main    #3414       +/-   ##
===========================================
- Coverage   65.46%   54.98%   -10.48%     
===========================================
  Files         278      392      +114     
  Lines       27771    43057    +15286     
===========================================
+ Hits        18179    23677     +5498     
- Misses       7666    16976     +9310     
- Partials     1926     2404      +478

Flag	Coverage Δ
integration-tests	`38.22% <ø> (?)`
kind-e2e-tests	`51.26% <ø> (-3.93%)`	⬇️
unit-tests	`43.36% <ø> (+0.03%)`	⬆️

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

Impacted Files	Coverage Δ
pkg/apis/controlplane/types.go	`0.00% <0.00%> (-100.00%)`	⬇️
pkg/controller/networkpolicy/store/group.go	`5.00% <0.00%> (-70.00%)`	⬇️
pkg/apis/controlplane/helper.go	`33.33% <0.00%> (-66.67%)`	⬇️
pkg/controller/networkpolicy/convert.go	`0.00% <0.00%> (-64.52%)`	⬇️
pkg/controller/networkpolicy/tier.go	`12.50% <0.00%> (-40.00%)`	⬇️
pkg/apiserver/handlers/webhook/convert_crd.go	`2.56% <0.00%> (-32.48%)`	⬇️
pkg/controller/types/group.go	`53.57% <0.00%> (-32.15%)`	⬇️
pkg/controller/networkpolicy/validate.go	`48.07% <0.00%> (-32.14%)`	⬇️
pkg/controller/networkpolicy/status_controller.go	`66.47% <0.00%> (-16.77%)`	⬇️
pkg/util/k8s/name.go	`25.00% <0.00%> (-12.50%)`	⬇️
... and 145 more

luolanzone · 2022-03-08T01:04:42Z

@bangqipropel you can do a force push to change the structure. thanks.

luolanzone · 2022-03-08T01:12:07Z

docs/antctl.md

+
+### Multi-Cluster commands
+
+Starting with version 1.6.0, Antrea supports the `antctl mc` commands, which can collect information from multicluster cluster. 


s/with/from/
s/multicluster cluster/a leader cluster in a ClusterSet./

luolanzone · 2022-03-08T01:13:40Z

docs/antctl.md

+### Multi-Cluster commands
+
+Starting with version 1.6.0, Antrea supports the `antctl mc` commands, which can collect information from multicluster cluster. 
+This information is useful when tryting to troubleshoot issues in


s/tryting/trying/
s/in/in a ClusterSet/

luolanzone · 2022-03-08T01:15:59Z

docs/antctl.md

+ClusterSet, ResourceImport, and ResourceExport, than using the default table
+output format.
+```bash
+antctl mc get clusterset [NAME] [-n NAMESPACE] [-o yaml] [--ALLNAMESPACES]


s/--ALLNAMESPACES/-A/

luolanzone · 2022-03-08T01:18:57Z

docs/antctl.md

+
+Starting with version 1.6.0, Antrea supports the `antctl mc` commands, which can collect information from multicluster cluster. 
+This information is useful when tryting to troubleshoot issues in
+- `antctl` `mc` `get clusterset` (or `get clustersets`) command can print all


s/antctl mc get clusterset/antctl mc get clusterset
please also fix following format issue.

bangqipropel · 2022-03-10T23:46:02Z

@luolanzone @hjiajing @jianjun can this be reviewed? Thanks!

luolanzone · 2022-03-11T02:17:55Z

docs/antctl.md

+
+### Multi-Cluster commands
+
+For information about Antrea Multi-Cluster commands, refer to the


please refer to

luolanzone · 2022-03-11T02:19:49Z

docs/multicluster/antctl.md

+Starting from version 1.6.0, Antrea supports the `antctl mc` commands, which can collect information from a leader cluster in a ClusterSet.
+This information is useful when trying to troubleshoot issues in an Antrea Multi-cluster ClusterSet.
+
+All antctl multi-cluster commands can only run correctly after [deploying Antrea Multi-cluster](./getting-started.md) successfully.


s/multi-cluster/Multi-cluster

luolanzone · 2022-03-11T02:22:40Z

docs/multicluster/antctl.md

+Namespace, or ResourceExports in a specific cluster.
+
+Using the `json` or `yaml` antctl output format can print more information of
+ClusterSet, ResourceImport, and ResourceExport, than using the default table


s/, than/ than

luolanzone · 2022-03-11T02:23:39Z

docs/multicluster/antctl.md

+output format.
+
+```bash
+antctl mc get clusterset [NAME] [-n NAMESPACE] [-o yaml] [-A]


s/[-o yaml]/[-o json|yaml]/

bangqipropel · 2022-03-21T19:54:39Z

@jianjuns @antoninbas can this be reviewed? thank you!

jianjuns · 2022-03-21T23:17:25Z

docs/antctl.md

@@ -33,6 +33,7 @@ running in three different modes:
  - [Flow Aggregator commands](#flow-aggregator-commands)
    - [Dumping flow records](#dumping-flow-records)
    - [Record metrics](#record-metrics)
+  - [Multi-Cluster commands](#multi-cluster-commands)


I think we generally use "Multi-cluster"?

I changed it back to Multi-Cluster since this is automatically generated, and it will fail during TOC CI verify if we change it to Multi-cluster

ignore me, I shouldn't change here, I updated Multi-Cluster to Multi-cluster in the description section, then we can have the right TOC title here.

jianjuns · 2022-03-21T23:18:57Z

docs/antctl.md

+### Multi-Cluster commands
+
+For information about Antrea Multi-Cluster commands, please refer to the
+[Antctl Multi-cluster command line](./multicluster/antctl.md).


antctl Multi-cluster commands

jianjuns · 2022-03-21T23:18:57Z

docs/antctl.md

+### Multi-Cluster commands
+
+For information about Antrea Multi-Cluster commands, please refer to the
+[Antctl Multi-cluster command line](./multicluster/antctl.md).


antctl Multi-cluster commands

jianjuns · 2022-03-21T23:19:41Z

docs/multicluster/antctl.md

@@ -0,0 +1,28 @@
+# Antctl Multi-cluster command line


Antctl Multi-cluster commands

jianjuns · 2022-03-21T23:19:41Z

docs/multicluster/antctl.md

@@ -0,0 +1,28 @@
+# Antctl Multi-cluster command line


Antctl Multi-cluster commands

jianjuns · 2022-03-21T23:23:01Z

docs/multicluster/antctl.md

+All antctl Multi-cluster commands can only run correctly after [deploying Antrea Multi-cluster](./getting-started.md) successfully.
+
+- `antctl mc get clusterset` (or `get clustersets`) command can print all
+ClusterSets, a specified Clusterset, or ClusterSets in a specified


I think we support only a single ClusterSet in a Namespace?

jianjuns · 2022-03-21T23:23:19Z

docs/multicluster/antctl.md

+
+- `antctl mc get clusterset` (or `get clustersets`) command can print all
+ClusterSets, a specified Clusterset, or ClusterSets in a specified
+Namespace.


leader cluster Namespace

jianjuns · 2022-03-21T23:23:19Z

docs/multicluster/antctl.md

+
+- `antctl mc get clusterset` (or `get clustersets`) command can print all
+ClusterSets, a specified Clusterset, or ClusterSets in a specified
+Namespace.


leader cluster Namespace

jianjuns · 2022-03-21T23:24:03Z

docs/multicluster/antctl.md

+Namespace.
+- `antctl mc get resourceexport` (or `get resourceexports`, `get re`) command can print all
+ResourceExports, a specified ResourceExport, ResourceExports in a specified
+Namespace, or ResourceExports in a specific cluster.


; or ResourceExports in a specific member cluster.

jianjuns · 2022-03-21T23:24:03Z

docs/multicluster/antctl.md

+Namespace.
+- `antctl mc get resourceexport` (or `get resourceexports`, `get re`) command can print all
+ResourceExports, a specified ResourceExport, ResourceExports in a specified
+Namespace, or ResourceExports in a specific cluster.


; or ResourceExports in a specific member cluster.

jianjuns

LGTM

tnqn

Doc content LGTM, but there is format issue and docs/antctl.md shouldn't be added to exception list.

tnqn · 2022-03-25T10:30:26Z

docs/multicluster/antctl.md

@@ -0,0 +1,26 @@
+# Antctl Multi-cluster commands
+
+Starting from version 1.6.0, Antrea supports the `antctl mc` commands, which can collect information from a leader cluster in a ClusterSet, for troubleshooting issues in an Antrea Multi-cluster ClusterSet.


Could you wrap the lines like other docs? Typically for docs we limit 80 chars per line so we could see the whole lines in some editors. But you don't need to break lines for code block and link.

tnqn · 2022-03-25T10:36:03Z

hack/.notableofcontents

@@ -1,5 +1,6 @@
 docs/aks-installation.md
 docs/api.md
+docs/antctl.md


This doc has table of contents and we need CI to ensure it's accurate, why adding it to the exception list?

removed it.

tnqn

LGTM

tnqn · 2022-03-25T13:37:32Z

/skip-all

tnqn · 2022-03-25T15:34:14Z

Doc verify failed. It's because this PR doesn't rebase on main branch and uses a stale link: getting-started.md has been renamed to "user-guide.md" by #3513.

FILE: ./docs/multicluster/antctl.md
[✖] ./getting-started.md

1 links checked.

ERROR: 1 dead links found!
[✖] ./getting-started.md → Status: 400

luolanzone

LGTM

tnqn · 2022-03-26T02:37:40Z

docs/multicluster/antctl.md

+Namespace.
+- `antctl mc get resourceexport` (or `get resourceexports`, `get re`) command can print all
+ResourceExports, a specified ResourceExport, ResourceExports in a specified
+Namespace, or ResourceExports in a specific member cluster.


The lines are not aligned consistently.

Signed-off-by: zbangqi <[email protected]>

tnqn · 2022-03-26T17:25:30Z

/skip-all

bangqipropel force-pushed the antctl_mc_doc branch from 59401df to f264436 Compare March 7, 2022 23:41

bangqipropel force-pushed the antctl_mc_doc branch from f264436 to f46f458 Compare March 8, 2022 00:39

bangqipropel closed this Mar 8, 2022

luolanzone reopened this Mar 8, 2022

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

luolanzone reviewed Mar 8, 2022

View reviewed changes

bangqipropel force-pushed the antctl_mc_doc branch from f46f458 to a23c945 Compare March 9, 2022 00:47

bangqipropel changed the title ~~[WIP] Antctl multicluster Doc for antctl.md~~ Antctl multicluster Doc for antctl.md Mar 9, 2022

bangqipropel force-pushed the antctl_mc_doc branch 3 times, most recently from 184bc39 to 8298b68 Compare March 10, 2022 23:00

luolanzone reviewed Mar 11, 2022

View reviewed changes

luolanzone requested review from hjiajing and jianjuns March 11, 2022 02:24

bangqipropel force-pushed the antctl_mc_doc branch from 8298b68 to be7f705 Compare March 14, 2022 07:26

luolanzone added this to the Antrea v1.6 release milestone Mar 16, 2022

jianjuns reviewed Mar 21, 2022

View reviewed changes

bangqipropel force-pushed the antctl_mc_doc branch from be7f705 to 25c35b2 Compare March 22, 2022 09:41

bangqipropel closed this Mar 22, 2022

bangqipropel reopened this Mar 22, 2022

bangqipropel force-pushed the antctl_mc_doc branch 5 times, most recently from 9823aaa to dedb2f2 Compare March 22, 2022 10:45

jianjuns previously approved these changes Mar 22, 2022

View reviewed changes

tnqn reviewed Mar 25, 2022

View reviewed changes

luolanzone dismissed jianjuns’s stale review via 9977627 March 25, 2022 13:23

luolanzone force-pushed the antctl_mc_doc branch 2 times, most recently from 9977627 to cd413db Compare March 25, 2022 13:34

tnqn previously approved these changes Mar 25, 2022

View reviewed changes

bangqipropel dismissed tnqn’s stale review via 13be13d March 25, 2022 18:48

bangqipropel force-pushed the antctl_mc_doc branch 3 times, most recently from 16ff239 to f65f643 Compare March 25, 2022 19:45

luolanzone previously approved these changes Mar 26, 2022

View reviewed changes

tnqn reviewed Mar 26, 2022

View reviewed changes

antctl mc doc

e80cfcb

Signed-off-by: zbangqi <[email protected]>

luolanzone dismissed their stale review via e80cfcb March 26, 2022 05:28

luolanzone force-pushed the antctl_mc_doc branch from f65f643 to e80cfcb Compare March 26, 2022 05:28

tnqn approved these changes Mar 26, 2022

View reviewed changes

tnqn closed this Mar 26, 2022

tnqn reopened this Mar 26, 2022

tnqn merged commit 404da37 into antrea-io:main Mar 28, 2022

tnqn added the action/release-note Indicates a PR that should be included in release notes. label Mar 28, 2022


		### Multi-Cluster commands

		Starting with version 1.6.0, Antrea supports the `antctl mc` commands, which can collect information from multicluster cluster.


		### Multi-Cluster commands

		For information about Antrea Multi-Cluster commands, refer to the

		@@ -0,0 +1,26 @@
		# Antctl Multi-cluster commands

		Starting from version 1.6.0, Antrea supports the `antctl mc` commands, which can collect information from a leader cluster in a ClusterSet, for troubleshooting issues in an Antrea Multi-cluster ClusterSet.

Antctl multicluster Doc for antctl.md #3414

Antctl multicluster Doc for antctl.md #3414

Conversation

bangqipropel commented Mar 7, 2022

codecov-commenter commented Mar 7, 2022 • edited Loading

Codecov Report

luolanzone commented Mar 8, 2022

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

bangqipropel commented Mar 10, 2022

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

bangqipropel commented Mar 21, 2022

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

jianjuns left a comment

Choose a reason for hiding this comment

tnqn 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

tnqn left a comment

Choose a reason for hiding this comment

tnqn commented Mar 25, 2022

tnqn commented Mar 25, 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

tnqn commented Mar 26, 2022

codecov-commenter commented Mar 7, 2022 •

edited

Loading