Skip to content

Commit 9347c06

Browse files
authored
docs: add deprecation notice for Terraform CAF Enterprise Scale module (#1298)
Adds deprecation notice to all modules
1 parent ab15ee3 commit 9347c06

File tree

12 files changed

+382
-44
lines changed

12 files changed

+382
-44
lines changed

README.md

Lines changed: 31 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,38 @@
44
> [!IMPORTANT]
55
> For new deployments we now recommend using Azure Verified Modules for Platform Landing Zones.
66
> Please see the documentation at <https://aka.ms/alz/tf>.
7-
> This module will continue to be supported for existing deployments.
87
9-
[![Build Status](https://dev.azure.com/mscet/CAE-ALZ-Terraform/_apis/build/status/Tests/E2E?branchName=refs%2Ftags%2Fv6.0.0)](https://dev.azure.com/mscet/CAE-ALZ-Terraform/_build/latest?definitionId=26&branchName=refs%2Ftags%2Fv6.0.0)
10-
![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/Azure/terraform-azurerm-caf-enterprise-scale?style=flat&logo=github)
11-
[![Average time to resolve an issue](http://isitmaintained.com/badge/resolution/azure/terraform-azurerm-caf-enterprise-scale.svg)](http://isitmaintained.com/project/azure/terraform-azurerm-caf-enterprise-scale "Average time to resolve an issue")
12-
[![Percentage of issues still open](http://isitmaintained.com/badge/open/azure/terraform-azurerm-caf-enterprise-scale.svg)](http://isitmaintained.com/project/azure/terraform-azurerm-caf-enterprise-scale "Percentage of issues still open")
13-
[![OpenSSF Scorecard](https://api.scorecard.dev/projects/github.com/Azure/terraform-azurerm-caf-enterprise-scale/badge)](https://scorecard.dev/viewer/?uri=github.com/Azure/terraform-azurerm-caf-enterprise-scale)
8+
## ⚠️ DEPRECATION NOTICE
9+
10+
**This module is now in extended support mode and will be archived on August 1, 2026.**
11+
12+
### Current Status
13+
14+
- **Extended Support Period**: This module is now in extended support for one year (until August 1, 2026)
15+
- **Support Scope**: During this period, we will provide quality updates (e.g. bug fixes) and policy library updates only
16+
- **No New Features**: No new features or functionality will be added to this module
17+
18+
### Migration Path
19+
20+
We strongly recommend that all users migrate to the new **Azure Verified Modules** approach for Azure Landing Zones. This new approach provides:
21+
22+
- Enhanced reliability and testing
23+
- Improved modularity and flexibility
24+
- Better alignment with Azure best practices
25+
- Ongoing feature development and support
26+
27+
**Further reading**: Please read our recent [blog](https://techcommunity.microsoft.com/blog/azuretoolsblog/terraform-azure-verified-modules-for-platform-landing-zone-alz-migration-guidanc/4432035)
28+
29+
**Migration Guide**: Please visit [aka.ms/alz/tf/migrate](https://aka.ms/alz/tf/migrate) for detailed migration guidance and resources.
30+
31+
### Timeline
32+
33+
- **Now - August 1, 2026**: Extended support (quality and policy updates only)
34+
- **August 1, 2026**: Repository will be archived and no further updates will be made
35+
36+
### Questions?
37+
38+
If you have questions about the migration process or need assistance, please refer to the migration documentation or raise an issue in the repository before the archive date.
1439

1540
Detailed information about how to use, configure and extend this module can be found on our Wiki:
1641

@@ -20,17 +45,6 @@ Detailed information about how to use, configure and extend this module can be f
2045
- [Frequently Asked Questions](https://github.com/Azure/terraform-azurerm-caf-enterprise-scale/wiki/Frequently-Asked-Questions)
2146
- [Troubleshooting](https://github.com/Azure/terraform-azurerm-caf-enterprise-scale/wiki/Troubleshooting)
2247

23-
## ‼ Notice of upcoming breaking changes
24-
25-
We are planning to make some breaking changes to the module in the next release (Q4 2024).
26-
27-
- Module defaults will updated to deploy zone redundant SKUs by default - this applies to:
28-
- Firewall
29-
- Public IP
30-
- Virtual Network Gateway
31-
32-
We will publish guidance on how to avoid re-deployment of existing resources nearer the time.
33-
3448
## Overview
3549

3650
The [Azure landing zones Terraform module](https://registry.terraform.io/modules/Azure/caf-enterprise-scale/azurerm/latest) is designed to accelerate deployment of platform resources based on the [Azure landing zones conceptual architecture](https://learn.microsoft.com/azure/cloud-adoption-framework/ready/landing-zone#azure-landing-zone-conceptual-architecture) using Terraform.

_README_header.md

Lines changed: 31 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,38 @@
33
> [!IMPORTANT]
44
> For new deployments we now recommend using Azure Verified Modules for Platform Landing Zones.
55
> Please see the documentation at <https://aka.ms/alz/tf>.
6-
> This module will continue to be supported for existing deployments.
76
8-
[![Build Status](https://dev.azure.com/mscet/CAE-ALZ-Terraform/_apis/build/status/Tests/E2E?branchName=refs%2Ftags%2Fv6.0.0)](https://dev.azure.com/mscet/CAE-ALZ-Terraform/_build/latest?definitionId=26&branchName=refs%2Ftags%2Fv6.0.0)
9-
![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/Azure/terraform-azurerm-caf-enterprise-scale?style=flat&logo=github)
10-
[![Average time to resolve an issue](http://isitmaintained.com/badge/resolution/azure/terraform-azurerm-caf-enterprise-scale.svg)](http://isitmaintained.com/project/azure/terraform-azurerm-caf-enterprise-scale "Average time to resolve an issue")
11-
[![Percentage of issues still open](http://isitmaintained.com/badge/open/azure/terraform-azurerm-caf-enterprise-scale.svg)](http://isitmaintained.com/project/azure/terraform-azurerm-caf-enterprise-scale "Percentage of issues still open")
12-
[![OpenSSF Scorecard](https://api.scorecard.dev/projects/github.com/Azure/terraform-azurerm-caf-enterprise-scale/badge)](https://scorecard.dev/viewer/?uri=github.com/Azure/terraform-azurerm-caf-enterprise-scale)
7+
## ⚠️ DEPRECATION NOTICE
8+
9+
**This module is now in extended support mode and will be archived on August 1, 2026.**
10+
11+
### Current Status
12+
13+
- **Extended Support Period**: This module is now in extended support for one year (until August 1, 2026)
14+
- **Support Scope**: During this period, we will provide quality updates (e.g. bug fixes) and policy library updates only
15+
- **No New Features**: No new features or functionality will be added to this module
16+
17+
### Migration Path
18+
19+
We strongly recommend that all users migrate to the new **Azure Verified Modules** approach for Azure Landing Zones. This new approach provides:
20+
21+
- Enhanced reliability and testing
22+
- Improved modularity and flexibility
23+
- Better alignment with Azure best practices
24+
- Ongoing feature development and support
25+
26+
**Further reading**: Please read our recent [blog](https://techcommunity.microsoft.com/blog/azuretoolsblog/terraform-azure-verified-modules-for-platform-landing-zone-alz-migration-guidanc/4432035)
27+
28+
**Migration Guide**: Please visit [aka.ms/alz/tf/migrate](https://aka.ms/alz/tf/migrate) for detailed migration guidance and resources.
29+
30+
### Timeline
31+
32+
- **Now - August 1, 2026**: Extended support (quality and policy updates only)
33+
- **August 1, 2026**: Repository will be archived and no further updates will be made
34+
35+
### Questions?
36+
37+
If you have questions about the migration process or need assistance, please refer to the migration documentation or raise an issue in the repository before the archive date.
1338

1439
Detailed information about how to use, configure and extend this module can be found on our Wiki:
1540

@@ -19,17 +44,6 @@ Detailed information about how to use, configure and extend this module can be f
1944
- [Frequently Asked Questions](https://github.com/Azure/terraform-azurerm-caf-enterprise-scale/wiki/Frequently-Asked-Questions)
2045
- [Troubleshooting](https://github.com/Azure/terraform-azurerm-caf-enterprise-scale/wiki/Troubleshooting)
2146

22-
## ‼ Notice of upcoming breaking changes
23-
24-
We are planning to make some breaking changes to the module in the next release (Q4 2024).
25-
26-
- Module defaults will updated to deploy zone redundant SKUs by default - this applies to:
27-
- Firewall
28-
- Public IP
29-
- Virtual Network Gateway
30-
31-
We will publish guidance on how to avoid re-deployment of existing resources nearer the time.
32-
3347
## Overview
3448

3549
The [Azure landing zones Terraform module](https://registry.terraform.io/modules/Azure/caf-enterprise-scale/azurerm/latest) is designed to accelerate deployment of platform resources based on the [Azure landing zones conceptual architecture](https://learn.microsoft.com/azure/cloud-adoption-framework/ready/landing-zone#azure-landing-zone-conceptual-architecture) using Terraform.

modules/archetypes/README.md

Lines changed: 32 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,38 @@
44
> [!IMPORTANT]
55
> For new deployments we now recommend using Azure Verified Modules for Platform Landing Zones.
66
> Please see the documentation at <https://aka.ms/alz/tf>.
7-
> This module will continue to be supported for existing deployments.
7+
8+
## ⚠️ DEPRECATION NOTICE
9+
10+
**This module is now in extended support mode and will be archived on August 1, 2026.**
11+
12+
### Current Status
13+
14+
- **Extended Support Period**: This module is now in extended support for one year (until August 1, 2026)
15+
- **Support Scope**: During this period, we will provide quality updates (e.g. bug fixes) and policy library updates only
16+
- **No New Features**: No new features or functionality will be added to this module
17+
18+
### Migration Path
19+
20+
We strongly recommend that all users migrate to the new **Azure Verified Modules** approach for Azure Landing Zones. This new approach provides:
21+
22+
- Enhanced reliability and testing
23+
- Improved modularity and flexibility
24+
- Better alignment with Azure best practices
25+
- Ongoing feature development and support
26+
27+
**Further reading**: Please read our recent [blog](https://techcommunity.microsoft.com/blog/azuretoolsblog/terraform-azure-verified-modules-for-platform-landing-zone-alz-migration-guidanc/4432035)
28+
29+
**Migration Guide**: Please visit [aka.ms/alz/tf/migrate](https://aka.ms/alz/tf/migrate) for detailed migration guidance and resources.
30+
31+
### Timeline
32+
33+
- **Now - August 1, 2026**: Extended support (quality and policy updates only)
34+
- **August 1, 2026**: Repository will be archived and no further updates will be made
35+
36+
### Questions?
37+
38+
If you have questions about the migration process or need assistance, please refer to the migration documentation or raise an issue in the repository before the archive date.
839

940
## Documentation
1041
<!-- markdownlint-disable MD033 -->

modules/archetypes/_README_header.md

Lines changed: 32 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,35 @@
33
> [!IMPORTANT]
44
> For new deployments we now recommend using Azure Verified Modules for Platform Landing Zones.
55
> Please see the documentation at <https://aka.ms/alz/tf>.
6-
> This module will continue to be supported for existing deployments.
6+
7+
## ⚠️ DEPRECATION NOTICE
8+
9+
**This module is now in extended support mode and will be archived on August 1, 2026.**
10+
11+
### Current Status
12+
13+
- **Extended Support Period**: This module is now in extended support for one year (until August 1, 2026)
14+
- **Support Scope**: During this period, we will provide quality updates (e.g. bug fixes) and policy library updates only
15+
- **No New Features**: No new features or functionality will be added to this module
16+
17+
### Migration Path
18+
19+
We strongly recommend that all users migrate to the new **Azure Verified Modules** approach for Azure Landing Zones. This new approach provides:
20+
21+
- Enhanced reliability and testing
22+
- Improved modularity and flexibility
23+
- Better alignment with Azure best practices
24+
- Ongoing feature development and support
25+
26+
**Further reading**: Please read our recent [blog](https://techcommunity.microsoft.com/blog/azuretoolsblog/terraform-azure-verified-modules-for-platform-landing-zone-alz-migration-guidanc/4432035)
27+
28+
**Migration Guide**: Please visit [aka.ms/alz/tf/migrate](https://aka.ms/alz/tf/migrate) for detailed migration guidance and resources.
29+
30+
### Timeline
31+
32+
- **Now - August 1, 2026**: Extended support (quality and policy updates only)
33+
- **August 1, 2026**: Repository will be archived and no further updates will be made
34+
35+
### Questions?
36+
37+
If you have questions about the migration process or need assistance, please refer to the migration documentation or raise an issue in the repository before the archive date.

modules/connectivity/README.md

Lines changed: 32 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,38 @@
44
> [!IMPORTANT]
55
> For new deployments we now recommend using Azure Verified Modules for Platform Landing Zones.
66
> Please see the documentation at <https://aka.ms/alz/tf>.
7-
> This module will continue to be supported for existing deployments.
7+
8+
## ⚠️ DEPRECATION NOTICE
9+
10+
**This module is now in extended support mode and will be archived on August 1, 2026.**
11+
12+
### Current Status
13+
14+
- **Extended Support Period**: This module is now in extended support for one year (until August 1, 2026)
15+
- **Support Scope**: During this period, we will provide quality updates (e.g. bug fixes) and policy library updates only
16+
- **No New Features**: No new features or functionality will be added to this module
17+
18+
### Migration Path
19+
20+
We strongly recommend that all users migrate to the new **Azure Verified Modules** approach for Azure Landing Zones. This new approach provides:
21+
22+
- Enhanced reliability and testing
23+
- Improved modularity and flexibility
24+
- Better alignment with Azure best practices
25+
- Ongoing feature development and support
26+
27+
**Further reading**: Please read our recent [blog](https://techcommunity.microsoft.com/blog/azuretoolsblog/terraform-azure-verified-modules-for-platform-landing-zone-alz-migration-guidanc/4432035)
28+
29+
**Migration Guide**: Please visit [aka.ms/alz/tf/migrate](https://aka.ms/alz/tf/migrate) for detailed migration guidance and resources.
30+
31+
### Timeline
32+
33+
- **Now - August 1, 2026**: Extended support (quality and policy updates only)
34+
- **August 1, 2026**: Repository will be archived and no further updates will be made
35+
36+
### Questions?
37+
38+
If you have questions about the migration process or need assistance, please refer to the migration documentation or raise an issue in the repository before the archive date.
839

940
## Documentation
1041
<!-- markdownlint-disable MD033 -->

modules/connectivity/_README_header.md

Lines changed: 32 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,35 @@
33
> [!IMPORTANT]
44
> For new deployments we now recommend using Azure Verified Modules for Platform Landing Zones.
55
> Please see the documentation at <https://aka.ms/alz/tf>.
6-
> This module will continue to be supported for existing deployments.
6+
7+
## ⚠️ DEPRECATION NOTICE
8+
9+
**This module is now in extended support mode and will be archived on August 1, 2026.**
10+
11+
### Current Status
12+
13+
- **Extended Support Period**: This module is now in extended support for one year (until August 1, 2026)
14+
- **Support Scope**: During this period, we will provide quality updates (e.g. bug fixes) and policy library updates only
15+
- **No New Features**: No new features or functionality will be added to this module
16+
17+
### Migration Path
18+
19+
We strongly recommend that all users migrate to the new **Azure Verified Modules** approach for Azure Landing Zones. This new approach provides:
20+
21+
- Enhanced reliability and testing
22+
- Improved modularity and flexibility
23+
- Better alignment with Azure best practices
24+
- Ongoing feature development and support
25+
26+
**Further reading**: Please read our recent [blog](https://techcommunity.microsoft.com/blog/azuretoolsblog/terraform-azure-verified-modules-for-platform-landing-zone-alz-migration-guidanc/4432035)
27+
28+
**Migration Guide**: Please visit [aka.ms/alz/tf/migrate](https://aka.ms/alz/tf/migrate) for detailed migration guidance and resources.
29+
30+
### Timeline
31+
32+
- **Now - August 1, 2026**: Extended support (quality and policy updates only)
33+
- **August 1, 2026**: Repository will be archived and no further updates will be made
34+
35+
### Questions?
36+
37+
If you have questions about the migration process or need assistance, please refer to the migration documentation or raise an issue in the repository before the archive date.

modules/identity/README.md

Lines changed: 32 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,38 @@
44
> [!IMPORTANT]
55
> For new deployments we now recommend using Azure Verified Modules for Platform Landing Zones.
66
> Please see the documentation at <https://aka.ms/alz/tf>.
7-
> This module will continue to be supported for existing deployments.
7+
8+
## ⚠️ DEPRECATION NOTICE
9+
10+
**This module is now in extended support mode and will be archived on August 1, 2026.**
11+
12+
### Current Status
13+
14+
- **Extended Support Period**: This module is now in extended support for one year (until August 1, 2026)
15+
- **Support Scope**: During this period, we will provide quality updates (e.g. bug fixes) and policy library updates only
16+
- **No New Features**: No new features or functionality will be added to this module
17+
18+
### Migration Path
19+
20+
We strongly recommend that all users migrate to the new **Azure Verified Modules** approach for Azure Landing Zones. This new approach provides:
21+
22+
- Enhanced reliability and testing
23+
- Improved modularity and flexibility
24+
- Better alignment with Azure best practices
25+
- Ongoing feature development and support
26+
27+
**Further reading**: Please read our recent [blog](https://techcommunity.microsoft.com/blog/azuretoolsblog/terraform-azure-verified-modules-for-platform-landing-zone-alz-migration-guidanc/4432035)
28+
29+
**Migration Guide**: Please visit [aka.ms/alz/tf/migrate](https://aka.ms/alz/tf/migrate) for detailed migration guidance and resources.
30+
31+
### Timeline
32+
33+
- **Now - August 1, 2026**: Extended support (quality and policy updates only)
34+
- **August 1, 2026**: Repository will be archived and no further updates will be made
35+
36+
### Questions?
37+
38+
If you have questions about the migration process or need assistance, please refer to the migration documentation or raise an issue in the repository before the archive date.
839

940
## Documentation
1041
<!-- markdownlint-disable MD033 -->

modules/identity/_README_header.md

Lines changed: 32 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,35 @@
33
> [!IMPORTANT]
44
> For new deployments we now recommend using Azure Verified Modules for Platform Landing Zones.
55
> Please see the documentation at <https://aka.ms/alz/tf>.
6-
> This module will continue to be supported for existing deployments.
6+
7+
## ⚠️ DEPRECATION NOTICE
8+
9+
**This module is now in extended support mode and will be archived on August 1, 2026.**
10+
11+
### Current Status
12+
13+
- **Extended Support Period**: This module is now in extended support for one year (until August 1, 2026)
14+
- **Support Scope**: During this period, we will provide quality updates (e.g. bug fixes) and policy library updates only
15+
- **No New Features**: No new features or functionality will be added to this module
16+
17+
### Migration Path
18+
19+
We strongly recommend that all users migrate to the new **Azure Verified Modules** approach for Azure Landing Zones. This new approach provides:
20+
21+
- Enhanced reliability and testing
22+
- Improved modularity and flexibility
23+
- Better alignment with Azure best practices
24+
- Ongoing feature development and support
25+
26+
**Further reading**: Please read our recent [blog](https://techcommunity.microsoft.com/blog/azuretoolsblog/terraform-azure-verified-modules-for-platform-landing-zone-alz-migration-guidanc/4432035)
27+
28+
**Migration Guide**: Please visit [aka.ms/alz/tf/migrate](https://aka.ms/alz/tf/migrate) for detailed migration guidance and resources.
29+
30+
### Timeline
31+
32+
- **Now - August 1, 2026**: Extended support (quality and policy updates only)
33+
- **August 1, 2026**: Repository will be archived and no further updates will be made
34+
35+
### Questions?
36+
37+
If you have questions about the migration process or need assistance, please refer to the migration documentation or raise an issue in the repository before the archive date.

0 commit comments

Comments
 (0)