You are browsing documentation for an older version. See the latest documentation here.

How to Configure Data Plane Resilience

Starting in version 3.2, Kong Gateway can be configured to support configuring new data planes in the event of a control plane outage. This feature works by designating one or more backup nodes and allowing it read/write access to a data store. This backup node will automatically push valid Kong Gateway configurations to the data store. In the event of a control plane outage when a new node is created, it will pull the latest Kong Gateway configuration from the data store, configure itself, and start proxying requests.

This option is only recommended for customers who have to adhere to strict availability SLAs, because it requires a larger maintenance load.

Amazon S3

GCP Cloud Storage

S3 object storage

Prerequisites

  • An Amazon S3 bucket
  • Read and write credentials for the bucket

Configuration

In this setup, you need to designate one backup node. The backup node must have read and write access to the S3 bucket, and the data plane nodes that are provisioned must have read access to the same S3 bucket. The backup node is responsible for communicating the state of the Kong Gateway kong.conf configuration file from the control plane to the S3 bucket.

Nodes are initialized with fallback configs via environment variables, including AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY, and AWS_DEFAULT_REGION. If associating with an IAM role and if the backup node does not reside on the AWS platform, an additional environment variable AWS_SESSION_TOKEN may be necessary.

We do not recommend using backup nodes to proxy traffic. The backup job enlarges the attack surface of a proxying DP and contributes significantly to the P99 delay. You need to know the risk if you want to deploy a node this way, and the DP needs to be at least 3.6.0.0 to be provisioned with backup configuration when it’s configured as a backup node. Although a single backup node is sufficient for all deployments, you can also configure additional backup nodes. A leader election algorithm selects one node from the group of designated backup nodes to do the backup job.

For more information about the data that is set in the environment variables, review the AWS environment variable configuration documentation.

Using Docker Compose, you can configure the backup nodes:

  1. kong-exporter:
  2.     image: 'kong/kong-gateway:latest'
  3.     ports:
  4.       - '8000:8000'
  5.       - '8443:8443'
  6.     environment:
  7.       <<: *other-kong-envs
  8.       AWS_REGION: 'us-east-2'
  9.       AWS_ACCESS_KEY_ID: <access_key_write>
  10.       AWS_SECRET_ACCESS_KEY: <secret_access_key_write>
  11.       KONG_CLUSTER_FALLBACK_CONFIG_STORAGE: s3://test-bucket/test-prefix
  12.       KONG_CLUSTER_FALLBACK_CONFIG_EXPORT: "on"

All the object keynames/prefixes mentioned in the following paragraphs are parameterized with the prefix given in the config and the gateway version. For example, let’s say the node has a version of 3.6.0.0.

The backup nodes will create registering files to run the leader election with a prefix test-prefix/3.6.0.0/election/. You can set up a lifecycle rule to delete objects with this prefix if it’s not updated for days.

The selected node is responsible for writing to the S3 bucket when it receives new configuration. The file structure is automatically created inside of the bucket and should not be created manually. The key name is test-prefix/3.6.0.0/config.json.

Both the control plane and data plane can be configured to export configurations.

You can configure new data planes to load a configuration from the S3 bucket if the control plane is unreachable using the following environment variables:

  1. kong-dp-importer:
  2.     image: 'kong/kong-gateway:latest'
  3.     ports:
  4.       - '8000:8000'
  5.       - '8443:8443'
  6.     environment:
  7.       <<: *other-kong-envs
  8.       AWS_REGION: 'us-east-2'
  9.       AWS_ACCESS_KEY_ID: <access_key_read>
  10.       AWS_SECRET_ACCESS_KEY: <secret_access_key_read>
  11.       KONG_CLUSTER_FALLBACK_CONFIG_STORAGE: s3://test-bucket/test-prefix
  12.       KONG_CLUSTER_FALLBACK_CONFIG_IMPORT: "on"

Prerequisites

  • A GCP cloud storage bucket
  • Read and write credentials for the bucket

Configuration

In this setup, you need to designate one backup node. The backup node must have read and write access to the GCP cloud storage bucket and the data plane nodes that are provisioned must have read access to the same GCP cloud storage bucket. This node is responsible for communicating the state of the Kong Gateway kong.conf configuration file from the control plane to the GCP cloud storage bucket.

Credentials are passed via the environment variable GCP_SERVICE_ACCOUNT. For more information about credentials review the GCP credentials documentation.

A backup node should not be used to proxy traffic. A single backup node is sufficient for all deployments.

Using Docker Compose, you can configure the backup node:

  1. kong-dp-exporter:
  2.     image: 'kong/kong-gateway:latest'
  3.     ports:
  4.       - '8000:8000'
  5.       - '8443:8443'
  6.     environment:
  7.       <<: *other-kong-envs
  8.       GCP_SERVICE_ACCOUNT: <GCP_JSON_STRING_WRITE>
  9.       KONG_CLUSTER_FALLBACK_CONFIG_STORAGE: gcs://test-bucket/test-prefix
  10.       KONG_CLUSTER_FALLBACK_CONFIG_EXPORT: "on"

This node is responsible for writing to the GCP bucket when it receives a new configuration. The file structure is automatically created inside of the bucket and should not be created manually. If the node version is 3.2.0.0, using the example above, the key name will be test-prefix/3.2.0.0/config.json.

Both the control plane and data plane can be configured to export configurations.

You can configure new data planes to load a configuration from the GCP cloud storage bucket if the control plane is unreachable using the following environment variables:

  1.   kong-dp-importer:
  2.     image: 'kong/kong-gateway:latest'
  3.     ports:
  4.       - '8000:8000'
  5.       - '8443:8443'
  6.     environment:
  7.       <<: *other-kong-envs
  8.       GCP_SERVICE_ACCOUNT: <GCP_JSON_STRING_READ>
  9.       KONG_CLUSTER_FALLBACK_CONFIG_STORAGE: gcs://test-bucket/test-prefix
  10.       KONG_CLUSTER_FALLBACK_CONFIG_IMPORT: "on"

Non-AWS S3 compatible object storage can be configured. The process is similar to the AWS S3 process, but requires an additional parameter AWS_CONFIG_STORAGE_ENDPOINT, which should be set to the endpoint of your object storage provider.

The example below uses MinIO to demonstrate configuring a backup node:

  1.   kong-exporter:
  2.     image: 'kong/kong-gateway:latest'
  3.     ports:
  4.       - '8000:8000'
  5.       - '8443:8443'
  6.     environment:
  7.       <<: *other-kong-envs
  8.       AWS_REGION: 'us-east-2'
  9.       AWS_ACCESS_KEY_ID: <access_key_write>
  10.       AWS_SECRET_ACCESS_KEY: <secret_access_key_write>
  11.       KONG_CLUSTER_FALLBACK_CONFIG_EXPORT: "on"
  12.       KONG_CLUSTER_FALLBACK_CONFIG_STORAGE: s3://test-bucket/test-prefix
  13.       AWS_CONFIG_STORAGE_ENDPOINT: http://minio:9000/

More Information