Skip to content

Commit

Permalink
antctl mc doc (#3414)
Browse files Browse the repository at this point in the history
Signed-off-by: zbangqi <[email protected]>
  • Loading branch information
bangqipropel authored Mar 28, 2022
1 parent b9e37a8 commit 404da37
Show file tree
Hide file tree
Showing 3 changed files with 37 additions and 0 deletions.
6 changes: 6 additions & 0 deletions docs/antctl.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
<!-- /toc -->

## Installation
Expand Down Expand Up @@ -626,3 +627,8 @@ Example outputs of record metrics:
RECORDS-EXPORTED RECORDS-RECEIVED FLOWS EXPORTERS-CONNECTED
46 118 7 2
```

### Multi-cluster commands

For information about Antrea Multi-cluster commands, please refer to the
[antctl Multi-cluster commands](./multicluster/antctl.md).
30 changes: 30 additions & 0 deletions docs/multicluster/antctl.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# 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.

All antctl Multi-cluster commands can only run correctly after [deploying Antrea
Multi-cluster](./user-guide.md) successfully.

- `antctl mc get clusterset` (or `get clustersets`) command can print all
ClusterSets, a specified Clusterset, or the ClusterSet in a specified leader cluster
Namespace.
- `antctl mc get resourceimport` (or `get resourceimports`, `get ri`) command can print
all ResourceImports, a specified ResourceImport, or ResourceImports in a specified
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.

Using the `json` or `yaml` antctl output format can print more information of
ClusterSet, ResourceImport, and ResourceExport than using the default table
output format.

```bash
antctl mc get clusterset [NAME] [-n NAMESPACE] [-o json|yaml] [-A]
antctl mc get resourceimport [NAME] [-n NAMESPACE] [-o json|yaml] [-A]
antctl mc get resourceexport [NAME] [-n NAMESPACE] [-clusterid CLUSTERID] [-o json|yaml] [-A]
```

To see the usage examples of these commands, you may also run `antctl mc get [subcommand] --help`.
1 change: 1 addition & 0 deletions hack/.notableofcontents
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ docs/maintainers/getting-started-gif.md
docs/maintainers/release.md
docs/maintainers/updating-ovs-windows.md
docs/multicluster/api.md
docs/multicluster/antctl.md
docs/multicluster/architecture.md
docs/multicluster/upgrade.md
docs/multicluster/user-guide.md
Expand Down

0 comments on commit 404da37

Please sign in to comment.