Skip to content

Commit 01d93d9

Browse files
committed
updating documentation and examples
1 parent 64cab32 commit 01d93d9

File tree

7 files changed

+52
-26
lines changed

7 files changed

+52
-26
lines changed

README.md

Lines changed: 28 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,11 @@ resource "azurerm_user_assigned_identity" "example" {
2222
2323
module "application-gateway" {
2424
source = "kumarvna/application-gateway/azurerm"
25-
version = "1.0.0"
25+
version = "1.1.0"
2626
27-
# Resource Group and location, VNet and Subnet detials (Required)
27+
# By default, this module will not create a resource group and expect to provide
28+
# a existing RG name to use an existing resource group. Location will be same as existing RG.
29+
# set the argument to `create_resource_group = true` to create new resrouce.
2830
resource_group_name = "rg-shared-westeurope-01"
2931
location = "westeurope"
3032
virtual_network_name = "vnet-shared-hub-westeurope-001"
@@ -157,7 +159,7 @@ module "application-gateway" {
157159
}
158160
```
159161

160-
## sku - what is the correct sku v1 or V2?
162+
## sku - Which one is the correct sku v1 or V2?
161163

162164
Application Gateway is available under a Standard_v2 SKU. Web Application Firewall (WAF) is available under a WAF_v2 SKU. The v2 SKU offers performance enhancements and adds support for critical new features like autoscaling, zone redundancy, and support for static VIPs.
163165

@@ -334,6 +336,23 @@ A ssl_certificates block supports the following:
334336
`password`|Password for the pfx file specified in data. Required if `data` is set.
335337
`key_vault_secret_id`|Secret Id of (base-64 encoded unencrypted pfx) Secret or Certificate object stored in Azure `KeyVault`. You need to enable `soft delete` for keyvault to use this feature. Required if `data` is not set.
336338

339+
```hcl
340+
module "application-gateway" {
341+
source = "kumarvna/application-gateway/azurerm"
342+
version = "1.1.0"
343+
344+
# .... omitted
345+
346+
ssl_certificates = [{
347+
name = "appgw-testgateway-westeurope-ssl01"
348+
data = "./keyBag.pfx"
349+
password = "P@$$w0rd123"
350+
}]
351+
352+
# .... omitted
353+
}
354+
```
355+
337356
### `custom_error_configuration` - Create Application Gateway custom error pages
338357

339358
Application Gateway allows you to create custom error pages instead of displaying default error pages. You can use your own branding and layout using a custom error page.
@@ -364,7 +383,7 @@ module "application-gateway" {
364383
ssl_certificate_name = "appgw-testgateway-westeurope-ssl01"
365384
host_name = null
366385
367-
/* custom_error_configuration = [
386+
custom_error_configuration = [
368387
{
369388
custom_error_page_url = "https://example.blob.core.windows.net/appgateway/custom_error_403_page.html"
370389
status_code = "HttpStatus403"
@@ -373,7 +392,7 @@ module "application-gateway" {
373392
custom_error_page_url = "https://example.blob.core.windows.net/appgateway/custom_error_502_page.html"
374393
status_code = "HttpStatus502"
375394
}
376-
] */
395+
]
377396
}
378397
]
379398
@@ -568,22 +587,24 @@ An effective naming convention assembles resource names by using important resou
568587

569588
Name | Description | Type | Default
570589
---- | ----------- | ---- | -------
590+
`create_resource_group` | Whether to create resource group and use it for all networking resources | string | `"false"`
571591
`resource_group_name`|The name of an existing resource group.|string|`""`
572592
`location`|The location for all resources while creating a new resource group.|string|`""`
573593
`virtual_network_name`|The name of the virtual network|string|`""`
594+
`vnet_resource_group_name`|The resource group name where the virtual network is created|string|`""`
574595
`subnet_name`|The name of the subnet to use in VM scale set|string|`""`
575596
`app_gateway_name`|The name of the application gateway|string|`""`
576597
`log_analytics_workspace_name`|The name of log analytics workspace name|string|`null`
577598
`storage_account_name`|The name of the hub storage account to store logs|string|`null`
578-
domain_name_label|Label for the Domain Name. Will be used to make up the FQDN|string|`null`
599+
`domain_name_label`|Label for the Domain Name. Will be used to make up the FQDN|string|`null`
579600
`enable_http2`|Is HTTP2 enabled on the application gateway resource?|string|`false`
580601
`zones`|A collection of availability zones to spread the Application Gateway over|list(string)|`[]`
581602
`firewall_policy_id`|The ID of the Web Application Firewall Policy which can be associated with app gateway|string|`null`
582603
`sku`|The sku pricing model of v1 and v2|object({})|`{}`
583604
`autoscale_configuration`|Minimum or Maximum capacity for autoscaling. Accepted values are for Minimum in the range `0` to `100` and for Maximum in the range `2` to `125`|object|`null`
584605
`private_ip_address`|Private IP Address to assign to the Load Balancer|string|`null`
585606
`backend_address_pools`|List of backend address pools|list(object{})|`[]`
586-
backend_http_settings|List of backend HTTP settings|list(object{})|`[]`
607+
`backend_http_settings`|List of backend HTTP settings|list(object{})|`[]`
587608
`http_listeners`|List of HTTP/HTTPS listeners. SSL Certificate name is required|list(object{})|`[]`
588609
`request_routing_rules`|List of Request routing rules to be used for listeners|list(object{})|`[]`
589610
`identity_ids`|Specifies a list with a single user managed identity id to be assigned to the Application Gateway|list(string)|`null`
@@ -629,11 +650,6 @@ Name | Description
629650
`url_path_map_default_backend_address_pool_id`|The ID of the Default Backend Address Pool associated with URL Path Map
630651
`url_path_map_default_backend_http_settings_id`|The ID of the Default Backend HTTP Settings Collection associated with URL Path Map
631652
`url_path_map_default_redirect_configuration_id`|The ID of the Default Redirect Configuration associated with URL Path Map
632-
`url_path_map_path_rule_id`|The ID of the Path Rule associated with URL Path Map
633-
`url_path_map_path_rule_backend_address_pool_id`|The ID of the Backend Address Pool used in this Path Rule
634-
`url_path_map_path_rule_backend_http_settings_id`|The ID of the Backend HTTP Settings Collection used in this Path Rule
635-
`url_path_map_path_rule_redirect_configuration_id`|The ID of the Redirect Configuration used in this Path Rule
636-
`url_path_map_path_rule_rewrite_rule_set_id`|The ID of the Rewrite Rule Set used in this Path Rule
637653
`custom_error_configuration_id`|The ID of the Custom Error Configuration
638654
`redirect_configuration_id`|The ID of the Redirect Configuration
639655
`rewrite_rule_set_id`|The ID of the Rewrite Rule Set

examples/application_gateway_with_ssl/README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,11 @@ resource "azurerm_user_assigned_identity" "example" {
2222
2323
module "application-gateway" {
2424
source = "kumarvna/application-gateway/azurerm"
25-
version = "1.0.0"
25+
version = "1.1.0"
2626
27-
# Resource Group and location, VNet and Subnet detials (Required)
27+
# By default, this module will not create a resource group and expect to provide
28+
# a existing RG name to use an existing resource group. Location will be same as existing RG.
29+
# set the argument to `create_resource_group = true` to create new resrouce.
2830
resource_group_name = "rg-shared-westeurope-01"
2931
location = "westeurope"
3032
virtual_network_name = "vnet-shared-hub-westeurope-001"

examples/application_gateway_with_ssl/main.tf

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,11 @@ resource "azurerm_user_assigned_identity" "example" {
1111

1212
module "application-gateway" {
1313
source = "kumarvna/application-gateway/azurerm"
14-
version = "1.0.0"
14+
version = "1.1.0"
1515

16-
# Resource Group and location, VNet and Subnet detials (Required)
16+
# By default, this module will not create a resource group and expect to provide
17+
# a existing RG name to use an existing resource group. Location will be same as existing RG.
18+
# set the argument to `create_resource_group = true` to create new resrouce.
1719
resource_group_name = "rg-shared-westeurope-01"
1820
location = "westeurope"
1921
virtual_network_name = "vnet-shared-hub-westeurope-001"

examples/application_gateway_with_waf/README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,9 @@ module "application-gateway" {
2424
source = "kumarvna/application-gateway/azurerm"
2525
version = "1.1.0"
2626
27-
# Resource Group and location, VNet and Subnet detials (Required)
27+
# By default, this module will not create a resource group and expect to provide
28+
# a existing RG name to use an existing resource group. Location will be same as existing RG.
29+
# set the argument to `create_resource_group = true` to create new resrouce.
2830
resource_group_name = "rg-shared-westeurope-01"
2931
location = "westeurope"
3032
virtual_network_name = "vnet-shared-hub-westeurope-001"
@@ -119,10 +121,9 @@ module "application-gateway" {
119121
ssl_certificates = [{
120122
name = "appgw-testgateway-westeurope-ssl01"
121123
data = "./keyBag.pfx"
122-
password = "lats1234" #"P@$$w0rd123"
124+
password = "P@$$w0rd123"
123125
}]
124126
125-
126127
# WAF configuration, disabled rule groups and exclusions.depends_on
127128
# The Application Gateway WAF comes pre-configured with CRS 3.0 by default. But you can choose to use CRS 3.2, 3.1, or 2.2.9 instead.
128129
# CRS 3.2 is only available on the `WAF_v2` SKU.

examples/application_gateway_with_waf/main.tf

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,9 @@ module "application-gateway" {
1313
source = "kumarvna/application-gateway/azurerm"
1414
version = "1.1.0"
1515

16-
# Resource Group and location, VNet and Subnet detials (Required)
16+
# By default, this module will not create a resource group and expect to provide
17+
# a existing RG name to use an existing resource group. Location will be same as existing RG.
18+
# set the argument to `create_resource_group = true` to create new resrouce.
1719
resource_group_name = "rg-shared-westeurope-01"
1820
location = "westeurope"
1921
virtual_network_name = "vnet-shared-hub-westeurope-001"
@@ -108,10 +110,9 @@ module "application-gateway" {
108110
ssl_certificates = [{
109111
name = "appgw-testgateway-westeurope-ssl01"
110112
data = "./keyBag.pfx"
111-
password = "lats1234" #"P@$$w0rd123"
113+
password = "P@$$w0rd123"
112114
}]
113115

114-
115116
# WAF configuration, disabled rule groups and exclusions.depends_on
116117
# The Application Gateway WAF comes pre-configured with CRS 3.0 by default. But you can choose to use CRS 3.2, 3.1, or 2.2.9 instead.
117118
# CRS 3.2 is only available on the `WAF_v2` SKU.

examples/simple_http_application_gateway/README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,11 @@ resource "azurerm_user_assigned_identity" "example" {
2222
2323
module "application-gateway" {
2424
source = "kumarvna/application-gateway/azurerm"
25-
version = "1.0.0"
25+
version = "1.1.0"
2626
27-
# Resource Group and location, VNet and Subnet detials (Required)
27+
# By default, this module will not create a resource group and expect to provide
28+
# a existing RG name to use an existing resource group. Location will be same as existing RG.
29+
# set the argument to `create_resource_group = true` to create new resrouce.
2830
resource_group_name = "rg-shared-westeurope-01"
2931
location = "westeurope"
3032
virtual_network_name = "vnet-shared-hub-westeurope-001"

examples/simple_http_application_gateway/main.tf

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,11 @@ resource "azurerm_user_assigned_identity" "example" {
1111

1212
module "application-gateway" {
1313
source = "kumarvna/application-gateway/azurerm"
14-
version = "1.0.0"
14+
version = "1.1.0"
1515

16-
# Resource Group and location, VNet and Subnet detials (Required)
16+
# By default, this module will not create a resource group and expect to provide
17+
# a existing RG name to use an existing resource group. Location will be same as existing RG.
18+
# set the argument to `create_resource_group = true` to create new resrouce.
1719
resource_group_name = "rg-shared-westeurope-01"
1820
location = "westeurope"
1921
virtual_network_name = "vnet-shared-hub-westeurope-001"

0 commit comments

Comments
 (0)