-
Notifications
You must be signed in to change notification settings - Fork 5.6k
Azure RedHat OpenShift 2022-09-04 #20463
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
|
Hi, @ross-bryan Thanks for your PR. I am workflow bot for review process. Here are some small tips. Any feedback about review process or workflow bot, pls contact swagger and tools team. vscswagger@microsoft.com |
Swagger Validation Report
|
Swagger Generation Artifacts
|
|
Swagger pipeline restarted successfully. If there is ApiView generated, it will be updated in this comment. |
|
Thank you for your contribution ross-bryan! We will review the pull request and get back to you soon. |
|
Hi @ross-bryan, Your PR has some issues. Please fix the CI sequentially by following the order of
|
|
Hi, @ross-bryan your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board(armapireview@microsoft.com). |
8276d30 to
95df640
Compare
95df640 to
f961d3f
Compare
|
Pleae follow the instructions in the checklist before sumitting the PR. This PR is not created correctly : In reply to: 1232049880 |
|
Please ensure to respond feedbacks from the ARM API reviewer. When you are ready to continue the ARM API review, please remove |
45fe07a to
de4e973
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
we want it to be a GET request - the idea is for the ARO service to provide same command as AKS, they have az aks get-versions and we are working on implementing the az aro get-versions equivalent.
I am trying to see more of how AKS achieved this, it looks like the endpoint for their command is as follows:
'https://management.azure.com/subscriptions/fe16a035-e540-4ab7-80d9-373fa9a3d6ae/providers/Microsoft.ContainerService/locations/eastus/orchestrators?api-version=2019-04-01&resource-type=managedClusters'
is the orchestrators an ARM resource? I see this for AKS service https://github.com/Azure/azure-rest-api-specs/blob/3ec782ff73d2c35f23978d2c6738cc9c85016531/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2022-06-01/managedClusters.json#L2699-L2703
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@raosuhas can you review my response here?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
we are trying to discourage RPs from using this model
For your scenario you can achieve pretty much the same thing by modelling this as a GET on a collection of "installVersions" i.e
GET ...crosoft.RedHatOpenShift/locations/{location}/installversions"
THis returns a paginated response like so : https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/resource-api-reference.md#pagination
and each entry of the value array is a Proxy resource of the "InstallVersion" type. The only difference from the AKS model is that each installVersion is a Proxy ARM type.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@raosuhas I have refactored my code and api /swagger definition such that this is a GET request which returns a List of OpenShiftVersion's that are available.
Can you please review? I do not seem to be able to edit the labels on the PR
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@ross-bryan I think @raosuhas is also suggesting changing the path to /installversions, so in this case the resource type is "InstallVersion"
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@raosuhas @leni-msft We have changed this resource path to
GET ...crosoft.RedHatOpenShift/locations/{location}/openshiftversions"
...topenshift/resource-manager/Microsoft.RedHatOpenShift/stable/2022-09-04/redhatopenshift.json
Outdated
Show resolved
Hide resolved
|
Hi @ross-bryan, one or multiple breaking change(s) is detected in your PR. Please check out the breaking change(s), and provide business justification in the PR comment and @ PR assignee why you must have these change(s), and how external customer impact can be mitigated. Please ensure to follow breaking change policy to request breaking change review and approval before proceeding swagger PR review. |
@ventifus Does your service return 201? if so, you must define 201 in swagger. To workaround the lint error, we can suppress it. See https://dev.azure.com/azure-sdk/internal/_wiki/wikis/internal.wiki/85/Swagger-Suppression-Process
+@jianyexi to check the logic |
|
HI @leni-msft Going back to the "pattern" restrictions and the resulting breaking change, I joined the Breaking Change office hours and they advised that the requirement for pattern restrictions is just a "staging" check and that we should not implement them at this time. (Also they noted that the client does not perform validation and so the restrictions would not have any effect anyway.) I'll submit a new commit reverting the pattern restrictions. Regarding the 201 responses, yes we had originally designed our API to return 201 Created for PUT requests as that made the most sense. We would prefer to use 201, I will look into the suppression process. |
|
Hi @ross-bryan, one or multiple breaking change(s) is detected in your PR. Please check out the breaking change(s), and provide business justification in the PR comment and @ PR assignee why you must have these change(s), and how external customer impact can be mitigated. Please ensure to follow breaking change policy to request breaking change review and approval before proceeding swagger PR review. |
|
@leni-msft I have removed the pattern restrictions and restored the 201 Created responses for our PUTs. Since both of these are staging checks, do we still need to go through the swagger suppression process? The regular "Swagger LintDiff" is reporting green. |
You're right, no need for the staging lint check. |
|
/azp run |
|
Azure Pipelines successfully started running 1 pipeline(s). |
|
@jianyexi @leni-msft can we get an approval here? This PR has been open for many many weeks now. We are delayed on delivering highly demanded features such as multi-version support because of this PR pending approval. Please either request changes, or grant us your blessings and approval 🙏 |
Hi @ross-bryan , this PR is blocked on ARM review. I will merge this PR after ARM sign-off. |
|
Looks like this is not getting an ARM review because it still has the tag ARMChangesRequested. I don't have permissions to remove it, @leni-msft @raosuhas can you help? |
| "description": "The Syncsets properties", | ||
| "x-ms-client-flatten": true | ||
| }, | ||
| "systemData": { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@rkmanda It is our intention that this systemData property is the Azure system metadata. In that context, should the systemData property be omitted from the swagger entirely?
https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-contracts.md#system-metadata-for-all-azure-resources
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I looked in the repo for other users of systemData, and our definitions seem to match theirs. Compare with adp.json DataPoolPatch and used in a PATCH method here.
|
Please close this PR in favor of #21248. |

ARM API Information (Control Plane)
MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.
Azure 1st Party Service can try out the Shift Left experience to initiate API design review from ADO code repo. If you are interested, may request engineering support by filling in with the form https://aka.ms/ShiftLeftSupportForm.
Changelog
Add a changelog entry for this PR by answering the following questions:
September 7th
September 20th
Contribution checklist (MS Employees Only):
If any further question about AME onboarding or validation tools, please view the FAQ.
ARM API Review Checklist
Otherwise your PR may be subject to ARM review requirements. Complete the following:
Check this box if any of the following apply to the PR so that the label "ARMReview" and "WaitForARMFeedback" will be added by bot to kick off ARM API Review. Missing to check this box in the following scenario may result in delays to the ARM manifest review and deployment.
Ensure you've reviewed following guidelines including ARM resource provider contract and REST guidelines. Estimated time (4 hours). This is required before you can request review from ARM API Review board.
If you are blocked on ARM review and want to get the PR merged with urgency, please get the ARM oncall for reviews (RP Manifest Approvers team under Azure Resource Manager service) from IcM and reach out to them.
Breaking Change Review Checklist
If you have any breaking changes as defined in the Breaking Change Policy, request approval from the Breaking Change Review Board.
Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Additional details on the process and office hours are on the Breaking Change Wiki.
NOTE: To update API(s) in public preview for over 1 year (refer to Retirement of Previews)
Please follow the link to find more details on PR review process.