Skip to content

Commit

Permalink
Add docs for v0.56.7
Browse files Browse the repository at this point in the history 
Signed-off-by: John Schnake <jschnake@vmware.com>
  • Loading branch information
@johnSchnake
johnSchnake committed Jun 10, 2022
1 parent c156860 commit 41f2081
Show file tree
Hide file tree
Showing 93 changed files with 2,900 additions and 73 deletions.
2 changes: 1 addition & 1 deletion pkg/buildinfo/version.go
View file
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.6"
var Version = "v0.56.7"

// 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
View file
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.6
docs_latest: v0.56.7
docs_versions:
- main
- v0.56.7
- v0.56.6
- v0.56.5
- v0.56.4
Expand Down
2 changes: 1 addition & 1 deletion site/content/docs/main/cli/sonobuoy.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -34,4 +34,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 2-Jun-2022
###### Auto generated by spf13/cobra on 10-Jun-2022
2 changes: 1 addition & 1 deletion site/content/docs/main/cli/sonobuoy_delete.md
View file
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 2-Jun-2022
###### Auto generated by spf13/cobra on 10-Jun-2022
2 changes: 1 addition & 1 deletion site/content/docs/main/cli/sonobuoy_e2e.md
View file
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 2-Jun-2022
###### Auto generated by spf13/cobra on 10-Jun-2022
7 changes: 3 additions & 4 deletions site/content/docs/main/cli/sonobuoy_gen.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ sonobuoy gen [flags]

```
--aggregator-node-selector nodeSelectors Node selectors to add to the aggregator. Values can be given multiple times and are in the form key:value (default map[])
--aggregator-permissions string Type of aggregator permission to use in the cluster. Allowable values are [namespaced, clusterAdmin] (default "clusterAdmin")
--aggregator-permissions string Type of aggregator permission to use in the cluster. Allowable values are [namespaceAdmin, clusterRead, clusterAdmin] (default "clusterAdmin")
--config Sonobuoy config Path to a sonobuoy configuration JSON file.
--context string Context in the kubeconfig to use.
--dns-namespace string The namespace to check for DNS pods during preflight checks. (default "kube-system")
Expand All @@ -40,7 +40,7 @@ sonobuoy gen [flags]
--security-context-mode string Type of security context to use for the aggregator pod. Allowable values are [none, nonroot] (default "nonroot")
--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-1-g7da578e1-dirty")
--sonobuoy-image string Container image override for the sonobuoy worker and aggregator. (default "sonobuoy/sonobuoy:v0.56.6-7-gc1568607")
--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 @@ -58,9 +58,8 @@ sonobuoy gen [flags]
### SEE ALSO

* [sonobuoy](sonobuoy.md) - Generate reports on your Kubernetes cluster by running plugins
* [sonobuoy gen cli](sonobuoy_gen_cli.md) - Generates markdown docs for the CLI
* [sonobuoy gen config](sonobuoy_gen_config.md) - Generates a Sonobuoy config for input to sonobuoy gen or run.
* [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 2-Jun-2022
###### Auto generated by spf13/cobra on 10-Jun-2022
29 changes: 0 additions & 29 deletions site/content/docs/main/cli/sonobuoy_gen_cli.md
View file

This file was deleted.

6 changes: 3 additions & 3 deletions site/content/docs/main/cli/sonobuoy_gen_config.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ sonobuoy gen config [flags]

```
--aggregator-node-selector nodeSelectors Node selectors to add to the aggregator. Values can be given multiple times and are in the form key:value (default map[])
--aggregator-permissions string Type of aggregator permission to use in the cluster. Allowable values are [namespaced, clusterAdmin] (default "clusterAdmin")
--aggregator-permissions string Type of aggregator permission to use in the cluster. Allowable values are [namespaceAdmin, clusterRead, clusterAdmin] (default "clusterAdmin")
--config Sonobuoy config Path to a sonobuoy configuration JSON file.
--context string Context in the kubeconfig to use.
--dns-namespace string The namespace to check for DNS pods during preflight checks. (default "kube-system")
Expand All @@ -40,7 +40,7 @@ sonobuoy gen config [flags]
--security-context-mode string Type of security context to use for the aggregator pod. Allowable values are [none, nonroot] (default "nonroot")
--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-1-g7da578e1-dirty")
--sonobuoy-image string Container image override for the sonobuoy worker and aggregator. (default "sonobuoy/sonobuoy:v0.56.6-7-gc1568607")
--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 2-Jun-2022
###### Auto generated by spf13/cobra on 10-Jun-2022
2 changes: 1 addition & 1 deletion site/content/docs/main/cli/sonobuoy_gen_default-image-config.md
View file
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 2-Jun-2022
###### Auto generated by spf13/cobra on 10-Jun-2022
2 changes: 1 addition & 1 deletion site/content/docs/main/cli/sonobuoy_gen_plugin.md
View file
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 2-Jun-2022
###### Auto generated by spf13/cobra on 10-Jun-2022
6 changes: 3 additions & 3 deletions site/content/docs/main/cli/sonobuoy_gen_plugin_e2e.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ sonobuoy gen plugin e2e [flags]

```
--aggregator-node-selector nodeSelectors Node selectors to add to the aggregator. Values can be given multiple times and are in the form key:value (default map[])
--aggregator-permissions string Type of aggregator permission to use in the cluster. Allowable values are [namespaced, clusterAdmin] (default "clusterAdmin")
--aggregator-permissions string Type of aggregator permission to use in the cluster. Allowable values are [namespaceAdmin, clusterRead, clusterAdmin] (default "clusterAdmin")
--config Sonobuoy config Path to a sonobuoy configuration JSON file.
--configmap stringArray Specifies files to read and add as configMaps. Will be mounted to the plugin at /tmp/sonobuoy/configs/<filename>.
--context string Context in the kubeconfig to use.
Expand All @@ -41,7 +41,7 @@ sonobuoy gen plugin e2e [flags]
--security-context-mode string Type of security context to use for the aggregator pod. Allowable values are [none, nonroot] (default "nonroot")
--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-1-g7da578e1-dirty")
--sonobuoy-image string Container image override for the sonobuoy worker and aggregator. (default "sonobuoy/sonobuoy:v0.56.6-7-gc1568607")
--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 2-Jun-2022
###### Auto generated by spf13/cobra on 10-Jun-2022
6 changes: 3 additions & 3 deletions site/content/docs/main/cli/sonobuoy_gen_plugin_systemd-logs.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ sonobuoy gen plugin systemd-logs [flags]

```
--aggregator-node-selector nodeSelectors Node selectors to add to the aggregator. Values can be given multiple times and are in the form key:value (default map[])
--aggregator-permissions string Type of aggregator permission to use in the cluster. Allowable values are [namespaced, clusterAdmin] (default "clusterAdmin")
--aggregator-permissions string Type of aggregator permission to use in the cluster. Allowable values are [namespaceAdmin, clusterRead, clusterAdmin] (default "clusterAdmin")
--config Sonobuoy config Path to a sonobuoy configuration JSON file.
--context string Context in the kubeconfig to use.
--dns-namespace string The namespace to check for DNS pods during preflight checks. (default "kube-system")
Expand All @@ -40,7 +40,7 @@ sonobuoy gen plugin systemd-logs [flags]
--security-context-mode string Type of security context to use for the aggregator pod. Allowable values are [none, nonroot] (default "nonroot")
--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-1-g7da578e1-dirty")
--sonobuoy-image string Container image override for the sonobuoy worker and aggregator. (default "sonobuoy/sonobuoy:v0.56.6-7-gc1568607")
--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 2-Jun-2022
###### Auto generated by spf13/cobra on 10-Jun-2022
2 changes: 1 addition & 1 deletion site/content/docs/main/cli/sonobuoy_images.md
View file
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 2-Jun-2022
###### Auto generated by spf13/cobra on 10-Jun-2022
2 changes: 1 addition & 1 deletion site/content/docs/main/cli/sonobuoy_images_delete.md
View file
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 2-Jun-2022
###### Auto generated by spf13/cobra on 10-Jun-2022
2 changes: 1 addition & 1 deletion site/content/docs/main/cli/sonobuoy_images_download.md
View file
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 2-Jun-2022
###### Auto generated by spf13/cobra on 10-Jun-2022
2 changes: 1 addition & 1 deletion site/content/docs/main/cli/sonobuoy_images_list.md
View file
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 2-Jun-2022
###### Auto generated by spf13/cobra on 10-Jun-2022
2 changes: 1 addition & 1 deletion site/content/docs/main/cli/sonobuoy_images_pull.md
View file
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 2-Jun-2022
###### Auto generated by spf13/cobra on 10-Jun-2022
2 changes: 1 addition & 1 deletion site/content/docs/main/cli/sonobuoy_images_push.md
View file
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 2-Jun-2022
###### Auto generated by spf13/cobra on 10-Jun-2022
2 changes: 1 addition & 1 deletion site/content/docs/main/cli/sonobuoy_logs.md
View file
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 2-Jun-2022
###### Auto generated by spf13/cobra on 10-Jun-2022
2 changes: 1 addition & 1 deletion site/content/docs/main/cli/sonobuoy_modes.md
View file
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 2-Jun-2022
###### Auto generated by spf13/cobra on 10-Jun-2022
2 changes: 1 addition & 1 deletion site/content/docs/main/cli/sonobuoy_plugin.md
View file
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 2-Jun-2022
###### Auto generated by spf13/cobra on 10-Jun-2022
2 changes: 1 addition & 1 deletion site/content/docs/main/cli/sonobuoy_plugin_install.md
View file
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 2-Jun-2022
###### Auto generated by spf13/cobra on 10-Jun-2022
2 changes: 1 addition & 1 deletion site/content/docs/main/cli/sonobuoy_plugin_list.md
View file
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 2-Jun-2022
###### Auto generated by spf13/cobra on 10-Jun-2022
2 changes: 1 addition & 1 deletion site/content/docs/main/cli/sonobuoy_plugin_show.md
View file
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 2-Jun-2022
###### Auto generated by spf13/cobra on 10-Jun-2022
2 changes: 1 addition & 1 deletion site/content/docs/main/cli/sonobuoy_plugin_uninstall.md
View file
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 2-Jun-2022
###### Auto generated by spf13/cobra on 10-Jun-2022
2 changes: 1 addition & 1 deletion site/content/docs/main/cli/sonobuoy_query.md
View file
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 2-Jun-2022
###### Auto generated by spf13/cobra on 10-Jun-2022
2 changes: 1 addition & 1 deletion site/content/docs/main/cli/sonobuoy_results.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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 2-Jun-2022
###### Auto generated by spf13/cobra on 10-Jun-2022
2 changes: 1 addition & 1 deletion site/content/docs/main/cli/sonobuoy_retrieve.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -32,4 +32,4 @@ sonobuoy retrieve [path] [flags]

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

###### Auto generated by spf13/cobra on 2-Jun-2022
###### Auto generated by spf13/cobra on 10-Jun-2022
6 changes: 3 additions & 3 deletions site/content/docs/main/cli/sonobuoy_run.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ sonobuoy run [flags]

```
--aggregator-node-selector nodeSelectors Node selectors to add to the aggregator. Values can be given multiple times and are in the form key:value (default map[])
--aggregator-permissions string Type of aggregator permission to use in the cluster. Allowable values are [namespaced, clusterAdmin] (default "clusterAdmin")
--aggregator-permissions string Type of aggregator permission to use in the cluster. Allowable values are [namespaceAdmin, clusterRead, clusterAdmin] (default "clusterAdmin")
--config Sonobuoy config Path to a sonobuoy configuration JSON file.
--context string Context in the kubeconfig to use.
--dns-namespace string The namespace to check for DNS pods during preflight checks. (default "kube-system")
Expand All @@ -40,7 +40,7 @@ sonobuoy run [flags]
--security-context-mode string Type of security context to use for the aggregator pod. Allowable values are [none, nonroot] (default "nonroot")
--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-1-g7da578e1-dirty")
--sonobuoy-image string Container image override for the sonobuoy worker and aggregator. (default "sonobuoy/sonobuoy:v0.56.6-7-gc1568607")
--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 2-Jun-2022
###### Auto generated by spf13/cobra on 10-Jun-2022
2 changes: 1 addition & 1 deletion site/content/docs/main/cli/sonobuoy_status.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -31,4 +31,4 @@ sonobuoy status [flags]

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

###### Auto generated by spf13/cobra on 2-Jun-2022
###### Auto generated by spf13/cobra on 10-Jun-2022
Loading

0 comments on commit 41f2081

Please sign in to comment.