-
Feature
-
Resolution: Unresolved
-
Major
-
None
Feature Overview
Goals
Provide a more streamline must gather image for customers with large environments where the current one times out
Requirements
This Section: A list of specific needs or objectives that a Feature must
deliver to satisfy the Feature.. Some requirements will be flagged as MVP.
If an MVP gets shifted, the feature shifts. If a non MVP requirement slips,
it does not shift the feature.
Must gather can call upon subscripts: https://docs.openshift.com/container-platform/4.13/support/gathering-cluster-data.html
| Requirement | Notes | isMvp? |
|---|---|---|
| CI - MUST be running successfully with test automation | This is a requirement for ALL features. |
YES |
| Release Technical Enablement | Provide necessary release enablement details and documents. |
YES |
| Have a script that functions as a gather all information | This is what the must gather does now, but instead of writing it in one script, it will call upon all sub-scripts | YES |
| Have ACM minimal sub-script gather both MCE and necessary ACM info | YES | |
| Have an MCE only sub-script | YES | |
| Have separate sub-scripts for various components | YES | |
| Have an automated way to determine if it's MCE or MCE + ACM and run the appropriate script | YES |
(Optional) Use Cases
This Section:
- Could be used to unify the backplane must gather and the acm must gather.
Questions to answer
- Will this unify the 2 must gathers?
- What will go into the default data collection? I propose the MCE script be the default as calling sub-scripts can be additive, not subtractive
- How will we determine how to split what into which sub-scripts? Application/DR/Lifecycle/Observability/etc?
- Should this be a wholly separate image or should it replace the ACM must gather, or should it replace all images?
Background, and strategic fit
This Section: What does the person writing code, testing, documenting
need to know? What context can be provided to frame this feature?
Assumptions
- Should be able to create a way to call all sub-scripts in order to simplify the information gathering
Customer Considerations
- Provide an easy way to gather all information as most customers can run the must gather as is fine
Documentation Considerations
Questions to be addressed:
- What educational or reference material (docs) is required to support this
product feature? For users/admins? Other functions (security officers, etc)?
-
- The must gather section would need to be amended to call specific sub-scripts for acm and mce.
- Does this feature have a doc impact?
- Yes
- New Content, Updates to existing content, Release Note, or No Doc Impact
- Update to existing content
- If unsure and no Technical Writer is available, please contact Content
Strategy. - What concepts do customers need to understand to be successful in
[action]?- Which subscripts to call for the must gather needed for the case
- How do we expect customers will use the feature? For what purpose(s)?
- Similar with how we use the must gather now, just adding an flag for the script
- What reference material might a customer want/need to complete [action]?
- KCS and documentation
- Is there source material that can be used as reference for the Technical
Writer in writing the content? If yes, please link if available.
