-
Story
-
Resolution: Unresolved
-
Undefined
-
None
-
None
-
None
In order to effectively analyze/debug customer issues with Gateway API, all of the relevant data about the underlying OSSM instance must be collected from the customer's cluster, including Gateway API and Sail Operator CRDs, istiod and proxy pod logs, and Envoy config and stats dumps. Fortunately, this functionality already exists in the OSSM Istio must-gather image.
Because the Cluster Ingress Operator (CIO) is a core component of OpenShift, and depends on OSSM for its Gateway API implementation, it is reasonable to fold the OSSM Istio must-gather functionality into the core must-gather image. This provides a simpler UX for support engineers and customers who are troubleshooting customer issues, since they can run one must-gather command to get all relevant data to analyze.
The functionality must work well for the following scenarios:
- customer has OSSM for Gateway API ingress functionality only
- customer has OSSM for service mesh functionality only
- customer has OSSM for Gateway API Ingress + service mesh functionality
- customer does not have OSSM/Gateway API
When implementing, a couple of points to keep in mind:
- Currently, the istio must-gather has the benefit of providing only data needed for debugging OSSM/Istio. This makes it easier to zero in on the relevant information. When incorporating the functionality into core must-gather, it's important to continue to keep data relevant to OSSM/Istio together, rather than spreading it across the entire must-gather output directory structure.
- Core must-gather is versioned in lockstep with OpenShift itself, whereas OSSM is released independently. Any must-gather logic must gracefully handle some OSSM version skew.