Skip to content

Commit

Permalink
Add docs for v0.56.14
Browse files Browse the repository at this point in the history
    Co-Authored By: Dave Riddle <[email protected]>

Signed-off-by: James Burchell <[email protected]>
  • Loading branch information
JamesBurchell committed Dec 14, 2022
1 parent 7d03a79 commit 9b72df1
Show file tree
Hide file tree
Showing 96 changed files with 2,827 additions and 159 deletions.
2 changes: 1 addition & 1 deletion pkg/buildinfo/version.go
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ package buildinfo

// Version is the current version of Sonobuoy, set by the go linker's -X flag at build time.
// Ensure that this is bumped manually as well so that Sonobuoy, as a library, also has the right version.
var Version = "v0.56.13"
var Version = "v0.56.14"

// GitSHA is the actual commit that is being built, set by the go linker's -X flag at build time.
var GitSHA string
Expand Down
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.56.13
docs_latest: v0.56.14
docs_versions:
- main
- v0.56.14
- v0.56.13
- v0.56.12
- v0.56.11
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 8-Dec-2022
###### Auto generated by spf13/cobra on 13-Dec-2022
6 changes: 1 addition & 5 deletions site/content/docs/main/cli/sonobuoy_delete.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,6 @@

Deletes Kubernetes resources that were generated by a Sonobuoy run

### Synopsis

Deletes Kubernetes resources that were generated by a Sonobuoy run

```
sonobuoy delete [flags]
```
Expand Down Expand Up @@ -33,4 +29,4 @@ sonobuoy delete [flags]

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

###### Auto generated by spf13/cobra on 8-Dec-2022
###### Auto generated by spf13/cobra on 13-Dec-2022
6 changes: 1 addition & 5 deletions site/content/docs/main/cli/sonobuoy_e2e.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,6 @@

Generates a list of all tests and tags in that tests

### Synopsis

Generates a list of all tests and tags in that tests

```
sonobuoy e2e [flags]
```
Expand Down Expand Up @@ -33,4 +29,4 @@ sonobuoy e2e [flags]

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

###### Auto generated by spf13/cobra on 8-Dec-2022
###### Auto generated by spf13/cobra on 13-Dec-2022
8 changes: 2 additions & 6 deletions site/content/docs/main/cli/sonobuoy_gen.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,6 @@

Generates a sonobuoy manifest for submission via kubectl

### Synopsis

Generates a sonobuoy manifest for submission via kubectl

```
sonobuoy gen [flags]
```
Expand Down Expand Up @@ -42,7 +38,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.12-1-g6d46d527")
--sonobuoy-image string Container image override for the sonobuoy worker and aggregator. (default "sonobuoy/sonobuoy:v0.56.13-2-g3d362933")
--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 @@ -64,4 +60,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 8-Dec-2022
###### Auto generated by spf13/cobra on 13-Dec-2022
8 changes: 2 additions & 6 deletions site/content/docs/main/cli/sonobuoy_gen_config.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,6 @@

Generates a Sonobuoy config for input to sonobuoy gen or run.

### Synopsis

Generates a Sonobuoy config for input to sonobuoy gen or run.

```
sonobuoy gen config [flags]
```
Expand Down Expand Up @@ -42,7 +38,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.12-1-g6d46d527")
--sonobuoy-image string Container image override for the sonobuoy worker and aggregator. (default "sonobuoy/sonobuoy:v0.56.13-2-g3d362933")
--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 @@ -61,4 +57,4 @@ sonobuoy gen config [flags]

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

###### Auto generated by spf13/cobra on 8-Dec-2022
###### Auto generated by spf13/cobra on 13-Dec-2022
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,6 @@

Generates the default image registry config for the e2e plugin

### Synopsis

Generates the default image registry config for the e2e plugin

```
sonobuoy gen default-image-config [flags]
```
Expand All @@ -28,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 8-Dec-2022
###### Auto generated by spf13/cobra on 13-Dec-2022
6 changes: 1 addition & 5 deletions site/content/docs/main/cli/sonobuoy_gen_plugin.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,6 @@

Generates the manifest Sonobuoy uses to define a plugin

### Synopsis

Generates the manifest Sonobuoy uses to define a plugin

```
sonobuoy gen plugin [flags]
```
Expand Down Expand Up @@ -46,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 8-Dec-2022
###### Auto generated by spf13/cobra on 13-Dec-2022
8 changes: 2 additions & 6 deletions site/content/docs/main/cli/sonobuoy_gen_plugin_e2e.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,6 @@

Generates the e2e plugin definition based on the given options

### Synopsis

Generates the e2e plugin definition based on the given options

```
sonobuoy gen plugin e2e [flags]
```
Expand Down Expand Up @@ -43,7 +39,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.12-1-g6d46d527")
--sonobuoy-image string Container image override for the sonobuoy worker and aggregator. (default "sonobuoy/sonobuoy:v0.56.13-2-g3d362933")
--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 +58,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 8-Dec-2022
###### Auto generated by spf13/cobra on 13-Dec-2022
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,6 @@

Generates the systemd-logs plugin definition based on the given options

### Synopsis

Generates the systemd-logs plugin definition based on the given options

```
sonobuoy gen plugin systemd-logs [flags]
```
Expand Down Expand Up @@ -42,7 +38,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.12-1-g6d46d527")
--sonobuoy-image string Container image override for the sonobuoy worker and aggregator. (default "sonobuoy/sonobuoy:v0.56.13-2-g3d362933")
--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 @@ -61,4 +57,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 8-Dec-2022
###### Auto generated by spf13/cobra on 13-Dec-2022
6 changes: 1 addition & 5 deletions site/content/docs/main/cli/sonobuoy_get.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,6 @@

Fetches Sonobuoy resources of a specified type

### Synopsis

Fetches Sonobuoy resources of a specified type

### Options

```
Expand All @@ -23,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 8-Dec-2022
###### Auto generated by spf13/cobra on 13-Dec-2022
6 changes: 1 addition & 5 deletions site/content/docs/main/cli/sonobuoy_get_pod.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,6 @@

Fetch sonobuoy pods

### Synopsis

Fetch sonobuoy pods

```
sonobuoy get pod [flags]
```
Expand All @@ -28,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 8-Dec-2022
###### Auto generated by spf13/cobra on 13-Dec-2022
6 changes: 1 addition & 5 deletions site/content/docs/main/cli/sonobuoy_images.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,6 @@

Manage images used in a plugin to facilitate running them in airgapped (or similar) environments. Supported plugins are: 'e2e'

### Synopsis

Manage images used in a plugin to facilitate running them in airgapped (or similar) environments. Supported plugins are: 'e2e'

```
sonobuoy images [flags]
```
Expand Down Expand Up @@ -37,4 +33,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 8-Dec-2022
###### Auto generated by spf13/cobra on 13-Dec-2022
6 changes: 1 addition & 5 deletions site/content/docs/main/cli/sonobuoy_images_delete.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,6 @@

Deletes all images downloaded to local docker client

### Synopsis

Deletes all images downloaded to local docker client

```
sonobuoy images delete [flags]
```
Expand Down Expand Up @@ -33,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 8-Dec-2022
###### Auto generated by spf13/cobra on 13-Dec-2022
6 changes: 1 addition & 5 deletions site/content/docs/main/cli/sonobuoy_images_download.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,6 @@

Saves downloaded images from local docker client to a tar file

### Synopsis

Saves downloaded images from local docker client to a tar file

```
sonobuoy images download [flags]
```
Expand Down Expand Up @@ -33,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 8-Dec-2022
###### Auto generated by spf13/cobra on 13-Dec-2022
6 changes: 1 addition & 5 deletions site/content/docs/main/cli/sonobuoy_images_list.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,6 @@

List images

### Synopsis

List images

```
sonobuoy images list [flags]
```
Expand All @@ -31,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 8-Dec-2022
###### Auto generated by spf13/cobra on 13-Dec-2022
6 changes: 1 addition & 5 deletions site/content/docs/main/cli/sonobuoy_images_pull.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,6 @@

Pulls images to local docker client for a specific plugin

### Synopsis

Pulls images to local docker client for a specific plugin

```
sonobuoy images pull [flags]
```
Expand Down Expand Up @@ -33,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 8-Dec-2022
###### Auto generated by spf13/cobra on 13-Dec-2022
6 changes: 1 addition & 5 deletions site/content/docs/main/cli/sonobuoy_images_push.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,6 @@

Pushes images to docker registry for a specific plugin

### Synopsis

Pushes images to docker registry for a specific plugin

```
sonobuoy images push [flags]
```
Expand Down Expand Up @@ -34,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 8-Dec-2022
###### Auto generated by spf13/cobra on 13-Dec-2022
6 changes: 1 addition & 5 deletions site/content/docs/main/cli/sonobuoy_logs.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,6 @@

Dumps the logs of the currently running Sonobuoy containers for diagnostics

### Synopsis

Dumps the logs of the currently running Sonobuoy containers for diagnostics

```
sonobuoy logs [flags]
```
Expand All @@ -31,4 +27,4 @@ sonobuoy logs [flags]

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

###### Auto generated by spf13/cobra on 8-Dec-2022
###### Auto generated by spf13/cobra on 13-Dec-2022
6 changes: 1 addition & 5 deletions site/content/docs/main/cli/sonobuoy_modes.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,6 @@

Display the various modes in which to run the e2e plugin

### Synopsis

Display the various modes in which to run the e2e plugin

```
sonobuoy modes [flags]
```
Expand All @@ -27,4 +23,4 @@ sonobuoy modes [flags]

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

###### Auto generated by spf13/cobra on 8-Dec-2022
###### Auto generated by spf13/cobra on 13-Dec-2022
6 changes: 1 addition & 5 deletions site/content/docs/main/cli/sonobuoy_plugin.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,6 @@

Manage your installed plugins

### Synopsis

Manage your installed plugins

### Options

```
Expand All @@ -26,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 8-Dec-2022
###### Auto generated by spf13/cobra on 13-Dec-2022
Loading

0 comments on commit 9b72df1

Please sign in to comment.