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

EventGatewayConsumePolicyUpdate

The typed schema of the consume policy to modify it.

One Of
typestringrequired

The type name of the policy.

Allowed values:modify_headers

>= 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 modify headers policy.

Show Child Parameters
conditionstring

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

When the policy is applied as a child policy of schema_validation, the expression can also reference
record.value fields.

Default:

<= 1000 characters

Example:record.value.content.foo.bar == "a-value"

Example

EventGatewayProducePolicyCreate

The typed schema of the produce policy to modify it.

One Of
typestringrequired

The type name of the policy.

Allowed values:modify_headers

>= 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 modify headers policy.

Show Child Parameters
conditionstring

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

When the policy is applied as a child policy of schema_validation, the expression can also reference
record.value fields.

Default:

<= 1000 characters

Example:record.value.content.foo.bar == "a-value"

parent_policy_idstring(uuid)

The unique identifier of the parent schema validation policy, if any.

Example

EventGatewayProducePolicyUpdate

The typed schema of the produce 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"}

configOne Of
objectrequired

The configuration of the policy.

EventGatewayProduceSchemaValidationPolicySchemaRegistryConfigobject

The configuration of the produce schema validation policy when using a schema registry.

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