Skip to content

Commit 2e529e9

Browse files
committed
code review suggestions
1 parent 1850302 commit 2e529e9

File tree

1 file changed

+41
-4
lines changed

1 file changed

+41
-4
lines changed

modules/manage/pages/cluster-maintenance/topic-property-configuration.adoc

Lines changed: 41 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,12 +21,49 @@ You can configure topic properties through multiple interfaces:
2121

2222
== Verify topic property configuration
2323

24-
The `SOURCE` output of the xref:reference:rpk/rpk-topic/rpk-topic-describe.adoc[`rpk topic describe <topic>`] command shows how properties are configured for the topic:
24+
Use `rpk topic describe <topic>` to view topic properties and their configuration sources:
2525

26-
* `DEFAULT_CONFIG` is set by a Redpanda default.
27-
* `DYNAMIC_TOPIC_CONFIG` is set by the user specifically for the topic and overrides inherited default configurations, such as a default or a cluster-level property.
26+
```
27+
rpk topic describe my-topic
28+
```
29+
30+
The output shows two sections:
31+
32+
```
33+
SUMMARY
34+
=======
35+
NAME my-topic
36+
PARTITIONS 1
37+
REPLICAS 1
38+
39+
CONFIGS
40+
=======
41+
KEY VALUE SOURCE
42+
cleanup.policy delete DEFAULT_CONFIG
43+
compression.type producer DEFAULT_CONFIG
44+
retention.ms 604800000 DEFAULT_CONFIG
45+
write.caching true DYNAMIC_TOPIC_CONFIG
46+
```
47+
48+
The `SOURCE` column indicates how each property is configured:
49+
50+
* `DEFAULT_CONFIG` - Redpanda's default value
51+
* `DYNAMIC_TOPIC_CONFIG` - User-configured value
2852

29-
Although xref:reference:rpk/rpk-topic/rpk-topic-describe.adoc[`rpk topic describe`] doesn't report `replication.factor` as a configuration, `replication.factor` can indeed be set by using the xref:reference:rpk/rpk-topic/rpk-topic-alter-config.adoc[`rpk topic alter-config`] command.
53+
The replication factor appears as REPLICAS in the SUMMARY section, not as replication.factor in the CONFIGS list. However, you need to use the `replication.factor` key when modifying the value with `rpk topic alter-config`.
54+
55+
For partition-level details, add the `-p` flag:
56+
57+
```
58+
rpk topic describe my-topic -p
59+
```
60+
61+
This shows a different output focused on partition information:
62+
63+
```
64+
PARTITION LEADER EPOCH REPLICAS LOG-START-OFFSET HIGH-WATERMARK
65+
0 0 1 [0] 0 0
66+
```
3067

3168
== Examples
3269

0 commit comments

Comments
 (0)