Documentation
Introduction
- Overview
- Getting Started
- Support for K8s Installers
- Deploying on Kind
- Deploying on Minikube
- Configuration
- Installing with Helm
Cloud Deployment
Reference
- Antrea Network Policy
- Antctl
- Architecture
- Traffic Encryption (Ipsec / WireGuard)
- Securing Control Plane
- Security considerations
- Troubleshooting
- OS-specific Known Issues
- OVS Pipeline
- Feature Gates
- Antrea Proxy
- Network Flow Visibility
- Traceflow Guide
- NoEncap and Hybrid Traffic Modes
- Egress Guide
- NodePortLocal Guide
- Antrea IPAM Guide
- Exposing Services of type LoadBalancer
- Traffic Control
- BGP Support
- Versioning
- Antrea API Groups
- Antrea API Reference
Windows
Integrations
Cookbooks
Multicluster
Developer Guide
Project Information
Antctl Multi-cluster commands
Starting from version 1.6.0, Antrea supports the antctl mc
commands, which can
collect information from a leader cluster for troubleshooting Antrea
Multi-cluster issues, deploy Antrea Multi-cluster and set up ClusterSets in both
leader and member clusters. The antctl mc get
command is supported since
Antrea v1.6.0, while other commands are supported since v1.8.0. These commands
cannot run inside the antrea-controller
, antrea-agent
or
antrea-mc-controller
Pods. antctl needs a kubeconfig file to access the target
cluster’s API server, and it will look for the kubeconfig file at
$HOME/.kube/config
by default. You can select a different file by setting the
KUBECONFIG
environment variable or with the --kubeconfig
option of antctl.
antctl mc get
antctl mc get clusterset
(orget clustersets
) command prints all ClusterSets, a specified Clusterset, or the ClusterSet in a specified Namespace.antctl mc get resourceimport
(orget resourceimports
,get ri
) command prints all ResourceImports, a specified ResourceImport, or ResourceImports in a specified Namespace.antctl mc get resourceexport
(orget resourceexports
,get re
) command prints all ResourceExports, a specified ResourceExport, or ResourceExports in a specified Namespace.antctl mc get joinconfig
command prints member cluster join parameters of the ClusterSet in a specified leader cluster Namespace.antctl mc get membertoken
(orget membertokens
) command prints all member tokens, a specified token, or member tokens in a specified Namespace. The command is supported only on a leader 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.
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]
antctl mc get joinconfig [--member-token TOKEN_NAME] [-n NAMESPACE]
antctl mc get membertoken [NAME] [-n NAMESPACE] [-o json|yaml] [-A]
To see the usage examples of these commands, you may also run antctl mc get [subcommand] --help
.
antctl mc create
antctl mc create
command creates a token for member clusters to join a ClusterSet. The command will
also create a Secret to store the token, as well as a ServiceAccount and a RoleBinding. The --output-file
option saves the member token Secret manifest to a file.
anctcl mc create membertoken NAME -n NAMESPACE [-o OUTPUT_FILE]
To see the usage examples of these commands, you may also run antctl mc create [subcommand] --help
.
antctl mc delete
antctl mc delete
command deletes a member token of a ClusterSet. The command will delete the
corresponding Secret, ServiceAccount and RoleBinding if they exist.
anctcl mc delete membertoken NAME -n NAMESPACE
To see the usage examples of these commands, you may also run antctl mc delete [subcommand] --help
.
antctl mc deploy
antctl mc deploy
command deploys Antrea Multi-cluster Controller to a leader or member cluster.
antctl mc deploy leadercluster
command deploys Antrea Multi-cluster Controller to a leader cluster and imports all the Antrea Multi-cluster CRDs.antctl mc deploy membercluster
command deploys Antrea Multi-cluster Controller to a member cluster and imports all the Antrea Multi-cluster CRDs.
antctl mc deploy leadercluster -n NAMESPACE [--antrea-version ANTREA_VERSION] [-f PATH_TO_MANIFEST]
antctl mc deploy membercluster -n NAMESPACE [--antrea-version ANTREA_VERSION] [-f PATH_TO_MANIFEST]
To see the usage examples of these commands, you may also run antctl mc deploy [subcommand] --help
.
antctl mc init
antctl mc init
command initializes an Antrea Multi-cluster ClusterSet in a leader cluster. It will create a
ClusterSet for the leader cluster. If the -j|--join-config-file
option is specified, the ClusterSet join
parameters will be saved to the specified file, which can be used in the antctl mc join
command
for a member cluster to join the ClusterSet.
antctl mc init -n NAMESPACE --clusterset CLUSTERSET_ID --clusterid CLUSTERID [--create-token] [-j JOIN_CONFIG_FILE]
To see the usage examples of this command, you may also run antctl mc init --help
.
antctl mc join
antctl mc join
command lets a member cluster join an existing Antrea Multi-cluster ClusterSet. It will create a
ClusterSet for the member cluster. Users can use command line options or a config file (which can be the output
file of the anctl mc init
command) to specify the ClusterSet join arguments.
When the config file is provided, the command line options may be overridden by the file. A token is needed for a
member cluster to access the leader cluster API server. Users can either specify a pre-created token Secret with the
--token-secret-name
option, or pass a Secret manifest to create the Secret with either the --token-secret-file
option or the config file.
antctl mc join --clusterset=CLUSTERSET_ID \
--clusterid=CLUSTER_ID \
--namespace=[MEMBER_NAMESPACE] \
--leader-clusterid=LEADER_CLUSTER_ID \
--leader-namespace=LEADER_NAMESPACE \
--leader-apiserver=LEADER_APISERVER \
--token-secret-name=[TOKEN_SECRET_NAME] \
--token-secret-file=[TOKEN_SECRET_FILE]
antctl mc join --config-file JOIN_CONFIG_FILE [--clusterid=CLUSTER_ID] [--token-secret-name=TOKEN_SECRET_NAME] [--token-secret-file=TOKEN_SECRET_FILE]
Below is a config file example:
apiVersion: multicluster.antrea.io/v1alpha1
kind: ClusterSetJoinConfig
clusterSetID: clusterset1
clusterID: cluster-east
namespace: kube-system
leaderClusterID: cluster-north
leaderNamespace: antrea-multicluster
leaderAPIServer: https://172.18.0.3:6443
tokenSecretName: cluster-east-token
antctl mc leave
antctl mc leave
command lets a member cluster leave a ClusterSet. It will delete the ClusterSet
and other resources created by antctl for the member cluster.
antctl mc leave --clusterset CLUSTERSET_ID --namespace [NAMESPACE]
antctl mc destroy
antctl mc destroy
command can destroy an Antrea Multi-cluster ClusterSet in a leader cluster. It will delete the
ClusterSet and other resources created by antctl for the leader cluster.
antctl mc destroy --clusterset=CLUSTERSET_ID --namespace NAMESPACE