From 409560d3008ca1c524fe41357aa81add9d5e4718 Mon Sep 17 00:00:00 2001 From: AlexanderSehr Date: Tue, 12 Sep 2023 22:58:28 +0200 Subject: [PATCH 01/12] Update to latest --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index f9c0dd06d6..9c74855d18 100644 --- a/README.md +++ b/README.md @@ -8,11 +8,11 @@ The CI environment supports both ARM and Bicep and can be leveraged using GitHub

Upcoming breaking changes

-In between now and the release of version `0.11.0`, the `main` branch is subject to several upcoming breaking changes that will affect all modules (e.g., the renaming of folders and files). +The most recet release [`0.11.0`](https://github.com/Azure/ResourceModules/releases/tag/v0.11.0) of CARML is simultaneously the last in which the library (i.e., the modules) and CI environment are hosted in one location. Going forward, the maintainers of CARML will implement the remaining changes required to align the modules to the developed [Azure Verified Modules](aka.ms/avm) specifications. This will enable us to move & publish the library in the official [Public Bicep Registry](https://github.com/Azure/bicep-registry-modules). -The rationale is an ongoing effort to prepare our modules for a release in the official [Public Bicep Registry](https://github.com/Azure/bicep-registry-modules), forcing us to align the structural requirements. +Please note that these changes will affect many interfaces (e.g., the diagnostic settings). We intend to keep this period as small as possible, but are limited by our own available capacity. -For more details, please refer to the issue #3131. +Once the move concluded, the library & CI environment will continue to exist and be maintained. However, several changes to the CARML CI-Environment will become necessary to ensure a low entry barrier when onbordining both (for example, we will need to be less restrictive in our tests). ## Get started From dc3788acbd6bf48f3e4d4822399e216eea8e45ce Mon Sep 17 00:00:00 2001 From: Alexander Sehr Date: Wed, 13 Sep 2023 09:03:42 +0200 Subject: [PATCH 02/12] Update README.md --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 9c74855d18..4267c8dc0f 100644 --- a/README.md +++ b/README.md @@ -8,9 +8,9 @@ The CI environment supports both ARM and Bicep and can be leveraged using GitHub

Upcoming breaking changes

-The most recet release [`0.11.0`](https://github.com/Azure/ResourceModules/releases/tag/v0.11.0) of CARML is simultaneously the last in which the library (i.e., the modules) and CI environment are hosted in one location. Going forward, the maintainers of CARML will implement the remaining changes required to align the modules to the developed [Azure Verified Modules](aka.ms/avm) specifications. This will enable us to move & publish the library in the official [Public Bicep Registry](https://github.com/Azure/bicep-registry-modules). +Following the recent release of [`0.11.0`](https://github.com/Azure/ResourceModules/releases/tag/v0.11.0), the upcoming period will focus on implementing the remaining changes required to align the modules to the developed [Azure Verified Modules](aka.ms/avm) specifications. This will enable us to move & publish the library to the official [Public Bicep Registry](https://github.com/Azure/bicep-registry-modules). -Please note that these changes will affect many interfaces (e.g., the diagnostic settings). We intend to keep this period as small as possible, but are limited by our own available capacity. +Please note that these changes will affect many interfaces (e.g., the diagnostic settings). We intend to keep this period as small as possible, but are limited by our own available capacity. As we want to avoid one 'big bang' migration, we will incrementally move modules, but keep a copy in this repository until the move is concluded. For modules that were already published, we will redirect the proposed changes to the new [repository](https://github.com/Azure/bicep-registry-modules) and it's AVM folder. In its final state, this folder will continue all modules you can currently find in this repository's 'modules' folder. Once the move concluded, the library & CI environment will continue to exist and be maintained. However, several changes to the CARML CI-Environment will become necessary to ensure a low entry barrier when onbordining both (for example, we will need to be less restrictive in our tests). From a98577230d6528830effefcfdb28b154e5075d4b Mon Sep 17 00:00:00 2001 From: Alexander Sehr Date: Wed, 13 Sep 2023 09:04:50 +0200 Subject: [PATCH 03/12] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 4267c8dc0f..5ad452b5b1 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ This repository includes a library of mature and curated [Bicep][Bicep] modules The CI environment supports both ARM and Bicep and can be leveraged using GitHub actions as well as Azure DevOps pipelines. -

Upcoming breaking changes

+

⚠️ Upcoming breaking changes ⚠️

Following the recent release of [`0.11.0`](https://github.com/Azure/ResourceModules/releases/tag/v0.11.0), the upcoming period will focus on implementing the remaining changes required to align the modules to the developed [Azure Verified Modules](aka.ms/avm) specifications. This will enable us to move & publish the library to the official [Public Bicep Registry](https://github.com/Azure/bicep-registry-modules). From 6f585cf114f0e28a4d95e9a89b130a3c0562dedf Mon Sep 17 00:00:00 2001 From: Alexander Sehr Date: Wed, 13 Sep 2023 09:05:30 +0200 Subject: [PATCH 04/12] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 5ad452b5b1..c4321e4cc9 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ The CI environment supports both ARM and Bicep and can be leveraged using GitHub Following the recent release of [`0.11.0`](https://github.com/Azure/ResourceModules/releases/tag/v0.11.0), the upcoming period will focus on implementing the remaining changes required to align the modules to the developed [Azure Verified Modules](aka.ms/avm) specifications. This will enable us to move & publish the library to the official [Public Bicep Registry](https://github.com/Azure/bicep-registry-modules). -Please note that these changes will affect many interfaces (e.g., the diagnostic settings). We intend to keep this period as small as possible, but are limited by our own available capacity. As we want to avoid one 'big bang' migration, we will incrementally move modules, but keep a copy in this repository until the move is concluded. For modules that were already published, we will redirect the proposed changes to the new [repository](https://github.com/Azure/bicep-registry-modules) and it's AVM folder. In its final state, this folder will continue all modules you can currently find in this repository's 'modules' folder. +Please note that these changes will affect many interfaces (e.g., the diagnostic settings). We intend to keep this period as small as possible, but are limited by our own available capacity. As we want to avoid one 'big bang' migration, we will incrementally align & move modules, but keep a copy in this repository until the move is concluded. For modules that were already published, we will redirect the proposed changes to the new [repository](https://github.com/Azure/bicep-registry-modules) and it's AVM folder. In its final state, this folder will continue all modules you can currently find in this repository's 'modules' folder. Once the move concluded, the library & CI environment will continue to exist and be maintained. However, several changes to the CARML CI-Environment will become necessary to ensure a low entry barrier when onbordining both (for example, we will need to be less restrictive in our tests). From 77ec8eda845b479ebc2b4e7282e684cd6e7c9ad9 Mon Sep 17 00:00:00 2001 From: Alexander Sehr Date: Wed, 13 Sep 2023 09:07:34 +0200 Subject: [PATCH 05/12] Update README.md --- README.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/README.md b/README.md index c4321e4cc9..93c75f2426 100644 --- a/README.md +++ b/README.md @@ -12,6 +12,11 @@ Following the recent release of [`0.11.0`](https://github.com/Azure/ResourceModu Please note that these changes will affect many interfaces (e.g., the diagnostic settings). We intend to keep this period as small as possible, but are limited by our own available capacity. As we want to avoid one 'big bang' migration, we will incrementally align & move modules, but keep a copy in this repository until the move is concluded. For modules that were already published, we will redirect the proposed changes to the new [repository](https://github.com/Azure/bicep-registry-modules) and it's AVM folder. In its final state, this folder will continue all modules you can currently find in this repository's 'modules' folder. +Possible changes include (but are not limited to): +- An update of the extension resource interfaces (i.e., diagnostic settings, RBAC, etc.) +- An update of the `README.md` that comes with each module (including an update of the utility itself) to allow for a more detailed parameter description +- ... + Once the move concluded, the library & CI environment will continue to exist and be maintained. However, several changes to the CARML CI-Environment will become necessary to ensure a low entry barrier when onbordining both (for example, we will need to be less restrictive in our tests). ## Get started From d524daef0bea4d185a05713e78cf4249ffb35c77 Mon Sep 17 00:00:00 2001 From: Alexander Sehr Date: Wed, 13 Sep 2023 10:55:34 +0200 Subject: [PATCH 06/12] Update README.md --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 93c75f2426..1af9faf458 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,8 @@ Please note that these changes will affect many interfaces (e.g., the diagnostic Possible changes include (but are not limited to): - An update of the extension resource interfaces (i.e., diagnostic settings, RBAC, etc.) - An update of the `README.md` that comes with each module (including an update of the utility itself) to allow for a more detailed parameter description -- ... +- An update to individual folder names +- The addition of several user defined types (requiring Bicep version `0.21.1`) Once the move concluded, the library & CI environment will continue to exist and be maintained. However, several changes to the CARML CI-Environment will become necessary to ensure a low entry barrier when onbordining both (for example, we will need to be less restrictive in our tests). From 229d6ccd59141b01c16440fc146972c0441318c6 Mon Sep 17 00:00:00 2001 From: Alexander Sehr Date: Wed, 13 Sep 2023 11:01:07 +0200 Subject: [PATCH 07/12] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 1af9faf458..2a1bf793e2 100644 --- a/README.md +++ b/README.md @@ -18,7 +18,7 @@ Possible changes include (but are not limited to): - An update to individual folder names - The addition of several user defined types (requiring Bicep version `0.21.1`) -Once the move concluded, the library & CI environment will continue to exist and be maintained. However, several changes to the CARML CI-Environment will become necessary to ensure a low entry barrier when onbordining both (for example, we will need to be less restrictive in our tests). +Once the move concluded, the library & CI environment will continue to exist and be maintained. However, several changes to the CARML CI-Environment will become necessary to ensure a low entry barrier when onbordining both (for example, as per the AVM specs we will need to be less restrictive in our tests). ## Get started From 1df1711f89f573a1f515bfb351cbdfa064112a7e Mon Sep 17 00:00:00 2001 From: Alexander Sehr Date: Wed, 13 Sep 2023 19:09:46 +0200 Subject: [PATCH 08/12] Update README.md Co-authored-by: Erika Gressi <56914614+eriqua@users.noreply.github.com> --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 2a1bf793e2..cb530073dd 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ The CI environment supports both ARM and Bicep and can be leveraged using GitHub Following the recent release of [`0.11.0`](https://github.com/Azure/ResourceModules/releases/tag/v0.11.0), the upcoming period will focus on implementing the remaining changes required to align the modules to the developed [Azure Verified Modules](aka.ms/avm) specifications. This will enable us to move & publish the library to the official [Public Bicep Registry](https://github.com/Azure/bicep-registry-modules). -Please note that these changes will affect many interfaces (e.g., the diagnostic settings). We intend to keep this period as small as possible, but are limited by our own available capacity. As we want to avoid one 'big bang' migration, we will incrementally align & move modules, but keep a copy in this repository until the move is concluded. For modules that were already published, we will redirect the proposed changes to the new [repository](https://github.com/Azure/bicep-registry-modules) and it's AVM folder. In its final state, this folder will continue all modules you can currently find in this repository's 'modules' folder. +Please note that these changes will affect many interfaces (e.g., the diagnostic settings). We intend to keep this period as small as possible, but are limited by our own available capacity. As we want to avoid one 'big bang' migration, we will incrementally align & move modules, but keep a copy in this repository until the move is concluded. For modules that were already published, we will redirect the proposed changes to the new [repository](https://github.com/Azure/bicep-registry-modules) and its AVM folder. In its final state, this folder will continue all modules you can currently find in this repository's 'modules' folder. Possible changes include (but are not limited to): - An update of the extension resource interfaces (i.e., diagnostic settings, RBAC, etc.) From d0f4d0cef318d264c53c76b04594a024ed1e955b Mon Sep 17 00:00:00 2001 From: Alexander Sehr Date: Wed, 13 Sep 2023 19:09:53 +0200 Subject: [PATCH 09/12] Update README.md Co-authored-by: Erika Gressi <56914614+eriqua@users.noreply.github.com> --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index cb530073dd..78c75b0dc9 100644 --- a/README.md +++ b/README.md @@ -18,7 +18,7 @@ Possible changes include (but are not limited to): - An update to individual folder names - The addition of several user defined types (requiring Bicep version `0.21.1`) -Once the move concluded, the library & CI environment will continue to exist and be maintained. However, several changes to the CARML CI-Environment will become necessary to ensure a low entry barrier when onbordining both (for example, as per the AVM specs we will need to be less restrictive in our tests). +Once the move concluded, the library & CI environment will continue to exist and be maintained. However, several changes to the CARML CI environment will become necessary to ensure a low entry barrier when onboarding both (for example, as per the AVM specs we will need to be less restrictive in our tests). ## Get started From b4796a2aee99a239ca836d4d973db413cd342051 Mon Sep 17 00:00:00 2001 From: Mate Barabas Date: Tue, 19 Sep 2023 11:34:01 +0100 Subject: [PATCH 10/12] disclaimer updates --- README.md | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 78c75b0dc9..0e971a6bf0 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,8 @@ -# ![AzureIcon] Common Azure Resource Modules Library - -## Description - -This repository includes a library of mature and curated [Bicep][Bicep] modules as well as a Continuous Integration (CI) environment leveraged for modules' validation and versioned publishing. - -The CI environment supports both ARM and Bicep and can be leveraged using GitHub actions as well as Azure DevOps pipelines. - -

⚠️ Upcoming breaking changes ⚠️

+

⚠️ Upcoming breaking changes ⚠️

-Following the recent release of [`0.11.0`](https://github.com/Azure/ResourceModules/releases/tag/v0.11.0), the upcoming period will focus on implementing the remaining changes required to align the modules to the developed [Azure Verified Modules](aka.ms/avm) specifications. This will enable us to move & publish the library to the official [Public Bicep Registry](https://github.com/Azure/bicep-registry-modules). +Following the recent release of [`0.11.0`](https://github.com/Azure/ResourceModules/releases/tag/v0.11.0), the upcoming period will focus on implementing the remaining changes required to align CARML's modules to the specifications of [Azure Verified Modules](https://aka.ms/avm) (currently in development). This will enable us to move & publish the modules of the CARML library to the official [Public Bicep Registry](https://github.com/Azure/bicep-registry-modules). You can read more about CARML's future in AVM [here](https://azure.github.io/Azure-Verified-Modules/faq/#what-is-happening-to-existing-initiatives-like-carml-and-tfvm). -Please note that these changes will affect many interfaces (e.g., the diagnostic settings). We intend to keep this period as small as possible, but are limited by our own available capacity. As we want to avoid one 'big bang' migration, we will incrementally align & move modules, but keep a copy in this repository until the move is concluded. For modules that were already published, we will redirect the proposed changes to the new [repository](https://github.com/Azure/bicep-registry-modules) and its AVM folder. In its final state, this folder will continue all modules you can currently find in this repository's 'modules' folder. +Please note that these changes will affect many interfaces (e.g., the diagnostic settings). We intend to keep this period as short as possible, but are limited by our own available capacity. As we want to avoid one 'big bang' migration, we will incrementally align & move modules, and keep a copy in this repository until the move is concluded. For modules that were already published, we will redirect the proposed changes to the `AVM` folder of the new [repository](https://github.com/Azure/bicep-registry-modules). In its final state, this `AVM` folder will continue all modules you can currently find in the `modules` folder of this repository. Possible changes include (but are not limited to): - An update of the extension resource interfaces (i.e., diagnostic settings, RBAC, etc.) @@ -20,6 +12,14 @@ Possible changes include (but are not limited to): Once the move concluded, the library & CI environment will continue to exist and be maintained. However, several changes to the CARML CI environment will become necessary to ensure a low entry barrier when onboarding both (for example, as per the AVM specs we will need to be less restrictive in our tests). +# ![AzureIcon] Common Azure Resource Modules Library + +## Description + +This repository includes a library of mature and curated [Bicep][Bicep] modules as well as a Continuous Integration (CI) environment leveraged for modules' validation and versioned publishing. + +The CI environment supports both ARM and Bicep and can be leveraged using GitHub actions as well as Azure DevOps pipelines. + ## Get started * For introduction guidance visit the [Wiki](https://github.com/Azure/ResourceModules/wiki) From 4a2d327c3cf975b2204cf094bc757bcfd3f692ea Mon Sep 17 00:00:00 2001 From: Alexander Sehr Date: Tue, 19 Sep 2023 11:45:38 +0100 Subject: [PATCH 11/12] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 0e971a6bf0..1d0534d203 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ Following the recent release of [`0.11.0`](https://github.com/Azure/ResourceModules/releases/tag/v0.11.0), the upcoming period will focus on implementing the remaining changes required to align CARML's modules to the specifications of [Azure Verified Modules](https://aka.ms/avm) (currently in development). This will enable us to move & publish the modules of the CARML library to the official [Public Bicep Registry](https://github.com/Azure/bicep-registry-modules). You can read more about CARML's future in AVM [here](https://azure.github.io/Azure-Verified-Modules/faq/#what-is-happening-to-existing-initiatives-like-carml-and-tfvm). -Please note that these changes will affect many interfaces (e.g., the diagnostic settings). We intend to keep this period as short as possible, but are limited by our own available capacity. As we want to avoid one 'big bang' migration, we will incrementally align & move modules, and keep a copy in this repository until the move is concluded. For modules that were already published, we will redirect the proposed changes to the `AVM` folder of the new [repository](https://github.com/Azure/bicep-registry-modules). In its final state, this `AVM` folder will continue all modules you can currently find in the `modules` folder of this repository. +Please note that these changes will affect many interfaces (e.g., the diagnostic settings). We intend to keep this period as short as possible, but are limited by our own available capacity. As we want to avoid one 'big bang' migration, we will incrementally align & move modules, and keep a copy in this repository until the move is concluded. For modules that were already published, we will redirect the proposed changes to the `AVM` folder of the new [repository](https://github.com/Azure/bicep-registry-modules). In its final state, this `AVM` folder will contain all modules you can currently find in the `modules` folder of this repository. Possible changes include (but are not limited to): - An update of the extension resource interfaces (i.e., diagnostic settings, RBAC, etc.) From f61b9b5791e84c0d0b22e8a150aaa85cf0e66db7 Mon Sep 17 00:00:00 2001 From: Alexander Sehr Date: Tue, 19 Sep 2023 11:48:09 +0100 Subject: [PATCH 12/12] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 1d0534d203..76e16140af 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ Possible changes include (but are not limited to): - An update to individual folder names - The addition of several user defined types (requiring Bicep version `0.21.1`) -Once the move concluded, the library & CI environment will continue to exist and be maintained. However, several changes to the CARML CI environment will become necessary to ensure a low entry barrier when onboarding both (for example, as per the AVM specs we will need to be less restrictive in our tests). +Once the move concluded, the library & CI environment is planned to be maintained. However, several changes to the CARML CI environment will become necessary to ensure a low entry barrier when onboarding both (for example, as per the AVM specs we will need to be less restrictive in our tests). # ![AzureIcon] Common Azure Resource Modules Library