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.

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

Add antctl CLI command to run post-installation checks #6061

Closed
antoninbas opened this issue Mar 5, 2024 · 4 comments
Closed

Add antctl CLI command to run post-installation checks #6061

antoninbas opened this issue Mar 5, 2024 · 4 comments
Labels
kind/feature Categorizes issue or PR as related to a new feature.

Comments

@antoninbas
Copy link
Contributor

This is a subtask for #5896

Regardless of the installation method for Antrea, it would be useful to have an antctl CLI command to quickly validate an Antrea installation and identify possible problems with the cluster. In essence, this command would serve a similar purpose as cilium connectivity test, which currently runs 69 connectivity tests.

We should probably start with a small set of tests initially (which by the way may not be limited to connectivity). If we have a robust and flexible framework, we can easily add new tests over time as needed.

Note that there is a fine line between post-installation checks and e2e tests. We want to avoid too much redundancy between the 2, and post-installation checks should ideally run pretty fast, so that users can run them after each installation and get results quickly.

@antoninbas antoninbas added the kind/feature Categorizes issue or PR as related to a new feature. label Mar 5, 2024
@antoninbas
Copy link
Contributor Author

cc @kanha-gupta

@antoninbas
Copy link
Contributor Author

I have an idea for a specific post-installation test, once #6133 (which defines the framework) is merged: when Antrea is deployed with encryption enabled (e.g., with Wireguard), we should include a test to validate that inter-Node Pod-to-Pod traffic is indeed encrypted. I think this could give users confidence that encryption is working correctly.

@kanha-gupta
Copy link
Contributor

I have an idea for a specific post-installation test, once #6133 (which defines the framework) is merged: when Antrea is deployed with encryption enabled (e.g., with Wireguard), we should include a test to validate that inter-Node Pod-to-Pod traffic is indeed encrypted. I think this could give users confidence that encryption is working correctly.

Hi @antoninbas, The idea Sounds good to me :)

antoninbas pushed a commit that referenced this issue Apr 29, 2024
We introduce a new antctl subcommand (antctl check) which can be used to
run sanity checks on a K8s cluster / Antrea deployment.
At the moment, we have "antctl check installation", which can be used to
validate an Antrea installation, by running some connectivity checks. We
only have a limited number of tests for now (inter-Node & intra-Node Pod
connectivity, Pod connectivity to the Internet), but the frameowk should
make it straightforward to add additional tests in the future.
We validate the antctl command in CI using a Github workflow.

For #6061

Signed-off-by: Kanha gupta <kanhag4163@gmail.com>
@antoninbas
Copy link
Contributor Author

Closing the issue as we have added the framework and a selection of tests. More tests will be added over time.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/feature Categorizes issue or PR as related to a new feature.
Projects
None yet
Development

No branches or pull requests

2 participants