Skip to content

Commit 3fdc172

Browse files
committed
Add must gather script enhancement doc
Signed-off-by: Shiv Verma <[email protected]>
1 parent 5d72237 commit 3fdc172

File tree

1 file changed

+68
-0
lines changed

1 file changed

+68
-0
lines changed

enhancements/opc-must-gather.md

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
---
2+
status: proposed
3+
title: Improvement in the must gather script
4+
creation-date: "2023-04-03"
5+
last-updated: "2023-04-03"
6+
authors: ["shverma"]
7+
---
8+
9+
# Must-Gather Enhancement
10+
11+
Must-Gather is a tool built on top of [Openshift must-gather](https://github.com/openshift/must-gather) that gathers openshift-pipelines debug information
12+
13+
<!-- toc -->
14+
15+
- [Summary](#summary)
16+
- [Motivation](#motivation)
17+
- [Goals](#goals)
18+
- [Non-Goals](#non-goals)
19+
- [Proposal](#proposal)
20+
- [Alternatives](#alternatives)
21+
- [References (optional)](#references-optional)
22+
<!-- /toc -->
23+
24+
## Summary
25+
26+
`must-gather` is a tool(basically a script) built on top of [Openshift must-gather](https://github.com/openshift/must-gather) to gather openshift pipelines debug information.
27+
28+
Customers or users can attach or share openshift pipelines debug information to support the case and this debug information will be helpful for support team or developer to understand the issue of failure.
29+
30+
## Motivation
31+
32+
To gather pipelines debug information with all details including the errors from the cluster and will help customers and users to understand the issue easily.
33+
34+
### Goals
35+
36+
- Enhance the logs of must gather script
37+
- Collects the errors of must gather script in a separate file
38+
- Collect the cluster informations
39+
- Collect the installed tekton components informations
40+
- Integrate must-gather with [Openshift Pipeline CLI](https://github.com/openshift-pipelines/opc)
41+
42+
### Non-Goals
43+
44+
- Show debug information on Web console
45+
46+
### Proposal
47+
48+
#### Gather pipeline debug information from target namespace
49+
50+
Current must gather script gathers pipelines debug information from all namespaces api resources of component across cluster and we can update must gather script to get the pipelines debug information
51+
from the target namespace.
52+
53+
#### Pros
54+
55+
- Will require less time and effort to find issue from debug information
56+
57+
#### Cons
58+
59+
- Doesn't support in the Openshift CLI
60+
- Might be implementable in the Openshift Pipeline CLI and must gather integration
61+
62+
## Alternatives
63+
64+
- `opc adm must-gather` Openshift Pipelines CLI to gather pipelines debug information
65+
66+
## References (optional)
67+
68+
- [Openshift Pipelines must-gather](https://github.com/openshift-pipelines/must-gather)

0 commit comments

Comments
 (0)