aboutsummaryrefslogtreecommitdiffstats
path: root/man
diff options
context:
space:
mode:
authorJake Hunsaker <jhunsake@redhat.com>2019-11-14 16:10:50 -0500
committerJake Hunsaker <jhunsake@redhat.com>2019-11-19 12:39:06 -0500
commit645b9c98dc8f509839e37055050be4f39d6161d2 (patch)
tree014eea6fd3169683c6ecae7f29a424de2ed419d0 /man
parent7eb369e119cbf506e1951d5280e2a6996c6e1d12 (diff)
downloadsos-645b9c98dc8f509839e37055050be4f39d6161d2.tar.gz
[Plugin] Allow selectively disabling postprocessing
Adds two mechanisms by which users can choose to disable postprocessing of collected information. First, is a global method exposed via the `--no-postproc` option. Using this option will skip postprocessing for all plugins. Second, is a per-plugin option exposed via a new 'postproc' plugin option. This is set to _True_ by default (meaning yes, perform postprocessing), which users can set to False or off to disable postprocessing for that plugin only; e.g. `-k podman.postproc=off` Closes: #286 Resolves: #1862 Signed-off-by: Jake Hunsaker <jhunsake@redhat.com>
Diffstat (limited to 'man')
-rw-r--r--man/en/sosreport.111
1 files changed, 11 insertions, 0 deletions
diff --git a/man/en/sosreport.1 b/man/en/sosreport.1
index a885d563..9033b8fc 100644
--- a/man/en/sosreport.1
+++ b/man/en/sosreport.1
@@ -10,6 +10,7 @@ sosreport \- Collect and package diagnostic and support data
[-a|--alloptions] [-v|--verbose]\fR
[-k plug.opt|--plugin-option plug.opt]\fR
[--no-report] [--config-file conf]\fR
+ [--no-postproc]\fR
[--preset preset] [--add-preset add_preset]\fR
[--del-preset del_preset] [--desc description]\fR
[--batch] [--build] [--debug] [--dry-run]\fR
@@ -82,6 +83,16 @@ Disable HTML report writing.
.B \--config-file CONFIG
Specify alternate configuration file.
.TP
+.B \-\-no-postproc
+Disable postprocessing globally for all plugins. This will mean data is not
+obfuscated/sanitized from the archive during collection.
+
+Note that this means data such as password, SSH keys, certificates, etc...
+will be collected in plain text.
+
+To selectively disable postprocessing on a per-plugin basis, use the 'postproc'
+plugin option available to all plugins, e.g. '-k podman.postproc=off'.
+.TP
.B \--preset PRESET
Specify an existing preset to use for sos options.