aboutsummaryrefslogtreecommitdiffstats
path: root/man/en/sos-collect.1
diff options
context:
space:
mode:
authorJake Hunsaker <jhunsake@redhat.com>2021-12-02 14:02:17 -0500
committerJake Hunsaker <jhunsake@redhat.com>2021-12-03 16:36:50 -0500
commitdecb5d26c165e664fa879a669f2d80165181f0e1 (patch)
tree9e5c43f603dccee26de5a3637ba7558726706156 /man/en/sos-collect.1
parentef27a6ee6737c23b3beda1437768a91679024697 (diff)
downloadsos-decb5d26c165e664fa879a669f2d80165181f0e1.tar.gz
[report,collect] Add option to control default container runtime
Adds a new `--container-runtime` option that allows users to control what default container runtime is used by plugins for container based collections, effectively overriding policy defaults. If no runtimes are active, this option is effectively ignored. If however runtimes are active, but the requested one is not, raise an exception to abort collection with an appropriate message to the user. Signed-off-by: Jake Hunsaker <jhunsake@redhat.com>
Diffstat (limited to 'man/en/sos-collect.1')
-rw-r--r--man/en/sos-collect.16
1 files changed, 6 insertions, 0 deletions
diff --git a/man/en/sos-collect.1 b/man/en/sos-collect.1
index a1f6c10e..9b0a5d7b 100644
--- a/man/en/sos-collect.1
+++ b/man/en/sos-collect.1
@@ -11,6 +11,7 @@ sos collect \- Collect sosreports from multiple (cluster) nodes
[\-\-chroot CHROOT]
[\-\-case\-id CASE_ID]
[\-\-cluster\-type CLUSTER_TYPE]
+ [\-\-container\-runtime RUNTIME]
[\-e ENABLE_PLUGINS]
[--encrypt-key KEY]\fR
[--encrypt-pass PASS]\fR
@@ -113,6 +114,11 @@ Example: \fBsos collect --cluster-type=kubernetes\fR will force the kubernetes p
to be run, and thus set sosreport options and attempt to determine a list of nodes using
that profile.
.TP
+\fB\-\-container\-runtime\fR RUNTIME
+\fB sos report\fR option. Using this with \fBcollect\fR will pass this option thru
+to nodes with sos version 4.3 or later. This option controls the default container
+runtime plugins will use for collections. See \fBman sos-report\fR.
+.TP
\fB\-e\fR ENABLE_PLUGINS, \fB\-\-enable\-plugins\fR ENABLE_PLUGINS
Sosreport option. Use this to enable a plugin that would otherwise not be run.