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

Azure Red Hat OpenShift 2021 01 31 preview API #12144

Conversation

mjudeikis
Copy link

MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.

Changelog

Please ensure to add changelog with this PR by answering the following questions.

  1. What's the purpose of the update?
    • new service onboarding
    • new API version
    • update existing version for new feature
    • update existing version to fix swagger quality issue in s360
    • Other, please clarify
  2. When you are targeting to deploy new service/feature to public regions? Please provide date, or month to public if date is not available yet.
    Target is to start testing in canary early next year, and go to production Beginning of march 2021
  3. When you expect to publish swagger? Please provide date, or month to public if date is not available yet.
    Together with going live
  4. If it's an update to existing version, please select SDKs of specific language and CLIs that require refresh after swagger is published.
    • SDK of .NET (need service team to ensure code readiness)
    • SDK of Python
    • SDK of Java
    • SDK of Js
    • SDK of Go
    • PowerShell
    • CLI
    • Terraform
    • No, no need to refresh for updates in this PR

Contribution checklist:

If any further question about AME onboarding or validation tools, please view the FAQ.

ARM API Review Checklist

  • Ensure to check this box if one of the following scenarios meet updates in the PR, so that label “WaitForARMFeedback” will be added automatically to involve ARM API Review. Failure to comply may result in delays for manifest application. Note this does not apply to data plane APIs, all “removals” and “adding a new property” no more require ARM API review.

    • Adding new API(s)
    • Adding a new API version
    • Adding a new service
  • Please 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 there are following updates in the PR, ensure to request an approval from API Review Board as defined in the Breaking Change Policy.

  • Removing API(s) in stable version
  • Removing properties in stable version
  • Removing API version(s) in stable version
  • Updating API in stable version with Breaking Change Validation errors
  • Updating API(s) in preview over 1 year

Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Addition details on the process and office hours are on the Breaking change Wiki.

Please follow the link to find more details on PR review process.

@openapi-workflow-bot
Copy link

Hi, @mjudeikis Thanks for your PR. I am workflow bot for review process. Here are some small tips.

  • Please ensure to do self-check against checklists in first PR comment.
  • PR assignee is the person auto-assigned and responsible for your current PR reviewing and merging.
  • For cross api-version diff. See OpenAPI Hub Diff
  • If there is CI failure(s), to fix CI error(s) is mandatory for PR merging; or you need to provide justification in PR comment for explanation. How to fix?

  • Any feedback about review process or workflow bot, pls contact swagger and tools team. vsswagger@microsoft.com

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Dec 16, 2020

    Swagger Validation Report

    ️️✔️BreakingChange succeeded [Detail] [Expand]
    There are no breaking changes.
    ️⚠️LintDiff: 1 Warnings warning [Detail]

    Rule Message
    ⚠️ R2066 - PostOperationIdContainsUrlVerb OperationId should contain the verb: 'listadmincredentials' in:'OpenShiftClusters_ListAdminKubeconfig'. Consider updating the operationId
    New: Microsoft.RedHatOpenShift/preview/2021-01-31-preview/redhatopenshift.json#L361
    ️️✔️Avocado succeeded [Detail] [Expand]
    Validation passes for Avocado.
    ️️✔️ModelValidation succeeded [Detail] [Expand]
    Validation passes for ModelValidation.
    ️️✔️SemanticValidation succeeded [Detail] [Expand]
    Validation passes for SemanticValidation.
    ️️✔️[Staging] Cross Version BreakingChange (Base on preview version) succeeded [Detail] [Expand]
    There are no breaking changes.
    ️️✔️[Staging] Cross Version BreakingChange (Base on stable version) succeeded [Detail] [Expand]
    There are no breaking changes.

    ️️✔️CredScan succeeded [Detail] [Expand]
    There is no credential detected.
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-workflow-bot
    Copy link

    Hi, @mjudeikis Thanks for your PR. I am workflow bot for review process. Here are some small tips.

  • Please ensure to do self-check against checklists in first PR comment.
  • PR assignee is the person auto-assigned and responsible for your current PR reviewing and merging.
  • For specs comparison cross API versions, Use API Specs Comparison Report Generator
  • If there is CI failure(s), to fix CI error(s) is mandatory for PR merging; or you need to provide justification in PR comment for explanation. How to fix?

  • Any feedback about review process or workflow bot, pls contact swagger and tools team. vsswagger@microsoft.com

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Dec 16, 2020

    Swagger Generation Artifacts

    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 561bb28. SDK Automation 14.0.0
      command	sh ./initScript.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json
      command	go run ./tools/generator/main.go ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json
    • ️✔️preview/mgmt/2021-01-31-preview/redhatopenshift [View full logs]  [Release SDK Changes]
      info	[Changelog] This is a new package
    • ️✔️redhatopenshift/mgmt/2020-04-30/redhatopenshift [View full logs]  [Release SDK Changes]
      info	[Changelog] No exported changes
    ️️✔️ azure-resource-manager-schemas succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 561bb28. Schema Automation 14.0.0
      warn	Skip initScript due to not configured
      command	npx n 12
      command	autorest --use=@autorest/azureresourceschema@3.0.92 --version=3.0.6320 --azureresourceschema --multiapi --title=none --pass-thru:subset-reducer --azureresourceschema-folder=/home/vsts/work/1/s/azure-resource-manager-schemas/azure-resource-manager-schemas ../../azure-rest-api-specs/specification/redhatopenshift/resource-manager/readme.md
    • ️✔️redhatopenshift [View full logs]  [Release Schema Changes]
      cmderr	[resource-manager] node-pre-gyp
      cmderr	[resource-manager] WARN Using request for node-pre-gyp https download
      cmderr	[resource-manager]  template-schema-validation-tools@1.0.0 No repository field.
      cmderr	[resource-manager] npm WARN optional SKIPPING OPTIONAL DEPENDENCY: fsevents@2.1.3 (node_modules/fsevents):
      cmderr	[resource-manager] npm WARN notsup SKIPPING OPTIONAL DEPENDENCY: Unsupported platform for fsevents@2.1.3: wanted {"os":"darwin","arch":"any"} (current: {"os":"linux","arch":"x64"})
    ️⚠️ azure-sdk-for-python warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 561bb28. SDK Automation 14.0.0
      warn	Skip initScript due to not configured
      command	npx n 12
      command	python3 -m venv venv
      command	pip install --upgrade setuptools wheel pip
      command	pip install pathlib jinja2 msrestazure
      command	autorest --version=V2 --use=@microsoft.azure/autorest.python@~4.0.71 --python --python-mode=update --multiapi --keep-version-file --no-async --python-sdks-folder=/home/vsts/work/1/s/azure-sdk-for-python/sdk ../azure-rest-api-specs/specification/redhatopenshift/resource-manager/readme.md
    • ⚠️azure-mgmt-redhatopenshift [View full logs]  [Release SDK Changes]
      cmderr	[buildConf] INFO:packaging_tools:Building template azure-mgmt-redhatopenshift
      cmderr	[buildConf] INFO:packaging_tools.conf:Skipping default conf since the file exists
      cmderr	[buildConf] INFO:packaging_tools:Skipping CHANGELOG.md template, since a previous one was found
      cmderr	[buildConf] INFO:packaging_tools:Template done azure-mgmt-redhatopenshift
      cmderr	[changelogSetup] WARNING: Skipping azure-nspkg as it is not installed.
      cmderr	[changelogReport] INFO:__main__:Looking for Autorest generated package in azure.mgmt.redhatopenshift
      cmderr	[changelogReport] Traceback (most recent call last):
      cmderr	[changelogReport]   File "/usr/lib/python3.6/runpy.py", line 193, in _run_module_as_main
      cmderr	[changelogReport]     "__main__", mod_spec)
      cmderr	[changelogReport]   File "/usr/lib/python3.6/runpy.py", line 85, in _run_code
      cmderr	[changelogReport]     exec(code, run_globals)
      cmderr	[changelogReport]   File "/home/vsts/work/1/s/azure-sdk-for-python/tools/azure-sdk-tools/packaging_tools/code_report.py", line 399, in <module>
      cmderr	[changelogReport]     main(args.package_name, args.version, args.no_venv, args.pypi, args.last_pypi, args.output)
      cmderr	[changelogReport]   File "/home/vsts/work/1/s/azure-sdk-for-python/tools/azure-sdk-tools/packaging_tools/code_report.py", line 291, in main
      cmderr	[changelogReport]     modules = find_autorest_generated_folder(module_name)
      cmderr	[changelogReport]   File "/home/vsts/work/1/s/azure-sdk-for-python/tools/azure-sdk-tools/packaging_tools/code_report.py", line 342, in find_autorest_generated_folder
      cmderr	[changelogReport]     model_module = importlib.import_module(".models", module_prefix)
      cmderr	[changelogReport]   File "/usr/lib/python3.6/importlib/__init__.py", line 126, in import_module
      cmderr	[changelogReport]     return _bootstrap._gcd_import(name[level:], package, level)
      cmderr	[changelogReport]   File "<frozen importlib._bootstrap>", line 994, in _gcd_import
      cmderr	[changelogReport]   File "<frozen importlib._bootstrap>", line 971, in _find_and_load
      cmderr	[changelogReport]   File "<frozen importlib._bootstrap>", line 941, in _find_and_load_unlocked
      cmderr	[changelogReport]   File "<frozen importlib._bootstrap>", line 219, in _call_with_frames_removed
      cmderr	[changelogReport]   File "<frozen importlib._bootstrap>", line 994, in _gcd_import
      cmderr	[changelogReport]   File "<frozen importlib._bootstrap>", line 971, in _find_and_load
      cmderr	[changelogReport]   File "<frozen importlib._bootstrap>", line 955, in _find_and_load_unlocked
      cmderr	[changelogReport]   File "<frozen importlib._bootstrap>", line 665, in _load_unlocked
      cmderr	[changelogReport]   File "<frozen importlib._bootstrap_external>", line 678, in exec_module
      cmderr	[changelogReport]   File "<frozen importlib._bootstrap>", line 219, in _call_with_frames_removed
      cmderr	[changelogReport]   File "/home/vsts/work/1/s/azure-sdk-for-python/sdk/redhatopenshift/azure-mgmt-redhatopenshift/azure/mgmt/redhatopenshift/__init__.py", line 13, in <module>
      cmderr	[changelogReport]     from ._azure_red_hat_open_shift4_client import AzureRedHatOpenShift4Client
      cmderr	[changelogReport]   File "/home/vsts/work/1/s/azure-sdk-for-python/sdk/redhatopenshift/azure-mgmt-redhatopenshift/azure/mgmt/redhatopenshift/_azure_red_hat_open_shift4_client.py", line 82
      cmderr	[changelogReport]     from .v2021-01-31-preview import models
      cmderr	[changelogReport]                ^
      cmderr	[changelogReport] SyntaxError: invalid syntax
      warn	Script return with result [warning] code [1] signal [null] cwd [azure-sdk-for-python]: python
      cmderr	[changelogReportLatest] INFO:__main__:Download versions of azure-mgmt-redhatopenshift on PyPI
      cmderr	[changelogReportLatest] INFO:__main__:Got ['0.1.0', '1.0.0b1']
      cmderr	[changelogReportLatest] INFO:__main__:Only keep last PyPI version
      cmderr	[changelogReportLatest] INFO:__main__:Installing version 0.1.0 of azure-mgmt-redhatopenshift in a venv
      cmderr	[changelogReportLatest] Cache entry deserialization failed, entry ignored
      cmderr	[changelogReportLatest] INFO:__main__:Looking for Autorest generated package in azure.mgmt.redhatopenshift
      cmderr	[changelogReportLatest] INFO:__main__:Looking for Autorest generated package in azure.mgmt.redhatopenshift.v2020_04_30
      cmderr	[changelogReportLatest] INFO:__main__:Found azure.mgmt.redhatopenshift.v2020_04_30
      cmderr	[changelogReportLatest] INFO:__main__:Working on azure.mgmt.redhatopenshift.v2020_04_30
      cmderr	[changelogReportLatest] INFO:__main__:Report written to sdk/redhatopenshift/azure-mgmt-redhatopenshift/code_reports/0.1.0/v2020_04_30.json
      warn	Not exact 2 reports found:
      warn		code_reports/0.1.0/v2020_04_30.json
      warn	Not generating changelog.
    ️️✔️[Staging] ApiDocPreview succeeded [Detail] [Expand]
     Please click here to preview with your @microsoft account. 
    Posted by Swagger Pipeline | How to fix these errors?

    @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 Dec 16, 2020
    @openapi-workflow-bot
    Copy link

    Hi, @mjudeikis your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board(armapireview@microsoft.com). cc @

    @mjudeikis
    Copy link
    Author

    @chunyu3 Hey! Can you please help us with the review on this. This is new API for Azure Red hat OpenShift service, joint engineering with Microsoft and RedHat. We are mostly modeling our APIS following AKS, but I see failure with missing SystemData. Is this mandatory implementation for this?
    Second Golang SDK fails to generate, where locally with the same files we have successful runs. Anything we are missing.

    Thanks and appreciate the time!
    MJ

    @chiragg4u chiragg4u added ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review and removed WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Dec 29, 2020
    @chunyu3
    Copy link
    Member

    chunyu3 commented Jan 4, 2021

    SDK azure-sdk-for-go failed. @ArcturusZhang please help to check it.

    And please look at the 'Swagger LintDiff' issue. @mjudeikis Thanks.

    Please also specify `--go-sdk-folder=<path to the root directory of your azure-sdk-for-go clone>`.

    ``` yaml $(tag) == 'package-2021-01-31-preview' && $(go)
    output-folder: $(go-sdk-folder)/services/$(namespace)/mgmt/2021-01-31-preview/$(namespace)
    Copy link
    Member

    Choose a reason for hiding this comment

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

    A preview package must be placed in the preview subdirectory

    Suggested change
    output-folder: $(go-sdk-folder)/services/$(namespace)/mgmt/2021-01-31-preview/$(namespace)
    output-folder: $(go-sdk-folder)/services/preview/$(namespace)/mgmt/2021-01-31-preview/$(namespace)

    @mjudeikis mjudeikis force-pushed the dev-redhatopenshift-Microsoft.RedHatOpenShift-2021-01-31-preview branch from f074f88 to 14f0fee Compare January 4, 2021 15:11
    @openapi-workflow-bot
    Copy link

    Hi @mjudeikis, Your PR has some issues. Please fix the CI sequentially by following the order of Avocado, semantic validation, model validation, breaking change, lintDiff.

    TaskHow to fixPrioritySupport (Microsoft alias)
    AvocadoFix-AvocadoHighruowan
    Semantic validationFix-SemanticValidation-ErrorHighraychen, jianyxi
    Model validationFix-ModelValidation-ErrorHighraychen,jianyxi
    LintDiffFix-LintDiffhighjianyxi, ruoxuan
    If you need further help, please feedback via swagger feedback."

    @mjudeikis
    Copy link
    Author

    @ArcturusZhang @chunyu3 addressed the change. Chan you please advise on Avocado failures? Not sure where they are coming from

    @chunyu3
    Copy link
    Member

    chunyu3 commented Jan 12, 2021

    /azp run

    @azure-pipelines
    Copy link

    Azure Pipelines successfully started running 2 pipeline(s).

    @chunyu3 chunyu3 merged commit 561bb28 into Azure:master Jan 12, 2021
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Labels
    ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    5 participants