GraphQL proxy cache with Redis storagev1.3+
Store GraphQL proxy cache data in a Redis database.
Prerequisites
-
You have an existing a GraphQL upstream service.
-
You have a Redis instance running.
Environment variables
-
REDIS_HOST: The hostname of your Redis instance, such asexample.com.
Add this section to your kong.yaml configuration file:
_format_version: "3.0"
plugins:
- name: graphql-proxy-cache-advanced
config:
strategy: redis
cache_ttl: 500
redis:
host: ${{ env "DECK_REDIS_HOST" }}
port: 6379
Make the following request:
curl -i -X POST http://localhost:8001/plugins/ \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--data '
{
"name": "graphql-proxy-cache-advanced",
"config": {
"strategy": "redis",
"cache_ttl": 500,
"redis": {
"host": "'$REDIS_HOST'",
"port": 6379
}
},
"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": "graphql-proxy-cache-advanced",
"config": {
"strategy": "redis",
"cache_ttl": 500,
"redis": {
"host": "'$REDIS_HOST'",
"port": 6379
}
},
"tags": []
}
'
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: graphql-proxy-cache-advanced
namespace: kong
annotations:
kubernetes.io/ingress.class: kong
konghq.com/tags: ''
labels:
global: 'true'
config:
strategy: redis
cache_ttl: 500
redis:
host: '$REDIS_HOST'
port: 6379
plugin: graphql-proxy-cache-advanced
" | 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_graphql_proxy_cache_advanced" "my_graphql_proxy_cache_advanced" {
enabled = true
config = {
strategy = "redis"
cache_ttl = 500
redis = {
host = var.redis_host
port = 6379
}
}
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 "redis_host" {
type = string
}
Add this section to your kong.yaml configuration file:
_format_version: "3.0"
plugins:
- name: graphql-proxy-cache-advanced
service: serviceName|Id
config:
strategy: redis
cache_ttl: 500
redis:
host: ${{ env "DECK_REDIS_HOST" }}
port: 6379
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": "graphql-proxy-cache-advanced",
"config": {
"strategy": "redis",
"cache_ttl": 500,
"redis": {
"host": "'$REDIS_HOST'",
"port": 6379
}
},
"tags": []
}
'
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": "graphql-proxy-cache-advanced",
"config": {
"strategy": "redis",
"cache_ttl": 500,
"redis": {
"host": "'$REDIS_HOST'",
"port": 6379
}
},
"tags": []
}
'
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: graphql-proxy-cache-advanced
namespace: kong
annotations:
kubernetes.io/ingress.class: kong
konghq.com/tags: ''
config:
strategy: redis
cache_ttl: 500
redis:
host: '$REDIS_HOST'
port: 6379
plugin: graphql-proxy-cache-advanced
" | kubectl apply -f -
Next, apply the KongPlugin resource by annotating the service resource:
kubectl annotate -n kong service SERVICE_NAME konghq.com/plugins=graphql-proxy-cache-advanced
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_graphql_proxy_cache_advanced" "my_graphql_proxy_cache_advanced" {
enabled = true
config = {
strategy = "redis"
cache_ttl = 500
redis = {
host = var.redis_host
port = 6379
}
}
tags = []
control_plane_id = konnect_gateway_control_plane.my_konnect_cp.id
service = {
id = konnect_gateway_service.my_service.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 "redis_host" {
type = string
}
Add this section to your kong.yaml configuration file:
_format_version: "3.0"
plugins:
- name: graphql-proxy-cache-advanced
route: routeName|Id
config:
strategy: redis
cache_ttl: 500
redis:
host: ${{ env "DECK_REDIS_HOST" }}
port: 6379
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": "graphql-proxy-cache-advanced",
"config": {
"strategy": "redis",
"cache_ttl": 500,
"redis": {
"host": "'$REDIS_HOST'",
"port": 6379
}
},
"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": "graphql-proxy-cache-advanced",
"config": {
"strategy": "redis",
"cache_ttl": 500,
"redis": {
"host": "'$REDIS_HOST'",
"port": 6379
}
},
"tags": []
}
'
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: graphql-proxy-cache-advanced
namespace: kong
annotations:
kubernetes.io/ingress.class: kong
konghq.com/tags: ''
config:
strategy: redis
cache_ttl: 500
redis:
host: '$REDIS_HOST'
port: 6379
plugin: graphql-proxy-cache-advanced
" | kubectl apply -f -
Next, apply the KongPlugin resource by annotating the httproute or ingress resource:
kubectl annotate -n kong httproute konghq.com/plugins=graphql-proxy-cache-advanced
kubectl annotate -n kong ingress konghq.com/plugins=graphql-proxy-cache-advanced
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_graphql_proxy_cache_advanced" "my_graphql_proxy_cache_advanced" {
enabled = true
config = {
strategy = "redis"
cache_ttl = 500
redis = {
host = var.redis_host
port = 6379
}
}
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 "redis_host" {
type = string
}
Add this section to your kong.yaml configuration file:
_format_version: "3.0"
plugins:
- name: graphql-proxy-cache-advanced
consumer: consumerName|Id
config:
strategy: redis
cache_ttl: 500
redis:
host: ${{ env "DECK_REDIS_HOST" }}
port: 6379
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": "graphql-proxy-cache-advanced",
"config": {
"strategy": "redis",
"cache_ttl": 500,
"redis": {
"host": "'$REDIS_HOST'",
"port": 6379
}
},
"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": "graphql-proxy-cache-advanced",
"config": {
"strategy": "redis",
"cache_ttl": 500,
"redis": {
"host": "'$REDIS_HOST'",
"port": 6379
}
},
"tags": []
}
'
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: graphql-proxy-cache-advanced
namespace: kong
annotations:
kubernetes.io/ingress.class: kong
konghq.com/tags: ''
config:
strategy: redis
cache_ttl: 500
redis:
host: '$REDIS_HOST'
port: 6379
plugin: graphql-proxy-cache-advanced
" | kubectl apply -f -
Next, apply the KongPlugin resource by annotating the KongConsumer resource:
kubectl annotate -n kong CONSUMER_NAME konghq.com/plugins=graphql-proxy-cache-advanced
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_graphql_proxy_cache_advanced" "my_graphql_proxy_cache_advanced" {
enabled = true
config = {
strategy = "redis"
cache_ttl = 500
redis = {
host = var.redis_host
port = 6379
}
}
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 "redis_host" {
type = string
}