Skip to content

Commit 5e00d9d

Browse files
Merge pull request #36031 from MirzWeiss/TELCODOCS-293
TELCODOCS-293: Created new troubleshooting assembly, created new module, updated existing must-gather tool module to state inclusion in new assembly.
2 parents 29a6425 + 03cd3f0 commit 5e00d9d

File tree

4 files changed

+56
-0
lines changed

4 files changed

+56
-0
lines changed

_topic_map.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1930,6 +1930,8 @@ Topics:
19301930
File: uninstalling-sandboxed-containers
19311931
- Name: Upgrade OpenShift sandboxed containers
19321932
File: upgrade-sandboxed-containers
1933+
- Name: Collecting OpenShift sandboxed containers data for Red Hat Support
1934+
File: troubleshooting-sandboxed-containers
19331935
---
19341936
Name: Logging
19351937
Dir: logging

modules/about-must-gather.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
// * serverless/serverless-support.adoc
66
// * service_mesh/v1x/servicemesh-release-notes.adoc
77
// * service_mesh/v2x/servicemesh-release-notes.adoc
8+
// * troubleshooting-sandboxed-containers.adoc
89

910
[id="about-must-gather_{context}"]
1011
= About the must-gather tool
Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * sandboxed_containers/troubleshooting-sandboxed-containers.adoc
4+
5+
//This file contains UI elements and/or package names that need to be updated.
6+
7+
[id="sandboxed-containers-collecting-data_{context}"]
8+
= About collecting {sandboxed-containers-first} data
9+
10+
You can use the `oc adm must-gather` CLI command to collect information about your cluster. The following features and objects are associated with {sandboxed-containers-first}:
11+
12+
* All namespaces and their child objects that belong to any {sandboxed-containers-first}
13+
resources
14+
* All {sandboxed-containers-first} custom resource definitions (CRDs)
15+
16+
The `oc adm must-gather` CLI command collects the following component logs:
17+
18+
* QEMU logs
19+
* Audit logs
20+
* {sandboxed-containers-first} logs
21+
* CRI-O logs
22+
23+
These component logs are collected as long as there is at least one pod running with the `kata` runtime.
24+
25+
To collect {sandboxed-containers-first} data with `must-gather`, you must specify the
26+
{sandboxed-containers-first} image:
27+
`--image=registry.redhat.io/openshift-sandboxed-containers-1.1.0/osc-must-gather:1.1.0`.
Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
[id="troubleshooting-sandboxed-containers"]
2+
= Collecting {sandboxed-containers-first} data for Red Hat Support
3+
include::modules/common-attributes.adoc[]
4+
:context: troubleshooting-sandboxed-containers
5+
6+
toc::[]
7+
8+
[role="_abstract"]
9+
10+
When opening a support case, it is helpful to provide debugging
11+
information about your cluster to Red Hat Support.
12+
13+
The `must-gather` tool enables you to collect diagnostic information about your
14+
{product-title} cluster, including virtual machines and other data related to
15+
{sandboxed-containers-first}.
16+
17+
For prompt support, supply diagnostic information for both {product-title}
18+
and {sandboxed-containers-first}.
19+
20+
include::modules/about-must-gather.adoc[leveloffset=+1]
21+
22+
include::modules/sandboxed-containers-collecting-data.adoc[leveloffset=+1]
23+
24+
[id="{context}_additional-resources"]
25+
== Additional resources
26+
* For more information about gathering data for support, see xref:../support/gathering-cluster-data.adoc#gathering-cluster-data[Gathering data about your cluster].

0 commit comments

Comments
 (0)