diff --git a/docs/index.md b/docs/index.md index 018f058..0640fb0 100644 --- a/docs/index.md +++ b/docs/index.md @@ -45,9 +45,9 @@ After the reconciliation you should be able to find a `ConfigMap` and a `Secret` We distribute DB Operator as a `helm` chart. You don't have to use it, but if you want to be able to get support, it's would be easier for us if you use the chart. -The charts is released as s simple help repo as well as a an OCI artifact. +The charts are released as s simple helm repo as well as a an OCI artifact. -To install the repo, run the following +To use the repo, run the following: ```sh $ helm repo add db-operator https://db-operator.github.io/charts diff --git a/docs/install_helm.md b/docs/install_helm.md new file mode 100644 index 0000000..50c6ea5 --- /dev/null +++ b/docs/install_helm.md @@ -0,0 +1,32 @@ +# Install with Helm + +## Getting started + +The only officially supported way to install DB Operator is using a helm chart. + +You can find the source code of our helm charts here: + +The charts are released as s simple helm repo as well as a an OCI artifact. + +To install the repo, run the following + +```sh +$ helm repo add db-operator https://db-operator.github.io/charts +$ helm search repo db-operator +``` + +OCI artifacts are available under `ghcr.io/db-operator/charts/` + +To install the chart, run the following: + +```sh +$ helm install db-operator/db-operator +# -- Or OCI +$ helm install ghcr.io/db-operator/charts/db-operator:${CHART_VERSION} +``` + +More info about the db-operator chart can be found in the [README.md](https://github.com/db-operator/charts/tree/main/charts/db-operator) + +## Configure the operator via values + +> @allanger chart will be updated soon, and then I'll write a better docs