Data Plane reference

Uses: Kong Gateway

A Data Plane node is a single instance of Kong Gateway that acts as a proxy and serves traffic. In Konnect, Data Plane nodes are managed by Control Planes. Control Planes manage and store configurations in Konnect, and they distribute those configurations to Data Planes nodes. Data Plane nodes don’t manage their own configurations.

Konnect provides Data Plane node installation scripts for various platforms. These Data Plane nodes are configured to run in your Konnect environment. Alternatively, Konnect offers fully-managed Data Planes through Dedicated Cloud Gateways.

Supported installation options

Konnect supports the following installation options:

Setup Type

Platforms

Standard setup macOS (ARM), macOS (Intel), Windows, Linux (Docker)
Advanced setup Linux, Kubernetes

Choose a Data Plane node hosting strategy

The following table can help you decide which Data Plane node strategy to use based on your use case:

Use case

Data Plane node strategy

Solution

Reducing latency is important to your organization. Dedicated Cloud Gateways Supports multiple regions on AWS and Azure.
Your organization operates in an industry with strict data protection and privacy requirements. Dedicated Cloud Gateways Using the private gateway option, Kong provisions a private network load balancer and only exposes the IP address in the UI.
Your organization needs high availability with zero downtime when upgrading Data Plane nodes. Dedicated Cloud Gateways There’s no downtime when upgrading your Data Plane nodes. Additionally, you can pre-warm your cluster by specifying the number of requests per second so that the first requests don’t have to wait for the infrastructure to scale up.
You have infrastructure in multiple clouds. Dedicated Cloud Gateways Dedicated Cloud Gateways allows you to run a multi-cloud solution that allows you to standardize API operations across the board to reduce complexity and increase agility.
You need very rapid provisioning for experimentation and sandbox use cases. Serverless Gateways Serverless Gateways offer sub-minute provisioning times and enable rapid iteration and development lifecycles.
You use a cloud provider (other than AWS or Azure) for hosting, or don’t want to host in the cloud because of organizational policy. Self-managed You can deploy self-managed data plane nodes on macOS, Windows, Linux (Docker), or Kubernetes.

Forward proxy support

Konnect supports using non-transparent forward proxies to connect your Kong Gateway Data Plane with the Konnect Control Plane. See the Forward proxy connections Kong Gateway documentation for more information.

Upgrade Data Planes

Self-managed Data Plane nodes can be upgraded to a new Kong Gateway by initializing new nodes before decommissioning old ones. This method ensures high availability, allowing the new node to start data processing prior to the removal of the old node.

Managed nodes are upgraded automatically after selecting the new version of Kong Gateway. We recommend running one major version (2.x or 3.x) of a Data Plane node per Control Plane, unless you are in the middle of version upgrades to the Data Plane. Mixing versions may cause compatibility issues.

To upgrade a Data Plane node to a new version, follow these steps:

Data Plane certificates

Data Plane certificates generated by Konnect expire every ten years. If you bring your own certificates, make sure to review the expiration date and associated metadata.

Renew your certificates to prevent any interruption in communication between Konnect and any configured Data Plane nodes. The following happens if a certificate expires and isn’t replaced:

  • The Data Plane node stops receiving configuration updates from the Control Plane.
  • The Data Plane node stops sending analytics and usage data to the Control Plane.
  • Each disconnected Data Plane node uses cached configuration to continue proxying and routing traffic.

Depending on your setup, renewing certificates might mean bringing up a new Data Plane, or generating new certificates and updating Data Plane nodes with the new files.

Advanced parameter reference

The following parameters are the minimum settings required for a Data Plane node:

Parameter

Field in Konnect

Description and Value

role n/a The role of the node, in this case data_plane.
database n/a Specifies whether this node connects directly to a database. For a Data Plane, this setting is always off.
cluster_mtls n/a Enables mTLS on connections between the Control Plane and the Data Plane. In this case, set to "pki".
cluster_control_plane n/a Sets the address of the Konnect Control Plane. Must be in the format host:port, with port set to 443.

Example:
Control plane endpoint in Konnect:
https://example.cp.khcp.konghq.com
Configuration value:
example.cp.khcp.konghq.com:443
cluster_server_name n/a The SNI (Server Name Indication extension) to use for Data Plane connections to the Control Plane through TLS. When not set, Data Plane will use kong_clustering as the SNI.
cluster_telemetry_endpoint n/a The address that the Data Plane uses to send Analytics telemetry data to the Control Plane. Must be in the format host:port, with port set to 443.

Example:
Telemetry endpoint in Konnect:
https://example.tp.khcp.konghq.com
Configuration value:
example.tp.khcp.konghq.com:443
cluster_telemetry_server_name n/a The SNI (Server Name Indication extension) to use for Analytics telemetry data.
cluster_cert Certificate The certificate used for mTLS between CP/DP nodes.
cluster_cert_key Private Key The private key used for mTLS between CP/DP nodes.
lua_ssl_trusted_certificate n/a Either a comma-separated list of paths to certificate authority (CA) files in PEM format, or system. We recommend using the value system to let Konnect search for the default provided by each distribution.
konnect_mode n/a Set to on for any Data Plane node connected to Konnect.
vitals n/a Legacy Vitals analytics reporting mechanism. Set to off for all Kong Gateway versions >= 3.0. Set to on for Kong Gateway 2.8.x to collect Vitals data and send it to the Control Plane for Analytics dashboards and metrics.

Custom Data Plane labels

Labels are commonly used for metadata information. Set anything that you need to identify your Data Plane nodes – deployment type, region, size, the team that the node belongs to, the purpose it serves, or any other identifiable information. For more information, review the Konnect labels documentation.

FAQs

You can verify a Data Plane node by accessing a configured route through its proxy URL. By default, Kong Gateway listens on port 8000, so a request to http://localhost:8000/{your-route} (or your custom hostname) should return the expected response from your upstream service.

  1. Run the following command to get the external IP and port:
    kubectl get service my-kong-kong-proxy -n kong
    
  2. Find the IP in the EXTERNAL-IP column and use it with port 80 or 443 along with your route.

    For example, if the external IP is 35.233.198.16 and your route is /mock, access your service at:

    http://35.233.198.16:80/mock
    

Yes. Gateway Manager lets you select the Kong Gateway version for your quickstart scripts.

No. Direct SSH access is not possible because the SSH keys are randomly generated and not exposed. To access nodes, use the cloud provider’s tools:

Something wrong?

Help us make these docs great!

Kong Developer docs are open source. If you find these useful and want to make them better, contribute today!