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

feat: Added disclaimer to container-app ptn - avm/ptn/azd/container-apps-stack #3221

Closed
wants to merge 15 commits into from
2 changes: 1 addition & 1 deletion .github/CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
#/avm/ptn/avd-lza/networking/ @Azure/avm-ptn-avd-lza-networking-module-owners-bicep @Azure/avm-module-reviewers-bicep
#/avm/ptn/avd-lza/session-hosts/ @Azure/avm-ptn-avd-lza-sessionhosts-module-owners-bicep @Azure/avm-module-reviewers-bicep
/avm/ptn/azd/apim-api/ @Azure/avm-ptn-azd-apimapi-module-owners-bicep @Azure/avm-module-reviewers-bicep
/avm/ptn/azd/container-apps/ @Azure/avm-ptn-azd-containerapps-module-owners-bicep @Azure/avm-module-reviewers-bicep
/avm/ptn/azd/container-apps-stack/ @Azure/avm-ptn-azd-containerappsstack-module-owners-bicep @Azure/avm-module-reviewers-bicep
/avm/ptn/azd/insights-dashboard/ @Azure/avm-ptn-azd-insightsdashboard-module-owners-bicep @Azure/avm-module-reviewers-bicep
/avm/ptn/deployment-script/import-image-to-acr/ @Azure/avm-ptn-deploymentscript-importimagetoacr-module-owners-bicep @Azure/avm-module-reviewers-bicep
/avm/ptn/dev-ops/cicd-agents-and-runners/ @Azure/avm-ptn-devops-cicdagentsandrunners-module-owners-bicep @Azure/avm-module-reviewers-bicep
Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/avm_module_issue.yml
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ body:
# - "avm/ptn/avd-lza/networking"
# - "avm/ptn/avd-lza/session-hosts"
- "avm/ptn/azd/apim-api"
- "avm/ptn/azd/container-apps"
- "avm/ptn/azd/container-apps-stack"
- "avm/ptn/azd/insights-dashboard"
- "avm/ptn/deployment-script/import-image-to-acr"
- "avm/ptn/dev-ops/cicd-agents-and-runners"
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: "avm.ptn.azd.container-apps"
name: "avm.ptn.azd.container-apps-stack"

on:
workflow_dispatch:
Expand Down Expand Up @@ -28,15 +28,15 @@ on:
paths:
- ".github/actions/templates/avm-**"
- ".github/workflows/avm.template.module.yml"
- ".github/workflows/avm.ptn.azd.container-apps.yml"
- "avm/ptn/azd/container-apps/**"
- ".github/workflows/avm.ptn.azd.container-apps-stack.yml"
- "avm/ptn/azd/container-apps-stack/**"
- "avm/utilities/pipelines/**"
- "!avm/utilities/pipelines/platform/**"
- "!*/**/README.md"

env:
modulePath: "avm/ptn/azd/container-apps"
workflowPath: ".github/workflows/avm.ptn.azd.container-apps.yml"
modulePath: "avm/ptn/azd/container-apps-stack"
workflowPath: ".github/workflows/avm.ptn.azd.container-apps-stack.yml"

concurrency:
group: ${{ github.workflow }}
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
# avm/ptn/azd/container-apps `[Azd/ContainerApps]`
# avm/ptn/azd/container-apps-stack `[Azd/ContainerAppsStack]`

Creates an Azure Container Registry and an Azure Container Apps environment.

**Note:** This module is not intended for broad, generic use, as it was designed to cater for the requirements of the AZD CLI product. Feature requests and bug fix requests are welcome if they support the development of the AZD CLI but may not be incorporated if they aim to make this module more generic than what it needs to be for its primary use case

## Navigation

- [Resource Types](#Resource-Types)
Expand Down Expand Up @@ -35,7 +37,7 @@ The following section provides usage examples for the module, which were used to

>**Note**: Each example lists all the required parameters first, followed by the rest - each in alphabetical order.

>**Note**: To reference the module, please use the following syntax `br/public:avm/ptn/azd/container-apps:<version>`.
>**Note**: To reference the module, please use the following syntax `br/public:avm/ptn/azd/container-apps-stack:<version>`.

- [With zoneRedundant enabled](#example-1-with-zoneredundant-enabled)

Expand All @@ -49,8 +51,8 @@ This instance deploys the module with zoneRedundant enabled.
<summary>via Bicep module</summary>

```bicep
module containerApps 'br/public:avm/ptn/azd/container-apps:<version>' = {
name: 'containerAppsDeployment'
module containerAppsStack 'br/public:avm/ptn/azd/container-apps-stack:<version>' = {
name: 'containerAppsStackDeployment'
params: {
// Required parameters
containerAppsEnvironmentName: 'acazrcae001'
Expand Down Expand Up @@ -150,7 +152,7 @@ module containerApps 'br/public:avm/ptn/azd/container-apps:<version>' = {
<summary>via Bicep parameters file</summary>

```bicep-params
using 'br/public:avm/ptn/azd/container-apps:<version>'
using 'br/public:avm/ptn/azd/container-apps-stack:<version>'

// Required parameters
param containerAppsEnvironmentName = 'acazrcae001'
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
metadata name = 'avm/ptn/azd/container-apps'
metadata description = 'Creates an Azure Container Registry and an Azure Container Apps environment.'
metadata name = 'avm/ptn/azd/container-apps-stack'
metadata description = '''Creates an Azure Container Registry and an Azure Container Apps environment.

**Note:** This module is not intended for broad, generic use, as it was designed to cater for the requirements of the AZD CLI product. Feature requests and bug fix requests are welcome if they support the development of the AZD CLI but may not be incorporated if they aim to make this module more generic than what it needs to be for its primary use case'''
metadata owner = 'Azure/module-maintainers'

@description('Optional. Location for all Resources.')
Expand Down Expand Up @@ -68,7 +70,7 @@ param infrastructureResourceGroupName string = take('ME_${containerAppsEnvironme

#disable-next-line no-deployments-resources
resource avmTelemetry 'Microsoft.Resources/deployments@2023-07-01' = if (enableTelemetry) {
name: '46d3xbcp.ptn.azd-containerapps.${replace('-..--..-', '.', '-')}.${substring(uniqueString(deployment().name, location), 0, 4)}'
name: '46d3xbcp.ptn.azd-containerappsstack.${replace('-..--..-', '.', '-')}.${substring(uniqueString(deployment().name, location), 0, 4)}'
properties: {
mode: 'Incremental'
template: {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,11 @@
"metadata": {
"_generator": {
"name": "bicep",
"version": "0.28.1.47646",
"templateHash": "3154922260961626340"
"version": "0.30.23.60470",
"templateHash": "387393512206698716"
},
"name": "avm/ptn/azd/container-apps",
"description": "Creates an Azure Container Registry and an Azure Container Apps environment.",
"name": "avm/ptn/azd/container-apps-stack",
"description": "Creates an Azure Container Registry and an Azure Container Apps environment.\n\n**Note:** This module is not intended for broad, generic use, as it was designed to cater for the requirements of the AZD CLI product. Feature requests and bug fix requests are welcome if they support the development of the AZD CLI but may not be incorporated if they aim to make this module more generic than what it needs to be for its primary use case",
"owner": "Azure/module-maintainers"
},
"parameters": {
Expand Down Expand Up @@ -154,7 +154,7 @@
"condition": "[parameters('enableTelemetry')]",
"type": "Microsoft.Resources/deployments",
"apiVersion": "2023-07-01",
"name": "[format('46d3xbcp.ptn.azd-containerapps.{0}.{1}', replace('-..--..-', '.', '-'), substring(uniqueString(deployment().name, parameters('location')), 0, 4))]",
"name": "[format('46d3xbcp.ptn.azd-containerappsstack.{0}.{1}', replace('-..--..-', '.', '-'), substring(uniqueString(deployment().name, parameters('location')), 0, 4))]",
"properties": {
"mode": "Incremental",
"template": {
Expand Down