diff --git a/website/data/docs-navigation.js b/website/data/docs-navigation.js index 504064a2b5..a94dec0a80 100644 --- a/website/data/docs-navigation.js +++ b/website/data/docs-navigation.js @@ -188,6 +188,7 @@ export default [ }, { category: 'operations', + name: 'Operations', content: ['upgrading', 'tls-on-existing-cluster', 'uninstalling'], }, 'dns', diff --git a/website/pages/docs/k8s/installation/consul-enterprise.mdx b/website/pages/docs/k8s/installation/consul-enterprise.mdx index fa68778b90..d739df1f36 100644 --- a/website/pages/docs/k8s/installation/consul-enterprise.mdx +++ b/website/pages/docs/k8s/installation/consul-enterprise.mdx @@ -43,7 +43,7 @@ server: Now run `helm install`: ```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 diff --git a/website/pages/docs/k8s/installation/index.mdx b/website/pages/docs/k8s/installation/index.mdx index 1e8820d1df..aa676e2960 100644 --- a/website/pages/docs/k8s/installation/index.mdx +++ b/website/pages/docs/k8s/installation/index.mdx @@ -60,44 +60,31 @@ need to install Tiller by following the ### Installing Consul -Determine the latest version of the Consul Helm chart -by visiting [https://github.com/hashicorp/consul-helm/releases](https://github.com/hashicorp/consul-helm/releases). +Add the HashiCorp Helm Repository: -Clone the chart at that version. For example, if the latest version is -`v0.8.1`, you would run: - -```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... +```shell +$ helm repo add hashicorp https://helm.releases.hashicorp.com +"hashicorp" has been added to your repositories ``` -Ensure you've checked out the correct version with `helm inspect chart`: +Ensure you have access to the consul chart: -```bash -$ helm inspect chart ./consul-helm -apiVersion: v1 -description: Install and configure Consul on Kubernetes. -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 +```shell +$ helm search repo hashicorp/consul +NAME CHART VERSION APP VERSION DESCRIPTION +hashicorp/consul 0.20.1 1.7.2 Official HashiCorp Consul Chart ``` Now you're ready to install Consul! To install Consul with the default configuration using Helm 3 run: ```shell -$ helm install hashicorp ./consul-helm -NAME: hashicorp +$ helm install consul hashicorp/consul --set global.name=consul +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 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, 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). +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: -```bash -$ helm install hashicorp ./consul-helm -f config.yaml +```shell +$ 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 @@ -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: ``` -$ kubectl port-forward service/hashicorp-consul-server 8500:8500 +$ kubectl port-forward service/consul-server 8500:8500 ... ``` diff --git a/website/pages/docs/k8s/operations/index.mdx b/website/pages/docs/k8s/operations/index.mdx deleted file mode 100644 index 19ae8d6811..0000000000 --- a/website/pages/docs/k8s/operations/index.mdx +++ /dev/null @@ -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. diff --git a/website/pages/docs/k8s/operations/upgrading.mdx b/website/pages/docs/k8s/operations/upgrading.mdx index ea16d51884..9018c845eb 100644 --- a/website/pages/docs/k8s/operations/upgrading.mdx +++ b/website/pages/docs/k8s/operations/upgrading.mdx @@ -66,4 +66,4 @@ until the clients come up healthy before continuing. If you already have a Consul cluster deployed on Kubernetes and would like to turn on TLS for internal Consul communication, 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).