consul_peering (Resource)

Cluster Peering can be used to create connections between two or more independent clusters so that services deployed to different partitions or datacenters can communicate.

The cluster_peering resource can be used to establish the peering after a peering token has been generated.

The functionality described here is available only in Consul version 1.13.0 and later.

Example Usage

# Create a peering between the EU and US Consul clusters

provider "consul" {
  alias   = "eu"
  address = "eu-cluster:8500"
}

provider "consul" {
  alias   = "us"
  address = "us-cluster:8500"
}

resource "consul_peering_token" "eu-us" {
  provider  = consul.us
  peer_name = "eu-cluster"
}

resource "consul_peering" "eu-us" {
  provider = consul.eu

  peer_name     = "eu-cluster"
  peering_token = consul_peering_token.token.peering_token

  meta = {
    hello = "world"
  }
}

Schema

Required

Optional

Read-Only