From cdaa03624a863423b3df1084ec852519cb863f44 Mon Sep 17 00:00:00 2001 From: Kanha gupta Date: Tue, 28 May 2024 02:39:28 +0530 Subject: [PATCH] Added the new antctl check command documentation Signed-off-by: Kanha gupta --- docs/antctl.md | 40 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 40 insertions(+) diff --git a/docs/antctl.md b/docs/antctl.md index 5bf99aa403f..9144e576603 100644 --- a/docs/antctl.md +++ b/docs/antctl.md @@ -21,6 +21,9 @@ running in three different modes: - [Usage](#usage) - [Showing or changing log verbosity level](#showing-or-changing-log-verbosity-level) - [Showing feature gates status](#showing-feature-gates-status) + - [Performing checks to facilitate installation process](#performing-checks-to-facilitate-installation-process) + - [Pre-installation checks](#pre-installation-checks) + - [Post-installation checks](#post-installation-checks) - [Collecting support information](#collecting-support-information) - [controllerinfo and agentinfo commands](#controllerinfo-and-agentinfo-commands) - [NetworkPolicy commands](#networkpolicy-commands) @@ -125,6 +128,43 @@ The following command prints the current feature gates: antctl get featuregates ``` +### Performing checks to facilitate installation process + +Antrea provides a utility command `antctl check` designed to perform checks that verify whether the Kubernetes cluster is correctly configured for installing Antrea, +and also to confirm that Antrea has been installed correctly. + +#### Pre-installation checks + +Before installing Antrea, it's crucial to ensure that the Kubernetes cluster is configured properly. This can prevent potential issues that might arise during the +installation of Antrea. To perform these pre-installation checks, Simply run the command as follows: + +```bash +antctl check cluster +``` + +#### Post-installation checks + +Once Antrea is installed, it's important to verify that it is functioning correctly within your cluster. +To perform, Simply run the command: + +```bash +antctl check installation +``` + +Incase Antrea is installed in a custom namespace, You can specify the namespace by adding the flag: + +```bash +antctl check installation --namespace [namespace] +``` + +Replace `[namespace]` with the actual name of the namespace. + +Run the following command to discover more utility flags: + +```bash +antctl check installation --help +``` + ### Collecting support information Starting with version 0.7.0, Antrea supports the `antctl supportbundle` command,