VirtualClusterNamespace

object

Namespace allows to implement multitenancy using a single backend cluster.
It allows to either hide or enforce a static prefix on resources (topics, consumer group IDs, transaction IDs).

modestringrequired
  • hide_prefix - the configured prefix is hidden from clients for topics and IDs when reading.
    Created resources are written with the prefix on the backend cluster.
  • enforce_prefix - the configured prefix remains visible to clients.
    Created resources must include the prefix or the request will fail.

Allowed values:hide_prefixenforce_prefix

prefixstringrequired

The namespace is differentiated by this chosen prefix.
For example, if the prefix is set to “analytics_” the topic named “analytics_user_clicks” is available to the clients
of the virtual cluster. Topics without the prefix will be ignored unless added via additional.topics.

>= 1 characters

additionalobject
Show Child Parameters
Example

VirtualClusterNamespaceAdditionalProperties

object
topicsOne Of
array[object]

Additional backend topics to expose even if they don’t match the namespace prefix.
The topics are not affected by the hide/enforce prefix mode.
If the client tries to create a topic that matches this list, the request is rejected.

VirtualClusterNamespaceTopicSelectorGlobobject
Show Child Parameters
consumer_groupsOne Of
array[object]

Consumer group IDs to expose even if they don’t start with the namespace prefix.

VirtualClusterNamespaceIdSelectorGlobobject
Show Child Parameters
Example

VirtualClusterNamespaceTopicSelector

object
One Of
typestringrequired

Allowed values:glob

globstring(glob)required

Expose any backend topic that matches this glob pattern (e.g., operations_data_*).

Match pattern:^[A-Za-z0-9._?*-]+$

>= 1 characters

conflictstring

How to inform the user about conflicts where multiple backend topics would map to the same virtual topic name.

  • warn - log in the Event Gateway logs. Additionally, it sets knep_namespace_topic_conflict to 1.
  • ignore - do not do anything. It does not cause knep_namespace_topic_conflict metric to be set to 1.

Allowed values:warnignore

Default:warn

Example

VirtualClusterNamespaceTopicSelectorGlob

object
typestringrequired

Allowed values:glob

globstring(glob)required

Expose any backend topic that matches this glob pattern (e.g., operations_data_*).

Match pattern:^[A-Za-z0-9._?*-]+$

>= 1 characters

conflictstring

How to inform the user about conflicts where multiple backend topics would map to the same virtual topic name.

  • warn - log in the Event Gateway logs. Additionally, it sets knep_namespace_topic_conflict to 1.
  • ignore - do not do anything. It does not cause knep_namespace_topic_conflict metric to be set to 1.

Allowed values:warnignore

Default:warn

Example

VirtualClusterNamespaceTopicSelectorExactList

object
typestringrequired

Allowed values:exact_list

exact_listarray[object]

Explicit allow-list of backend topic names.

>= 1 items

Show Child Parameters
conflictstring

How to inform the user about conflicts where multiple backend topics would map to the same virtual topic name.

  • warn - log in the Event Gateway logs. Additionally, it sets knep_namespace_topic_conflict to 1.
  • ignore - do not do anything. It does not cause knep_namespace_topic_conflict metric to be set to 1.

Allowed values:warnignore

Default:warn

Example