OSDOCS-5259: MicroShift sos reports

_topic_maps/_topic_map_ms.yml

@@ -62,6 +62,8 @@ Distros: microshift
 Topics:
 - Name: MicroShift etcd
   File: microshift-etcd
+- Name: MicroShift sos report
+  File: microshift-sos-report
 ---
 Name: API reference
 Dir: microshift_rest_api

microshift_support/microshift-sos-report.adoc

@@ -0,0 +1,22 @@
+:_content-type: ASSEMBLY
+[id="microshift-sos-report"]
+= MicroShift sos report
+include::_attributes/attributes-microshift.adoc[]
+:context: microshift-sos-report
+
+toc::[]
+
+[role="_abstract"]
+`sos` is a tool you can use to collect troubleshooting information about a host. An `sos report` will generate a detailed report with all the enabled plugins and data from the different components and applications in a system.
+
+:FeatureName: MicroShift
+include::snippets/microshift-tech-preview-snip.adoc[leveloffset=+1]
+
+include::modules/microshift-about-sos-reports.adoc[leveloffset=+1]
+include::modules/microshift-gathering-sos-report.adoc[leveloffset=+1]
+
+[role="_additional-resources"]
+[id="additional-resources_microshift-sos-report"]
+== Additional resources
+* link:https://access.redhat.com/solutions/2112[How to provide files to Red Hat Support (vmcore, rhev logcollector, sosreports, heap dumps, log files, etc.]
+* link:https://access.redhat.com/solutions/3592[What is an sos report and how to create one in {op-system-base-full}?]

modules/microshift-about-sos-reports.adoc

@@ -0,0 +1,14 @@
+// Module included in the following assemblies:
+
+// * microshift_support/microshift-sos-report
+
+:_content-type: CONCEPT
+[id="about-microshift-sos-reports_{context}"]
+= About {product-title} sos reports
+
+The `sos` tool is composed of different plugins that will help you gather information from different applications. A {product-title} specific plugin has been added from sos version 4.5.1, and it can gather the following data:
+
+* {product-title} configuration and version
+* YAML output for cluster-wide and system namespaced resources
+* OVN-Kubernetes information
+

modules/microshift-gathering-sos-report.adoc

@@ -0,0 +1,79 @@
+// Module included in the following assemblies:
+
+// * microshift_support/microshift-sos-report
+
+:_content-type: PROCEDURE
+[id="gathering-data-microshift-sos-report_{context}"]
+= Gathering data from a {product-title} sos report
+
+.Prerequisites
+
+* You must have the `sos` package installed.
+
+.Procedure
+
+. Log into the failing host as a root user.
+
+. Perform the debug report creation procedure by running the following command:
++
+[source,terminal]
+----
+$ sos report --batch --clean --all-logs --profile microshift
+----
++
+.Example output
+[source,terminal]
+----
+sosreport (version 4.5.1)
+
+This command will collect diagnostic and configuration information from
+this Red Hat Enterprise Linux system and installed applications.
+
+An archive containing the collected information will be generated in
+/var/tmp/sos.o0sznf_8 and may be provided to a Red Hat support
+representative.
+
+Any information provided to Red Hat will be treated in accordance with
+the published support policies at:
+
+        Distribution Website : https://www.redhat.com/
+        Commercial Support   : https://www.access.redhat.com/
+
+The generated archive may contain data considered sensitive and its
+content should be reviewed by the originating organization before being
+passed to any third party.
+
+No changes will be made to system configuration.
+
+
+ Setting up archive ...
+ Setting up plugins ...
+ Running plugins. Please wait ...
+
+  Starting 1/2   microshift      [Running: microshift]
+  Starting 2/2   microshift_ovn  [Running: microshift microshift_ovn]
+  Finishing plugins              [Running: microshift]
+
+  Finished running plugins
+
+Found 1 total reports to obfuscate, processing up to 4 concurrently
+
+sosreport-microshift-rhel9-2023-03-31-axjbyxw :    Beginning obfuscation...
+sosreport-microshift-rhel9-2023-03-31-axjbyxw :    Obfuscation completed
+
+Successfully obfuscated 1 report(s)
+
+Creating compressed archive...
+
+A mapping of obfuscated elements is available at
+	/var/tmp/sosreport-microshift-rhel9-2023-03-31-axjbyxw-private_map
+
+Your sosreport has been generated and saved in:
+	/var/tmp/sosreport-microshift-rhel9-2023-03-31-axjbyxw-obfuscated.tar.xz
+
+ Size	444.14KiB
+ Owner	root
+ sha256	922e5ff2db25014585b7c6c749d2c44c8492756d619df5e9838ce863f83d4269
+
+Please send this file to your support representative.
+----