Configuring Kafka

3.1.1.1 Configuring Kafka

Kafka is used as an internal transport to display live output from pipelines, errors, warnings, etc.

To configure Kafka:

Click the user name at the top right corner of the screen.
Click System Settings.
Click Environment.
Enter the Kafka bootstrap URL. Select the one of the available authentication methods:
- SSL: Select SSL to connect to an SSL enabled Kafka cluster.
  - Truststore: Locate and upload the truststore file. This field is applicable only to connect to an SSL enabled Kafka cluster.
  - Truststore Password: Enter the truststore password.
- MTLS: Select MLTS to enable 2-way authentication of both the user and the Kafka broker.
  - Truststore: Locate and upload the truststore file. This field is applicable only to connect to an SSL enabled Kafka cluster.
  - Truststore Password: Enter the truststore password.
  - Keystore: Locate and upload the keystore file. This field is applicable only to connect to an SSL enabled Kafka cluster.
  - Keystore Password: Enter the keystore password.
- SASL: Select SASL if Kafka broker requires authentication.
  - User Name: When using OCI Streaming Kafka compatibility APIs, enter the SASL username for Kafka broker, in the following format:
    
    tenancyName/username/stream pool id
    
    Note:
    Enter the tenancyName and userName, not tenancy OCID and user OCID. Similarly, enter the stream pool ID and not the stream pool name.
    
    You can retrieve this information from the OCI console. This field is enabled only if you have checked the SASL option.
  - Password: Enter the SASL password, which is an authentication token that you can generate on the User Details page, of the OCI console.
    
    Note:
    
    Copy the authentication token when you create it, and save it for future use. You can not retrieve it at a later stage.
  - Security Protocol: Select a security protocol from from the drop-down.
  - Security Mechanism: Select a security mechanism from the drop-down.

After this configuration, GGSA creates Kafka topics and Group IDs, to be used internally.

3.1.1.1.1 Internal Kafka Topics

The internal Kafka topics and Group ID's used by GGSA are standardized to the following naming conventions:

Kafka Topics

Topic	Resource	Operations
sx_backend_notification_<UUID>	Topic	CREATE,DELETE,DESCRIBE,DESCRIBE_CONFIGS,READ,WRITE
sx_messages_<UUID>	Topic	CREATE,DELETE,DESCRIBE,DESCRIBE_CONFIGS,READ,WRITE
sx_<application_name>_<stage_name>_public	Topic	CREATE,DELETE,DESCRIBE,DESCRIBE_CONFIGS,READ,WRITE
sx_<application_name>_<stage_name>_draft	Topic	CREATE,DELETE,DESCRIBE,DESCRIBE_CONFIGS,READ,WRITE
sx_<application_name>_public_<offset_number>_<stage_name>_offset	Topic	CREATE,DELETE,DESCRIBE,DESCRIBE_CONFIGS,READ,WRITE

Group IDs

Group ID	Resource	Operations
sx_<UUID>_receiver	Group	DESCRIBE, READ
sx_<UUID>	Group	DESCRIBE, READ
sx_<application_name>_public_<offset_number>_<stage_name>	Group	DESCRIBE, READ