Managing clusters

A unique, human-readable identifier for the Kafka cluster. It helps differentiate between multiple Kafka clusters in environments with multiple deployments. Only letters, numbers and symbols _-. are permitted. Other special characters and spaces are not allowed.

A human-readable description of the Kafka cluster.

The type of Kafka cluster. Currently, only Apache Kafka is supported.

The URL of the Kafka bootstrap server that a client uses to connect to the Kafka cluster initially. The bootstrap URL helps the client to locate the Kafka cluster.

This value indicates where the cluster is deployed, such as "local" for local development environments or a region-specific identifier for different cloud environments.

Specify if the Kafka Admin Client needs to perform CA validation of the Broker server certificate.

When a Kafka cluster uses SSL/TLS encryption, certificates issued by a publicly trusted CA ensure secure communication between clients and brokers, preventing the need for manually managing custom certificates.

If Publicly Trusted CA is unchecked, configure the private CA certificate to sign the Broker Server certificate.

Specify the mechanism used to authenticate platform manager when connecting to the Kafka brokers. The supported authentication methods are mTLS and SASL (PLAIN, SCRAM_SHA_256, SCRAM_SHA_512). The operator can choose to use mTLS (then they pass cert and private key) or SASL (then they pass username/password).

Defines the visibility of the cluster. Shared cluster can be used by multiple tenants.

Choose between validating clients using either a simple certificate-based approach or a full principal chain. The certificate-based option verifies the client’s identity using just the Distinguished Name (DN). The full principal chain option ensures a more detailed verification by validating the entire chain of certificates, which is recommended for multi-tenant environments. The default value of the SSL authentication Mode is Certificate.

This pattern is used to determine the actual topic name in the Kafka cluster when a topic is created from Self Service. The default value for a topic pattern is {tenant}-{instance}-{environment}-{topic}

This pattern is used to determine the actual consumer group name in the Kafka cluster. The default value for a consumer group pattern is {tenant}-{instance}-{environment}-{group}

This pattern is used to determine the actual transactional IDs in the Kafka cluster. The default value for a transactional ID pattern is {tenant}-{instance}-{environment}-{transactional.id}

These are free-form Kafka bootstrap endpoints that can be listed for each type of security protocol. It is shown in the Connectivity Information section of the Application detail page. Users can use it to configure their producers and consumers. This is also helpful if you have different advertised URLs due to networking configurations.