Kong · Schema

VirtualClusterNamespace

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).

API GatewayAI GatewayAI ConnectivityAgent GatewayEvent GatewayMCP RegistryService MeshLLMKafkaKonnectOpen Source

Properties

Name Type Description
mode string * 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 pr
prefix string 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. Top
additional object
View JSON Schema on GitHub

JSON Schema

kong-virtualclusternamespace-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/VirtualClusterNamespace",
  "title": "VirtualClusterNamespace",
  "description": "Namespace allows to implement multitenancy using a single backend cluster.\nIt allows to either hide or enforce a static prefix on resources (topics, consumer group IDs, transaction IDs).\n",
  "type": "object",
  "properties": {
    "mode": {
      "description": "* hide_prefix - the configured prefix is hidden from clients for topics and IDs when reading.\n\n\n  Created resources are written with the prefix on the backend cluster.\n* enforce_prefix - the configured prefix remains visible to clients.\n\n\n  Created resources must include the prefix or the request will fail.\n",
      "type": "string",
      "enum": [
        "hide_prefix",
        "enforce_prefix"
      ],
      "x-speakeasy-unknown-values": "allow"
    },
    "prefix": {
      "description": "The namespace is differentiated by this chosen prefix.\nFor example, if the prefix is set to \"analytics_\" the topic named \"analytics_user_clicks\" is available to the clients\nof the virtual cluster. Topics without the prefix will be ignored unless added via `additional.topics`.\n",
      "type": "string",
      "minLength": 1
    },
    "additional": {
      "$ref": "#/components/schemas/VirtualClusterNamespaceAdditionalProperties"
    }
  },
  "required": [
    "mode",
    "prefix"
  ]
}