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

fix: AppServicePlan - SKU selection improvements #1736

Merged
merged 7 commits into from
Apr 23, 2024

Conversation

tsc-buddy
Copy link
Contributor

@tsc-buddy tsc-buddy commented Apr 22, 2024

Description

Provides improvements to simplify the selection of SKUs for App Service Plans by relying on the RP to provide the values for 'tier', 'family' and 'size' properties based on the 'name' provided. Logic adjusted on ZR param to accommodate the change also.

Closes #1506

Pipeline Reference

Pipeline
avm.res.web.serverfarm

Type of Change

  • Update to CI Environment or utlities (Non-module effecting changes)
  • Azure Verified Module updates:
    • Bugfix containing backwards compatible bug fixes, and I have NOT bumped the MAJOR or MINOR version in version.json:
      • Someone has opened a bug report issue, and I have included "Closes #{bug_report_issue_number}" in the PR description.
      • The bug was found by the module author, and no one has opened an issue to report it yet.
    • Feature update backwards compatible feature updates, and I have bumped the MINOR version in version.json.
    • Breaking changes and I have bumped the MAJOR version in version.json.
    • Update to documentation

Checklist

  • I'm sure there are no other open Pull Requests for the same update/change
  • I have run Set-AVMModule locally to generate the supporting module files.
  • My corresponding pipelines / checks run clean and green without any errors or warnings

@tsc-buddy tsc-buddy requested review from a team as code owners April 22, 2024 07:53

Important

The "Needs: Triage 🔍" label must be removed once the triage process is complete!

Tip

For additional guidance on how to triage this issue/PR, see the BRM Issue Triage documentation.

Note

This label was added as per ITA06.

@microsoft-github-policy-service microsoft-github-policy-service bot added the Needs: Triage 🔍 Maintainers need to triage still label Apr 22, 2024

Note

The "Type: AVM 🅰️ ✌️ Ⓜ️" label was added as per ITA08BCP.

@microsoft-github-policy-service microsoft-github-policy-service bot added the Type: AVM 🅰️ ✌️ Ⓜ️ This is an AVM related issue label Apr 22, 2024
@tsc-buddy
Copy link
Contributor Author

@Azure/avm-core-team-technical-bicep - Can you provide some guidance on whether the change to the way the SKU parameter now works, warrants a bump in version or not? I was unsure, so didn't adjust it, but I'm mindful the way the SKU was provided has change from an object with 5 properties to, two separate spring params and others being handled by the RP. Technically breaking peoples current approach to the usage of the module, but not the provisioned resources.

@cloudchristoph
Copy link
Contributor

@Azure/avm-core-team-technical-bicep - Can you provide some guidance on whether the change to the way the SKU parameter now works, warrants a bump in version or not? I was unsure, so didn't adjust it, but I'm mindful the way the SKU was provided has change from an object with 5 properties to, two separate spring params and others being handled by the RP. Technically breaking peoples current approach to the usage of the module, but not the provisioned resources.

Just my 2 cents:

Since you are changing the "interface" to the module - including new required parameters - this should definitely be a new version.

The people who previously used the module in the current version do not set the "skuCapacity" parameter, for example. Their template will then become invalid, even if they didn't change the module version..

@AlexanderSehr
Copy link
Contributor

@Azure/avm-core-team-technical-bicep - Can you provide some guidance on whether the change to the way the SKU parameter now works, warrants a bump in version or not? I was unsure, so didn't adjust it, but I'm mindful the way the SKU was provided has change from an object with 5 properties to, two separate spring params and others being handled by the RP. Technically breaking peoples current approach to the usage of the module, but not the provisioned resources.

Just my 2 cents:

Since you are changing the "interface" to the module - including new required parameters - this should definitely be a new version.

The people who previously used the module in the current version do not set the "skuCapacity" parameter, for example. Their template will then become invalid, even if they didn't change the module version..

100% correct @cloudchristoph. As we're still in the 'pre 1.0' phase, plese update the module's version to the next minor @tsc-buddy.

That being said and for context, @cloudchristoph, a change to a module always results in a new version / we never overwrite a current one. But we still want to adhere semver (especially from 1.0 onwards), so it remains a valid ask to explicitely bump up the version (to in this case at least a new minor).

Copy link
Contributor

@AlexanderSehr AlexanderSehr left a comment

Choose a reason for hiding this comment

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

Please bump the version in the version.json file as per the dicsussion in the PR's comments.

@tsc-buddy
Copy link
Contributor Author

Please bump the version in the version.json file as per the dicsussion in the PR's comments.

All done. Thanks @AlexanderSehr

@AlexanderSehr AlexanderSehr changed the title fix: 1506 SKU selection improvements fix: AppServicePlan - SKU selection improvements Apr 23, 2024
@AlexanderSehr AlexanderSehr merged commit 1dd8628 into Azure:main Apr 23, 2024
6 checks passed
@tsc-buddy tsc-buddy deleted the fix/1506-sku-updates branch April 23, 2024 02:56
donk-msft pushed a commit to donk-msft/bicep-registry-modules that referenced this pull request Apr 29, 2024
## Description
Provides improvements to simplify the selection of SKUs for App Service
Plans by relying on the RP to provide the values for 'tier', 'family'
and 'size' properties based on the 'name' provided. Logic adjusted on ZR
param to accommodate the change also.

Closes Azure#1506 

## Pipeline Reference

<!-- Insert your Pipeline Status Badge below -->

| Pipeline |
| -------- |
|
[![avm.res.web.serverfarm](https://github.com/tsc-buddy/bicep-registry-modules/actions/workflows/avm.res.web.serverfarm.yml/badge.svg?branch=fix%2F1506-sku-updates)](https://github.com/tsc-buddy/bicep-registry-modules/actions/workflows/avm.res.web.serverfarm.yml)
|

## Type of Change

<!-- Use the check-boxes [x] on the options that are relevant. -->

- [ ] Update to CI Environment or utlities (Non-module effecting
changes)
- [x] Azure Verified Module updates:
- [ ] Bugfix containing backwards compatible bug fixes, and I have NOT
bumped the MAJOR or MINOR version in `version.json`:
- [x] Someone has opened a bug report issue, and I have included "Closes
#{bug_report_issue_number}" in the PR description.
- [ ] The bug was found by the module author, and no one has opened an
issue to report it yet.
- [ ] Feature update backwards compatible feature updates, and I have
bumped the MINOR version in `version.json`.
- [ ] Breaking changes and I have bumped the MAJOR version in
`version.json`.
  - [x] Update to documentation

## Checklist

- [x] I'm sure there are no other open Pull Requests for the same
update/change
- [x] I have run `Set-AVMModule` locally to generate the supporting
module files.
- [x] My corresponding pipelines / checks run clean and green without
any errors or warnings

<!-- Please keep up to day with the contribution guide at
https://aka.ms/avm/contribute/bicep -->
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Needs: Triage 🔍 Maintainers need to triage still Type: AVM 🅰️ ✌️ Ⓜ️ This is an AVM related issue
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[AVM Module Issue]: res/web/serverfarm - I need to specify tier in SKU I will otherwise get an error
3 participants