Skip to content

Commit 601a4a3

Browse files
actions-useractions-user
committed
Update documentation
1 parent 4fea17a commit 601a4a3

File tree

2 files changed

+98
-1
lines changed

2 files changed

+98
-1
lines changed

‎storage-account/README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ Basic usage of this module is as follows:
2424
cross_tenant_replication_enabled = false
2525
delete_retention_policy = 10
2626
environment = "DEV"
27-
location = "centralindia"
27+
location = ""
2828
public_network_access_enabled = true
2929
}
3030
```

‎vmss-linux/README.md‎

Lines changed: 97 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,97 @@
1+
<!-- BEGIN_AUTOMATED_TF_DOCS_BLOCK -->
2+
## Requirements
3+
4+
| Name | Version |
5+
|------|---------|
6+
| <a name="requirement_terraform"></a> [terraform](#requirement_terraform) | ~> 1.3 |
7+
| <a name="requirement_azurerm"></a> [azurerm](#requirement_azurerm) | ~> 3.0 |
8+
| <a name="requirement_random"></a> [random](#requirement_random) | >= 3.1 |
9+
## Usage
10+
Basic usage of this module is as follows:
11+
```hcl
12+
module "example" {
13+
source = "<module-path>"
14+
15+
# Optional variables
16+
additional_data_disks = []
17+
additional_data_disks_storage_account_type = "Standard_LRS"
18+
admin_username = "admin_user"
19+
application_name = ""
20+
backend_port = 80
21+
default_instance_count = 0
22+
environment = ""
23+
eviction_policy = "Delete"
24+
frontend_port = 80
25+
load_balancer_sku = "Basic"
26+
location = ""
27+
os_disk_size = 30
28+
os_disk_storage_account_type = "Standard_LRS"
29+
priority = ""
30+
protocol = "Http"
31+
request_path = "/"
32+
resource_group_name = ""
33+
sku_size = ""
34+
subnet_name = ""
35+
vmss_name = ""
36+
vnet_name = ""
37+
vnet_resource_group = ""
38+
}
39+
```
40+
41+
## Resources
42+
43+
| Name | Type |
44+
|------|------|
45+
| [azurerm_lb.lb](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/lb) | resource |
46+
| [azurerm_lb_backend_address_pool.backend_address_pool](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/lb_backend_address_pool) | resource |
47+
| [azurerm_lb_probe.health](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/lb_probe) | resource |
48+
| [azurerm_lb_rule.lb_rule](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/lb_rule) | resource |
49+
| [azurerm_linux_virtual_machine_scale_set.vmss](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/linux_virtual_machine_scale_set) | resource |
50+
| [azurerm_public_ip.lb_pub_ip](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/public_ip) | resource |
51+
| [azurerm_resource_group.rg](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/resource_group) | resource |
52+
| [random_password.password](https://registry.terraform.io/providers/hashicorp/random/latest/docs/resources/password) | resource |
53+
| [azurerm_subnet.subnet](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/data-sources/subnet) | data source |
54+
| [local_file.cloudinit](https://registry.terraform.io/providers/hashicorp/local/latest/docs/data-sources/file) | data source |
55+
56+
## Inputs
57+
58+
| Name | Description | Type | Required |
59+
|------|-------------|------|:--------:|
60+
| <a name="input_additional_data_disks"></a> [additional_data_disks](#input_additional_data_disks) | Adding additional disks capacity to add each instance in GB | `list(number)` | no |
61+
| <a name="input_additional_data_disks_storage_account_type"></a> [additional_data_disks_storage_account_type](#input_additional_data_disks_storage_account_type) | The Type of Storage Account which should back this Data Disk. Possible values include Standard_LRS, StandardSSD_LRS, Premium_LRS and UltraSSD_LRS. | `string` | no |
62+
| <a name="input_admin_username"></a> [admin_username](#input_admin_username) | VMSS default user name | `string` | no |
63+
| <a name="input_application_name"></a> [application_name](#input_application_name) | Azure application name tag | `string` | no |
64+
| <a name="input_backend_port"></a> [backend_port](#input_backend_port) | Port on which traffic is passed on to application backends | `number` | no |
65+
| <a name="input_default_instance_count"></a> [default_instance_count](#input_default_instance_count) | Default instance count for the VMSS | `number` | no |
66+
| <a name="input_environment"></a> [environment](#input_environment) | Environment tag value in Azure | `string` | no |
67+
| <a name="input_eviction_policy"></a> [eviction_policy](#input_eviction_policy) | Azure Spot VM eviction policy Delete or Deallocate | `string` | no |
68+
| <a name="input_frontend_port"></a> [frontend_port](#input_frontend_port) | Port on which queries for status of application | `number` | no |
69+
| <a name="input_load_balancer_sku"></a> [load_balancer_sku](#input_load_balancer_sku) | Azure Loadbalancer Skus | `string` | no |
70+
| <a name="input_location"></a> [location](#input_location) | Azure location | `string` | no |
71+
| <a name="input_os_disk_size"></a> [os_disk_size](#input_os_disk_size) | OS disk size in GB | `number` | no |
72+
| <a name="input_os_disk_storage_account_type"></a> [os_disk_storage_account_type](#input_os_disk_storage_account_type) | OS disk storage account type | `string` | no |
73+
| <a name="input_priority"></a> [priority](#input_priority) | Type of vmss instances Spot or regular | `string` | no |
74+
| <a name="input_protocol"></a> [protocol](#input_protocol) | Protocol for Load balancing | `string` | no |
75+
| <a name="input_request_path"></a> [request_path](#input_request_path) | Health check path | `string` | no |
76+
| <a name="input_resource_group_name"></a> [resource_group_name](#input_resource_group_name) | Azure VMSS resource group name | `string` | no |
77+
| <a name="input_sku_size"></a> [sku_size](#input_sku_size) | Azure VMSS sku | `string` | no |
78+
| <a name="input_subnet_name"></a> [subnet_name](#input_subnet_name) | Azure subnet name to create vmss | `string` | no |
79+
| <a name="input_vmss_name"></a> [vmss_name](#input_vmss_name) | Azure VMSS name | `string` | no |
80+
| <a name="input_vnet_name"></a> [vnet_name](#input_vnet_name) | Azure Vnet Name | `string` | no |
81+
| <a name="input_vnet_resource_group"></a> [vnet_resource_group](#input_vnet_resource_group) | Azure Vnet resource group | `string` | no |
82+
83+
## Outputs
84+
85+
| Name | Description |
86+
|------|-------------|
87+
| <a name="output_admin_password"></a> [admin_password](#output_admin_password) | VMSS user password |
88+
| <a name="output_admin_username"></a> [admin_username](#output_admin_username) | VMSS user name |
89+
| <a name="output_azure_vmss_name"></a> [azure_vmss_name](#output_azure_vmss_name) | Azure VMSS name |
90+
| <a name="output_azure_vmss_rg"></a> [azure_vmss_rg](#output_azure_vmss_rg) | Azure VMSS Rg |
91+
| <a name="output_data_disks"></a> [data_disks](#output_data_disks) | VMSS data disks |
92+
| <a name="output_load_balancer_frontend_public_ip"></a> [load_balancer_frontend_public_ip](#output_load_balancer_frontend_public_ip) | Azure load balancer frontend ip address |
93+
| <a name="output_loadbalancer_id"></a> [loadbalancer_id](#output_loadbalancer_id) | AzureLoad balancer Id |
94+
| <a name="output_os_disk"></a> [os_disk](#output_os_disk) | VMSS os disk size |
95+
| <a name="output_subnet_id"></a> [subnet_id](#output_subnet_id) | Azure Subnet id |
96+
| <a name="output_type_of_instances"></a> [type_of_instances](#output_type_of_instances) | Spot or Regular instances |
97+
<!-- END_AUTOMATED_TF_DOCS_BLOCK -->

0 commit comments

Comments
 (0)