Merge pull request #7944 from hashicorp/k8s-mgw-docs-update

Update for consul:1.8.0-beta2
This commit is contained in:
Luke Kysow 2020-05-25 11:26:28 -07:00 committed by GitHub
commit 85b20d3713
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 11 additions and 7 deletions

View File

@ -38,7 +38,7 @@ with the possible modifications listed below.
```yaml ```yaml
global: global:
name: consul name: consul
image: consul:1.8.0-beta1 image: consul:beta
datacenter: dc1 datacenter: dc1
# TLS configures whether Consul components use TLS. # TLS configures whether Consul components use TLS.
@ -81,7 +81,7 @@ Modifications:
1. Note the Docker image: 1. Note the Docker image:
```yaml ```yaml
global: global:
image: consul:1.8.0-beta1 image: consul:beta
``` ```
Kubernetes support for federation is currently only available in Consul 1.8.0 beta. Kubernetes support for federation is currently only available in Consul 1.8.0 beta.
1. The Consul datacenter name is `dc1`. The datacenter name in each federated 1. The Consul datacenter name is `dc1`. The datacenter name in each federated
@ -124,6 +124,8 @@ With your `config.yaml` ready to go, follow our [Installation Guide](/docs/k8s/i
to install Consul on your primary cluster and then skip ahead to the [Federation Secret](#federation-secret) to install Consul on your primary cluster and then skip ahead to the [Federation Secret](#federation-secret)
section. section.
-> **NOTE:** You must be using consul-helm 0.21.0+. To update, run `helm repo update`.
#### Upgrading An Existing Cluster #### Upgrading An Existing Cluster
If you have an existing cluster, you will need to upgrade it to ensure it has If you have an existing cluster, you will need to upgrade it to ensure it has
@ -131,7 +133,7 @@ the following config:
```yaml ```yaml
global: global:
image: consul:1.8.0-beta1 image: consul:beta
tls: tls:
enabled: true enabled: true
federation: federation:
@ -144,7 +146,7 @@ meshGateway:
enabled: true enabled: true
``` ```
1. `global.image` must be set to `consul:1.8.0-beta1` because Kubernetes support 1. `global.image` must be set to `consul:beta` because Kubernetes support
for federation is currently only available in Consul 1.8.0 beta. for federation is currently only available in Consul 1.8.0 beta.
1. `global.tls.enabled` must be `true`. See [Configuring TLS on an Existing Cluster](/docs/k8s/operations/tls-on-existing-cluster) 1. `global.tls.enabled` must be `true`. See [Configuring TLS on an Existing Cluster](/docs/k8s/operations/tls-on-existing-cluster)
for more information on safely upgrading a cluster to use TLS. for more information on safely upgrading a cluster to use TLS.
@ -163,6 +165,8 @@ If you've set `enableAutoEncrypt: true`, this is also supported.
With the above settings added to your existing config, follow the [Upgrading](/localhost:3000/docs/k8s/operations/upgrading) With the above settings added to your existing config, follow the [Upgrading](/localhost:3000/docs/k8s/operations/upgrading)
guide to upgrade your cluster and then come back to the [Federation Secret](#federation-secret) section. guide to upgrade your cluster and then come back to the [Federation Secret](#federation-secret) section.
-> **NOTE:** You must be using consul-helm 0.21.0+. To update, run `helm repo update`.
## Federation Secret ## Federation Secret
The federation secret is a Kubernetes secret containing information needed The federation secret is a Kubernetes secret containing information needed
@ -263,7 +267,7 @@ settings are different.
```yaml ```yaml
global: global:
name: consul name: consul
image: consul:1.8.0-beta1 image: consul:beta
datacenter: dc2 datacenter: dc2
tls: tls:
enabled: true enabled: true
@ -310,7 +314,7 @@ server:
Modifications: Modifications:
1. Note `global.image: consul:1.8.0-beta1`. Kubernetes support for federation is currently only available 1. Note `global.image: consul:beta`. Kubernetes support for federation is currently only available
in Consul 1.8.0 beta. in Consul 1.8.0 beta.
1. The Consul datacenter name is `dc2`. The primary datacenter's name was `dc1`. 1. The Consul datacenter name is `dc2`. The primary datacenter's name was `dc1`.
The datacenter name in **each** federated cluster **must be unique**. The datacenter name in **each** federated cluster **must be unique**.

View File

@ -244,7 +244,7 @@ Then use the following Helm config file:
```yaml ```yaml
global: global:
name: consul name: consul
image: consul:1.8.0-beta1 image: consul:beta
datacenter: dc2 datacenter: dc2
tls: tls:
enabled: true enabled: true