From 1213c0ddb0aa723d602246db3284a5d86dfa84f5 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" Date: Tue, 21 May 2024 21:30:54 +0000 Subject: [PATCH] terraform-docs: automated action --- README.md | 59 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 59 insertions(+) diff --git a/README.md b/README.md index 4c40ea5..8aea983 100644 --- a/README.md +++ b/README.md @@ -66,4 +66,63 @@ Reference for OS images [https://cloud.google.com/compute/docs/images/os-details](https://cloud.google.com/compute/docs/images/os-details) +## Providers + +| Name | Version | +|------|---------| +| [cloudinit](#provider\_cloudinit) | n/a | +| [google](#provider\_google) | n/a | +| [local](#provider\_local) | n/a | +| [random](#provider\_random) | n/a | +| [tls](#provider\_tls) | n/a | + +## Resources + +| Name | Type | +|------|------| +| [google_compute_address.static_ip](https://registry.terraform.io/providers/hashicorp/google/latest/docs/resources/compute_address) | resource | +| [google_compute_firewall.ssh](https://registry.terraform.io/providers/hashicorp/google/latest/docs/resources/compute_firewall) | resource | +| [google_compute_instance.default](https://registry.terraform.io/providers/hashicorp/google/latest/docs/resources/compute_instance) | resource | +| [google_compute_network.vnet](https://registry.terraform.io/providers/hashicorp/google/latest/docs/resources/compute_network) | resource | +| [google_compute_subnetwork.vnet](https://registry.terraform.io/providers/hashicorp/google/latest/docs/resources/compute_subnetwork) | resource | +| [google_os_login_ssh_public_key.cache](https://registry.terraform.io/providers/hashicorp/google/latest/docs/resources/os_login_ssh_public_key) | resource | +| [local_file.gcp-ssh-privkey](https://registry.terraform.io/providers/hashicorp/local/latest/docs/resources/file) | resource | +| [local_file.gcp-ssh-pubkey](https://registry.terraform.io/providers/hashicorp/local/latest/docs/resources/file) | resource | +| [random_uuid.random_id](https://registry.terraform.io/providers/hashicorp/random/latest/docs/resources/uuid) | resource | +| [tls_private_key.gcp](https://registry.terraform.io/providers/hashicorp/tls/latest/docs/resources/private_key) | resource | +| [cloudinit_config.cloud_config](https://registry.terraform.io/providers/hashicorp/cloudinit/latest/docs/data-sources/config) | data source | +| [google_client_openid_userinfo.me](https://registry.terraform.io/providers/hashicorp/google/latest/docs/data-sources/client_openid_userinfo) | data source | +| [google_compute_image.fedora_coreos_next](https://registry.terraform.io/providers/hashicorp/google/latest/docs/data-sources/compute_image) | data source | +| [google_compute_image.fedora_coreos_stable](https://registry.terraform.io/providers/hashicorp/google/latest/docs/data-sources/compute_image) | data source | +| [google_compute_image.fedora_coreos_testing](https://registry.terraform.io/providers/hashicorp/google/latest/docs/data-sources/compute_image) | data source | + +## Inputs + +| Name | Description | Type | Default | Required | +|------|-------------|------|---------|:--------:| +| [cloud\_init\_template\_file](#input\_cloud\_init\_template\_file) | Optional path for a cloud-init file | `string` | `null` | no | +| [gcp\_os\_image](#input\_gcp\_os\_image) | Default OS Image From the Local Vars | `string` | `"ubuntu2404"` | no | +| [gcp\_vcn\_cidr\_block](#input\_gcp\_vcn\_cidr\_block) | CIDR Address range for GCE Networks | `string` | `"10.2.0.0/16"` | no | +| [gcp\_vcn\_cidr\_subnet](#input\_gcp\_vcn\_cidr\_subnet) | CIDR Address range for GCE Networks | `string` | `"10.2.1.0/24"` | no | +| [gcp\_vm\_count](#input\_gcp\_vm\_count) | GCE Virtual Machine Count | `number` | `1` | no | +| [instance\_prefix](#input\_instance\_prefix) | Name prefix for vm instances | `string` | `"ampere-taut2a"` | no | +| [location](#input\_location) | Google Location | `string` | `"US"` | no | +| [project\_id](#input\_project\_id) | Google Project ID | `any` | n/a | yes | +| [region](#input\_region) | Google Region | `string` | `"us-central1"` | no | +| [startup\_script\_template\_file](#input\_startup\_script\_template\_file) | Optional path for a startup script file | `string` | `null` | no | +| [virtual\_network\_name](#input\_virtual\_network\_name) | virtual\_network\_name | `string` | `"terraform-ampere-taut2a"` | no | +| [zone](#input\_zone) | Google Region | `string` | `"us-central1-a"` | no | + +## Outputs + +| Name | Description | +|------|-------------| +| [ampere\_t2a\_metadata](#output\_ampere\_t2a\_metadata) | Output rendered instance Metadata | +| [ampere\_t2a\_private\_ips](#output\_ampere\_t2a\_private\_ips) | Output GCE Ampere Instance Private IP(s) | +| [ampere\_t2a\_public\_ips](#output\_ampere\_t2a\_public\_ips) | Output GCE Ampere Instance Public IP(s) | +| [cloud\_config](#output\_cloud\_config) | n/a | +| [gcp\_ssh\_private\_key](#output\_gcp\_ssh\_private\_key) | Output GCE SSH private key | +| [gcp\_ssh\_pubic\_key](#output\_gcp\_ssh\_pubic\_key) | Output GCE SSH public key | +| [my-email](#output\_my-email) | Output email address | +| [random\_uuid](#output\_random\_uuid) | Output a randomly generated uuid |