Skip to content

Commit

Permalink
feat: add helm chart install documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
davidebianchi committed Nov 17, 2024
1 parent 214b792 commit baf0350
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 2 deletions.
20 changes: 19 additions & 1 deletion docs/installation/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

<!-- TODO: -->
### 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)

Expand Down
11 changes: 10 additions & 1 deletion docs/installation/uninstall.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/).

0 comments on commit baf0350

Please sign in to comment.