EDB Klio Operator Helm Chart v0.0.12

The EDB Klio Operator Helm chart from EDB allows you to deploy the Klio Operator in your Kubernetes cluster. It is distributed as a private OCI image.

Prerequisites

Before installing the Klio Operator, ensure you have:

• Helm – see the Helm installation guide
• Kubernetes cluster with appropriate permissions
• Credentials to access the registry hosting the Helm chart, the Klio operator image, and the Klio operand image. For the EDB registry, your username will be k8s and your password will be your EDB Repos 2.0 token.
• CloudNativePG Operator already installed in your Kubernetes cluster. See the CloudNativePG installation guide.
• cert-manager (optional, but strongly recommended for managing TLS certificates). See the cert-manager installation guide.
• Prometheus Operator (optional, for operator monitoring). See the Prometheus Operator installation guide.

Installation

For simplicity, the instructions below assume you've put the following values into environment variables:

• $TOKEN - will be your EDB Repos 2.0 token.
• $NAMESPACE - will be the namespace where you installed CNPG (cnpg-system is the default namespace for CNPG installations).

Example:

export TOKEN=your-edb-token
export NAMESPACE=cnpg-system

Step 1: Registry Authentication

First, authenticate with the EDB registry where the Helm chart is hosted:

helm registry login helm.oci.cloudsmith.io -u enterprisedb/k8s -p "${TOKEN}"

Step 2: Create an Image Pull Secret

Create a Kubernetes secret to allow the operator to pull container images from the registry:

kubectl create secret docker-registry klio-registry-secret \
  --docker-server=docker.enterprisedb.com \
  "--docker-username=k8s" \
  "--docker-password=${TOKEN}" \
  "--namespace "${NAMESPACE}"

Step 3: Install the Helm Chart

Deploy the Klio Operator to your cluster:

helm install klio-operator oci://helm.oci.cloudsmith.io/enterprisedb/k8s/klio-operator-chart \
  --version 0.0.12 \
  --namespace "${NAMESPACE}" \
  --set "controllerManager.manager.image.pullSecrets[0].name=klio-registry-secret"

Step 4: Verify Installation

After installation, verify that the Klio Operator is running:

kubectl get pods -n "${NAMESPACE}" -l app.kubernetes.io/name=klio

You should see the operator pod in a Running state. Check the logs to ensure there are no errors:

kubectl logs -n "${NAMESPACE}" deployment/klio-controller-manager -f

Verify that the Custom Resource Definitions (CRDs) were created:

kubectl get crds | grep klio.enterprisedb.io

You should see CRDs like servers.klio.enterprisedb.io and pluginconfigurations.klio.enterprisedb.io.

Configuration

Customizing the Installation

The chart is designed to be customizable, allowing you to configure multiple aspects of the Klio Operator deployment, passing in values through a custom values.yaml file or using the --set flag during installation. See the Helm documentation for more details on how to customize and manage Helm charts.

Inspecting the Chart

Before installing, you can download the Helm chart to inspect its contents, review the default values, and understand what resources it will create:

helm pull oci://docker.enterprisedb.com/k8s/klio-operator-chart --version 0.0.12

This downloads the chart as a .tgz file. Extract it to examine the templates, default values.yaml, and other chart files:

tar -xzf klio-operator-chart-0.0.12.tgz
cd klio-operator-chart
cat values.yaml

Configuration Reference

Upgrading

To upgrade the Klio Operator to a newer version:

helm upgrade klio-operator oci://docker.enterprisedb.com/k8s/klio-operator-chart \
  --version <NEW_VERSION> \
  --namespace "${NAMESPACE}"

...where <NEW_VERSION> is the version you're upgrading to.

When upgrading, you can control how Helm handles values from the previous installation. Please refer to the Helm upgrade documentation to understand the different options.

Uninstalling

To uninstall the Klio Operator:

helm uninstall klio-operator --namespace "${NAMESPACE}"

To remove the CRDs after uninstalling:

kubectl delete crd servers.klio.enterprisedb.io
kubectl delete crd pluginconfigurations.klio.enterprisedb.io