Azure / Azure-Verified-Modules

Azure Verified Modules (AVM) is an initiative to consolidate and set the standards for what a good Infrastructure-as-Code module looks like. Modules will then align to these standards, across languages (Bicep, Terraform etc.) and will then be classified as AVMs and available from their respective language specific registries.
https://aka.ms/AVM
MIT License
354 stars 83 forks source link

[Module Proposal]: `avm/utl/types/avm-common-types` #1396

Closed AlexanderSehr closed 1 month ago

AlexanderSehr commented 2 months ago

Check for previous/existing GitHub issues/module proposals

Check this module doesn't already exist in the module indexes

Bicep or Terraform?

Bicep

Module Classification?

Resource Module

Module Name

avm/utl/types/avm-common-type

Module Details

This module is based on @jtracey93's comment here, effectively proposing a module that just provides the most common AVM types as documented here.

As such, the module would exclusively contain types with the @export() annotation, one for each variant of our specs (with maybe the exception of e.g. tags)

Do you want to be the owner of this module?

Yes

Module Owner's GitHub Username (handle)

AlexanderSehr

(Optional) Secondary Module Owner's GitHub Username (handle)

No response

matebarabas commented 1 month ago

Hi @AlexanderSehr,

Thanks for requesting/proposing to be an AVM module owner!

We just want to confirm you agree to the below pages that define what module ownership means:

Any questions or clarifications needed, let us know!

If you agree, please just reply to this issue with the exact sentence below (as this helps with our automation 👍):

"I CONFIRM I WISH TO OWN THIS AVM MODULE AND UNDERSTAND THE REQUIREMENTS AND DEFINITION OF A MODULE OWNER"

Thanks,

The AVM Core Team

RR

matebarabas commented 1 month ago

Marking this as long term, until @AlexanderSehr is back from his annual leave.

AlexanderSehr commented 1 month ago

I CONFIRM I WISH TO OWN THIS AVM MODULE AND UNDERSTAND THE REQUIREMENTS AND DEFINITION OF A MODULE OWNER

matebarabas commented 1 month ago

Hi @AlexanderSehr,

Thanks for confirming that you wish to own this AVM module and understand the related requirements and responsibilities!

Before starting development, please ensure ALL the following requirements are met.

Please use the following values explicitly as provided in the module index page:

Check if this module exists in the other IaC language. If so, collaborate with the other owner for consistency. 👍

You can now start the development of this module! ✅ Happy coding! 🎉

Please respond to this comment and request a review from the AVM core team once your module is ready to be published! Please include a link pointing to your PR, once available. 🙏

Any further questions or clarifications needed, let us know!

Thanks,

The AVM Core Team

AlexanderSehr commented 1 month ago

Hey @matebarabas, small correction: I guess it should be types/avm-common-type (singular) not types/avm-common-types (plural) as per our specs? Maybe even type/avm-common-type? Or can the grouping folder be plural? I see we have both cases currently in the ptn modules...

matebarabas commented 1 month ago

Hey @AlexanderSehr, we only have the singular restriction for the 2nd segment of resource modules. For pattern and utility modules, no such restriction is in place. So, for the grouping segment, I think "types" is appropriate as we can potentially have many of them. For the 2nd segment, I'd leave that on you - it could be either singular or plural. Is one instance of this module deployment dealing with a single or multiple types at the same time? Thanks!

AlexanderSehr commented 1 month ago

PR ready for review: https://github.com/Azure/bicep-registry-modules/pull/3397

matebarabas commented 4 weeks ago

Thank you for your work @AlexanderSehr!