Skip to content

Commit 9332f3d

Browse files
authored
docs: add rpk config list (#1259)
1 parent e153bce commit 9332f3d

File tree

2 files changed

+81
-0
lines changed

2 files changed

+81
-0
lines changed

modules/ROOT/nav.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -275,6 +275,7 @@
275275
***** xref:reference:rpk/rpk-cluster/rpk-cluster-config-force-reset.adoc[]
276276
***** xref:reference:rpk/rpk-cluster/rpk-cluster-config-get.adoc[]
277277
***** xref:reference:rpk/rpk-cluster/rpk-cluster-config-import.adoc[]
278+
***** xref:reference:rpk/rpk-cluster/rpk-cluster-config-list.adoc[]
278279
***** xref:reference:rpk/rpk-cluster/rpk-cluster-config-lint.adoc[]
279280
***** xref:reference:rpk/rpk-cluster/rpk-cluster-config-set.adoc[]
280281
***** xref:reference:rpk/rpk-cluster/rpk-cluster-config-status.adoc[]
Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
= rpk cluster config list
2+
// tag::single-source[]
3+
4+
This command lists all available cluster configuration properties. Use the xref:reference:rpk/rpk-cluster/rpk-cluster-config-get.adoc[`rpk cluster config get`] command to retrieve specific property values, or xref:reference:rpk/rpk-cluster/rpk-cluster-config-edit.adoc[`rpk cluster config edit`] for interactive editing.
5+
6+
Use the `--filter` flag with a regular expression to filter configuration keys. This is useful for exploring related configuration properties or finding specific settings.
7+
8+
== Usage
9+
10+
[,bash]
11+
----
12+
rpk cluster config list [flags]
13+
----
14+
15+
== Examples
16+
17+
List all cluster configuration properties:
18+
19+
[,bash]
20+
----
21+
rpk cluster config list
22+
----
23+
24+
List configuration properties matching a filter:
25+
26+
[,bash]
27+
----
28+
rpk cluster config list --filter="kafka.*"
29+
----
30+
31+
Filter properties containing "log":
32+
33+
[,bash]
34+
----
35+
rpk cluster config list --filter=".*log.*"
36+
----
37+
38+
Filter with case-insensitive matching:
39+
40+
[,bash]
41+
----
42+
rpk cluster config list --filter="(?i)batch.*"
43+
----
44+
45+
List configuration properties in JSON format:
46+
47+
[,bash]
48+
----
49+
rpk cluster config list --format=json
50+
----
51+
52+
List configuration properties in YAML format:
53+
54+
[,bash]
55+
----
56+
rpk cluster config list --format=yaml
57+
----
58+
59+
== Flags
60+
61+
[cols="1m,1a,2a"]
62+
|===
63+
|*Value* |*Type* |*Description*
64+
65+
|--filter |string |Filter configuration keys using regular expression.
66+
67+
|--format |string |Output format. Possible values: `json`, `yaml`, `text`, `wide`, `help`. Default: `text`.
68+
69+
|-h, --help |- |Help for list.
70+
71+
|--config |string |Redpanda or `rpk` config file; default search paths are `/var/lib/redpanda/.config/rpk/rpk.yaml`, `$PWD/redpanda.yaml`, and `/etc/redpanda/redpanda.yaml`.
72+
73+
|-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail.
74+
75+
|--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details.
76+
77+
|-v, --verbose |- |Enable verbose logging.
78+
|===
79+
80+
// end::single-source[]

0 commit comments

Comments
 (0)