You are browsing unreleased documentation. See the latest documentation here.

Consumer, Credentials and Consumer Group

In this guide you’ll learn how to use the KongConsumer and KongConsumerGroup custom resources to manage Kong Konnect Consumers and consumer groups natively from your Kubernetes cluster.

helm repo add kong https://charts.konghq.com
helm repo update kong

helm upgrade --install kgo kong/gateway-operator -n kong-system --create-namespace --set image.tag=nightly --set kubernetes-configuration-crds.enabled=true

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

echo '
kind: KonnectAPIAuthConfiguration
apiVersion: konnect.konghq.com/v1alpha1
metadata:
  name: konnect-api-auth
  namespace: default
spec:
  type: token
  token: kpat_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
  serverURL: eu.api.konghq.com
' | kubectl apply -f -

echo '
kind: KonnectAPIAuthConfiguration
apiVersion: konnect.konghq.com/v1alpha1
metadata:
  name: konnect-api-auth
  namespace: default
spec:
  type: secretRef
  secretRef:
    name: konnect-api-auth-secret
  serverURL: eu.api.konghq.com
---
kind: Secret
apiVersion: v1
metadata:
  name: konnect-api-auth-secret
  namespace: default
  labels:
    konghq.com/credential: konnect
stringData:
  token: kpat_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
' | kubectl apply -f -

kubectl get konnectapiauthconfiguration konnect-api-auth

NAME               VALID   ORGID                                  SERVERURL
konnect-api-auth   True    <your-konnect-org-id>                  https://eu.api.konghq.tech

echo '
kind: KonnectGatewayControlPlane
apiVersion: konnect.konghq.com/v1alpha1
metadata:
  name: gateway-control-plane
  namespace: default
spec:
  name: gateway-control-plane # Name used to identify the Gateway Control Plane in Konnect
  konnect:
    authRef:
      name: konnect-api-auth # Reference to the KonnectAPIAuthConfiguration object
  ' | kubectl apply -f -

kubectl get konnectgatewaycontrolplanes.konnect.konghq.com gateway-control-plane

NAME                    PROGRAMMED   ID                                     ORGID
gateway-control-plane   True         <konnect-control-plane-id>             <your-konnect-ord-id>

Create a consumer

Creating the KongConsumer object in your Kubernetes cluster will provision a Kong Konnect Consumer in your Gateway Manager. You can refer to the CR API to see all the available fields.

Your KongConsumer must be associated with a KonnectGatewayControlPlane object that you’ve created in your cluster. It will make it part of the Gateway Control Plane’s configuration.

You can create a KongConsumer by applying the following YAML manifest:

echo '
kind: KongConsumer
apiVersion: configuration.konghq.com/v1
metadata:
  name: consumer
  namespace: default
username: consumer
custom_id: 08433C12-2B81-4738-B61D-3AA2136F0212 # Optional
spec:
  controlPlaneRef:
    type: konnectNamespacedRef
    konnectNamespacedRef:
      name: gateway-control-plane # Reference to the KonnectGatewayControlPlane object
  ' | kubectl apply -f -

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

kubectl get kongconsumer consumer -o=jsonpath='{.status.conditions[?(@.type=="Programmed")]}' | jq

The output should look similar to this:

{
  "observedGeneration": 1,
  "reason": "Programmed",
  "status": "True",
  "type": "Programmed"
}

At this point, you should see the consumer in the Gateway Manager UI.

Associate the consumer with credentials

Consumers can have credentials associated with them. You can create one of the supported credential types. Please refer to the below custom resource’s documentation links to learn all the available fields for each credential type.

• KongCredentialBasicAuth
• KongCredentialKeyAuth
• KongCredentialACL
• KongCredentialJWT
• KongCredentialHMAC

For example, you can create a KongCredentialBasicAuth associated with the consumer KongConsumer by applying the following YAML manifest:

echo '
apiVersion: configuration.konghq.com/v1alpha1
kind: KongCredentialBasicAuth
metadata:
  name: basic-auth-cred
  namespace: default
spec:
  consumerRef:
    name: consumer # Reference to the KongConsumer object
  password: pass
  username: username
  ' | kubectl apply -f -

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

kubectl get kongcredentialbasicauth basic-auth-cred -o=jsonpath='{.status.conditions[?(@.type=="Programmed")]}' | jq

The output should look similar to this:

{
  "observedGeneration": 1,
  "reason": "Programmed",
  "status": "True",
  "type": "Programmed"
}

At this point, you should see the credential in the consumer’s credentials in the Gateway Manager UI.

Create a consumer group

Creating the KongConsumerGroup object in your Kubernetes cluster will provision a Kong Konnect consumer group in your Gateway Manager. Please refer to the KongConsumerGroup CR API to see all the available fields.

You can create a KongConsumerGroup by applying the following YAML manifest:

echo '
kind: KongConsumerGroup
apiVersion: configuration.konghq.com/v1beta1
metadata:
  name: consumer-group
  namespace: default
spec:
  name: consumer-group
  controlPlaneRef:
    type: konnectNamespacedRef
    konnectNamespacedRef:
      name: gateway-control-plane # Reference to the KonnectGatewayControlPlane object
' | kubectl apply -f -

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

kubectl get kongconsumergroup consumer-group -o=jsonpath='{.status.conditions[?(@.type=="Programmed")]}' | jq

The output should look similar to this:

{
  "observedGeneration": 1,
  "reason": "Programmed",
  "status": "True",
  "type": "Programmed"
}

At this point, you should see the consumer group in the Gateway Manager UI.

Associate a consumer with a consumer group

You can associate a KongConsumer with a KongConsumerGroup by modifying the KongConsumer object and adding the consumerGroups field. This field is a list of KongConsumerGroup names.

For example, you can associate the consumer KongConsumer with the consumer-group KongConsumerGroup by applying the following YAML manifest:

echo '
kind: KongConsumer
apiVersion: configuration.konghq.com/v1
metadata:
  name: consumer
  namespace: default
username: consumer
custom_id: 08433C12-2B81-4738-B61D-3AA2136F0212 # Optional
consumerGroups:
  - consumer-group # Reference to the KongConsumerGroup object
spec:
  controlPlaneRef:
    type: konnectNamespacedRef
    konnectNamespacedRef:
      name: gateway-control-plane # Reference to the KonnectGatewayControlPlane object
  ' | kubectl apply -f -

You can verify the KongConsumer’s consumerGroups field was reconciled successfully by checking its KongConsumerGroupRefsValid condition.

kubectl get kongconsumer consumer -o=jsonpath='{.status.conditions[?(@.type=="KongConsumerGroupRefsValid")]}' | jq

The output should look similar to this:

{
  "observedGeneration": 1,
  "reason": "Valid",
  "status": "True",
  "type": "KongConsumerGroupRefsValid"
}

At this point, you should see the consumer Consumer in the Consumer Group members in the Gateway Manager UI.