From 9d8a3f157467244246ce3059efac148ca11309f7 Mon Sep 17 00:00:00 2001 From: Andrii Vakarev <745407+avakarev@users.noreply.github.com> Date: Wed, 7 Jul 2021 01:54:59 +0200 Subject: [PATCH] Document helm chart (#127) --- README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/README.md b/README.md index 16188fbb..71a90bc6 100644 --- a/README.md +++ b/README.md @@ -47,6 +47,7 @@ For more details, see [Usage](#usage) - [Auto Discovery](#auto-discovery) - [Deploying](#deploying) - [Docker](#docker) +- [Helm Chart](#helm-chart) - [Running the tests](#running-the-tests) - [Using in Production](#using-in-production) - [FAQ](#faq) @@ -664,6 +665,19 @@ To build the image locally: docker build . -t twinproduction/gatus ``` +## Helm Chart + +[Helm](https://helm.sh) must be installed to use the chart. +Please refer to Helm's [documentation](https://helm.sh/docs/) to get started. + +Once Helm is set up properly, add the repo as follows: + +```console +helm repo add gatus https://avakarev.github.io/gatus-chart +``` + +To get more details, please check chart's [configuration](https://github.com/avakarev/gatus-chart#configuration) +and [helmfile example](https://github.com/avakarev/gatus-chart#helmfileyaml-example) ## Running the tests