From 9b387707fe94ade7419dcbfa05e650e17bb334ff Mon Sep 17 00:00:00 2001 From: David Yu Date: Fri, 26 Aug 2022 09:09:06 -0700 Subject: [PATCH 1/4] README.md: update versions --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index de65faff15..e076689e19 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,7 @@ The `consul-k8s-control-plane` binary includes first-class integrations between Consul and Kubernetes. The project encapsulates multiple use cases such as syncing -services, injecting Connect sidecars, and more. +services, injecting Consul sidecars, and more. The Kubernetes integrations with Consul are [documented directly on the Consul website](https://www.consul.io/docs/platform/k8s/index.html). @@ -30,8 +30,8 @@ by contacting us at [security@hashicorp.com](mailto:security@hashicorp.com). ## Features - * [**Consul Service Mesh (Connect)**](https://www.consul.io/docs/k8s/connect): - Run Consul Service Mesh (aka Consul Connect) on Kubernetes. This feature + * [**Consul Service Mesh**](https://www.consul.io/docs/k8s/connect): + Run Consul Service Mesh on Kubernetes. This feature injects Envoy sidecars and registers your Pods with Consul. * [**Catalog Sync**](https://www.consul.io/docs/k8s/service-sync): @@ -67,7 +67,7 @@ use Consul with Kubernetes, please see the ### Prerequisites * **Helm 3.2+** (Helm 2 is not supported) - * **Kubernetes 1.19+** - This is the earliest version of Kubernetes tested. + * **Kubernetes 1.21-1.24+** - This is the earliest version of Kubernetes tested. It is possible that this chart works with earlier versions, but it is untested. From e23bf602a49c5709af4f62e3bcd95531b3821a7f Mon Sep 17 00:00:00 2001 From: David Yu Date: Fri, 26 Aug 2022 09:10:30 -0700 Subject: [PATCH 2/4] Update README.md --- charts/consul/README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/charts/consul/README.md b/charts/consul/README.md index 36e104bb15..f55be2dcd4 100644 --- a/charts/consul/README.md +++ b/charts/consul/README.md @@ -20,8 +20,8 @@ by contacting us at [security@hashicorp.com](mailto:security@hashicorp.com). ## Features - * [**Consul Service Mesh (Connect)**](https://www.consul.io/docs/k8s/connect): - Run Consul Service Mesh (aka Consul Connect) on Kubernetes. This feature + * [**Consul Service Mesh**](https://www.consul.io/docs/k8s/connect): + Run Consul Service Mesh on Kubernetes. This feature injects Envoy sidecars and registers your Pods with Consul. * [**Catalog Sync**](https://www.consul.io/docs/k8s/service-sync): @@ -31,7 +31,7 @@ by contacting us at [security@hashicorp.com](mailto:security@hashicorp.com). ### Prerequisites * **Helm 3.2+** (Helm 2 is not supported) - * **Kubernetes 1.19+** - This is the earliest version of Kubernetes tested. + * **Kubernetes 1.21-1.24** - This is the earliest version of Kubernetes tested. It is possible that this chart works with earlier versions but it is untested. @@ -49,7 +49,7 @@ Detailed installation instructions for Consul on Kubernetes are found [here](htt $ helm search repo hashicorp/consul NAME CHART VERSION APP VERSION DESCRIPTION - hashicorp/consul 0.35.0 1.10.3 Official HashiCorp Consul Chart + hashicorp/consul 0.471.0 1.13.1 Official HashiCorp Consul Chart 3. Now you're ready to install Consul! To install Consul with the default configuration using Helm 3.2 run the following command below. This will create a `consul` Kubernetes namespace if not already present, and install Consul on the dedicated namespace. From 0796337816b8ec55fb21805b144f76e6a56128b6 Mon Sep 17 00:00:00 2001 From: David Yu Date: Fri, 26 Aug 2022 09:11:29 -0700 Subject: [PATCH 3/4] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index e076689e19..35b3c4b762 100644 --- a/README.md +++ b/README.md @@ -67,7 +67,7 @@ use Consul with Kubernetes, please see the ### Prerequisites * **Helm 3.2+** (Helm 2 is not supported) - * **Kubernetes 1.21-1.24+** - This is the earliest version of Kubernetes tested. + * **Kubernetes 1.21-1.24** - This is the earliest version of Kubernetes tested. It is possible that this chart works with earlier versions, but it is untested. From 8b1a8963451817c06b65faa6169dfba42c423237 Mon Sep 17 00:00:00 2001 From: David Yu Date: Fri, 26 Aug 2022 09:18:23 -0700 Subject: [PATCH 4/4] Update README.md --- charts/consul/README.md | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) diff --git a/charts/consul/README.md b/charts/consul/README.md index f55be2dcd4..ccc695151d 100644 --- a/charts/consul/README.md +++ b/charts/consul/README.md @@ -40,22 +40,23 @@ by contacting us at [security@hashicorp.com](mailto:security@hashicorp.com). Detailed installation instructions for Consul on Kubernetes are found [here](https://www.consul.io/docs/k8s/installation/overview). 1. Add the HashiCorp Helm Repository: - - $ helm repo add hashicorp https://helm.releases.hashicorp.com - "hashicorp" has been added to your repositories + ``` bash + $ helm repo add hashicorp https://helm.releases.hashicorp.com + ``` 2. Ensure you have access to the Consul Helm chart and you see the latest chart version listed. If you have previously added the HashiCorp Helm repository, run `helm repo update`. - $ helm search repo hashicorp/consul - NAME CHART VERSION APP VERSION DESCRIPTION - hashicorp/consul 0.471.0 1.13.1 Official HashiCorp Consul Chart + ```bash + $ helm search repo hashicorp/consul + ``` 3. Now you're ready to install Consul! To install Consul with the default configuration using Helm 3.2 run the following command below. This will create a `consul` Kubernetes namespace if not already present, and install Consul on the dedicated namespace. - $ helm install consul hashicorp/consul --set global.name=consul --create-namespace -n consul - NAME: consul + ```bash + $ helm install consul hashicorp/consul --set global.name=consul --create-namespace -n consul + ``` Please see the many options supported in the `values.yaml` file. These are also fully documented directly on the