Create a namespace in Hermes

  • Release version: Washingtondc
  • Updated February 1, 2024
  • 1 minute to read

    • Organize your Kafka topics by creating a namespace.

    Before you begin

    Role required: hermes_admin or kafka_namespace_admin

    About this task

    Use namespaces to organize Kafka topics in logical ways. For example:
    • Create namespace records for each Kafka cluster that replicates messages to Hermes.
    • Create namespace records for each domain in a domain-separated instance. For more information, see Hermes Messaging Service domain separation.

    Procedure

    1. Navigate to All > Hermes Messaging Service > Namespaces.
    2. Select New.
    3. On the form, fill in the fields.
      Table 1. Kafka namespace form
      Field Description
      Name Name of the namespace.
      Topic Prefix Prefix assigned to all topics in this namespace.

      Topics are assigned to namespaces based on the topic prefix. A scheduled job checks for new topics in Hermes. When it finds one, it creates a topic record and links the topic to the namespace.

      Warning:
      To avoid conflicts between the app ID and the namespace that could result in unexpected behavior, don't specify a topic prefix beginning with sn_ when creating a namespace record.
      Allowed Application Scopes List of application scopes that have access to this namespace.
    4. Select Submit.

    Result

    A namespace record is created in the Kafka Namespace [sys_kafka_namespace] table. Topics created in or replicated to Hermes are assigned to the namespace based on the topic prefix.

    What to do next