consul/website/content/docs/connect/cluster-peering/create-manage-peering.mdx

---
layout: docs
page_title: Create and Manage Peering Connections
description: >-
    This page describes how to use the Consul CLI to create, manage, and delete peering connections for cluster peering.
---

# Create and Manage Peering Connections

~> **Cluster peering is currently in beta:** Functionality associated with cluster peering is subject to change. You should never use the beta release in secure environments or production scenarios. Features in beta may have performance issues, scaling issues, and limited support.

A peering token enables cluster peering between different datacenters. Once you generate a peering token, you can use it to establish a connection between clusters. Then you can export services and create intentions so that peered clusters can call those services.

## Create a peering connection

Cluster peering is not enabled by default on Consul servers. To peer clusters, you must first configure all Consul servers so that `peering` is `enabled`. For additional information, refer to [Configuration Files](/docs/agent/config/config-files).

Then, complete the following steps in order:

1. Create a peering token
1. Establish a connection between clusters
1. Export services between clusters
1. Authorize services for peers

### Enable peering on all Consul servers

Cluster peering is not enabled by default. To enable cluster peering,

### Create a peering token

You can generate peering tokens and initiate connections on any available agent using either the Consul UI or the API. If you use the API, we recommend performing these operations through a client agent in the partition you want to connect.

To begin the cluster peering process, generate a peering token in one of your clusters. The other cluster uses this token to establish the peering connection.

<Tabs>
<Tab heading="Consul API">
In `cluster-01`, issue a request for a peering token.

```shell-session
$ curl --request POST --data '{"PeerName":"cluster-02"}' --url http://localhost:8500/v1/peering/token
```

The CLI outputs the peering token, which is a base64-encoded string containing the token details.

Create a JSON file that contains the first cluster's name and the peering token.

<CodeBlockConfig filename="peering_token.json" hideClipboard>

```json
{
    "PeerName": "cluster-01",
    "PeeringToken": "eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbiIsImF1ZCI6IlNvbHIifQ.5T7L_L1MPfQ_5FjKGa1fTPqrzwK4bNSM812nW6oyjb8"
}
```

</CodeBlockConfig>
</Tab>

<Tab heading="Consul UI">

</Tab>
</Tabs>

### Establish a connection between clusters

Next, use the peering token to establish a secure connection between the clusters.

<Tabs>
<Tab heading="Consul API">
In one of the client agents in "cluster-02," use `peering_token.json` to establish the peering connection. This endpoint does not generate an output unless there is an error.

```shell-session
$ curl --request POST --data @peering_token.json http://127.0.0.1:8500/v1/peering/establish
```

When you connect server agents through cluster peering, they peer their default partitions. To establish peering connections for other partitions through server agents, you must add the `Partition` field to `peering_token.json` and specify the partitions you want to peer. For additional configuration information, refer to [Cluster Peering - HTTP API](/api-docs/peering).
</Tab>

<Tab heading="Consul UI">

</Tab>
</Tabs>

### Export services between clusters

After you establish a connection between the clusters, you need to create a configuration entry that defines the services that are available for other clusters. Consul uses this configuration entry to advertise service information and support service mesh connections across clusters.

<Tabs>
<Tab heading="Consul API">
First, create a configuration entry and specify the `Kind` as `"exported-services"`.

<CodeBlockConfig filename="peering-config.hcl" hideClipboard>

```hcl
Kind = "exported-services"

Services = [
  {
    ## The name and namespace of the service to export.
    Name      = "service-name"
    Namespace = "default"

    ## The list of peer clusters to export the service to.
    Consumers = [
      {
        ## The peer name to reference in config is the one set
        ## during the peering process.
        Peer = "cluster-02"
      }
    ]
```

</CodeBlockConfig>

Then, add the configuration entry to your cluster.

```shell-session
$ consul config write peering-config.hcl
```

Before you proceed, wait for the clusters to sync and make services available to their peers. You can issue an endpoint query to [check the peered cluster status](#check-peered-cluster-status).
</Tab>

<Tab heading="Consul UI">

</Tab>
</Tabs>

### Authorize services for peers

Before you can call services from peered clusters, you must set service intentions that authorize those clusters to use specific services. Consul prevents services from being exported to unauthorized clusters.

<Tabs>
<Tab heading="Consul API">
First, create a configuration entry and specify the `Kind` as `"service-intentions"`. Declare the service on "cluster-02" that can access the service in "cluster-01." The following example sets service intentions so that "frontend-service" can access "backend-service."

<CodeBlockConfig filename="peering-intentions.hcl" hideClipboard>

```hcl
Kind      = "service-intentions"
Name      = "backend-service"

Sources = [
  {
    Name   = "frontend-service"
    Peer   = "cluster-02"
    Action = "allow"
  }
]
```

</CodeBlockConfig>

If the peer’s name is not specified in `Peer`, then Consul assumes that the service is in the local cluster.

Then, add the configuration entry to your cluster.

```shell-session
$ consul config write peering-intentions.hcl
```
</Tab>

<Tab heading="Consul UI">

</Tab>
</Tabs>

## Manage peering connections

After you establish a peering connection, you can get a list of all active peering connections, read a specific peering connection's info, check peering connection health, and delete peering connections.

### List all peering connections

You can list all active peering connections in a cluster.

<Tabs>
<Tab heading="Consul API">

After you establish a peering connection, [query the `/peering/` endpoint](/api-docs/peering#list-all-peerings) to get a list of all peering connections. For example, the following command requests a list of all peering connections on `localhost` and returns the info as a series of JSON objects:

```shell-session
$  curl http://127.0.0.1:8500/v1/peerings

[
    {
        "ID": "462c45e8-018e-f19d-85eb-1fc1bcc2ef12",
        "Name": "cluster-02",
        "State": "ACTIVE",
        "Partition": "default",
        "PeerID": "e83a315c-027e-bcb1-7c0c-a46650904a05",
        "PeerServerName": "server.dc1.consul",
        "PeerServerAddresses": [
            "10.0.0.1:8300"
        ],
        "CreateIndex": 89,
        "ModifyIndex": 89
    },
    {
        "ID": "1460ada9-26d2-f30d-3359-2968aa7dc47d",
        "Name": "cluster-03",
        "State": "INITIAL",
        "Partition": "default",
        "Meta": {
            "env": "production"
        },
        "CreateIndex": 109,
        "ModifyIndex": 119
    },
]
```
</Tab>

<Tab heading="Consul UI">

</Tab>
</Tabs>

### Read a peering connection

You can get information about individual peering connections between clusters.

<Tabs>
<Tab heading="Consul API">

After you establish a peering connection, [query the `/peering/:name` endpoint](/api-docs/peering#read-a-peering-connection) to get peering information about for a specific cluster. For example, the following command requests peering connection info for "cluster-02" and returns the info as a JSON object:

```shell-session
$  curl http://127.0.0.1:8500/v1/peering/cluster-02

{
    "ID": "462c45e8-018e-f19d-85eb-1fc1bcc2ef12",
    "Name": "cluster-02",
    "State": "INITIAL",
    "PeerID": "e83a315c-027e-bcb1-7c0c-a46650904a05",
    "PeerServerName": "server.dc1.consul",
    "PeerServerAddresses": [
        "10.0.0.1:8300"
    ],
    "CreateIndex": 89,
    "ModifyIndex": 89
}
```
</Tab>

<Tab heading="Consul UI">

</Tab>
</Tabs>

### Check peering connection health

You can check the status of your peering connection to perform health checks.

<Tabs>
<Tab heading="Consul API">
To confirm that the peering connection between your clusters remains healthy, [query the `/health/service` endpoint](/api-docs/health) of one cluster from the other cluster. For example, in "cluster-02," query the endpoint and add the `peer=cluster-01` query parameter to the end of the URL.

```shell-session
$ curl \
    "http://127.0.0.1:8500/v1/health/service/<service-name>?peer=cluster-01"
```

A successful query includes service information in the output.
</Tab>

<Tab heading="Consul UI">

</Tab>
</Tabs>

### Delete peering connections

You can disconnect the peered clusters by deleting their connection. Deleting a peering connection stops data replication to the peer and deletes imported data, including services and CA certificates.

<Tabs>
<Tab heading="Consul API">
In "cluster-01," request the deletion through the [`/peering/` endpoint](api-docs/peering#delete-a-peering-connection).

```shell-session
$ curl --request DELETE http://127.0.0.1:8500/v1/peering/cluster-02
```
</Tab>

<Tab heading="Consul UI">

</Tab>
</Tabs>