Skip to content

Commit 20604e5

Browse files
opayne1opayne1
authored
Merge pull request #57828 from opayne1/OSDOCS-5259
OSDOCS-5259: MicroShift sos reports
2 parents b5f5b13 + 168c5ea commit 20604e5

File tree

4 files changed

+117
-0
lines changed

4 files changed

+117
-0
lines changed

‎_topic_maps/_topic_map_ms.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,8 @@ Distros: microshift
6262
Topics:
6363
- Name: MicroShift etcd
6464
File: microshift-etcd
65+
- Name: MicroShift sos report
66+
File: microshift-sos-report
6567
---
6668
Name: API reference
6769
Dir: microshift_rest_api

‎microshift_support/microshift-sos-report.adoc

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
:_content-type: ASSEMBLY
2+
[id="microshift-sos-report"]
3+
= MicroShift sos report
4+
include::_attributes/attributes-microshift.adoc[]
5+
:context: microshift-sos-report
6+
7+
toc::[]
8+
9+
[role="_abstract"]
10+
`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.
11+
12+
:FeatureName: MicroShift
13+
include::snippets/microshift-tech-preview-snip.adoc[leveloffset=+1]
14+
15+
include::modules/microshift-about-sos-reports.adoc[leveloffset=+1]
16+
include::modules/microshift-gathering-sos-report.adoc[leveloffset=+1]
17+
18+
[role="_additional-resources"]
19+
[id="additional-resources_microshift-sos-report"]
20+
== Additional resources
21+
* link:https://access.redhat.com/solutions/2112[How to provide files to Red Hat Support (vmcore, rhev logcollector, sosreports, heap dumps, log files, etc.]
22+
* 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

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
// Module included in the following assemblies:
2+
3+
// * microshift_support/microshift-sos-report
4+
5+
:_content-type: CONCEPT
6+
[id="about-microshift-sos-reports_{context}"]
7+
= About {product-title} sos reports
8+
9+
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:
10+
11+
* {product-title} configuration and version
12+
* YAML output for cluster-wide and system namespaced resources
13+
* OVN-Kubernetes information
14+

‎modules/microshift-gathering-sos-report.adoc

Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
// Module included in the following assemblies:
2+
3+
// * microshift_support/microshift-sos-report
4+
5+
:_content-type: PROCEDURE
6+
[id="gathering-data-microshift-sos-report_{context}"]
7+
= Gathering data from a {product-title} sos report
8+
9+
.Prerequisites
10+
11+
* You must have the `sos` package installed.
12+
13+
.Procedure
14+
15+
. Log into the failing host as a root user.
16+
17+
. Perform the debug report creation procedure by running the following command:
18+
+
19+
[source,terminal]
20+
----
21+
$ sos report --batch --clean --all-logs --profile microshift
22+
----
23+
+
24+
.Example output
25+
[source,terminal]
26+
----
27+
sosreport (version 4.5.1)
28+
29+
This command will collect diagnostic and configuration information from
30+
this Red Hat Enterprise Linux system and installed applications.
31+
32+
An archive containing the collected information will be generated in
33+
/var/tmp/sos.o0sznf_8 and may be provided to a Red Hat support
34+
representative.
35+
36+
Any information provided to Red Hat will be treated in accordance with
37+
the published support policies at:
38+
39+
Distribution Website : https://www.redhat.com/
40+
Commercial Support : https://www.access.redhat.com/
41+
42+
The generated archive may contain data considered sensitive and its
43+
content should be reviewed by the originating organization before being
44+
passed to any third party.
45+
46+
No changes will be made to system configuration.
47+
48+
49+
Setting up archive ...
50+
Setting up plugins ...
51+
Running plugins. Please wait ...
52+
53+
Starting 1/2 microshift [Running: microshift]
54+
Starting 2/2 microshift_ovn [Running: microshift microshift_ovn]
55+
Finishing plugins [Running: microshift]
56+
57+
Finished running plugins
58+
59+
Found 1 total reports to obfuscate, processing up to 4 concurrently
60+
61+
sosreport-microshift-rhel9-2023-03-31-axjbyxw : Beginning obfuscation...
62+
sosreport-microshift-rhel9-2023-03-31-axjbyxw : Obfuscation completed
63+
64+
Successfully obfuscated 1 report(s)
65+
66+
Creating compressed archive...
67+
68+
A mapping of obfuscated elements is available at
69+
/var/tmp/sosreport-microshift-rhel9-2023-03-31-axjbyxw-private_map
70+
71+
Your sosreport has been generated and saved in:
72+
/var/tmp/sosreport-microshift-rhel9-2023-03-31-axjbyxw-obfuscated.tar.xz
73+
74+
Size 444.14KiB
75+
Owner root
76+
sha256 922e5ff2db25014585b7c6c749d2c44c8492756d619df5e9838ce863f83d4269
77+
78+
Please send this file to your support representative.
79+
----

0 commit comments

Comments
 (0)