Installation via Helm

The StackGres operator can be installed using Helm version >= 3.1.1. As you may expect, a production environment will require you to install and set up additional components alongside your StackGres operator and cluster resources.

On this page, we are going through all the necessary steps to set up a production-grade StackGres environment using Helm.

Set Up StackGres Helm Repository

Add the StackGres Helm repository:

helm repo add stackgres-charts

StackGres Operator Installation

Install the operator:

helm install --create-namespace --namespace stackgres stackgres-operator stackgres-charts/stackgres-operator

You can specify the version adding --version <version, e.g. 1.0.0> to the Helm command.

For more installation options have a look at the Operator Parameters section for more information.

If you want to integrate Prometheus and Grafana into StackGres, please read the next section.

Installation With Monitoring

It’s also possible to install the StackGres operator with an integration of an existing Prometheus/Grafana monitoring stack. For this, it’s required to have a Prometheus/Grafana stack already installed on your cluster. The following examples use the Kube Prometheus Stack.

To install StackGres with monitoring, the StackGres operator is pointed to the existing monitoring resources:

helm install --create-namespace --namespace stackgres stackgres-operator \
 --set grafana.autoEmbed=true \
 --set-string grafana.webHost=prometheus-grafana.monitoring \
 --set-string grafana.secretNamespace=monitoring \
 --set-string grafana.secretName=prometheus-grafana \
 --set-string grafana.secretUserKey=admin-user \
 --set-string grafana.secretPasswordKey=admin-password \

Important: This example only works if you already have a running monitoring setup (here running in namespace monitoring), otherwise the StackGres installation will fail.

The example above is based on the Kube Prometheus Stack Helm chart. To install the full setup, run the following installation commands before you install StackGres, or have a look at the Monitoring guide.

helm repo add prometheus-community
helm repo add stable
helm repo update

helm install --create-namespace --namespace monitoring \
 --set grafana.enabled=true \
 prometheus prometheus-community/kube-prometheus-stack

The Monitoring guide explains this in greater detail.

Waiting for Operator Startup

Use the following command to wait until the StackGres operator is ready to use:

kubectl wait -n stackgres deployment -l --for=condition=Available

Once it’s ready, you will see that the operator pods are Running:

$ kubectl get pods -n stackgres -l
NAME                                  READY   STATUS    RESTARTS   AGE
stackgres-operator-78d57d4f55-pm8r2   1/1     Running   0          3m34s
stackgres-restapi-6ffd694fd5-hcpgp    2/2     Running   0          3m30s

Now we can continue with creating a StackGres cluster.