Skip to content
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

Goutham mn redhatopenshift microsoft.red hat open shift 2023 09 04 #25711

Merged

Conversation

gouthamMN
Copy link
Contributor

@gouthamMN gouthamMN commented Sep 7, 2023

ARM (Control Plane) API Specification Update Pull Request

PR review workflow diagram

Please understand this diagram before proceeding. It explains how to get your PR approved & merged.

diagram

[1] ARM review queue (for merge queues, see [4])
The PRs are processed by time opened, ascending. Your PR may show up on 2nd or later page.
If you addressed Step 1 from the diagram and your PR is not showing up in the queue, ensure the label ARMChangesRequested
is removed from your PR. This should cause the label WaitForARMFeedback to be added.
[2] https://aka.ms/azsdk/support/specreview-channel
[3] List of SDK breaking changes approvers in pinned Teams announcement
[4] public repo merge queue, private repo merge queue (for ARM review queue, [1])

If you need further help with anything, see Getting help section below.

Purpose of this PR

What's the purpose of this PR? Check all that apply. This is mandatory!

  • New API version. (Such PR should have been generated with OpenAPI Hub, per this wiki doc.)
  • 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 swagger quality issues in S360.
  • 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:

Breaking changes review (Step 1)

  • If the automation determines you have breaking changes, i.e. Step 1 from the diagram applies to you,
    you must follow the breaking changes process.
    IMPORTANT This applies even if:
    • The tool fails while it shouldn't, e.g. due to runtime exception, or incorrect detection of breaking changes.
    • You believe there is no need for you to request breaking change approval, for any reason.
      Such claims must be reviewed, and the process is the same.

ARM API changes review (Step 2)

  • If this PR is in purview of ARM review then automation will add the ARMReview label.
  • If you want to force ARM review, add the label yourself.
  • Proceed according to the diagram at the top of this comment.

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
Swagger-Suppression-Process
to get approval.

Getting help

@openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Sep 7, 2023

Next Steps to Merge

✔️ All automated merging requirements have been met! Refer to step 4 in the PR workflow diagram (even if your PR is for data plane, not ARM).

@openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Sep 7, 2023

Swagger Validation Report

️️✔️BreakingChange succeeded [Detail] [Expand]
There are no breaking changes.
️❌Breaking Change(Cross-Version): 4 Errors, 5 Warnings failed [Detail]
compared swaggers (via Oad v0.10.4)] new version base version
redhatopenshift.json 2023-09-04(43cd5b5) 2023-04-01(main)
redhatopenshift.json 2023-09-04(43cd5b5) 2023-07-01-preview(main)

The following breaking changes are detected by comparison with the latest stable version:

Rule Message
1023 - TypeFormatChanged The new version has a different format than the previous one.
New: Microsoft.RedHatOpenShift/stable/2023-09-04/redhatopenshift.json#L2512:9
Old: Microsoft.RedHatOpenShift/stable/2023-04-01/redhatopenshift.json#L2483:9
1023 - TypeFormatChanged The new version has a different format than the previous one.
New: Microsoft.RedHatOpenShift/stable/2023-09-04/redhatopenshift.json#L2521:9
Old: Microsoft.RedHatOpenShift/stable/2023-04-01/redhatopenshift.json#L2491:9
1048 - AddedXmsEnum The new version adds a x-ms-enum extension.
New: Microsoft.RedHatOpenShift/stable/2023-09-04/redhatopenshift.json#L2068:9
Old: Microsoft.RedHatOpenShift/stable/2023-04-01/redhatopenshift.json#L2064:9
1048 - AddedXmsEnum The new version adds a x-ms-enum extension.
New: Microsoft.RedHatOpenShift/stable/2023-09-04/redhatopenshift.json#L2252:5
Old: Microsoft.RedHatOpenShift/stable/2023-04-01/redhatopenshift.json#L2227:5


The following breaking changes are detected by comparison with the latest preview version:

Rule Message
⚠️ 1006 - RemovedDefinition The new version is missing a definition that was found in the old version. Was 'LoadBalancerProfile' removed or renamed?
New: Microsoft.RedHatOpenShift/stable/2023-09-04/redhatopenshift.json#L1736:3
Old: Microsoft.RedHatOpenShift/preview/2023-07-01-preview/redhatopenshift.json#L1736:3
⚠️ 1006 - RemovedDefinition The new version is missing a definition that was found in the old version. Was 'ManagedOutboundIPs' removed or renamed?
New: Microsoft.RedHatOpenShift/stable/2023-09-04/redhatopenshift.json#L1736:3
Old: Microsoft.RedHatOpenShift/preview/2023-07-01-preview/redhatopenshift.json#L1736:3
⚠️ 1033 - RemovedProperty The new version is missing a property found in the old version. Was 'loadBalancerProfile' renamed or removed?
New: Microsoft.RedHatOpenShift/stable/2023-09-04/redhatopenshift.json#L1980:7
Old: Microsoft.RedHatOpenShift/preview/2023-07-01-preview/redhatopenshift.json#L2042:7
⚠️ 1048 - AddedXmsEnum The new version adds a x-ms-enum extension.
New: Microsoft.RedHatOpenShift/stable/2023-09-04/redhatopenshift.json#L2068:9
Old: Microsoft.RedHatOpenShift/preview/2023-07-01-preview/redhatopenshift.json#L2130:9
⚠️ 1048 - AddedXmsEnum The new version adds a x-ms-enum extension.
New: Microsoft.RedHatOpenShift/stable/2023-09-04/redhatopenshift.json#L2252:5
Old: Microsoft.RedHatOpenShift/preview/2023-07-01-preview/redhatopenshift.json#L2315:5
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️️✔️LintDiff succeeded [Detail] [Expand]
Validation passes for LintDiff.
compared tags (via openapi-validator v2.1.5) new version base version
package-2023-09-04 package-2023-09-04(43cd5b5) default(main)
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️SwaggerAPIView succeeded [Detail] [Expand]
️️✔️TypeSpecAPIView succeeded [Detail] [Expand]
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️PoliCheck succeeded [Detail] [Expand]
Validation passed for PoliCheck.
️️✔️PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
️️✔️Automated merging requirements met succeeded [Detail] [Expand]
Posted by Swagger Pipeline | How to fix these errors?

@openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Sep 7, 2023

Swagger Generation Artifacts

️️✔️ApiDocPreview succeeded [Detail] [Expand]
 Please click here to preview with your @microsoft account. 
️️✔️SDK Breaking Change Tracking succeeded [Detail] [Expand]

Breaking Changes Tracking



️⚠️ azure-sdk-for-python-track2 warning [Detail]
  • ⚠️Warning [Logs]Release - Generate from 6941a3d. SDK Automation 14.0.0
    command	sh scripts/automation_init.sh ../azure-sdk-for-python_tmp/initInput.json ../azure-sdk-for-python_tmp/initOutput.json
    cmderr	[automation_init.sh] WARNING: Skipping azure-nspkg as it is not installed.
    command	sh scripts/automation_generate.sh ../azure-sdk-for-python_tmp/generateInput.json ../azure-sdk-for-python_tmp/generateOutput.json
    cmderr	[automation_generate.sh] npm notice
    cmderr	[automation_generate.sh] npm notice New major version of npm available! 9.6.7 -> 10.1.0
    cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v10.1.0>
    cmderr	[automation_generate.sh] npm notice Run `npm install -g npm@10.1.0` to update!
    cmderr	[automation_generate.sh] npm notice
  • ️✔️track2_azure-mgmt-redhatopenshift [View full logs]  [Release SDK Changes]
    info	[Changelog] ### Features Added
    info	[Changelog]
    info	[Changelog]   - Model NetworkProfile has a new parameter preconfigured_nsg
    info	[Changelog]   - Model OpenShiftCluster has a new parameter worker_profiles_status
    info	[Changelog]   - Model OpenShiftClusterUpdate has a new parameter worker_profiles_status
️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
  • ️✔️Succeeded [Logs]Release - Generate from 6941a3d. SDK Automation 14.0.0
    command	sh ./eng/scripts/automation_init.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json
    command	generator automation-v2 ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json
  • ️✔️sdk/resourcemanager/redhatopenshift/armredhatopenshift [View full logs]  [Release SDK Changes]
    info	[Changelog] ### Features Added
    info	[Changelog]
    info	[Changelog] - New enum type `PreconfiguredNSG` with values `PreconfiguredNSGDisabled`, `PreconfiguredNSGEnabled`
    info	[Changelog] - New field `PreconfiguredNSG` in struct `NetworkProfile`
    info	[Changelog] - New field `WorkerProfilesStatus` in struct `OpenShiftClusterProperties`
    info	[Changelog]
    info	[Changelog] Total 0 breaking change(s), 5 additive change(s).
️⚠️ azure-resource-manager-schemas warning [Detail]
  • ⚠️Warning [Logs]Release - Generate from 6941a3d. Schema Automation 14.0.0
    command	.sdkauto/initScript.sh ../azure-resource-manager-schemas_tmp/initInput.json ../azure-resource-manager-schemas_tmp/initOutput.json
    cmderr	[initScript.sh] npm notice
    cmderr	[initScript.sh] npm notice New major version of npm available! 8.19.4 -> 10.1.0
    cmderr	[initScript.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v10.1.0>
    cmderr	[initScript.sh] npm notice Run `npm install -g npm@10.1.0` to update!
    cmderr	[initScript.sh] npm notice
    warn	File azure-resource-manager-schemas_tmp/initOutput.json not found to read
    command	.sdkauto/generateScript.sh ../azure-resource-manager-schemas_tmp/generateInput.json ../azure-resource-manager-schemas_tmp/generateOutput.json
  • ️✔️redhatopenshift [View full logs]  [Release Schema Changes]
️❌ azure-powershell failed [Detail]
  • Pipeline Framework Failed [Logs]Release - Generate from 6941a3d. SDK Automation 14.0.0
    command	sh ./tools/SwaggerCI/init.sh ../azure-powershell_tmp/initInput.json ../azure-powershell_tmp/initOutput.json
    command	pwsh ./tools/SwaggerCI/psci.ps1 ../azure-powershell_tmp/generateInput.json ../azure-powershell_tmp/generateOutput.json
    SSL error: syscall failure: Broken pipe
    Error: SSL error: syscall failure: Broken pipe
  • ️✔️Az.redhatopenshift.DefaultTag [View full logs
    error	Fatal error: SSL error: syscall failure: Broken pipe
    error	The following packages are still pending:
    error		Az.redhatopenshift.DefaultTag
Posted by Swagger Pipeline | How to fix these errors?

@openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Sep 7, 2023

Generated ApiView

Language Package Name ApiView Link
Go sdk/resourcemanager/redhatopenshift/armredhatopenshift https://apiview.dev/Assemblies/Review/3cdaf3a2b524433f8f4d70904c4d0310

@openapi-workflow-bot
Copy link

Hi @gouthamMN! For review efficiency consideration, when creating a new API version, it is required to place API specs of the base version in the first commit, and push new version updates into successive commits. You can use OpenAPIHub to initialize the PR for adding a new version.
For more details refer to the wiki.

@AzureRestAPISpecReview AzureRestAPISpecReview added ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required ReadyForApiTest <valid label in PR review process>add this label when swagger and service APIs are ready for test and removed WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Sep 7, 2023
@openapi-workflow-bot
Copy link

Please address or respond to feedback from the ARM API reviewer.
When you are ready to continue the ARM API review, please remove the ARMChangesRequested label.
This will notify the reviewer to have another look.
If the feedback provided needs further discussion, please use this Teams channel to post your questions - aka.ms/azsdk/support/specreview-channel.
Please include [ARM Query] in the title of your question to indicate that it is ARM-related.

Copy link
Contributor

@jhoreman jhoreman left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Left comment. We'll need breaking change review as well as review from ARM team on this. Azure SDK check has been failing for some time so is not expected to pass at the moment AFAIK.

specification/redhatopenshift/resource-manager/readme.md Outdated Show resolved Hide resolved
@jhoreman jhoreman removed the ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review label Sep 8, 2023
@openapi-workflow-bot openapi-workflow-bot bot added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Sep 8, 2023
@gouthamMN
Copy link
Contributor Author

/azp run unifiedPipeline

@azure-pipelines
Copy link

No pipelines are associated with this pull request.

@openapi-workflow-bot openapi-workflow-bot bot added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Sep 26, 2023
@raosuhas raosuhas added the ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review label Sep 27, 2023
@openapi-workflow-bot openapi-workflow-bot bot removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Sep 27, 2023
@gouthamMN
Copy link
Contributor Author

/pr RequestMerge

gniranjan added 2 commits September 28, 2023 12:35
This reverts commit cedd9ad.

Revert the workerProfilesStatus and ProvisioningState changes
…anceled provisioning state"

This reverts commit d921e05.

revert workerProfilesStatus and ProvisioningState changes
@AzureRestAPISpecReview AzureRestAPISpecReview added the BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required label Sep 28, 2023
@gouthamMN
Copy link
Contributor Author

/pr RequestMerge

@raosuhas raosuhas merged commit 6941a3d into main Sep 29, 2023
30 of 31 checks passed
@raosuhas raosuhas deleted the gouthamMN-redhatopenshift-Microsoft.RedHatOpenShift-2023-09-04 branch September 29, 2023 00:57
@openapi-pipeline-app
Copy link

Swagger pipeline restarted successfully, please wait for status update in this comment.

jnlycklama pushed a commit that referenced this pull request Nov 8, 2023
…25711)

* Adds base for updating Microsoft.RedHatOpenShift from version stable/2023-04-01 to version 2023-09-04

* Updates readme

* Updates API version in new specs and examples

* add 2023-09-04 rest api specs

* resolve LintDiff check failure

* tag with full date

* rename workerProfilesStatus to activeWorkerProfiles and add canceled provisioning state

* fix lintDiff

* Revert "tag with full date"

This reverts commit cedd9ad.

Revert the workerProfilesStatus and ProvisioningState changes

* Revert "rename workerProfilesStatus to activeWorkerProfiles and add canceled provisioning state"

This reverts commit d921e05.

revert workerProfilesStatus and ProvisioningState changes

* tag with full date

* update readme

---------

Co-authored-by: gniranjan <gniranjan@microsoft.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 ARMReview ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required CI-MissingBaseCommit new-api-version ReadyForApiTest <valid label in PR review process>add this label when swagger and service APIs are ready for test resource-manager
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants