Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Added the new antctl check command documentation #6373

Merged
merged 5 commits into from
May 31, 2024
Merged

Added the new antctl check command documentation #6373

Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
cdaa036
Added the new antctl check command documentation
kanha-gupta May 27, 2024
f5d9d94
improved lint
kanha-gupta May 27, 2024
70b6829
changes
kanha-gupta May 28, 2024
9419e99
changes
kanha-gupta May 29, 2024
57a70f4
changes
kanha-gupta May 31, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 49 additions & 0 deletions docs/antctl.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down Expand Up @@ -125,6 +128,52 @@ 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
kanha-gupta marked this conversation as resolved.
Show resolved Hide resolved
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:
kanha-gupta marked this conversation as resolved.
Show resolved Hide resolved

```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 post-installation checks, Simply run the command as follows:

```bash
antctl check installation
```

In case Antrea is installed in a custom namespace, You
can specify the namespace by adding the flag:

```bash
antctl check installation --namespace [namespace]
kanha-gupta marked this conversation as resolved.
Show resolved Hide resolved
```

Replace `[namespace]` with the actual name of the namespace.
kanha-gupta marked this conversation as resolved.
Show resolved Hide resolved

Run the following command to discover more utility flags:
kanha-gupta marked this conversation as resolved.
Show resolved Hide resolved

```bash
antctl check installation --help
kanha-gupta marked this conversation as resolved.
Show resolved Hide resolved
```

### Collecting support information

Starting with version 0.7.0, Antrea supports the `antctl supportbundle` command,
Expand Down
Loading