Add docs for v0.57.0

Signed-off-by: Peter Grant <[email protected]>

scripts/update_docs.sh

@@ -118,7 +118,7 @@ fi
 
 docker run --rm \
   -v "${DIR}":/root \
-  debian:stretch-slim \
+  debian:bookworm-slim \
   /bin/sh -c \
   "rm -rf /root/site/content/docs/${VERSION} && \
   cp -r /root/site/content/docs/main /root/site/content/docs/${VERSION} && \

site/config.yaml

@@ -32,9 +32,10 @@ params:
   docs_search_index_name: index_name
   docs_search_api_key: api_key
   docs_versioning: true
-  docs_latest: v0.56.17
+  docs_latest: v0.57.0
   docs_versions:
     - main
+    - v0.57.0
     - v0.56.17
     - v0.56.15
     - v0.56.14

site/content/docs/main/cli/sonobuoy.md

@@ -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 15-Jun-2023
+###### Auto generated by spf13/cobra on 19-Oct-2023

site/content/docs/main/cli/sonobuoy_delete.md

@@ -11,6 +11,7 @@ sonobuoy delete [flags]
 ```
       --all                     In addition to deleting Sonobuoy namespaces, also clean up dangling e2e namespaces (those with 'e2e-framework' and 'e2e-run' labels).
       --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 delete
       --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")
@@ -29,4 +30,4 @@ sonobuoy delete [flags]
 
 * [sonobuoy](sonobuoy.md)	 - Generate reports on your Kubernetes cluster by running plugins
 
-###### Auto generated by spf13/cobra on 15-Jun-2023
+###### Auto generated by spf13/cobra on 19-Oct-2023

site/content/docs/main/cli/sonobuoy_e2e.md

@@ -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 15-Jun-2023
+###### Auto generated by spf13/cobra on 19-Oct-2023

site/content/docs/main/cli/sonobuoy_gen.md

@@ -15,6 +15,7 @@ sonobuoy gen [flags]
       --context string                           Context in the kubeconfig to use.
       --dns-namespace string                     The namespace to check for DNS pods during preflight checks. (default "kube-system")
       --dns-pod-labels strings                   The label selectors to use for locating DNS pods during preflight checks. Can be specified multiple times or as a comma-separated list. (default [k8s-app=kube-dns,k8s-app=coredns])
+      --e2e-docker-config-file json-filepath     A docker credentials configuration file used which contains authorization token that can be used to pull images from certain private registries provided by the users
       --e2e-focus envModifier                    Specify the E2E_FOCUS value for the e2e plugin, specifying which tests to run. Shorthand for --plugin-env=e2e.E2E_FOCUS=<string> (default \[Conformance\])
       --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.
@@ -39,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:1c88db1e")
+      --sonobuoy-image string                    Container image override for the sonobuoy worker and aggregator. (default "sonobuoy/sonobuoy:v0.56.16-56-ge5bb5618-dirty")
       --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[])
@@ -61,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 15-Jun-2023
+###### Auto generated by spf13/cobra on 19-Oct-2023

site/content/docs/main/cli/sonobuoy_gen_config.md

@@ -15,6 +15,7 @@ sonobuoy gen config [flags]
       --context string                           Context in the kubeconfig to use.
       --dns-namespace string                     The namespace to check for DNS pods during preflight checks. (default "kube-system")
       --dns-pod-labels strings                   The label selectors to use for locating DNS pods during preflight checks. Can be specified multiple times or as a comma-separated list. (default [k8s-app=kube-dns,k8s-app=coredns])
+      --e2e-docker-config-file json-filepath     A docker credentials configuration file used which contains authorization token that can be used to pull images from certain private registries provided by the users
       --e2e-focus envModifier                    Specify the E2E_FOCUS value for the e2e plugin, specifying which tests to run. Shorthand for --plugin-env=e2e.E2E_FOCUS=<string> (default \[Conformance\])
       --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.
@@ -39,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:1c88db1e")
+      --sonobuoy-image string                    Container image override for the sonobuoy worker and aggregator. (default "sonobuoy/sonobuoy:v0.56.16-56-ge5bb5618-dirty")
       --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[])
@@ -58,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 15-Jun-2023
+###### Auto generated by spf13/cobra on 19-Oct-2023

site/content/docs/main/cli/sonobuoy_gen_default-image-config.md

@@ -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 15-Jun-2023
+###### Auto generated by spf13/cobra on 19-Oct-2023

site/content/docs/main/cli/sonobuoy_gen_plugin.md

@@ -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 15-Jun-2023
+###### Auto generated by spf13/cobra on 19-Oct-2023

site/content/docs/main/cli/sonobuoy_gen_plugin_e2e.md

@@ -16,6 +16,7 @@ sonobuoy gen plugin e2e [flags]
       --context string                           Context in the kubeconfig to use.
       --dns-namespace string                     The namespace to check for DNS pods during preflight checks. (default "kube-system")
       --dns-pod-labels strings                   The label selectors to use for locating DNS pods during preflight checks. Can be specified multiple times or as a comma-separated list. (default [k8s-app=kube-dns,k8s-app=coredns])
+      --e2e-docker-config-file json-filepath     A docker credentials configuration file used which contains authorization token that can be used to pull images from certain private registries provided by the users
       --e2e-focus envModifier                    Specify the E2E_FOCUS value for the e2e plugin, specifying which tests to run. Shorthand for --plugin-env=e2e.E2E_FOCUS=<string> (default \[Conformance\])
       --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.
@@ -40,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:1c88db1e")
+      --sonobuoy-image string                    Container image override for the sonobuoy worker and aggregator. (default "sonobuoy/sonobuoy:v0.56.16-56-ge5bb5618-dirty")
       --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[])
@@ -59,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 15-Jun-2023
+###### Auto generated by spf13/cobra on 19-Oct-2023

site/content/docs/main/cli/sonobuoy_gen_plugin_systemd-logs.md

@@ -15,6 +15,7 @@ sonobuoy gen plugin systemd-logs [flags]
       --context string                           Context in the kubeconfig to use.
       --dns-namespace string                     The namespace to check for DNS pods during preflight checks. (default "kube-system")
       --dns-pod-labels strings                   The label selectors to use for locating DNS pods during preflight checks. Can be specified multiple times or as a comma-separated list. (default [k8s-app=kube-dns,k8s-app=coredns])
+      --e2e-docker-config-file json-filepath     A docker credentials configuration file used which contains authorization token that can be used to pull images from certain private registries provided by the users
       --e2e-focus envModifier                    Specify the E2E_FOCUS value for the e2e plugin, specifying which tests to run. Shorthand for --plugin-env=e2e.E2E_FOCUS=<string> (default \[Conformance\])
       --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.
@@ -39,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:1c88db1e")
+      --sonobuoy-image string                    Container image override for the sonobuoy worker and aggregator. (default "sonobuoy/sonobuoy:v0.56.16-56-ge5bb5618-dirty")
       --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[])
@@ -58,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 15-Jun-2023
+###### Auto generated by spf13/cobra on 19-Oct-2023

site/content/docs/main/cli/sonobuoy_get.md

@@ -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 15-Jun-2023
+###### Auto generated by spf13/cobra on 19-Oct-2023

site/content/docs/main/cli/sonobuoy_get_pod.md

@@ -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 15-Jun-2023
+###### Auto generated by spf13/cobra on 19-Oct-2023

site/content/docs/main/cli/sonobuoy_images.md

@@ -29,8 +29,9 @@ sonobuoy images [flags]
 * [sonobuoy](sonobuoy.md)	 - Generate reports on your Kubernetes cluster by running plugins
 * [sonobuoy images delete](sonobuoy_images_delete.md)	 - Deletes all images downloaded to local docker client
 * [sonobuoy images download](sonobuoy_images_download.md)	 - Saves downloaded images from local docker client to a tar file
+* [sonobuoy images inspect](sonobuoy_images_inspect.md)	 - Inspect images
 * [sonobuoy images list](sonobuoy_images_list.md)	 - List images
 * [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 15-Jun-2023
+###### Auto generated by spf13/cobra on 19-Oct-2023

site/content/docs/main/cli/sonobuoy_images_delete.md

@@ -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 15-Jun-2023
+###### Auto generated by spf13/cobra on 19-Oct-2023

site/content/docs/main/cli/sonobuoy_images_download.md

@@ -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 15-Jun-2023
+###### Auto generated by spf13/cobra on 19-Oct-2023

site/content/docs/main/cli/sonobuoy_images_list.md

@@ -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 15-Jun-2023
+###### Auto generated by spf13/cobra on 19-Oct-2023

site/content/docs/main/cli/sonobuoy_images_pull.md

@@ -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 15-Jun-2023
+###### Auto generated by spf13/cobra on 19-Oct-2023

site/content/docs/main/cli/sonobuoy_images_push.md

@@ -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 15-Jun-2023
+###### Auto generated by spf13/cobra on 19-Oct-2023

site/content/docs/main/cli/sonobuoy_logs.md

@@ -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 15-Jun-2023
+###### Auto generated by spf13/cobra on 19-Oct-2023

site/content/docs/main/cli/sonobuoy_modes.md

@@ -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 15-Jun-2023
+###### Auto generated by spf13/cobra on 19-Oct-2023

site/content/docs/main/cli/sonobuoy_plugin.md

@@ -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 15-Jun-2023
+###### Auto generated by spf13/cobra on 19-Oct-2023

site/content/docs/main/cli/sonobuoy_plugin_install.md

@@ -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 15-Jun-2023
+###### Auto generated by spf13/cobra on 19-Oct-2023

site/content/docs/main/cli/sonobuoy_plugin_list.md

@@ -22,4 +22,4 @@ sonobuoy plugin list [flags]
 
 * [sonobuoy plugin](sonobuoy_plugin.md)	 - Manage your installed plugins
 
-###### Auto generated by spf13/cobra on 15-Jun-2023
+###### Auto generated by spf13/cobra on 19-Oct-2023

site/content/docs/main/cli/sonobuoy_plugin_show.md

@@ -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 15-Jun-2023
+###### Auto generated by spf13/cobra on 19-Oct-2023

site/content/docs/main/cli/sonobuoy_plugin_uninstall.md

@@ -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 15-Jun-2023
+###### Auto generated by spf13/cobra on 19-Oct-2023

site/content/docs/main/cli/sonobuoy_query.md

@@ -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 15-Jun-2023
+###### Auto generated by spf13/cobra on 19-Oct-2023

site/content/docs/main/cli/sonobuoy_results.md

@@ -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 15-Jun-2023
+###### Auto generated by spf13/cobra on 19-Oct-2023

site/content/docs/main/cli/sonobuoy_retrieve.md

@@ -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 15-Jun-2023
+###### Auto generated by spf13/cobra on 19-Oct-2023