Skip to content

Commit

Permalink
Update ready for release v2.0.0 (#349)
Browse files Browse the repository at this point in the history
Updates to documentation for upcoming v2.0.0 release
matt-FFFFFF authored Apr 27, 2022

Verified

This commit was signed with the committer’s verified signature.
1 parent 246cf7d commit a0801f9
Showing 32 changed files with 837 additions and 172 deletions.
Original file line number Diff line number Diff line change
@@ -32,7 +32,7 @@ CompanyName = 'krowlandson'
Copyright = 'Copyright (c) 2020 Kevin Rowlandson. All rights reserved.'

# Description of the functionality provided by this module
Description = 'This module provides a set of custom classes and functions used for managing the template library in the Terraform Module for Cloud Adoption Framework Enterprise-scale.'
Description = 'This module provides a set of custom classes and functions used for managing the template library in the Azure landing zones Terraform module.'

# Minimum version of the PowerShell engine required by this module
PowerShellVersion = '7.0'
Original file line number Diff line number Diff line change
@@ -498,8 +498,7 @@ class ArmTemplateResource : ESLTBase {
$this.apiVersion = [ProviderApiVersions]::GetLatestStableByType($ResourceType)
}

# Update resource values as per requirements for Terraform Module
# for Cloud Adoption Framework Enterprise Scale
# Update resource values as per requirements for Azure landing zones Terraform module
[Object] ToTemplateFile() {
if ($this.type -eq "Microsoft.Authorization/policyAssignments") {
$this.properties.scope = "`${current_scope_resource_id}"
146 changes: 66 additions & 80 deletions README.md

Large diffs are not rendered by default.

8 changes: 4 additions & 4 deletions docs/wiki/Home.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Terraform Module for Cloud Adoption Framework Enterprise-scale
# Azure landing zones Terraform module

The [Terraform Module for Cloud Adoption Framework Enterprise-scale][terraform-registry-caf-enterprise-scale] provides an opinionated approach for deploying and managing the core platform capabilities of [Cloud Adoption Framework enterprise-scale landing zone architecture][ESLZ-Architecture] using Terraform, with a focus on the central resource hierarchy:
The [Azure landing zones Terraform module][terraform-registry-caf-enterprise-scale] provides an opinionated approach for deploying and managing the core platform capabilities of [Azure landing zones architecture][ESLZ-Architecture] using Terraform, with a focus on the central resource hierarchy:

![Enterprise-scale Landing Zone Architecture][TFAES-Overview]

@@ -43,14 +43,14 @@ Check out the [User Guide](./User-Guide), or go straight to our [Examples](./Exa
[//]: # (INSERT IMAGE REFERENCES BELOW)
[//]: # (*****************************)

[TFAES-Overview]: ./media/terraform-caf-enterprise-scale-overview.png "Diagram showing the Cloud Adoption Framework Enterprise-scale Landing Zone architecture deployed by this module."
[TFAES-Overview]: ./media/terraform-caf-enterprise-scale-overview.png "Diagram showing the Azure landing zones architecture deployed by this module."

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

[ESLZ-Architecture]: https://docs.microsoft.com/azure/cloud-adoption-framework/ready/enterprise-scale/architecture "Enterprise-scale Reference Architecture"
[terraform-registry-caf-enterprise-scale]: https://registry.terraform.io/modules/Azure/caf-enterprise-scale/azurerm/latest "Terraform Registry: Terraform Module for Cloud Adoption Framework Enterprise-scale"
[terraform-registry-caf-enterprise-scale]: https://registry.terraform.io/modules/Azure/caf-enterprise-scale/azurerm/latest "Terraform Registry: Azure landing zones Terraform module"
[management-group-and-subscription-organization]: https://docs.microsoft.com/azure/cloud-adoption-framework/ready/enterprise-scale/management-group-and-subscription-organization "Cloud Adoption Framework: Management group and subscription organization"
[identity-and-access-management]: https://docs.microsoft.com/azure/cloud-adoption-framework/ready/enterprise-scale/identity-and-access-management "Cloud Adoption Framework: Identity and access management"
[management-and-monitoring]: https://docs.microsoft.com/azure/cloud-adoption-framework/ready/enterprise-scale/management-and-monitoring "Cloud Adoption Framework: Management and monitoring"
2 changes: 1 addition & 1 deletion docs/wiki/Troubleshooting.md
Original file line number Diff line number Diff line change
@@ -2,7 +2,7 @@ Having trouble using the module and unable to find a solution in the Wiki?

If it isn't listed below, let us know about it in our [Issues][Issues] log. We'll do our best to help and you may find your issue documented here in the future!

[Issues]: https://github.com/Azure/terraform-azurerm-caf-enterprise-scale/issues "Terraform Module for Cloud Adoption Framework Enterprise-scale: Report an Issue"
[Issues]: https://github.com/Azure/terraform-azurerm-caf-enterprise-scale/issues "Azure landing zones Terraform module: Report an Issue"

#### Errors creating Role Definitions and Role Assignments

Original file line number Diff line number Diff line change
@@ -137,12 +137,12 @@ It also contains the module declaration for this module, containing a number of
data "azurerm_client_config" "core" {}
# Declare the Terraform Module for Cloud Adoption Framework
# Enterprise-scale and provide a base configuration.
# Declare the Azure landing zones Terraform module
# and provide a base configuration.
module "enterprise_scale" {
source = "Azure/caf-enterprise-scale/azurerm"
version = "1.1.4"
version = "2.0.0"
providers = {
azurerm = azurerm
4 changes: 2 additions & 2 deletions docs/wiki/[Examples]-Deploy-Connectivity-Resources.md
Original file line number Diff line number Diff line change
@@ -3,7 +3,7 @@
This page describes how to deploy Enterprise-scale with the [Connectivity resources][wiki_connectivity_resources] created in the current Subscription context, using the default configuration settings.

As connectivity resources can start to significantly increase Azure consumption costs, the module defaults are aimed to help build the basic connectivity configuration whilst minimising cost.
Please refer to the Cloud Adoption Framework [Network topology and connectivity][ESLZ-Connectivity] recommendations to better understand which of these settings you should enable in a Production environment.
Please refer to the [Network topology and connectivity][ESLZ-Connectivity] recommendations to better understand which of these settings you should enable in a Production environment.

In this example, we take the [default configuration][wiki_deploy_default_configuration] and make the following changes:

@@ -65,7 +65,7 @@ data "azurerm_client_config" "core" {}
module "enterprise_scale" {
source = "Azure/caf-enterprise-scale/azurerm"
version = "1.1.4"
version = "2.0.0"
providers = {
azurerm = azurerm
8 changes: 4 additions & 4 deletions docs/wiki/[Examples]-Deploy-Custom-Landing-Zone-Archetypes.md
Original file line number Diff line number Diff line change
@@ -89,12 +89,12 @@ To allow the declaration of custom templates, you must create a custom library f
data "azurerm_client_config" "core" {}
# Declare the Terraform Module for Cloud Adoption Framework
# Enterprise-scale and provide a base configuration.
# Declare the Azure landing zones Terraform module
# and provide a base configuration.
module "enterprise_scale" {
source = "Azure/caf-enterprise-scale/azurerm"
version = "1.1.4"
version = "2.0.0"
providers = {
azurerm = azurerm
@@ -144,7 +144,7 @@ module "enterprise_scale" {

> IMPORTANT: Please ensure you create this file in the `/lib` directory within your root module.
The `lib/archetype_definition_customer_online.json` file contains a custom "archetype definition". This is a custom JSON format used specifically by the Terraform Module for Cloud Adoption Framework Enterprise-scale.
The `lib/archetype_definition_customer_online.json` file contains a custom "archetype definition". This is a custom JSON format used specifically by the Azure landing zones Terraform module.

In this example, we are using this archetype definition to create an archetype called `customer_online`. This archetype definition includes the creation of Policy Assignments for `Deny-Resource-Locations` and `Deny-RSG-Locations`, with default values pre-defined in the archetype definition template.

2 changes: 1 addition & 1 deletion docs/wiki/[Examples]-Deploy-Default-Configuration.md
Original file line number Diff line number Diff line change
@@ -44,7 +44,7 @@ data "azurerm_client_config" "core" {}
module "enterprise_scale" {
source = "Azure/caf-enterprise-scale/azurerm"
version = "1.1.4"
version = "2.0.0"
providers = {
azurerm = azurerm
6 changes: 3 additions & 3 deletions docs/wiki/[Examples]-Deploy-Demo-Landing-Zone-Archetypes.md
Original file line number Diff line number Diff line change
@@ -46,12 +46,12 @@ provider "azurerm" {
data "azurerm_client_config" "core" {}
# Declare the Terraform Module for Cloud Adoption Framework
# Enterprise-scale and provide a base configuration.
# Declare the Azure landing zones Terraform module
# and provide a base configuration.
module "enterprise_scale" {
source = "Azure/caf-enterprise-scale/azurerm"
version = "1.1.4"
version = "2.0.0"
providers = {
azurerm = azurerm
Original file line number Diff line number Diff line change
@@ -95,12 +95,12 @@ It also contains the module declaration for this module, containing a number of
data "azurerm_client_config" "core" {}
# Declare the Terraform Module for Cloud Adoption Framework
# Enterprise-scale and provide a base configuration.
# Declare the Azure landing zones Terraform module
# and provide a base configuration.
module "enterprise_scale" {
source = "Azure/caf-enterprise-scale/azurerm"
version = "1.1.4"
version = "2.0.0"
providers = {
azurerm = azurerm
2 changes: 1 addition & 1 deletion docs/wiki/[Examples]-Deploy-Identity-Resources.md
Original file line number Diff line number Diff line change
@@ -58,7 +58,7 @@ data "azurerm_client_config" "core" {}
module "enterprise_scale" {
source = "Azure/caf-enterprise-scale/azurerm"
version = "1.1.4"
version = "2.0.0"
providers = {
azurerm = azurerm
Original file line number Diff line number Diff line change
@@ -125,12 +125,12 @@ It also contains the module declaration for this module, containing a number of
data "azurerm_client_config" "core" {}
# Declare the Terraform Module for Cloud Adoption Framework
# Enterprise-scale and provide a base configuration.
# Declare the Azure landing zones Terraform module
# and provide a base configuration.
module "enterprise_scale" {
source = "Azure/caf-enterprise-scale/azurerm"
version = "1.1.4"
version = "2.0.0"
providers = {
azurerm = azurerm
2 changes: 1 addition & 1 deletion docs/wiki/[Examples]-Deploy-Management-Resources.md
Original file line number Diff line number Diff line change
@@ -59,7 +59,7 @@ data "azurerm_client_config" "core" {}
module "enterprise_scale" {
source = "Azure/caf-enterprise-scale/azurerm"
version = "1.1.4"
version = "2.0.0"
providers = {
azurerm = azurerm
12 changes: 6 additions & 6 deletions docs/wiki/[Examples]-Deploy-Using-Module-Nesting.md
Original file line number Diff line number Diff line change
@@ -12,7 +12,7 @@ The extra code needed to extend your configuration, is the following:
module "enterprise_scale_nested_landing_zone" {
source = "Azure/caf-enterprise-scale/azurerm"
version = "1.1.4"
version = "2.0.0"
providers = {
azurerm = azurerm
@@ -129,12 +129,12 @@ To allow the declaration of custom templates, you must create a custom library f
data "azurerm_client_config" "core" {}
# Declare the Terraform Module for Cloud Adoption Framework
# Enterprise-scale and provide a base configuration.
# Declare the Azure landing zones Terraform module
# and provide a base configuration.
module "enterprise_scale" {
source = "Azure/caf-enterprise-scale/azurerm"
version = "1.1.4"
version = "2.0.0"
providers = {
azurerm = azurerm
@@ -183,7 +183,7 @@ module "enterprise_scale" {
module "enterprise_scale_nested_landing_zone" {
source = "Azure/caf-enterprise-scale/azurerm"
version = "1.1.4"
version = "2.0.0"
providers = {
azurerm = azurerm
@@ -221,7 +221,7 @@ module "enterprise_scale_nested_landing_zone" {

> IMPORTANT: Please ensure you create this file in the `/lib` directory within your root module.
The `lib/archetype_definition_customer_online.json` file contains a custom "archetype definition". This is a custom JSON format used specifically by the Terraform Module for Cloud Adoption Framework Enterprise-scale.
The `lib/archetype_definition_customer_online.json` file contains a custom "archetype definition". This is a custom JSON format used specifically by the Azure landing zones Terraform module.

In this example, we are using this archetype definition to create an archetype called `customer_online`. This archetype definition includes the creation of Policy Assignments for `Deny-Resource-Locations` and `Deny-RSG-Locations`, with default values pre-defined in the archetype definition template.

Original file line number Diff line number Diff line change
@@ -96,7 +96,7 @@ data "azurerm_client_config" "core" {}
module "enterprise_scale" {
source = "Azure/caf-enterprise-scale/azurerm"
version = "1.1.4"
version = "2.0.0"
providers = {
azurerm = azurerm
6 changes: 3 additions & 3 deletions docs/wiki/[Examples]-Override-Module-Role-Assignments.md
Original file line number Diff line number Diff line change
@@ -97,12 +97,12 @@ To allow the declaration of custom templates, you must create a custom library f
data "azurerm_client_config" "core" {}
# Declare the Terraform Module for Cloud Adoption Framework
# Enterprise-scale and provide a base configuration.
# Declare the Azure landing zones Terraform module
# and provide a base configuration.
module "enterprise_scale" {
source = "Azure/caf-enterprise-scale/azurerm"
version = "1.1.4"
version = "2.0.0"
providers = {
azurerm = azurerm
Loading

0 comments on commit a0801f9

Please sign in to comment.