### Example Plugin Generation

Source: https://sonobuoy.io/docs/v0.57.4/cli/sonobuoy_gen_plugin

Example command to generate a plugin manifest with a specified name and image.

```bash
sonobuoy gen plugin -n myPlugin -i myregistry/myimage:v0
```

--------------------------------

### Sonobuoy Plugin Install Help

Source: https://sonobuoy.io/docs/v0.57.4/cli/sonobuoy_plugin_install

Displays help information for the `sonobuoy plugin install` command.

```bash
  -h, --help   help for install
```

--------------------------------

### List installed plugins

Source: https://sonobuoy.io/docs/v0.57.4/cli/sonobuoy_plugin_list

Displays all plugins currently installed in the Sonobuoy environment.

```bash
sonobuoy plugin list [flags]
```

--------------------------------

### Install Sonobuoy Plugin

Source: https://sonobuoy.io/docs/v0.57.4/cli/sonobuoy_plugin_install

Use this command to install a plugin, making it runnable by its filename. Specify the desired filename, the source path or URL, and any relevant flags.

```bash
sonobuoy plugin install <save-as-filename> <source filename or URL> [flags]
```

--------------------------------

### Install Sonobuoy via Homebrew

Source: https://sonobuoy.io/docs/v0.57.4/index.html

Use Homebrew to install the Sonobuoy CLI on MacOS.

```bash
brew install sonobuoy
```

--------------------------------

### Sonobuoy Get Command Help

Source: https://sonobuoy.io/docs/v0.57.4/cli/sonobuoy_get

Displays help information for the 'sonobuoy get' command.

```bash
  -h, --help   help for get

```

--------------------------------

### GET /plugin/list

Source: https://sonobuoy.io/docs/v0.57.4/cli/sonobuoy_plugin_list

Lists all installed plugins in the Sonobuoy environment.

```APIDOC
## GET sonobuoy plugin list

### Description
List all installed plugins.

### Method
GET

### Endpoint
sonobuoy plugin list

### Parameters
#### Query Parameters
- **--help** (flag) - Optional - Help for list
- **--level** (string) - Optional - Log level. One of {panic, fatal, error, warn, info, debug, trace} (default info)

### Response
#### Success Response (200)
- **plugins** (array) - List of installed plugins
```

--------------------------------

### sonobuoy plugin install

Source: https://sonobuoy.io/docs/v0.57.4/cli/sonobuoy_plugin_install

Installs a plugin from a source file or URL to a specified local filename for easier execution.

```APIDOC
## sonobuoy plugin install

### Description
Install a plugin so that it can be run via just its filename rather than a full path or URL.

### Usage
`sonobuoy plugin install <save-as-filename> <source filename or URL> [flags]`

### Parameters
- **save-as-filename** (string) - Required - The local filename to save the plugin as.
- **source filename or URL** (string) - Required - The path or URL of the plugin source.

### Options
- **-h, --help** - Displays help for the install command.

### Inherited Options
- **--level** (string) - Optional - Log level. One of {panic, fatal, error, warn, info, debug, trace} (default info).
```

--------------------------------

### Run an Installed Sonobuoy Plugin

Source: https://sonobuoy.io/docs/v0.57.4/plugins

After installing a plugin, you can run it using this command. Sonobuoy will automatically find the plugin if it's in the installation directory or the current working directory.

```bash
$ sonobuoy run -p myPlugin
```

--------------------------------

### Install a Sonobuoy Plugin

Source: https://sonobuoy.io/docs/v0.57.4/plugins

Use this command to install a plugin for repeated use. The plugin definition will be saved locally. Ensure the SONOBUOY_PLUGIN_INSTALLATION feature gate is enabled.

```bash
$ sonobuoy plugin install myPlugin <file or URL>
```

--------------------------------

### Example Git remote output

Source: https://sonobuoy.io/docs/v0.57.4/release

Shows the expected output format for git remote -v.

```text
origin	git@github.com:<username>/sonobuoy.git (fetch)
origin	git@github.com:<username>/sonobuoy.git (push)
upstream	https://github.com/vmware-tanzu/sonobuoy (fetch)
upstream	https://github.com/vmware-tanzu/sonobuoy (push)
```

--------------------------------

### Example Plugin Definition with PodSpec

Source: https://sonobuoy.io/docs/v0.57.4/plugins

A sample YAML plugin definition showing the structure of the podSpec object and associated configuration.

```yaml
podSpec:
  containers: []
  restartPolicy: Never
  serviceAccountName: sonobuoy-serviceaccount
  tolerations:
  - effect: NoSchedule
    key: node-role.kubernetes.io/master
    operator: Exists
  - key: CriticalAddonsOnly
    operator: Exists
sonobuoy-config:
  driver: Job
  plugin-name: my-plugin
  result-type: my-plugin
spec:
  command:
  - ./run.sh
  image: my-plugin:latest
  name: plugin
  resources: {}
  volumeMounts:
  - mountPath: /tmp/results
    name: results
```

--------------------------------

### Define a manual results plugin

Source: https://sonobuoy.io/docs/v0.57.4/results

Example configuration for a plugin that provides results in the manual format.

```yaml
sonobuoy-config:
  driver: Job
  plugin-name: manual-results-plugin
  result-format: manual
  result-files:
    - manual-results-1.yaml
    - manual-results-2.yaml
spec:
  command:
  - ./run.sh
  image: custom-image:latest
  name: plugin
  resources: {}
  volumeMounts:
  - mountPath: /tmp/results
    name: results
```

--------------------------------

### Run Sonobuoy with a custom YAML file

Source: https://sonobuoy.io/docs/v0.57.4/gen

Applies a previously generated and modified YAML configuration file to start a Sonobuoy run.

```bash
sonobuoy run -f sonobuoy.yaml
```

--------------------------------

### Manual Results Item Structure Example

Source: https://sonobuoy.io/docs/v0.57.4/results

This example demonstrates the recursive structure of a manual result item, including name, status, meta, details, and nested items. It shows how to represent test results with stdout, stderr, and messages.

```yaml
name: manual-results-plugin
status: custom-status
meta:
  type: summary
items:
- name: Manual test suite
  status: complete
  items:
  - name: Manual test
    status: custom-status-1
    details:
      stdout: "stdout from the test"
      messages:
        - message from the test
        - another message
  - name: Another manual test
    status: custom-status-2
    details:
      stderr: "stderr from the test"

```

--------------------------------

### sonobuoy plugin show

Source: https://sonobuoy.io/docs/v0.57.4/cli/sonobuoy_plugin_show

Prints the full definition of the named plugin file. This command is useful for inspecting the configuration and details of installed Sonobuoy plugins.

```APIDOC
## sonobuoy plugin show

### Description
Print the full definition of the named plugin file.

### Method
CLI Command

### Endpoint
sonobuoy plugin show <plugin filename> [flags]

### Parameters
#### Path Parameters
- **plugin filename** (string) - Required - The name of the plugin file to show the definition for.

#### Query Parameters
None

#### Request Body
None

### Options
- **-h, --help** (bool) - help for show

### Options inherited from parent commands
- **--level** (string) - Log level. One of {panic, fatal, error, warn, info, debug, trace} (default info)

### SEE ALSO
* sonobuoy plugin - Manage your installed plugins
```

--------------------------------

### Sonobuoy Get Pod Options

Source: https://sonobuoy.io/docs/v0.57.4/cli/sonobuoy_get_pod

Flags available for the 'sonobuoy get pod' command, including help, namespace, and plugin filtering.

```bash
-h, --help               help for pod
-n, --namespace string   The namespace to run Sonobuoy in. Only one Sonobuoy run can exist per namespace simultaneously. (default "sonobuoy")
-p, --plugin string      Plugin to locate pods for
```

--------------------------------

### Sonobuoy Get Command Inherited Options

Source: https://sonobuoy.io/docs/v0.57.4/cli/sonobuoy_get

Shows inherited options for the 'sonobuoy get' command, including log level configuration.

```bash
      --level level   Log level. One of {panic, fatal, error, warn, info, debug, trace} (default info)

```

--------------------------------

### Generate Sonobuoy E2E Plugin Definition

Source: https://sonobuoy.io/docs/v0.57.4/cli/sonobuoy_gen_plugin_e2e

Use this command to generate the e2e plugin definition for Sonobuoy based on specified options. No setup or imports are required.

```bash
sonobuoy gen plugin e2e [flags]
```

--------------------------------

### View E2E Test Framework Options

Source: https://sonobuoy.io/docs/v0.57.4/faq

Run the conformance image with the --help flag to see available test framework options for your Kubernetes version.

```bash
KUBE_VERSION=<Kubernetes version you are using>
docker run -it k8s.gcr.io/conformance:$KUBE_VERSION ./e2e.test --help

```

--------------------------------

### GET sonobuoy get

Source: https://sonobuoy.io/docs/v0.57.4/cli/sonobuoy_get

Fetches Sonobuoy resources of a specified type from the cluster.

```APIDOC
## GET sonobuoy get

### Description
Fetches Sonobuoy resources of a specified type.

### Method
GET

### Endpoint
sonobuoy get [resource_type]

### Parameters
#### Options
- **-h, --help** - Optional - Show help for the get command.

#### Options inherited from parent commands
- **--level** (string) - Optional - Log level. One of {panic, fatal, error, warn, info, debug, trace} (default info).
```

--------------------------------

### Sonobuoy Plugin Help Options

Source: https://sonobuoy.io/docs/v0.57.4/cli/sonobuoy_plugin

Displays the help menu for the plugin command.

```bash
  -h, --help   help for plugin
```

--------------------------------

### Run Sonobuoy conformance tests

Source: https://sonobuoy.io/docs/v0.57.4/index.html

Launch the default conformance tests and block until completion.

```bash
sonobuoy run --wait
```

--------------------------------

### Uninstall command options

Source: https://sonobuoy.io/docs/v0.57.4/cli/sonobuoy_plugin_uninstall

Displays help information for the uninstall command.

```bash
  -h, --help   help for uninstall
```

--------------------------------

### Options for sonobuoy plugin show

Source: https://sonobuoy.io/docs/v0.57.4/cli/sonobuoy_plugin_show

Lists available flags for the show command.

```bash
  -h, --help   help for show
```

--------------------------------

### GET sonobuoy get pod

Source: https://sonobuoy.io/docs/v0.57.4/cli/sonobuoy_get_pod

Fetches Sonobuoy pods based on specified namespace or plugin filters.

```APIDOC
## GET sonobuoy get pod

### Description
Fetch sonobuoy pods.

### Method
GET

### Endpoint
sonobuoy get pod [flags]

### Parameters
#### Query Parameters
- **-n, --namespace** (string) - Optional - The namespace to run Sonobuoy in. Only one Sonobuoy run can exist per namespace simultaneously. (default "sonobuoy")
- **-p, --plugin** (string) - Optional - Plugin to locate pods for
- **--level** (level) - Optional - Log level. One of {panic, fatal, error, warn, info, debug, trace} (default info)
```

--------------------------------

### Execute Build and Test Commands

Source: https://sonobuoy.io/docs/v0.57.4/index.html

Common Makefile targets for building the binary and running unit tests.

```makefile
// Build the binary
$ make build

// Run local unit tests
$ make test
```

--------------------------------

### Sonobuoy Get Command

Source: https://sonobuoy.io/docs/v0.57.4/cli/sonobuoy_get_pod

The 'sonobuoy get' command is used to fetch Sonobuoy resources of a specified type. Refer to its subcommands for specific resource fetching.

```bash
sonobuoy get - Fetches Sonobuoy resources of a specified type
```

--------------------------------

### Generate versioned documentation

Source: https://sonobuoy.io/docs/v0.57.4/release

Updates the website configuration and links to reflect the new version.

```bash
./scripts/update_docs.sh -v v0.57.4 -b
```

--------------------------------

### Usage of sonobuoy plugin show

Source: https://sonobuoy.io/docs/v0.57.4/cli/sonobuoy_plugin_show

Displays the full definition of a named plugin file.

```bash
sonobuoy plugin show <plugin filename> [flags]
```

--------------------------------

### Run E2E Tests with Custom Options (v1.16.0+)

Source: https://sonobuoy.io/docs/v0.57.4/faq

For Kubernetes v1.16.0 and later, set E2E_USE_GO_RUNNER=true and use --plugin-env to pass custom arguments like provider-specific flags.

```bash
sonobuoy run --plugin-env=e2e.E2E_USE_GO_RUNNER=true \
  --plugin-env=e2e.E2E_PROVIDER=gce \
  --plugin-env=e2e.E2E_EXTRA_ARGS="--gce-zone=foo --gce-region=bar"

```

--------------------------------

### Check Kubernetes context and version

Source: https://sonobuoy.io/docs/v0.57.4/release

Commands to verify the current cluster context and Kubernetes server version.

```bash
kubectl config current-context
```

```bash
kubectl version --short
```

--------------------------------

### Run Conformance Tests with Registry Config

Source: https://sonobuoy.io/docs/v0.57.4/index.html

Execute Sonobuoy conformance tests using a custom registry configuration file.

```bash
sonobuoy run --sonobuoy-image sonobuoy/sonobuoy:<VERSION> --e2e-repo-config conformance-image-config.yaml
```

--------------------------------

### Uninstall a Sonobuoy plugin

Source: https://sonobuoy.io/docs/v0.57.4/cli/sonobuoy_plugin_uninstall

Use this command to remove an installed plugin. Plugins can still be executed by referencing their file or URL.

```bash
sonobuoy plugin uninstall <plugin filename> [flags]
```

--------------------------------

### Sonobuoy Images Inspect Command Options

Source: https://sonobuoy.io/docs/v0.57.4/cli/sonobuoy_images_inspect

These options configure the 'inspect' command. Specify the kubeconfig context, enable dry-run to preview operations, provide a path to the kubeconfig file, or override the Kubernetes version.

```bash
--context string
            Context in the kubeconfig to use.
```

```bash
--dry-run
                    If true, only print the image operations that would be performed.
```

```bash
-h, --help
                    help for inspect
```

```bash
--kubeconfig Kubeconfig
            Path to explicit kubeconfig file.
```

```bash
--kubernetes-version string
            Use default E2E image, but override the version. Default is 'auto', which will be set to your cluster's version if detected, erroring otherwise. 'ignore' will try version resolution but ignore errors. 'latest' will find the latest dev image/version upstream.
```

```bash
-p, --plugin strings
            Describe which plugin's images to interact with (Valid plugins are 'e2e', 'systemd-logs'). (default [e2e,systemd-logs])
```

--------------------------------

### Execute sonobuoy run command

Source: https://sonobuoy.io/docs/v0.57.4/cli/sonobuoy_run

Initiates a Sonobuoy run by deploying the aggregator and plugin pods.

```bash
sonobuoy run [flags]
```

--------------------------------

### Sonobuoy Images Options

Source: https://sonobuoy.io/docs/v0.57.4/cli/sonobuoy_images

Configure image operations by specifying the Kubernetes context, performing a dry run, setting the kubeconfig path, overriding the Kubernetes version, selecting specific plugins, or setting environment variables for plugins.

```bash
--context string
              Context in the kubeconfig to use.
--dry-run                     If true, only print the image operations that would be performed.
-h, --help                        help for images
--kubeconfig Kubeconfig       Path to explicit kubeconfig file.
--kubernetes-version string   Use default E2E image, but override the version. Default is 'auto', which will be set to your cluster's version if detected, erroring otherwise. 'ignore' will try version resolution but ignore errors. 'latest' will find the latest dev image/version upstream.
-p, --plugin strings              Describe which plugin's images to interact with (Valid plugins are 'e2e', 'systemd-logs'). (default [e2e,systemd-logs])
--plugin-env pluginenvvar     Set env vars on plugins. Values can be given multiple times and are in the form plugin.env=value (default map[])
```

--------------------------------

### Get Secret YAML for Manual Editing

Source: https://sonobuoy.io/docs/v0.57.4/pullsecrets

Retrieve the YAML definition of an existing Kubernetes secret. This YAML will be manually edited and inserted into Sonobuoy's generated configuration.

```bash
kubectl get secret <secret name> -o yaml > secret.yaml
```

--------------------------------

### Plugin list command options

Source: https://sonobuoy.io/docs/v0.57.4/cli/sonobuoy_plugin_list

Available flags for the plugin list command.

```bash
  -h, --help   help for list
```

--------------------------------

### Plugin Configuration Options

Source: https://sonobuoy.io/docs/v0.57.4/cli/sonobuoy_gen_plugin

Available flags for configuring the plugin manifest generation.

```text
  -a, --arg stringArray                Arg values to set on the plugin. Can be set multiple times (e.g. --arg 'arg 1' --arg arg2)
  -c, --cmd stringArray                Command to run when starting the plugin's container. Can be set multiple times (e.g. --cmd /bin/sh -c "-c") (default [./run.sh])
      --configmap stringArray          Specifies files to read and add as configMaps. Will be mounted to the plugin at /tmp/sonobuoy/configs/<filename>.
  -D, --description string             Description for the plugin
  -e, --env envvar                     Env var values to set on the plugin (e.g. --env FOO=bar) (default map[])
  -f, --format string                  Result format (junit or raw) (default "raw")
  -h, --help                           help for plugin
  -i, --image string                   Plugin image
  -n, --name string                    Plugin name
      --node-selector stringToString   Node selector for the plugin (key=value). Usually set to specify OS via kubernetes.io/os=windows. Can be set multiple times. (default [])
      --show-default-podspec           If true, include the default pod spec used for plugins in the output.
  -t, --type pluginDriver              Plugin Driver (job or daemonset) (default Job)
  -u, --url string                     URL for the plugin
```

--------------------------------

### Generate Plugin Manifest

Source: https://sonobuoy.io/docs/v0.57.4/cli/sonobuoy_gen_plugin

Basic syntax for generating a plugin manifest.

```bash
sonobuoy gen plugin [flags]
```

--------------------------------

### Verify Docker image version

Source: https://sonobuoy.io/docs/v0.57.4/release

Runs the Sonobuoy container to verify the version matches the release tag.

```bash
docker run -it sonobuoy/sonobuoy:v0.x.y /sonobuoy version
```

--------------------------------

### Version Command Options

Source: https://sonobuoy.io/docs/v0.57.4/cli/sonobuoy_version

Configuration flags specific to the version command, including kubeconfig paths and output formatting.

```bash
      --context string          Context in the kubeconfig to use.
  -h, --help                    help for version
      --kubeconfig Kubeconfig   Path to explicit kubeconfig file.
      --short                   If true, prints just the Sonobuoy version.
```

--------------------------------

### Basic sonobuoy e2e usage

Source: https://sonobuoy.io/docs/v0.57.4/cli/sonobuoy_e2e

The base command syntax for listing tests and tags.

```bash
sonobuoy e2e [flags]
```

--------------------------------

### Run Sonobuoy with Custom Conformance Image

Source: https://sonobuoy.io/docs/v0.57.4/airgap

Specify your private registry's conformance image using the `--kube-conformance-image` flag when running Sonobuoy.

```bash
sonobuoy run --kube-conformance-image $PRIVATE_REG/conformance:$CLUSTER_VERSION

```

--------------------------------

### Run E2E Plugin with Custom Registry

Source: https://sonobuoy.io/docs/v0.57.4/airgap

When running the e2e plugin, specify your custom registry configuration using the same flags as the `images push` command.

```bash
sonobuoy run --e2e-repo <your registry>

```

```bash
sonobuoy run --e2e-repo-config <path/to/custom-repo-config.yaml>

```

--------------------------------

### Run Sonobuoy plugins via CLI

Source: https://sonobuoy.io/docs/v0.57.4/plugins

Use the --plugin flag to specify built-in plugins or custom plugin definition files.

```bash
# Run just the e2e plugin
$ sonobuoy run --plugin e2e

# Run your custom plugin and the systemd-logs gatherer
$ sonobuoy run --plugin customPlugin.yaml --plugin systemd-logs
```

--------------------------------

### Display Sonobuoy Version

Source: https://sonobuoy.io/docs/v0.57.4/cli/sonobuoy_version

Use this command to print the current version of the Sonobuoy binary.

```bash
sonobuoy version [flags]
```

--------------------------------

### Sonobuoy CLI Synopsis

Source: https://sonobuoy.io/docs/v0.57.4/cli/sonobuoy

Basic command structure for executing the Sonobuoy CLI.

```bash
sonobuoy [flags]
```

--------------------------------

### Execute custom plugin

Source: https://sonobuoy.io/docs/v0.57.4/plugins

Run a locally defined plugin YAML file using the sonobuoy run command.

```bash
sonobuoy run --plugin myPlugin.yaml
```

--------------------------------

### sonobuoy e2e options

Source: https://sonobuoy.io/docs/v0.57.4/cli/sonobuoy_e2e

Configuration flags for filtering test output and specifying cluster connection details.

```bash
      --context string                    Context in the kubeconfig to use.
  -f, --focus string                      Return tests which match this regular expression
  -h, --help                              help for e2e
  -i, --input string                      Determines the source of the test lists. Can be [online, offline, -]. If '-' is set, tests will be read from stdin. (default "online")
      --kubeconfig Kubeconfig             Path to explicit kubeconfig file.
  -m, --mode string                       Print mode. Can be one of [tags, tagCounts, tests] (default "tests")
  -s, --skip string                       Do not return tests which match this regular expression
      --version ConformanceImageVersion   Use default E2E image, but override the version. Default is 'auto', which will be set to your cluster's version if detected, erroring otherwise. 'ignore' will try version resolution but ignore errors. 'latest' will find the latest dev image/version upstream.
```

--------------------------------

### Retrieve command syntax

Source: https://sonobuoy.io/docs/v0.57.4/cli/sonobuoy_retrieve

Basic command structure for retrieving Sonobuoy results.

```bash
sonobuoy retrieve [path] [flags]
```

--------------------------------

### Retrieve command options

Source: https://sonobuoy.io/docs/v0.57.4/cli/sonobuoy_retrieve

Configuration flags available for the retrieve command.

```bash
      --context string          Context in the kubeconfig to use.
  -x, --extract                 If true, extracts the results instead of just downloading the results tarball.
  -f, --filename string         Specify the name of the downloaded file. If empty, defaults to the name of the tarball in the pod.
  -h, --help                    help for retrieve
      --kubeconfig Kubeconfig   Path to explicit kubeconfig file.
  -n, --namespace string        The namespace to run Sonobuoy in. Only one Sonobuoy run can exist per namespace simultaneously. (default "sonobuoy")
      --retrieve-path string    Specify the path to retrieve from the aggregator pod. (default "/tmp/sonobuoy")
```

--------------------------------

### Pull, Tag, and Push Conformance Image

Source: https://sonobuoy.io/docs/v0.57.4/airgap

These commands are used to make the Kubernetes conformance test image available in your private registry. Adjust placeholders for your private registry and target Kubernetes version.

```bash
PRIVATE_REG=<private registry>
CLUSTER_VERSION=<version of k8s you are targeting; e.g. v1.16.0>

docker pull k8s.gcr.io/conformance:$CLUSTER_VERSION
docker tag k8s.gcr.io/conformance:$CLUSTER_VERSION $PRIVATE_REG/conformance:$CLUSTER_VERSION
docker push $PRIVATE_REG/conformance:$CLUSTER_VERSION

```

--------------------------------

### List E2E Tests by Tag

Source: https://sonobuoy.io/docs/v0.57.4/e2eplugin

This command lists all tests matching the focus and skip criteria, grouped by their associated tags (e.g., [sig-storage] or [Feature: Foo]).

```bash
sonobuoy e2e --focus foo --skip bar --mode=tags

```

--------------------------------

### Create an annotated Git tag

Source: https://sonobuoy.io/docs/v0.57.4/release

Creates a local tag for the release commit.

```bash
git tag -a v0.x.y -m "Release v0.x.y"
```

--------------------------------

### Sonobuoy CLI Options

Source: https://sonobuoy.io/docs/v0.57.4/cli/sonobuoy

Available flags for configuring the Sonobuoy CLI execution, including help and log level settings.

```bash
  -h, --help          help for sonobuoy
      --level level   Log level. One of {panic, fatal, error, warn, info, debug, trace} (default info)
```

--------------------------------

### Pull, Tag, and Push Sonobuoy Image

Source: https://sonobuoy.io/docs/v0.57.4/airgap

Use these commands to make the Sonobuoy image available in your private registry for air-gapped deployments. Ensure you replace placeholders with your specific registry and Sonobuoy version.

```bash
PRIVATE_REG=<your private registry>
SONOBUOY_VERSION=<version of Sonobuoy you are targeting; e.g. v0.16.0>

docker pull sonobuoy/sonobuoy:$SONOBUOY_VERSION
docker tag sonobuoy/sonobuoy:$SONOBUOY_VERSION $PRIVATE_REG/sonobuoy:$SONOBUOY_VERSION
docker push $PRIVATE_REG/sonobuoy:$SONOBUOY_VERSION

```

--------------------------------

### Sonobuoy Images Push Command Options

Source: https://sonobuoy.io/docs/v0.57.4/cli/sonobuoy_images_push

Lists available flags for the 'sonobuoy images push' command, including context, registry specification, dry-run, and plugin selection.

```bash
      --context string              Context in the kubeconfig to use.
```

```bash
      --custom-registry string      Specify a registry to override the Sonobuoy and Plugin image registries.
```

```bash
      --dry-run                     If true, only print the image operations that would be performed.
```

```bash
      --e2e-repo string             Specify a registry for KUBE_TEST_REPO, overriding registries for test images.
```

```bash
      --e2e-repo-config string      Specify a yaml file acting as KUBE_TEST_REPO_LIST, overriding registries for test images.
```

```bash
  -h, --help                        help for push
```

```bash
      --kubeconfig Kubeconfig       Path to explicit kubeconfig file.
```

```bash
      --kubernetes-version string   Use default E2E image, but override the version. Default is 'auto', which will be set to your cluster's version if detected, erroring otherwise. 'ignore' will try version resolution but ignore errors. 'latest' will find the latest dev image/version upstream. 'latest' will find the latest dev image/version upstream.
```

```bash
  -p, --plugin strings              Describe which plugin's images to interact with (Valid plugins are 'e2e', 'systemd-logs'). (default [e2e,systemd-logs])
```

--------------------------------

### Generate systemd-logs plugin definition

Source: https://sonobuoy.io/docs/v0.57.4/cli/sonobuoy_gen_plugin_systemd-logs

Use this command to generate the systemd-logs plugin definition. Specify any desired flags for customization.

```bash
sonobuoy gen plugin systemd-logs [flags]

```

--------------------------------

### Sonobuoy Gen Default Image Config Options

Source: https://sonobuoy.io/docs/v0.57.4/cli/sonobuoy_gen_default-image-config

Lists the available options for the 'sonobuoy gen default-image-config' command. These options control context and kubeconfig.

```bash
--context string          Context in the kubeconfig to use.
  -h, --help                    help for default-image-config
      --kubeconfig Kubeconfig   Path to explicit kubeconfig file.

```

--------------------------------

### Generate Sonobuoy manifest

Source: https://sonobuoy.io/docs/v0.57.4/cli/sonobuoy_gen

Use this command to output a manifest for cluster submission.

```bash
sonobuoy gen [flags]
```

--------------------------------

### Manage systemd-logs Plugin Image

Source: https://sonobuoy.io/docs/v0.57.4/airgap

This section covers pulling, tagging, and pushing the systemd-logs plugin image to a private registry. It also shows how to override the default image when running Sonobuoy.

```bash
PRIVATE_REG=<private registry>

docker pull gcr.io/heptio-images/sonobuoy-plugin-systemd-logs:latest
docker tag gcr.io/heptio-images/sonobuoy-plugin-systemd-logs:latest $PRIVATE_REG/sonobuoy-plugin-systemd-logs:latest
docker push $PRIVATE_REG/sonobuoy-plugin-systemd-logs:latest

```

```bash
sonobuoy run --systemd-logs-image $PRIVATE_REG/sonobuoy-plugin-systemd-logs:latest

```

--------------------------------

### Sonobuoy status command options

Source: https://sonobuoy.io/docs/v0.57.4/cli/sonobuoy_status

Available flags for configuring the status command output and Kubernetes context.

```bash
      --context string          Context in the kubeconfig to use.
  -h, --help                    help for status
      --json                    Print the status object as json
      --kubeconfig Kubeconfig   Path to explicit kubeconfig file.
  -n, --namespace string        The namespace to run Sonobuoy in. Only one Sonobuoy run can exist per namespace simultaneously. (default "sonobuoy")
      --show-all                Don't summarize plugin statuses, show results for each node
```

--------------------------------

### Dump plugin results to YAML

Source: https://sonobuoy.io/docs/v0.57.4/results

Displays the raw sonobuoy_results.yaml file from the tarball.

```bash
sonobuoy results $tarball --mode=dump
```

--------------------------------

### Sonobuoy Query Command Options

Source: https://sonobuoy.io/docs/v0.57.4/cli/sonobuoy_query

These flags customize the query command's behavior, such as specifying a configuration file or an output directory.

```bash
--config Sonobuoy config   Path to a sonobuoy configuration JSON file.
```

```bash
-h, --help                     help for query
```

```bash
-o, --output string            Directory to output results into. If empty, will default to a UUID folder in the pwd.
```

--------------------------------

### Sonobuoy Configuration Options

Source: https://sonobuoy.io/docs/v0.57.4/cli/sonobuoy_wait

This section details the available configuration options for the Sonobuoy CLI.

```APIDOC
## Sonobuoy Configuration Options

### Description
Configuration options for the Sonobuoy CLI.

### Options

#### Skip Preflight Checks
- **--skip-preflight** (strings[=true]) - Skips the specified preflight checks. Valid values are [dnscheck, versioncheck, existingnamespace] or true to skip all of the checks.

#### Sonobuoy Image Override
- **--sonobuoy-image** (string) - Container image override for the sonobuoy worker and aggregator. (default "sonobuoy/sonobuoy:v0.57.4")

#### SSH Key
- **--ssh-key** (yamlFile) - Path to the private key enabling SSH to cluster nodes. May be required by some tests from the e2e plugin.

#### SSH User
- **--ssh-user** (envModifier) - SSH user for ssh-key. Required if running e2e plugin with certain tests that require SSH access to nodes.

#### Systemd Logs Image Override
- **--systemd-logs-image** (image) - Container image override for the systemd-logs plugin. Shorthand for --plugin-image=systemd-logs:<string> (default map[])

#### Timeout
- **--timeout** (int) - How long (in seconds) Sonobuoy aggregator will wait for plugins to complete before exiting. 0 indicates no timeout. (default 21600)

#### Wait
- **--wait** (int[=1440]) - How long (in minutes) for the CLI to wait for sonobuoy run to be completed or fail, where 0 indicates do not wait. If specified, the default wait time is 1 day.

#### Wait Output
- **--wait-output** (string) - Specify the type of output Sonobuoy should produce when --wait is used. Valid modes are silent, spinner, or progress (default "Progress")

### Inherited Options

#### Log Level
- **--level** (level) - Log level. One of {panic, fatal, error, warn, info, debug, trace} (default info)

### See Also
- sonobuoy - Generate reports on your Kubernetes cluster by running plugins
```

--------------------------------

### Inspect Sonobuoy logs

Source: https://sonobuoy.io/docs/v0.57.4/index.html

View logs from all Sonobuoy containers.

```bash
sonobuoy logs
```

--------------------------------

### Sonobuoy Images Command Options

Source: https://sonobuoy.io/docs/v0.57.4/cli/sonobuoy_images_list

These options configure the 'sonobuoy images list' command, allowing you to specify the Kubernetes context, kubeconfig path, target Kubernetes version, and plugins.

```bash
--context string              Context in the kubeconfig to use.
```

```bash
--dry-run                     If true, only print the image operations that would be performed.
```

```bash
-h, --help                        help for list
```

```bash
--kubeconfig Kubeconfig       Path to explicit kubeconfig file.
```

```bash
--kubernetes-version string   Use default E2E image, but override the version. Default is 'auto', which will be set to your cluster's version if detected, erroring otherwise. 'ignore' will try version resolution but ignore errors. 'latest' will find the latest dev image/version upstream.
```

```bash
-p, --plugin strings              Describe which plugin's images to interact with (Valid plugins are 'e2e', 'systemd-logs'). (default [e2e,systemd-logs])
```

--------------------------------

### List Sonobuoy Images

Source: https://sonobuoy.io/docs/v0.57.4/cli/sonobuoy_images_list

Use this command to list images used by Sonobuoy plugins. Specify flags to filter by context, kubeconfig, Kubernetes version, or specific plugins.

```bash
sonobuoy images list [flags]
```

--------------------------------

### Push Test Images to Custom Registry

Source: https://sonobuoy.io/docs/v0.57.4/airgap

Push the pulled test images to your own registry. Use `--e2e-repo` for a single registry or `--e2e-repo-config` for fine-grained control over image-to-registry mapping.

```bash
sonobuoy images push --e2e-repo <your registry>

```

```bash
sonobuoy images push --e2e-repo-config <path/to/custom-repo-config.yaml>

```

--------------------------------

### Configure Conformance Image Registry

Source: https://sonobuoy.io/docs/v0.57.4/index.html

Create a registry manifest file to override default Docker Hub image pulls during conformance testing.

```yaml
dockerLibraryRegistry: mirror.gcr.io/library
```

--------------------------------

### Run Sonobuoy Modes

Source: https://sonobuoy.io/docs/v0.57.4/cli/sonobuoy_modes

Use this command to display the various modes in which the e2e plugin can be run. The --verbose flag prevents output truncation for each mode.

```bash
sonobuoy modes [flags]
```

--------------------------------

### Generate Sonobuoy Configuration

Source: https://sonobuoy.io/docs/v0.57.4/sonobuoy-config

Command to output the default Sonobuoy configuration to the console.

```bash
sonobuoy gen config
```

--------------------------------

### Sonobuoy SEE ALSO

Source: https://sonobuoy.io/docs/v0.57.4/cli/sonobuoy_images

Related Sonobuoy commands for managing reports and images.

```bash
sonobuoy - Generate reports on your Kubernetes cluster by running plugins
sonobuoy images delete - Deletes all images downloaded to local docker client
sonobuoy images download - Saves downloaded images from local docker client to a tar file
sonobuoy images inspect - Inspect images
sonobuoy images list - List images
sonobuoy images pull - Pulls images to local docker client for a specific plugin
sonobuoy images push - Pushes images to docker registry for a specific plugin
```

--------------------------------

### List E2E Tests by Name

Source: https://sonobuoy.io/docs/v0.57.4/e2eplugin

This command lists all tests that match the specified focus and skip criteria by their full names. It provides precise detail but may result in a large output.

```bash
sonobuoy e2e --focus foo --skip bar

```

--------------------------------

### Fetch Sonobuoy Pods

Source: https://sonobuoy.io/docs/v0.57.4/cli/sonobuoy_get_pod

Use this command to retrieve information about Sonobuoy pods. Specify the namespace and optionally filter by plugin.

```bash
sonobuoy get pod [flags]
```

--------------------------------

### Generate Sonobuoy Configuration

Source: https://sonobuoy.io/docs/v0.57.4/cli/sonobuoy_gen_config

Use this command to generate a Sonobuoy configuration file. This config can then be used as input for other Sonobuoy commands like 'gen' or 'run'.

```bash
sonobuoy gen config [flags]

```

--------------------------------

### Allow Not Ready Nodes

Source: https://sonobuoy.io/docs/v0.57.4/faq

For versions prior to v1.17.0, use the --allowed-not-ready-nodes flag to specify the number of tainted nodes that can be in a 'not-ready' state.

```bash
# Example: Allow 2 tainted nodes to be in a 'not-ready' state
# sonobuoy run --allowed-not-ready-nodes=2

```

--------------------------------

### Sonobuoy CLI Options

Source: https://sonobuoy.io/docs/v0.57.4/cli/sonobuoy_gen

This section details the available command-line options for the Sonobuoy CLI, including their purpose, default values, and accepted formats.

```APIDOC
## Sonobuoy CLI Options

### Description
Configuration options for the Sonobuoy CLI.

### Options

#### `--skip-preflight`
*   **Type**: `strings`
*   **Default**: `true`
*   **Description**: Skips the specified preflight checks. Valid values are `[dnscheck, versioncheck, existingnamespace]` or `true` to skip all of the checks.

#### `--sonobuoy-image`
*   **Type**: `string`
*   **Default**: `"sonobuoy/sonobuoy:v0.57.4"`
*   **Description**: Container image override for the sonobuoy worker and aggregator.

#### `--ssh-key`
*   **Type**: `yamlFile`
*   **Description**: Path to the private key enabling SSH to cluster nodes. May be required by some tests from the e2e plugin.

#### `--ssh-user`
*   **Type**: `envModifier`
*   **Description**: SSH user for `ssh-key`. Required if running e2e plugin with certain tests that require SSH access to nodes.

#### `--systemd-logs-image`
*   **Type**: `image`
*   **Description**: Container image override for the systemd-logs plugin. Shorthand for `--plugin-image=systemd-logs:<string>`.
*   **Default**: `map[]`

#### `--timeout`
*   **Type**: `int`
*   **Description**: How long (in seconds) Sonobuoy aggregator will wait for plugins to complete before exiting. 0 indicates no timeout.
*   **Default**: `21600`

#### `--wait`
*   **Type**: `int`
*   **Description**: How long (in minutes) for the CLI to wait for sonobuoy run to be completed or fail, where 0 indicates do not wait. If specified, the default wait time is 1 day.
*   **Default**: `1440`

#### `--wait-output`
*   **Type**: `string`
*   **Description**: Specify the type of output Sonobuoy should produce when `--wait` is used. Valid modes are `silent`, `spinner`, or `progress`.
*   **Default**: `"Progress"`

### Inherited Options

#### `--level`
*   **Type**: `level`
*   **Description**: Log level. One of `{panic, fatal, error, warn, info, debug, trace}`.
*   **Default**: `info`
```

--------------------------------

### Work-around for Certified-Conformance Mode

Source: https://sonobuoy.io/docs/v0.57.4/issue1388

Manually clear the E2E_SKIP environment variable by passing an empty value via the plugin-env flag.

```bash
sonobuoy run --mode=certified-conformance --plugin-env e2e.E2E_SKIP
```

--------------------------------

### Generate Plugin Definition with Default PodSpec

Source: https://sonobuoy.io/docs/v0.57.4/plugins

Use this command to generate a new plugin definition that includes the default PodSpec configuration.

```bash
sonobuoy gen plugin --show-default-podspec -n my-plugin -i my-plugin:latest
```

--------------------------------

### Inspect detailed non-junit plugin output

Source: https://sonobuoy.io/docs/v0.57.4/results

Displays file output with location prefixes for non-junit plugins.

```bash
$ sonobuoy results $tarball --mode=detailed --plugin systemd-logs|head -n1
systemd-logs|kind-control-plane|systemd_logs {"_HOSTNAME":"kind-control-plane",...}
```

--------------------------------

### Set Plugin Environment Variables via --plugin-env

Source: https://sonobuoy.io/docs/v0.57.4/e2eplugin

An alternative to direct flags, this shows how to set environment variables for plugins, such as E2E_SKIP, using the general --plugin-env flag.

```bash
sonobuoy run \
  --plugin-env e2e.E2E_SKIP=<value>

```

--------------------------------

### Check configured Git remotes

Source: https://sonobuoy.io/docs/v0.57.4/release

Lists all configured remotes to identify the upstream repository.

```bash
git remote -v
```

--------------------------------

### Sonobuoy Query Command Usage

Source: https://sonobuoy.io/docs/v0.57.4/cli/sonobuoy_query

This is the main command for running queries. Use it to initiate debugging queries on your cluster.

```bash
sonobuoy query [flags]
```

--------------------------------

### Sonobuoy Images Command

Source: https://sonobuoy.io/docs/v0.57.4/cli/sonobuoy_images_push

Manages images used in plugins for airgapped environments. Supports 'e2e' and 'systemd-logs' plugins.

```bash
  * sonobuoy images - Manage images used in a plugin to facilitate running them in airgapped (or similar) environments. Supported plugins are: ‘e2e’
```

--------------------------------

### List E2E Tests by Tag Counts

Source: https://sonobuoy.io/docs/v0.57.4/e2eplugin

This command lists all tests matching the focus and skip criteria, along with the count of tests for each tag (e.g., [sig-storage]: 13).

```bash
sonobuoy e2e --focus foo --skip bar --mode=tagCounts

```

--------------------------------

### Run E2E Tests with Focus and Skip Filters

Source: https://sonobuoy.io/docs/v0.57.4/e2eplugin

Use these flags to specify regular expressions for including or excluding tests. E2E_FOCUS is applied first, then E2E_SKIP further refines the list.

```bash
sonobuoy run \
  --e2e-focus=<run tests matching this regexp> \
  --e2e-skip=<skip tests matching this regexp>

```

--------------------------------

### Run Sonobuoy with Custom Image

Source: https://sonobuoy.io/docs/v0.57.4/airgap

Override the default Sonobuoy image with your private registry image using the `--sonobuoy-image` flag during the `run` command.

```bash
sonobuoy run --sonobuoy-image $PRIVATE_REG/sonobuoy:$SONOBUOY_VERSION

```

--------------------------------

### Generate Default Image Configuration

Source: https://sonobuoy.io/docs/v0.57.4/airgap

Use this command to generate a default image configuration file for a specific Kubernetes version. This file maps registry categories to default registry URLs.

```bash
$ sonobuoy gen default-image-config

```

--------------------------------

### Sonobuoy Images Download Command

Source: https://sonobuoy.io/docs/v0.57.4/cli/sonobuoy_images_download

Use this command to save downloaded images from your local Docker client to a tar file. This is useful for airgapped environments.

```bash
sonobuoy images download [flags]
```

--------------------------------

### Push Sonobuoy Plugin Images to Registry

Source: https://sonobuoy.io/docs/v0.57.4/cli/sonobuoy_images_push

Use this command to push images for a specific Sonobuoy plugin to a Docker registry. Supports custom registries and dry-run mode.

```bash
sonobuoy images push [flags]
```

--------------------------------

### Inspect Sonobuoy Image Availability

Source: https://sonobuoy.io/docs/v0.57.4/cli/sonobuoy_images_inspect

Use this command to check if a specified image is available in the registry. It supports various flags for context, dry-run, kubeconfig, Kubernetes version, and plugin selection.

```bash
sonobuoy images inspect [flags]
```