-
Feature
-
Resolution: Unresolved
-
None
-
None
-
None
-
Product / Portfolio Work
-
-
False
-
-
False
-
None
-
None
-
None
-
None
-
None
-
-
None
-
None
-
None
-
None
Feature Overview (aka. Goal Summary)
Users can easily find product offerings from the observability product portfolio with a new "Observability" category in the OperatorHub (and other RH catalogs).
Goals (aka. expected user outcomes)
Red Hat OpenShift Observability Program is enabling an observability product portfolio beyond the current offerings in core “monitoring” and “logging and tracing” areas such as Network Observability and Power Monitoring (aka Kepler).
A new "Observability" category in the OperatorHub (and other RH catalogs) will be beneficial to align with the branding messages Red Hat OpenShift Observability Program has been evangelizing, and to ensure users can easily access those offerings with better discoverability and clarity.
Ultimately, this will lead to a faster realization of the value-adds of the OpenShift platform.
Requirements (aka. Acceptance Criteria):
- Bundle Validator: A new "Observability" is added as a valid option to OperatorHubValidator in the operator-framework/api so that new operator submissions with a category defined as "Observability" can pass the bundle validation in the build pipeline. This applies to these catalog images:
- Red Hat operator catalog: “registry.redhat.io/redhat/redhat-operator-index:v4.y”
- Certified operator catalog: “registry.redhat.io/redhat/certified-operator-index:v4.y”
- Red Hat marketplace catalog: “registry.redhat.io/redhat/redhat-marketplace-index:v4.y”
- OpenShift community catalog: “registry.redhat.io/redhat/community-operator-index:v4.y”
- Upstream community catalog: “quay.io/operatorhubio/catalog:latest”
- Category option list: A new "Observability" is added as an available option so operator authors know that is a viable category option for their listings.
- for Red Hat operators: https://docs.engineering.redhat.com/display/CFC/Validations#Validations-ToValidatethecommonconfigurationbylintingthebundle
- OperatorHub.io: https://github.com/k8s-operatorhub/community-operators/blob/main/categories.json
- Upstream community operator: https://github.com/redhat-openshift-ecosystem/community-operators-prod/blob/main/categories.json
Use Cases (Optional):
Include use case diagrams, main success scenarios, alternative flow scenarios. Initial completion during Refinement status.
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.
Out of Scope
High-level list of items that are out of scope. Initial completion during Refinement status.
Background
Provide any additional context is needed to frame the feature. Initial completion during Refinement status.
Customer Considerations
Provide any additional customer-specific considerations that must be made when designing and delivering the Feature. Initial completion during Refinement status.
Documentation Considerations
- Category option list: A new "Observability" is added as an available option so operator authors know that is a viable category option for their listings.
- for Red Hat operators: https://docs.engineering.redhat.com/display/CFC/Validations#Validations-ToValidatethecommonconfigurationbylintingthebundle
- OperatorHub.io: https://github.com/k8s-operatorhub/community-operators/blob/main/categories.json
- Upstream community operator: https://github.com/redhat-openshift-ecosystem/community-operators-prod/blob/main/categories.json
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.