Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.equinix.dev/llms.txt

Use this file to discover all available pages before exploring further.

The terraform-equinix-fabric repository is the canonical module set. It wraps the lowest-level equinix_fabric_* resources into composable, opinionated modules that handle the joint configuration patterns Fabric customers run into repeatedly. equinix.dev uses these modules where they fit. Where a one-resource-per-package pattern is cleaner, we call the resource directly.

​
When to use a module

A Fabric Cloud Router and its connections share account, notification, and metro settings. Module inputs DRY this up:
module "fcr_iad" {
  source  = "equinix/fabric-equinix/fabric"
  version = "0.28.1"

  cloud_router_name           = "fcr-iad"
  cloud_router_metro_code     = "DC"
  cloud_router_package        = "BASIC"
  cloud_router_account_num    = var.equinix_account_number
  cloud_router_notification_emails = ["platform@example.com"]
}
Then a connection just references module.fcr_iad.cloud_router_id.
Need a non-default redundancy.priority, a custom lifecycle.ignore_changes, or a bespoke route filter binding? Drop to the raw resource:
resource "equinix_fabric_cloud_router" "this" {
  name     = "fcr-iad-custom"
  type     = "XF_ROUTER"
  package  = { code = "ADVANCED" }
  location { metro_code = "DC" }
  lifecycle {
    ignore_changes = [account, change_log]
  }
}
equinix.dev’s emitted Terraform mixes both: modules for the common case, raw resources for the per-package customizations.

​
Module catalog

The Fabric module repo ships several modules. The ones we use:
Module pathVersionWhat it wrapsUsed by
equinix/fabric-equinix/fabric (root)0.28.1Cloud Router with default account + notificationsAll Use Cases
equinix/fabric-equinix/fabric//modules/fabric-cloud-router-connection0.28.1A single Cloud Router connection — A-side and Z-side wiredPrivate AI inference
equinix/fabric-equinix/fabric//modules/fabric-port-connection0.28.1Port-to-port Fabric connectionMulti-cloud regulated
equinix/fabric-equinix/fabric//modules/fabric-stream-subscription0.28.1Streams subscription with sink + samplingDistributed AI observability
equinix/fabric-equinix/fabric//modules/fabric-route-filter0.28.1Route filter with rule listMulti-cloud regulated

​
Module versioning

We pin to 0.28.1 — the version that’s stable as of Q2 2026. The repo’s CHANGELOG.md is the source of truth for what shipped where. To bump: 
equinix-dev upgrade equinix/fabric-cloud-router --module-version 0.29.0
equinix-dev plan
The CLI re-resolves the module version, re-emits Terraform, and runs terraform plan to surface the diff before you commit.

​
Cross-module composition

Modules call other modules. The Cloud Router root module composes the connection module under the hood. When you author your own modules on top of equinix.dev, the same composition pattern applies: 
module "private_ai_iad" {
  source  = "./modules/private-ai-path"

  metro_code         = "DC"
  gpu_partner_profile_uuid = data.equinix_fabric_service_profiles.lambda.data[0].uuid
  fortigate_ssh_key_name   = "platform"
}

# ./modules/private-ai-path/main.tf composes:
#   - module.fcr (terraform-equinix-fabric root)
#   - resource.equinix_fabric_connection × 2
#   - resource.equinix_network_device (FortiGate)
This is the pattern the Private AI inference recipe uses.

​
Module discovery via MCP

Agents looking for a module to satisfy a constraint can query the Fabric MCP: 
{
  "tool": "search_module",
  "arguments": { "kind": "fabric_cloud_router_connection" },
  "result": {
    "modules": [
      {
        "source": "equinix/fabric-equinix/fabric//modules/fabric-cloud-router-connection",
        "version": "0.28.1",
        "inputs_required": ["fabric_cloud_router_id", "z_side_profile_uuid"],
        "inputs_optional": ["bandwidth", "redundancy_priority"]
      }
    ]
  }
}
This drives recipe authoring when an agent assembles a multi-resource plan from a high-level intent.

​
Next

Resources index

Every equinix_* resource available, with one-line summaries.

Recipes

Composed examples showing modules and resources together.