Skip to content

Commit a37f94e

Browse files
authored
docs(groups): addition of content for groups config page (#2413)
* docs(groups): addition of content for groups config page Signed-off-by: prmellor <pmellor@redhat.com> * docs(review): updates from comments by ME Signed-off-by: prmellor <pmellor@redhat.com> --------- Signed-off-by: prmellor <pmellor@redhat.com>
1 parent f624f7d commit a37f94e

8 files changed

+47
-10
lines changed

docs/sources/index.adoc

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,5 +30,6 @@ 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]
3232
include::modules/con-groups-page.adoc[leveloffset=+1]
33-
include::modules/proc-checking-consumer-groups-members.adoc[leveloffset=+2]
34-
include::modules/proc-resetting-consumer-offsets.adoc[leveloffset=+2]
33+
include::modules/proc-checking-group-members.adoc[leveloffset=+2]
34+
include::modules/proc-checking-group-configuration.adoc[leveloffset=+2]
35+
include::modules/proc-resetting-consumer-offsets.adoc[leveloffset=+2]

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Streams groups and Share groups were introduced in Apache Kafka 4.2.
2222

2323
For each group, the page shows information such as the group type and membership.
2424
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].
25+
Click a topic to view topic information available from the xref:con-topics-page-{context}[*Topics* page tabs].
2626

2727
Group status indicates the current state of a group.
2828
The exact states that appear depend on the group type.

docs/sources/modules/proc-changing-topic-configuration.adoc

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,13 @@ If you are using the Topic Operator to manage topics in unidirectional mode, con
1313
.Procedure
1414

1515
. Log in to the Kafka cluster in the StreamsHub Console, then click *Topics*.
16-
. Select the options icon (three vertical dots) for the relevant topic and click *Edit configuration*.
17-
Or you can click the name of the topic you want to configure from the *Topics* page and click the *Configuration* tab.
16+
. On the *Topics* page, click the name of the topic you want to configure.
17+
. Check the information on the *Configuration* tab.
1818
. Edit the configuration by updating individual property values.
1919
+
20-
Filter the configuration properties to narrow results by data source:
20+
Filter by property name or data source to narrow results.
21+
+
22+
Data sources include:
2123
+
2224
* *DEFAULT_CONFIG*: The fallback value used when no other configuration is specified.
2325
* *STATIC_BROKER_CONFIG*: Predefined, broker-wide values that apply to all topics by default.

docs/sources/modules/proc-checking-broker-configuration.adoc

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,12 @@ The broker page lists the configuration values for the broker.
1010
.Procedure
1111

1212
. Log in to the Kafka cluster in the StreamsHub Console, then click *Kafka nodes*.
13-
. On the *Nodes* page, click the name of the broker you want to inspect.
13+
. On the *Nodes* page, click the ID of the broker you want to inspect.
1414
. Check the information on the broker page.
1515
+
16-
Filter the configuration properties to narrow results by data source:
16+
Filter by property name or data source to narrow results.
17+
+
18+
Data sources include:
1719
+
1820
* *DEFAULT_CONFIG*: The fallback value used when no other configuration is specified.
1921
* *STATIC_BROKER_CONFIG*: Predefined, broker-wide values that apply to all topics by default.
Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
:_mod-docs-content-type: PROCEDURE
2+
3+
[id='proc-checking-group-configuration-{context}']
4+
= Checking group configuration
5+
6+
[role="_abstract"]
7+
Check the configuration of a specific group from the *Configuration* tab.
8+
The *Configuration* tab lists the configuration values for the group.
9+
10+
NOTE: Default values apply only to the group type they are defined for.
11+
Some settings may appear for all groups but take effect only for the relevant group type.
12+
For example, `consumer.session.timeout.ms` appears globally but applies only to Consumer groups.
13+
14+
.Procedure
15+
16+
. Log in to the Kafka cluster in the StreamsHub Console, then click *Groups*.
17+
. On the *Groups* page, click the ID of the group you want to inspect.
18+
. Check the information on the *Configuration* tab.
19+
+
20+
Filter by property name or data source to narrow results.
21+
+
22+
Data sources include:
23+
+
24+
* *DEFAULT_CONFIG*: The default configuration value used when no group-specific configuration is set.
25+
* *DYNAMIC_GROUP_CONFIG*: A configuration value that has been explicitly set for the group.

docs/sources/modules/proc-checking-consumer-groups-members.adoc renamed to docs/sources/modules/proc-checking-group-members.adoc

File renamed without changes.

docs/sources/modules/proc-checking-topic-configuration.adoc

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,9 @@ TIP: The Strimzi Topic Operator simplifies the process of creating and managing
1515
. On the *Topics* page, click the name of the topic you want to inspect.
1616
. Check the information on the *Configuration* tab.
1717
+
18-
Filter the configuration properties to narrow results by data source:
18+
Filter by property name or data source to narrow results.
19+
+
20+
Data sources include:
1921
+
2022
* *DEFAULT_CONFIG*: The fallback value used when no other configuration is specified.
2123
* *STATIC_BROKER_CONFIG*: Predefined, broker-wide values that apply to all topics by default.

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

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,12 @@ All active members of the consumer group must be shut down before resetting the
1919

2020
. Log in to the Kafka cluster in the StreamsHub Console, then click *Groups*.
2121

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.
22+
. Start the offset reset operation in one of the following ways:
23+
+
24+
* On the *Groups* page, click the options icon (three vertical dots) for the consumer group and select *Reset offsets*.
25+
* On the *Groups* page, click the name of the consumer group to open the group details page, then click *Reset offset*.
26+
+
27+
This opens the *Reset consumer offset* page.
2328

2429
. Choose whether to apply the offset reset to all consumer topics associated with the consumer group or to a specific topic.
2530
+

0 commit comments

Comments
 (0)