Skip to content
Open
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions docs/sources/assemblies/assembly-deploying.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -16,14 +16,14 @@ You can configure the console to use an existing Prometheus source.
If no source is set, the operator creates a private Prometheus instance when the console is deployed.
However, this default setup is not recommended for production and should only be used for development or evaluation purposes.

Connect the console to one or more Kafka clusters to provide visibility into topics, Kafka nodes, and consumer groups.
Connect the console to one or more Kafka clusters to provide visibility into topics, Kafka nodes, and groups used by Kafka client applications to coordinate work.

Configure the console to integrate with related services, including:

* **Authentication providers** for securing access to Kafka clusters
* **Kafka Connect clusters** for viewing connector and configuration details
* **Metrics providers** for monitoring Kafka cluster performance
* **Schema registries** for validating and decoding messages using data schemas
* **Authentication providers** to secure access to Kafka clusters
* **Kafka Connect clusters** to view connector and configuration details
* **Metrics providers** to monitor Kafka cluster performance
* **Schema registries** to validate and decode messages using data schemas

Define these integrations in the `Console` custom resource configuration YAML file.

Expand Down
2 changes: 1 addition & 1 deletion docs/sources/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,6 @@ include::modules/proc-checking-connectors.adoc[leveloffset=+2]
include::modules/proc-checking-connect-clusters.adoc[leveloffset=+2]
include::modules/con-users-page.adoc[leveloffset=+1]
include::modules/proc-checking-users.adoc[leveloffset=+2]
include::modules/con-consumer-groups-page.adoc[leveloffset=+1]
include::modules/con-groups-page.adoc[leveloffset=+1]
include::modules/proc-checking-consumer-groups-members.adoc[leveloffset=+2]
include::modules/proc-resetting-consumer-offsets.adoc[leveloffset=+2]
20 changes: 0 additions & 20 deletions docs/sources/modules/con-consumer-groups-page.adoc

This file was deleted.

30 changes: 30 additions & 0 deletions docs/sources/modules/con-groups-page.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
:_mod-docs-content-type: CONCEPT

[id='con-groups-page-{context}']
= Groups page

[role="_abstract"]
The *Groups* page lists all groups associated with a Kafka cluster.
Groups represent client applications that coordinate work across multiple instances.

You can filter the list by group name or status.

Kafka supports the following group types:

* *Consumer groups* coordinate message consumption across multiple consumer instances. Each consumer in the group processes a subset of topic partitions.
* *Classic groups* use the older Kafka consumer group protocol that existed before the newer consumer protocol was introduced.
* *Streams groups* are created by Kafka Streams applications to coordinate stream processing tasks.
* *Share groups* distribute message processing across multiple consumers using a shared consumption model. Multiple consumers can process messages from the same partition concurrently.

For each group, the page shows information such as the group type and membership.
For consumer groups, the console also displays the overall consumer lag across partitions and the number of members.
Click on associated topics to view topic information available from the xref:con-topics-page-{context}[*Topics* page tabs].

Consumer group status can be one of the following:

* *Stable* indicates normal operation.
* *Rebalancing* indicates that group membership is being adjusted.
* *Empty* indicates that the group has no active members.

Click a group name to view group details and membership information.
Select the options icon (three vertical dots) for a consumer group to reset consumer offsets.
3 changes: 2 additions & 1 deletion docs/sources/modules/con-navigating-the-console.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,8 @@ Nodes:: Details broker and controller nodes, including roles, status, and partit
Topics:: Lists topics with configuration details, partition data, and associated groups.
Kafka Connect:: Displays information about Kafka Connect clusters, including connector status, configuration details, and available plugins.
Kafka Users:: Lists Kafka users associated with the selected cluster and shows the namespace for each user.
Consumer groups:: Shows group activity, offsets, lag metrics, and partition assignments.
Groups:: Lists groups associated with the cluster and shows group activity, membership, and assignments.
Offset and lag metrics are available for consumer groups.

NOTE: If the cluster navigation menu is hidden, click the navigation menu icon (three horizontal lines) in the console header to reveal it.

Expand Down
14 changes: 7 additions & 7 deletions docs/sources/modules/con-topics-page.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,18 +7,18 @@
The *Topics* page lists all topics created for a Kafka cluster.
You can filter the list by topic name, ID, or status.

The *Topics* page shows the overall replication status for partitions in the topic, as well as counts for the partitions in the topic and the number of associated consumer groups.
The overall storage used by the topic is also shown.
The *Topics* page shows the overall replication status of topic partitions, the number of partitions, and the number of associated groups.
The page also shows the total storage used by the topic data.

WARNING: Internal topics must not be modified. You can choose to hide internal topics from the list of topics returned on the *Topics* page.

Click on a topic name to view additional topic information presented on a series of tabs:

Messages:: Messages shows the message log for a topic.
Partitions:: Partitions shows the replication status of each partition in a topic.
Consumer groups:: Consumer groups lists the names and status of the consumer groups and group members connected to a topic.
Configuration:: Configuration shows the configuration of a topic.
Messages:: Shows the message log for the topic.
Partitions:: Shows the replication status of each partition.
Groups:: Lists the groups associated with the topic, including their status and members. Offset and lag information is available for consumer groups.
Configuration:: Shows the topic configuration.

If a topic is shown as *Managed*, it means that is managed using the Strimzi Topic Operator and was not created directly in the Kafka cluster.
If a topic is shown as *Managed*, it means that it is managed by the Strimzi Topic Operator and was not created directly in the Kafka cluster.

Use the information provided on the tabs to check and modify the configuration of your topics.