Skip to content

Commit

Permalink
terraform-docs: automated action
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions[bot] committed Sep 5, 2024
1 parent 5524f71 commit 1c6a67a
Show file tree
Hide file tree
Showing 6 changed files with 19 additions and 19 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,14 +70,14 @@ Enjoy!

| Name | Version |
|------|---------|
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.5.3 |
| <a name="requirement_azurerm"></a> [azurerm](#requirement\_azurerm) | ~> 3.106.1 |
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.9.5 |
| <a name="requirement_azurerm"></a> [azurerm](#requirement\_azurerm) | ~> 4.0.1 |

## Providers

| Name | Version |
|------|---------|
| <a name="provider_azurerm"></a> [azurerm](#provider\_azurerm) | ~> 3.106.1 |
| <a name="provider_azurerm"></a> [azurerm](#provider\_azurerm) | ~> 4.0.1 |
| <a name="provider_random"></a> [random](#provider\_random) | n/a |

## Modules
Expand Down Expand Up @@ -137,16 +137,16 @@ Enjoy!
| <a name="input_private_dns_zones"></a> [private\_dns\_zones](#input\_private\_dns\_zones) | Private DNS zones to create and link to VNET. | `list(string)` | `null` | no |
| <a name="input_resource_group_name"></a> [resource\_group\_name](#input\_resource\_group\_name) | Name of the resource group where resources will be hosted. | `string` | n/a | yes |
| <a name="input_resource_subnet_name"></a> [resource\_subnet\_name](#input\_resource\_subnet\_name) | The name for the resource subnet, used in data source to get subnet ID. | `string` | n/a | yes |
| <a name="input_sa_config"></a> [sa\_config](#input\_sa\_config) | Storage configuration object to create persistent azure file shares for sonarqube aci. | <pre>object({<br> name = string<br> account_kind = string<br> account_tier = string<br> account_replication_type = string<br> access_tier = string<br> enable_https_traffic_only = bool<br> min_tls_version = string<br> is_hns_enabled = bool<br> })</pre> | <pre>{<br> "access_tier": "Hot",<br> "account_kind": "StorageV2",<br> "account_replication_type": "LRS",<br> "account_tier": "Standard",<br> "enable_https_traffic_only": true,<br> "is_hns_enabled": false,<br> "min_tls_version": "TLS1_2",<br> "name": "sonarqubesa9000"<br>}</pre> | no |
| <a name="input_sa_config"></a> [sa\_config](#input\_sa\_config) | Storage configuration object to create persistent azure file shares for sonarqube aci. | <pre>object({<br> name = string<br> account_kind = string<br> account_tier = string<br> account_replication_type = string<br> access_tier = string<br> min_tls_version = string<br> is_hns_enabled = bool<br> })</pre> | <pre>{<br> "access_tier": "Hot",<br> "account_kind": "StorageV2",<br> "account_replication_type": "LRS",<br> "account_tier": "Standard",<br> "is_hns_enabled": false,<br> "min_tls_version": "TLS1_2",<br> "name": "sonarqubesa9000"<br>}</pre> | no |
| <a name="input_shares_config"></a> [shares\_config](#input\_shares\_config) | Sonarqube file shares. | <pre>list(object({<br> share_name = string<br> quota_gb = number<br> }))</pre> | <pre>[<br> {<br> "quota_gb": 10,<br> "share_name": "data"<br> },<br> {<br> "quota_gb": 10,<br> "share_name": "extensions"<br> },<br> {<br> "quota_gb": 10,<br> "share_name": "logs"<br> },<br> {<br> "quota_gb": 1,<br> "share_name": "conf"<br> }<br>]</pre> | no |
| <a name="input_sonar_config"></a> [sonar\_config](#input\_sonar\_config) | Sonarqube container configuration object to create sonarqube aci. | <pre>object({<br> container_name = string<br> container_image = string<br> container_cpu = number<br> container_memory = number<br> container_environment_variables = map(string)<br> container_commands = list(string)<br> })</pre> | <pre>{<br> "container_commands": [],<br> "container_cpu": 2,<br> "container_environment_variables": null,<br> "container_image": "ghcr.io/metrostar/quartz/ironbank/big-bang/sonarqube-9:9.9.4-community",<br> "container_memory": 8,<br> "container_name": "sonarqube-server"<br>}</pre> | no |
| <a name="input_sonarqube_private_dns_record"></a> [sonarqube\_private\_dns\_record](#input\_sonarqube\_private\_dns\_record) | Private dns A record for sonarqube instance. (Remember to add dns zone link to other peered vnets to resolve aci dns record.) Otherwise use hosts file to resolve the dns record for internal sonarqube instance: 'custom.domain.local'. | `string` | `"sonar"` | no |
| <a name="input_sql_admin_username"></a> [sql\_admin\_username](#input\_sql\_admin\_username) | Username for sql admin creds. (Stored in sonarqube key vault) | `string` | `"Sonar-Admin"` | no |
| <a name="input_storage_firewall_allowed_ips"></a> [storage\_firewall\_allowed\_ips](#input\_storage\_firewall\_allowed\_ips) | value of storage firewall allowed ip rules. | `list(string)` | `[]` | no |
| <a name="input_storage_firewall_bypass"></a> [storage\_firewall\_bypass](#input\_storage\_firewall\_bypass) | List of storage firewall rules to bypass. | `list(string)` | <pre>[<br> "AzureServices"<br>]</pre> | no |
| <a name="input_storage_firewall_default_action"></a> [storage\_firewall\_default\_action](#input\_storage\_firewall\_default\_action) | Default action for storage firewall rules. | `string` | `"Deny"` | no |
| <a name="input_subnet_config"></a> [subnet\_config](#input\_subnet\_config) | A list of subnet configuration objects to create subnets in the virtual network. | <pre>list(object({<br> subnet_name = string<br> subnet_address_space = list(string)<br> service_endpoints = list(string)<br> private_endpoint_network_policies_enabled = bool<br> private_link_service_network_policies_enabled = bool<br> }))</pre> | `null` | no |
| <a name="input_subnet_config_delegated_aci"></a> [subnet\_config\_delegated\_aci](#input\_subnet\_config\_delegated\_aci) | A list of subnet configuration objects to create subnets in the virtual network. - delegated to ACI | <pre>list(object({<br> subnet_name = string<br> subnet_address_space = list(string)<br> service_endpoints = list(string)<br> private_endpoint_network_policies_enabled = bool<br> private_link_service_network_policies_enabled = bool<br> delegation_name = string<br> delegation_service = string<br> delegation_ations = list(string)<br> }))</pre> | `null` | no |
| <a name="input_subnet_config"></a> [subnet\_config](#input\_subnet\_config) | A list of subnet configuration objects to create subnets in the virtual network. | <pre>list(object({<br> subnet_name = string<br> subnet_address_space = list(string)<br> service_endpoints = list(string)<br> private_endpoint_network_policies_enabled = string<br> private_link_service_network_policies_enabled = bool<br> }))</pre> | `null` | no |
| <a name="input_subnet_config_delegated_aci"></a> [subnet\_config\_delegated\_aci](#input\_subnet\_config\_delegated\_aci) | A list of subnet configuration objects to create subnets in the virtual network. - delegated to ACI | <pre>list(object({<br> subnet_name = string<br> subnet_address_space = list(string)<br> service_endpoints = list(string)<br> private_endpoint_network_policies_enabled = string<br> private_link_service_network_policies_enabled = bool<br> delegation_name = string<br> delegation_service = string<br> delegation_ations = list(string)<br> }))</pre> | `null` | no |
| <a name="input_tags"></a> [tags](#input\_tags) | A map of key value pairs that is used to tag resources created. | `map(string)` | <pre>{<br> "Author": "Marcel Lupo",<br> "Description": "Sonarqube VNET integrated aci with caddy (self signed cert).",<br> "GitHub": "https://github.com/Pwd9000-ML/terraform-azurerm-sonarqube-aci-internal",<br> "Terraform": "True"<br>}</pre> | no |
| <a name="input_virtual_network_name"></a> [virtual\_network\_name](#input\_virtual\_network\_name) | Name of the virtual network where resources are attached. | `string` | `null` | no |
| <a name="input_vnet_address_space"></a> [vnet\_address\_space](#input\_vnet\_address\_space) | value of the address space for the virtual network. | `list(string)` | `null` | no |
Expand Down
6 changes: 3 additions & 3 deletions examples/vnet_integrated_deploy_network_resources/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ No requirements.
| <a name="input_pass_length"></a> [pass\_length](#input\_pass\_length) | Password length for sql admin creds. (Stored in sonarqube key vault) | `number` | `36` | no |
| <a name="input_private_dns_zones"></a> [private\_dns\_zones](#input\_private\_dns\_zones) | Private DNS zones to create. | `list(string)` | <pre>[<br> "privatelink.vaultcore.azure.net",<br> "privatelink.file.core.windows.net",<br> "privatelink.database.windows.net",<br> "pwd9000.local"<br>]</pre> | no |
| <a name="input_resource_subnet_name"></a> [resource\_subnet\_name](#input\_resource\_subnet\_name) | The name for the resource subnet, used in data source to get subnet ID. | `string` | `"sonarqube-resource-sub"` | no |
| <a name="input_sa_config"></a> [sa\_config](#input\_sa\_config) | Storage configuration object to create persistent azure file shares for sonarqube aci. | <pre>object({<br> name = string<br> account_kind = string<br> account_tier = string<br> account_replication_type = string<br> access_tier = string<br> enable_https_traffic_only = bool<br> min_tls_version = string<br> is_hns_enabled = bool<br> })</pre> | <pre>{<br> "access_tier": "Hot",<br> "account_kind": "StorageV2",<br> "account_replication_type": "LRS",<br> "account_tier": "Standard",<br> "enable_https_traffic_only": true,<br> "is_hns_enabled": false,<br> "min_tls_version": "TLS1_2",<br> "name": "sonarqubesa9000"<br>}</pre> | no |
| <a name="input_sa_config"></a> [sa\_config](#input\_sa\_config) | Storage configuration object to create persistent azure file shares for sonarqube aci. | <pre>object({<br> name = string<br> account_kind = string<br> account_tier = string<br> account_replication_type = string<br> access_tier = string<br> min_tls_version = string<br> is_hns_enabled = bool<br> })</pre> | <pre>{<br> "access_tier": "Hot",<br> "account_kind": "StorageV2",<br> "account_replication_type": "LRS",<br> "account_tier": "Standard",<br> "is_hns_enabled": false,<br> "min_tls_version": "TLS1_2",<br> "name": "sonarqubesa9000"<br>}</pre> | no |
| <a name="input_shares_config"></a> [shares\_config](#input\_shares\_config) | Sonarqube file shares. | <pre>list(object({<br> share_name = string<br> quota_gb = number<br> }))</pre> | <pre>[<br> {<br> "quota_gb": 10,<br> "share_name": "data"<br> },<br> {<br> "quota_gb": 10,<br> "share_name": "extensions"<br> },<br> {<br> "quota_gb": 10,<br> "share_name": "logs"<br> },<br> {<br> "quota_gb": 1,<br> "share_name": "conf"<br> }<br>]</pre> | no |
| <a name="input_sonar_config"></a> [sonar\_config](#input\_sonar\_config) | Sonarqube container configuration object to create sonarqube aci. | <pre>object({<br> container_name = string<br> container_image = string<br> container_cpu = number<br> container_memory = number<br> container_environment_variables = map(string)<br> container_commands = list(string)<br> })</pre> | <pre>{<br> "container_commands": [],<br> "container_cpu": 2,<br> "container_environment_variables": null,<br> "container_image": "ghcr.io/metrostar/quartz/ironbank/big-bang/sonarqube-9:9.9.4-community",<br> "container_memory": 8,<br> "container_name": "sonarqube-server"<br>}</pre> | no |
| <a name="input_sonarqube_private_dns_record"></a> [sonarqube\_private\_dns\_record](#input\_sonarqube\_private\_dns\_record) | Private dns A record for sonarqube instance. (Remember to add dns zone link to other peered vnets to resolve aci dns record.) Otherwise use hosts file to resolve the dns record for internal sonarqube instance: 'custom.domain.local'. | `string` | `"sonar"` | no |
Expand All @@ -94,8 +94,8 @@ No requirements.
| <a name="input_storage_firewall_allowed_ips"></a> [storage\_firewall\_allowed\_ips](#input\_storage\_firewall\_allowed\_ips) | value of storage firewall allowed ip rules. | `list(string)` | <pre>[<br> "0.0.0.0/0"<br>]</pre> | no |
| <a name="input_storage_firewall_bypass"></a> [storage\_firewall\_bypass](#input\_storage\_firewall\_bypass) | List of storage firewall rules to bypass. | `list(string)` | <pre>[<br> "AzureServices"<br>]</pre> | no |
| <a name="input_storage_firewall_default_action"></a> [storage\_firewall\_default\_action](#input\_storage\_firewall\_default\_action) | Default action for storage firewall rules. | `string` | `"Deny"` | no |
| <a name="input_subnet_config"></a> [subnet\_config](#input\_subnet\_config) | A list of subnet configuration objects to create subnets in the virtual network. | <pre>list(object({<br> subnet_name = string<br> subnet_address_space = list(string)<br> service_endpoints = list(string)<br> private_endpoint_network_policies_enabled = bool<br> private_link_service_network_policies_enabled = bool<br> }))</pre> | <pre>[<br> {<br> "private_endpoint_network_policies_enabled": false,<br> "private_link_service_network_policies_enabled": false,<br> "service_endpoints": [<br> "Microsoft.Storage",<br> "Microsoft.Sql",<br> "Microsoft.KeyVault"<br> ],<br> "subnet_address_space": [<br> "10.1.0.0/24"<br> ],<br> "subnet_name": "sonarqube-resource-sub"<br> }<br>]</pre> | no |
| <a name="input_subnet_config_delegated_aci"></a> [subnet\_config\_delegated\_aci](#input\_subnet\_config\_delegated\_aci) | A list of subnet configuration objects to create subnets in the virtual network. - delegated to ACI | <pre>list(object({<br> subnet_name = string<br> subnet_address_space = list(string)<br> service_endpoints = list(string)<br> private_endpoint_network_policies_enabled = bool<br> private_link_service_network_policies_enabled = bool<br> delegation_name = string<br> delegation_service = string<br> delegation_ations = list(string)<br> }))</pre> | <pre>[<br> {<br> "delegation_ations": [<br> "Microsoft.Network/virtualNetworks/subnets/action"<br> ],<br> "delegation_name": "aci-sub-delegation",<br> "delegation_service": "Microsoft.ContainerInstance/containerGroups",<br> "private_endpoint_network_policies_enabled": false,<br> "private_link_service_network_policies_enabled": false,<br> "service_endpoints": [],<br> "subnet_address_space": [<br> "10.1.1.0/24"<br> ],<br> "subnet_name": "sonarqube-delegated-sub"<br> }<br>]</pre> | no |
| <a name="input_subnet_config"></a> [subnet\_config](#input\_subnet\_config) | A list of subnet configuration objects to create subnets in the virtual network. | <pre>list(object({<br> subnet_name = string<br> subnet_address_space = list(string)<br> service_endpoints = list(string)<br> private_endpoint_network_policies_enabled = string<br> private_link_service_network_policies_enabled = bool<br> }))</pre> | <pre>[<br> {<br> "private_endpoint_network_policies_enabled": "Enabled",<br> "private_link_service_network_policies_enabled": false,<br> "service_endpoints": [<br> "Microsoft.Storage",<br> "Microsoft.Sql",<br> "Microsoft.KeyVault"<br> ],<br> "subnet_address_space": [<br> "10.1.0.0/24"<br> ],<br> "subnet_name": "sonarqube-resource-sub"<br> }<br>]</pre> | no |
| <a name="input_subnet_config_delegated_aci"></a> [subnet\_config\_delegated\_aci](#input\_subnet\_config\_delegated\_aci) | A list of subnet configuration objects to create subnets in the virtual network. - delegated to ACI | <pre>list(object({<br> subnet_name = string<br> subnet_address_space = list(string)<br> service_endpoints = list(string)<br> private_endpoint_network_policies_enabled = string<br> private_link_service_network_policies_enabled = bool<br> delegation_name = string<br> delegation_service = string<br> delegation_ations = list(string)<br> }))</pre> | <pre>[<br> {<br> "delegation_ations": [<br> "Microsoft.Network/virtualNetworks/subnets/action"<br> ],<br> "delegation_name": "aci-sub-delegation",<br> "delegation_service": "Microsoft.ContainerInstance/containerGroups",<br> "private_endpoint_network_policies_enabled": "Enabled",<br> "private_link_service_network_policies_enabled": false,<br> "service_endpoints": [],<br> "subnet_address_space": [<br> "10.1.1.0/24"<br> ],<br> "subnet_name": "sonarqube-delegated-sub"<br> }<br>]</pre> | no |
| <a name="input_tags"></a> [tags](#input\_tags) | A map of key value pairs that is used to tag resources created. | `map(string)` | <pre>{<br> "TagName": "TagValue"<br>}</pre> | no |
| <a name="input_virtual_network_name"></a> [virtual\_network\_name](#input\_virtual\_network\_name) | Name of the virtual network to create. | `string` | `"sonarqube-vnet"` | no |
| <a name="input_vnet_address_space"></a> [vnet\_address\_space](#input\_vnet\_address\_space) | value of the address space for the virtual network. | `list(string)` | <pre>[<br> "10.1.0.0/16"<br>]</pre> | no |
Expand Down
Loading

0 comments on commit 1c6a67a

Please sign in to comment.