From cdaa03624a863423b3df1084ec852519cb863f44 Mon Sep 17 00:00:00 2001 From: Kanha gupta Date: Tue, 28 May 2024 02:39:28 +0530 Subject: [PATCH 1/5] 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, From f5d9d941888df4e52d59f99620b5aac7bbe34d99 Mon Sep 17 00:00:00 2001 From: kanha gupta Date: Mon, 27 May 2024 21:47:45 +0000 Subject: [PATCH 2/5] improved lint Signed-off-by: Kanha gupta --- docs/antctl.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/antctl.md b/docs/antctl.md index 9144e576603..0837290cab3 100644 --- a/docs/antctl.md +++ b/docs/antctl.md @@ -130,12 +130,12 @@ 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, +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 +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 @@ -159,7 +159,7 @@ antctl check installation --namespace [namespace] Replace `[namespace]` with the actual name of the namespace. -Run the following command to discover more utility flags: +Run the following command to discover more utility flags: ```bash antctl check installation --help From 70b6829f4095c7d7023d1a117ed31f93c4e24fa0 Mon Sep 17 00:00:00 2001 From: Kanha gupta Date: Wed, 29 May 2024 02:59:21 +0530 Subject: [PATCH 3/5] changes Signed-off-by: Kanha gupta --- docs/antctl.md | 23 ++++++++++++++++------- 1 file changed, 16 insertions(+), 7 deletions(-) diff --git a/docs/antctl.md b/docs/antctl.md index 0837290cab3..a721caa7db2 100644 --- a/docs/antctl.md +++ b/docs/antctl.md @@ -130,28 +130,37 @@ 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. +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: +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 ``` +Run the following command to discover more options: + +```bash +antctl check cluster --help +``` + #### 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: +Once Antrea is installed, it's important to verify that it is functioning correctly +within your cluster. To perform post-installation checks, Simply run the command as follows: ```bash antctl check installation ``` -Incase Antrea is installed in a custom namespace, You can specify the namespace by adding the flag: +In case Antrea is installed in a custom namespace, You +can specify the namespace by adding the flag: ```bash antctl check installation --namespace [namespace] From 9419e992013b0799fbd1d5e78e654d8c9c182e90 Mon Sep 17 00:00:00 2001 From: Kanha gupta Date: Thu, 30 May 2024 00:20:31 +0530 Subject: [PATCH 4/5] changes Signed-off-by: Kanha gupta --- docs/antctl.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/docs/antctl.md b/docs/antctl.md index a721caa7db2..d7e1b1edb9b 100644 --- a/docs/antctl.md +++ b/docs/antctl.md @@ -130,15 +130,16 @@ 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 provides a utility command `antctl check` designed to perform checks +that verify whether 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: +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 @@ -152,8 +153,9 @@ antctl check cluster --help #### Post-installation checks -Once Antrea is installed, it's important to verify that it is functioning correctly -within your cluster. To perform post-installation checks, Simply run the command as follows: +Once Antrea is installed, it's important to verify that it is functioning +correctly within your cluster. To perform post-installation checks, Simply run +the command as follows: ```bash antctl check installation @@ -163,11 +165,9 @@ In case Antrea is installed in a custom namespace, You can specify the namespace by adding the flag: ```bash -antctl check installation --namespace [namespace] +antctl check installation --namespace [NAMESPACE] ``` -Replace `[namespace]` with the actual name of the namespace. - Run the following command to discover more utility flags: ```bash From 57a70f4452d0f7cfd69af074b9ef4737dd18f9d5 Mon Sep 17 00:00:00 2001 From: Kanha gupta Date: Fri, 31 May 2024 19:49:34 +0530 Subject: [PATCH 5/5] changes Signed-off-by: Kanha gupta --- docs/antctl.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/antctl.md b/docs/antctl.md index d7e1b1edb9b..ed7993022e4 100644 --- a/docs/antctl.md +++ b/docs/antctl.md @@ -131,15 +131,15 @@ antctl get featuregates ### Performing checks to facilitate installation process Antrea provides a utility command `antctl check` designed to perform checks -that verify whether Kubernetes cluster is correctly configured for installing +that verify whether a 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: +Before installing Antrea, it can be helpful 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 @@ -153,8 +153,8 @@ antctl check cluster --help #### Post-installation checks -Once Antrea is installed, it's important to verify that it is functioning -correctly within your cluster. To perform post-installation checks, Simply run +Once Antrea is installed, you can verify that networking is functioning +correctly within your cluster. To perform post-installation checks, simply run the command as follows: ```bash @@ -168,7 +168,7 @@ can specify the namespace by adding the flag: antctl check installation --namespace [NAMESPACE] ``` -Run the following command to discover more utility flags: +Run the following command to discover more options: ```bash antctl check installation --help