Skip to content

Commit

Permalink
docs: update docs with FAQ on roadmap and banner for upcoming breakin…
Browse files Browse the repository at this point in the history
…g changes (#1008)
  • Loading branch information
matt-FFFFFF authored Jun 25, 2024
1 parent 7356e5c commit 35927bb
Show file tree
Hide file tree
Showing 3 changed files with 32 additions and 0 deletions.
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,17 @@ Detailed information about how to use, configure and extend this module can be f
- [Frequently Asked Questions](https://github.com/Azure/terraform-azurerm-caf-enterprise-scale/wiki/Frequently-Asked-Questions)
- [Troubleshooting](https://github.com/Azure/terraform-azurerm-caf-enterprise-scale/wiki/Troubleshooting)

## ‼ Notice of upcoming breaking changes

We are planning to make some breaking changes to the module in the next release (Q4 2024).

- Module defaults will updated to deploy zone redundant SKUs by default - this applies to:
- Firewall
- Public IP
- Virtual Network Gateway

We will publish guidance on how to avoid re-deployment of existing resources nearer the time.

## Overview

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.
Expand Down
11 changes: 11 additions & 0 deletions _README_header.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,17 @@ Detailed information about how to use, configure and extend this module can be f
- [Frequently Asked Questions](https://github.com/Azure/terraform-azurerm-caf-enterprise-scale/wiki/Frequently-Asked-Questions)
- [Troubleshooting](https://github.com/Azure/terraform-azurerm-caf-enterprise-scale/wiki/Troubleshooting)

## ‼ Notice of upcoming breaking changes

We are planning to make some breaking changes to the module in the next release (Q4 2024).

- Module defaults will updated to deploy zone redundant SKUs by default - this applies to:
- Firewall
- Public IP
- Virtual Network Gateway

We will publish guidance on how to avoid re-deployment of existing resources nearer the time.

## Overview

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.
Expand Down
10 changes: 10 additions & 0 deletions docs/wiki/Frequently-Asked-Questions.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,16 @@ In large environments, costs can also increase when large volumes of data are be

To see further guidance regarding costs for Azure landing zones, please refer to our [pricing guidance][alz_pricing] page.

### General questions

#### With the upcoming release of the new Azure Landing Zones [AVM](https://aka.ms/avm) module, what is the future for this module and what should I do today?

The Azure Landing Zones Terraform module (`caf-enterprise-scale`) is still our recommendation for customers looking to accelerate deployments.

We are working on a new set of more focussed modules that can be combined like Lego bricks to achieve the outcome you are looking for. These will be published as AVM modules. However, these are not all ready yet. We will publish guidance on the roadmap (including migration advice) in the coming months.

We do want to reassure customers that the caf-enterprise-scale module will remain supported once we release the new set of modules.

[//]: # (************************)
[//]: # (INSERT LINK LABELS BELOW)
[//]: # (************************)
Expand Down

0 comments on commit 35927bb

Please sign in to comment.