Azure
Add Azure Red Hat OpenShift 2024-08-12-preview API version
ARM (Control Plane) API Specification Update Pull Request
[!TIP] Overwhelmed by all this guidance? See the
Getting helpsection at the bottom of this PR description.
PR review workflow diagram
Please understand this diagram before proceeding. It explains how to get your PR approved & merged.
Purpose of this PR
What's the purpose of this PR? Check the specific option that applies. This is mandatory!
- [ ] New resource provider.
- [x] New API version for an existing resource provider. (If API spec is not defined in TypeSpec, the PR should have been created in adherence to OpenAPI specs PR creation guidance).
- [ ] Update existing version for a new feature. (This is applicable only when you are revising a private preview API version.)
- [ ] Update existing version to fix OpenAPI spec quality issues in S360.
- [ ] Convert existing OpenAPI spec to TypeSpec spec (do not combine this with implementing changes for a new API version).
- [ ] Other, please clarify:
- edit this with your clarification
Due diligence checklist
To merge this PR, you must go through the following checklist and confirm you understood and followed the instructions by checking all the boxes:
- [x] I confirm this PR is modifying Azure Resource Manager (ARM) related specifications, and not data plane related specifications.
- [x] I have reviewed following Resource Provider guidelines, including
ARM resource provider contract and
REST guidelines (estimated time: 4 hours).
I understand this is required before I can proceed to the diagram Step 2, "ARM API changes review", for this PR.
Additional information
Viewing API changes
For convenient view of the API changes made by this PR, refer to the URLs provided in the table
in the Generated ApiView comment added to this PR. You can use ApiView to show API versions diff.
Suppressing failures
If one or multiple validation error/warning suppression(s) is detected in your PR, please follow the suppressions guide to get approval.
Getting help
- First, please carefully read through this PR description, from top to bottom. Please fill out the
Purpose of this PRandDue diligence checklist. - If you don't have permissions to remove or add labels to the PR, request
write accessper aka.ms/azsdk/access#request-access-to-rest-api-or-sdk-repositories - To understand what you must do next to merge this PR, see the
Next Steps to Mergecomment. It will appear within few minutes of submitting this PR and will continue to be up-to-date with current PR state. - For guidance on fixing this PR CI check failures, see the hyperlinks provided in given failure and https://aka.ms/ci-fix.
- For help with ARM review (PR workflow diagram Step 2), see https://aka.ms/azsdk/pr-arm-review.
- If the PR CI checks appear to be stuck in
queuedstate, please add a comment with contents/azp run. This should result in a new comment denoting aPR validation pipelinehas started and the checks should be updated after few minutes. - If the help provided by the previous points is not enough, post to https://aka.ms/azsdk/support/specreview-channel and link to this PR.
Next Steps to Merge
✅ All automated merging requirements have been met! To get your PR merged, see aka.ms/azsdk/specreview/merge.![openapi-pipeline-app[bot] avatar](https://avatars.githubusercontent.com/in/65541?v=4 "Published by a pub.dev verified publisher"){kind=small}
Generated ApiView
| Language | Package Name | ApiView Link |
|---|---|---|
| Go | sdk/resourcemanager/redhatopenshift/armredhatopenshift | https://apiview.dev/Assemblies/Review/df1417fb7f4340f5870d566ba177285c?revisionId=9e49968b5f0d487bb00090a42c4767a7 |
![azure-pipelines[bot] avatar](https://avatars.githubusercontent.com/in/9426?v=4 "Published by a pub.dev verified publisher"){kind=small}
This PR had a previous ARM sign-off, but I added 2 new commits, so I'm re-adding the WaitForARMFeedback label here - please take a look and let me know if anything needs to be adjusted. I believe that the Swagger SpellCheck can be disregarded.
"PlatformWorkloadIdentityRoleSetUpdate": {
It's almost the same as PlatformWorkloadIdentityRoleSetUpdate (except it doesn't have the allOf) and it doesn't seem to be used.
Refers to: specification/redhatopenshift/resource-manager/Microsoft.RedHatOpenShift/openshiftclusters/preview/2024-08-12-preview/redhatopenshift.json:2507 in 7838b6a. [](commit_id = 7838b6a246f5be0970df7f5c1283ecbd0022a002, deletion_comment = False)
@gary-x-li where are you seeing the extra/unused PlatformWorkloadIdentityRoleSetUpdate? I only see PlatformWorkloadIdentityRoleSetUpdate appear once in the generated swagger file (specification/redhatopenshift/resource-manager/Microsoft.RedHatOpenShift/openshiftclusters/preview/2024-08-12-preview/redhatopenshift.json) and only in the latest commit d2f1c82 (not in the referenced commit https://github.com/Azure/azure-rest-api-specs/commit/7838b6a246f5be0970df7f5c1283ecbd0022a002)
"$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
you should use the latest version of common types #Resolved
Refers to: specification/redhatopenshift/resource-manager/Microsoft.RedHatOpenShift/openshiftclusters/preview/2024-08-12-preview/redhatopenshift.json:29 in d2f1c82. [](commit_id = d2f1c82be0d77127469ba5d064b283e9c2a93ad1, deletion_comment = False)
"Identity": {
Why are you not using the ManagedServiceIdentity from common-types?
Refers to: specification/redhatopenshift/resource-manager/Microsoft.RedHatOpenShift/openshiftclusters/preview/2024-08-12-preview/redhatopenshift.json:1947 in d2f1c82. [](commit_id = d2f1c82be0d77127469ba5d064b283e9c2a93ad1, deletion_comment = False)
"Identity": {Why are you not using the ManagedServiceIdentity from common-types?
Refers to: specification/redhatopenshift/resource-manager/Microsoft.RedHatOpenShift/openshiftclusters/preview/2024-08-12-preview/redhatopenshift.json:1947 in d2f1c82. [](commit_id = d2f1c82, deletion_comment = False)
I saw also that you are defining an Identity similar with the ManagedServiceIdentity one.
PR validation pipeline can not start as the pull request is not merged or mergeable - most likely it has merge conflicts.
@mikekistler do you mind taking another look at the breaking changes? They are all still related to our migration from common-types v3 to common-types v6, with the exception of the removal of systemData where it was not required and included in previous versions in error.
@cadenmarchese Pls come to Breaking Change office hours next Monday at 10AM PT to discuss these changes. I have concerns with the RemovedProperty and AddedRequiredProperty issues flagged in the Breaking Changes report.
API change check
APIView has identified API level changes in this PR and created following API reviews.
Microsoft.RedHatOpenShift-openshiftclusters
@cadenmarchese - Earlier commits in this PR were signed off by ARM, but currently none of those commits are in the PR (it only has 9 commits, all later and showing all newly added files). There is no way to tell what was reviewed and what wasn't. Also, the APIs currently in the PR cannot be signed off: there are many blocking issues that need to be addressed. I've left review comments. #Closed
I've resolved comments from @mentat9 - now my question is whether or not I need to suppress the Swagger Avocado failure (see comment https://github.com/Azure/azure-rest-api-specs/pull/30004#discussion_r1887283477)
In any case, re-review from the ARM team is much appreciated.