Enable Proxy Caching

Use the KongPlugin CRD to enable proxy caching on a KongService. The following example:

• Caches 200 OK responses
• Applies to GET and HEAD requests
• Targets responses with application/json content type
• Stores cached data in memory
• Sets the cache TTL to 300 seconds (5 minutes)

echo "
apiVersion: configuration.konghq.com/v1
kind: KongPlugin
metadata:
  name: proxy-cache-all-endpoints
  namespace: kong
  annotations:
    kubernetes.io/ingress.class: kong
plugin: proxy-cache
config:
  response_code:
  - 200
  request_method:
  - GET
  - HEAD
  content_type:
  - text/plain; charset=utf-8
  cache_ttl: 300
  strategy: memory
" | kubectl apply -f -

Next, apply the KongPlugin resource by annotating the KongService resource:

kubectl annotate -n kong kongservice service konghq.com/plugins=rate-limiting,proxy-cache-all-endpoints --overwrite

Send six requests to the same endpoint and inspect the cache status. The first request will miss, but subsequent ones will hit because they are served from the cache.

for _ in {1..6}; do
  curl  -sv $PROXY_IP/echo \
       -H "apikey:example-key" 2>&1 | grep -E "(Status|< HTTP)"
  echo
done

< HTTP/1.1 200 OK
< X-Cache-Status: Miss

< HTTP/1.1 200 OK
< X-Cache-Status: Hit

< HTTP/1.1 200 OK
< X-Cache-Status: Hit

< HTTP/1.1 200 OK
< X-Cache-Status: Hit

< HTTP/1.1 200 OK
< X-Cache-Status: Hit

< HTTP/1.1 429 Too Many Requests