Skip to content

Commit 15e7a01

Browse files
authored
docs(groups): updates the groups page to reflect group types (#2393)
* docs(groups): updates the groups page to reflect group types Signed-off-by: prmellor <pmellor@redhat.com> * docs(review): updates from review by copilot Signed-off-by: prmellor <pmellor@redhat.com> * docs(review): updates from comments by TC /01 Signed-off-by: prmellor <pmellor@redhat.com> * docs(review): updates from comments by ME /01 Signed-off-by: prmellor <pmellor@redhat.com> --------- Signed-off-by: prmellor <pmellor@redhat.com>
1 parent 4d855be commit 15e7a01

9 files changed

+86
-56
lines changed

docs/sources/assemblies/assembly-deploying.adoc

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -16,14 +16,14 @@ You can configure the console to use an existing Prometheus source.
1616
If no source is set, the operator creates a private Prometheus instance when the console is deployed.
1717
However, this default setup is not recommended for production and should only be used for development or evaluation purposes.
1818

19-
Connect the console to one or more Kafka clusters to provide visibility into topics, Kafka nodes, and consumer groups.
19+
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.
2020

2121
Configure the console to integrate with related services, including:
2222

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

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

docs/sources/index.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,6 @@ include::modules/proc-checking-connectors.adoc[leveloffset=+2]
2929
include::modules/proc-checking-connect-clusters.adoc[leveloffset=+2]
3030
include::modules/con-users-page.adoc[leveloffset=+1]
3131
include::modules/proc-checking-users.adoc[leveloffset=+2]
32-
include::modules/con-consumer-groups-page.adoc[leveloffset=+1]
32+
include::modules/con-groups-page.adoc[leveloffset=+1]
3333
include::modules/proc-checking-consumer-groups-members.adoc[leveloffset=+2]
3434
include::modules/proc-resetting-consumer-offsets.adoc[leveloffset=+2]

docs/sources/modules/con-consumer-groups-page.adoc

Lines changed: 0 additions & 20 deletions
This file was deleted.
Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
:_mod-docs-content-type: CONCEPT
2+
3+
[id='con-groups-page-{context}']
4+
= Groups page
5+
6+
[role="_abstract"]
7+
The *Groups* page lists all groups associated with a Kafka cluster.
8+
Groups represent client applications that coordinate work across multiple instances.
9+
10+
You can filter the list by group name, type, or status.
11+
12+
Kafka supports the following group types:
13+
14+
* *Consumer groups* coordinate message consumption across multiple consumer instances. Each consumer in the group processes a subset of topic partitions.
15+
* *Classic groups* use the original Kafka consumer group protocol used by earlier Kafka consumer clients.
16+
* *Streams groups* are created by Kafka Streams applications to coordinate stream processing tasks.
17+
* *Share groups* distribute message processing across multiple consumers using a shared consumption model. Multiple consumers can process messages from the same partition concurrently.
18+
19+
Apache Kafka introduced a newer consumer group protocol in version 4.0.
20+
Clients that use this protocol appear as *Consumer* groups in the console, while clients that use the original protocol appear as *Classic* groups.
21+
Streams groups and Share groups were introduced in Apache Kafka 4.2.
22+
23+
For each group, the page shows information such as the group type and membership.
24+
The console also displays the overall consumer lag across partitions and the number of members.
25+
Click associated topics to view topic information available from the xref:con-topics-page-{context}[*Topics* page tabs].
26+
27+
Group status indicates the current state of a group.
28+
The exact states that appear depend on the group type.
29+
30+
Common states include:
31+
32+
* *Stable* indicates normal operation.
33+
* *Empty* indicates that the group exists but currently has no active members.
34+
* *Dead* indicates that the group is being removed after all members have left and retention has expired.
35+
36+
Some group types might display additional states depending on the group protocol:
37+
38+
* *PreparingRebalance* and *CompletingRebalance* can appear for Classic and Consumer groups while partition assignments are being updated.
39+
* *Assigning* can appear for Consumer and Streams groups when a new partition assignment has been calculated but has not yet been applied to all members.
40+
* *Reconciling* can appear for Consumer and Streams groups while members are transitioning to their assigned partitions.
41+
* *NotReady* can appear for Streams groups when the application topology or required topics are not yet ready for processing.
42+
43+
Click a group name to view group details and membership information.
44+
Select the options icon (three vertical dots) for a consumer group to reset consumer offsets.
45+
46+
NOTE: Resetting offsets is supported only for consumer groups.
47+
Streams groups and Share groups do not currently support offset reset operations.

docs/sources/modules/con-navigating-the-console.adoc

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,8 @@ Nodes:: Details broker and controller nodes, including roles, status, and partit
1212
Topics:: Lists topics with configuration details, partition data, and associated groups.
1313
Kafka Connect:: Displays information about Kafka Connect clusters, including connector status, configuration details, and available plugins.
1414
Kafka Users:: Lists Kafka users associated with the selected cluster and shows the namespace for each user.
15-
Consumer groups:: Shows group activity, offsets, lag metrics, and partition assignments.
15+
Groups:: Lists groups associated with the cluster and shows group activity, membership, and assignments.
16+
Offset and lag metrics are available for consumer groups.
1617

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

docs/sources/modules/con-topics-page.adoc

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,18 +7,18 @@
77
The *Topics* page lists all topics created for a Kafka cluster.
88
You can filter the list by topic name, ID, or status.
99

10-
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.
11-
The overall storage used by the topic is also shown.
10+
The *Topics* page shows the overall replication status of topic partitions, the number of partitions, and the number of associated groups.
11+
The page also shows the total storage used by the topic data.
1212

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

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

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

22-
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.
22+
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.
2323

2424
Use the information provided on the tabs to check and modify the configuration of your topics.
Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
11
:_mod-docs-content-type: PROCEDURE
22

3-
[id='proc-checking-consumer-groups-members-{context}']
4-
= Checking consumer group members
3+
[id='proc-checking-group-members-{context}']
4+
= Checking group members
55

66
[role="_abstract"]
7-
Check the members of a specific consumer group from the *Consumer Groups* page.
7+
Check the members of a group from the *Groups* page.
88

99
.Procedure
1010

11-
. Log in to the Kafka cluster in the StreamsHub Console, then click *Consumer Groups*.
12-
. On the *Consumer Groups* page, click the name of the consumer group you want to inspect.
13-
. 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.
11+
. Log in to the Kafka cluster in the StreamsHub Console, then click *Groups*.
12+
. On the *Groups* page, click the name of the group you want to inspect.
13+
. Click the right arrow (>) next to a member ID to view the topic partitions associated with the member and any available lag information.
1414
+
15-
For each group member, you see the unique (consumer) client ID assigned to the consumer within the consumer group, overall consumer lag, and the number of assigned partitions.
15+
For each group member, the console shows information such as the client ID, the number of assigned partitions, and any available offset or lag metrics.
1616
+
17-
Any consumer lag for a specific topic partition reflects the gap between the last message a consumer has picked up (committed offset position) and the latest message written by the producer (end offset position).
17+
For consumer groups, lag reflects the gap between the last message processed by a consumer (committed offset position) and the latest message written to the partition (end offset position).

docs/sources/modules/proc-checking-topic-consumer-groups.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ NOTE: Monitoring consumer group behavior is essential for ensuring optimal distr
1818

1919
Consumer groups::
2020
For each consumer group, view the status, the overall consumer lag across all partitions, and the number of members.
21-
For more information on checking consumer groups, see xref:con-consumer-groups-page-{context}[].
21+
For more information on checking consumer groups, see xref:con-groups-page-{context}[].
2222

2323
Group members::
2424
For each group member, you see the unique (consumer) client ID assigned to the consumer within the consumer group, overall consumer lag, and the number of assigned partitions.

docs/sources/modules/proc-resetting-consumer-offsets.adoc

Lines changed: 15 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,47 +1,49 @@
11
:_mod-docs-content-type: PROCEDURE
22

3-
[id='proc-restting-consumer-offsets-{context}']
3+
[id='proc-resetting-consumer-offsets-{context}']
44
= Resetting consumer offsets
55

66
[role="_abstract"]
7-
Reset the consumer offsets of a specific consumer group from the *Consumer Groups* page.
7+
Reset the consumer offsets of a specific consumer group from the *Groups* page.
88

99
You might want to do this when reprocessing old data, skipping unwanted messages, or recovering from downtime.
1010

11+
NOTE: Resetting offsets is supported only for consumer groups.
12+
Streams groups and Share groups do not currently support offset reset operations.
13+
1114
.Prerequisites
1215

1316
All active members of the consumer group must be shut down before resetting the consumer offsets.
1417

1518
.Procedure
1619

17-
. Log in to the Kafka cluster in the StreamsHub Console, then click *Consumer Groups*.
20+
. Log in to the Kafka cluster in the StreamsHub Console, then click *Groups*.
1821

19-
. 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.
22+
. Click the options icon (three vertical dots) for the consumer group and select the reset consumer offsets option to open the *Reset consumer offset* page.
2023

21-
. Choose to apply the offset reset to all consumer topics associated with the consumer group or select a specific topic.
24+
. Choose whether to apply the offset reset to all consumer topics associated with the consumer group or to a specific topic.
2225
+
23-
If you selected a topic, choose to apply the offset reset to all partitions or select a specific partition.
26+
If you selected a topic, choose whether to apply the offset reset to all partitions or to a specific partition.
2427

2528
. Choose the position to reset the offset:
2629
+
27-
* Custom offset (available only if you selected a specific topic _and_ a specific partition).
28-
If you select this option, enter the custom offset value.
30+
* Custom offset (available only if you selected a specific topic and a specific partition). Enter the custom offset value.
2931
* Latest offset
3032
* Earliest offset
3133
* Specific date and time
32-
* Delete committed offsets (available only if you selected a specific topic).
34+
* Delete committed offsets (available only if you selected a specific topic)
3335
+
3436
If you selected date and time, choose the appropriate format and enter the date in that format.
3537
+
3638
IMPORTANT: The *Delete committed offsets* option removes the stored offsets from the consumer group.
3739
When the group resumes, offset behavior depends on the consumer configuration (for example, the `auto.offset.reset` setting).
3840
Use this option with caution.
3941

40-
. (Optional) Perform a dry run before applying the offset reset.
42+
. (Optional) Perform a dry run before applying the offset reset.
43+
+
44+
.. Click the down arrow next to *Dry run*.
45+
.. Choose to run the dry run and view the results in the console, or copy the command to run it independently against the consumer group.
4146
+
42-
.. Click the down arrow next to *Dry run*.
43-
.. Choose the option to run the dry run and view the results in the console, or copy the command to run it independently against the consumer group.
44-
+
4547
The results display the new offsets for each topic partition included in the reset operation.
4648
A download option is available for the results.
4749

0 commit comments

Comments
 (0)