Create a Consumer and Consumer Group
Use the KongConsumer and KongConsumerGroup CRDs to configure consumers and groups in Konnect Gateway Manager through your Kubernetes cluster.
Prerequisites
Kong Konnect
If you don’t have a Konnect account, you can get started quickly with our onboarding wizard.
- 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.
-
Set the personal access token as an environment variable:
export KONNECT_TOKEN='YOUR KONNECT TOKEN'
Kong Gateway Operator running
-
Add the Kong Helm charts:
helm repo add kong https://charts.konghq.com helm repo update -
Create a
kongnamespace:kubectl create namespace kong --dry-run=client -o yaml | kubectl apply -f - -
Install Kong Ingress Controller using Helm:
helm upgrade --install kgo kong/gateway-operator -n kong-system --create-namespace \ --set image.tag=1.5 \ --set kubernetes-configuration-crds.enabled=true \ --set env.ENABLE_CONTROLLER_KONNECT=true
Create a KonnectAPIAuthConfiguration resource
kubectl create namespace kong --dry-run=client -o yaml | kubectl apply -f -
echo '
kind: KonnectAPIAuthConfiguration
apiVersion: konnect.konghq.com/v1alpha1
metadata:
name: konnect-api-auth
namespace: kong
spec:
type: token
token: "'$KONNECT_TOKEN'"
serverURL: us.api.konghq.com
' | kubectl apply -f -
Create a KonnectGatewayControlPlane resource
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 -
Create a KongConsumer
Define a KongConsumer resource to provision a consumer in Konnect Gateway Manager.
echo '
kind: KongConsumer
apiVersion: configuration.konghq.com/v1
metadata:
name: consumer
namespace: kong
spec:
controlPlaneRef:
type: konnectNamespacedRef
konnectNamespacedRef:
name: gateway-control-plane
username: consumer
custom_id: '08433C12-2B81-4738-B61D-3AA2136F0212'
' | kubectl apply -f -
Create a KongConsumerGroup
Creating the KongConsumerGroup object in your Kubernetes cluster will provision a Konnect Consumer Group in your Gateway Manager.
echo '
kind: KongConsumerGroup
apiVersion: configuration.konghq.com/v1beta1
metadata:
name: consumer-group
namespace: kong
spec:
name: consumer-group
controlPlaneRef:
type: konnectNamespacedRef
konnectNamespacedRef:
name: gateway-control-plane
' | kubectl apply -f -
Associate a Consumer with a Consumer Group
Update the Consumer to include the consumerGroups field referencing the target group.
echo '
kind: KongConsumer
apiVersion: configuration.konghq.com/v1
metadata:
name: consumer
namespace: kong
spec:
controlPlaneRef:
type: konnectNamespacedRef
konnectNamespacedRef:
name: gateway-control-plane
username: consumer
custom_id: '08433C12-2B81-4738-B61D-3AA2136F0212'
consumerGroups:
- consumer-group
' | kubectl apply -f -
Validation
Check that Programmed is True on the consumer resource:
You can verify the KongConsumer was reconciled successfully by checking its Programmed condition.
kubectl get -n kong kongconsumer consumer \
-o=jsonpath='{.status.conditions[?(@.type=="Programmed")]}' | jq
The output should look similar to this:
{
"observedGeneration": 1,
"reason": "Programmed",
"status": "True",
"type": "Programmed"
}