Using the Streams for Apache Kafka Console

Procedure

1. Create a Console custom resource in the desired namespace.

   If you deployed the example Kafka cluster provided with the installation artifacts, you can use the configuration specified in the examples/console/resources/console/010-Console-example.yaml configuration file unchanged.

   Otherwise, configure the resource to connect to your Kafka cluster.

   Example console configuration

   apiVersion: console.streamshub.github.com/v1alpha1
   kind: Console
   metadata:
     name: my-console
   spec:
     hostname: my-console.<cluster_domain> 

   1

   
     kafkaClusters:
       - name: console-kafka 

   2

   
         namespace: kafka 

   3

   
         listener: secure 

   4

   
         properties:
           values: [] 

   5

   
           valuesFrom: [] 

   6

   
         credentials:
           kafkaUser:
             name: console-kafka-user1 

   7

   1

   Hostname to access the console by HTTP.

   2

   Name of the Kafka resource representing the cluster.

   3

   Namespace of the Kafka cluster.

   4

   Listener to expose the Kafka cluster for console connection.

   5

   (Optional) Add connection properties if needed.

   6

   (optional) References to config maps or secrets, if needed.

   7

   (Optional) Kafka user created for authenticated access to the Kafka cluster.

2. Apply the Console configuration to install the console.

   In this example, the console is deployed to the console-namespace namespace:

   oc apply -f examples/console/resources/console/010-Console-example.yaml -n console-namespace

3. Check the status of the deployment:

   oc get pods -n console-namespace

   Output shows the deployment name and readiness

   NAME           READY  STATUS  RUNNING
   console-kafka  1/1    1       1

4. Access the console.

   When the console is running, use the hostname specified in the Console resource (spec.hostname) to access the user interface.

Procedure

1. From the homepage, optionally filter the list of clusters by name, then click Login to cluster for a selected Kafka cluster.

2. Enter login credentials depending on the authentication method used.

   • For SCRAM-SHA-512, enter the username and password associated with the KafkaUser.
   • For OAuth 2.0, provide a client ID and client secret that is valid for the OAuth provider configured for the Kafka listener.
3. To end your session, click your username and select Logout, or return to the homepage.

Procedure

1. Log in to the Kafka cluster in the Streams for Apache Kafka Console.
   On the Cluster overview page, click Pause reconciliation.
2. Confirm the pause, after which the Cluster overview page shows a change of status warning that reconciliation is paused.
3. Click Resume reconciliation to restart reconciliation.

Procedure

1. Log in to the Kafka cluster in the Streams for Apache Kafka Console.
   On the Cluster overview page, click Cluster connection details.
2. Copy the bootstrap address (external or internal, depending on your client environment).
3. Add any required connection properties to your Kafka client configuration to establish a secure connection.

Procedure

1. Log in to the Kafka cluster in the Streams for Apache Kafka Console, then click Topics.
2. From the Topics page, click the name of the topic you want to inspect.

3. Check the information on the Messages tab.

   For each message, you can view its timestamp (in UTC), offset, key, and value.

   Click on a message to view the full message details.

   Click the Manage columns icon (represented as two columns) to choose the information to display.

4. Click the search dropdown and select the advanced search options to refine your search.

   Choose to display the latest messages or messages from a specified time or offset. You can display messages for all partitions or a specified partition.

   When you are done, you can click the CSV icon (represented as a CSV file) to download the information on the returned messages.

Procedure

1. Log in to the Kafka cluster in the Streams for Apache Kafka Console, then click Topics.
2. From the Topics page, click the name of the topic you want to inspect.
3. Check the information on the Partitions tab.

Procedure

1. Log in to the Kafka cluster in the Streams for Apache Kafka Console, then click Topics.
2. From the Topics page, click the name of the topic you want to inspect.
3. Check the information on the Consumer groups tab.
4. Click a consumer group name to view consumer group members.

Procedure

1. Log in to the Kafka cluster in the Streams for Apache Kafka Console, then click Topics.
2. From the Topics page, click the name of the topic you want to inspect.
3. Check the information on the Configuration tab.

Procedure

1. Log in to the Kafka cluster in the Streams for Apache Kafka Console, then click Kafka nodes.

2. Check the information on the Rebalance tab.

   For each rebalance, you can view its status and the time it was last updated.

   Expand

   Table 7.1. Rebalance status descriptions

   Status	Description
   New	Resource has not been observed by the operator before
   PendingProposal	Optimization proposal not generated
   ProposalReady	Optimization proposal is ready for approval
   Rebalancing	Rebalance in progress
   Stopped	Rebalance stopped
   NotReady	Error ocurred with the rebalance
   Ready	Rebalance complete
   ReconciliationPaused	Rebalance is paused

   Show more
   Note

   The status of the KafkaRebalance resource changes to ReconciliationPaused when the strimzi.io/pause-reconciliation annotation is set to true in its configuration.

3. Click on the right arrow (>) next to a rebalance name to view more information about the broker, including its rebalance mode, and whether auto-approval is enabled. If the rebalance involved brokers being removed or added, they are also listed.

Procedure

1. Log in to the Kafka cluster in the Streams for Apache Kafka Console, then click Consumer Groups.
2. From the Consumer Groups page, click the name of the consumer group you want to inspect.
3. Click on the right arrow (>) next to a member ID to view the topic partitions a member is associated with, as well as any possible consumer lag.

Procedure

1. Log in to the Kafka cluster in the Streams for Apache Kafka Console, then click Consumer Groups.
2. Click the options icon (three vertical dots) for the consumer group and click the reset consumer offsets option to display the Reset consumer offset page.

3. Choose to apply the offset reset to all consumer topics associated with the consumer group or select a specific topic.

   If you selected a topic, choose to apply the offset reset to all partitions or select a specific partition.

4. Choose the position to reset the offset:

   • Custom offset (available only if you selected a specific topic and a specific partition)
     If you select this option, enter the custom offset value.
   • Latest offset
   • Earliest offset
   • Specific date and time
     If you selected date and time, choose the appropriate format and enter the date in that format.
5. Click Reset to perform the offset reset.

1. From the Reset consumer offset page, click the down arrow next to Dry run.
2. Choose the option to run and show the results in the console.
   Or you can copy the dry run command and run it independently against the consumer group.