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

Service Fabric Managed Clusters - api version 2022-06-01-preview #19337

Merged
merged 4 commits into from
Jul 26, 2022

Conversation

a-santamaria
Copy link
Member

@a-santamaria a-santamaria commented Jun 6, 2022

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:

  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 are you targeting to deploy the new service/feature to public regions? Please provide the date or, if the date is not yet available, the month.
  3. When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month.
  4. By default, Azure SDKs of all languages (.NET/Python/Java/JavaScript for both management-plane SDK and data-plane SDK, Go for management-plane SDK only ) MUST be refreshed with/after swagger of new version is published. If you prefer NOT to refresh any specific SDK language upon swagger updates in the current PR, please leave details with justification here.

Contribution checklist (MS Employees Only):

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

ARM API Review Checklist

Applicability: ⚠️

If your changes encompass only the following scenarios, you should SKIP this section, as these scenarios do not require ARM review.

  • Change to data plane APIs
  • Adding new properties
  • All removals

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.

    • Adding a new service
    • Adding new API(s)
    • Adding a new API version
      -[ ] To review changes efficiently, ensure you copy the existing version into the new directory structure for first commit and then push new changes, including version updates, in separate commits. You can use OpenAPIHub to initialize the PR for adding a new version. For more details refer to the wiki.
  • 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.

@openapi-workflow-bot
Copy link

Hi, @a-santamaria 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. vscswagger@microsoft.com

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Jun 6, 2022

    Swagger Validation Report

    ️️✔️BreakingChange succeeded [Detail] [Expand]
    There are no breaking changes.
    ️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]
    There are no breaking changes.
    compared swaggers (via Oad v0.9.6)] new version base version
    managedapplication.json 2022-06-01-preview(b2e986b) 2022-01-01(main)
    managedapplication.json 2022-06-01-preview(b2e986b) 2022-02-01-preview(main)
    managedcluster.json 2022-06-01-preview(b2e986b) 2022-01-01(main)
    managedcluster.json 2022-06-01-preview(b2e986b) 2022-02-01-preview(main)
    nodetype.json 2022-06-01-preview(b2e986b) 2022-01-01(main)
    nodetype.json 2022-06-01-preview(b2e986b) 2022-02-01-preview(main)
    ️️✔️CredScan succeeded [Detail] [Expand]
    There is no credential detected.
    ️⚠️LintDiff: 0 Warnings warning [Detail]
    compared tags (via openapi-validator v1.13.0) new version base version
    package-2022-06-preview package-2022-06-preview(b2e986b) default(main)

    The following errors/warnings exist before current PR submission:

    Rule Message
    ⚠️ R2001 - AvoidNestedProperties Consider using x-ms-client-flatten to provide a better end user experience
    Location: Microsoft.ServiceFabric/preview/2022-06-01-preview/managedapplication.json#L2204
    ⚠️ R2001 - AvoidNestedProperties Consider using x-ms-client-flatten to provide a better end user experience
    Location: Microsoft.ServiceFabric/preview/2022-06-01-preview/managedcluster.json#L1338
    ⚠️ R2007 - LongRunningOperationsWithLongRunningExtension The operation 'OperationResults_Get' returns 202 status code, which indicates a long running operation, please enable 'x-ms-long-running-operation.
    Location: Microsoft.ServiceFabric/preview/2022-06-01-preview/managedcluster.json#L674
    ⚠️ R2063 - OperationIdNounConflictingModelNames OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'managedAzResiliencyStatusModel'. Consider using the plural form of 'managedAzResiliencyStatus' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change.
    Location: Microsoft.ServiceFabric/preview/2022-06-01-preview/managedcluster.json#L333
    ⚠️ R2066 - PostOperationIdContainsUrlVerb OperationId should contain the verb: 'getazresiliencystatus' in:'managedAzResiliencyStatus_get'. Consider updating the operationId
    Location: Microsoft.ServiceFabric/preview/2022-06-01-preview/managedcluster.json#L333
    ️️✔️Avocado succeeded [Detail] [Expand]
    Validation passes for Avocado.
    ️️✔️ApiReadinessCheck 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.
    ️⚠️SDK Track2 Validation: 12 Warnings warning [Detail]
    • The following tags are being changed in this PR
      • "https://github.com/Azure/azure-rest-api-specs/blob/b2e986bfba682ac3918a857f0eed41d5ca7bc907/specification/servicefabricmanagedclusters/resource-manager/readme.md#tag-package-2022-06-preview">servicefabricmanagedclusters/resource-manager/readme.md#package-2022-06-preview
    The following errors/warnings are introduced by current PR:
    Rule Message
    ⚠️ PreCheck/EmptyParentSchemaWarning "readme":"servicefabricmanagedclusters/resource-manager/readme.md",
    "tag":"package-2022-06-preview",
    "details":"Schema 'AddRemoveIncrementalNamedPartitionScalingMechanism' has an allOf list with an empty object schema as a parent,
    removing it."
    ⚠️ PreCheck/EmptyParentSchemaWarning "readme":"servicefabricmanagedclusters/resource-manager/readme.md",
    "tag":"package-2022-06-preview",
    "details":"Schema 'AveragePartitionLoadScalingTrigger' has an allOf list with an empty object schema as a parent,
    removing it."
    ⚠️ PreCheck/EmptyParentSchemaWarning "readme":"servicefabricmanagedclusters/resource-manager/readme.md",
    "tag":"package-2022-06-preview",
    "details":"Schema 'AverageServiceLoadScalingTrigger' has an allOf list with an empty object schema as a parent,
    removing it."
    ⚠️ PreCheck/EmptyParentSchemaWarning "readme":"servicefabricmanagedclusters/resource-manager/readme.md",
    "tag":"package-2022-06-preview",
    "details":"Schema 'NamedPartitionScheme' has an allOf list with an empty object schema as a parent,
    removing it."
    ⚠️ PreCheck/EmptyParentSchemaWarning "readme":"servicefabricmanagedclusters/resource-manager/readme.md",
    "tag":"package-2022-06-preview",
    "details":"Schema 'PartitionInstanceCountScaleMechanism' has an allOf list with an empty object schema as a parent,
    removing it."
    ⚠️ PreCheck/EmptyParentSchemaWarning "readme":"servicefabricmanagedclusters/resource-manager/readme.md",
    "tag":"package-2022-06-preview",
    "details":"Schema 'ServicePlacementInvalidDomainPolicy' has an allOf list with an empty object schema as a parent,
    removing it."
    ⚠️ PreCheck/EmptyParentSchemaWarning "readme":"servicefabricmanagedclusters/resource-manager/readme.md",
    "tag":"package-2022-06-preview",
    "details":"Schema 'ServicePlacementPreferPrimaryDomainPolicy' has an allOf list with an empty object schema as a parent,
    removing it."
    ⚠️ PreCheck/EmptyParentSchemaWarning "readme":"servicefabricmanagedclusters/resource-manager/readme.md",
    "tag":"package-2022-06-preview",
    "details":"Schema 'ServicePlacementRequiredDomainPolicy' has an allOf list with an empty object schema as a parent,
    removing it."
    ⚠️ PreCheck/EmptyParentSchemaWarning "readme":"servicefabricmanagedclusters/resource-manager/readme.md",
    "tag":"package-2022-06-preview",
    "details":"Schema 'ServicePlacementRequireDomainDistributionPolicy' has an allOf list with an empty object schema as a parent,
    removing it."
    ⚠️ PreCheck/EmptyParentSchemaWarning "readme":"servicefabricmanagedclusters/resource-manager/readme.md",
    "tag":"package-2022-06-preview",
    "details":"Schema 'UniformInt64RangePartitionScheme' has an allOf list with an empty object schema as a parent,
    removing it."
    ⚠️ PreCheck/EmptyParentSchemaWarning "readme":"servicefabricmanagedclusters/resource-manager/readme.md",
    "tag":"package-2022-06-preview",
    "details":"Schema 'ManagedCluster' has an allOf list with an empty object schema as a parent,
    removing it."
    ⚠️ UnkownSecurityScheme "readme":"servicefabricmanagedclusters/resource-manager/readme.md",
    "tag":"package-2022-06-preview",
    "details":"Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,
    AzureKey,
    Anonymous"
    ️️✔️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).
    ️️✔️CadlValidation succeeded [Detail] [Expand]
    Validation passes for CadlValidation.
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-workflow-bot
    Copy link

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

    @openapi-workflow-bot openapi-workflow-bot bot added ARMReview WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Jun 6, 2022
    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Jun 6, 2022

    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 - track2_azure-mgmt-servicefabricmanagedclusters - 2.0.0b1
    ️❌ azure-sdk-for-net failed [Detail]
    • Failed [Logs]Release - Generate from 23e8920. SDK Automation 14.0.0
      warn	Skip initScript due to not configured
      command	sudo apt-get install -y dotnet-sdk-6.0
      command	autorest --version=2.0.4421 --csharp --reflect-api-versions --license-header=MICROSOFT_MIT_NO_VERSION --use=@microsoft.azure/autorest.csharp@2.3.82 --csharp-sdks-folder=/mnt/vss/_work/1/s/azure-sdk-for-net/sdk ../azure-rest-api-specs/specification/servicefabricmanagedclusters/resource-manager/readme.md
      cmderr	[Autorest] realpath(): Permission denied
      cmderr	[Autorest] realpath(): Permission denied
      cmderr	[Autorest] realpath(): Permission denied
      cmderr	[Autorest] realpath(): Permission denied
      cmderr	[Autorest] realpath(): Permission denied
      cmderr	[Autorest] realpath(): Permission denied
      cmderr	[Autorest] No usable version of the libssl was found
      cmderr	[Autorest] FATAL: csharp/simplifier - FAILED
      cmderr	[Autorest] FATAL: Error: [Exception] AutoRest extension '@microsoft.azure/autorest.csharp' terminated.
      cmderr	[Autorest] Process() cancelled due to exception : [Exception] AutoRest extension '@microsoft.azure/autorest.csharp' terminated.
      error	Script return with result [failed] code [1] signal [null] cwd [azure-sdk-for-net]: autorest
      warn	Skip package processing as generation is failed
    ️⚠️ azure-sdk-for-python-track2 warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 23e8920. 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]  config global `--global`, `--local` are deprecated. Use `--location=global` instead.
    • ️✔️track2_azure-mgmt-servicefabricmanagedclusters [View full logs]  [Release SDK Changes]
      info	[Changelog] **Features**
      info	[Changelog]
      info	[Changelog]   - Model NodeType has a new parameter eviction_policy
      info	[Changelog]   - Model NodeType has a new parameter host_group_id
      info	[Changelog]   - Model NodeType has a new parameter spot_restore_timeout
      info	[Changelog]   - Model NodeType has a new parameter use_ephemeral_os_disk
    ️⚠️ azure-resource-manager-schemas warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 23e8920. 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] WARN old lockfile
      cmderr	[initScript.sh] npm WARN old lockfile The package-lock.json file was created with an old version of npm,
      cmderr	[initScript.sh] npm WARN old lockfile so supplemental metadata must be fetched from the registry.
      cmderr	[initScript.sh] npm WARN old lockfile
      cmderr	[initScript.sh] npm WARN old lockfile This is a one-time fix-up, please be patient...
      cmderr	[initScript.sh] npm WARN old lockfile
      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
    • ️✔️servicefabricmanagedclusters [View full logs]  [Release Schema Changes]
    ️❌ azure-powershell failed [Detail]
    • Failed [Logs]Release - Generate from 23e8920. 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
    • Az.servicefabricmanagedclusters [View full logs]  [Release SDK Changes]
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-workflow-bot
    Copy link

    Hi @a-santamaria, Your PR has some issues. Please fix the CI sequentially by following the order of Avocado, semantic validation, model validation, breaking change, lintDiff. If you have any questions, please post your questions in this channel https://aka.ms/swaggersupport.

    TaskHow to fixPriority
    AvocadoFix-AvocadoHigh
    Semantic validationFix-SemanticValidation-ErrorHigh
    Model validationFix-ModelValidation-ErrorHigh
    LintDiffFix-LintDiffhigh
    If you need further help, please feedback via swagger feedback.

    Copy link

    @raosuhas raosuhas left a comment

    Choose a reason for hiding this comment

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

    :shipit:

    @raosuhas raosuhas added the ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review label Jun 8, 2022
    @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 Jun 8, 2022
    @dw511214992
    Copy link
    Member

    Hi @a-santamaria The api readiness check in CI is failed. Has the service been ready in azure?

    @dw511214992
    Copy link
    Member

    /azp run

    @azure-pipelines
    Copy link

    Azure Pipelines successfully started running 1 pipeline(s).

    @a-santamaria
    Copy link
    Member Author

    @dw511214992 can you complete the pr now. We finished deploying the RP manifest with the new api version

    @a-santamaria
    Copy link
    Member Author

    @dw511214992 please complete the pr

    @dw511214992
    Copy link
    Member

    /azp run

    @azure-pipelines
    Copy link

    Azure Pipelines successfully started running 1 pipeline(s).

    @dw511214992
    Copy link
    Member

    dw511214992 commented Jul 21, 2022

    @a-santamaria could you please re-check whether service is deployed? I find the api readiness check is still failed.
    https://github.com/Azure/azure-rest-api-specs/pull/19337/checks?check_run_id=7441203400

    @a-santamaria
    Copy link
    Member Author

    /azp run

    @azure-pipelines
    Copy link

    Azure Pipelines successfully started running 1 pipeline(s).

    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Labels
    ARMReview ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review CI-FixRequiredOnFailure
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    3 participants