- Proposed title of this feature request
Add argument to default Must Gather collection command to allow collection of data needed for Phased Gates Technical Supportability Review (TSR)
- What is the nature and description of the request?
- TSR consists of 150+ checks executed on OCP Cluster's Must Gather. link
- Default Must Gather file collection command however does not collect all the data needed for executing all the checks in form of PG Insights Rules link
- Hence currently when requesting the customer for sharing data needed for TSR, currently a cluster’s must-gather “quay.io/pg.next/pg-must-gather” is required
- With this request, the additional commands can be replaced with single argument that performs the same function.
For Example:
###############################################
oc adm must-gather *--PG*
###############################################
- Why does the customer need this? (List the business requirements here)
- This would allow Customer to execute simpler command having transparency to the working in the background
- Further it makes it easy for customer IT admins to get security clearance from their management to share data as having standard argument as opposed to customized command, provides more legitimacy and sense of security to the customers.
- Simpler command reduces the risk of customers making manual errors during data collection. This especially for disconnected clusters, where the additional needed image is not available by default.
- As Phased Gates team enhances the list of checks to incorporate feature/components of newer OCP releases, layered products, the logs required to be collected would also increase. These changes would then be only needed to be done internally as extension of what '--PG' argument does without having the need to alter instructions to the customer
- Functionality of the argument further can be moved to DX Engineering team who are co-work with Phased Gates team to develop Phased Gates Insight Rules to execute these checks.
- Most importantly, the scope of Must gather command with the argument is therefore limited to Phased Gates review only and there is no risk/impact to the rest of the Must Gather collections.
As for impact of the Phased Gates reviews overall, below should add more clarity on the same -
- Red Hat’s Phased Gates (PG) program is an internal service for Red Hat associates working with the customers directly. It offers a Technical Supportability Review (TSR), which is a comprehensive assessment of OpenShift clusters to provide a holistic analysis regarding its adherence to supportability and common practices.
- The assessment is triggered against a Must-Gather file and is an automated process using over 150+ Phased Gates Insight Rules that have been created specifically to check all important aspects of an OpenShift Cluster
- This Automated Supportability Review allows PG program to scale at a much larger level, which will in turn drive a deflection in support cases and escalations while providing an easier adoption journey for customers and simplify TAM’s proactive engagement as part of their value added proposition.
- PG Team is currently working directly towards XE OKR 2.3: Increase the total number of OCP Phased Gates by 150% through automation, and have OCP TAMs deliver them to at least 25% of their customers globally.
- This change would allow better customer experience as well as coverage for customers who are sensitive to data being shared with Red Hat.
- List any affected packages or components.
must-gather
Additional Notes:
- Prerequisite of this request is to first implement RFE https://issues.redhat.com/browse/RFE-3817
- In addition to this request for argument for PG Team's data collection, RFE 3817 then further also allows implementation of CLIOT request https://issues.redhat.com/browse/CLIOT-278 (which is similar request for additional argument for Must Gather collection but different in scope)
- is blocked by
-
RFE-3817 Allow must-gather to specify custom scripts/parameters when specifying multiple images
- Backlog
- mentioned on