Skip to content

Commit

Permalink
Add docs for v0.56.8
Browse files Browse the repository at this point in the history
Signed-off-by: John Schnake <[email protected]>
  • Loading branch information
johnSchnake committed Jul 2, 2022
1 parent b18f805 commit e709787
Show file tree
Hide file tree
Showing 94 changed files with 2,989 additions and 38 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.7"
var Version = "v0.56.8"

// 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.7
docs_latest: v0.56.8
docs_versions:
- main
- v0.56.8
- v0.56.7
- v0.56.6
- v0.56.5
Expand Down
3 changes: 2 additions & 1 deletion site/content/docs/main/cli/sonobuoy.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ sonobuoy [flags]
* [sonobuoy delete](sonobuoy_delete.md) - Deletes Kubernetes resources that were generated by a Sonobuoy run
* [sonobuoy e2e](sonobuoy_e2e.md) - Generates a list of all tests and tags in that tests
* [sonobuoy gen](sonobuoy_gen.md) - Generates a sonobuoy manifest for submission via kubectl
* [sonobuoy get](sonobuoy_get.md) - Fetches Sonobuoy resources of a specified type
* [sonobuoy images](sonobuoy_images.md) - Manage images used in a plugin to facilitate running them in airgapped (or similar) environments. Supported plugins are: 'e2e'
* [sonobuoy logs](sonobuoy_logs.md) - Dumps the logs of the currently running Sonobuoy containers for diagnostics
* [sonobuoy modes](sonobuoy_modes.md) - Display the various modes in which to run the e2e plugin
Expand All @@ -34,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 10-Jun-2022
###### Auto generated by spf13/cobra on 1-Jul-2022
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 @@ -33,4 +33,4 @@ sonobuoy delete [flags]

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

###### Auto generated by spf13/cobra on 10-Jun-2022
###### Auto generated by spf13/cobra on 1-Jul-2022
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 @@ -33,4 +33,4 @@ sonobuoy e2e [flags]

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

###### Auto generated by spf13/cobra on 10-Jun-2022
###### Auto generated by spf13/cobra on 1-Jul-2022
6 changes: 4 additions & 2 deletions site/content/docs/main/cli/sonobuoy_gen.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ sonobuoy gen [flags]
--e2e-repo envModifier Specify a registry to use as the default for pulling Kubernetes test images. Same as providing --e2e-repo-config but specifying the same repo repeatedly.
--e2e-repo-config yaml-filepath Specify a yaml file acting as KUBE_TEST_REPO_LIST, overriding registries for test images.
--e2e-skip envModifier Specify the E2E_SKIP value for the e2e plugin, specifying which tests to skip. Shorthand for --plugin-env=e2e.E2E_SKIP=<string> (default \[Disruptive\]|NoExecuteTaintManager)
--existing-service-account If true, use an existing service account, else attempt to create one.
-f, --file - If set, loads the file as if it were the output from sonobuoy gen. Set to - to read from stdin.
--force-image-pull-policy Force plugins' imagePullPolicy to match the value for the Sonobuoy pod
-h, --help help for gen
Expand All @@ -38,9 +39,10 @@ sonobuoy gen [flags]
--rbac RBACMode Whether to enable RBAC on Sonobuoy. Valid modes are Enable, Disable, and Detect (query the server to see whether to enable RBAC). (default Enable)
--rerun-failed tar.gz file Read the given tarball and set the E2E_FOCUS to target all the failed tests
--security-context-mode string Type of security context to use for the aggregator pod. Allowable values are [none, nonroot] (default "nonroot")
--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 If true, skip all checks before starting the sonobuoy run.
--sonobuoy-image string Container image override for the sonobuoy worker and aggregator. (default "sonobuoy/sonobuoy:v0.56.6-7-gc1568607")
--sonobuoy-image string Container image override for the sonobuoy worker and aggregator. (default "sonobuoy/sonobuoy:v0.56.7-12-gb18f8058")
--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 +64,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 10-Jun-2022
###### Auto generated by spf13/cobra on 1-Jul-2022
6 changes: 4 additions & 2 deletions site/content/docs/main/cli/sonobuoy_gen_config.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ sonobuoy gen config [flags]
--e2e-repo envModifier Specify a registry to use as the default for pulling Kubernetes test images. Same as providing --e2e-repo-config but specifying the same repo repeatedly.
--e2e-repo-config yaml-filepath Specify a yaml file acting as KUBE_TEST_REPO_LIST, overriding registries for test images.
--e2e-skip envModifier Specify the E2E_SKIP value for the e2e plugin, specifying which tests to skip. Shorthand for --plugin-env=e2e.E2E_SKIP=<string> (default \[Disruptive\]|NoExecuteTaintManager)
--existing-service-account If true, use an existing service account, else attempt to create one.
-f, --file - If set, loads the file as if it were the output from sonobuoy gen. Set to - to read from stdin.
--force-image-pull-policy Force plugins' imagePullPolicy to match the value for the Sonobuoy pod
-h, --help help for config
Expand All @@ -38,9 +39,10 @@ sonobuoy gen config [flags]
--rbac RBACMode Whether to enable RBAC on Sonobuoy. Valid modes are Enable, Disable, and Detect (query the server to see whether to enable RBAC). (default Enable)
--rerun-failed tar.gz file Read the given tarball and set the E2E_FOCUS to target all the failed tests
--security-context-mode string Type of security context to use for the aggregator pod. Allowable values are [none, nonroot] (default "nonroot")
--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 If true, skip all checks before starting the sonobuoy run.
--sonobuoy-image string Container image override for the sonobuoy worker and aggregator. (default "sonobuoy/sonobuoy:v0.56.6-7-gc1568607")
--sonobuoy-image string Container image override for the sonobuoy worker and aggregator. (default "sonobuoy/sonobuoy:v0.56.7-12-gb18f8058")
--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 +61,4 @@ sonobuoy gen config [flags]

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

###### Auto generated by spf13/cobra on 10-Jun-2022
###### Auto generated by spf13/cobra on 1-Jul-2022
Original file line number Diff line number Diff line change
Expand Up @@ -28,4 +28,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 10-Jun-2022
###### Auto generated by spf13/cobra on 1-Jul-2022
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 @@ -46,4 +46,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 10-Jun-2022
###### Auto generated by spf13/cobra on 1-Jul-2022
6 changes: 4 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 @@ -24,6 +24,7 @@ sonobuoy gen plugin e2e [flags]
--e2e-repo envModifier Specify a registry to use as the default for pulling Kubernetes test images. Same as providing --e2e-repo-config but specifying the same repo repeatedly.
--e2e-repo-config yaml-filepath Specify a yaml file acting as KUBE_TEST_REPO_LIST, overriding registries for test images.
--e2e-skip envModifier Specify the E2E_SKIP value for the e2e plugin, specifying which tests to skip. Shorthand for --plugin-env=e2e.E2E_SKIP=<string> (default \[Disruptive\]|NoExecuteTaintManager)
--existing-service-account If true, use an existing service account, else attempt to create one.
-f, --file - If set, loads the file as if it were the output from sonobuoy gen. Set to - to read from stdin.
--force-image-pull-policy Force plugins' imagePullPolicy to match the value for the Sonobuoy pod
-h, --help help for e2e
Expand All @@ -39,9 +40,10 @@ sonobuoy gen plugin e2e [flags]
--rbac RBACMode Whether to enable RBAC on Sonobuoy. Valid modes are Enable, Disable, and Detect (query the server to see whether to enable RBAC). (default Enable)
--rerun-failed tar.gz file Read the given tarball and set the E2E_FOCUS to target all the failed tests
--security-context-mode string Type of security context to use for the aggregator pod. Allowable values are [none, nonroot] (default "nonroot")
--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 If true, skip all checks before starting the sonobuoy run.
--sonobuoy-image string Container image override for the sonobuoy worker and aggregator. (default "sonobuoy/sonobuoy:v0.56.6-7-gc1568607")
--sonobuoy-image string Container image override for the sonobuoy worker and aggregator. (default "sonobuoy/sonobuoy:v0.56.7-12-gb18f8058")
--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 +62,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 10-Jun-2022
###### Auto generated by spf13/cobra on 1-Jul-2022
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ sonobuoy gen plugin systemd-logs [flags]
--e2e-repo envModifier Specify a registry to use as the default for pulling Kubernetes test images. Same as providing --e2e-repo-config but specifying the same repo repeatedly.
--e2e-repo-config yaml-filepath Specify a yaml file acting as KUBE_TEST_REPO_LIST, overriding registries for test images.
--e2e-skip envModifier Specify the E2E_SKIP value for the e2e plugin, specifying which tests to skip. Shorthand for --plugin-env=e2e.E2E_SKIP=<string> (default \[Disruptive\]|NoExecuteTaintManager)
--existing-service-account If true, use an existing service account, else attempt to create one.
-f, --file - If set, loads the file as if it were the output from sonobuoy gen. Set to - to read from stdin.
--force-image-pull-policy Force plugins' imagePullPolicy to match the value for the Sonobuoy pod
-h, --help help for systemd-logs
Expand All @@ -38,9 +39,10 @@ sonobuoy gen plugin systemd-logs [flags]
--rbac RBACMode Whether to enable RBAC on Sonobuoy. Valid modes are Enable, Disable, and Detect (query the server to see whether to enable RBAC). (default Enable)
--rerun-failed tar.gz file Read the given tarball and set the E2E_FOCUS to target all the failed tests
--security-context-mode string Type of security context to use for the aggregator pod. Allowable values are [none, nonroot] (default "nonroot")
--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 If true, skip all checks before starting the sonobuoy run.
--sonobuoy-image string Container image override for the sonobuoy worker and aggregator. (default "sonobuoy/sonobuoy:v0.56.6-7-gc1568607")
--sonobuoy-image string Container image override for the sonobuoy worker and aggregator. (default "sonobuoy/sonobuoy:v0.56.7-12-gb18f8058")
--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 +61,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 10-Jun-2022
###### Auto generated by spf13/cobra on 1-Jul-2022
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 @@ -37,4 +37,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 10-Jun-2022
###### Auto generated by spf13/cobra on 1-Jul-2022
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 @@ -33,4 +33,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 10-Jun-2022
###### Auto generated by spf13/cobra on 1-Jul-2022
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 @@ -33,4 +33,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 10-Jun-2022
###### Auto generated by spf13/cobra on 1-Jul-2022
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 @@ -31,4 +31,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 10-Jun-2022
###### Auto generated by spf13/cobra on 1-Jul-2022
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 @@ -33,4 +33,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 10-Jun-2022
###### Auto generated by spf13/cobra on 1-Jul-2022
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 @@ -34,4 +34,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 10-Jun-2022
###### Auto generated by spf13/cobra on 1-Jul-2022
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 @@ -31,4 +31,4 @@ sonobuoy logs [flags]

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

###### Auto generated by spf13/cobra on 10-Jun-2022
###### Auto generated by spf13/cobra on 1-Jul-2022
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 @@ -27,4 +27,4 @@ sonobuoy modes [flags]

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

###### Auto generated by spf13/cobra on 10-Jun-2022
###### Auto generated by spf13/cobra on 1-Jul-2022
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 @@ -26,4 +26,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 10-Jun-2022
###### Auto generated by spf13/cobra on 1-Jul-2022
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 @@ -26,4 +26,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 10-Jun-2022
###### Auto generated by spf13/cobra on 1-Jul-2022
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 @@ -26,4 +26,4 @@ sonobuoy plugin list [flags]

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

###### Auto generated by spf13/cobra on 10-Jun-2022
###### Auto generated by spf13/cobra on 1-Jul-2022
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 @@ -26,4 +26,4 @@ sonobuoy plugin show <plugin filename> [flags]

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

###### Auto generated by spf13/cobra on 10-Jun-2022
###### Auto generated by spf13/cobra on 1-Jul-2022
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 @@ -26,4 +26,4 @@ sonobuoy plugin uninstall <plugin filename> [flags]

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

###### Auto generated by spf13/cobra on 10-Jun-2022
###### Auto generated by spf13/cobra on 1-Jul-2022
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 @@ -28,4 +28,4 @@ sonobuoy query [flags]

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

###### Auto generated by spf13/cobra on 10-Jun-2022
###### Auto generated by spf13/cobra on 1-Jul-2022
4 changes: 2 additions & 2 deletions site/content/docs/main/cli/sonobuoy_results.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ sonobuoy results archive.tar.gz [flags]

```
-h, --help help for results
-m, --mode string Modifies the format of the output. Valid options are report, detailed, or dump. (default "report")
-m, --mode string Modifies the format of the output. Valid options are report, detailed, readable, or dump. (default "report")
-n, --node string Traverse results starting at the node with the given name. Defaults to the real root.
-p, --plugin string Which plugin to show results for. Defaults to printing them all.
-s, --skip-prefix When printing items linking to files, only print the file contents.
Expand All @@ -30,4 +30,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 10-Jun-2022
###### Auto generated by spf13/cobra on 1-Jul-2022
Loading

0 comments on commit e709787

Please sign in to comment.