GraphQL Proxy Caching Advanced

For example, configure this plugin on a service by making the following request:

curl -X POST http://{HOST}:8001/services/{SERVICE}/plugins \
    --data "name=graphql-proxy-cache-advanced"  \
    --data "config.strategy=memory" \
    --data "config.memory.dictionary_name=kong_db_cache"

SERVICE is the id or name of the service that this plugin configuration will target.

First, create a KongPlugin resource:

apiVersion: configuration.konghq.com/v1
kind: KongPlugin
metadata:
  name: <graphql-proxy-cache-advanced-example>
config: 
  strategy: memory
  memory.dictionary_name: kong_db_cache
plugin: graphql-proxy-cache-advanced

Next, apply the KongPlugin resource to a Service by annotating the Service as follows:

apiVersion: v1
kind: Service
metadata:
  name: {SERVICE}
  labels:
    app: {SERVICE}
  annotations:
    konghq.com/plugins: <graphql-proxy-cache-advanced-example>
spec:
  ports:
  - port: 80
    targetPort: 80
    protocol: TCP
    name: {SERVICE}
  selector:
    app: {SERVICE}

{SERVICE} is the id or name of the service that this plugin configuration will target.

For example, configure this plugin on a service by adding this section to your declarative configuration file:

plugins:
- name: graphql-proxy-cache-advanced
  service: {SERVICE}
  config: 
    strategy: memory
    memory.dictionary_name: kong_db_cache

SERVICE is the id or name of the service that this plugin configuration will target.

Configure this plugin on a service:

1. In Konnect Cloud, select the service on the ServiceHub page.
2. Scroll down to Versions and select the version.
3. Scroll down to Plugins and click New Plugin.
4. Find and select the GraphQL Proxy Caching Advanced plugin.

5. Enter the following parameters, updating the default or sample values as needed:

   • Config.Strategy: memory
   • Config.Memory.dictionary Name: kong_db_cache
6. Click Create.

Configure this plugin on a service:

1. In Kong Manager, select the workspace.
2. From the Dashboard, scroll down to Services and click View for the service row.
3. Scroll down to plugins and click Add Plugin.

4. Find and select the GraphQL Proxy Caching Advanced plugin.

   Note: If the plugin is greyed out, then it is not available for your product tier. See Kong Gateway tiers.
5. If the option is available, select Scoped.
6. Add the service name and ID to the Service field if it is not already prefilled.

7. Enter the following parameters, updating the default or sample values as needed:

   • Config.Strategy: memory
   • Config.Memory.dictionary Name: kong_db_cache
8. Click Create.

For example, configure this plugin on a route with:

$ curl -X POST http://{HOST}:8001/routes/{ROUTE}/plugins \
    --data "name=graphql-proxy-cache-advanced"  \
    --data "config.strategy=memory" \
    --data "config.memory.dictionary_name=kong_db_cache"

ROUTE is the id or name of the route that this plugin configuration will target.

First, create a KongPlugin resource:

apiVersion: configuration.konghq.com/v1
kind: KongPlugin
metadata:
  name: <graphql-proxy-cache-advanced-example>
config: 
  strategy: memory
  memory.dictionary_name: kong_db_cache
plugin: graphql-proxy-cache-advanced

Then, apply it to an ingress (Route or Routes) by annotating the ingress as follows:

apiVersion: networking/v1beta1
kind: Ingress
metadata:
  name: {ROUTE}
  annotations:
    kubernetes.io/ingress.class: kong
    konghq.com/plugins: <graphql-proxy-cache-advanced-example>
spec:
  rules:
  - host: examplehostname.com
    http:
      paths:
      - path: /bar
        backend:
          serviceName: echo
          servicePort: 80

ROUTE is the id or name of the route that this plugin configuration will target.

For example, configure this plugin on a route by adding this section to your declarative configuration file:

plugins:
- name: graphql-proxy-cache-advanced
  route: <route>
  config: 
    strategy: memory
    memory.dictionary_name: kong_db_cache

ROUTE is the id or name of the route that this plugin configuration will target.

Configure this plugin on a route:

1. In Konnect Cloud, select the service from the ServiceHub page.
2. Scroll down to Versions and select the version.
3. Select the route.
4. Scroll down to Plugins and click Add Plugin.
5. Find and select the GraphQL Proxy Caching Advanced plugin.

6. Enter the following parameters, updating the default or sample values as needed:

   • Config.Strategy: memory
   • Config.Memory.dictionary Name: kong_db_cache
7. Click Create.

Configure this plugin on a route:

1. In Kong Manager, select the workspace.
2. From the Dashboard, select Routes in the left navigation.
3. Click View for the route row.
4. Scroll down to plugins and click Add Plugin.

5. Find and select the GraphQL Proxy Caching Advanced plugin.

   Note: If the plugin is greyed out, then it is not available for your product tier. See Kong Gateway tiers.
6. If the option is available, select Scoped.
7. Add the Route ID if it is not already prefilled.

8. Enter the following parameters, updating the default or sample values as needed:

   • Config.Strategy: memory
   • Config.Memory.dictionary Name: kong_db_cache
9. Click Create.

For example, configure this plugin globally with:

$ curl -X POST http://{HOST}:8001/plugins/ \
    --data "name=graphql-proxy-cache-advanced"  \
    --data "config.strategy=memory" \
    --data "config.memory.dictionary_name=kong_db_cache"

Create a KongClusterPlugin resource and label it as global:

apiVersion: configuration.konghq.com/v1
kind: KongClusterPlugin
metadata:
  name: <global-graphql-proxy-cache-advanced>
  annotations:
    kubernetes.io/ingress.class: kong
  labels:
    global: \"true\"
config: 
  strategy: memory
  memory.dictionary_name: kong_db_cache
plugin: graphql-proxy-cache-advanced

For example, configure this plugin using the plugins: entry in the declarative configuration file:

plugins:
- name: graphql-proxy-cache-advanced
  config: 
    strategy: memory
    memory.dictionary_name: kong_db_cache

Configure this plugin globally:

1. In Kong Manager, select the workspace.
2. From the Dashboard, select Plugins in the left navigation.
3. Click New Plugin.

4. Find and select the GraphQL Proxy Caching Advanced plugin.

   Note: If the plugin is greyed out, then it is not available for your product tier. See Kong Gateway tiers.
5. If the option is available, set the plugin scope to Global.

6. Enter the following parameters, updating the default/sample values as needed:

   • Config.Strategy: memory
   • Config.Memory.dictionary Name: kong_db_cache
7. Click Create.