TLSVersionRange

object

A range of TLS versions.

Default:{"min":"TLSv1.2","max":"TLSv1.3"}

minstring

Minimum TLS version to use.

Allowed values:TLSv1.2TLSv1.3

Default:TLSv1.2

maxstring

Maximum TLS version to use.

Allowed values:TLSv1.2TLSv1.3

Default:TLSv1.3

Example

Forward to Virtual Cluster

object

Forwards requests to virtual clusters configured with port routing or SNI routing.
While there can be multiple of these policies configured on a listener, there can only be one instance of
port_mapping.
When multiple policies are configured, the first one that matches the connection is used.
If no policy matches, the connection is rejected.

When using port_mapping, there must be a mapping port for each broker on the backend cluster see
ForwardToClusterBySNIConfig for more details.

typestringrequired

The type name of the policy.

Allowed values:forward_to_virtual_cluster

>= 1 characters<= 255 characters

namestring

A unique user-defined name of the policy.

<= 255 characters

descriptionstring

A human-readable description of the policy.

Default:

<= 512 characters

enabledboolean

Whether the policy is enabled.

Default:true

labelsobject

Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.

Keys must be of length 1-63 characters, and cannot start with “kong”, “konnect”, “mesh”, “kic”, or “_”.

Example:{"env":"test"}

configOne Of
objectrequired

The configuration of the policy.

ForwardToClusterBySNIConfigobject

The configuration to forward requests to virtual clusters configured with SNI routing.

* Additional properties are NOT allowed.
Show Child Parameters
Example

ForwardToClusterByPortMappingConfig

object

The configuration to forward request to destination and rewrite ports accordingly.
All broker ids must fit in the range of ports defined in the listener, if it doesn’t the metadata request will
return an error.

For example with ports: [9000, “9092-9094”, “9100”] and bootstrap_port: at_start and brokers with ids
1, 2, 3, 4 we will map: bootstrap to 9000 broker 1 to 9001, broker 2 to 9002, broker 3 to 9003, and broker 4
to 9004 and fail the metadata request as these ports are not open.

However, with the same configuration but with brokers with ids: 92,93,94,100 we will map: bootstrap to 9000,
broker 92 to 9092, broker 93 to 9093, broker 94 to 9094, and broker 100 to 9100.

In most cases users should use a single range ["9090-9094"] and bootstrap_port: at_start and connect with
<host>:9090 as bootstrap server. Being able to use multiple ranges is only useful when when dealing with
gaps in broker ids.

It is strongly discouraged to use port mapping in production.

* Additional properties are NOT allowed.
typestringrequired

Allowed values:port_mapping

destinationAny Of
required

A reference to a virtual cluster.

VirtualClusterReferenceByIdobject

Reference a virtual cluster by its unique identifier.

Show Child Parameters
advertised_hoststringrequired

Virtual brokers are advertised to clients using this host. Any kind of host supported by kafka can be used. If not defined, it’s listen_address. If listen_address is 0.0.0.0 it’s the destination IP of the TCP connection.

Match pattern:^[a-z0-9](?:[a-z0-9\-]{0,61}[a-z0-9])?(?:\.[a-z0-9](?:[a-z0-9\-]{0,61}[a-z0-9])?)*$

bootstrap_portstring

If set to at_start, the first port will be used as a bootstrap port.
It provides a stable endpoint to use as the bootstrap server for clients, regardless of broker
IDs in the cluster.

Additionally, it offsets all ports by one, so for example, if there are 3 brokers (id=1, id=2, id=3)
then we will use 4 ports: 9092 (bootstrap), 9093 (id=1), 9094 (id=2), 9095 (id=3)
With none we will use 3 ports: 9092 (id=1), 9093 (id=2), 9094 (id=3).

Allowed values:noneat_start

Default:at_start

min_broker_idinteger

The lowest broker node ID in the cluster.

Default:0

Example

ForwardToClusterBySNIConfig

object

The configuration to forward requests to virtual clusters configured with SNI routing.

* Additional properties are NOT allowed.
typestringrequired

Allowed values:sni

sni_suffixstring

Optional suffix for TLS SNI validation.

This suffix is concatenated with the virtual cluster “dns.label” label to form the base name for the SNI.
If not provided, the virtual cluster “dns.label” label alone is used as the base name for the SNI.
For example with sni_suffix: .example.com and virtual cluster “dns.label” label: my-cluster,
the SNI suffix for it is my-cluster.example.com.
If “dns.label” label is absent on the virtual cluster, the traffic won’t be routed there.

The bootstrap host is bootstrap.my-cluster.example.com and then each broker is addressable at broker-0.my-cluster.example.com, broker-1.my-cluster.example.com, etc.
This means that your deployment needs to have a wildcard certificate for the domain and a DNS resolver that routes *.my-cluster.example.com to the proxy.

The accepted format is a DNS subdomain starting with either . or -. For example, -keg.example.com, .keg.example.com, .namespace.svc.cluster.local, and .localhost are all valid,
while keg.example.com is not.

Match pattern:^[\.-]([a-z0-9]([a-z0-9-]*[a-z0-9])?\.)*([a-z0-9-]*[a-z0-9])$

Example:.example.com

advertised_portinteger

Virtual brokers are advertised to clients with this port instead of listen_port. Useful when proxy is
behind loadbalancer listening on different port.

>= 1<= 65535

broker_host_formatobject

Configures DNS names assigned to brokers in virtual clusters.

  • per_cluster_suffix is the default and allocates one level in the hierarchy for virtual clusters: broker-{node_id}.{virtual_cluster}.{sni_suffix}
  • shared_suffix puts all brokers from every virtual clusters into the same level: broker-{node_id}-{virtual_cluster}.{sni_suffix}. This makes it easier to manage certificates for this listener.

Requires a minimum runtime version of 1.1.

Show Child Parameters
Example

EventGatewayConsumePolicyCreate

The typed schema of the consume policy to modify it.

One Of
typestringrequired

The type name of the policy.

Allowed values:schema_validation

>= 1 characters<= 255 characters

namestring

A unique user-defined name of the policy.

<= 255 characters

descriptionstring

A human-readable description of the policy.

Default:

<= 512 characters

enabledboolean

Whether the policy is enabled.

Default:true

labelsobject

Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.

Keys must be of length 1-63 characters, and cannot start with “kong”, “konnect”, “mesh”, “kic”, or “_”.

Example:{"env":"test"}

configobjectrequired

The configuration of the schema validation policy.

Show Child Parameters
conditionstring

A string containing the boolean expression that determines whether the policy is applied.

Default:

<= 1000 characters

Example:context.topic.name.endsWith("my_suffix") && record.headers["x-flag"] == "a-value"

Example