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:
  1. Click the user name at the top right corner of the screen.
  2. Click System Settings.
  3. Click Environment.
  4. 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: Enter the SASL username.

        Note:

        OCI Streaming is not supported in Kafka System Settings.
      • 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

3.1.1.1.2 Configure OCI Streaming as Internal Kafka

  1. Go to OSA console > System Settings > Environment
  2. Set Kafka bootstrap to Stream Pool bootstrap server.
  3. Choose SASL, SASL_SSL protocol and PLAIN mechanism
  4. For username - refer the username in Kafka Connection Settings; replace ggstest with bmc_operator_access, so it becomes
    bmc_operator_access/<user>/ocid1.streampool.oc1.iad.amaaaaaarhwbfeqal54ke2pkcceczegwsfymerjqcory7k3d3s3ulx5bqpgq
  5. For password, provide the auth token saved earlier.