Create a Control Plane Group

Uses: Kong Gateway Operator
Related Documentation
Incompatible with
on-prem
TL;DR

Create a KonnectGatewayControlPlane object, then create a Control Plane group using a KonnectGatewayControlPlane object with the CLUSTER_TYPE_CONTROL_PLANE_GROUP cluster type.

Prerequisites

If you don’t have a Konnect account, you can get started quickly with our onboarding wizard.

  1. The following Konnect items are required to complete this tutorial:
    • Personal access token (PAT): Create a new personal access token by opening the Konnect PAT page and selecting Generate Token.
  2. Set the personal access token as an environment variable:

    export KONNECT_TOKEN='YOUR KONNECT TOKEN'
    
    Copied to clipboard!

Create a KonnectGatewayControlPlane

Create a Control Plane using the KonnectGatewayControlPlane object:

echo '
kind: KonnectGatewayControlPlane
apiVersion: konnect.konghq.com/v1alpha1
metadata:
  name: gateway-control-plane
  namespace: kong
spec:
  name: gateway-control-plane
  konnect:
    authRef:
      name: konnect-api-auth
' | kubectl apply -f -
Copied to clipboard!

Create a KonnectGatewayControlPlane with members

Create a new KonnectGatewayControlPlane object, add the CLUSTER_TYPE_CONTROL_PLANE_GROUP cluster type, and add the Control Plane created in the previous step as a member:

echo '
kind: KonnectGatewayControlPlane
apiVersion: konnect.konghq.com/v1alpha1
metadata:
  name: control-plane-group
  namespace: kong
spec:
  name: control-plane-group
  cluster_type: CLUSTER_TYPE_CONTROL_PLANE_GROUP
  members:
  - name: gateway-control-plane
  konnect:
    authRef:
      name: konnect-api-auth
' | kubectl apply -f -
Copied to clipboard!

Validation

Check that Programmed is True on the control-plane-group resource:

You can verify the KonnectGatewayControlPlane was reconciled successfully by checking its Programmed condition.

kubectl get -n kong konnectgatewaycontrolplane control-plane-group \
  -o=jsonpath='{.status.conditions[?(@.type=="Programmed")]}' | jq
Copied to clipboard!

The output should look similar to this:

{
  "observedGeneration": 1,
  "reason": "Programmed",
  "status": "True",
  "type": "Programmed"
}
Copied to clipboard!

Did this doc help?

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!