Conditionally fetch or store cache datav3.12+
This example leverages the cache and branch nodes to conditionally store or retrieve
cache items.
The cache node requires a cache resource. In this example, we use an in-memory cache resource.
For all options, see the cache resource reference.
Note: When using the
branchnode, thethenandelseparameters must list all nodes for both branches. If a node isn’t listed in the branch, the node will run depending on its location in the flow configuration.
Add this section to your kong.yaml configuration file:
kong.yaml
Copied!
_format_version: "3.0"
plugins:
- name: datakit
config:
resources:
cache:
strategy: memory
nodes:
- type: static
values:
key: cache key
name: CACHE_KEY_GET
- type: cache
input: CACHE_KEY_GET
ttl: 200
name: GET
- type: branch
then:
- DATA
- SET
- EXIT_MISS
else:
- EXIT_HIT
input: GET.miss
name: branch
- type: call
method: GET
url: http://localhost:8080/anything
name: DATA
- type: static
values:
hit:
x-hit: true
ttl: 100
miss:
x-miss: true
key: cache key
name: VALUES
- type: cache
inputs:
key: VALUES.key
data: DATA
ttl: VALUES.ttl
name: SET
- inputs:
headers: VALUES.miss
body: DATA
type: exit
status: 200
name: EXIT_MISS
- inputs:
headers: VALUES.hit
body: GET.data
type: exit
status: 200
name: EXIT_HIT
Make the following request:
curl -i -X POST http://localhost:8001/plugins/ \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--data '
{
"name": "datakit",
"config": {
"resources": {
"cache": {
"strategy": "memory"
}
},
"nodes": [
{
"type": "static",
"values": {
"key": "cache key"
},
"name": "CACHE_KEY_GET"
},
{
"type": "cache",
"input": "CACHE_KEY_GET",
"ttl": 200,
"name": "GET"
},
{
"type": "branch",
"then": [
"DATA",
"SET",
"EXIT_MISS"
],
"else": [
"EXIT_HIT"
],
"input": "GET.miss",
"name": "branch"
},
{
"type": "call",
"method": "GET",
"url": "http://localhost:8080/anything",
"name": "DATA"
},
{
"type": "static",
"values": {
"hit": {
"x-hit": true
},
"ttl": 100,
"miss": {
"x-miss": true
},
"key": "cache key"
},
"name": "VALUES"
},
{
"type": "cache",
"inputs": {
"key": "VALUES.key",
"data": "DATA",
"ttl": "VALUES.ttl"
},
"name": "SET"
},
{
"inputs": {
"headers": "VALUES.miss",
"body": "DATA"
},
"type": "exit",
"status": 200,
"name": "EXIT_MISS"
},
{
"inputs": {
"headers": "VALUES.hit",
"body": "GET.data"
},
"type": "exit",
"status": 200,
"name": "EXIT_HIT"
}
]
}
}
'
Copied!
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": "datakit",
"config": {
"resources": {
"cache": {
"strategy": "memory"
}
},
"nodes": [
{
"type": "static",
"values": {
"key": "cache key"
},
"name": "CACHE_KEY_GET"
},
{
"type": "cache",
"input": "CACHE_KEY_GET",
"ttl": 200,
"name": "GET"
},
{
"type": "branch",
"then": [
"DATA",
"SET",
"EXIT_MISS"
],
"else": [
"EXIT_HIT"
],
"input": "GET.miss",
"name": "branch"
},
{
"type": "call",
"method": "GET",
"url": "http://localhost:8080/anything",
"name": "DATA"
},
{
"type": "static",
"values": {
"hit": {
"x-hit": true
},
"ttl": 100,
"miss": {
"x-miss": true
},
"key": "cache key"
},
"name": "VALUES"
},
{
"type": "cache",
"inputs": {
"key": "VALUES.key",
"data": "DATA",
"ttl": "VALUES.ttl"
},
"name": "SET"
},
{
"inputs": {
"headers": "VALUES.miss",
"body": "DATA"
},
"type": "exit",
"status": 200,
"name": "EXIT_MISS"
},
{
"inputs": {
"headers": "VALUES.hit",
"body": "GET.data"
},
"type": "exit",
"status": 200,
"name": "EXIT_HIT"
}
]
}
}
'
Copied!
Make sure to replace the following placeholders with your own values:
-
region: Geographic region where your Kong Konnect is hosted and operates. -
controlPlaneId: Theidof the control plane. -
KONNECT_TOKEN: Your Personal Access Token (PAT) associated with your Konnect account.
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: datakit
namespace: kong
annotations:
kubernetes.io/ingress.class: kong
labels:
global: 'true'
config:
resources:
cache:
strategy: memory
nodes:
- type: static
values:
key: cache key
name: CACHE_KEY_GET
- type: cache
input: CACHE_KEY_GET
ttl: 200
name: GET
- type: branch
then:
- DATA
- SET
- EXIT_MISS
else:
- EXIT_HIT
input: GET.miss
name: branch
- type: call
method: GET
url: http://localhost:8080/anything
name: DATA
- type: static
values:
hit:
x-hit: true
ttl: 100
miss:
x-miss: true
key: cache key
name: VALUES
- type: cache
inputs:
key: VALUES.key
data: DATA
ttl: VALUES.ttl
name: SET
- inputs:
headers: VALUES.miss
body: DATA
type: exit
status: 200
name: EXIT_MISS
- inputs:
headers: VALUES.hit
body: GET.data
type: exit
status: 200
name: EXIT_HIT
plugin: datakit
" | kubectl apply -f -
Copied!
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/"
}
Copied!
Add the following to your Terraform configuration to create a Konnect Gateway Plugin:
resource "konnect_gateway_plugin_datakit" "my_datakit" {
enabled = true
config = {
resources = {
cache = {
strategy = "memory"
}
}
nodes = [
{
type = "static"
values = {
key = "cache key"
}
name = "CACHE_KEY_GET"
},
{
type = "cache"
input = "CACHE_KEY_GET"
ttl = 200
name = "GET"
},
{
type = "branch"
then = ["DATA", "SET", "EXIT_MISS"]
else = ["EXIT_HIT"]
input = "GET.miss"
name = "branch"
},
{
type = "call"
method = "GET"
url = "http://localhost:8080/anything"
name = "DATA"
},
{
type = "static"
values = {
hit = {
x-hit = true
}
ttl = 100
miss = {
x-miss = true
}
key = "cache key"
}
name = "VALUES"
},
{
type = "cache"
inputs = {
key = "VALUES.key"
data = "DATA"
ttl = "VALUES.ttl"
}
name = "SET"
},
{
inputs = {
headers = "VALUES.miss"
body = "DATA"
}
type = "exit"
status = 200
name = "EXIT_MISS"
},
{
inputs = {
headers = "VALUES.hit"
body = "GET.data"
}
type = "exit"
status = 200
name = "EXIT_HIT"
} ]
}
control_plane_id = konnect_gateway_control_plane.my_konnect_cp.id
}
Copied!
Add this section to your kong.yaml configuration file:
kong.yaml
Copied!
_format_version: "3.0"
plugins:
- name: datakit
service: serviceName|Id
config:
resources:
cache:
strategy: memory
nodes:
- type: static
values:
key: cache key
name: CACHE_KEY_GET
- type: cache
input: CACHE_KEY_GET
ttl: 200
name: GET
- type: branch
then:
- DATA
- SET
- EXIT_MISS
else:
- EXIT_HIT
input: GET.miss
name: branch
- type: call
method: GET
url: http://localhost:8080/anything
name: DATA
- type: static
values:
hit:
x-hit: true
ttl: 100
miss:
x-miss: true
key: cache key
name: VALUES
- type: cache
inputs:
key: VALUES.key
data: DATA
ttl: VALUES.ttl
name: SET
- inputs:
headers: VALUES.miss
body: DATA
type: exit
status: 200
name: EXIT_MISS
- inputs:
headers: VALUES.hit
body: GET.data
type: exit
status: 200
name: EXIT_HIT
Make sure to replace the following placeholders with your own values:
-
serviceName|Id: Theidornameof the service the plugin configuration will target.
Make the following request:
curl -i -X POST http://localhost:8001/services/{serviceName|Id}/plugins/ \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--data '
{
"name": "datakit",
"config": {
"resources": {
"cache": {
"strategy": "memory"
}
},
"nodes": [
{
"type": "static",
"values": {
"key": "cache key"
},
"name": "CACHE_KEY_GET"
},
{
"type": "cache",
"input": "CACHE_KEY_GET",
"ttl": 200,
"name": "GET"
},
{
"type": "branch",
"then": [
"DATA",
"SET",
"EXIT_MISS"
],
"else": [
"EXIT_HIT"
],
"input": "GET.miss",
"name": "branch"
},
{
"type": "call",
"method": "GET",
"url": "http://localhost:8080/anything",
"name": "DATA"
},
{
"type": "static",
"values": {
"hit": {
"x-hit": true
},
"ttl": 100,
"miss": {
"x-miss": true
},
"key": "cache key"
},
"name": "VALUES"
},
{
"type": "cache",
"inputs": {
"key": "VALUES.key",
"data": "DATA",
"ttl": "VALUES.ttl"
},
"name": "SET"
},
{
"inputs": {
"headers": "VALUES.miss",
"body": "DATA"
},
"type": "exit",
"status": 200,
"name": "EXIT_MISS"
},
{
"inputs": {
"headers": "VALUES.hit",
"body": "GET.data"
},
"type": "exit",
"status": 200,
"name": "EXIT_HIT"
}
]
}
}
'
Copied!
Make sure to replace the following placeholders with your own values:
-
serviceName|Id: Theidornameof the service the plugin configuration will target.
Make the following request:
curl -X POST https://{region}.api.konghq.com/v2/control-planes/{controlPlaneId}/core-entities/services/{serviceId}/plugins/ \
--header "accept: application/json" \
--header "Content-Type: application/json" \
--header "Authorization: Bearer $KONNECT_TOKEN" \
--data '
{
"name": "datakit",
"config": {
"resources": {
"cache": {
"strategy": "memory"
}
},
"nodes": [
{
"type": "static",
"values": {
"key": "cache key"
},
"name": "CACHE_KEY_GET"
},
{
"type": "cache",
"input": "CACHE_KEY_GET",
"ttl": 200,
"name": "GET"
},
{
"type": "branch",
"then": [
"DATA",
"SET",
"EXIT_MISS"
],
"else": [
"EXIT_HIT"
],
"input": "GET.miss",
"name": "branch"
},
{
"type": "call",
"method": "GET",
"url": "http://localhost:8080/anything",
"name": "DATA"
},
{
"type": "static",
"values": {
"hit": {
"x-hit": true
},
"ttl": 100,
"miss": {
"x-miss": true
},
"key": "cache key"
},
"name": "VALUES"
},
{
"type": "cache",
"inputs": {
"key": "VALUES.key",
"data": "DATA",
"ttl": "VALUES.ttl"
},
"name": "SET"
},
{
"inputs": {
"headers": "VALUES.miss",
"body": "DATA"
},
"type": "exit",
"status": 200,
"name": "EXIT_MISS"
},
{
"inputs": {
"headers": "VALUES.hit",
"body": "GET.data"
},
"type": "exit",
"status": 200,
"name": "EXIT_HIT"
}
]
}
}
'
Copied!
Make sure to replace the following placeholders with your own values:
-
region: Geographic region where your Kong Konnect is hosted and operates. -
controlPlaneId: Theidof the control plane. -
KONNECT_TOKEN: Your Personal Access Token (PAT) associated with your Konnect account. -
serviceId: Theidof the service 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: datakit
namespace: kong
annotations:
kubernetes.io/ingress.class: kong
config:
resources:
cache:
strategy: memory
nodes:
- type: static
values:
key: cache key
name: CACHE_KEY_GET
- type: cache
input: CACHE_KEY_GET
ttl: 200
name: GET
- type: branch
then:
- DATA
- SET
- EXIT_MISS
else:
- EXIT_HIT
input: GET.miss
name: branch
- type: call
method: GET
url: http://localhost:8080/anything
name: DATA
- type: static
values:
hit:
x-hit: true
ttl: 100
miss:
x-miss: true
key: cache key
name: VALUES
- type: cache
inputs:
key: VALUES.key
data: DATA
ttl: VALUES.ttl
name: SET
- inputs:
headers: VALUES.miss
body: DATA
type: exit
status: 200
name: EXIT_MISS
- inputs:
headers: VALUES.hit
body: GET.data
type: exit
status: 200
name: EXIT_HIT
plugin: datakit
" | kubectl apply -f -
Copied!
Next, apply the KongPlugin resource by annotating the service resource:
kubectl annotate -n kong service SERVICE_NAME konghq.com/plugins=datakit
Copied!
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/"
}
Copied!
Add the following to your Terraform configuration to create a Konnect Gateway Plugin:
resource "konnect_gateway_plugin_datakit" "my_datakit" {
enabled = true
config = {
resources = {
cache = {
strategy = "memory"
}
}
nodes = [
{
type = "static"
values = {
key = "cache key"
}
name = "CACHE_KEY_GET"
},
{
type = "cache"
input = "CACHE_KEY_GET"
ttl = 200
name = "GET"
},
{
type = "branch"
then = ["DATA", "SET", "EXIT_MISS"]
else = ["EXIT_HIT"]
input = "GET.miss"
name = "branch"
},
{
type = "call"
method = "GET"
url = "http://localhost:8080/anything"
name = "DATA"
},
{
type = "static"
values = {
hit = {
x-hit = true
}
ttl = 100
miss = {
x-miss = true
}
key = "cache key"
}
name = "VALUES"
},
{
type = "cache"
inputs = {
key = "VALUES.key"
data = "DATA"
ttl = "VALUES.ttl"
}
name = "SET"
},
{
inputs = {
headers = "VALUES.miss"
body = "DATA"
}
type = "exit"
status = 200
name = "EXIT_MISS"
},
{
inputs = {
headers = "VALUES.hit"
body = "GET.data"
}
type = "exit"
status = 200
name = "EXIT_HIT"
} ]
}
control_plane_id = konnect_gateway_control_plane.my_konnect_cp.id
service = {
id = konnect_gateway_service.my_service.id
}
}
Copied!
Add this section to your kong.yaml configuration file:
kong.yaml
Copied!
_format_version: "3.0"
plugins:
- name: datakit
route: routeName|Id
config:
resources:
cache:
strategy: memory
nodes:
- type: static
values:
key: cache key
name: CACHE_KEY_GET
- type: cache
input: CACHE_KEY_GET
ttl: 200
name: GET
- type: branch
then:
- DATA
- SET
- EXIT_MISS
else:
- EXIT_HIT
input: GET.miss
name: branch
- type: call
method: GET
url: http://localhost:8080/anything
name: DATA
- type: static
values:
hit:
x-hit: true
ttl: 100
miss:
x-miss: true
key: cache key
name: VALUES
- type: cache
inputs:
key: VALUES.key
data: DATA
ttl: VALUES.ttl
name: SET
- inputs:
headers: VALUES.miss
body: DATA
type: exit
status: 200
name: EXIT_MISS
- inputs:
headers: VALUES.hit
body: GET.data
type: exit
status: 200
name: EXIT_HIT
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": "datakit",
"config": {
"resources": {
"cache": {
"strategy": "memory"
}
},
"nodes": [
{
"type": "static",
"values": {
"key": "cache key"
},
"name": "CACHE_KEY_GET"
},
{
"type": "cache",
"input": "CACHE_KEY_GET",
"ttl": 200,
"name": "GET"
},
{
"type": "branch",
"then": [
"DATA",
"SET",
"EXIT_MISS"
],
"else": [
"EXIT_HIT"
],
"input": "GET.miss",
"name": "branch"
},
{
"type": "call",
"method": "GET",
"url": "http://localhost:8080/anything",
"name": "DATA"
},
{
"type": "static",
"values": {
"hit": {
"x-hit": true
},
"ttl": 100,
"miss": {
"x-miss": true
},
"key": "cache key"
},
"name": "VALUES"
},
{
"type": "cache",
"inputs": {
"key": "VALUES.key",
"data": "DATA",
"ttl": "VALUES.ttl"
},
"name": "SET"
},
{
"inputs": {
"headers": "VALUES.miss",
"body": "DATA"
},
"type": "exit",
"status": 200,
"name": "EXIT_MISS"
},
{
"inputs": {
"headers": "VALUES.hit",
"body": "GET.data"
},
"type": "exit",
"status": 200,
"name": "EXIT_HIT"
}
]
}
}
'
Copied!
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": "datakit",
"config": {
"resources": {
"cache": {
"strategy": "memory"
}
},
"nodes": [
{
"type": "static",
"values": {
"key": "cache key"
},
"name": "CACHE_KEY_GET"
},
{
"type": "cache",
"input": "CACHE_KEY_GET",
"ttl": 200,
"name": "GET"
},
{
"type": "branch",
"then": [
"DATA",
"SET",
"EXIT_MISS"
],
"else": [
"EXIT_HIT"
],
"input": "GET.miss",
"name": "branch"
},
{
"type": "call",
"method": "GET",
"url": "http://localhost:8080/anything",
"name": "DATA"
},
{
"type": "static",
"values": {
"hit": {
"x-hit": true
},
"ttl": 100,
"miss": {
"x-miss": true
},
"key": "cache key"
},
"name": "VALUES"
},
{
"type": "cache",
"inputs": {
"key": "VALUES.key",
"data": "DATA",
"ttl": "VALUES.ttl"
},
"name": "SET"
},
{
"inputs": {
"headers": "VALUES.miss",
"body": "DATA"
},
"type": "exit",
"status": 200,
"name": "EXIT_MISS"
},
{
"inputs": {
"headers": "VALUES.hit",
"body": "GET.data"
},
"type": "exit",
"status": 200,
"name": "EXIT_HIT"
}
]
}
}
'
Copied!
Make sure to replace the following placeholders with your own values:
-
region: Geographic region where your Kong Konnect is hosted and operates. -
controlPlaneId: Theidof the control plane. -
KONNECT_TOKEN: Your Personal Access Token (PAT) associated with your Konnect account. -
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: datakit
namespace: kong
annotations:
kubernetes.io/ingress.class: kong
config:
resources:
cache:
strategy: memory
nodes:
- type: static
values:
key: cache key
name: CACHE_KEY_GET
- type: cache
input: CACHE_KEY_GET
ttl: 200
name: GET
- type: branch
then:
- DATA
- SET
- EXIT_MISS
else:
- EXIT_HIT
input: GET.miss
name: branch
- type: call
method: GET
url: http://localhost:8080/anything
name: DATA
- type: static
values:
hit:
x-hit: true
ttl: 100
miss:
x-miss: true
key: cache key
name: VALUES
- type: cache
inputs:
key: VALUES.key
data: DATA
ttl: VALUES.ttl
name: SET
- inputs:
headers: VALUES.miss
body: DATA
type: exit
status: 200
name: EXIT_MISS
- inputs:
headers: VALUES.hit
body: GET.data
type: exit
status: 200
name: EXIT_HIT
plugin: datakit
" | kubectl apply -f -
Copied!
Next, apply the KongPlugin resource by annotating the httproute or ingress resource:
kubectl annotate -n kong httproute konghq.com/plugins=datakit
Copied!
kubectl annotate -n kong ingress konghq.com/plugins=datakit
Copied!
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/"
}
Copied!
Add the following to your Terraform configuration to create a Konnect Gateway Plugin:
resource "konnect_gateway_plugin_datakit" "my_datakit" {
enabled = true
config = {
resources = {
cache = {
strategy = "memory"
}
}
nodes = [
{
type = "static"
values = {
key = "cache key"
}
name = "CACHE_KEY_GET"
},
{
type = "cache"
input = "CACHE_KEY_GET"
ttl = 200
name = "GET"
},
{
type = "branch"
then = ["DATA", "SET", "EXIT_MISS"]
else = ["EXIT_HIT"]
input = "GET.miss"
name = "branch"
},
{
type = "call"
method = "GET"
url = "http://localhost:8080/anything"
name = "DATA"
},
{
type = "static"
values = {
hit = {
x-hit = true
}
ttl = 100
miss = {
x-miss = true
}
key = "cache key"
}
name = "VALUES"
},
{
type = "cache"
inputs = {
key = "VALUES.key"
data = "DATA"
ttl = "VALUES.ttl"
}
name = "SET"
},
{
inputs = {
headers = "VALUES.miss"
body = "DATA"
}
type = "exit"
status = 200
name = "EXIT_MISS"
},
{
inputs = {
headers = "VALUES.hit"
body = "GET.data"
}
type = "exit"
status = 200
name = "EXIT_HIT"
} ]
}
control_plane_id = konnect_gateway_control_plane.my_konnect_cp.id
route = {
id = konnect_gateway_route.my_route.id
}
}
Copied!
Add this section to your kong.yaml configuration file:
kong.yaml
Copied!
_format_version: "3.0"
plugins:
- name: datakit
consumer: consumerName|Id
config:
resources:
cache:
strategy: memory
nodes:
- type: static
values:
key: cache key
name: CACHE_KEY_GET
- type: cache
input: CACHE_KEY_GET
ttl: 200
name: GET
- type: branch
then:
- DATA
- SET
- EXIT_MISS
else:
- EXIT_HIT
input: GET.miss
name: branch
- type: call
method: GET
url: http://localhost:8080/anything
name: DATA
- type: static
values:
hit:
x-hit: true
ttl: 100
miss:
x-miss: true
key: cache key
name: VALUES
- type: cache
inputs:
key: VALUES.key
data: DATA
ttl: VALUES.ttl
name: SET
- inputs:
headers: VALUES.miss
body: DATA
type: exit
status: 200
name: EXIT_MISS
- inputs:
headers: VALUES.hit
body: GET.data
type: exit
status: 200
name: EXIT_HIT
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": "datakit",
"config": {
"resources": {
"cache": {
"strategy": "memory"
}
},
"nodes": [
{
"type": "static",
"values": {
"key": "cache key"
},
"name": "CACHE_KEY_GET"
},
{
"type": "cache",
"input": "CACHE_KEY_GET",
"ttl": 200,
"name": "GET"
},
{
"type": "branch",
"then": [
"DATA",
"SET",
"EXIT_MISS"
],
"else": [
"EXIT_HIT"
],
"input": "GET.miss",
"name": "branch"
},
{
"type": "call",
"method": "GET",
"url": "http://localhost:8080/anything",
"name": "DATA"
},
{
"type": "static",
"values": {
"hit": {
"x-hit": true
},
"ttl": 100,
"miss": {
"x-miss": true
},
"key": "cache key"
},
"name": "VALUES"
},
{
"type": "cache",
"inputs": {
"key": "VALUES.key",
"data": "DATA",
"ttl": "VALUES.ttl"
},
"name": "SET"
},
{
"inputs": {
"headers": "VALUES.miss",
"body": "DATA"
},
"type": "exit",
"status": 200,
"name": "EXIT_MISS"
},
{
"inputs": {
"headers": "VALUES.hit",
"body": "GET.data"
},
"type": "exit",
"status": 200,
"name": "EXIT_HIT"
}
]
}
}
'
Copied!
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": "datakit",
"config": {
"resources": {
"cache": {
"strategy": "memory"
}
},
"nodes": [
{
"type": "static",
"values": {
"key": "cache key"
},
"name": "CACHE_KEY_GET"
},
{
"type": "cache",
"input": "CACHE_KEY_GET",
"ttl": 200,
"name": "GET"
},
{
"type": "branch",
"then": [
"DATA",
"SET",
"EXIT_MISS"
],
"else": [
"EXIT_HIT"
],
"input": "GET.miss",
"name": "branch"
},
{
"type": "call",
"method": "GET",
"url": "http://localhost:8080/anything",
"name": "DATA"
},
{
"type": "static",
"values": {
"hit": {
"x-hit": true
},
"ttl": 100,
"miss": {
"x-miss": true
},
"key": "cache key"
},
"name": "VALUES"
},
{
"type": "cache",
"inputs": {
"key": "VALUES.key",
"data": "DATA",
"ttl": "VALUES.ttl"
},
"name": "SET"
},
{
"inputs": {
"headers": "VALUES.miss",
"body": "DATA"
},
"type": "exit",
"status": 200,
"name": "EXIT_MISS"
},
{
"inputs": {
"headers": "VALUES.hit",
"body": "GET.data"
},
"type": "exit",
"status": 200,
"name": "EXIT_HIT"
}
]
}
}
'
Copied!
Make sure to replace the following placeholders with your own values:
-
region: Geographic region where your Kong Konnect is hosted and operates. -
controlPlaneId: Theidof the control plane. -
KONNECT_TOKEN: Your Personal Access Token (PAT) associated with your Konnect account. -
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: datakit
namespace: kong
annotations:
kubernetes.io/ingress.class: kong
config:
resources:
cache:
strategy: memory
nodes:
- type: static
values:
key: cache key
name: CACHE_KEY_GET
- type: cache
input: CACHE_KEY_GET
ttl: 200
name: GET
- type: branch
then:
- DATA
- SET
- EXIT_MISS
else:
- EXIT_HIT
input: GET.miss
name: branch
- type: call
method: GET
url: http://localhost:8080/anything
name: DATA
- type: static
values:
hit:
x-hit: true
ttl: 100
miss:
x-miss: true
key: cache key
name: VALUES
- type: cache
inputs:
key: VALUES.key
data: DATA
ttl: VALUES.ttl
name: SET
- inputs:
headers: VALUES.miss
body: DATA
type: exit
status: 200
name: EXIT_MISS
- inputs:
headers: VALUES.hit
body: GET.data
type: exit
status: 200
name: EXIT_HIT
plugin: datakit
" | kubectl apply -f -
Copied!
Next, apply the KongPlugin resource by annotating the KongConsumer resource:
kubectl annotate -n kong CONSUMER_NAME konghq.com/plugins=datakit
Copied!
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/"
}
Copied!
Add the following to your Terraform configuration to create a Konnect Gateway Plugin:
resource "konnect_gateway_plugin_datakit" "my_datakit" {
enabled = true
config = {
resources = {
cache = {
strategy = "memory"
}
}
nodes = [
{
type = "static"
values = {
key = "cache key"
}
name = "CACHE_KEY_GET"
},
{
type = "cache"
input = "CACHE_KEY_GET"
ttl = 200
name = "GET"
},
{
type = "branch"
then = ["DATA", "SET", "EXIT_MISS"]
else = ["EXIT_HIT"]
input = "GET.miss"
name = "branch"
},
{
type = "call"
method = "GET"
url = "http://localhost:8080/anything"
name = "DATA"
},
{
type = "static"
values = {
hit = {
x-hit = true
}
ttl = 100
miss = {
x-miss = true
}
key = "cache key"
}
name = "VALUES"
},
{
type = "cache"
inputs = {
key = "VALUES.key"
data = "DATA"
ttl = "VALUES.ttl"
}
name = "SET"
},
{
inputs = {
headers = "VALUES.miss"
body = "DATA"
}
type = "exit"
status = 200
name = "EXIT_MISS"
},
{
inputs = {
headers = "VALUES.hit"
body = "GET.data"
}
type = "exit"
status = 200
name = "EXIT_HIT"
} ]
}
control_plane_id = konnect_gateway_control_plane.my_konnect_cp.id
consumer = {
id = konnect_gateway_consumer.my_consumer.id
}
}
Copied!
Add this section to your kong.yaml configuration file:
kong.yaml
Copied!
_format_version: "3.0"
plugins:
- name: datakit
consumer_group: consumerGroupName|Id
config:
resources:
cache:
strategy: memory
nodes:
- type: static
values:
key: cache key
name: CACHE_KEY_GET
- type: cache
input: CACHE_KEY_GET
ttl: 200
name: GET
- type: branch
then:
- DATA
- SET
- EXIT_MISS
else:
- EXIT_HIT
input: GET.miss
name: branch
- type: call
method: GET
url: http://localhost:8080/anything
name: DATA
- type: static
values:
hit:
x-hit: true
ttl: 100
miss:
x-miss: true
key: cache key
name: VALUES
- type: cache
inputs:
key: VALUES.key
data: DATA
ttl: VALUES.ttl
name: SET
- inputs:
headers: VALUES.miss
body: DATA
type: exit
status: 200
name: EXIT_MISS
- inputs:
headers: VALUES.hit
body: GET.data
type: exit
status: 200
name: EXIT_HIT
Make sure to replace the following placeholders with your own values:
-
consumerGroupName|Id: Theidornameof the consumer group the plugin configuration will target.
Make the following request:
curl -i -X POST http://localhost:8001/consumer_groups/{consumerGroupName|Id}/plugins/ \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--data '
{
"name": "datakit",
"config": {
"resources": {
"cache": {
"strategy": "memory"
}
},
"nodes": [
{
"type": "static",
"values": {
"key": "cache key"
},
"name": "CACHE_KEY_GET"
},
{
"type": "cache",
"input": "CACHE_KEY_GET",
"ttl": 200,
"name": "GET"
},
{
"type": "branch",
"then": [
"DATA",
"SET",
"EXIT_MISS"
],
"else": [
"EXIT_HIT"
],
"input": "GET.miss",
"name": "branch"
},
{
"type": "call",
"method": "GET",
"url": "http://localhost:8080/anything",
"name": "DATA"
},
{
"type": "static",
"values": {
"hit": {
"x-hit": true
},
"ttl": 100,
"miss": {
"x-miss": true
},
"key": "cache key"
},
"name": "VALUES"
},
{
"type": "cache",
"inputs": {
"key": "VALUES.key",
"data": "DATA",
"ttl": "VALUES.ttl"
},
"name": "SET"
},
{
"inputs": {
"headers": "VALUES.miss",
"body": "DATA"
},
"type": "exit",
"status": 200,
"name": "EXIT_MISS"
},
{
"inputs": {
"headers": "VALUES.hit",
"body": "GET.data"
},
"type": "exit",
"status": 200,
"name": "EXIT_HIT"
}
]
}
}
'
Copied!
Make sure to replace the following placeholders with your own values:
-
consumerGroupName|Id: Theidornameof the consumer group the plugin configuration will target.
Make the following request:
curl -X POST https://{region}.api.konghq.com/v2/control-planes/{controlPlaneId}/core-entities/consumer_groups/{consumerGroupId}/plugins/ \
--header "accept: application/json" \
--header "Content-Type: application/json" \
--header "Authorization: Bearer $KONNECT_TOKEN" \
--data '
{
"name": "datakit",
"config": {
"resources": {
"cache": {
"strategy": "memory"
}
},
"nodes": [
{
"type": "static",
"values": {
"key": "cache key"
},
"name": "CACHE_KEY_GET"
},
{
"type": "cache",
"input": "CACHE_KEY_GET",
"ttl": 200,
"name": "GET"
},
{
"type": "branch",
"then": [
"DATA",
"SET",
"EXIT_MISS"
],
"else": [
"EXIT_HIT"
],
"input": "GET.miss",
"name": "branch"
},
{
"type": "call",
"method": "GET",
"url": "http://localhost:8080/anything",
"name": "DATA"
},
{
"type": "static",
"values": {
"hit": {
"x-hit": true
},
"ttl": 100,
"miss": {
"x-miss": true
},
"key": "cache key"
},
"name": "VALUES"
},
{
"type": "cache",
"inputs": {
"key": "VALUES.key",
"data": "DATA",
"ttl": "VALUES.ttl"
},
"name": "SET"
},
{
"inputs": {
"headers": "VALUES.miss",
"body": "DATA"
},
"type": "exit",
"status": 200,
"name": "EXIT_MISS"
},
{
"inputs": {
"headers": "VALUES.hit",
"body": "GET.data"
},
"type": "exit",
"status": 200,
"name": "EXIT_HIT"
}
]
}
}
'
Copied!
Make sure to replace the following placeholders with your own values:
-
region: Geographic region where your Kong Konnect is hosted and operates. -
controlPlaneId: Theidof the control plane. -
KONNECT_TOKEN: Your Personal Access Token (PAT) associated with your Konnect account. -
consumerGroupId: Theidof the consumer group 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: datakit
namespace: kong
annotations:
kubernetes.io/ingress.class: kong
config:
resources:
cache:
strategy: memory
nodes:
- type: static
values:
key: cache key
name: CACHE_KEY_GET
- type: cache
input: CACHE_KEY_GET
ttl: 200
name: GET
- type: branch
then:
- DATA
- SET
- EXIT_MISS
else:
- EXIT_HIT
input: GET.miss
name: branch
- type: call
method: GET
url: http://localhost:8080/anything
name: DATA
- type: static
values:
hit:
x-hit: true
ttl: 100
miss:
x-miss: true
key: cache key
name: VALUES
- type: cache
inputs:
key: VALUES.key
data: DATA
ttl: VALUES.ttl
name: SET
- inputs:
headers: VALUES.miss
body: DATA
type: exit
status: 200
name: EXIT_MISS
- inputs:
headers: VALUES.hit
body: GET.data
type: exit
status: 200
name: EXIT_HIT
plugin: datakit
" | kubectl apply -f -
Copied!
Next, apply the KongPlugin resource by annotating the KongConsumerGroup resource:
kubectl annotate -n kong CONSUMERGROUP_NAME konghq.com/plugins=datakit
Copied!
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/"
}
Copied!
Add the following to your Terraform configuration to create a Konnect Gateway Plugin:
resource "konnect_gateway_plugin_datakit" "my_datakit" {
enabled = true
config = {
resources = {
cache = {
strategy = "memory"
}
}
nodes = [
{
type = "static"
values = {
key = "cache key"
}
name = "CACHE_KEY_GET"
},
{
type = "cache"
input = "CACHE_KEY_GET"
ttl = 200
name = "GET"
},
{
type = "branch"
then = ["DATA", "SET", "EXIT_MISS"]
else = ["EXIT_HIT"]
input = "GET.miss"
name = "branch"
},
{
type = "call"
method = "GET"
url = "http://localhost:8080/anything"
name = "DATA"
},
{
type = "static"
values = {
hit = {
x-hit = true
}
ttl = 100
miss = {
x-miss = true
}
key = "cache key"
}
name = "VALUES"
},
{
type = "cache"
inputs = {
key = "VALUES.key"
data = "DATA"
ttl = "VALUES.ttl"
}
name = "SET"
},
{
inputs = {
headers = "VALUES.miss"
body = "DATA"
}
type = "exit"
status = 200
name = "EXIT_MISS"
},
{
inputs = {
headers = "VALUES.hit"
body = "GET.data"
}
type = "exit"
status = 200
name = "EXIT_HIT"
} ]
}
control_plane_id = konnect_gateway_control_plane.my_konnect_cp.id
consumer_group = {
id = konnect_gateway_consumer_group.my_consumer_group.id
}
}
Copied!