Installing with Helm (recommended)

Installing¶

The Aiven Operator for Kubernetes can be installed via Helm.

Before you start, make sure you have the prerequisites.

helm repo add aiven https://aiven.github.io/aiven-charts && helm repo update

Installing Custom Resource Definitions¶

helm install aiven-operator-crds aiven/aiven-operator-crds

Verify the installation:

kubectl api-resources --api-group=aiven.io

The output is similar to the following:

NAME                  SHORTNAMES   APIVERSION          NAMESPACED   KIND
connectionpools                    aiven.io/v1alpha1   true         ConnectionPool
databases                          aiven.io/v1alpha1   true         Database
... < several omitted lines >

Installing the Operator¶

helm install aiven-operator aiven/aiven-operator

Note

Installation will fail if webhooks are enabled and the CRDs for the cert-manager are not installed.

Verify the installation:

helm status aiven-operator

The output is similar to the following:

NAME: aiven-operator
LAST DEPLOYED: Fri Sep 10 15:23:26 2021
NAMESPACE: default
STATUS: deployed
REVISION: 1
TEST SUITE: None

It is also possible to install the operator without webhooks enabled:

helm install aiven-operator aiven/aiven-operator --set webhooks.enabled=false

Configuration Options¶

Please refer to the values.yaml of the chart.

Installing without full cluster administrator access¶

If the person installing the Helm chart does not have the necessary permissions to create cluster-wide resources such as ClusterRole and ClusterRoleBinding, a cluster administrator can manually install these roles. This ensures that the operator can function properly.

Uninstalling¶

Important

Please see this page for more information.

Find out the name of your deployment:

helm list

The output has the name of each deployment similar to the following:

NAME                NAMESPACE REVISION UPDATED                                  STATUS   CHART                      APP VERSION
aiven-operator      default   1        2021-09-09 10:56:14.623700249 +0200 CEST deployed aiven-operator-v0.1.0      v0.1.0
aiven-operator-crds default   1        2021-09-09 10:56:05.736411868 +0200 CEST deployed aiven-operator-crds-v0.1.0 v0.1.0

Remove the CRDs:

helm uninstall aiven-operator-crds

The confirmation message is similar to the following:

release "aiven-operator-crds" uninstalled

Remove the operator:

helm uninstall aiven-operator

The confirmation message is similar to the following:

release "aiven-operator" uninstalled