Skip to content

Commit

Permalink
Update documentation template
Browse files Browse the repository at this point in the history
  • Loading branch information
remilapeyre committed Dec 14, 2023
1 parent 8ad79f6 commit c035371
Show file tree
Hide file tree
Showing 2 changed files with 1 addition and 8 deletions.
2 changes: 0 additions & 2 deletions consul/resource_consul_peering_token.go
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,6 @@ func resourceSourceConsulPeeringToken() *schema.Resource {
[Cluster Peering](https://www.consul.io/docs/connect/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_token`" + ` resource can be used to generate a peering token that can later be used to establish a peering connection.
The functionality described here is available only in Consul version 1.13.0 and later.
`,

Create: resourceConsulPeeringTokenCreate,
Expand Down
7 changes: 1 addition & 6 deletions docs/resources/peering_token.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,6 @@ subcategory: ""
description: |-
Cluster Peering https://www.consul.io/docs/connect/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_token resource can be used to generate a peering token that can later be used to establish a peering connection.
~> Cluster peering is currently in technical preview: Functionality associated with cluster peering is subject to change. You should never use the technical preview release in secure environments or production scenarios. Features in technical preview may have performance issues, scaling issues, and limited support.
The functionality described here is available only in Consul version 1.13.0 and later.
---

# consul_peering_token (Resource)
Expand All @@ -15,10 +13,6 @@ description: |-

The `cluster_peering_token` resource can be used to generate a peering token that can later be used to establish a peering connection.

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

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

## Example Usage

```terraform
Expand All @@ -38,6 +32,7 @@ resource "consul_peering_token" "token" {

- `meta` (Map of String) Specifies KV metadata to associate with the peering. This parameter is not required and does not directly impact the cluster peering process.
- `partition` (String)
- `server_external_addresses` (List of String) The addresses for the cluster that generates the peering token. Addresses take the form {host or IP}:port. You can specify one or more load balancers or external IPs that route external traffic to this cluster's Consul servers.

### Read-Only

Expand Down

0 comments on commit c035371

Please sign in to comment.