Skip to content

peering: update docs with exposing servers #14191

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ndhanushkodi merged 4 commits into from
Aug 12, 2022
Merged

peering: update docs with exposing servers #14191

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
ed43ee2
update docs with values for exposing servers
ndhanushkodi Aug 12, 2022
5a84961
bump version
ndhanushkodi Aug 12, 2022
882d6b2
update helm docs
ndhanushkodi Aug 12, 2022
46c4992
add code ticks
ndhanushkodi Aug 12, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 8 additions & 4 deletions website/content/docs/connect/cluster-peering/k8s.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,7 @@ The following CRDs are used to create and manage a peering connection:
You must implement the following requirements to create and use cluster peering connections with Kubernetes:
- Consul version 1.13.1 or later
- At least two Kubernetes clusters
- The Kubernetes clusters must be running in a flat network
- The network must be running on Consul on Kubernetes version 0.47.0 or later
- The installation must be running on Consul on Kubernetes version 0.47.1 or later

### Helm chart configuration

Expand All @@ -48,14 +47,19 @@ To establish cluster peering through Kubernetes, deploy clusters with the follow

</CodeBlockConfig>

Install Consul on Kubernetes on each Kubernetes cluster by applying `values.yaml` using the Helm CLI.
Install Consul on Kubernetes on each Kubernetes cluster by applying `values.yaml` using the Helm CLI. With these values,
the servers in each cluster will be exposed over a Kubernetes Load balancer service. This service can be customized
using [`server.exposeService`](/docs/k8s/helm#v-server-exposeservice). When generating a peering token from one of the
clusters, the address(es) of the load balancer will be used in the peering token, so the peering stream will go through
the load balancer in front of the servers. For customizing the addresses used in the peering token, see
[`global.peering.tokenGeneration`](/docs/k8s/helm#v-global-peering-tokengeneration).

```shell-session
$ export HELM_RELEASE_NAME=cluster-name
```

```shell-session
$ helm install ${HELM_RELEASE_NAME} hashicorp/consul --version "0.47.0" --values values.yaml
$ helm install ${HELM_RELEASE_NAME} hashicorp/consul --version "0.47.1" --values values.yaml
```

## Create a peering token
Expand Down
4 changes: 3 additions & 1 deletion website/content/docs/k8s/helm.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,9 @@ Use these links to navigate to a particular top-level stanza.
- `source` ((#v-global-peering-tokengeneration-serveraddresses-source)) (`string: ""`) - Source can be set to "","consul" or "static".

"" is the default source. If servers are enabled, it will check if `server.exposeService` is enabled, and read
the addresses from that service to use as the peering token server addresses.
the addresses from that service to use as the peering token server addresses. If using admin partitions and
only Consul client agents are enabled, the addresses in `externalServers.hosts` and `externalServers.grpcPort`
will be used.

"consul" will use the Consul advertise addresses in the peering token.

Expand Down