Take a moment to explore the different Sonobuoy CLI commands and options: sonobuoy help

To deploy the latest version of Sonobuoy pods to our cluster: sonobuoy run --mode=Quick --sonobuoy-image gcr.io/heptio-images/sonobuoy:latest

Note: Sonobuoy conformance tests may take upwards of 60 minutes to complete, but Katacoda scenarios have a shorter life span, hence the Quick mode.

To view actively running pods: sonobuoy status

To inspect logs: sonobuoy logs

Alternatively, you may follow the log trail: sonobuoy logs -f (CTRL+C or ^C to exit)

To view the results, we must first copy the results from the main Sonobuoy pod to somewhere locally: sonobuoy retrieve .

Now that we have copied the .tar.gz snapshot from the Sonobuoy pod into our local . directory, we can extract the contents into ./results: mkdir ./results; tar xzvf *.tar.gz -C ./results

For more information on the contents of the snapshot, see the snapshot documentation

Sonobuoy can be extended via plugins.

Plugins have 2 main components:

1. Plugin Selection: A section of the YAML config, called config.json, that declares which plugins to use in the Sonobuoy run.
2. Plugin Definition: A YAML document that defines metadata and the pod(s) to produce a result.

Plugin Definition

Plugins can exist in:

• /etc/sonobuoy/plugins.d
• $HOME/.sonobuoy/plugins.d
• ./plugins.d.

This is configurable by the PluginSearchPath value in Sonobuoy config.

Plugin Contract

The plugin can run any container you want, but the workload must fulfill a contract.

Once a container completes the work, it must signal to Sonobuoy that it's done. The way to do this is by writing a results file. The default is /tmp/results/done, but this is configurable via the ResultsDir value in the Sonobuoy config.

Once Sonobuoy detects the presence of the done file, the results are transmitted back to the Sonobuoy aggregator.

Let's write a custom Sonobuoy plugin that targets a specific E2E test!

First, create the home directory for our plugin: mkdir -p $HOME/.sonobuoy/plugins.d

Second, let's create the plugin's YAML config:

cat <<EOF >$HOME/.sonobuoy/plugins.d/e2e-focus.yaml

---
sonobuoy-config:
  driver: Job        # Job or DaemonSet. Job runs once per run, Daemonset runs on every node per run.
  plugin-name: e2e   # The name of the plugin
  result-type: e2e   # The name of the "result type." Usually the name of the plugin.
spec:                # A kubernetes container spec
  env:
  - name: E2E_FOCUS
    value: Pods should be submitted and removed
  image: gcr.io/heptio-images/kube-conformance:latest
  imagePullPolicy: Always
  name: e2e
  volumeMounts:
  - mountPath: /tmp/results
    name: results
    readOnly: false
  - mountPath: /var/log/test
    name: test-volume
extra-volumes:
- name: test-volume
  hostPath:
    # directory location on host
    path: /data
EOF

Now, this plugin will run you invoke: sonobuoy run

For more information on Sonobuoy plugins, see the documentation

To clean up Kubernetes objects created by Sonobuoy: sonobuoy delete