Skip to content

Commit 21b774d

Browse files
authored
Update terraform docs (#181)
1 parent 57493ea commit 21b774d

File tree

5 files changed

+67
-8
lines changed

5 files changed

+67
-8
lines changed

infrastructure/modules/app-service-plan/tfdocs.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -268,6 +268,14 @@ Description: Wildcard SSL certificate pfx password, for Custom Domain binding.
268268

269269
Type: `string`
270270

271+
Default: `null`
272+
273+
### <a name="input_zone_balancing_enabled"></a> [zone\_balancing\_enabled](#input\_zone\_balancing\_enabled)
274+
275+
Description: Balance the App Service Plan across Availability Zones in the region. Changing this forces the resource to be recreated.
276+
277+
Type: `string`
278+
271279
Default: `null`
272280
## Modules
273281

infrastructure/modules/container-app-environment/tfdocs.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,14 @@ Type: `string`
3838

3939
The following input variables are optional (have default values):
4040

41+
### <a name="input_location"></a> [location](#input\_location)
42+
43+
Description: The location/region where the container app environment is created.
44+
45+
Type: `string`
46+
47+
Default: `"UK South"`
48+
4149
### <a name="input_zone_redundancy_enabled"></a> [zone\_redundancy\_enabled](#input\_zone\_redundancy\_enabled)
4250

4351
Description: Enable availability zone redundancy for the container app environment. Should be set to true in production.
@@ -76,4 +84,3 @@ Description: Container app environment ID
7684
The following resources are used by this module:
7785

7886
- [azurerm_container_app_environment.main](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/container_app_environment) (resource)
79-
- [azurerm_resource_group.main](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/data-sources/resource_group) (data source)

infrastructure/modules/container-app/tfdocs.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,14 @@ Type: `bool`
7474

7575
Default: `false`
7676

77+
### <a name="input_location"></a> [location](#input\_location)
78+
79+
Description: The location/region where the container app is created.
80+
81+
Type: `string`
82+
83+
Default: `"UK South"`
84+
7785
### <a name="input_memory"></a> [memory](#input\_memory)
7886

7987
Description: Memory allocated to the app (GiB). Also dictates the CPU allocation: CPU(%)=MEMORY(Gi)/2. Maximum: 4Gi
@@ -117,4 +125,3 @@ The following resources are used by this module:
117125

118126
- [azurerm_container_app.main](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/container_app) (resource)
119127
- [azurerm_key_vault_secrets.app](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/data-sources/key_vault_secrets) (data source)
120-
- [azurerm_resource_group.main](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/data-sources/resource_group) (data source)

infrastructure/modules/service-bus/tfdocs.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,22 @@
44

55
The following input variables are required:
66

7+
### <a name="input_private_endpoint_properties"></a> [private\_endpoint\_properties](#input\_private\_endpoint\_properties)
8+
9+
Description: Consolidated properties for the Service Bus Private Endpoint.
10+
11+
Type:
12+
13+
```hcl
14+
object({
15+
private_dns_zone_ids = optional(list(string), [])
16+
private_endpoint_enabled = optional(bool, false)
17+
private_endpoint_subnet_id = optional(string, "")
18+
private_endpoint_resource_group_name = optional(string, "")
19+
private_service_connection_is_manual = optional(bool, false)
20+
})
21+
```
22+
723
### <a name="input_resource_group_name"></a> [resource\_group\_name](#input\_resource\_group\_name)
824

925
Description: The name of the resource group in which to create the Event Grid. Changing this forces a new resource to be created.
@@ -99,11 +115,30 @@ Description: A mapping of tags to assign to the resource.
99115
Type: `map(string)`
100116

101117
Default: `{}`
118+
## Modules
119+
120+
The following Modules are called:
102121

122+
### <a name="module_private_endpoint_service_bus_namespace"></a> [private\_endpoint\_service\_bus\_namespace](#module\_private\_endpoint\_service\_bus\_namespace)
103123

124+
Source: ../private-endpoint
125+
126+
Version:
127+
## Outputs
128+
129+
The following outputs are exported:
130+
131+
### <a name="output_namespace_id"></a> [namespace\_id](#output\_namespace\_id)
132+
133+
Description: n/a
134+
135+
### <a name="output_servicebus_connection_string"></a> [servicebus\_connection\_string](#output\_servicebus\_connection\_string)
136+
137+
Description: n/a
104138
## Resources
105139

106140
The following resources are used by this module:
107141

108142
- [azurerm_servicebus_namespace.this](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/servicebus_namespace) (resource)
143+
- [azurerm_servicebus_namespace_authorization_rule.this](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/servicebus_namespace_authorization_rule) (resource)
109144
- [azurerm_servicebus_topic.this](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/servicebus_topic) (resource)

infrastructure/modules/shared-config/tfdocs.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -22,12 +22,6 @@ Description: Location for the deployment
2222

2323
Type: `any`
2424

25-
### <a name="input_tags"></a> [tags](#input\_tags)
26-
27-
Description: Default tags for the deployment
28-
29-
Type: `map(string)`
30-
3125
## Optional Inputs
3226

3327
The following input variables are optional (have default values):
@@ -125,6 +119,14 @@ Default:
125119
}
126120
```
127121

122+
### <a name="input_tags"></a> [tags](#input\_tags)
123+
124+
Description: Default tags for the deployment
125+
126+
Type: `map(string)`
127+
128+
Default: `{}`
129+
128130
## Outputs
129131

130132
The following outputs are exported:

0 commit comments

Comments
 (0)