mirror of https://github.com/status-im/consul.git
Update k8s instructions for new helm repo
Also remove index page for operations since it just linked to the other pages in the list.
This commit is contained in:
parent
0d6aff29f6
commit
dca331ed44
|
@ -188,6 +188,7 @@ export default [
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
category: 'operations',
|
category: 'operations',
|
||||||
|
name: 'Operations',
|
||||||
content: ['upgrading', 'tls-on-existing-cluster', 'uninstalling'],
|
content: ['upgrading', 'tls-on-existing-cluster', 'uninstalling'],
|
||||||
},
|
},
|
||||||
'dns',
|
'dns',
|
||||||
|
|
|
@ -43,7 +43,7 @@ server:
|
||||||
Now run `helm install`:
|
Now run `helm install`:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
$ helm install --wait hashicorp ./consul-helm -f config.yaml
|
$ helm install --wait hashicorp hashicorp/consul -f config.yaml
|
||||||
```
|
```
|
||||||
|
|
||||||
Once the cluster is up, you can verify the nodes are running Consul Enterprise by
|
Once the cluster is up, you can verify the nodes are running Consul Enterprise by
|
||||||
|
|
|
@ -60,44 +60,31 @@ need to install Tiller by following the
|
||||||
|
|
||||||
### Installing Consul
|
### Installing Consul
|
||||||
|
|
||||||
Determine the latest version of the Consul Helm chart
|
Add the HashiCorp Helm Repository:
|
||||||
by visiting [https://github.com/hashicorp/consul-helm/releases](https://github.com/hashicorp/consul-helm/releases).
|
|
||||||
|
|
||||||
Clone the chart at that version. For example, if the latest version is
|
```shell
|
||||||
`v0.8.1`, you would run:
|
$ helm repo add hashicorp https://helm.releases.hashicorp.com
|
||||||
|
"hashicorp" has been added to your repositories
|
||||||
```bash
|
|
||||||
$ git clone --single-branch --branch v0.8.1 https://github.com/hashicorp/consul-helm.git
|
|
||||||
Cloning into 'consul-helm'...
|
|
||||||
...
|
|
||||||
You are in 'detached HEAD' state...
|
|
||||||
```
|
```
|
||||||
|
|
||||||
Ensure you've checked out the correct version with `helm inspect chart`:
|
Ensure you have access to the consul chart:
|
||||||
|
|
||||||
```bash
|
```shell
|
||||||
$ helm inspect chart ./consul-helm
|
$ helm search repo hashicorp/consul
|
||||||
apiVersion: v1
|
NAME CHART VERSION APP VERSION DESCRIPTION
|
||||||
description: Install and configure Consul on Kubernetes.
|
hashicorp/consul 0.20.1 1.7.2 Official HashiCorp Consul Chart
|
||||||
home: https://www.consul.io
|
|
||||||
name: consul
|
|
||||||
sources:
|
|
||||||
- https://github.com/hashicorp/consul
|
|
||||||
- https://github.com/hashicorp/consul-helm
|
|
||||||
- https://github.com/hashicorp/consul-k8s
|
|
||||||
version: 0.8.1
|
|
||||||
```
|
```
|
||||||
|
|
||||||
Now you're ready to install Consul! To install Consul with the default
|
Now you're ready to install Consul! To install Consul with the default
|
||||||
configuration using Helm 3 run:
|
configuration using Helm 3 run:
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
$ helm install hashicorp ./consul-helm
|
$ helm install consul hashicorp/consul --set global.name=consul
|
||||||
NAME: hashicorp
|
NAME: consul
|
||||||
...
|
...
|
||||||
```
|
```
|
||||||
|
|
||||||
-> If using Helm 2, run: `helm install --name hashicorp ./consul-helm`
|
-> If using Helm 2, run: `helm install --name consul hashicorp/consul --set global.name=consul`
|
||||||
|
|
||||||
_That's it._ The Helm chart does everything to set up a recommended
|
_That's it._ The Helm chart does everything to set up a recommended
|
||||||
Consul-on-Kubernetes deployment.
|
Consul-on-Kubernetes deployment.
|
||||||
|
@ -108,13 +95,26 @@ elected and every node will have a running Consul agent.
|
||||||
|
|
||||||
If you want to customize your installation,
|
If you want to customize your installation,
|
||||||
create a `config.yaml` file to override the default settings.
|
create a `config.yaml` file to override the default settings.
|
||||||
You can learn what settings are available by running `helm inspect values ./consul-helm`
|
You can learn what settings are available by running `helm inspect values hashicorp/consul`
|
||||||
or by reading the [Helm Chart Reference](/docs/platform/k8s/helm).
|
or by reading the [Helm Chart Reference](/docs/platform/k8s/helm).
|
||||||
|
|
||||||
|
For example, if you want to enable the [Consul Connect](/docs/k8s/connect) feature,
|
||||||
|
use the following config file:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
# config.yaml
|
||||||
|
global:
|
||||||
|
name: consul
|
||||||
|
connectInject:
|
||||||
|
enabled: true
|
||||||
|
```
|
||||||
|
|
||||||
Once you've created your `config.yaml` file, run `helm install` with the `-f` flag:
|
Once you've created your `config.yaml` file, run `helm install` with the `-f` flag:
|
||||||
|
|
||||||
```bash
|
```shell
|
||||||
$ helm install hashicorp ./consul-helm -f config.yaml
|
$ helm install consul hashicorp/consul -f config.yaml
|
||||||
|
NAME: consul
|
||||||
|
...
|
||||||
```
|
```
|
||||||
|
|
||||||
If you've already installed Consul and want to make changes, you'll need to run
|
If you've already installed Consul and want to make changes, you'll need to run
|
||||||
|
@ -128,7 +128,7 @@ For security reasons, it isn't exposed via a `LoadBalancer` Service by default s
|
||||||
use `kubectl port-forward` to visit the UI:
|
use `kubectl port-forward` to visit the UI:
|
||||||
|
|
||||||
```
|
```
|
||||||
$ kubectl port-forward service/hashicorp-consul-server 8500:8500
|
$ kubectl port-forward service/consul-server 8500:8500
|
||||||
...
|
...
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
|
@ -1,14 +0,0 @@
|
||||||
---
|
|
||||||
layout: docs
|
|
||||||
page_title: Operations
|
|
||||||
sidebar_title: Operations
|
|
||||||
description: Operating Consul on Kubernetes
|
|
||||||
---
|
|
||||||
|
|
||||||
# Operations
|
|
||||||
|
|
||||||
This section holds documentation on various operational tasks you may need to perform.
|
|
||||||
|
|
||||||
- [Upgrading](/docs/platform/k8s/upgrading) - Upgrading your Consul servers or clients and the Helm chart.
|
|
||||||
- [Configuring TLS on an Existing Cluster](/docs/platform/k8s/tls-on-existing-cluster) - Configuring TLS on an existing Consul cluster running in Kubernetes.
|
|
||||||
- [Uninstalling](/docs/platform/k8s/uninstalling) - Uninstaling the Helm chart.
|
|
|
@ -66,4 +66,4 @@ until the clients come up healthy before continuing.
|
||||||
If you already have a Consul cluster deployed on Kubernetes and
|
If you already have a Consul cluster deployed on Kubernetes and
|
||||||
would like to turn on TLS for internal Consul communication,
|
would like to turn on TLS for internal Consul communication,
|
||||||
please see
|
please see
|
||||||
[Configuring TLS on an Existing Cluster](/docs/platform/k8s/tls-on-existing-cluster).
|
[Configuring TLS on an Existing Cluster](/docs/k8s/operations/tls-on-existing-cluster).
|
||||||
|
|
Loading…
Reference in New Issue