Skip to content

Commit 6266219

Browse files
abrennan89abrennan89
authored
Merge pull request #93796 from abrennan89/OSDOCS-13960
OSDOCS-13960: Add kueue support docs
2 parents 020d771 + e7de3dc commit 6266219

File tree

9 files changed

+112
-0
lines changed

9 files changed

+112
-0
lines changed

‎_topic_maps/_topic_map.yml

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,15 @@ Topics:
5656
- Name: Using cohorts
5757
File: using-cohorts
5858
---
59+
Name: Support
60+
Dir: support
61+
Distros: openshift-kueue
62+
Topics:
63+
- Name: Getting support
64+
File: getting-support
65+
# - Name: Troubleshooting
66+
# File: troubleshooting
67+
---
5968
Name: Develop
6069
Dir: develop
6170
Distros: openshift-kueue

‎modules/gathering-cluster-data.adoc

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * support/getting-support.adoc
4+
5+
:_mod-docs-content-type: PROCEDURE
6+
[id="gathering-cluster-data_{context}"]
7+
= Collecting data for Red Hat Support
8+
9+
You can use the `oc adm must-gather` CLI command to collect the information about your {product-title} instance that is most likely needed for debugging issues, including:
10+
11+
* {product-title} custom resources, such as workloads, cluster queues, local queues, resource flavors, admission checks, and their corresponding cluster resource definitions (CRDs)
12+
* Services
13+
* Endpoints
14+
* Webhook configurations
15+
* Logs from the `openshift-kueue-operator` namespace and `kueue-controller-manager` pods
16+
17+
Collected data is written into a new directory named `must-gather/` in the current working directory by default.
18+
19+
.Prerequisites
20+
21+
* The {product-title} Operator is installed on your cluster.
22+
* You have installed the {oc-first}.
23+
24+
.Procedure
25+
26+
. Navigate to the directory where you want to store the `must-gather` data.
27+
28+
. Collect `must-gather` data by running the following command:
29+
+
30+
[source,terminal]
31+
----
32+
$ oc adm must-gather \
33+
--image=registry.redhat.io/kueue/kueue-must-gather-rhel9:<version>
34+
----
35+
+
36+
Where `<version>` is your current version of {product-title}.
37+
38+
. Create a compressed file from the `must-gather` directory that was just created in your working directory. Make sure you provide the date and cluster ID for the unique `must-gather` data. For more information about how to find the cluster ID, see link:https://access.redhat.com/solutions/5280291[How to find the cluster-id or name on OpenShift cluster].
39+
40+
. Attach the compressed file to your support case on the link:https://access.redhat.com/support/cases/#/case/list[the *Customer Support* page] of the Red{nbsp}Hat Customer Portal.

‎modules/modules

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../modules/

‎support/_attributes

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../_attributes/

‎support/getting-support.adoc

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
:_mod-docs-content-type: ASSEMBLY
2+
include::_attributes/common-attributes.adoc[]
3+
[id="getting-support"]
4+
= Getting support
5+
:context: getting-support
6+
7+
toc::[]
8+
9+
If you experience difficulty with a procedure described in this documentation, or with {product-title} in general, visit the link:http://access.redhat.com[Red{nbsp}Hat Customer Portal].
10+
11+
From the Customer Portal, you can:
12+
13+
* Search or browse through the Red{nbsp}Hat Knowledgebase of articles and solutions relating to Red{nbsp}Hat products.
14+
* Submit a support case to Red{nbsp}Hat Support.
15+
* Access other product documentation.
16+
17+
[id="getting-support-rh-kb"]
18+
== About the Red Hat Knowledgebase
19+
20+
The link:https://access.redhat.com/knowledgebase[Red{nbsp}Hat Knowledgebase] provides rich content aimed at helping you make the most of Red{nbsp}Hat's products and technologies. The Red{nbsp}Hat Knowledgebase consists of articles, product documentation, and videos outlining best practices on installing, configuring, and using Red{nbsp}Hat products. In addition, you can search for solutions to known issues, each providing concise root cause descriptions and remedial steps.
21+
22+
include::modules/gathering-cluster-data.adoc[leveloffset=+1]
23+
24+
[id="getting-support-additional-resources"]
25+
[role="_additional-resources"]
26+
== Additional resources
27+
* link:https://docs.redhat.com/en/documentation/openshift_container_platform/latest/html/support/index[{platform} support documentation]

‎support/images

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../images/

‎support/modules

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../modules/

‎support/snippets

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../snippets/

‎support/troubleshooting.adoc

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
:_mod-docs-content-type: ASSEMBLY
2+
include::_attributes/common-attributes.adoc[]
3+
[id="troubleshooting"]
4+
= Troubleshooting
5+
:context: troubleshooting
6+
7+
toc::[]
8+
9+
// commented out - note for TS docs
10+
11+
// Troubleshooting installations
12+
// Verifying node health
13+
// Troubleshooting network issues
14+
// Troubleshooting Operator issues
15+
// Investigating pod issues
16+
// Diagnosing CLI issues
17+
////
18+
Troubleshooting Jobs
19+
Troubleshooting the status of a Job
20+
21+
Troubleshooting Queues
22+
Troubleshooting the status of a LocalQueue or ClusterQueue
23+
24+
Troubleshooting Provisioning Request in Kueue
25+
Troubleshooting the status of a Provisioning Request in Kueue
26+
27+
Troubleshooting Pods
28+
Troubleshooting the status of a Pod or group of Pods
29+
30+
Troubleshooting delete ClusterQueue
31+
////

0 commit comments

Comments
 (0)