Update README
This commit is contained in:
parent
661a5258e1
commit
8d04c2f684
1 changed files with 16 additions and 0 deletions
16
README.md
16
README.md
|
@ -4,12 +4,28 @@ This repository contains the official HashiCorp Helm chart for installing
|
||||||
and configuring Consul on Kubernetes. This chart supports multiple use
|
and configuring Consul on Kubernetes. This chart supports multiple use
|
||||||
cases of Consul on Kubernetes depending on the values provided.
|
cases of Consul on Kubernetes depending on the values provided.
|
||||||
|
|
||||||
|
Please see the [consul-k8s project](https://github.com/hashicorp/consul-k8s)
|
||||||
|
for the various ways that Consul integrates with Kubernetes. This Helm chart
|
||||||
|
installs and configures `consul-k8s` in some cases.
|
||||||
|
|
||||||
## Prerequisites
|
## Prerequisites
|
||||||
|
|
||||||
To use the charts here, [Helm](https://helm.sh/) must be installed in your
|
To use the charts here, [Helm](https://helm.sh/) must be installed in your
|
||||||
Kubernetes cluster. Setting up Kubernetes and Helm and is outside the scope
|
Kubernetes cluster. Setting up Kubernetes and Helm and is outside the scope
|
||||||
of this README. Please refer to the Kubernetes and Helm documentation.
|
of this README. Please refer to the Kubernetes and Helm documentation.
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
|
For now, we do not host a Chart repository. To use the charts, you must
|
||||||
|
download this repository and unpack it into a directory. Then, the chart can
|
||||||
|
be installed directly:
|
||||||
|
|
||||||
|
helm install ./charts/consul
|
||||||
|
|
||||||
|
Please see the many options supported in the `./charts/consul/values.yaml`
|
||||||
|
file. These are also fully documented directly on the
|
||||||
|
[Consul website](https://www.consul.io/docs/).
|
||||||
|
|
||||||
## Testing
|
## Testing
|
||||||
|
|
||||||
The Helm charts are tested in two forms: [Bats](https://github.com/bats-core/bats-core)
|
The Helm charts are tested in two forms: [Bats](https://github.com/bats-core/bats-core)
|
||||||
|
|
Loading…
Reference in a new issue