Skip to content

Commit

Permalink
Documentation fixes due to missing variable attributes (#356)
Browse files Browse the repository at this point in the history 
* Add `advanced_vpn_settings` variable attribute

* Add `enable_defender_for_containers` attribute

* Update module references to v2.0.1

* Further update docs for MS defender for containers

Co-authored-by: Matt White <[email protected]>
  • Loading branch information
@jonclyde @matt-FFFFFF
jonclyde and matt-FFFFFF authored May 9, 2022
1 parent 5cbcbe2 commit 9a1b66e
Show file tree
Hide file tree
Showing 16 changed files with 49 additions and 41 deletions.
20 changes: 19 additions & 1 deletion docs/wiki/[Examples]-Deploy-Connectivity-Resources-With-Custom-Settings.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -142,7 +142,7 @@ data "azurerm_client_config" "core" {}
module "enterprise_scale" {
source = "Azure/caf-enterprise-scale/azurerm"
version = "2.0.0"
version = "2.0.1"
providers = {
azurerm = azurerm
Expand Down Expand Up @@ -187,6 +187,15 @@ locals {
address_prefix = "10.100.1.0/24"
gateway_sku_expressroute = "ErGw2AZ"
gateway_sku_vpn = ""
advanced_vpn_settings = {
enable_bgp = null
active_active = null
private_ip_address_allocation = ""
default_local_network_gateway_id = ""
vpn_client_configuration = []
bgp_settings = []
custom_route = []
}
}
}
azure_firewall = {
Expand Down Expand Up @@ -226,6 +235,15 @@ locals {
address_prefix = "10.101.1.0/24"
gateway_sku_expressroute = ""
gateway_sku_vpn = "VpnGw2AZ"
advanced_vpn_settings = {
enable_bgp = null
active_active = null
private_ip_address_allocation = ""
default_local_network_gateway_id = ""
vpn_client_configuration = []
bgp_settings = []
custom_route = []
}
}
}
azure_firewall = {
Expand Down
2 changes: 1 addition & 1 deletion docs/wiki/[Examples]-Deploy-Connectivity-Resources.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ data "azurerm_client_config" "core" {}
module "enterprise_scale" {
source = "Azure/caf-enterprise-scale/azurerm"
version = "2.0.0"
version = "2.0.1"
providers = {
azurerm = azurerm
Expand Down
2 changes: 1 addition & 1 deletion docs/wiki/[Examples]-Deploy-Custom-Landing-Zone-Archetypes.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ data "azurerm_client_config" "core" {}
module "enterprise_scale" {
source = "Azure/caf-enterprise-scale/azurerm"
version = "2.0.0"
version = "2.0.1"
providers = {
azurerm = azurerm
Expand Down
2 changes: 1 addition & 1 deletion docs/wiki/[Examples]-Deploy-Default-Configuration.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ data "azurerm_client_config" "core" {}
module "enterprise_scale" {
source = "Azure/caf-enterprise-scale/azurerm"
version = "2.0.0"
version = "2.0.1"
providers = {
azurerm = azurerm
Expand Down
2 changes: 1 addition & 1 deletion docs/wiki/[Examples]-Deploy-Demo-Landing-Zone-Archetypes.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ data "azurerm_client_config" "core" {}
module "enterprise_scale" {
source = "Azure/caf-enterprise-scale/azurerm"
version = "2.0.0"
version = "2.0.1"
providers = {
azurerm = azurerm
Expand Down
2 changes: 1 addition & 1 deletion docs/wiki/[Examples]-Deploy-Identity-Resources-With-Custom-Settings.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ data "azurerm_client_config" "core" {}
module "enterprise_scale" {
source = "Azure/caf-enterprise-scale/azurerm"
version = "2.0.0"
version = "2.0.1"
providers = {
azurerm = azurerm
Expand Down
2 changes: 1 addition & 1 deletion docs/wiki/[Examples]-Deploy-Identity-Resources.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ data "azurerm_client_config" "core" {}
module "enterprise_scale" {
source = "Azure/caf-enterprise-scale/azurerm"
version = "2.0.0"
version = "2.0.1"
providers = {
azurerm = azurerm
Expand Down
11 changes: 5 additions & 6 deletions docs/wiki/[Examples]-Deploy-Management-Resources-With-Custom-Settings.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,7 @@ data "azurerm_client_config" "core" {}
module "enterprise_scale" {
source = "Azure/caf-enterprise-scale/azurerm"
version = "2.0.0"
version = "2.0.1"
providers = {
azurerm = azurerm
Expand Down Expand Up @@ -166,6 +166,7 @@ locals {
enable_monitoring_for_arc = true
enable_monitoring_for_vm = true
enable_monitoring_for_vmss = true
enable_sentinel = true
enable_solution_for_agent_health_assessment = true
enable_solution_for_anti_malware = true
enable_solution_for_azure_activity = true
Expand All @@ -174,23 +175,21 @@ locals {
enable_solution_for_sql_assessment = true
enable_solution_for_updates = true
enable_solution_for_vm_insights = true
enable_sentinel = true
}
}
security_center = {
enabled = true
config = {
email_security_contact = var.security_alerts_email_address
enable_defender_for_acr = true
enable_defender_for_app_services = true
enable_defender_for_arm = true
enable_defender_for_containers = true
enable_defender_for_dns = true
enable_defender_for_key_vault = true
enable_defender_for_kubernetes = true
enable_defender_for_oss_databases = true
enable_defender_for_servers = true
enable_defender_for_sql_servers = true
enable_defender_for_sql_server_vms = true
enable_defender_for_sql_servers = true
enable_defender_for_storage = true
}
}
Expand Down Expand Up @@ -293,4 +292,4 @@ Looking for further inspiration? Why not try some of our other [examples][wiki_e
[archetype_exclusions]: ./%5BExamples%5D-Expand-Built-in-Archetype-Definitions#to-enable-the-exclusion-function "Wiki - Expand Built-in Archetype Definitions # To enable the exclusion function"
[custom_archetypes]: ./%5BUser-Guide%5D-Archetype-Definitions "[User Guide] Archetype Definitions"

[azure_tag_support]: https://docs.microsoft.com/azure/azure-resource-manager/management/tag-support "Tag support for Azure resources"
[azure_tag_support]: https://docs.microsoft.com/azure/azure-resource-manager/management/tag-support "Tag support for Azure resources"
2 changes: 1 addition & 1 deletion docs/wiki/[Examples]-Deploy-Management-Resources.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ data "azurerm_client_config" "core" {}
module "enterprise_scale" {
source = "Azure/caf-enterprise-scale/azurerm"
version = "2.0.0"
version = "2.0.1"
providers = {
azurerm = azurerm
Expand Down
6 changes: 3 additions & 3 deletions docs/wiki/[Examples]-Deploy-Using-Module-Nesting.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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 = "2.0.0"
version = "2.0.1"
providers = {
azurerm = azurerm
Expand Down Expand Up @@ -134,7 +134,7 @@ data "azurerm_client_config" "core" {}
module "enterprise_scale" {
source = "Azure/caf-enterprise-scale/azurerm"
version = "2.0.0"
version = "2.0.1"
providers = {
azurerm = azurerm
Expand Down Expand Up @@ -183,7 +183,7 @@ module "enterprise_scale" {
module "enterprise_scale_nested_landing_zone" {
source = "Azure/caf-enterprise-scale/azurerm"
version = "2.0.0"
version = "2.0.1"
providers = {
azurerm = azurerm
Expand Down
2 changes: 1 addition & 1 deletion docs/wiki/[Examples]-Expand-built-in-archetype-definitions.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ data "azurerm_client_config" "core" {}
module "enterprise_scale" {
source = "Azure/caf-enterprise-scale/azurerm"
version = "2.0.0"
version = "2.0.1"
providers = {
azurerm = azurerm
Expand Down
2 changes: 1 addition & 1 deletion docs/wiki/[Examples]-Override-Module-Role-Assignments.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ data "azurerm_client_config" "core" {}
module "enterprise_scale" {
source = "Azure/caf-enterprise-scale/azurerm"
version = "2.0.0"
version = "2.0.1"
providers = {
azurerm = azurerm
Expand Down
2 changes: 1 addition & 1 deletion docs/wiki/[User-Guide]-Getting-Started.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ Copy and paste the following 'module' block into your Terraform configuration, i
```hcl
module "caf-enterprise-scale" {
source = "Azure/caf-enterprise-scale/azurerm"
version = "2.0.0"
version = "2.0.1"
providers = {
azurerm = azurerm
Expand Down
3 changes: 1 addition & 2 deletions docs/wiki/[User-Guide]-Module-Variables.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -213,12 +213,11 @@ Default:
enabled = true
config = {
email_security_contact = "security_contact@replace_me"
enable_defender_for_acr = true
enable_defender_for_app_services = true
enable_defender_for_arm = true
enable_defender_for_containers = true
enable_defender_for_dns = true
enable_defender_for_key_vault = true
enable_defender_for_kubernetes = true
enable_defender_for_oss_databases = true
enable_defender_for_servers = true
enable_defender_for_sql_servers = true
Expand Down
6 changes: 3 additions & 3 deletions docs/wiki/[User-Guide]-Provider-Configuration.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ provider "azurerm" {

module "caf-enterprise-scale" {
source = "Azure/caf-enterprise-scale/azurerm"
version = "2.0.0"
version = "2.0.1"

providers = {
azurerm = azurerm
Expand Down Expand Up @@ -149,7 +149,7 @@ provider "azurerm" {
module "caf-enterprise-scale" {
source = "Azure/caf-enterprise-scale/azurerm"
version = "2.0.0"
version = "2.0.1"
providers = {
azurerm = azurerm
Expand Down Expand Up @@ -207,7 +207,7 @@ data "azurerm_client_config" "connectivity" {
# Map each module provider to their corresponding `azurerm` provider using the providers input object
module "enterprise_scale" {
source = "Azure/caf-enterprise-scale/azurerm"
version = "2.0.0"
version = "2.0.1"
providers = {
azurerm = azurerm
Expand Down
24 changes: 8 additions & 16 deletions docs/wiki/[Variables]-configure_management_resources.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -31,16 +31,15 @@ If specified, will customize the "Management" landing zone settings and resource
enabled = true
config = {
email_security_contact = "security_contact@replace_me"
enable_defender_for_acr = true
enable_defender_for_app_services = true
enable_defender_for_arm = true
enable_defender_for_containers = true
enable_defender_for_dns = true
enable_defender_for_key_vault = true
enable_defender_for_kubernetes = true
enable_defender_for_oss_databases = true
enable_defender_for_servers = true
enable_defender_for_sql_servers = true
enable_defender_for_sql_server_vms = true
enable_defender_for_sql_servers = true
enable_defender_for_storage = true
}
}
Expand Down Expand Up @@ -80,12 +79,11 @@ object({
enabled = bool
config = object({
email_security_contact = string
enable_defender_for_acr = bool
enable_defender_for_app_services = bool
enable_defender_for_arm = bool
enable_defender_for_dns = bool
enable_defender_for_key_vault = bool
enable_defender_for_kubernetes = bool
enable_defender_for_containers = bool
enable_defender_for_oss_databases = bool
enable_defender_for_servers = bool
enable_defender_for_sql_servers = bool
Expand Down Expand Up @@ -235,16 +233,15 @@ security_center = {
enabled = true
config = {
email_security_contact = "security_contact@replace_me"
enable_defender_for_acr = true
enable_defender_for_app_services = true
enable_defender_for_arm = true
enable_defender_for_containers = true
enable_defender_for_app_services = true
enable_defender_for_dns = true
enable_defender_for_key_vault = true
enable_defender_for_kubernetes = true
enable_defender_for_oss_databases = true
enable_defender_for_servers = true
enable_defender_for_sql_server_vms = true
enable_defender_for_sql_servers = true
enable_defender_for_sql_server_vms = true
enable_defender_for_storage = true
}
}
Expand All @@ -262,11 +259,6 @@ The `config` (`object`) input allows you to set the following configuration item

Specifies the email address to be used as the security contact in Microsoft Defender for Cloud.

##### `settings.security_center.enable_defender_for_acr`

Enables the the Standard pricing tier for `ContainerRegistry` using the "Configure Azure Defender for container registries to be enabled" policy.
This is deployed to all in-scope subscriptions using the `DeployIfNotExists` policy effect.

##### `settings.security_center.enable_defender_for_app_services`

Enables the the Standard pricing tier for `AppServices` using the "Configure Azure Defender for App Service to be enabled" policy.
Expand All @@ -287,9 +279,9 @@ This is deployed to all in-scope subscriptions using the `DeployIfNotExists` pol
Enables the the Standard pricing tier for `KeyVaults` using the "Configure Azure Defender for Key Vaults to be enabled" policy.
This is deployed to all in-scope subscriptions using the `DeployIfNotExists` policy effect.

##### `settings.security_center.enable_defender_for_kubernetes`
##### `settings.security_center.enable_defender_for_containers`

Enables Microsoft Defender for Cloud for all in-scope Azure Kubernetes Service clusters using the "Configure Azure Defender for Kubernetes to be enabled" policy.
Enables Microsoft Defender for Cloud for all in-scope Azure Kubernetes Service clusters using the "Configure Microsoft Defender for Containers to be enabled" policy.
This is deployed to all in-scope clusters using the `DeployIfNotExists` policy effect.

##### `settings.security_center.enable_defender_for_oss_databases`
Expand Down

0 comments on commit 9a1b66e

Please sign in to comment.