initial version

Author: Oscar Cobles

CHANGELOG.md

@@ -0,0 +1,10 @@
+## 0.1.0 (April 18, 2022)
+
+NOTES:
+
+Initial release.
+
+FEATURES:
+
+- Supported single connections from Equinix Fabric Port, Network Edge Device, Equinix Service Token
+to service profiles `Equinix Metal - Layer 2` and `Equinix Metal - Layer 2 - Redundant`.

CODEOWNERS

@@ -1 +1,3 @@
-* @equinix-labs/terraform-metal-shared-connection ocobleseqx
+# TEMPLATE: add your username after terraform
+# TEMPLATE: * equinix-labs/terraform myusername
+* @ocobleseqx

README.md

@@ -1,23 +1,24 @@
-## terraform-metal-shared-connection
+## Equinix Fabric L2 Connection To Equinix Metal Connection Terraform module
 
 [![Experimental](https://img.shields.io/badge/Stability-Experimental-red.svg)](https://github.com/equinix-labs/standards#about-uniform-standards)
 [![terraform](https://github.com/equinix-labs/terraform-equinix-template/actions/workflows/integration.yaml/badge.svg)](https://github.com/equinix-labs/terraform-equinix-template/actions/workflows/integration.yaml)
 
-`terraform-metal-shared-connection` is a minimal Terraform module that utilizes [Terraform providers for Equinix](https://registry.terraform.io/namespaces/equinix) to set up an Equinix Metal shared connection.
+`terraform-equinix-fabric-connection-metal` is a minimal Terraform module that utilizes [Terraform providers for Equinix](https://registry.terraform.io/namespaces/equinix) to set up an Equinix Metal shared connection.
 
 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.
 
-```
+```html
   Origin                                             Destination
   (A-side)                                           (Z-side)
 
 ┌────────────────┐                                 ┌───────────────┐
 │ Equinix Fabric │      Equinix Metal              │ Equinix Metal │
 │ Port / Network ├───── Shared connection  ───────►│ Shared Port   │
-│ Edge Device    │      (50 Mbps - 10 Gbps)        │               │
-└────────────────┘                                 └───────────────┘
+│ Edge Device /  │     (50 Mbps - 10 Gbps)         └───────────────┘
+│ Service Token  │
+└────────────────┘
 ```
 
 ### Usage
@@ -33,58 +34,45 @@ This project may also be used as a [Terraform module](https://learn.hashicorp.co
 To use this module in a new project, create a file such as:
 
 ```hcl
-# main.tf
-terraform {
-  required_providers {
-    equinix = {
-      source = "equinix/equinix"
-    }
-    metal = {
-      source = "equinix/metal"
-    }
-}
+provider "equinix" {}
+
+variable "metal_project_name" {}
+variable "edge_device_id" {}
+
+module "equinix-fabric-connection-metal" {
+  source = "github.com/equinix-labs/terraform-equinix-fabric-connection-metal"
+
+  # required variables
+  fabric_notification_users     = ["example@equinix.com"]
+  fabric_destination_metro_code = "SV"
 
-module "example" {
-  source = "github.com/equinix-labs/terraform-metal-shared-connection"
+  metal_project_name = var.metal_project_name
 
-  # TEMPLATE: insert required variables here
+  # optional variables
+  network_edge_device_id = var.edge_device_id
 }
 ```
 
 Run `terraform init -upgrade` and `terraform apply`.
 
-
 #### Resources
 
 | Name | Type |
 | :-----: | :------: |
-| [metal_project.this](https://registry.terraform.io/providers/equinix/metal/latest/docs/data-sources/project) | data source |
-| [metal_connection.this](https://registry.terraform.io/providers/equinix/metal/latest/docs/resources/device) | resource |
-| [equinix_ecx_l2_connection.this](https://registry.terraform.io/providers/equinix/equinix/latest/docs/resources/ecx_l2_connection) | resource |
-| [equinix_ecx_l2_sellerprofile.this](https://registry.terraform.io/providers/equinix/equinix/latest/docs/data-sources/ecx_l2_sellerprofile) | data source |
-| [equinix_ecx_port.primary](https://registry.terraform.io/providers/equinix/equinix/latest/docs/data-sources/ecx_port) | data source |
-| [equinix_ecx_port.secondary](https://registry.terraform.io/providers/equinix/equinix/latest/docs/data-sources/ecx_port) | data source |
+| [equinix_metal_project.this](https://registry.terraform.io/providers/equinix/metal/latest/docs/data-sources/project) | data source |
+| [equinix_metal_connection.this](https://registry.terraform.io/providers/equinix/metal/latest/docs/resources/device) | resource |
+| [equinix-fabric-connection](https://registry.terraform.io/modules/equinix-labs/fabric-connection/equinix/latest) | module |
 
 #### Variables
 
-|     Variable Name      |  Type   |        Default Value        | Description                                             |
-| :--------------------: | :-----: | :-------------------------: | :------------------------------------------------------ |
-|                        |         |                             |                                                         |
-
-TBD
-
-<!-- TEMPLATE: If published, remove the table and use the following: See <https://registry.terraform.io/modules/equinix-labs/template/equinix/latest?tab=inputs> for a description of all variables. -->
+See <https://registry.terraform.io/modules/equinix-labs/fabric-connection-metal/equinix/latest?tab=inputs> for a description of all variables.
 
 #### Outputs
 
-|     Variable Name      |  Type   | Description                                             |
-| :--------------------: | :-----: | :------------------------------------------------------ |
-|                        |         |                                                         |
-
-TBD
-
-<!-- TEMPLATE: If published, remove the table and use the following: See <https://registry.terraform.io/modules/equinix-labs/template/equinix/latest?tab=outputs> for a description of all outputs. -->
+See <https://registry.terraform.io/modules/equinix-labs/fabric-connection-metal/equinix/latest?tab=outputs> for a description of all outputs.
 
 ### Examples
 
-- [examples/device-redundant-connection](examples/device-redundant-connection/)
+- [Fabric Port redundant connection](https://registry.terraform.io/modules/equinix-labs/fabric-connection-metal/equinix/latest/examples/fabric-port-redundant-connection/)
+- [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/device-redundant-connection/.terraform.lock.hcl

@@ -0,0 +1,27 @@
+# Equinix Fabric Port Connection Example
+
+This example demonstrates usage of the Equinix Connection Metal module to establish a single Equinix Fabric L2 Connection from an Equinix Fabric Port to Equinix Metal. It will:
+
+- Create a Metal shared non-redundant connection in Frankfurt.
+- Create Equinix Fabric l2 connection in Frankfurt for 'Equinix Metal - Layer 2' service profile with 200Mbps bandwidth.
+
+## Usage
+
+To provision this example, you should clone the github repository and run terraform from within this directory:
+
+```bash
+git clone https://github.com/equinix-labs/terraform-equinix-fabric-connection-metal.git
+cd terraform-equinix-fabric-connection-metal/examples/network-edge-device-redundant-connection
+terraform init
+terraform apply
+```
+
+Note that this example may create resources which cost money. Run 'terraform destroy' when you don't need these resources.
+
+## Variables
+
+See <https://registry.terraform.io/modules/equinix-labs/fabric-connection-metal/equinix/latest/examples/network-edge-device-redundant-connection?tab=inputs> for a description of all variables.
+
+## Outputs
+
+See <https://registry.terraform.io/modules/equinix-labs/fabric-connection-metal/equinix/latest/examples/network-edge-device-redundant-connection?tab=outputs> for a description of all outputs.

examples/device-redundant-connection/main.tf

@@ -0,0 +1,35 @@
+// Interacting with Equinix Metal requires an API auth token in addition to the Equinix API
+// credentials. See provider docs for further details
+// https://registry.terraform.io/providers/equinix/equinix/latest/docs
+provider "equinix" {} 
+
+module "equinix-fabric-connection-metal" {
+  source = "github.com/equinix-labs/terraform-equinix-fabric-connection-metal"
+
+  # required variables
+  fabric_notification_users     = ["example@equinix.com"]
+  fabric_destination_metro_code = "FR" // corresponds to Frankfurt
+
+  metal_project_name = var.metal_project_name
+
+  # optional variables
+  fabric_speed           = 200
+  fabric_connection_name = local.connection_name
+  fabric_port_name       = var.fabric_port_name
+  fabric_vlan_stag       = 1010
+
+  metal_connection_name        = local.connection_name
+  metal_connection_description = "My shared connection from an Equinix Fabric Port"
+}
+
+locals {
+  // Optionally you can use the same name on both sides Equinix Fabric and Equinix Metal to easily
+  // identify the connection
+  connection_name = format("example-fr-%s", random_string.this.result)
+}
+
+resource "random_string" "this" {
+  length  = 3
+  special = false
+  upper   = false
+}

examples/device-redundant-connection/outputs.tf

@@ -0,0 +1,3 @@
+output "connection_details" {
+  value = module.equinix-fabric-connection-metal
+}