Install Kong Operator in Konnect hybrid mode

Incompatible with
on-prem
Related Documentation
Minimum Version
- 1.6.1
TL;DR

Update the Helm repository and use Helm to install Kong Operator in Konnect.

Deploying Data Planes

Kong Operator can deploy and manage Data Planes attached to a Konnect Control Plane. All the Services, Routes, and plugins are configured in Konnect and sent to the Data Planes automatically.

Install CRDs

If you want to use Gateway API resources, run this command:

kubectl apply -f https://github.com/kubernetes-sigs/gateway-api/releases/download/v1.3.0/standard-install.yaml

Install Kong Operator

  1. Add the Kong Helm charts:

    helm repo add kong https://charts.konghq.com
    helm repo update
    
  2. Install Kong Gateway Operator using Helm:

    helm upgrade --install kong-operator kong/kong-operator -n kong-system \
      --create-namespace \
      --set image.tag=2.0.2 \
      --set env.ENABLE_CONTROLLER_KONNECT=true
    

If you want cert-manager to issue and rotate the admission and conversion webhook certificates, install cert-manager to your cluster and enable cert-manager integration by passing the following argument while installing:

--set global.webhooks.options.certManager.enabled=true

If you do not enable this, the chart will generate and inject self-signed certificates automatically. We recommend enabling cert-manager to manage the lifecycle of these certificates.

If you want cert-manager to issue and rotate the admission and conversion webhook certificates, install cert-manager to your cluster and enable cert-manager integration by passing the following argument while installing:

--set global.webhooks.options.certManager.enabled=true

If you do not enable this, the chart will generate and inject self-signed certificates automatically. We recommend enabling cert-manager to manage the lifecycle of these certificates.

Validate

Wait for Kong Operator to be ready

kubectl -n kong-system wait --for=condition=Available=true --timeout=120s deployment/kong-operator-kong-operator-controller-manager

You should see the following content on stdout:

deployment.apps/kong-operator-kong-operator-controller-manager condition met

Check the return code of the command to make sure it completed successfully:

if [[ $? -ne 0 ]]; then
  echo "Did not receive the expected return code"
fi

Once the kong-operator-kong-operator-controller-manager deployment is ready, you can deploy a DataPlane resource that is attached to a Konnect Gateway Control Plane. You can use this guide to learn more about how to do this.

Something wrong?

Help us make these docs great!

Kong Developer docs are open source. If you find these useful and want to make them better, contribute today!