Skip to content

Commit 2f68f67

Browse files
Peter PouliotPeter Pouliot
Peter Pouliot
authored and
Peter Pouliot
committed
fixing README tfdocs output
1 parent ac650b5 commit 2f68f67

File tree

1 file changed

+1
-72
lines changed

1 file changed

+1
-72
lines changed

‎README.md‎

Lines changed: 1 addition & 72 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,7 @@ This can also be used as a terraform module. The [examples](examples) director
4747
```
4848
terraform init && terraform plan && terraform apply -auto-approve
4949
```
50+
5051
<!-- BEGIN_TF_DOCS -->
5152
<!-- END_TF_DOCS -->
5253

@@ -65,75 +66,3 @@ terraform init && terraform plan && terraform apply -auto-approve
6566
* [Install Azure CLI on Windows](https://docs.microsoft.com/en-us/cli/azure/install-azure-cli-windows)
6667
* [Azure CLI authentication in Terraform](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/guides/azure_cli)
6768
* [cloud-init support for virtual machines in Azure](https://docs.microsoft.com/en-us/azure/virtual-machines/linux/using-cloud-init)
68-
69-
<!-- BEGIN_TF_DOCS -->
70-
## Requirements
71-
72-
No requirements.
73-
74-
## Providers
75-
76-
| Name | Version |
77-
|------|---------|
78-
| <a name="provider_azurerm"></a> [azurerm](#provider\_azurerm) | n/a |
79-
| <a name="provider_local"></a> [local](#provider\_local) | n/a |
80-
| <a name="provider_random"></a> [random](#provider\_random) | n/a |
81-
| <a name="provider_template"></a> [template](#provider\_template) | n/a |
82-
| <a name="provider_tls"></a> [tls](#provider\_tls) | n/a |
83-
84-
## Modules
85-
86-
No modules.
87-
88-
## Resources
89-
90-
| Name | Type |
91-
|------|------|
92-
| [azurerm_network_interface.nic](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/network_interface) | resource |
93-
| [azurerm_network_security_group.nsg](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/network_security_group) | resource |
94-
| [azurerm_public_ip.pip](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/public_ip) | resource |
95-
| [azurerm_resource_group.rg](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/resource_group) | resource |
96-
| [azurerm_subnet.subnet](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/subnet) | resource |
97-
| [azurerm_virtual_machine.vm](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/virtual_machine) | resource |
98-
| [azurerm_virtual_network.vnet](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/virtual_network) | resource |
99-
| [local_file.azure-ssh-privkey](https://registry.terraform.io/providers/hashicorp/local/latest/docs/resources/file) | resource |
100-
| [local_file.azure-ssh-pubkey](https://registry.terraform.io/providers/hashicorp/local/latest/docs/resources/file) | resource |
101-
| [random_uuid.random_id](https://registry.terraform.io/providers/hashicorp/random/latest/docs/resources/uuid) | resource |
102-
| [tls_private_key.azure](https://registry.terraform.io/providers/hashicorp/tls/latest/docs/resources/private_key) | resource |
103-
| [azurerm_public_ip.pip](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/data-sources/public_ip) | data source |
104-
| [azurerm_subscription.current](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/data-sources/subscription) | data source |
105-
| [template_file.cloud_config](https://registry.terraform.io/providers/hashicorp/template/latest/docs/data-sources/file) | data source |
106-
107-
## Inputs
108-
109-
| Name | Description | Type | Default | Required |
110-
|------|-------------|------|---------|:--------:|
111-
| <a name="input_address_space"></a> [address\_space](#input\_address\_space) | The address space that is used by the virtual network. You can supply more than one address space. Changing this forces a new resource to be created. | `string` | `"10.2.0.0/16"` | no |
112-
| <a name="input_azure_os_image"></a> [azure\_os\_image](#input\_azure\_os\_image) | Default OS Image From the Local Vars | `string` | `"ubuntu2004"` | no |
113-
| <a name="input_azure_vm_count"></a> [azure\_vm\_count](#input\_azure\_vm\_count) | Azure Ampere Virtual machine Config | `number` | `1` | no |
114-
| <a name="input_cloud_init_template_file"></a> [cloud\_init\_template\_file](#input\_cloud\_init\_template\_file) | Optional path for a cloud-init file | `string` | `null` | no |
115-
| <a name="input_instance_prefix"></a> [instance\_prefix](#input\_instance\_prefix) | Name prefix for vm instances | `string` | `"azure-ampere-vm"` | no |
116-
| <a name="input_location"></a> [location](#input\_location) | The location/region where the virtual network is created. Changing this forces a new resource to be created. | `string` | `"westus2"` | no |
117-
| <a name="input_resource_group"></a> [resource\_group](#input\_resource\_group) | The name of the resource group in which to create the virtual network. | `string` | `"Terraform-Ampere-on-Azure"` | no |
118-
| <a name="input_rg_prefix"></a> [rg\_prefix](#input\_rg\_prefix) | The shortened abbreviation to represent your resource group that will go on the front of some resources. | `string` | `"rg"` | no |
119-
| <a name="input_subnet_prefix"></a> [subnet\_prefix](#input\_subnet\_prefix) | The address prefix to use for the subnet. | `string` | `"10.2.1.0/24"` | no |
120-
| <a name="input_subscription_id"></a> [subscription\_id](#input\_subscription\_id) | Azure Credentials | `string` | `"Azure Subscription ID"` | no |
121-
| <a name="input_tags"></a> [tags](#input\_tags) | n/a | `map` | <pre>{<br> "environment": "Public Cloud"<br>}</pre> | no |
122-
| <a name="input_tenant_id"></a> [tenant\_id](#input\_tenant\_id) | n/a | `string` | `"Azure Tenant ID"` | no |
123-
| <a name="input_virtual_network_name"></a> [virtual\_network\_name](#input\_virtual\_network\_name) | The name for the virtual network. | `string` | `"vnet"` | no |
124-
| <a name="input_vm_size"></a> [vm\_size](#input\_vm\_size) | Specifies the size of the Azure Ampere virtual machine. | `string` | `"Standard_D16ps_v5"` | no |
125-
126-
## Outputs
127-
128-
| Name | Description |
129-
|------|-------------|
130-
| <a name="output_azure_ampere_vm_private_ipaddresses"></a> [azure\_ampere\_vm\_private\_ipaddresses](#output\_azure\_ampere\_vm\_private\_ipaddresses) | Output the Azure VM(s)) private/internal ip address |
131-
| <a name="output_azure_ampere_vm_public_ipaddresses"></a> [azure\_ampere\_vm\_public\_ipaddresses](#output\_azure\_ampere\_vm\_public\_ipaddresses) | Output the Azure VM(s)) public/external ip address |
132-
| <a name="output_azure_ampere_vm_ssh_private_key"></a> [azure\_ampere\_vm\_ssh\_private\_key](#output\_azure\_ampere\_vm\_ssh\_private\_key) | Output the Azure SSH private key |
133-
| <a name="output_azure_ampere_vm_ssh_public_key"></a> [azure\_ampere\_vm\_ssh\_public\_key](#output\_azure\_ampere\_vm\_ssh\_public\_key) | Output the Azure SSH public key |
134-
| <a name="output_azure_current_subscription_display_name"></a> [azure\_current\_subscription\_display\_name](#output\_azure\_current\_subscription\_display\_name) | Output the Display Name for the current Azure Subscription |
135-
| <a name="output_azure_ssh_private_key"></a> [azure\_ssh\_private\_key](#output\_azure\_ssh\_private\_key) | output the Azure SSH private key |
136-
| <a name="output_azure_ssh_pubic_key"></a> [azure\_ssh\_pubic\_key](#output\_azure\_ssh\_pubic\_key) | output the Azure SSH public key |
137-
| <a name="output_cloud_init"></a> [cloud\_init](#output\_cloud\_init) | Output the rendered cloud-init file |
138-
| <a name="output_random_uuid"></a> [random\_uuid](#output\_random\_uuid) | Output: A randomly generated uuid |
139-
<!-- END_TF_DOCS -->

0 commit comments

Comments
 (0)