-
Feature
-
Resolution: Unresolved
-
Normal
-
None
-
None
-
Product / Portfolio Work
-
None
-
100% To Do, 0% In Progress, 0% Done
-
False
-
-
False
-
None
-
None
-
None
-
None
-
-
None
-
None
-
None
-
None
Feature Overview (aka. Goal Summary)
An elevator pitch (value statement) that describes the Feature in a clear, concise way. Complete during New status.
When using the `oc-mirror` tool, it should be clear which version of the tool is supported and how compatible it is with the currently supported OCP versions without guessing.
Goals (aka. expected user outcomes)
The observable functionality that the user now has as a result of receiving this feature. Include the anticipated primary user type/persona and which existing features, if any, will be expanded. Complete during New status.
We should have a clear support policy for oc-mirror tool and OCP versions. This support policy will define clearly and without guesses:
(1) which version of the tool is supported today
(2) which OCP versions this version of oc-mirror is compatible/supported with.
We need to have a support matrix tested by QE reflecting this support policy.
As a cluster admin using oc-mirror to mirror OCP registry I need to know which version of oc-mirror I should use for the desired version of OCP in my disconnected environment and also where to get that version.
As a software developer I need to know what are my obligations to the customer - which versions of the tool need to have bugfixes and CVEs, and which versions are out of support.
As a Red Hat employee working with customers using oc-mirror I need to have clarity about support configurations to ensure we provide the required support to our customers defined by the support policy.
Requirements (aka. Acceptance Criteria):
A list of specific needs or objectives that a feature must deliver in order to be considered complete. Be sure to include nonfunctional requirements such as security, reliability, performance, maintainability, scalability, usability, etc. Initial completion during Refinement status.
<enter general Feature acceptance here>
- We have a written policy in our public docs explaining how the tool is supported.
- We have the required tests in place to assure the compatibility matrix is provided.
- We adjust our development practices to adhere with the agreed on policy -> this means decoupling from OCP payload.
Anyone reviewing this Feature needs to know which deployment configurations that the Feature will apply to (or not) once it's been completed. Describe specific needs (or indicate N/A) for each of the following deployment scenarios. For specific configurations that are out-of-scope for a given release, ensure you provide the OCPSTRAT (for the future to be supported configuration) as well.
| Deployment considerations | List applicable specific needs (N/A = not applicable) |
| Self-managed, managed, or both | Self-managed |
| Classic (standalone cluster) | yes |
| Hosted control planes | no |
| Multi node, Compact (three node), or Single node (SNO), or all | all |
| Connected / Restricted Network | restricted |
| Architectures, e.g. x86_x64, ARM (aarch64), IBM Power (ppc64le), and IBM Z (s390x) | all |
| Operator compatibility | yes |
| Backport needed (list applicable versions) | maybe |
| UI need (e.g. OpenShift Console, dynamic plugin, OCM) | maybe |
| Other (please specify) | documentation |
Use Cases (Optional):
Include use case diagrams, main success scenarios, alternative flow scenarios. Initial completion during Refinement status.
Today it is very confusing which version of oc-mirror is supported. In the docs we tell download the version from console.redhat.com, which is version agnostic and it holds only one version available for download - latest. For instance - if the latest version of OCP today is 4.20.1 -> that will be the version of oc-mirror available to download.
However, since oc-mirror is shipped with core OCP payload, it is shipped with every single z-stream of all supported OCP versions.
Exact problem we have today: customers want to use oc-mirror v2 with OCP 4.16. That version had only TP status of v2. However, it has GA-ed in 4.18. Is it ok for the customer to use the GA-ed version with 4.16 or not? Especially since it is the one available for download. Unclear. Support exceptions are filed to address this. Other customers and field complain about this unclarity as well.
Questions to Answer (Optional):
Include a list of refinement / architectural questions that may need to be answered before coding can begin. Initial completion during Refinement status.
Should we consider decoupling oc-mirror from OCP payload? What are the advantages and disadvantages of this? If we stick with the current model, how can we ensure that customers can safely use the latest oc-mirror? Tests need to be added and documentation needs to be updated.
Out of Scope
High-level list of items that are out of scope. Initial completion during Refinement status.
<your text here>
Background
Provide any additional context is needed to frame the feature. Initial completion during Refinement status.
<your text here>
Customer Considerations
Provide any additional customer-specific considerations that must be made when designing and delivering the Feature. Initial completion during Refinement status.
<your text here>
Documentation Considerations
Provide information that needs to be considered and planned so that documentation will meet customer needs. If the feature extends existing functionality, provide a link to its current documentation. Initial completion during Refinement status.
<your text here>
Interoperability Considerations
Which other projects, including ROSA/OSD/ARO, and versions in our portfolio does this feature impact? What interoperability test scenarios should be factored by the layered products? Initial completion during Refinement status.
<your text here>