Skip to content

Commit adb5181

Browse files
github-actions[bot]github-actions[bot]
committed
terraform-docs: automated action
1 parent 60e80ae commit adb5181

File tree

1 file changed

+318
-0
lines changed

1 file changed

+318
-0
lines changed

‎README.md‎

Lines changed: 318 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,324 @@ terraform init && terraform plan && terraform apply -auto-approve
6767
```
6868

6969
<!-- BEGIN_TF_DOCS -->
70+
71+
72+
73+
## Examples
74+
75+
### AlmaLinux 8
76+
77+
```hcl
78+
variable "subscription_id" {}
79+
variable "tenant_id" {}
80+
81+
locals {
82+
cloud_init_template_path = "${path.cwd}/cloud-init.yaml.tpl"
83+
}
84+
85+
module "azure-ampere-vm" {
86+
source = "github.com/amperecomputing/terraform-azure-ampere-vm"
87+
subscription_id = var.subscription_id
88+
tenant_id = var.tenant_id
89+
# Optional
90+
# resource_group = var.resource_group
91+
# rg_prefix = var.rg_prefix
92+
# virtual_network_name = var.virtual_network_name
93+
# address_space = var.address_space
94+
# subnet_prefix = var.subnet_prefix
95+
# vm_size = var.vm_size
96+
location = "westus2"
97+
azure_vm_count = 1
98+
azure_os_image = "almalinux8"
99+
instance_prefix = "azure-ampere-vm-almalinux8"
100+
cloud_init_template_file = local.cloud_init_template_path
101+
}
102+
103+
output "azure_ampere_vm_private_ips" {
104+
value = module.azure-ampere-vm.azure_ampere_vm_private_ipaddresses
105+
}
106+
output "azure_ampere_vm_public_ips" {
107+
value = module.azure-ampere-vm.azure_ampere_vm_public_ipaddresses
108+
}
109+
```
110+
111+
### Debian 11
112+
113+
```hcl
114+
variable "subscription_id" {}
115+
variable "tenant_id" {}
116+
117+
locals {
118+
cloud_init_template_path = "${path.cwd}/cloud-init.yaml.tpl"
119+
}
120+
121+
module "azure-ampere-vm" {
122+
source = "github.com/amperecomputing/terraform-azure-ampere-vm"
123+
subscription_id = var.subscription_id
124+
tenant_id = var.tenant_id
125+
# Optional
126+
# resource_group = var.resource_group
127+
# rg_prefix = var.rg_prefix
128+
# virtual_network_name = var.virtual_network_name
129+
# address_space = var.address_space
130+
# subnet_prefix = var.subnet_prefix
131+
# vm_size = var.vm_size
132+
location = "westus2"
133+
azure_vm_count = 1
134+
azure_os_image = "debian11"
135+
instance_prefix = "azure-ampere-vm-debian-11"
136+
cloud_init_template_file = local.cloud_init_template_path
137+
}
138+
139+
output "azure_ampere_vm_private_ips" {
140+
value = module.azure-ampere-vm.azure_ampere_vm_private_ipaddresses
141+
}
142+
output "azure_ampere_vm_public_ips" {
143+
value = module.azure-ampere-vm.azure_ampere_vm_public_ipaddresses
144+
}
145+
```
146+
147+
### CBL Mariner
148+
149+
```hcl
150+
variable "subscription_id" {}
151+
variable "tenant_id" {}
152+
153+
locals {
154+
cloud_init_template_path = "${path.cwd}/cloud-init.yaml.tpl"
155+
}
156+
157+
module "azure-ampere-vm" {
158+
source = "github.com/amperecomputing/terraform-azure-ampere-vm"
159+
subscription_id = var.subscription_id
160+
tenant_id = var.tenant_id
161+
# Optional
162+
# resource_group = var.resource_group
163+
# rg_prefix = var.rg_prefix
164+
# virtual_network_name = var.virtual_network_name
165+
# address_space = var.address_space
166+
# subnet_prefix = var.subnet_prefix
167+
# vm_size = var.vm_size
168+
location = "westus2"
169+
azure_vm_count = 1
170+
azure_os_image = "mariner"
171+
instance_prefix = "azure-ampere-vm-mariner"
172+
cloud_init_template_file = local.cloud_init_template_path
173+
}
174+
175+
output "azure_ampere_vm_private_ips" {
176+
value = module.azure-ampere-vm.azure_ampere_vm_private_ipaddresses
177+
}
178+
output "azure_ampere_vm_public_ips" {
179+
value = module.azure-ampere-vm.azure_ampere_vm_public_ipaddresses
180+
}
181+
```
182+
183+
### OpenSuse
184+
185+
```hcl
186+
variable "subscription_id" {}
187+
variable "tenant_id" {}
188+
189+
locals {
190+
cloud_init_template_path = "${path.cwd}/cloud-init.yaml.tpl"
191+
}
192+
193+
module "azure-ampere-vm" {
194+
source = "github.com/amperecomputing/terraform-azure-ampere-vm"
195+
subscription_id = var.subscription_id
196+
tenant_id = var.tenant_id
197+
# Optional
198+
# resource_group = var.resource_group
199+
# rg_prefix = var.rg_prefix
200+
# virtual_network_name = var.virtual_network_name
201+
# address_space = var.address_space
202+
# subnet_prefix = var.subnet_prefix
203+
# vm_size = var.vm_size
204+
location = "westus2"
205+
azure_vm_count = 1
206+
azure_os_image = "opensuse"
207+
instance_prefix = "azure-ampere-vm-opensuse-15"
208+
cloud_init_template_file = local.cloud_init_template_path
209+
}
210+
211+
output "azure_ampere_vm_private_ips" {
212+
value = module.azure-ampere-vm.azure_ampere_vm_private_ipaddresses
213+
}
214+
output "azure_ampere_vm_public_ips" {
215+
value = module.azure-ampere-vm.azure_ampere_vm_public_ipaddresses
216+
}
217+
```
218+
219+
220+
### Example Ubuntu 18.04
221+
222+
```hcl
223+
variable "subscription_id" {}
224+
variable "tenant_id" {}
225+
226+
locals {
227+
cloud_init_template_path = "${path.cwd}/cloud-init.yaml.tpl"
228+
}
229+
230+
module "azure-ampere-vm" {
231+
source = "github.com/amperecomputing/terraform-azure-ampere-vm"
232+
subscription_id = var.subscription_id
233+
tenant_id = var.tenant_id
234+
# Optional
235+
# resource_group = var.resource_group
236+
# rg_prefix = var.rg_prefix
237+
# virtual_network_name = var.virtual_network_name
238+
# address_space = var.address_space
239+
# subnet_prefix = var.subnet_prefix
240+
# vm_size = var.vm_size
241+
location = "westus2"
242+
azure_vm_count = 1
243+
azure_os_image = "ubuntu1804"
244+
instance_prefix = "azure-ampere-vm-ubuntu-1804"
245+
cloud_init_template_file = local.cloud_init_template_path
246+
}
247+
248+
output "azure_ampere_vm_private_ips" {
249+
value = module.azure-ampere-vm.azure_ampere_vm_private_ipaddresses
250+
}
251+
output "azure_ampere_vm_public_ips" {
252+
value = module.azure-ampere-vm.azure_ampere_vm_public_ipaddresses
253+
}
254+
```
255+
256+
### Example Ubuntu 20.04
257+
258+
```hcl
259+
variable "subscription_id" {}
260+
variable "tenant_id" {}
261+
262+
locals {
263+
cloud_init_template_path = "${path.cwd}/cloud-init.yaml.tpl"
264+
}
265+
266+
module "azure-ampere-vm" {
267+
source = "github.com/amperecomputing/terraform-azure-ampere-vm"
268+
subscription_id = var.subscription_id
269+
tenant_id = var.tenant_id
270+
# Optional
271+
# resource_group = var.resource_group
272+
# rg_prefix = var.rg_prefix
273+
# virtual_network_name = var.virtual_network_name
274+
# address_space = var.address_space
275+
# subnet_prefix = var.subnet_prefix
276+
# vm_size = var.vm_size
277+
location = "westus2"
278+
azure_vm_count = 1
279+
azure_os_image = "ubuntu2004"
280+
instance_prefix = "azure-ampere-vm-ubuntu-2004"
281+
cloud_init_template_file = local.cloud_init_template_path
282+
}
283+
284+
output "azure_ampere_vm_private_ips" {
285+
value = module.azure-ampere-vm.azure_ampere_vm_private_ipaddresses
286+
}
287+
output "azure_ampere_vm_public_ips" {
288+
value = module.azure-ampere-vm.azure_ampere_vm_public_ipaddresses
289+
}
290+
```
291+
### Example Ubuntu 22.04
292+
293+
```hcl
294+
variable "subscription_id" {}
295+
variable "tenant_id" {}
296+
297+
locals {
298+
cloud_init_template_path = "${path.cwd}/cloud-init.yaml.tpl"
299+
}
300+
301+
module "azure-ampere-vm" {
302+
source = "github.com/amperecomputing/terraform-azure-ampere-vm"
303+
subscription_id = var.subscription_id
304+
tenant_id = var.tenant_id
305+
# Optional
306+
# resource_group = var.resource_group
307+
# rg_prefix = var.rg_prefix
308+
# virtual_network_name = var.virtual_network_name
309+
# address_space = var.address_space
310+
# subnet_prefix = var.subnet_prefix
311+
# vm_size = var.vm_size
312+
location = "westus2"
313+
azure_vm_count = 1
314+
azure_os_image = "ubuntu2204"
315+
instance_prefix = "azure-ampere-vm-ubuntu-2204"
316+
cloud_init_template_file = local.cloud_init_template_path
317+
}
318+
319+
output "azure_ampere_vm_private_ips" {
320+
value = module.azure-ampere-vm.azure_ampere_vm_private_ipaddresses
321+
}
322+
output "azure_ampere_vm_public_ips" {
323+
value = module.azure-ampere-vm.azure_ampere_vm_public_ipaddresses
324+
}
325+
```
326+
327+
## Inputs
328+
329+
| Name | Description | Type | Default | Required |
330+
|------|-------------|------|---------|:--------:|
331+
| <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 |
332+
| <a name="input_azure_os_image"></a> [azure\_os\_image](#input\_azure\_os\_image) | Default OS Image From the Local Vars | `string` | `"ubuntu2004"` | no |
333+
| <a name="input_azure_vm_count"></a> [azure\_vm\_count](#input\_azure\_vm\_count) | Azure Ampere Virtual machine Config | `number` | `1` | no |
334+
| <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 |
335+
| <a name="input_instance_prefix"></a> [instance\_prefix](#input\_instance\_prefix) | Name prefix for vm instances | `string` | `"azure-ampere-vm"` | no |
336+
| <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 |
337+
| <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 |
338+
| <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 |
339+
| <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 |
340+
| <a name="input_subscription_id"></a> [subscription\_id](#input\_subscription\_id) | Azure Credentials | `string` | `"Azure Subscription ID"` | no |
341+
| <a name="input_tags"></a> [tags](#input\_tags) | n/a | `map` | <pre>{<br/> "environment": "Public Cloud"<br/>}</pre> | no |
342+
| <a name="input_tenant_id"></a> [tenant\_id](#input\_tenant\_id) | n/a | `string` | `"Azure Tenant ID"` | no |
343+
| <a name="input_virtual_network_name"></a> [virtual\_network\_name](#input\_virtual\_network\_name) | The name for the virtual network. | `string` | `"vnet"` | no |
344+
| <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 |
345+
## Modules
346+
347+
No modules.
348+
## Outputs
349+
350+
| Name | Description |
351+
|------|-------------|
352+
| <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 |
353+
| <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 |
354+
| <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 |
355+
| <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 |
356+
| <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 |
357+
| <a name="output_azure_ssh_private_key"></a> [azure\_ssh\_private\_key](#output\_azure\_ssh\_private\_key) | output the Azure SSH private key |
358+
| <a name="output_azure_ssh_pubic_key"></a> [azure\_ssh\_pubic\_key](#output\_azure\_ssh\_pubic\_key) | output the Azure SSH public key |
359+
| <a name="output_random_uuid"></a> [random\_uuid](#output\_random\_uuid) | Output: A randomly generated uuid |
360+
## Providers
361+
362+
| Name | Version |
363+
|------|---------|
364+
| <a name="provider_azurerm"></a> [azurerm](#provider\_azurerm) | n/a |
365+
| <a name="provider_local"></a> [local](#provider\_local) | n/a |
366+
| <a name="provider_random"></a> [random](#provider\_random) | n/a |
367+
| <a name="provider_tls"></a> [tls](#provider\_tls) | n/a |
368+
## Resources
369+
370+
| Name | Type |
371+
|------|------|
372+
| [azurerm_network_interface.nic](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/network_interface) | resource |
373+
| [azurerm_network_security_group.nsg](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/network_security_group) | resource |
374+
| [azurerm_public_ip.pip](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/public_ip) | resource |
375+
| [azurerm_resource_group.rg](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/resource_group) | resource |
376+
| [azurerm_subnet.subnet](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/subnet) | resource |
377+
| [azurerm_virtual_machine.vm](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/virtual_machine) | resource |
378+
| [azurerm_virtual_network.vnet](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/virtual_network) | resource |
379+
| [local_file.azure-ssh-privkey](https://registry.terraform.io/providers/hashicorp/local/latest/docs/resources/file) | resource |
380+
| [local_file.azure-ssh-pubkey](https://registry.terraform.io/providers/hashicorp/local/latest/docs/resources/file) | resource |
381+
| [random_uuid.random_id](https://registry.terraform.io/providers/hashicorp/random/latest/docs/resources/uuid) | resource |
382+
| [tls_private_key.azure](https://registry.terraform.io/providers/hashicorp/tls/latest/docs/resources/private_key) | resource |
383+
| [azurerm_public_ip.pip](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/data-sources/public_ip) | data source |
384+
| [azurerm_subscription.current](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/data-sources/subscription) | data source |
385+
## Requirements
386+
387+
No requirements.
70388
<!-- END_TF_DOCS -->
71389

72390
## References

0 commit comments

Comments
 (0)