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

[Module Proposal]: avm/res/app/container-app #128

Closed
2 tasks done
oZakari opened this issue Sep 28, 2023 · 15 comments
Closed
2 tasks done

[Module Proposal]: avm/res/app/container-app #128

oZakari opened this issue Sep 28, 2023 · 15 comments
Assignees
Labels
Class: Resource Module 📦 This is a resource module Language: Bicep 💪 This is related to the Bicep IaC language Status: Migrate from CARML 🚛 This item is related to a module migration from CARML Status: Module Available 🟢 The module is published Status: Owners Identified 🤘 This module has its owners identified Type: New Module Proposal 💡 A new module for AVM is being proposed

Comments

@oZakari
Copy link
Contributor

oZakari commented Sep 28, 2023

Check for previous/existing GitHub issues/module proposals

  • I have checked for previous/existing GitHub issues/module proposals

Check this module doesn't already exist in another project that is being evolved into AVM

  • I have checked for that this module doesn't already exist in CARML or TFVM

Terraform or Bicep?

Bicep

Module Classification?

Resource Module

Module Name

avm/res/app/container-app

Module Details

Not proposing a new module but interested in taking ownership of existing CARML module.

For reference: https://github.com/Azure/ResourceModules/tree/main/modules/app/container-app

Do you want to be the owner of this module?

Yes

Module Owner's GitHub Username

oZakari

@oZakari oZakari added Needs: Triage 🔍 Maintainers need to triage still Type: New Module Proposal 💡 A new module for AVM is being proposed labels Sep 28, 2023
@oZakari oZakari moved this from Proposed to Looking for owners in AVM - Module Triage Sep 28, 2023
@prjelesi prjelesi added Status: Migrate from CARML 🚛 This item is related to a module migration from CARML Language: Bicep 💪 This is related to the Bicep IaC language labels Oct 2, 2023
@prjelesi prjelesi moved this from Looking for owners to Proposed in AVM - Module Triage Oct 2, 2023
@matebarabas matebarabas changed the title [Module Proposal]: Resource Module-Bicep-Container Apps [Module Proposal]: Resource Module-Bicep-Container Apps (bicep) Oct 3, 2023
@prjelesi prjelesi added the Status: In Triage 🔍 Picked up for triaging by an AVM core team member label Oct 5, 2023
@matebarabas matebarabas changed the title [Module Proposal]: Resource Module-Bicep-Container Apps (bicep) [Module Proposal]: Resource Module-Bicep-Container Apps (res) (bicep) Oct 11, 2023
@matebarabas matebarabas added the Class: Resource Module 📦 This is a resource module label Oct 11, 2023
@matebarabas
Copy link
Contributor

@oZakari, thanks for opening this request and volunteering! I'll shortly send you a request to officially confirm ownership.

Also, @prjelesi is going to reach out to you separately and help with the next steps, given this is a migrate from CARML scenario.

Thank you!

@matebarabas
Copy link
Contributor

Hi @oZakari,

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

@oZakari
Copy link
Contributor Author

oZakari commented Oct 12, 2023

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

@oZakari oZakari closed this as completed Oct 12, 2023
@github-project-automation github-project-automation bot moved this from Proposed to Done in AVM - Module Triage Oct 12, 2023
@matebarabas matebarabas reopened this Oct 12, 2023
@matebarabas
Copy link
Contributor

Reopening.

@oZakari, please note that this issue can only be closed when the module is developed, tested, and published in the Bicep public registry.

@matebarabas
Copy link
Contributor

Hi @oZakari,

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

We just want to ask you to double check a few important things before you start the development.

Please visit the module index page of your module and use the following values explicitly as provided there:

  • ModuleName
  • TelemetryIdPrefix
  • ModuleOwnersGHTeam and ModuleContributorsGHTeam
  • Repository name and folder path defined in RepoURL

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

Please respond to this comment, once your module is ready to be published!

Any further questions or clarifications needed, let us know.

Thanks,

The AVM Core Team

@matebarabas matebarabas removed Needs: Triage 🔍 Maintainers need to triage still Status: In Triage 🔍 Picked up for triaging by an AVM core team member labels Oct 12, 2023
@matebarabas matebarabas moved this from Done to In development in AVM - Module Triage Oct 12, 2023
@matebarabas matebarabas added the Status: Owners Identified 🤘 This module has its owners identified label Oct 12, 2023
@matebarabas matebarabas changed the title [Module Proposal]: Resource Module-Bicep-Container Apps (res) (bicep) [Module Proposal]: avm-res-app-containerapp Apps (res) (bicep) Oct 17, 2023
@kewalaka
Copy link
Contributor

semantics perhaps - but would avm-res-container-app be a better choice? There is avm-res-container-registry, and presumably there will need to be one for managed environments (avm-res-container-environment ?)

seems more logical to me to place the container items closer together alphabetically

If the intent is to group various app options together, then I think the appservice repository name needs reconsideration?

@oZakari
Copy link
Contributor Author

oZakari commented Oct 19, 2023

Hi @kewalaka, the spec is where that naming convention came from. I think this was done to try to reduce the number of dashes for resource names with lots of spaces and to try to keep it as consistent as possible with the resource schema itself. For container registry it should be avm-res-containerregistry-registry instead of avm-res-container-registry.

@matebarabas Just taking a quick look at other resource module names, looks like module for Action Group has a hypen, but it shouldn't either unless I am missing something.

@matebarabas
Copy link
Contributor

@oZakari, @kewalaka,

Please see the naming convention for resource and pattern modules under the respective shared requirement.

  • The explanation in the previous comment is correct. The right name for the Container Registry module is avm-res-containerregistry-registry
  • The correct name for the Container App module is: avm-res-app-containerapp. --> The information in this issue is correct.
  • The correct name for the Action Group module is avm-res-insights-actiongroup. --> The name information in this issue ([Module Proposal]: avm/res/insights/action-group #207) was incorrectly captured and it remained unnoticed. The module was published with the correct name. Please note that the issue for this module was captured retrospectively as an exception, since the module was already being worked on by an AVM core team member before the process for managing the issues (including issue templates, automation, documentation, etc.) was put in place. For good recordkeeping, the core team was asked to make sure they cover all modules that were migrated from CARML with "module proposal" issues. I've corrected the mistake. Thank you for calling this out!

@matebarabas matebarabas changed the title [Module Proposal]: avm-res-app-containerapp Apps (res) (bicep) [Module Proposal]: avm/res/app/container-app Nov 6, 2023
@matebarabas
Copy link
Contributor

@oZakari,

Due to a recent change in the naming convention for AVM Bicep modules, this module is getting an updated name.

The title and description of this GH issue has been updated to reflect the name change. Please make sure you adhere to the new naming convention when publishing your module!

Please see the new naming convention in:

Please note that the Telemetry ID and name of GitHub Teams haven't changed.

If you feel uncertain about any details, please check the Bicep modules indexes.

@oZakari
Copy link
Contributor Author

oZakari commented Dec 14, 2023

Working branch from fork for reference: https://github.com/oZakari/bicep-registry-modules/tree/container-apps

@matebarabas
Copy link
Contributor

Thanks for the update @oZakari! Please let us know once you've submitted a PR (by providing a link to it). Thank you in advance!

@microsoft-github-policy-service microsoft-github-policy-service bot added the Needs: Attention 👋 Reply has been added to issue, maintainer to review label Jan 4, 2024
@matebarabas
Copy link
Contributor

Hi @oZakari, Happy New Year! I hope you had a great holiday season and had a chance to recharge! 😊

I just would like to check back on this issue and ask how far do you think you are? Can you please share your expected timeline on publishing this module?

Thank you!

CC: @jeanchg

@oZakari
Copy link
Contributor Author

oZakari commented Jan 10, 2024

Hi @matebarabas, nearly complete, pushing to get the PR out by this Friday.

@oZakari
Copy link
Contributor Author

oZakari commented Jan 19, 2024

PR Link in Bicep Registry

@oZakari oZakari moved this from In development to In Review in AVM - Module Triage Jan 19, 2024
AlexanderSehr added a commit to Azure/bicep-registry-modules that referenced this issue Jan 29, 2024
## Description

<!--Why this PR? What is changed? What is the effect? etc.-->

Closes avm/res/app/container-app
[#128](Azure/Azure-Verified-Modules#128 (comment))

If you haven't already, read the full [contribution
guide](https://github.com/Azure/bicep-registry-modules/blob/main/CONTRIBUTING.md).
The guide may have changed since the last time you read it, so please
double-check. Once you are done and ready to submit your PR, edit the PR
description and run through the relevant checklist below.

Enable GitHub Workflows in your fork to enable auto-generation of assets
with our [GitHub Action](/.github/workflows/push-auto-generate.yml).
To trigger GitHub Actions after auto-generation, [add a GitHub
PAT](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)
as a secret in your forked repository called `PAT`.

> edit: @AlexanderSehr 
> | Pipeline |
> | - |
> |
[![avm.res.app.container-app](https://github.com/oZakari/bicep-registry-modules/actions/workflows/avm.res.app.container-app.yml/badge.svg?branch=container-apps&event=workflow_dispatch)](https://github.com/oZakari/bicep-registry-modules/actions/workflows/avm.res.app.container-app.yml)
|

## Adding a new module

<!--Run through the checklist if your PR adds a new module.-->

- [x] A proposal has been submitted and approved.
- [x] I have included "Closes #{module_proposal_issue_number}" in the PR
description.
- [ ] I have run `brm validate` locally to verify the module files.
- [x] I have run deployment tests locally to ensure the module is
deployable.

---------

Co-authored-by: Alexander Sehr <[email protected]>
@matebarabas matebarabas added Status: Module Available 🟢 The module is published and removed Needs: Attention 👋 Reply has been added to issue, maintainer to review labels Jan 30, 2024
@matebarabas
Copy link
Contributor

Thank you for your work @oZakari! I'm closing this issue now.

@github-project-automation github-project-automation bot moved this from In Review to Done in AVM - Module Triage Jan 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Class: Resource Module 📦 This is a resource module Language: Bicep 💪 This is related to the Bicep IaC language Status: Migrate from CARML 🚛 This item is related to a module migration from CARML Status: Module Available 🟢 The module is published Status: Owners Identified 🤘 This module has its owners identified Type: New Module Proposal 💡 A new module for AVM is being proposed
Projects
Development

No branches or pull requests

4 participants