Skip to content

Commit

Permalink
add docs for v0.57.1
Browse files Browse the repository at this point in the history
Signed-off-by: Peter Grant <[email protected]>
  • Loading branch information
Peter Grant committed Nov 17, 2023
1 parent 87baeca commit 78cd76b
Show file tree
Hide file tree
Showing 97 changed files with 2,920 additions and 38 deletions.
3 changes: 2 additions & 1 deletion site/config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -32,9 +32,10 @@ params:
docs_search_index_name: index_name
docs_search_api_key: api_key
docs_versioning: true
docs_latest: v0.57.0
docs_latest: v0.57.1
docs_versions:
- main
- v0.57.1
- v0.57.0
- v0.56.17
- v0.56.15
Expand Down
2 changes: 1 addition & 1 deletion site/content/docs/main/cli/sonobuoy.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,4 +35,4 @@ sonobuoy [flags]
* [sonobuoy version](sonobuoy_version.md) - Print sonobuoy version
* [sonobuoy wait](sonobuoy_wait.md) - Waits on the Sonobuoy run in the targeted namespace.

###### Auto generated by spf13/cobra on 19-Oct-2023
###### Auto generated by spf13/cobra on 17-Nov-2023
2 changes: 1 addition & 1 deletion site/content/docs/main/cli/sonobuoy_delete.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,4 +30,4 @@ sonobuoy delete [flags]

* [sonobuoy](sonobuoy.md) - Generate reports on your Kubernetes cluster by running plugins

###### Auto generated by spf13/cobra on 19-Oct-2023
###### Auto generated by spf13/cobra on 17-Nov-2023
2 changes: 1 addition & 1 deletion site/content/docs/main/cli/sonobuoy_e2e.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,4 +29,4 @@ sonobuoy e2e [flags]

* [sonobuoy](sonobuoy.md) - Generate reports on your Kubernetes cluster by running plugins

###### Auto generated by spf13/cobra on 19-Oct-2023
###### Auto generated by spf13/cobra on 17-Nov-2023
4 changes: 2 additions & 2 deletions site/content/docs/main/cli/sonobuoy_gen.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ sonobuoy gen [flags]
--service-account-name string Name of the service account to be used by sonobuoy. (default "sonobuoy-serviceaccount")
--show-default-podspec If true, include the default pod spec used for plugins in the output.
--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 string Container image override for the sonobuoy worker and aggregator. (default "sonobuoy/sonobuoy:v0.56.16-56-ge5bb5618-dirty")
--sonobuoy-image string Container image override for the sonobuoy worker and aggregator. (default "sonobuoy/sonobuoy:v0.57.0-4-g87baecab")
--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 envModifier SSH user for ssh-key. Required if running e2e plugin with certain tests that require SSH access to nodes.
--systemd-logs-image image Container image override for the systemd-logs plugin. Shorthand for --plugin-image=systemd-logs:<string> (default map[])
Expand All @@ -62,4 +62,4 @@ sonobuoy gen [flags]
* [sonobuoy gen default-image-config](sonobuoy_gen_default-image-config.md) - Generates the default image registry config for the e2e plugin
* [sonobuoy gen plugin](sonobuoy_gen_plugin.md) - Generates the manifest Sonobuoy uses to define a plugin

###### Auto generated by spf13/cobra on 19-Oct-2023
###### Auto generated by spf13/cobra on 17-Nov-2023
4 changes: 2 additions & 2 deletions site/content/docs/main/cli/sonobuoy_gen_config.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ sonobuoy gen config [flags]
--service-account-name string Name of the service account to be used by sonobuoy. (default "sonobuoy-serviceaccount")
--show-default-podspec If true, include the default pod spec used for plugins in the output.
--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 string Container image override for the sonobuoy worker and aggregator. (default "sonobuoy/sonobuoy:v0.56.16-56-ge5bb5618-dirty")
--sonobuoy-image string Container image override for the sonobuoy worker and aggregator. (default "sonobuoy/sonobuoy:v0.57.0-4-g87baecab")
--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 envModifier SSH user for ssh-key. Required if running e2e plugin with certain tests that require SSH access to nodes.
--systemd-logs-image image Container image override for the systemd-logs plugin. Shorthand for --plugin-image=systemd-logs:<string> (default map[])
Expand All @@ -59,4 +59,4 @@ sonobuoy gen config [flags]

* [sonobuoy gen](sonobuoy_gen.md) - Generates a sonobuoy manifest for submission via kubectl

###### Auto generated by spf13/cobra on 19-Oct-2023
###### Auto generated by spf13/cobra on 17-Nov-2023
Original file line number Diff line number Diff line change
Expand Up @@ -24,4 +24,4 @@ sonobuoy gen default-image-config [flags]

* [sonobuoy gen](sonobuoy_gen.md) - Generates a sonobuoy manifest for submission via kubectl

###### Auto generated by spf13/cobra on 19-Oct-2023
###### Auto generated by spf13/cobra on 17-Nov-2023
2 changes: 1 addition & 1 deletion site/content/docs/main/cli/sonobuoy_gen_plugin.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,4 +42,4 @@ sonobuoy gen plugin -n myPlugin -i myregistry/myimage:v0
* [sonobuoy gen plugin e2e](sonobuoy_gen_plugin_e2e.md) - Generates the e2e plugin definition based on the given options
* [sonobuoy gen plugin systemd-logs](sonobuoy_gen_plugin_systemd-logs.md) - Generates the systemd-logs plugin definition based on the given options

###### Auto generated by spf13/cobra on 19-Oct-2023
###### Auto generated by spf13/cobra on 17-Nov-2023
4 changes: 2 additions & 2 deletions site/content/docs/main/cli/sonobuoy_gen_plugin_e2e.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ sonobuoy gen plugin e2e [flags]
--service-account-name string Name of the service account to be used by sonobuoy. (default "sonobuoy-serviceaccount")
--show-default-podspec If true, include the default pod spec used for plugins in the output.
--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 string Container image override for the sonobuoy worker and aggregator. (default "sonobuoy/sonobuoy:v0.56.16-56-ge5bb5618-dirty")
--sonobuoy-image string Container image override for the sonobuoy worker and aggregator. (default "sonobuoy/sonobuoy:v0.57.0-4-g87baecab")
--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 envModifier SSH user for ssh-key. Required if running e2e plugin with certain tests that require SSH access to nodes.
--systemd-logs-image image Container image override for the systemd-logs plugin. Shorthand for --plugin-image=systemd-logs:<string> (default map[])
Expand All @@ -60,4 +60,4 @@ sonobuoy gen plugin e2e [flags]

* [sonobuoy gen plugin](sonobuoy_gen_plugin.md) - Generates the manifest Sonobuoy uses to define a plugin

###### Auto generated by spf13/cobra on 19-Oct-2023
###### Auto generated by spf13/cobra on 17-Nov-2023
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ sonobuoy gen plugin systemd-logs [flags]
--service-account-name string Name of the service account to be used by sonobuoy. (default "sonobuoy-serviceaccount")
--show-default-podspec If true, include the default pod spec used for plugins in the output.
--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 string Container image override for the sonobuoy worker and aggregator. (default "sonobuoy/sonobuoy:v0.56.16-56-ge5bb5618-dirty")
--sonobuoy-image string Container image override for the sonobuoy worker and aggregator. (default "sonobuoy/sonobuoy:v0.57.0-4-g87baecab")
--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 envModifier SSH user for ssh-key. Required if running e2e plugin with certain tests that require SSH access to nodes.
--systemd-logs-image image Container image override for the systemd-logs plugin. Shorthand for --plugin-image=systemd-logs:<string> (default map[])
Expand All @@ -59,4 +59,4 @@ sonobuoy gen plugin systemd-logs [flags]

* [sonobuoy gen plugin](sonobuoy_gen_plugin.md) - Generates the manifest Sonobuoy uses to define a plugin

###### Auto generated by spf13/cobra on 19-Oct-2023
###### Auto generated by spf13/cobra on 17-Nov-2023
2 changes: 1 addition & 1 deletion site/content/docs/main/cli/sonobuoy_get.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,4 +19,4 @@ Fetches Sonobuoy resources of a specified type
* [sonobuoy](sonobuoy.md) - Generate reports on your Kubernetes cluster by running plugins
* [sonobuoy get pod](sonobuoy_get_pod.md) - Fetch sonobuoy pods

###### Auto generated by spf13/cobra on 19-Oct-2023
###### Auto generated by spf13/cobra on 17-Nov-2023
2 changes: 1 addition & 1 deletion site/content/docs/main/cli/sonobuoy_get_pod.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,4 +24,4 @@ sonobuoy get pod [flags]

* [sonobuoy get](sonobuoy_get.md) - Fetches Sonobuoy resources of a specified type

###### Auto generated by spf13/cobra on 19-Oct-2023
###### Auto generated by spf13/cobra on 17-Nov-2023
2 changes: 1 addition & 1 deletion site/content/docs/main/cli/sonobuoy_images.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,4 +34,4 @@ sonobuoy images [flags]
* [sonobuoy images pull](sonobuoy_images_pull.md) - Pulls images to local docker client for a specific plugin
* [sonobuoy images push](sonobuoy_images_push.md) - Pushes images to docker registry for a specific plugin

###### Auto generated by spf13/cobra on 19-Oct-2023
###### Auto generated by spf13/cobra on 17-Nov-2023
2 changes: 1 addition & 1 deletion site/content/docs/main/cli/sonobuoy_images_delete.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,4 +29,4 @@ sonobuoy images delete [flags]

* [sonobuoy images](sonobuoy_images.md) - Manage images used in a plugin to facilitate running them in airgapped (or similar) environments. Supported plugins are: 'e2e'

###### Auto generated by spf13/cobra on 19-Oct-2023
###### Auto generated by spf13/cobra on 17-Nov-2023
2 changes: 1 addition & 1 deletion site/content/docs/main/cli/sonobuoy_images_download.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,4 +29,4 @@ sonobuoy images download [flags]

* [sonobuoy images](sonobuoy_images.md) - Manage images used in a plugin to facilitate running them in airgapped (or similar) environments. Supported plugins are: 'e2e'

###### Auto generated by spf13/cobra on 19-Oct-2023
###### Auto generated by spf13/cobra on 17-Nov-2023
34 changes: 34 additions & 0 deletions site/content/docs/main/cli/sonobuoy_images_inspect.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
## sonobuoy images inspect

Inspect images

### Synopsis

Inspect if image is available in the registry

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

### Options

```
--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 inspect
--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])
```

### Options inherited from parent commands

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

### SEE ALSO

* [sonobuoy images](sonobuoy_images.md) - Manage images used in a plugin to facilitate running them in airgapped (or similar) environments. Supported plugins are: 'e2e'

###### Auto generated by spf13/cobra on 17-Nov-2023
2 changes: 1 addition & 1 deletion site/content/docs/main/cli/sonobuoy_images_list.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,4 +27,4 @@ sonobuoy images list [flags]

* [sonobuoy images](sonobuoy_images.md) - Manage images used in a plugin to facilitate running them in airgapped (or similar) environments. Supported plugins are: 'e2e'

###### Auto generated by spf13/cobra on 19-Oct-2023
###### Auto generated by spf13/cobra on 17-Nov-2023
2 changes: 1 addition & 1 deletion site/content/docs/main/cli/sonobuoy_images_pull.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,4 +29,4 @@ sonobuoy images pull [flags]

* [sonobuoy images](sonobuoy_images.md) - Manage images used in a plugin to facilitate running them in airgapped (or similar) environments. Supported plugins are: 'e2e'

###### Auto generated by spf13/cobra on 19-Oct-2023
###### Auto generated by spf13/cobra on 17-Nov-2023
2 changes: 1 addition & 1 deletion site/content/docs/main/cli/sonobuoy_images_push.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,4 +30,4 @@ sonobuoy images push [flags]

* [sonobuoy images](sonobuoy_images.md) - Manage images used in a plugin to facilitate running them in airgapped (or similar) environments. Supported plugins are: 'e2e'

###### Auto generated by spf13/cobra on 19-Oct-2023
###### Auto generated by spf13/cobra on 17-Nov-2023
2 changes: 1 addition & 1 deletion site/content/docs/main/cli/sonobuoy_logs.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,4 +27,4 @@ sonobuoy logs [flags]

* [sonobuoy](sonobuoy.md) - Generate reports on your Kubernetes cluster by running plugins

###### Auto generated by spf13/cobra on 19-Oct-2023
###### Auto generated by spf13/cobra on 17-Nov-2023
2 changes: 1 addition & 1 deletion site/content/docs/main/cli/sonobuoy_modes.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,4 +23,4 @@ sonobuoy modes [flags]

* [sonobuoy](sonobuoy.md) - Generate reports on your Kubernetes cluster by running plugins

###### Auto generated by spf13/cobra on 19-Oct-2023
###### Auto generated by spf13/cobra on 17-Nov-2023
2 changes: 1 addition & 1 deletion site/content/docs/main/cli/sonobuoy_plugin.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,4 +22,4 @@ Manage your installed plugins
* [sonobuoy plugin show](sonobuoy_plugin_show.md) - Print the full definition of the named plugin file
* [sonobuoy plugin uninstall](sonobuoy_plugin_uninstall.md) - Uninstall a plugin. You can continue to run any plugin via specifying a file or URL.

###### Auto generated by spf13/cobra on 19-Oct-2023
###### Auto generated by spf13/cobra on 17-Nov-2023
2 changes: 1 addition & 1 deletion site/content/docs/main/cli/sonobuoy_plugin_install.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,4 +22,4 @@ sonobuoy plugin install <save-as-filename> <source filename or URL> [flags]

* [sonobuoy plugin](sonobuoy_plugin.md) - Manage your installed plugins

###### Auto generated by spf13/cobra on 19-Oct-2023
###### Auto generated by spf13/cobra on 17-Nov-2023
2 changes: 1 addition & 1 deletion site/content/docs/main/cli/sonobuoy_plugin_list.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,4 +22,4 @@ sonobuoy plugin list [flags]

* [sonobuoy plugin](sonobuoy_plugin.md) - Manage your installed plugins

###### Auto generated by spf13/cobra on 19-Oct-2023
###### Auto generated by spf13/cobra on 17-Nov-2023
2 changes: 1 addition & 1 deletion site/content/docs/main/cli/sonobuoy_plugin_show.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,4 +22,4 @@ sonobuoy plugin show <plugin filename> [flags]

* [sonobuoy plugin](sonobuoy_plugin.md) - Manage your installed plugins

###### Auto generated by spf13/cobra on 19-Oct-2023
###### Auto generated by spf13/cobra on 17-Nov-2023
2 changes: 1 addition & 1 deletion site/content/docs/main/cli/sonobuoy_plugin_uninstall.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,4 +22,4 @@ sonobuoy plugin uninstall <plugin filename> [flags]

* [sonobuoy plugin](sonobuoy_plugin.md) - Manage your installed plugins

###### Auto generated by spf13/cobra on 19-Oct-2023
###### Auto generated by spf13/cobra on 17-Nov-2023
2 changes: 1 addition & 1 deletion site/content/docs/main/cli/sonobuoy_query.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,4 +24,4 @@ sonobuoy query [flags]

* [sonobuoy](sonobuoy.md) - Generate reports on your Kubernetes cluster by running plugins

###### Auto generated by spf13/cobra on 19-Oct-2023
###### Auto generated by spf13/cobra on 17-Nov-2023
2 changes: 1 addition & 1 deletion site/content/docs/main/cli/sonobuoy_results.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,4 +26,4 @@ sonobuoy results archive.tar.gz [flags]

* [sonobuoy](sonobuoy.md) - Generate reports on your Kubernetes cluster by running plugins

###### Auto generated by spf13/cobra on 19-Oct-2023
###### Auto generated by spf13/cobra on 17-Nov-2023
2 changes: 1 addition & 1 deletion site/content/docs/main/cli/sonobuoy_retrieve.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,4 +28,4 @@ sonobuoy retrieve [path] [flags]

* [sonobuoy](sonobuoy.md) - Generate reports on your Kubernetes cluster by running plugins

###### Auto generated by spf13/cobra on 19-Oct-2023
###### Auto generated by spf13/cobra on 17-Nov-2023
4 changes: 2 additions & 2 deletions site/content/docs/main/cli/sonobuoy_run.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ sonobuoy run [flags]
--service-account-name string Name of the service account to be used by sonobuoy. (default "sonobuoy-serviceaccount")
--show-default-podspec If true, include the default pod spec used for plugins in the output.
--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 string Container image override for the sonobuoy worker and aggregator. (default "sonobuoy/sonobuoy:v0.56.16-56-ge5bb5618-dirty")
--sonobuoy-image string Container image override for the sonobuoy worker and aggregator. (default "sonobuoy/sonobuoy:v0.57.0-4-g87baecab")
--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 envModifier SSH user for ssh-key. Required if running e2e plugin with certain tests that require SSH access to nodes.
--systemd-logs-image image Container image override for the systemd-logs plugin. Shorthand for --plugin-image=systemd-logs:<string> (default map[])
Expand All @@ -59,4 +59,4 @@ sonobuoy run [flags]

* [sonobuoy](sonobuoy.md) - Generate reports on your Kubernetes cluster by running plugins

###### Auto generated by spf13/cobra on 19-Oct-2023
###### Auto generated by spf13/cobra on 17-Nov-2023
2 changes: 1 addition & 1 deletion site/content/docs/main/cli/sonobuoy_status.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,4 +27,4 @@ sonobuoy status [flags]

* [sonobuoy](sonobuoy.md) - Generate reports on your Kubernetes cluster by running plugins

###### Auto generated by spf13/cobra on 19-Oct-2023
###### Auto generated by spf13/cobra on 17-Nov-2023
2 changes: 1 addition & 1 deletion site/content/docs/main/cli/sonobuoy_version.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,4 +25,4 @@ sonobuoy version [flags]

* [sonobuoy](sonobuoy.md) - Generate reports on your Kubernetes cluster by running plugins

###### Auto generated by spf13/cobra on 19-Oct-2023
###### Auto generated by spf13/cobra on 17-Nov-2023
4 changes: 2 additions & 2 deletions site/content/docs/main/cli/sonobuoy_wait.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ sonobuoy wait [flags]
--service-account-name string Name of the service account to be used by sonobuoy. (default "sonobuoy-serviceaccount")
--show-default-podspec If true, include the default pod spec used for plugins in the output.
--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 string Container image override for the sonobuoy worker and aggregator. (default "sonobuoy/sonobuoy:v0.56.16-56-ge5bb5618-dirty")
--sonobuoy-image string Container image override for the sonobuoy worker and aggregator. (default "sonobuoy/sonobuoy:v0.57.0-4-g87baecab")
--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 envModifier SSH user for ssh-key. Required if running e2e plugin with certain tests that require SSH access to nodes.
--systemd-logs-image image Container image override for the systemd-logs plugin. Shorthand for --plugin-image=systemd-logs:<string> (default map[])
Expand All @@ -59,4 +59,4 @@ sonobuoy wait [flags]

* [sonobuoy](sonobuoy.md) - Generate reports on your Kubernetes cluster by running plugins

###### Auto generated by spf13/cobra on 19-Oct-2023
###### Auto generated by spf13/cobra on 17-Nov-2023
Loading

0 comments on commit 78cd76b

Please sign in to comment.