Skip to content
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.

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

README.md: update K8s versions #1459

Merged
merged 5 commits into from
Aug 26, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).

Expand All @@ -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):
Expand Down Expand Up @@ -67,7 +67,7 @@ use Consul with Kubernetes, please see the

### Prerequisites
* **Helm 3.2+** (Helm 2 is not supported)
* **Kubernetes 1.21+** - 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.

Expand Down
23 changes: 12 additions & 11 deletions charts/consul/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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):
Expand All @@ -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.

Expand All @@ -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.35.0 1.10.3 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
Expand Down