Merge pull request #16 from equinix-labs:readme-lints

Fix readme linting issues

README.md

@@ -1,3 +1,7 @@
+# terraform-vcf-metal-deployment
+
+This Terraform module deploys a VMware Cloud Foundation (VCF) environment on Equinix Metal.
+
 <!-- BEGIN_TF_DOCS -->
 ## Requirements
 
@@ -49,14 +53,14 @@
 | <a name="input_esxi_network_space"></a> [esxi\_network\_space](#input\_esxi\_network\_space) | Overall Network space for the VCF project | `string` | n/a | yes |
 | <a name="input_esxi_ntp_server"></a> [esxi\_ntp\_server](#input\_esxi\_ntp\_server) | NTP Server to be configured in ESXi (vcf-ems-deployment-parameter.xlsx > Deploy Parameters Sheet > F8:G8) | `string` | n/a | yes |
 | <a name="input_esxi_password"></a> [esxi\_password](#input\_esxi\_password) | mkpasswd Pre-hashed root password to be set for ESXi instances (Hash the password from vcf-ems-deployment-parameter.xlsx > Credentials Sheet > C8 using 'mkpasswd --method=SHA-512' from Linux whois package) | `string` | n/a | yes |
-| <a name="input_esxi_size"></a> [esxi\_size](#input\_esxi\_size) | Slug for target hardware plan type. The only officially supported server plan for ESXi/VCF is the 'n3.xlarge.opt-m4s2' https://deploy.equinix.com/product/servers/n3-xlarge-opt-m4s2/ | `string` | n/a | yes |
-| <a name="input_esxi_version_slug"></a> [esxi\_version\_slug](#input\_esxi\_version\_slug) | Slug for ESXi OS version to be deployed on Metal Instances https://github.com/equinixmetal-images/changelog/blob/main/vmware-esxi/x86_64/8.md | `string` | n/a | yes |
-| <a name="input_fabric_client_id"></a> [fabric\_client\_id](#input\_fabric\_client\_id) | Client ID for Equinix Fabric API interaction https://developer.equinix.com/docs?page=/dev-docs/fabric/overview | `string` | n/a | yes |
-| <a name="input_fabric_client_secret"></a> [fabric\_client\_secret](#input\_fabric\_client\_secret) | Client Secret for Equinix Fabric API interaction https://developer.equinix.com/docs?page=/dev-docs/fabric/overview | `string` | n/a | yes |
-| <a name="input_metal_auth_token"></a> [metal\_auth\_token](#input\_metal\_auth\_token) | API Token for Equinix Metal API interaction https://deploy.equinix.com/developers/docs/metal/identity-access-management/api-keys/ | `string` | n/a | yes |
-| <a name="input_metal_project_id"></a> [metal\_project\_id](#input\_metal\_project\_id) | Equinix Metal Project UUID, can be found in the General Tab of the Organization Settings https://deploy.equinix.com/developers/docs/metal/identity-access-management/organizations/#organization-settings-and-roles | `string` | n/a | yes |
-| <a name="input_metal_vrf_asn"></a> [metal\_vrf\_asn](#input\_metal\_vrf\_asn) | ASN to be used for Metal VRF https://deploy.equinix.com/developers/docs/metal/networking/vrf/ | `string` | n/a | yes |
-| <a name="input_metro"></a> [metro](#input\_metro) | Equinix Metal Metro where Metal resources are going to be deployed https://deploy.equinix.com/developers/docs/metal/locations/metros/#metros-quick-reference | `string` | n/a | yes |
+| <a name="input_esxi_size"></a> [esxi\_size](#input\_esxi\_size) | Slug for target hardware plan type. The only officially supported server plan for ESXi/VCF is the 'n3.xlarge.opt-m4s2' <https://deploy.equinix.com/product/servers/n3-xlarge-opt-m4s2/> | `string` | n/a | yes |
+| <a name="input_esxi_version_slug"></a> [esxi\_version\_slug](#input\_esxi\_version\_slug) | Slug for ESXi OS version to be deployed on Metal Instances <https://github.com/equinixmetal-images/changelog/blob/main/vmware-esxi/x86_64/8.md> | `string` | n/a | yes |
+| <a name="input_fabric_client_id"></a> [fabric\_client\_id](#input\_fabric\_client\_id) | Client ID for Equinix Fabric API interaction <https://developer.equinix.com/docs?page=/dev-docs/fabric/overview> | `string` | n/a | yes |
+| <a name="input_fabric_client_secret"></a> [fabric\_client\_secret](#input\_fabric\_client\_secret) | Client Secret for Equinix Fabric API interaction <https://developer.equinix.com/docs?page=/dev-docs/fabric/overview> | `string` | n/a | yes |
+| <a name="input_metal_auth_token"></a> [metal\_auth\_token](#input\_metal\_auth\_token) | API Token for Equinix Metal API interaction <https://deploy.equinix.com/developers/docs/metal/identity-access-management/api-keys/> | `string` | n/a | yes |
+| <a name="input_metal_project_id"></a> [metal\_project\_id](#input\_metal\_project\_id) | Equinix Metal Project UUID, can be found in the General Tab of the Organization Settings <https://deploy.equinix.com/developers/docs/metal/identity-access-management/organizations/#organization-settings-and-roles> | `string` | n/a | yes |
+| <a name="input_metal_vrf_asn"></a> [metal\_vrf\_asn](#input\_metal\_vrf\_asn) | ASN to be used for Metal VRF <https://deploy.equinix.com/developers/docs/metal/networking/vrf/> | `string` | n/a | yes |
+| <a name="input_metro"></a> [metro](#input\_metro) | Equinix Metal Metro where Metal resources are going to be deployed <https://deploy.equinix.com/developers/docs/metal/locations/metros/#metros-quick-reference> | `string` | n/a | yes |
 | <a name="input_primary_ne_device_port"></a> [primary\_ne\_device\_port](#input\_primary\_ne\_device\_port) | Port Number on Primary Network Edge Device for interconnection to Metal VRF | `number` | n/a | yes |
 | <a name="input_primary_ne_device_uuid"></a> [primary\_ne\_device\_uuid](#input\_primary\_ne\_device\_uuid) | UUID of Primary Network Edge Device for interconenction to Metal VRF | `string` | n/a | yes |
 | <a name="input_secondary_ne_device_port"></a> [secondary\_ne\_device\_port](#input\_secondary\_ne\_device\_port) | Port Number on Secondary Network Edge Device for interconnection to Metal VRF | `number` | n/a | yes |
@@ -86,4 +90,4 @@
 | <a name="output_management_public_ip"></a> [management\_public\_ip](#output\_management\_public\_ip) | The public IP address of the windows management host |
 | <a name="output_ssh_forward_command"></a> [ssh\_forward\_command](#output\_ssh\_forward\_command) | SSH port forward command to use to connect to the VCF GUIs |
 | <a name="output_ssh_private_key"></a> [ssh\_private\_key](#output\_ssh\_private\_key) | The private key for the SSH keypair |
-<!-- END_TF_DOCS -->
+<!-- END_TF_DOCS -->

modules/metal_vrf_gateway_w_dynamic_neighbor/README.md

@@ -1,3 +1,7 @@
+# Metal VRF Gateway with Dynamic Neighbor
+
+This module creates a Metal VRF Gateway with a dynamic BGP neighbor range.
+
 <!-- BEGIN_TF_DOCS -->
 ## Requirements
 
@@ -31,13 +35,13 @@ No modules.
 
 | Name | Description | Type | Default | Required |
 |------|-------------|------|---------|:--------:|
-| <a name="input_metal_auth_token"></a> [metal\_auth\_token](#input\_metal\_auth\_token) | API Token for Equinix Metal API interaction https://deploy.equinix.com/developers/docs/metal/identity-access-management/api-keys/ | `string` | n/a | yes |
-| <a name="input_metal_project_id"></a> [metal\_project\_id](#input\_metal\_project\_id) | Equinix Metal Project UUID, can be found in the General Tab of the Organization Settings https://deploy.equinix.com/developers/docs/metal/identity-access-management/organizations/#organization-settings-and-roles | `string` | n/a | yes |
+| <a name="input_metal_auth_token"></a> [metal\_auth\_token](#input\_metal\_auth\_token) | API Token for Equinix Metal API interaction <https://deploy.equinix.com/developers/docs/metal/identity-access-management/api-keys/> | `string` | n/a | yes |
+| <a name="input_metal_project_id"></a> [metal\_project\_id](#input\_metal\_project\_id) | Equinix Metal Project UUID, can be found in the General Tab of the Organization Settings <https://deploy.equinix.com/developers/docs/metal/identity-access-management/organizations/#organization-settings-and-roles> | `string` | n/a | yes |
 | <a name="input_vrf_id"></a> [vrf\_id](#input\_vrf\_id) | UUID of VRF parent of the Metal VRF Gateway to be created | `string` | n/a | yes |
 | <a name="input_vrfgw_dynamic_neighbor_asn"></a> [vrfgw\_dynamic\_neighbor\_asn](#input\_vrfgw\_dynamic\_neighbor\_asn) | ASN of the BGP Neighbors that will peer with the created Metal VRF Gateway | `string` | n/a | yes |
 | <a name="input_vrfgw_dynamic_neighbor_range"></a> [vrfgw\_dynamic\_neighbor\_range](#input\_vrfgw\_dynamic\_neighbor\_range) | /31 IP Range of BGP Neighbors that will peer with the created Metal VRF Gateway | `string` | n/a | yes |
 | <a name="input_vrfgw_enable_dynamic_neighbor"></a> [vrfgw\_enable\_dynamic\_neighbor](#input\_vrfgw\_enable\_dynamic\_neighbor) | Whether or not to configure BGP Dynamic Neighbor range on the created Metal VRF Gateway | `bool` | n/a | yes |
-| <a name="input_vrfgw_metro"></a> [vrfgw\_metro](#input\_vrfgw\_metro) | Equinix Metal Metro where Metal resources are going to be deployed https://deploy.equinix.com/developers/docs/metal/locations/metros/#metros-quick-reference | `string` | n/a | yes |
+| <a name="input_vrfgw_metro"></a> [vrfgw\_metro](#input\_vrfgw\_metro) | Equinix Metal Metro where Metal resources are going to be deployed <https://deploy.equinix.com/developers/docs/metal/locations/metros/#metros-quick-reference> | `string` | n/a | yes |
 | <a name="input_vrfgw_subnet"></a> [vrfgw\_subnet](#input\_vrfgw\_subnet) | /29 or larger network subnet to be used for Metal VRF Gateway. Note: first usable IP in the specified range will be claimed by the Metal VRF Gateway itself | `string` | n/a | yes |
 | <a name="input_vrfgw_vlan_name"></a> [vrfgw\_vlan\_name](#input\_vrfgw\_vlan\_name) | Description to associate with Metal VLAN being created for use use Metal VRF Gateway | `string` | n/a | yes |
 | <a name="input_vrfgw_vxlan_id"></a> [vrfgw\_vxlan\_id](#input\_vrfgw\_vxlan\_id) | Metal VLAN ID (802.1q ie. 2-3999) to be created for use with Metal VRF Gateway | `string` | n/a | yes |
@@ -47,4 +51,4 @@ No modules.
 | Name | Description |
 |------|-------------|
 | <a name="output_vlan_uuid"></a> [vlan\_uuid](#output\_vlan\_uuid) | ID of the Metal VRF |
-<!-- END_TF_DOCS -->
+<!-- END_TF_DOCS -->

modules/metal_vrf_w_interconnection_to_network_edge/README.md

@@ -1,3 +1,7 @@
+# Equinix Metal VRF with Interconnection to Network Edge
+
+This module creates the VRF and Interconnection to Network Edge on Equinix Metal.
+
 <!-- BEGIN_TF_DOCS -->
 ## Requirements
 
@@ -34,13 +38,13 @@ No modules.
 
 | Name | Description | Type | Default | Required |
 |------|-------------|------|---------|:--------:|
-| <a name="input_fabric_client_id"></a> [fabric\_client\_id](#input\_fabric\_client\_id) | Client ID for Equinix Fabric API interaction https://developer.equinix.com/docs?page=/dev-docs/fabric/overview | `string` | n/a | yes |
-| <a name="input_fabric_client_secret"></a> [fabric\_client\_secret](#input\_fabric\_client\_secret) | Client Secret for Equinix Fabric API interaction https://developer.equinix.com/docs?page=/dev-docs/fabric/overview | `string` | n/a | yes |
+| <a name="input_fabric_client_id"></a> [fabric\_client\_id](#input\_fabric\_client\_id) | Client ID for Equinix Fabric API interaction <https://developer.equinix.com/docs?page=/dev-docs/fabric/overview> | `string` | n/a | yes |
+| <a name="input_fabric_client_secret"></a> [fabric\_client\_secret](#input\_fabric\_client\_secret) | Client Secret for Equinix Fabric API interaction <https://developer.equinix.com/docs?page=/dev-docs/fabric/overview> | `string` | n/a | yes |
 | <a name="input_fabric_interconnection_notification_email"></a> [fabric\_interconnection\_notification\_email](#input\_fabric\_interconnection\_notification\_email) | Email address for interconnection notifications (must be valid email address format) | `string` | n/a | yes |
-| <a name="input_metal_auth_token"></a> [metal\_auth\_token](#input\_metal\_auth\_token) | API Token for Equinix Metal API interaction https://deploy.equinix.com/developers/docs/metal/identity-access-management/api-keys/ | `string` | n/a | yes |
-| <a name="input_metal_metro"></a> [metal\_metro](#input\_metal\_metro) | Equinix Metal Metro where Metal resources are going to be deployed https://deploy.equinix.com/developers/docs/metal/locations/metros/#metros-quick-reference | `string` | n/a | yes |
-| <a name="input_metal_project_id"></a> [metal\_project\_id](#input\_metal\_project\_id) | Equinix Metal Project UUID, can be found in the General Tab of the Organization Settings https://deploy.equinix.com/developers/docs/metal/identity-access-management/organizations/#organization-settings-and-roles | `string` | n/a | yes |
-| <a name="input_metal_vrf_asn"></a> [metal\_vrf\_asn](#input\_metal\_vrf\_asn) | ASN to be used for Metal VRF https://deploy.equinix.com/developers/docs/metal/networking/vrf/ | `string` | n/a | yes |
+| <a name="input_metal_auth_token"></a> [metal\_auth\_token](#input\_metal\_auth\_token) | API Token for Equinix Metal API interaction <https://deploy.equinix.com/developers/docs/metal/identity-access-management/api-keys/> | `string` | n/a | yes |
+| <a name="input_metal_metro"></a> [metal\_metro](#input\_metal\_metro) | Equinix Metal Metro where Metal resources are going to be deployed <https://deploy.equinix.com/developers/docs/metal/locations/metros/#metros-quick-reference> | `string` | n/a | yes |
+| <a name="input_metal_project_id"></a> [metal\_project\_id](#input\_metal\_project\_id) | Equinix Metal Project UUID, can be found in the General Tab of the Organization Settings <https://deploy.equinix.com/developers/docs/metal/identity-access-management/organizations/#organization-settings-and-roles> | `string` | n/a | yes |
+| <a name="input_metal_vrf_asn"></a> [metal\_vrf\_asn](#input\_metal\_vrf\_asn) | ASN to be used for Metal VRF <https://deploy.equinix.com/developers/docs/metal/networking/vrf/> | `string` | n/a | yes |
 | <a name="input_metal_vrf_cust_bgp_peer_pri"></a> [metal\_vrf\_cust\_bgp\_peer\_pri](#input\_metal\_vrf\_cust\_bgp\_peer\_pri) | IP of BGP Neighbor on Primary Interconnection that Metal VRF should expect to peer with | `string` | n/a | yes |
 | <a name="input_metal_vrf_cust_bgp_peer_sec"></a> [metal\_vrf\_cust\_bgp\_peer\_sec](#input\_metal\_vrf\_cust\_bgp\_peer\_sec) | IP of BGP Neighbor on Secondary Interconnection that Metal VRF should expect to peer with | `string` | n/a | yes |
 | <a name="input_metal_vrf_interconnection_speed"></a> [metal\_vrf\_interconnection\_speed](#input\_metal\_vrf\_interconnection\_speed) | Metal VRF interconnection speed across Fabric | `number` | n/a | yes |
@@ -62,4 +66,4 @@ No modules.
 | Name | Description |
 |------|-------------|
 | <a name="output_vrf_id"></a> [vrf\_id](#output\_vrf\_id) | ID of the Metal VRF |
-<!-- END_TF_DOCS -->
+<!-- END_TF_DOCS -->

modules/vcf_metal_device/README.md

@@ -1,3 +1,7 @@
+# Equinix Metal VCF Metal Device
+
+This module creates the VCF devices on Equinix Metal.
+
 <!-- BEGIN_TF_DOCS -->
 ## Requirements
 
@@ -41,10 +45,10 @@ No modules.
 | <a name="input_esxi_ntp_server"></a> [esxi\_ntp\_server](#input\_esxi\_ntp\_server) | NTP Server to be configured in ESXi | `string` | n/a | yes |
 | <a name="input_esxi_password"></a> [esxi\_password](#input\_esxi\_password) | mkpasswd Pre-hashed root password to be set for ESXi instances (Hash the password from vcf-ems-deployment-parameter.xlsx > Credentials Sheet > C8 using 'mkpasswd --method=SHA-512' from Linux whois package) | `string` | n/a | yes |
 | <a name="input_esxi_reservation_id"></a> [esxi\_reservation\_id](#input\_esxi\_reservation\_id) | Hardware reservation IDs to use for the VCF nodes. Each item can be a reservation UUID or `next-available`. | `string` | n/a | yes |
-| <a name="input_esxi_version_slug"></a> [esxi\_version\_slug](#input\_esxi\_version\_slug) | Slug for ESXi OS version to be deployed on Metal Instances https://github.com/equinixmetal-images/changelog/blob/main/vmware-esxi/x86_64/8.md | `string` | n/a | yes |
-| <a name="input_metal_device_plan"></a> [metal\_device\_plan](#input\_metal\_device\_plan) | Slug for target hardware plan type. The only officially supported server plan for ESXi/VCF is the 'n3.xlarge.opt-m4s2' https://deploy.equinix.com/product/servers/n3-xlarge-opt-m4s2/ | `string` | n/a | yes |
-| <a name="input_metal_metro"></a> [metal\_metro](#input\_metal\_metro) | Equinix Metal Metro where Metal resources are going to be deployed https://deploy.equinix.com/developers/docs/metal/locations/metros/#metros-quick-reference | `string` | n/a | yes |
-| <a name="input_metal_project_id"></a> [metal\_project\_id](#input\_metal\_project\_id) | Equinix Metal Project UUID, can be found in the General Tab of the Organization Settings https://deploy.equinix.com/developers/docs/metal/identity-access-management/organizations/#organization-settings-and-roles | `string` | n/a | yes |
+| <a name="input_esxi_version_slug"></a> [esxi\_version\_slug](#input\_esxi\_version\_slug) | Slug for ESXi OS version to be deployed on Metal Instances <https://github.com/equinixmetal-images/changelog/blob/main/vmware-esxi/x86_64/8.md> | `string` | n/a | yes |
+| <a name="input_metal_device_plan"></a> [metal\_device\_plan](#input\_metal\_device\_plan) | Slug for target hardware plan type. The only officially supported server plan for ESXi/VCF is the 'n3.xlarge.opt-m4s2' <https://deploy.equinix.com/product/servers/n3-xlarge-opt-m4s2/> | `string` | n/a | yes |
+| <a name="input_metal_metro"></a> [metal\_metro](#input\_metal\_metro) | Equinix Metal Metro where Metal resources are going to be deployed <https://deploy.equinix.com/developers/docs/metal/locations/metros/#metros-quick-reference> | `string` | n/a | yes |
+| <a name="input_metal_project_id"></a> [metal\_project\_id](#input\_metal\_project\_id) | Equinix Metal Project UUID, can be found in the General Tab of the Organization Settings <https://deploy.equinix.com/developers/docs/metal/identity-access-management/organizations/#organization-settings-and-roles> | `string` | n/a | yes |
 | <a name="input_vm_mgmt_vlan"></a> [vm\_mgmt\_vlan](#input\_vm\_mgmt\_vlan) | VLAN ID of VM Management VLAN for the default VM Network portgroup | `string` | n/a | yes |
 | <a name="input_metal_billing_cycle"></a> [metal\_billing\_cycle](#input\_metal\_billing\_cycle) | The billing cycle of the device ('hourly', 'daily', 'monthly', 'yearly') when in doubt, use 'hourly' | `string` | `"hourly"` | no |
 
@@ -55,4 +59,4 @@ No modules.
 | <a name="output_device_id"></a> [device\_id](#output\_device\_id) | Metal Device ID |
 | <a name="output_device_name"></a> [device\_name](#output\_device\_name) | Name of the Metal device |
 | <a name="output_vmk0_ip"></a> [vmk0\_ip](#output\_vmk0\_ip) | IP Address set on vmk0 |
-<!-- END_TF_DOCS -->
+<!-- END_TF_DOCS -->