[collect] Add options to provide registry auth for pulling images

Adds options that allow a user to specify registry authentication,
either via username/password or an authfile, to allow pulling an image
that exists on a non-public registry.

If a username/password is provided, that will be used. If not, we will
attempt to use an authfile - either provided by the user or by a cluster
profile.

Also adds an option to forcibly pull a new(er) version of the specified
image, to alleviate conditions where a too-old version of the image
already exists on the host.

Closes: #2534

Signed-off-by: Jake Hunsaker <jhunsake@redhat.com>

1 files changed, 30 insertions, 0 deletions

diff --git a/man/en/sos-collect.1 b/man/en/sos-collect.1
index 286bfe71..cdbc3257 100644
--- a/man/en/sos-collect.1
+++ b/man/en/sos-collect.1
@@ -26,6 +26,11 @@ sos collect \- Collect sosreports from multiple (cluster) nodes
     [\-\-no\-pkg\-check]
     [\-\-no\-local]
     [\-\-master MASTER]
+    [\-\-image IMAGE]
+    [\-\-force-pull-image]
+    [\-\-registry-user USER]
+    [\-\-registry-password PASSWORD]
+    [\-\-registry-authfile FILE]
     [\-o ONLY_PLUGINS]
     [\-p SSH_PORT]
     [\-\-password]
@@ -245,6 +250,31 @@ Specify a master node for the cluster.
 If provided, then sos collect will check the master node, not localhost, for determining
 the type of cluster in use.
 .TP
+\fB\-\-image IMAGE\fR
+Specify an image to use for the temporary container created for collections on
+containerized host, if you do not want to use the default image specifed by the
+host's policy. Note that this should include the registry.
+.TP
+\fB\-\-force-pull-image\fR
+Use this option to force the container runtime to pull the specified image (even
+if it is the policy default image) even if the image already exists on the host.
+This may be useful to update an older container image on containerized hosts.
+.TP
+\fB\-\-registry-user USER\fR
+Specify the username to authenticate to the registry with in order to pull the container
+image
+.TP
+\fB\-\-registry-password PASSWORD\fR
+Specify the password to authenticate to the registry with in order to pull the container
+image. If no password is required, leave this blank.
+.TP
+\fB\-\-registry-authfile FILE\fR
+Specify the filename to use for providing authentication credentials to the registry
+to pull the container image.
+
+Note that this file must exist on the node(s) performing the pull operations, not the
+node from which \fBsos collect\fR was run.
+.TP
 \fB\-o\fR ONLY_PLUGINS, \fB\-\-only\-plugins\fR ONLY_PLUGINS
 Sosreport option. Run ONLY the plugins listed.