Update docs (#26)

* Update all README.md's in project with descriptions and better doc automation * Add README.md updates to remaining examples and modules * Update root module README.md
equinix · Jan 18, 2024 · 9be2c52 · 9be2c52
1 parent ad5d499
commit 9be2c52
Show file tree

Hide file tree

Showing 35 changed files with 1,703 additions and 343 deletions.
diff --git a/.github/workflows/documentation.yaml b/.github/workflows/documentation.yaml
@@ -20,7 +20,7 @@ jobs:
         with:
           ref: main
 
-      - name: Render terraform docs inside the main and the modules README.md files and push changes back to PR branch
+      - name: Render terraform docs inside the main, modules, and examples README.md files and push changes back to PR branch
         id: terraform-docs
         uses: terraform-docs/[email protected]
         with:
@@ -50,4 +50,4 @@ jobs:
           signoff: true
           delete-branch: true
 
-      # TODO(ocobleseqx): https://github.com/peter-evans/enable-pull-request-automerge
+      # TODO(ocobleseqx): https://github.com/peter-evans/enable-pull-request-automerge
diff --git a/README.md b/README.md
@@ -5,7 +5,8 @@
 [![Terraform version](https://img.shields.io/badge/terraform-%3E%3D1.5.4-623CE4.svg?style=flat-square&logo=terraform)](https://github.com/hashicorp/terraform)
 [![Terraform registry](https://img.shields.io/badge/terraform-registry-623CE4.svg?style=flat-square&logo=terraform)](https://registry.terraform.io/modules/equinix/fabric/equinix/latest)
 
-> This is a empty module that houses multiple submodules for Equinix Fabric Terraform usage.
+> This is a empty module that houses multiple submodules for Equinix Fabric Terraform usage. Please view the Submodules
+> and the Examples in this module's registry to view details on what they are and how to leverage them.
 
 ## Equinix Fabric Developer Documentation
 

diff --git a/examples/cloud-router-2-aws-connection/README.md b/examples/cloud-router-2-aws-connection/README.md
@@ -1,3 +1,15 @@
+# Fabric Cloud Router to AWS Service Profile Connection
+
+This example shows how to leverage the [Fabric Cloud Router Connection Module](../../modules/cloud-router-connection/README.md)
+to create a Fabric Connection from a Fabric Cloud Router to AWS Service Profile.
+
+It leverages the Equinix Terraform Provider, the AWS Terraform Provider, and the Fabric Cloud Router Connection
+Module to setup the connection based on the parameters you have provided to this example; or based on the pattern
+you see used in this example it will allow you to create a more specific use case for your own needs.
+
+See example usage below for details on how to use this example.
+
+<!-- Begin Example Usage (Do not edit contents) -->
 ## Equinix Fabric Developer Documentation
 
 To see the documentation for the APIs that the Fabric Terraform Provider is built on
@@ -28,7 +40,8 @@ To use this example of the module in your own terraform configuration include th
 *NOTE: terraform.tfvars must be a separate file, but all other content can be placed together in main.tf if you prefer*
 
 terraform.tfvars (Replace these values with your own):
- ```hcl
+```hcl
+
 equinix_client_id      = "<MyEquinixClientId>"
 equinix_client_secret  = "<MyEquinixSecret>"
 
@@ -50,10 +63,10 @@ additional_info = [
   { key = "accessKey", value = "<aws_access_key>" },
   { key = "secretKey", value = "<aws_secret_key>" }
 ]
-
 ```
 versions.tf:
- ```hcl
+```hcl
+
 terraform {
   required_version = ">= 1.5.4"
   required_providers {
@@ -63,10 +76,10 @@ terraform {
     }
   }
 }
-
 ```
 variables.tf:
- ```hcl
+```hcl
+
 variable "equinix_client_id" {
   description = "Equinix client ID (consumer key), obtained after registering app in the developer platform"
   type        = string
@@ -146,17 +159,15 @@ variable "additional_info" {
   type        = list(object({ key = string, value = string }))
   default     = []
 }
-
 ```
 outputs.tf:
- ```hcl
+```hcl
+
 output "module_output" {
   value = module.cloud_router_aws_connection.primary_connection_id
 }
-
 ```
 main.tf:
-
 ```hcl
 
 provider "equinix" {
@@ -171,7 +182,7 @@ module "cloud_router_aws_connection" {
   connection_type       = var.connection_type
   notifications_type    = var.notifications_type
   notifications_emails  = var.notifications_emails
-  additional_info       = [{ key = "accessKey", value = var.aws_access_key }, { key = "secretKey", value = var.aws_secret_key }]
+  additional_info       = var.additional_info
   bandwidth             = var.bandwidth
   purchase_order_number = var.purchase_order_number
 
@@ -188,7 +199,7 @@ module "cloud_router_aws_connection" {
   zside_fabric_sp_name        = var.zside_fabric_sp_name
 }
 ```
-
+<!-- End Example Usage -->
 <!-- BEGIN_TF_DOCS -->
 ## Requirements
 
@@ -238,4 +249,4 @@ No resources.
 | Name | Description |
 |------|-------------|
 | <a name="output_module_output"></a> [module\_output](#output\_module\_output) | n/a |
-<!-- END_TF_DOCS -->
+<!-- END_TF_DOCS -->
diff --git a/examples/cloud-router-2-azure-connection/README.md b/examples/cloud-router-2-azure-connection/README.md
@@ -1,3 +1,15 @@
+# Fabric Cloud Router to Azure Service Profile Connection
+
+This example shows how to leverage the [Fabric Cloud Router Connection Module](../../modules/cloud-router-connection/README.md)
+to create a Fabric Connection from a Fabric Cloud Router to Azure Service Profile.
+
+It leverages the Equinix Terraform Provider, the Azure Terraform Provider, and the Fabric Cloud Router Connection
+Module to setup the connection based on the parameters you have provided to this example; or based on the pattern
+you see used in this example it will allow you to create a more specific use case for your own needs.
+
+See example usage below for details on how to use this example.
+
+<!-- Begin Example Usage (Do not edit contents) -->
 ## Equinix Fabric Developer Documentation
 
 To see the documentation for the APIs that the Fabric Terraform Provider is built on
@@ -28,7 +40,8 @@ To use this example of the module in your own terraform configuration include th
 *NOTE: terraform.tfvars must be a separate file, but all other content can be placed together in main.tf if you prefer*
 
 terraform.tfvars (Replace these values with your own):
- ```hcl
+```hcl
+
 equinix_client_id      = "<MyEquinixClientId>"
 equinix_client_secret  = "<MyEquinixSecret>"
 
@@ -46,23 +59,38 @@ zside_ap_profile_type           = "L2_PROFILE"
 zside_location                  = "SV"
 zside_peering_type              = "PRIVATE"
 zside_fabric_sp_name            = "Azure ExpressRoute"
-
+azure_client_id                 = "<Azure Client Id>"
+azure_client_secret             = "<Azure Client Secret Value>"
+azure_tenant_id                 = "<Azure Tenant Id>"
+azure_subscription_id           = "<Azure Subscription Id>"
+azure_location                  = "West US 2"
+azure_service_key_name          = "Test_Azure_Key"
+azure_service_provider_name     = "<Service Provider Name>"
+azure_peering_location          = "Silicon Valley Test"
+azure_tier                      = "Standard"
+azure_family                    = "UnlimitedData"
+azure_environment               = "PROD"
 ```
 versions.tf:
- ```hcl
+```hcl
+
 terraform {
   required_version = ">= 1.5.4"
   required_providers {
     equinix = {
       source  = "equinix/equinix"
       version = ">= 1.20.0"
     }
+    azurerm = {
+      source = "hashicorp/azurerm"
+      version = "3.84.0"
+    }
   }
 }
-
 ```
 variables.tf:
- ```hcl
+```hcl
+
 variable "equinix_client_id" {
   description = "Equinix client ID (consumer key), obtained after registering app in the developer platform"
   type        = string
@@ -106,12 +134,6 @@ variable "aside_fcr_uuid" {
   description = "Equinix-assigned Fabric Cloud Router identifier"
   type        = string
 }
-
-variable "zside_ap_authentication_key" {
-  description = "Authentication key for provider based connections"
-  type        = string
-  default     = ""
-}
 variable "zside_ap_type" {
   description = "Access point type - COLO, VD, VG, SP, IGW, SUBNET, GW"
   type        = string
@@ -137,32 +159,108 @@ variable "zside_fabric_sp_name" {
   type        = string
   default     = ""
 }
-
+variable "azure_client_id" {
+  description = "Azure Client id"
+  type        = string
+}
+variable "azure_client_secret" {
+  description = "Azure Secret value"
+  type        = string
+}
+variable "azure_tenant_id" {
+  description = "Azure Tenant id"
+  type        = string
+}
+variable "azure_subscription_id" {
+  description = "Azure Subscription id"
+  type        = string
+}
+variable "azure_resource_name" {
+  description = "The name of Azure Resource"
+  type        = string
+}
+variable "azure_location" {
+  description = "The Location of Azure service provider(resource)"
+  type        = string
+}
+variable "azure_service_key_name" {
+  description = "Azure Service Key Name"
+  type        = string
+}
+variable "azure_service_provider_name" {
+  description = "The name of Azure Service Provider"
+  type        = string
+  default     = ""
+}
+variable "azure_peering_location" {
+  description = "The name of the peering location (not the Azure resource location)"
+  type        = string
+  default     = ""
+}
+variable "azure_tier" {
+  description = "The Service tier. Possible values are Basic, Local, Standard or Premium"
+  type        = string
+}
+variable "azure_family" {
+  description = "The billing mode for bandwidth. Possible values are MeteredData or UnlimitedData"
+  type        = string
+}
+variable "azure_environment" {
+  description = "The Cloud environment which should be used for Service Key"
+  type        = string
+}
 ```
 outputs.tf:
- ```hcl
+```hcl
+
 output "module_output" {
   value = module.cloud_router_azure_connection.primary_connection_id
 }
-
 ```
 main.tf:
-
 ```hcl
 
 provider "equinix" {
   client_id     = var.equinix_client_id
   client_secret = var.equinix_client_secret
 }
-
+provider "azurerm" {
+  features {}
+  client_id       = var.azure_client_id
+  client_secret   = var.azure_client_secret
+  tenant_id       = var.azure_tenant_id
+  subscription_id = var.azure_subscription_id
+
+  skip_provider_registration = true
+}
+resource "azurerm_resource_group" "fcr2azure" {
+  name     = var.azure_resource_name
+  location = var.azure_location
+}
+resource "azurerm_express_route_circuit" "fcr2azure" {
+  name                  = var.azure_service_key_name
+  resource_group_name   = azurerm_resource_group.fcr2azure.name
+  location              = azurerm_resource_group.fcr2azure.location
+  service_provider_name = var.azure_service_provider_name
+  peering_location      = var.azure_peering_location
+  bandwidth_in_mbps     = var.bandwidth
+  sku {
+    tier   = var.azure_tier
+    family = var.azure_family
+  }
+  allow_classic_operations = false
+  tags = {
+    environment = var.azure_environment
+  }
+}
 module "cloud_router_azure_connection" {
   source = "equinix/fabric/equinix//modules/cloud-router-connection"
 
   connection_name       = var.connection_name
   connection_type       = var.connection_type
   notifications_type    = var.notifications_type
   notifications_emails  = var.notifications_emails
-  bandwidth             = var.bandwidth
+  bandwidth             = azurerm_express_route_circuit.fcr2azure.bandwidth_in_mbps
   purchase_order_number = var.purchase_order_number
 
   #Aside
@@ -171,14 +269,14 @@ module "cloud_router_azure_connection" {
 
   #Zside
   zside_ap_type               = var.zside_ap_type
-  zside_ap_authentication_key = var.zside_ap_authentication_key
+  zside_ap_authentication_key = azurerm_express_route_circuit.fcr2azure.service_key
   zside_ap_profile_type       = var.zside_ap_profile_type
   zside_location              = var.zside_location
   zside_peering_type          = var.zside_peering_type
   zside_fabric_sp_name        = var.zside_fabric_sp_name
 }
 ```
-
+<!-- End Example Usage -->
 <!-- BEGIN_TF_DOCS -->
 ## Requirements
 
@@ -244,4 +342,4 @@ module "cloud_router_azure_connection" {
 | Name | Description |
 |------|-------------|
 | <a name="output_module_output"></a> [module\_output](#output\_module\_output) | n/a |
-<!-- END_TF_DOCS -->
+<!-- END_TF_DOCS -->