Overview
Sonobuoy is a diagnostic tool that makes it easier to understand the
state of a Kubernetes cluster by running a set of plugins (including Kubernetes conformance
tests) in an accessible and non-destructive manner. It is a customizable,
extendable, and cluster-agnostic way to generate clear, informative reports
about your cluster.
Its selective data dumps of Kubernetes resource objects and cluster nodes allow
for the following use cases:
- Integrated end-to-end (e2e) conformance-testing
- Workload debugging
- Custom data collection via extensible plugins
Sonobuoy supports 3 Kubernetes minor versions: the current release and 2 minor versions before. Sonobuoy is currently versioned to track the Kubernetes minor version to clarify the support matrix. For example, Sonobuoy v0.14.x would support Kubernetes 1.14.x, 1.13.x, and 1.12.x.
Note: You can skip this version enforcement by running Sonobuoy with the
--skip-preflightflag.
Prerequisites
-
Access to an up-and-running Kubernetes cluster. If you do not have a cluster,
we recommend following the AWS Quickstart for Kubernetes instructions. -
An admin
kubeconfigfile, and the KUBECONFIG environment variable set. -
For some advanced workflows it may be required to have
kubectlinstalled. See installing via Homebrew (MacOS) or building
the binary (Linux). -
The
sonobuoy imagessubcommand requires Docker to be installed. See installing Docker.
Installing
We recommend installing Sonobuoy via downloading one of the releases directly from here.
You can use the web UI to download a release or from the terminal:
$ VERSION=0.16.1 OS=darwin && \
curl -L "https://github.com/vmware-tanzu/sonobuoy/releases/download/v${VERSION}/sonobuoy_${VERSION}_${OS}_amd64.tar.gz" --output $HOME/bin/sonobuoy.tar.gz && \
tar -xzf $HOME/bin/sonobuoy.tar.gz -C $HOME/bin && \
chmod +x $HOME/bin/sonobuoy && \
rm $HOME/bin/sonobuoy.tar.gz
Note: Be sure to update the OS to your local value. Supported values are: "linux", "darwin", and "windows".
If building locally, you should clone the repository and run make. To build locally, Docker is required.
Getting Started
To launch conformance tests (ensuring CNCF conformance) and wait until they are finished run:
sonobuoy run --wait
Note: Using
--mode quickwill significantly shorten the runtime of Sonobuoy. It runs just a single test, helping to quickly validate your Sonobuoy and Kubernetes configuration.
Get the results from the plugins (e.g. e2e test results):
results=$(sonobuoy retrieve)
Inspect results for test failures. This will list the number of tests failed and their names:
sonobuoy results $results
Note: The
resultscommand has lots of useful options for various situations. See the results page for more details.
You can also extract the entire contents of the file to get much more detailed data about your cluster.
Sonobuoy creates a few resources in order to run and expects to run within its
own namespace.
Deleting Sonobuoy entails removing its namespace as well as a few cluster
scoped resources.
sonobuoy delete --wait
Note: The --wait option ensures the Kubernetes namespace is deleted, avoiding conflicts if another Sonobuoy run is started quickly.
Other Tests
By default, sonobuoy run runs the Kubernetes conformance tests but this can easily be configured. The same plugin that has the conformance tests has all the Kubernetes end-to-end tests which include other tests such as:
- tests for specific storage features
- performance tests
- scaling tests
- provider specific tests
- and many more
To modify which tests you want to run, checkout our page on the e2e plugin.
If you want to run other tests or tools which are not a part of the Kubernetes end-to-end suite, refer to our documentation on custom plugins.
Monitoring Sonobuoy during a run
You can check on the status of each of the plugins running with:
sonobuoy status
You can also inspect the logs of all Sonobuoy containers:
sonobuoy logs
Troubleshooting
If you encounter any problems that the documentation does not address, file an
issue.
Known Issues
Leaked End-to-end namespaces
There are some Kubernetes e2e tests that may leak resources. Sonobuoy can
help clean those up as well by deleting all namespaces prefixed with e2e:
sonobuoy delete --all
Run on Google Cloud Platform (GCP)
Sonobuoy requires admin permissions which won't be automatic if you are running via Google Kubernetes Engine (GKE) cluster. You must first create an admin role for the user under which you run Sonobuoy:
kubectl create clusterrolebinding <your-user-cluster-admin-binding> --clusterrole=cluster-admin --user=<your.google.cloud.email@example.org>
Contributing
Thanks for taking the time to join our community and start contributing! We
welcome pull requests. Feel free to dig through the issues and jump in.
Before you start
- Please familiarize yourself with the Code of Conduct before
contributing. - See CONTRIBUTING.md for instructions on the developer certificate
of origin that we require. - There is a Slack channel if you want to
interact with other members of the community
Changelog
See the list of releases to find out about feature changes.