-
Feature
-
Resolution: Unresolved
-
Major
-
None
-
None
-
Product / Portfolio Work
-
None
-
False
-
-
False
-
None
-
None
-
None
-
None
-
None
-
-
None
-
None
-
None
-
None
Feature Overview (aka. Goal Summary)
Finalize the Azure Hosted Control Plane (HCP) API to ensure it meets all requirements and specifications before the General Availability (GA) of ARO HCP. This review will identify and resolve any missing fields, incorrect API assumptions (such as field length or validations), and ensure a robust and reliable API for managing ARO HCP.
Goals (aka. expected user outcomes)
Upon completion of this review and any necessary fixes, users and client tools (including potential CLIs and UIs) will have a fully functional and reliable API for interacting with the Azure Hosted Control Plane. This ensures a smooth and error-free experience when managing and operating ARO HCP clusters.
Requirements (aka. Acceptance Criteria):
- All necessary fields for managing ARO HCP via the API are present and correctly defined in the API schema.
- API assumptions regarding field lengths, data types, and validations are accurate and enforced correctly by the API.
- The API is reliable and performs consistently as expected under various load conditions.
- The API is maintainable and well-documented for future updates and enhancements.
- The API is user-friendly for developers consuming it, with clear and consistent design.
Deployment considerations
| Deployment Scenario | Applicable Specific Needs |
|---|---|
| Self-managed, managed, or both | Managed (ARO HCP) |
| Classic (standalone cluster) | N/A |
| Hosted control planes | Ensure all HCP-specific API endpoints, request/response structures, and behaviors are reviewed and validated. |
| Multi node, Compact, or SNO | All - the API should support managing HCP regardless of the underlying node configuration. |
| Connected / Restricted Network | Consider potential implications for API access from restricted network environments. |
| Architectures | N/A |
| Operator compatibility | Ensure compatibility with the relevant ARO and HCP operator versions at GA. |
| Backport needed | N/A |
| UI need | The API should support potential UI development for managing HCP. |
| Other | N/A |
Use Cases (Optional):
N/A
Questions to Answer (Optional):
N/A
Out of Scope
- Implementing new API features or enhancements beyond ensuring correctness and completeness for GA.
- Extensive performance optimization of the API at this stage (focus is on functional correctness).
- Development of specific client tools (like a CLI or UI) beyond ensuring the API supports them.
Background
The Azure Hosted Control Plane (HCP) API is a critical component for managing the upcoming General Availability (GA) of Azure Red Hat OpenShift (ARO) HCP. A robust and accurate API is essential for users and tools to effectively manage and interact with these hosted control planes. This review is a final gate to ensure the API is production-ready and aligns with all requirements.
Customer Considerations
Customers relying on automation and integration with ARO will depend on the reliability and correctness of the HCP API. Any inconsistencies or errors in the API could lead to integration issues and a negative user experience. Ensuring a consistent and accurate API is crucial for the successful adoption of ARO HCP.
Documentation Considerations
N/A
Interoperability Considerations
N/A