Merge pull request #10 from equinix-labs/metal_auto_approval

updated to use always fabric billed instead of deprecated shared ports feature

Author: displague

README.md

@@ -7,17 +7,17 @@
 
 A part of Platform Equinix, your Equinix Metal™ infrastructure can connect with other parties, such as public cloud providers, network service providers, or your own colocation cages in Equinix by defining an [Equinix Fabric - software-defined interconnections](https://metal.equinix.com/developers/docs/equinix-interconnect/introduction/)
 
-Setting Up a Shared Port requires requesting the connection on the Equinix Metal side, retrieving a token and using that token to request a connection on the Equinix Fabric side. This module is intended to abstract you from this process and handle the connection as a single resource.
+Setting Up a [Fabric Billed Fabric Virtual Connections](https://deploy.equinix.com/developers/docs/metal/interconnections/fabric-billed-fabric-vc/) requires requesting the connection on the Equinix Metal side, retrieving a token and using that token to request a connection on the Equinix Fabric side. This module is intended to abstract you from this process and handle the connection as a single resource.
 
 ```html
-  Origin                                             Destination
+  Origin                                            Destination
   (A-side)                                           (Z-side)
 
-┌────────────────┐                                 ┌───────────────┐
-│ Equinix Fabric │      Equinix Metal              │ Equinix Metal │
-│ Port / Network ├───── Shared connection  ───────►│ Shared Port   │
-│ Edge Device /  │     (50 Mbps - 10 Gbps)         └───────────────┘
-│ Service Token  │
+┌────────────────┐                               ┌───────────────┐
+│ Equinix Fabric │       Equinix Metal           │ Equinix Metal │
+│ Port / Network ├─────  Fabric Billed   ───────►│     Port      │
+│ Edge Device /  │     Virtual Connection        └───────────────┘
+│ Service Token  │     (50 Mbps - 10 Gbps)
 └────────────────┘
 ```
 
@@ -74,6 +74,5 @@ See <https://registry.terraform.io/modules/equinix-labs/fabric-connection-metal/
 ### Examples
 
 - [Fabric Port connection](https://registry.terraform.io/modules/equinix-labs/fabric-connection-metal/equinix/latest/examples/fabric-port-connection/)
-- [Fabric Port connection wiht Metal z-side service token](https://registry.terraform.io/modules/equinix-labs/fabric-connection-metal/equinix/latest/examples/fabric-port-connection-with-zside-token/)
 - [Network Edge device redundant connection](https://registry.terraform.io/modules/equinix-labs/fabric-connection-metal/equinix/latest/examples/network-edge-device-redundant-connection/)
 - [Fabric a-side Service Token redundant connection](https://registry.terraform.io/modules/equinix-labs/fabric-connection-metal/equinix/latest/examples/service-token-redundant-connection)

examples/fabric-port-connection-with-zside-token/README.md

@@ -9,8 +9,7 @@ module "equinix-fabric-connection-metal" {
   # required variables
   fabric_notification_users     = ["example@equinix.com"]
   fabric_destination_metro_code = "DA" // corresponds to Dallas
-
-  metal_project_name = var.metal_project_name
+  metal_project_name            = var.metal_project_name
 
   # optional variables
   redundancy_type                  = "REDUNDANT"

examples/fabric-port-connection-with-zside-token/main.tf

@@ -1,6 +1,8 @@
 locals {
   metal_connection_name = coalesce(var.metal_connection_name, lower(format("shared-conn-%s-%s", var.fabric_destination_metro_code, random_string.this.result)))
   fabric_primary_name   = var.fabric_connection_name != "" ? var.fabric_connection_name : upper(format("METAL-%s-%s", var.fabric_destination_metro_code, random_string.this.result))
+  fabric_secondary_name = var.fabric_secondary_connection_name != "" ? var.fabric_secondary_connection_name : format("%s-SEC", local.fabric_primary_name)
+  network_edge_secondary_device_id = var.network_edge_secondary_device_id != "" ? var.network_edge_secondary_device_id : var.network_edge_device_id
 }
 
 data "equinix_metal_project" "this" {
@@ -23,58 +25,29 @@ resource "equinix_metal_connection" "this" {
   tags               = var.metal_connection_tags
   speed              = format("%dMbps", var.fabric_speed)
   vlans              = var.metal_connection_vlans
-  service_token_type = var.service_token_automation_feature_preview ? "z_side" : null
+  service_token_type = "z_side"
 }
 
 module "equinix-fabric-connection" {
+  count   = var.redundancy_type == "REDUNDANT" ? 2 : 1
   source  = "equinix-labs/fabric-connection/equinix"
-  version = "0.3.1"
+  version = "0.4.0"
 
   # required variables
   notification_users = var.fabric_notification_users
 
   # optional variables
-  name                      = local.fabric_primary_name
-  network_edge_id           = var.network_edge_device_id
-  network_edge_interface_id = var.network_edge_device_interface_id
-  port_name                 = var.fabric_port_name
-  vlan_stag                 = var.fabric_vlan_stag
-  service_token_id          = var.fabric_service_token_id
-  speed                     = var.fabric_speed
-  speed_unit                = "MB"
-  purchase_order_number     = var.fabric_purchase_order_number
-
-  zside_service_token_id   = var.service_token_automation_feature_preview ? equinix_metal_connection.this.service_tokens.0.id : null
-  seller_profile_name      = var.service_token_automation_feature_preview ? "" : var.redundancy_type == "SINGLE" ? "Equinix Metal - Layer 2" : "Equinix Metal - Layer 2 - Redundant"
-  seller_authorization_key = var.service_token_automation_feature_preview ? "" : equinix_metal_connection.this.token
-  seller_metro_code        = var.service_token_automation_feature_preview ? "" : var.fabric_destination_metro_code
-
-  redundancy_type                     = var.service_token_automation_feature_preview ? "SINGLE" : var.redundancy_type
-  secondary_name                      = var.service_token_automation_feature_preview ? "" : var.fabric_secondary_connection_name
-  secondary_port_name                 = var.service_token_automation_feature_preview ? "" : var.fabric_secondary_port_name
-  secondary_vlan_stag                 = var.service_token_automation_feature_preview ? 0 : var.fabric_secondary_vlan_stag
-  secondary_service_token_id          = var.service_token_automation_feature_preview ? "" : var.fabric_secondary_service_token_id
-  network_edge_secondary_id           = var.service_token_automation_feature_preview ? "" : var.network_edge_secondary_device_id
-  network_edge_secondary_interface_id = var.service_token_automation_feature_preview ? 0 : var.network_edge_secondary_device_interface_id
-}
+  name = count.index == 0 ? local.fabric_primary_name : local.fabric_secondary_name
 
-module "equinix-fabric-connection-sec" {
-  count   = var.service_token_automation_feature_preview && var.redundancy_type == "REDUNDANT" ? 1 : 0
-  source  = "equinix-labs/fabric-connection/equinix"
-  version = "0.4.0"
+  network_edge_id           = count.index == 0 ? var.network_edge_device_id : local.network_edge_secondary_device_id
+  network_edge_interface_id = count.index == 0 ? var.network_edge_device_interface_id : var.network_edge_secondary_device_interface_id
 
-  # required variables
-  notification_users = var.fabric_notification_users
-
-  # optional variables
-  name                  = var.fabric_secondary_connection_name != "" ? var.fabric_secondary_connection_name : format("%s-SEC", local.fabric_primary_name)
-  port_name             = var.fabric_secondary_port_name != "" ? var.fabric_secondary_port_name : var.fabric_port_name
-  vlan_stag             = var.fabric_secondary_vlan_stag
-  speed                 = var.fabric_speed
+  port_name             = count.index == 0 ? var.fabric_port_name : var.fabric_secondary_port_name != "" ? var.fabric_secondary_port_name : var.fabric_port_name
+  vlan_stag             = count.index == 0 ? var.fabric_vlan_stag : var.fabric_secondary_vlan_stag
+  service_token_id      = count.index == 0 ? var.fabric_service_token_id : var.fabric_secondary_service_token_id
+  speed                 = count.index == 0 ? var.fabric_speed : var.fabric_secondary_speed != 0 ? var.fabric_secondary_speed : var.fabric_speed
   speed_unit            = "MB"
   purchase_order_number = var.fabric_purchase_order_number
 
-  zside_service_token_id = equinix_metal_connection.this.service_tokens.1.id
-
-  redundancy_type = "SINGLE"
+  zside_service_token_id = equinix_metal_connection.this.service_tokens[count.index].id
 }

examples/fabric-port-connection-with-zside-token/outputs.tf

@@ -1,60 +1,51 @@
 output "fabric_connection_primary_uuid" {
   description = "Unique identifier of the connection."
-  value       = module.equinix-fabric-connection.primary_connection.uuid
+  value       = module.equinix-fabric-connection.0.primary_connection.uuid
 }
 
 output "fabric_connection_primary_name" {
   description = "Name of the connection."
-  value       = module.equinix-fabric-connection.primary_connection.name
+  value       = module.equinix-fabric-connection.0.primary_connection.name
 }
 
 output "fabric_connection_primary_status" {
   description = "Connection provisioning status."
-  value       = module.equinix-fabric-connection.primary_connection.status
+  value       = module.equinix-fabric-connection.0.primary_connection.status
 }
 
 output "fabric_connection_primary_provider_status" {
   description = "Connection provisioning provider status."
-  value       = module.equinix-fabric-connection.primary_connection.provider_status
+  value       = module.equinix-fabric-connection.0.primary_connection.provider_status
 }
 
 output "fabric_connection_primary_speed" {
   description = "Connection speed."
-  value       = module.equinix-fabric-connection.primary_connection.speed
+  value       = module.equinix-fabric-connection.0.primary_connection.speed
 }
 
 output "fabric_connection_primary_speed_unit" {
   description = "Connection speed unit."
-  value       = module.equinix-fabric-connection.primary_connection.speed_unit
-}
-
-output "fabric_connection_primary_seller_metro" {
-  description = "Connection seller metro code."
-  value       = module.equinix-fabric-connection.primary_connection.seller_metro_code
+  value       = module.equinix-fabric-connection.0.primary_connection.speed_unit
 }
 
 output "fabric_connection_secondary_uuid" {
   description = "Unique identifier of the secondary connection."
-  value = module.equinix-fabric-connection.secondary_connection != null ? module.equinix-fabric-connection.secondary_connection.uuid : (
-  var.service_token_automation_feature_preview && var.redundancy_type == "REDUNDANT") ? module.equinix-fabric-connection-sec.primary_connection.uuid : null
+  value = var.redundancy_type == "REDUNDANT" ? module.equinix-fabric-connection.1.primary_connection.uuid : null
 }
 
 output "fabric_connection_secondary_name" {
   description = "Name of the secondary connection."
-  value = module.equinix-fabric-connection.secondary_connection != null ? module.equinix-fabric-connection.secondary_connection.name : (
-  var.service_token_automation_feature_preview && var.redundancy_type == "REDUNDANT") ? module.equinix-fabric-connection-sec.primary_connection.name : null
+  value = var.redundancy_type == "REDUNDANT" ? module.equinix-fabric-connection.1.primary_connection.name : null
 }
 
 output "fabric_connection_secondary_status" {
   description = "Secondary connection provisioning status."
-  value = module.equinix-fabric-connection.secondary_connection != null ? module.equinix-fabric-connection.secondary_connection.status : (
-  var.service_token_automation_feature_preview && var.redundancy_type == "REDUNDANT") ? module.equinix-fabric-connection-sec.primary_connection.status : null
+  value = var.redundancy_type == "REDUNDANT" ? module.equinix-fabric-connection.1.primary_connection.status : null
 }
 
 output "fabric_connection_secondary_provider_status" {
   description = "Secondary connection provisioning provider status."
-  value = module.equinix-fabric-connection.secondary_connection != null ? module.equinix-fabric-connection.secondary_connection.provider_status : (
-  var.service_token_automation_feature_preview && var.redundancy_type == "REDUNDANT") ? module.equinix-fabric-connection-sec.primary_connection.provider_status : null
+  value = var.redundancy_type == "REDUNDANT" ? module.equinix-fabric-connection.1.primary_connection.provider_status : null
 }
 
 output "equinix_metal_connection_uuid" {

examples/fabric-port-connection-with-zside-token/variables.tf

@@ -16,7 +16,7 @@ variable "fabric_connection_name" {
 
 variable "fabric_destination_metro_code" {
   type        = string
-  description = "Destination Metro code where the connection will be created."
+  description = "Destination Metal Metro code where the connection will be created."
 
   validation {
     condition     = can(regex("^[A-Z]{2}$", var.fabric_destination_metro_code))
@@ -79,6 +79,18 @@ variable "fabric_speed" {
   }
 }
 
+variable "fabric_secondary_speed" {
+  type        = number
+  description = <<EOF
+  Speed/Bandwidth in Mbps to be allocated to the connection. If unspecified, it will be used the primary connection fabric speed.
+  EOF
+  default     = 0
+  validation {
+    condition     = contains([0, 50, 100, 200, 500, 1000, 2000, 5000, 10000], var.fabric_secondary_speed)
+    error_message = "Valid values are (0, 50, 100, 200, 500, 1000, 2000, 5000, 10000)."
+  }
+}
+
 variable "fabric_purchase_order_number" {
   type        = string
   description = "Connection's purchase order number to reflect on the invoice."
@@ -194,14 +206,3 @@ variable "metal_connection_vlans" {
     error_message = "Max. number of vlans is two (one per connection, primary and secondary)"
   }
 }
-
-variable "service_token_automation_feature_preview" {
-  type        = bool
-  description = <<EOF
-  If true it will use automated service token type z_side. NOTE: Equinix Metal connection with service_token_type
-  z_side/a_side is not generally available and may not be enabled yet for your organization. This new feature will
-  provision the connection automatically after creation, but it is not compatible (July, 2022) with
-  'fabric_service_token_id' or 'network_edge_device_id'.
-  EOF
-  default     = false
-}