Skip to content

Commit

Permalink
Readme cleanup (#1) (hashicorp#623)
Browse files Browse the repository at this point in the history
* Main Consul k8s Readme and ArtifactHub readme cleanup
  • Loading branch information
David Yu authored Aug 18, 2021
1 parent 0106e4d commit 7dd5e08
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 7 deletions.
6 changes: 2 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,13 +30,11 @@ by contacting us at [[email protected]](mailto:[email protected]).
* [**Consul Service Mesh (Connect)**](https://www.consul.io/docs/k8s/connect):
Run Consul Service Mesh (aka Consul Connect) on Kubernetes. This feature
injects Envoy sidecars and registers your Pods with Consul.
_(Requires Consul 1.3+)_

* [**Catalog Sync**](https://www.consul.io/docs/k8s/service-sync):
Sync Consul services into first-class Kubernetes services and vice versa.
This enables Kubernetes to easily access external services and for
non-Kubernetes nodes to easily discover and access Kubernetes services.
_(Requires Consul 1.1+)_

## Installation

Expand Down Expand Up @@ -81,7 +79,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.20.1 1.7.2 Official HashiCorp Consul Chart
hashicorp/consul 0.33.0 1.10.0 Official HashiCorp Consul Chart

3. Now you're ready to install Consul! To install Consul with the default configuration using Helm 3 run:

Expand All @@ -95,4 +93,4 @@ file. These are also fully documented directly on the
# Tutorials

You can find examples and complete tutorials on how to deploy Consul on
Kubernetes using Helm on the [HashiCorp Learn website](https://learn.hashicorp.com/consul).
Kubernetes using Helm on the [HashiCorp Learn website](https://learn.hashicorp.com/consul).
4 changes: 1 addition & 3 deletions charts/consul/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,13 +19,11 @@ by contacting us at [[email protected]](mailto:[email protected]).
* [**Consul Service Mesh (Connect)**](https://www.consul.io/docs/k8s/connect):
Run Consul Service Mesh (aka Consul Connect) on Kubernetes. This feature
injects Envoy sidecars and registers your Pods with Consul.
_(Requires Consul 1.3+)_

* [**Catalog Sync**](https://www.consul.io/docs/k8s/service-sync):
Sync Consul services into first-class Kubernetes services and vice versa.
This enables Kubernetes to easily access external services and for
non-Kubernetes nodes to easily discover and access Kubernetes services.
_(Requires Consul 1.1+)_

### Prerequisites
* **Helm 3.0+** (Helm 2 is not supported)
Expand All @@ -46,7 +44,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.20.1 1.7.2 Official HashiCorp Consul Chart
hashicorp/consul 0.33.0 1.10.0 Official HashiCorp Consul Chart

3. Now you're ready to install Consul! To install Consul with the default configuration using Helm 3 run:

Expand Down

0 comments on commit 7dd5e08

Please sign in to comment.