diff --git a/README.md b/README.md index de45c57..c509be5 100644 --- a/README.md +++ b/README.md @@ -11,6 +11,26 @@ This is a helm chart that deploys a [Krakend](https://www.krakend.io/) instance. A Helm chart for deploying krakend.io in Kubernetes provided and maintained by your friends at Equinix Metal +## Installation + +* Add the Equinix Metal helm repository +```bash +helm repo add equinixmetal https://helm.equinixmetal.com +``` + +* Install the helm chart using default values +```bash +helm install krakend equinixmetal/krakend +``` + +> If you are using your own chart, reference the following to your chart's dependencies: +> ```yaml +> dependencies: +> - name: krakend +> version: v0.1.16 +> repository: "https://helm.equinixmetal.com" +> ``` + ## Usage There are two main modes of operation: @@ -142,4 +162,4 @@ extraVolumes: secretName: krakend-license ``` -Note the mount of the license file in the `/etc/krakend/LICENSE` path. \ No newline at end of file +Note the mount of the license file in the `/etc/krakend/LICENSE` path. diff --git a/README.md.gotmpl b/README.md.gotmpl index 001d2d9..6ad472d 100644 --- a/README.md.gotmpl +++ b/README.md.gotmpl @@ -10,6 +10,26 @@ This is a helm chart that deploys a [Krakend](https://www.krakend.io/) instance. {{ template "chart.description" . }} +## Installation + +* Add the Equinix Metal helm repository +```bash +helm repo add equinixmetal https://helm.equinixmetal.com +``` + +* Install the helm chart using default values +```bash +helm install krakend equinixmetal/krakend +``` + +> If you are using your own chart, reference the following to your chart's dependencies: +> ```yaml +> dependencies: +> - name: krakend +> version: v0.1.16 +> repository: "https://helm.equinixmetal.com" +> ``` + ## Usage There are two main modes of operation: @@ -90,4 +110,4 @@ extraVolumes: secretName: krakend-license ``` -Note the mount of the license file in the `/etc/krakend/LICENSE` path. \ No newline at end of file +Note the mount of the license file in the `/etc/krakend/LICENSE` path.