generate-terraform-docs: automated action (#152)

Signed-off-by: GitHub <[email protected]> Co-authored-by: thogarty <[email protected]> Co-authored-by: thogarty <[email protected]>
equinix · Nov 1, 2024 · c4f52c8 · c4f52c8
1 parent 2bc6b5b
commit c4f52c8
Show file tree

Hide file tree

Showing 46 changed files with 860 additions and 156 deletions.
diff --git a/examples/cloud-router-2-aws-connection/README.md b/examples/cloud-router-2-aws-connection/README.md
@@ -208,8 +208,9 @@ variable "aws_gateway_asn" {
 
 outputs.tf
 ```hcl
-output "aws_connection_id" {
-  value = module.cloud_router_aws_connection.primary_connection_id
+output "aws_connection" {
+  value = module.cloud_router_aws_connection.primary_connection
+  sensitive = true
 }
 output "aws_dx_gateway_id" {
   value = aws_dx_gateway.aws_gateway.id
@@ -348,7 +349,7 @@ resource "aws_dx_private_virtual_interface" "aws_virtual_interface" {
 
 | Name | Description |
 |------|-------------|
-| <a name="output_aws_connection_id"></a> [aws\_connection\_id](#output\_aws\_connection\_id) | n/a |
+| <a name="output_aws_connection"></a> [aws\_connection](#output\_aws\_connection) | n/a |
 | <a name="output_aws_dx_gateway_id"></a> [aws\_dx\_gateway\_id](#output\_aws\_dx\_gateway\_id) | n/a |
 | <a name="output_aws_interface_id"></a> [aws\_interface\_id](#output\_aws\_interface\_id) | n/a |
 <!-- END_TF_DOCS -->
diff --git a/examples/cloud-router-2-azure-connection/README.md b/examples/cloud-router-2-azure-connection/README.md
@@ -219,8 +219,9 @@ output "azurerm_resource_group_id" {
 output "azurerm_express_route_circuit" {
   value = azurerm_express_route_circuit.fcr2azure.id
 }
-output "azure_connection_id" {
-  value = module.cloud_router_azure_connection.primary_connection_id
+output "azure_connection" {
+  value = module.cloud_router_azure_connection.primary_connection
+  sensitive = true
 }
 ```
 
@@ -344,7 +345,7 @@ module "cloud_router_azure_connection" {
 
 | Name | Description |
 |------|-------------|
-| <a name="output_azure_connection_id"></a> [azure\_connection\_id](#output\_azure\_connection\_id) | n/a |
+| <a name="output_azure_connection"></a> [azure\_connection](#output\_azure\_connection) | n/a |
 | <a name="output_azurerm_express_route_circuit"></a> [azurerm\_express\_route\_circuit](#output\_azurerm\_express\_route\_circuit) | n/a |
 | <a name="output_azurerm_resource_group_id"></a> [azurerm\_resource\_group\_id](#output\_azurerm\_resource\_group\_id) | n/a |
 <!-- END_TF_DOCS -->
diff --git a/examples/cloud-router-2-azure-redundant-connection/README.md b/examples/cloud-router-2-azure-redundant-connection/README.md
@@ -240,11 +240,13 @@ output "azurerm_resource_group_id" {
 output "azurerm_express_route_circuit" {
   value = azurerm_express_route_circuit.fcr2azure.id
 }
-output "azure_primary_connection_id" {
-  value = module.cloud_router_azure_redundant_connection.primary_connection_id
+output "azure_primary_connection" {
+  value = module.cloud_router_azure_redundant_connection.primary_connection
+  sensitive = true
 }
-output "azure_secondary_connection_id" {
-  value = var.secondary_connection_name != "" ? module.cloud_router_azure_redundant_connection.secondary_connection_id : null
+output "azure_secondary_connection" {
+  value = module.cloud_router_azure_redundant_connection.secondary_connection
+  sensitive = true
 }
 ```
 
@@ -377,8 +379,8 @@ module "cloud_router_azure_redundant_connection" {
 
 | Name | Description |
 |------|-------------|
-| <a name="output_azure_primary_connection_id"></a> [azure\_primary\_connection\_id](#output\_azure\_primary\_connection\_id) | n/a |
-| <a name="output_azure_secondary_connection_id"></a> [azure\_secondary\_connection\_id](#output\_azure\_secondary\_connection\_id) | n/a |
+| <a name="output_azure_primary_connection"></a> [azure\_primary\_connection](#output\_azure\_primary\_connection) | n/a |
+| <a name="output_azure_secondary_connection"></a> [azure\_secondary\_connection](#output\_azure\_secondary\_connection) | n/a |
 | <a name="output_azurerm_express_route_circuit"></a> [azurerm\_express\_route\_circuit](#output\_azurerm\_express\_route\_circuit) | n/a |
 | <a name="output_azurerm_resource_group_id"></a> [azurerm\_resource\_group\_id](#output\_azurerm\_resource\_group\_id) | n/a |
 <!-- END_TF_DOCS -->
diff --git a/examples/cloud-router-2-google-connection/README.md b/examples/cloud-router-2-google-connection/README.md
@@ -216,8 +216,9 @@ output "GCP_Router_Id" {
 output "GCP_Interconnect_Id" {
   value = google_compute_interconnect_attachment.cloud-router-google.id
 }
-output "Google_Connection_Id" {
-  value = module.cloud_router_google_connection.primary_connection_id
+output "Google_Connection" {
+  value = module.cloud_router_google_connection.primary_connection
+  sensitive = true
 }
 ```
 
@@ -346,5 +347,5 @@ module "cloud_router_google_connection" {
 | <a name="output_GCP_Interconnect_Id"></a> [GCP\_Interconnect\_Id](#output\_GCP\_Interconnect\_Id) | n/a |
 | <a name="output_GCP_Network_Id"></a> [GCP\_Network\_Id](#output\_GCP\_Network\_Id) | n/a |
 | <a name="output_GCP_Router_Id"></a> [GCP\_Router\_Id](#output\_GCP\_Router\_Id) | n/a |
-| <a name="output_Google_Connection_Id"></a> [Google\_Connection\_Id](#output\_Google\_Connection\_Id) | n/a |
+| <a name="output_Google_Connection"></a> [Google\_Connection](#output\_Google\_Connection) | n/a |
 <!-- END_TF_DOCS -->
diff --git a/examples/cloud-router-2-metal-nimf-connection/README.md b/examples/cloud-router-2-metal-nimf-connection/README.md
@@ -183,11 +183,13 @@ output "metal_vlan_id" {
 output "metal_connection_id" {
   value = equinix_metal_connection.metal-connection.id
 }
-output "cloud_router_metal_connection_id" {
-  value = module.cloud_router_2_metal_connection.primary_connection_id
+output "cloud_router_metal_connection" {
+  value = module.cloud_router_2_metal_connection.primary_connection
+  sensitive = true
 }
-output "cloud_router_routing_protocol_id" {
-  value = module.routing_protocols.direct_routing_protocol_id
+output "cloud_router_routing_protocol" {
+  value = module.routing_protocols.direct_routing_protocol
+  sensitive = true
 }
 output "metal_connection_status" {
   value = data.equinix_metal_connection.NIMF-test.status
@@ -317,8 +319,8 @@ data "equinix_metal_connection" "NIMF-test" {
 
 | Name | Description |
 |------|-------------|
-| <a name="output_cloud_router_metal_connection_id"></a> [cloud\_router\_metal\_connection\_id](#output\_cloud\_router\_metal\_connection\_id) | n/a |
-| <a name="output_cloud_router_routing_protocol_id"></a> [cloud\_router\_routing\_protocol\_id](#output\_cloud\_router\_routing\_protocol\_id) | n/a |
+| <a name="output_cloud_router_metal_connection"></a> [cloud\_router\_metal\_connection](#output\_cloud\_router\_metal\_connection) | n/a |
+| <a name="output_cloud_router_routing_protocol"></a> [cloud\_router\_routing\_protocol](#output\_cloud\_router\_routing\_protocol) | n/a |
 | <a name="output_metal_connection_id"></a> [metal\_connection\_id](#output\_metal\_connection\_id) | n/a |
 | <a name="output_metal_connection_status"></a> [metal\_connection\_status](#output\_metal\_connection\_status) | n/a |
 | <a name="output_metal_vlan_id"></a> [metal\_vlan\_id](#output\_metal\_vlan\_id) | n/a |

diff --git a/examples/cloud-router-2-metal-nimf-redundant-connection/README.md b/examples/cloud-router-2-metal-nimf-redundant-connection/README.md
@@ -204,13 +204,16 @@ output "metal_connection_id" {
   value = equinix_metal_connection.metal-connection.id
 }
 output "cloud_router_metal_primary_connection_id" {
-  value = module.cloud_router_2_metal_connection.primary_connection_id
+  value = module.cloud_router_2_metal_connection.primary_connection
+  sensitive = true
 }
 output "primary_connection_cloud_router_routing_protocol_id" {
-  value = module.primary_connection_routing_protocols.direct_routing_protocol_id
+  value = module.primary_connection_routing_protocols.direct_routing_protocol
+  sensitive = true
 }
 output "secondary_connection_cloud_router_routing_protocol_id" {
-  value = module.secondary_connection_routing_protocols.direct_routing_protocol_id
+  value = module.secondary_connection_routing_protocols.direct_routing_protocol
+  sensitive = true
 }
 ```
 

diff --git a/examples/cloud-router-2-oracle-connection/README.md b/examples/cloud-router-2-oracle-connection/README.md
@@ -226,8 +226,9 @@ variable "oracle_gateway_id" {
 
 outputs.tf
 ```hcl
-output "oracle_connection_id" {
-  value = module.cloud_router_oracle_connection.primary_connection_id
+output "oracle_connection" {
+  value = module.cloud_router_oracle_connection.primary_connection
+  sensitive = true
 }
 ```
 
@@ -364,5 +365,5 @@ module "cloud_router_oracle_connection" {
 
 | Name | Description |
 |------|-------------|
-| <a name="output_oracle_connection_id"></a> [oracle\_connection\_id](#output\_oracle\_connection\_id) | n/a |
+| <a name="output_oracle_connection"></a> [oracle\_connection](#output\_oracle\_connection) | n/a |
 <!-- END_TF_DOCS -->
diff --git a/examples/cloud-router-2-port-connection-with-route-filters/README.md b/examples/cloud-router-2-port-connection-with-route-filters/README.md
@@ -247,8 +247,9 @@ variable "routing_protocol_bgp_customer_asn" {
 
 outputs.tf
 ```hcl
-output "port_connection_id" {
-  value = module.cloud_router_port_connection.primary_connection_id
+output "port_connection" {
+  value = module.cloud_router_port_connection.primary_connection
+  sensitive = true
 }
 ```
 
@@ -391,5 +392,5 @@ module "cloud_router_route_filters" {
 
 | Name | Description |
 |------|-------------|
-| <a name="output_port_connection_id"></a> [port\_connection\_id](#output\_port\_connection\_id) | n/a |
+| <a name="output_port_connection"></a> [port\_connection](#output\_port\_connection) | n/a |
 <!-- END_TF_DOCS -->
diff --git a/examples/cloud-router-2-port-connection/README.md b/examples/cloud-router-2-port-connection/README.md
@@ -135,8 +135,9 @@ variable "zside_location" {
 
 outputs.tf
 ```hcl
-output "port_connection_id" {
-  value = module.cloud_router_port_connection.primary_connection_id
+output "port_connection" {
+  value = module.cloud_router_port_connection.primary_connection
+  sensitive = true
 }
 ```
 
@@ -211,5 +212,5 @@ No resources.
 
 | Name | Description |
 |------|-------------|
-| <a name="output_port_connection_id"></a> [port\_connection\_id](#output\_port\_connection\_id) | n/a |
+| <a name="output_port_connection"></a> [port\_connection](#output\_port\_connection) | n/a |
 <!-- END_TF_DOCS -->
diff --git a/examples/cloud-router-2-service-profile-connection/README.md b/examples/cloud-router-2-service-profile-connection/README.md
@@ -137,8 +137,9 @@ variable "zside_fabric_sp_name" {
 
 outputs.tf
 ```hcl
-output "service_profile_connection_id" {
-  value = module.cloud_router_sp_connection.primary_connection_id
+output "service_profile_connection" {
+  value = module.cloud_router_sp_connection.primary_connection
+  sensitive = true
 }
 ```
 
@@ -213,5 +214,5 @@ No resources.
 
 | Name | Description |
 |------|-------------|
-| <a name="output_service_profile_connection_id"></a> [service\_profile\_connection\_id](#output\_service\_profile\_connection\_id) | n/a |
+| <a name="output_service_profile_connection"></a> [service\_profile\_connection](#output\_service\_profile\_connection) | n/a |
 <!-- END_TF_DOCS -->
diff --git a/examples/cloud-router-2-virtual-device-connection/README.md b/examples/cloud-router-2-virtual-device-connection/README.md
@@ -143,7 +143,8 @@ variable "zside_interface_id" {
 outputs.tf
 ```hcl
 output "FCR_VD_Connection" {
-  value = module.cloud_router_virtual_device_connection.primary_connection_id
+  value = module.cloud_router_virtual_device_connection.primary_connection
+  sensitive = true
 }
 ```
 

diff --git a/examples/cloud-router-2-virtual-device-redundant-connection/README.md b/examples/cloud-router-2-virtual-device-redundant-connection/README.md
@@ -171,10 +171,12 @@ variable "zside_sec_interface_id" {
 outputs.tf
 ```hcl
 output "FCR_VD_Primary_Connection" {
-  value = module.cloud_router_virtual_device_redundant_connection.primary_connection_id
+  value = module.cloud_router_virtual_device_redundant_connection.primary_connection
+  sensitive = true
 }
 output "FCR_VD_Secondary_Connection" {
-  value = module.cloud_router_virtual_device_redundant_connection.secondary_connection_id
+  value = module.cloud_router_virtual_device_redundant_connection.secondary_connection
+  sensitive = true
 }
 
 ```

diff --git a/examples/cloud-router-2-wan-connection/README.md b/examples/cloud-router-2-wan-connection/README.md
@@ -124,8 +124,9 @@ variable "zside_network_uuid" {
 
 outputs.tf
 ```hcl
-output "wan_connection_id" {
-  value = module.cloud_router_wan_connection.primary_connection_id
+output "wan_connection" {
+  value = module.cloud_router_wan_connection.primary_connection
+  sensitive = true
 }
 ```
 
@@ -196,5 +197,5 @@ No resources.
 
 | Name | Description |
 |------|-------------|
-| <a name="output_wan_connection_id"></a> [wan\_connection\_id](#output\_wan\_connection\_id) | n/a |
+| <a name="output_wan_connection"></a> [wan\_connection](#output\_wan\_connection) | n/a |
 <!-- END_TF_DOCS -->
diff --git a/examples/cloud-router-marketplace-susbscription/README.md b/examples/cloud-router-marketplace-susbscription/README.md
@@ -126,8 +126,9 @@ variable "marketplace_subscription_uuid" {
 
 outputs.tf
 ```hcl
-output "cloud_router_id" {
-  value = equinix_fabric_cloud_router.create_fcr_marketplace_subscription.id
+output "cloud_router" {
+  value = equinix_fabric_cloud_router.create_fcr_marketplace_subscription
+  sensitive = true
 }
 ```
 
@@ -221,5 +222,5 @@ No modules.
 
 | Name | Description |
 |------|-------------|
-| <a name="output_cloud_router_id"></a> [cloud\_router\_id](#output\_cloud\_router\_id) | n/a |
+| <a name="output_cloud_router"></a> [cloud\_router](#output\_cloud\_router) | n/a |
 <!-- END_TF_DOCS -->
diff --git a/examples/cloud-router-routing-protocols/README.md b/examples/cloud-router-routing-protocols/README.md
@@ -135,12 +135,14 @@ variable "bgp_customer_asn" {
 
 outputs.tf
 ```hcl
-output "direct_rp_id" {
-  value = module.routing_protocols.direct_routing_protocol_id
+output "direct_rp" {
+  value = module.routing_protocols.direct_routing_protocol
+  sensitive = true
 }
 
 output "bgp_rp_id" {
-  value = module.routing_protocols.bgp_routing_protocol_id
+  value = module.routing_protocols.bgp_routing_protocol
+  sensitive = true
 }
 ```
 
@@ -214,5 +216,5 @@ No resources.
 | Name | Description |
 |------|-------------|
 | <a name="output_bgp_rp_id"></a> [bgp\_rp\_id](#output\_bgp\_rp\_id) | n/a |
-| <a name="output_direct_rp_id"></a> [direct\_rp\_id](#output\_direct\_rp\_id) | n/a |
+| <a name="output_direct_rp"></a> [direct\_rp](#output\_direct\_rp) | n/a |
 <!-- END_TF_DOCS -->
diff --git a/examples/metal-nimf-2-aws-connection/README.md b/examples/metal-nimf-2-aws-connection/README.md
@@ -250,8 +250,9 @@ output "metal_vlan_id" {
 output "metal_connection_id" {
   value = equinix_metal_connection.metal-connection.id
 }
-output "metal_aws_connection_id" {
-  value = module.metal_2_aws_connection.primary_connection_id
+output "metal_aws_connection" {
+  value = module.metal_2_aws_connection.primary_connection
+  sensitive = true
 }
 output "aws_dx_gateway_id" {
   value = aws_dx_gateway.aws_gateway.id
@@ -433,7 +434,7 @@ data "equinix_metal_connection" "NIMF-test" {
 |------|-------------|
 | <a name="output_aws_dx_gateway_id"></a> [aws\_dx\_gateway\_id](#output\_aws\_dx\_gateway\_id) | n/a |
 | <a name="output_aws_interface_id"></a> [aws\_interface\_id](#output\_aws\_interface\_id) | n/a |
-| <a name="output_metal_aws_connection_id"></a> [metal\_aws\_connection\_id](#output\_metal\_aws\_connection\_id) | n/a |
+| <a name="output_metal_aws_connection"></a> [metal\_aws\_connection](#output\_metal\_aws\_connection) | n/a |
 | <a name="output_metal_connection_id"></a> [metal\_connection\_id](#output\_metal\_connection\_id) | n/a |
 | <a name="output_metal_connection_status"></a> [metal\_connection\_status](#output\_metal\_connection\_status) | n/a |
 | <a name="output_metal_vlan_id"></a> [metal\_vlan\_id](#output\_metal\_vlan\_id) | n/a |

diff --git a/examples/metal-nimf-2-azure-connection/README.md b/examples/metal-nimf-2-azure-connection/README.md
@@ -262,8 +262,9 @@ output "azurerm_resource_group_id" {
 output "azurerm_express_route_circuit" {
   value = azurerm_express_route_circuit.metal2azure.id
 }
-output "metal_azure_connection_id" {
-  value = module.metal_2_azure_connection.primary_connection_id
+output "metal_azure_connection" {
+  value = module.metal_2_azure_connection.primary_connection
+  sensitive = true
 }
 output "metal_connection_status" {
   value = data.equinix_metal_connection.NIMF-test.status
@@ -431,7 +432,7 @@ data "equinix_metal_connection" "NIMF-test" {
 |------|-------------|
 | <a name="output_azurerm_express_route_circuit"></a> [azurerm\_express\_route\_circuit](#output\_azurerm\_express\_route\_circuit) | n/a |
 | <a name="output_azurerm_resource_group_id"></a> [azurerm\_resource\_group\_id](#output\_azurerm\_resource\_group\_id) | n/a |
-| <a name="output_metal_azure_connection_id"></a> [metal\_azure\_connection\_id](#output\_metal\_azure\_connection\_id) | n/a |
+| <a name="output_metal_azure_connection"></a> [metal\_azure\_connection](#output\_metal\_azure\_connection) | n/a |
 | <a name="output_metal_connection_id"></a> [metal\_connection\_id](#output\_metal\_connection\_id) | n/a |
 | <a name="output_metal_connection_status"></a> [metal\_connection\_status](#output\_metal\_connection\_status) | n/a |
 | <a name="output_metal_vlan_id"></a> [metal\_vlan\_id](#output\_metal\_vlan\_id) | n/a |

diff --git a/examples/metal-nimf-2-google-connection/README.md b/examples/metal-nimf-2-google-connection/README.md
@@ -258,8 +258,9 @@ output "GCP_Router_Id" {
 output "GCP_Interconnect_Id" {
   value = google_compute_interconnect_attachment.metal-nimf-google.id
 }
-output "Metal_Google_Connection_Id" {
-  value = module.metal_2_google_connection.primary_connection_id
+output "Metal_Google_Connection" {
+  value = module.metal_2_google_connection.primary_connection
+  sensitive = true
 }
 output "metal_connection_status" {
   value = data.equinix_metal_connection.NIMF-test.status
@@ -433,7 +434,7 @@ data "equinix_metal_connection" "NIMF-test" {
 | <a name="output_GCP_Interconnect_Id"></a> [GCP\_Interconnect\_Id](#output\_GCP\_Interconnect\_Id) | n/a |
 | <a name="output_GCP_Network_Id"></a> [GCP\_Network\_Id](#output\_GCP\_Network\_Id) | n/a |
 | <a name="output_GCP_Router_Id"></a> [GCP\_Router\_Id](#output\_GCP\_Router\_Id) | n/a |
-| <a name="output_Metal_Google_Connection_Id"></a> [Metal\_Google\_Connection\_Id](#output\_Metal\_Google\_Connection\_Id) | n/a |
+| <a name="output_Metal_Google_Connection"></a> [Metal\_Google\_Connection](#output\_Metal\_Google\_Connection) | n/a |
 | <a name="output_metal_connection_id"></a> [metal\_connection\_id](#output\_metal\_connection\_id) | n/a |
 | <a name="output_metal_connection_status"></a> [metal\_connection\_status](#output\_metal\_connection\_status) | n/a |
 | <a name="output_metal_vlan_id"></a> [metal\_vlan\_id](#output\_metal\_vlan\_id) | n/a |

diff --git a/examples/metal-nimf-2-ibm2-connection/README.md b/examples/metal-nimf-2-ibm2-connection/README.md
@@ -242,8 +242,9 @@ output "metal_vlan_id" {
 output "metal_connection_id" {
   value = equinix_metal_connection.metal-connection.id
 }
-output "Metal_IBM2_Connection_Id" {
-  value = module.metal_2_ibm2_connection.primary_connection_id
+output "Metal_IBM2_Connection" {
+  value = module.metal_2_ibm2_connection.primary_connection
+  sensitive = true
 }
 output "IBM_Gateway_Action_Id" {
   value = ibm_dl_gateway_action.test_dl_gateway_action.id
@@ -411,7 +412,7 @@ data "equinix_metal_connection" "NIMF-test" {
 | Name | Description |
 |------|-------------|
 | <a name="output_IBM_Gateway_Action_Id"></a> [IBM\_Gateway\_Action\_Id](#output\_IBM\_Gateway\_Action\_Id) | n/a |
-| <a name="output_Metal_IBM2_Connection_Id"></a> [Metal\_IBM2\_Connection\_Id](#output\_Metal\_IBM2\_Connection\_Id) | n/a |
+| <a name="output_Metal_IBM2_Connection"></a> [Metal\_IBM2\_Connection](#output\_Metal\_IBM2\_Connection) | n/a |
 | <a name="output_metal_connection_id"></a> [metal\_connection\_id](#output\_metal\_connection\_id) | n/a |
 | <a name="output_metal_connection_status"></a> [metal\_connection\_status](#output\_metal\_connection\_status) | n/a |
 | <a name="output_metal_vlan_id"></a> [metal\_vlan\_id](#output\_metal\_vlan\_id) | n/a |