SASL/OAUTHBEARER authenticationv3.15+
Authenticate to a Kafka broker using SASL/OAUTHBEARER. Kong Gateway fetches and renews OAuth 2.0 access tokens automatically using the client credentials grant.
Prerequisites
-
You have a Kafka cluster
-
You have a Kafka topic in the cluster
-
An OAuth 2.0 identity provider that supports the client credentials grant
Environment variables
-
BOOTSTRAP_SERVER_HOST: The bootstrap server host. -
KAFKA_TOPIC: The name of the Kafka topic to consume from. -
TOKEN_ENDPOINT_URL: The URL of the OAuth 2.0 token endpoint. -
CLIENT_ID: The OAuth 2.0 client ID. -
CLIENT_SECRET: The OAuth 2.0 client secret.
Add this section to your kong.yaml configuration file:
_format_version: "3.0"
plugins:
- name: kafka-consume
config:
bootstrap_servers:
- host: ${{ env "DECK_BOOTSTRAP_SERVER_HOST" }}
port: 9092
topics:
- name: ${{ env "DECK_KAFKA_TOPIC" }}
mode: http-get
authentication:
strategy: sasl
mechanism: OAUTHBEARER
oauthbearer:
token_endpoint_url: ${{ env "DECK_TOKEN_ENDPOINT_URL" }}
client_id: ${{ env "DECK_CLIENT_ID" }}
client_secret: ${{ env "DECK_CLIENT_SECRET" }}Make the following request:
curl -i -X POST http://localhost:8001/plugins/ \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--data '
{
"name": "kafka-consume",
"config": {
"bootstrap_servers": [
{
"host": "'$BOOTSTRAP_SERVER_HOST'",
"port": 9092
}
],
"topics": [
{
"name": "'$KAFKA_TOPIC'"
}
],
"mode": "http-get",
"authentication": {
"strategy": "sasl",
"mechanism": "OAUTHBEARER",
"oauthbearer": {
"token_endpoint_url": "'$TOKEN_ENDPOINT_URL'",
"client_id": "'$CLIENT_ID'",
"client_secret": "'$CLIENT_SECRET'"
}
}
},
"tags": []
}
'Make the following request:
curl -X POST https://{region}.api.konghq.com/v2/control-planes/{controlPlaneId}/core-entities/plugins/ \
--header "accept: application/json" \
--header "Content-Type: application/json" \
--header "Authorization: Bearer $KONNECT_TOKEN" \
--data '
{
"name": "kafka-consume",
"config": {
"bootstrap_servers": [
{
"host": "'$BOOTSTRAP_SERVER_HOST'",
"port": 9092
}
],
"topics": [
{
"name": "'$KAFKA_TOPIC'"
}
],
"mode": "http-get",
"authentication": {
"strategy": "sasl",
"mechanism": "OAUTHBEARER",
"oauthbearer": {
"token_endpoint_url": "'$TOKEN_ENDPOINT_URL'",
"client_id": "'$CLIENT_ID'",
"client_secret": "'$CLIENT_SECRET'"
}
}
},
"tags": []
}
'Make sure to replace the following placeholders with your own values:
-
region: Geographic region where your Kong Konnect is hosted and operates. -
KONNECT_TOKEN: Your Personal Access Token (PAT) associated with your Konnect account. -
controlPlaneId: Theidof the control plane.
See the Konnect API reference to learn about region-specific URLs and personal access tokens.
echo "
apiVersion: configuration.konghq.com/v1
kind: KongClusterPlugin
metadata:
name: kafka-consume
namespace: kong
annotations:
kubernetes.io/ingress.class: kong
konghq.com/tags: ''
labels:
global: 'true'
config:
bootstrap_servers:
- host: '$BOOTSTRAP_SERVER_HOST'
port: 9092
topics:
- name: '$KAFKA_TOPIC'
mode: http-get
authentication:
strategy: sasl
mechanism: OAUTHBEARER
oauthbearer:
token_endpoint_url: '$TOKEN_ENDPOINT_URL'
client_id: '$CLIENT_ID'
client_secret: '$CLIENT_SECRET'
plugin: kafka-consume
" | kubectl apply -f -Prerequisite: Configure your Personal Access Token
terraform {
required_providers {
konnect = {
source = "kong/konnect"
}
}
}
provider "konnect" {
personal_access_token = "$KONNECT_TOKEN"
server_url = "https://us.api.konghq.com/"
}Add the following to your Terraform configuration to create a Konnect Gateway Plugin:
resource "konnect_gateway_plugin_kafka_consume" "my_kafka_consume" {
enabled = true
config = {
bootstrap_servers = [
{
host = var.bootstrap_server_host
port = 9092
} ]
topics = [
{
name = var.kafka_topic
} ]
mode = "http-get"
authentication = {
strategy = "sasl"
mechanism = "OAUTHBEARER"
oauthbearer = {
token_endpoint_url = var.token_endpoint_url
client_id = var.client_id
client_secret = var.client_secret
}
}
}
tags = []
control_plane_id = konnect_gateway_control_plane.my_konnect_cp.id
}This example requires the following variables to be added to your manifest. You can specify values at runtime by setting TF_VAR_name=value.
variable "client_secret" {
type = string
}Add this section to your kong.yaml configuration file:
_format_version: "3.0"
plugins:
- name: kafka-consume
route: routeName|Id
config:
bootstrap_servers:
- host: ${{ env "DECK_BOOTSTRAP_SERVER_HOST" }}
port: 9092
topics:
- name: ${{ env "DECK_KAFKA_TOPIC" }}
mode: http-get
authentication:
strategy: sasl
mechanism: OAUTHBEARER
oauthbearer:
token_endpoint_url: ${{ env "DECK_TOKEN_ENDPOINT_URL" }}
client_id: ${{ env "DECK_CLIENT_ID" }}
client_secret: ${{ env "DECK_CLIENT_SECRET" }}Make sure to replace the following placeholders with your own values:
-
routeName|Id: Theidornameof the route the plugin configuration will target.
Make the following request:
curl -i -X POST http://localhost:8001/routes/{routeName|Id}/plugins/ \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--data '
{
"name": "kafka-consume",
"config": {
"bootstrap_servers": [
{
"host": "'$BOOTSTRAP_SERVER_HOST'",
"port": 9092
}
],
"topics": [
{
"name": "'$KAFKA_TOPIC'"
}
],
"mode": "http-get",
"authentication": {
"strategy": "sasl",
"mechanism": "OAUTHBEARER",
"oauthbearer": {
"token_endpoint_url": "'$TOKEN_ENDPOINT_URL'",
"client_id": "'$CLIENT_ID'",
"client_secret": "'$CLIENT_SECRET'"
}
}
},
"tags": []
}
'Make sure to replace the following placeholders with your own values:
-
routeName|Id: Theidornameof the route the plugin configuration will target.
Make the following request:
curl -X POST https://{region}.api.konghq.com/v2/control-planes/{controlPlaneId}/core-entities/routes/{routeId}/plugins/ \
--header "accept: application/json" \
--header "Content-Type: application/json" \
--header "Authorization: Bearer $KONNECT_TOKEN" \
--data '
{
"name": "kafka-consume",
"config": {
"bootstrap_servers": [
{
"host": "'$BOOTSTRAP_SERVER_HOST'",
"port": 9092
}
],
"topics": [
{
"name": "'$KAFKA_TOPIC'"
}
],
"mode": "http-get",
"authentication": {
"strategy": "sasl",
"mechanism": "OAUTHBEARER",
"oauthbearer": {
"token_endpoint_url": "'$TOKEN_ENDPOINT_URL'",
"client_id": "'$CLIENT_ID'",
"client_secret": "'$CLIENT_SECRET'"
}
}
},
"tags": []
}
'Make sure to replace the following placeholders with your own values:
-
region: Geographic region where your Kong Konnect is hosted and operates. -
KONNECT_TOKEN: Your Personal Access Token (PAT) associated with your Konnect account. -
controlPlaneId: Theidof the control plane. -
routeId: Theidof the route the plugin configuration will target.
See the Konnect API reference to learn about region-specific URLs and personal access tokens.
echo "
apiVersion: configuration.konghq.com/v1
kind: KongPlugin
metadata:
name: kafka-consume
namespace: kong
annotations:
kubernetes.io/ingress.class: kong
konghq.com/tags: ''
config:
bootstrap_servers:
- host: '$BOOTSTRAP_SERVER_HOST'
port: 9092
topics:
- name: '$KAFKA_TOPIC'
mode: http-get
authentication:
strategy: sasl
mechanism: OAUTHBEARER
oauthbearer:
token_endpoint_url: '$TOKEN_ENDPOINT_URL'
client_id: '$CLIENT_ID'
client_secret: '$CLIENT_SECRET'
plugin: kafka-consume
" | kubectl apply -f -Next, apply the KongPlugin resource by annotating the httproute or ingress resource:
kubectl annotate -n kong httproute konghq.com/plugins=kafka-consumekubectl annotate -n kong ingress konghq.com/plugins=kafka-consumePrerequisite: Configure your Personal Access Token
terraform {
required_providers {
konnect = {
source = "kong/konnect"
}
}
}
provider "konnect" {
personal_access_token = "$KONNECT_TOKEN"
server_url = "https://us.api.konghq.com/"
}Add the following to your Terraform configuration to create a Konnect Gateway Plugin:
resource "konnect_gateway_plugin_kafka_consume" "my_kafka_consume" {
enabled = true
config = {
bootstrap_servers = [
{
host = var.bootstrap_server_host
port = 9092
} ]
topics = [
{
name = var.kafka_topic
} ]
mode = "http-get"
authentication = {
strategy = "sasl"
mechanism = "OAUTHBEARER"
oauthbearer = {
token_endpoint_url = var.token_endpoint_url
client_id = var.client_id
client_secret = var.client_secret
}
}
}
tags = []
control_plane_id = konnect_gateway_control_plane.my_konnect_cp.id
route = {
id = konnect_gateway_route.my_route.id
}
}This example requires the following variables to be added to your manifest. You can specify values at runtime by setting TF_VAR_name=value.
variable "client_secret" {
type = string
}Add this section to your kong.yaml configuration file:
_format_version: "3.0"
plugins:
- name: kafka-consume
consumer: consumerName|Id
config:
bootstrap_servers:
- host: ${{ env "DECK_BOOTSTRAP_SERVER_HOST" }}
port: 9092
topics:
- name: ${{ env "DECK_KAFKA_TOPIC" }}
mode: http-get
authentication:
strategy: sasl
mechanism: OAUTHBEARER
oauthbearer:
token_endpoint_url: ${{ env "DECK_TOKEN_ENDPOINT_URL" }}
client_id: ${{ env "DECK_CLIENT_ID" }}
client_secret: ${{ env "DECK_CLIENT_SECRET" }}Make sure to replace the following placeholders with your own values:
-
consumerName|Id: Theidornameof the consumer the plugin configuration will target.
Make the following request:
curl -i -X POST http://localhost:8001/consumers/{consumerName|Id}/plugins/ \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--data '
{
"name": "kafka-consume",
"config": {
"bootstrap_servers": [
{
"host": "'$BOOTSTRAP_SERVER_HOST'",
"port": 9092
}
],
"topics": [
{
"name": "'$KAFKA_TOPIC'"
}
],
"mode": "http-get",
"authentication": {
"strategy": "sasl",
"mechanism": "OAUTHBEARER",
"oauthbearer": {
"token_endpoint_url": "'$TOKEN_ENDPOINT_URL'",
"client_id": "'$CLIENT_ID'",
"client_secret": "'$CLIENT_SECRET'"
}
}
},
"tags": []
}
'Make sure to replace the following placeholders with your own values:
-
consumerName|Id: Theidornameof the consumer the plugin configuration will target.
Make the following request:
curl -X POST https://{region}.api.konghq.com/v2/control-planes/{controlPlaneId}/core-entities/consumers/{consumerId}/plugins/ \
--header "accept: application/json" \
--header "Content-Type: application/json" \
--header "Authorization: Bearer $KONNECT_TOKEN" \
--data '
{
"name": "kafka-consume",
"config": {
"bootstrap_servers": [
{
"host": "'$BOOTSTRAP_SERVER_HOST'",
"port": 9092
}
],
"topics": [
{
"name": "'$KAFKA_TOPIC'"
}
],
"mode": "http-get",
"authentication": {
"strategy": "sasl",
"mechanism": "OAUTHBEARER",
"oauthbearer": {
"token_endpoint_url": "'$TOKEN_ENDPOINT_URL'",
"client_id": "'$CLIENT_ID'",
"client_secret": "'$CLIENT_SECRET'"
}
}
},
"tags": []
}
'Make sure to replace the following placeholders with your own values:
-
region: Geographic region where your Kong Konnect is hosted and operates. -
KONNECT_TOKEN: Your Personal Access Token (PAT) associated with your Konnect account. -
controlPlaneId: Theidof the control plane. -
consumerId: Theidof the consumer the plugin configuration will target.
See the Konnect API reference to learn about region-specific URLs and personal access tokens.
echo "
apiVersion: configuration.konghq.com/v1
kind: KongPlugin
metadata:
name: kafka-consume
namespace: kong
annotations:
kubernetes.io/ingress.class: kong
konghq.com/tags: ''
config:
bootstrap_servers:
- host: '$BOOTSTRAP_SERVER_HOST'
port: 9092
topics:
- name: '$KAFKA_TOPIC'
mode: http-get
authentication:
strategy: sasl
mechanism: OAUTHBEARER
oauthbearer:
token_endpoint_url: '$TOKEN_ENDPOINT_URL'
client_id: '$CLIENT_ID'
client_secret: '$CLIENT_SECRET'
plugin: kafka-consume
" | kubectl apply -f -Next, apply the KongPlugin resource by annotating the KongConsumer resource:
kubectl annotate -n kong kongconsumer CONSUMER_NAME konghq.com/plugins=kafka-consumePrerequisite: Configure your Personal Access Token
terraform {
required_providers {
konnect = {
source = "kong/konnect"
}
}
}
provider "konnect" {
personal_access_token = "$KONNECT_TOKEN"
server_url = "https://us.api.konghq.com/"
}Add the following to your Terraform configuration to create a Konnect Gateway Plugin:
resource "konnect_gateway_plugin_kafka_consume" "my_kafka_consume" {
enabled = true
config = {
bootstrap_servers = [
{
host = var.bootstrap_server_host
port = 9092
} ]
topics = [
{
name = var.kafka_topic
} ]
mode = "http-get"
authentication = {
strategy = "sasl"
mechanism = "OAUTHBEARER"
oauthbearer = {
token_endpoint_url = var.token_endpoint_url
client_id = var.client_id
client_secret = var.client_secret
}
}
}
tags = []
control_plane_id = konnect_gateway_control_plane.my_konnect_cp.id
consumer = {
id = konnect_gateway_consumer.my_consumer.id
}
}This example requires the following variables to be added to your manifest. You can specify values at runtime by setting TF_VAR_name=value.
variable "client_secret" {
type = string
}