|
1 | 1 | <!-- BEGIN_AUTOMATED_TF_DOCS_BLOCK -->
|
2 | 2 | ## Requirements
|
3 | 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) | <= 4.0 | |
8 |
| -| <a name="requirement_random"></a> [random](#requirement_random) | >= 3.1 | |
| 4 | +No requirements. |
9 | 5 | ## Usage
|
10 | 6 | Basic usage of this module is as follows:
|
11 | 7 | ```hcl
|
12 | 8 | module "example" {
|
13 | 9 | source = "<module-path>"
|
14 |
| - |
15 |
| - # Optional variables |
16 |
| - application_name = "devwithkrishna" |
17 |
| - environment = "DEV" |
18 |
| - eviction_policy = "Delete" |
19 |
| - location = "centralindia" |
20 |
| - os_disk_size = 32 |
21 |
| - priority = "" |
22 |
| - public_ip_address_name = "JENKINS-DOCKERHOST-PUBLIC-IP" |
23 |
| - resource_group_name = "JENKINS-DOCKEHOST-RG" |
24 |
| - source_image_reference = { |
25 |
| - "offer": "0001-com-ubuntu-server-jammy", |
26 |
| - "publisher": "Canonical", |
27 |
| - "sku": "22_04-lts", |
28 |
| - "version": "latest" |
29 |
| -} |
30 |
| - subnet_name = "ARCHITECTS-PROTECTED-CI-SUBNET" |
31 |
| - temporary = "TRUE" |
32 |
| - vm_sku = "Standard_D2as_v4" |
33 |
| - vmname = "JENKINS-DOCKERHOST-VM" |
34 |
| - vnet_name = "ARCHITECTS-CENTRAL-INDIA-VNET" |
35 |
| - vnet_rg = "ARCHITECTS-CENTRAL-INDIA-VNET-RG" |
36 | 10 | }
|
37 | 11 | ```
|
38 | 12 |
|
39 | 13 | ## Resources
|
40 | 14 |
|
41 |
| -| Name | Type | |
42 |
| -|------|------| |
43 |
| -| [azurerm_linux_virtual_machine.vm](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/linux_virtual_machine) | resource | |
44 |
| -| [azurerm_network_interface.nic](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/network_interface) | resource | |
45 |
| -| [azurerm_public_ip.public_ip](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/public_ip) | resource | |
46 |
| -| [azurerm_resource_group.rg](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/resource_group) | resource | |
47 |
| -| [random_password.password](https://registry.terraform.io/providers/hashicorp/random/latest/docs/resources/password) | resource | |
48 |
| -| [random_pet.vm_username](https://registry.terraform.io/providers/hashicorp/random/latest/docs/resources/pet) | resource | |
49 |
| -| [azurerm_subnet.subnet](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/data-sources/subnet) | data source | |
50 |
| -| [azurerm_virtual_network.vnet](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/data-sources/virtual_network) | data source | |
51 |
| -| [template_cloudinit_config.config](https://registry.terraform.io/providers/hashicorp/template/latest/docs/data-sources/cloudinit_config) | data source | |
52 |
| -| [template_file.user_data](https://registry.terraform.io/providers/hashicorp/template/latest/docs/data-sources/file) | data source | |
| 15 | +No resources. |
53 | 16 |
|
54 | 17 | ## Inputs
|
55 | 18 |
|
56 |
| -| Name | Description | Type | Required | |
57 |
| -|------|-------------|------|:--------:| |
58 |
| -| <a name="input_application_name"></a> [application_name](#input_application_name) | Azure application name tag | `string` | no | |
59 |
| -| <a name="input_environment"></a> [environment](#input_environment) | Environment tag value in Azure | `string` | no | |
60 |
| -| <a name="input_eviction_policy"></a> [eviction_policy](#input_eviction_policy) | Azure Spot VM eviction policy Delete or Deallocate | `string` | no | |
61 |
| -| <a name="input_location"></a> [location](#input_location) | Azure location where VM is deployed | `string` | no | |
62 |
| -| <a name="input_os_disk_size"></a> [os_disk_size](#input_os_disk_size) | OS disk size in GB | `number` | no | |
63 |
| -| <a name="input_priority"></a> [priority](#input_priority) | Type of vmss instances Spot or regular | `string` | no | |
64 |
| -| <a name="input_public_ip_address_name"></a> [public_ip_address_name](#input_public_ip_address_name) | Public IP address name | `string` | no | |
65 |
| -| <a name="input_resource_group_name"></a> [resource_group_name](#input_resource_group_name) | Azure resource group name | `string` | no | |
66 |
| -| <a name="input_source_image_reference"></a> [source_image_reference](#input_source_image_reference) | Source image reference for the virtual machine | ```object({ publisher = string offer = string sku = string version = string })``` | no | |
67 |
| -| <a name="input_subnet_name"></a> [subnet_name](#input_subnet_name) | Subnet name where VM will be attached | `string` | no | |
68 |
| -| <a name="input_temporary"></a> [temporary](#input_temporary) | Temporary tag value in Azure | `string` | no | |
69 |
| -| <a name="input_vm_sku"></a> [vm_sku](#input_vm_sku) | Azure virtual machine SKU | `string` | no | |
70 |
| -| <a name="input_vmname"></a> [vmname](#input_vmname) | Azure virtual machine name | `string` | no | |
71 |
| -| <a name="input_vnet_name"></a> [vnet_name](#input_vnet_name) | Virtual network name where VM will be attached | `string` | no | |
72 |
| -| <a name="input_vnet_rg"></a> [vnet_rg](#input_vnet_rg) | Virtual network resource group name | `string` | no | |
| 19 | +No inputs. |
73 | 20 |
|
74 | 21 | ## Outputs
|
75 | 22 |
|
76 |
| -| Name | Description | |
77 |
| -|------|-------------| |
78 |
| -| <a name="output_location"></a> [location](#output_location) | Location of the resource | |
79 |
| -| <a name="output_public_ip_address"></a> [public_ip_address](#output_public_ip_address) | Public IP address of the VM | |
80 |
| -| <a name="output_public_ip_address_name"></a> [public_ip_address_name](#output_public_ip_address_name) | Public IP address name | |
81 |
| -| <a name="output_resource_group_name"></a> [resource_group_name](#output_resource_group_name) | Resource group name | |
82 |
| -| <a name="output_subnet_name"></a> [subnet_name](#output_subnet_name) | Subnet used for the VM | |
83 |
| -| <a name="output_virtul_machine_name"></a> [virtul_machine_name](#output_virtul_machine_name) | Virtual machine name | |
84 |
| -| <a name="output_vm_private_ip"></a> [vm_private_ip](#output_vm_private_ip) | Private IP address of the VM | |
85 |
| -| <a name="output_vm_sku"></a> [vm_sku](#output_vm_sku) | Azure VM SKU | |
86 |
| -| <a name="output_vm_user_name"></a> [vm_user_name](#output_vm_user_name) | value of the username | |
87 |
| -| <a name="output_vm_user_password"></a> [vm_user_password](#output_vm_user_password) | value of the password | |
88 |
| -| <a name="output_vnet_name"></a> [vnet_name](#output_vnet_name) | Virtual Network used for the VM | |
| 23 | +No outputs. |
89 | 24 | <!-- END_AUTOMATED_TF_DOCS_BLOCK -->
|
0 commit comments