Feature Overview (aka. Goal Summary)

Facilitate debugging of clusters stuck during the installation process in HyperShift. This feature aims to provide clear, actionable insights into what conditions or issues are blocking cluster installation, thereby significantly reducing the time and effort needed to troubleshoot and resolve these issues.

Goals (aka. expected user outcomes)

The primary outcome is for users, particularly system administrators and (cluster service providers in HCP terminology), to quickly identify and resolve installation blockages in HyperShift clusters. This feature will expand the functionality of the existing status and metrics system to include detailed indicators of installation progress and specific blocking conditions.

Requirements (aka. Acceptance Criteria):

1. Provide clear status messages indicating the current stage of cluster installation.
2. Highlight specific conditions that are blocking the installation, including DNS reachability, certificate generation, and resource quotas.
3. Integrate these indicators into the existing monitoring and metrics systems.
4. Ensure compatibility with self-managed and managed deployments.
5. Support for all architectures: x86_x64, ARM (aarch64), IBM Power (ppc64le), and IBM Z (s390x).
6. Ensure the feature is secure, reliable, maintainable, and scalable.
7. Backport to applicable versions as needed.

Deployment considerations

Use Cases:

• System administrator troubleshooting an installation failure.
• Automated systems monitoring and alerting on installation progress and blockages.
• Post-mortem analysis of installation issues to prevent future occurrences.

Questions to Answer:

• What specific conditions are most commonly blocking cluster installations?
• How can these conditions be automatically detected and reported?
• What level of detail is needed in the status messages to be most useful?

Out of Scope

• Debugging non-installation related issues.
• Integration with third-party monitoring tools beyond the scope of OpenShift Console and OCM.

Background

Current debugging processes for clusters stuck in installation are manual and time-consuming. This feature aims to streamline and improve the efficiency of the debugging process by providing automated, clear insights into blocking conditions.

Documentation Considerations

Detailed documentation on how to interpret new status messages and metrics will be required. This should include troubleshooting guides and examples. Any changes should be reflected in the existing HyperShift and OpenShift documentation.

Interoperability Considerations

This feature impacts HyperShift installations on ROSA, ARO, and self-managed HCP. Interoperability test scenarios should include these environments to ensure consistent behavior and reliability across the portfolio.