From baf03501749c0d8a6149ecb6196cc5fa32703269 Mon Sep 17 00:00:00 2001 From: Davide Bianchi <10374360+davidebianchi@users.noreply.github.com> Date: Sun, 17 Nov 2024 18:32:57 +0100 Subject: [PATCH] feat: add helm chart install documentation --- docs/installation/install.md | 20 +++++++++++++++++++- docs/installation/uninstall.md | 11 ++++++++++- 2 files changed, 29 insertions(+), 2 deletions(-) diff --git a/docs/installation/install.md b/docs/installation/install.md index 5ea11ae..40329bb 100644 --- a/docs/installation/install.md +++ b/docs/installation/install.md @@ -38,7 +38,25 @@ and see when the `kube-green-controller-manager` pod is up and running. *kube-green* has its own Helm chart which can be used to install the operator in the cluster. - +### 1. Add the Helm repository + +This repository is the source of kube-green charts. + +```sh +helm repo add kube-green https://kube-green.github.io/kube-green +``` + +### 2. Install kube-green + +To install the kube-green Helm chart, run: + +```sh +helm install kube-green kube-green/kube-green --namespace kube-green --create-namespace +``` + +### Installation options + +A full list of available Helm values is on the [Helm chart repository](https://github.com/kube-green/kube-green/tree/main/charts/kube-green). ## Operator Lifecycle Manager (OLM) diff --git a/docs/installation/uninstall.md b/docs/installation/uninstall.md index fff5795..f3daaac 100644 --- a/docs/installation/uninstall.md +++ b/docs/installation/uninstall.md @@ -53,11 +53,20 @@ To uninstall kube-green from the cluster, run: helm uninstall RELEASE_NAME ``` -where `RELEASE_NAME` is the name of the `kube-green` release currently installed. +where `RELEASE_NAME` is the name of the `kube-green` release currently installed (if you used the [install guide](./install.md#helm-chart), `kube-green`). This command, by default, will not delete the CRDs from the cluster, which should be deleted manually. If you have set the `crds.keep` value to *false* during the installation, also the CRDs will be deleted as well. +:::danger +This command will remove all `SleepInfo` resources from the cluster: + +```sh +kubectl delete crd sleepinfos.kube-green.io +``` + +::: + ## Operator Lifecycle Manager (OLM) To uninstall kube-green from the cluster, follow [this guide](https://olm.operatorframework.io/docs/tasks/uninstall-operator/).