Skip to content

Commit 9caa235

Browse files
author
Peter Pouliot
committed
tf-docs
1 parent 7eba853 commit 9caa235

File tree

2 files changed

+129
-66
lines changed

2 files changed

+129
-66
lines changed

‎.terraform-docs.yml‎

Lines changed: 117 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,117 @@
1+
formatter: "markdown"
2+
3+
version: ""
4+
5+
header-from: main.tf
6+
footer-from: ""
7+
8+
recursive:
9+
enabled: false
10+
path: modules
11+
include-main: true
12+
13+
sections:
14+
hide: []
15+
show: []
16+
17+
content: |-
18+
19+
{{ .Header }}
20+
21+
## Examples
22+
23+
### AlmaLinux 8
24+
25+
```hcl
26+
{{ include "examples/almalinux8/main.tf" }}
27+
```
28+
29+
### Debian 11
30+
31+
```hcl
32+
{{ include "examples/debian11/main.tf" }}
33+
```
34+
35+
### CBL Mariner
36+
37+
```hcl
38+
{{ include "examples/cbl-mariner/main.tf" }}
39+
```
40+
41+
### OpenSuse
42+
43+
```hcl
44+
{{ include "examples/opensuse/main.tf" }}
45+
```
46+
47+
48+
### Example Ubuntu 18.04
49+
50+
```hcl
51+
{{ include "examples/ubuntu1804/main.tf" }}
52+
```
53+
54+
### Example Ubuntu 20.04
55+
56+
```hcl
57+
{{ include "examples/ubuntu2004/main.tf" }}
58+
```
59+
### Example Ubuntu 22.04
60+
61+
```hcl
62+
{{ include "examples/ubuntu2204/main.tf" }}
63+
```
64+
65+
{{ .Inputs }}
66+
{{ .Modules }}
67+
{{ .Outputs }}
68+
{{ .Providers }}
69+
{{ .Resources }}
70+
{{ .Requirements }}
71+
{{ .Footer }}
72+
73+
output:
74+
file: ""
75+
mode: inject
76+
template: |-
77+
<!-- BEGIN_TF_DOCS -->
78+
{{ .Content }}
79+
<<<<<<< HEAD
80+
<!-- END_TF_DOCS -->
81+
=======
82+
83+
## Example
84+
85+
```hcl
86+
{{ include "examples/rockylinux8/main.tf" }}
87+
```
88+
89+
```hcl
90+
{{ include "examples/rockylinux9/main.tf" }}
91+
```
92+
93+
<!-- END_TF_DOCS -->
94+
>>>>>>> e67d73a (testing)
95+
96+
output-values:
97+
enabled: false
98+
from: ""
99+
100+
sort:
101+
enabled: true
102+
by: name
103+
104+
settings:
105+
anchor: true
106+
color: true
107+
default: true
108+
description: false
109+
escape: true
110+
hide-empty: false
111+
html: true
112+
indent: 2
113+
lockfile: true
114+
read-comments: true
115+
required: true
116+
sensitive: true
117+
type: true

‎README.md‎

Lines changed: 12 additions & 66 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,19 @@
22

33
# terraform-azure-ampere-vm
44

5+
[![Source Code](https://img.shields.io/badge/source-GitHub-blue.svg?style=flat)](https://github.com/AmpereComputing/terraform-azure-ampere-vm)
6+
![documentation workflow](https://github.com/AmpereComputing/terraform-azure-ampere-vm/actions/workflows/documentation.yml/badge.svg?label=build&style=flat-square&branch=main)
7+
[![pages-build-deployment](https://github.com/AmpereComputing/terraform-gcp-ampere-t2a/actions/workflows/pages/pages-build-deployment/badge.svg)](https://github.com/AmpereComputing/terraform-gcp-ampere-t2a/actions/workflows/pages/pages-build-deployment)
8+
[![Latest version](https://img.shields.io/github/tag/AmpereComputing/terraform-azure-ampere-vm.svg?label=release&style=flat&maxAge=3600)](https://github.com/AmpereComputing/terraform-azure-ampere-vm/tags)
9+
[![GitHub issues](https://img.shields.io/github/issues/AmpereComputing/terraform-azure-ampere-vm.svg)](https://github.com/AmpereComputing/terraform-azure-ampere-vm/issues)
10+
![Github stars](https://badgen.net/github/stars/AmpereComputing/terraform-azure-ampere-vm?icon=github&label=stars)
11+
![Github last-commit](https://img.shields.io/github/last-commit/AmpereComputing/terraform-azure-ampere-vm)
12+
[![GitHub forks](https://img.shields.io/github/forks/AmpereComputing/terraform-azure-ampere-vm.svg)](https://github.com/AmpereComputing/terraform-azure-ampere-vm/network)
13+
![Github forks](https://badgen.net/github/forks/AmpereComputing/terraform-azure-ampere-vm?icon=github&label=forks)
14+
![GitHub License](https://img.shields.io/github/license/AmpereComputing/terraform-azure-ampere-vm)
515
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
16+
![GitHub deployments](https://img.shields.io/github/deployments/AmpereComputing/terraform-azure-ampere-vm/github-pages)
17+
![Website](https://img.shields.io/website?url=https%3A%2F%2Famperecomputing.github.io/terraform-azure-ampere-vm)
618

719
## Description
820

@@ -49,72 +61,6 @@ terraform init && terraform plan && terraform apply -auto-approve
4961
```
5062

5163
<!-- BEGIN_TF_DOCS -->
52-
## Requirements
53-
54-
No requirements.
55-
56-
## Providers
57-
58-
| Name | Version |
59-
|------|---------|
60-
| <a name="provider_azurerm"></a> [azurerm](#provider\_azurerm) | n/a |
61-
| <a name="provider_local"></a> [local](#provider\_local) | n/a |
62-
| <a name="provider_random"></a> [random](#provider\_random) | n/a |
63-
| <a name="provider_tls"></a> [tls](#provider\_tls) | n/a |
64-
65-
## Modules
66-
67-
No modules.
68-
69-
## Resources
70-
71-
| Name | Type |
72-
|------|------|
73-
| [azurerm_network_interface.nic](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/network_interface) | resource |
74-
| [azurerm_network_security_group.nsg](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/network_security_group) | resource |
75-
| [azurerm_public_ip.pip](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/public_ip) | resource |
76-
| [azurerm_resource_group.rg](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/resource_group) | resource |
77-
| [azurerm_subnet.subnet](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/subnet) | resource |
78-
| [azurerm_virtual_machine.vm](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/virtual_machine) | resource |
79-
| [azurerm_virtual_network.vnet](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/virtual_network) | resource |
80-
| [local_file.azure-ssh-privkey](https://registry.terraform.io/providers/hashicorp/local/latest/docs/resources/file) | resource |
81-
| [local_file.azure-ssh-pubkey](https://registry.terraform.io/providers/hashicorp/local/latest/docs/resources/file) | resource |
82-
| [random_uuid.random_id](https://registry.terraform.io/providers/hashicorp/random/latest/docs/resources/uuid) | resource |
83-
| [tls_private_key.azure](https://registry.terraform.io/providers/hashicorp/tls/latest/docs/resources/private_key) | resource |
84-
| [azurerm_public_ip.pip](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/data-sources/public_ip) | data source |
85-
| [azurerm_subscription.current](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/data-sources/subscription) | data source |
86-
87-
## Inputs
88-
89-
| Name | Description | Type | Default | Required |
90-
|------|-------------|------|---------|:--------:|
91-
| <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 |
92-
| <a name="input_azure_os_image"></a> [azure\_os\_image](#input\_azure\_os\_image) | Default OS Image From the Local Vars | `string` | `"ubuntu2004"` | no |
93-
| <a name="input_azure_vm_count"></a> [azure\_vm\_count](#input\_azure\_vm\_count) | Azure Ampere Virtual machine Config | `number` | `1` | no |
94-
| <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 |
95-
| <a name="input_instance_prefix"></a> [instance\_prefix](#input\_instance\_prefix) | Name prefix for vm instances | `string` | `"azure-ampere-vm"` | no |
96-
| <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 |
97-
| <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 |
98-
| <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 |
99-
| <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 |
100-
| <a name="input_subscription_id"></a> [subscription\_id](#input\_subscription\_id) | Azure Credentials | `string` | `"Azure Subscription ID"` | no |
101-
| <a name="input_tags"></a> [tags](#input\_tags) | n/a | `map` | <pre>{<br> "environment": "Public Cloud"<br>}</pre> | no |
102-
| <a name="input_tenant_id"></a> [tenant\_id](#input\_tenant\_id) | n/a | `string` | `"Azure Tenant ID"` | no |
103-
| <a name="input_virtual_network_name"></a> [virtual\_network\_name](#input\_virtual\_network\_name) | The name for the virtual network. | `string` | `"vnet"` | no |
104-
| <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 |
105-
106-
## Outputs
107-
108-
| Name | Description |
109-
|------|-------------|
110-
| <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 |
111-
| <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 |
112-
| <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 |
113-
| <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 |
114-
| <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 |
115-
| <a name="output_azure_ssh_private_key"></a> [azure\_ssh\_private\_key](#output\_azure\_ssh\_private\_key) | output the Azure SSH private key |
116-
| <a name="output_azure_ssh_pubic_key"></a> [azure\_ssh\_pubic\_key](#output\_azure\_ssh\_pubic\_key) | output the Azure SSH public key |
117-
| <a name="output_random_uuid"></a> [random\_uuid](#output\_random\_uuid) | Output: A randomly generated uuid |
11864
<!-- END_TF_DOCS -->
11965

12066
## References

0 commit comments

Comments
 (0)