Skip to content

Commit d923570

Browse files
kbatuigasmicheleRP
andauthored
Rpk cluster config edits (#1143)
Co-authored-by: Michele Cyran <michele@redpanda.com>
1 parent 2032aee commit d923570

6 files changed

Lines changed: 26 additions & 31 deletions

File tree

modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config-edit.adoc

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,16 +4,15 @@ Edit cluster-wide configuration properties.
44

55
This command opens a text editor to modify the cluster's configuration.
66

7-
Cluster properties are redpanda settings which apply to all nodes in
8-
the cluster. These are separate to node properties, which are set with
9-
`rpk redpanda config`.
7+
Cluster properties are Redpanda settings that apply to all brokers in
8+
the cluster. These are separate from broker properties, which you can set with `rpk redpanda config`.
109

11-
Modified values are written back when the file is saved and the editor
12-
is closed. Properties which are deleted are reset to their default
13-
values.
10+
Modified values are saved after the file is saved and the editor
11+
is closed. If you delete a property, Redpanda resets it to its default
12+
value.
1413

15-
By default, low level tunables are excluded: use the `--all` flag
16-
to edit all properties including these tunables.
14+
By default, low-level tunables are excluded. Use the `--all` flag
15+
to edit all properties including tunables.
1716

1817
== Usage
1918

modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config-export.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@ Writes out a YAML representation of the cluster configuration to a file,
66
suitable for editing and later applying with the corresponding `import`
77
command.
88

9-
By default, low level tunables are excluded: use the `--all` flag
10-
to include all properties including these low level tunables.
9+
By default, low-level tunables are excluded. Use the `--all` flag
10+
to edit all properties, including these tunables.
1111

1212
== Usage
1313

@@ -22,7 +22,7 @@ rpk cluster config export [flags]
2222
|===
2323
|*Value* |*Type* |*Description*
2424

25-
|-f, --filename |string |path to file to export to, e.g. './config.yml'.
25+
|-f, --filename |string |Path to file to export to; for example, `./config.yml`.
2626

2727
|-h, --help |- |Help for export.
2828

modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config-force-reset.adoc

Lines changed: 9 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,15 @@
11
= rpk cluster config force-reset
22

3-
Forcibly clear a cluster configuration property on this node.
3+
Forcibly clear a cluster configuration property on a broker.
44

5-
This command is not for general changes to cluster configuration: use this only
6-
when redpanda will not start due to a configuration issue.
5+
Do not use this command for general changes to cluster configuration. Use `force-reset` only when Redpanda does not start due to a configuration issue; for example, when a property is set to an invalid value or when a property is missing that Redpanda requires to start.
76

8-
If your cluster is working properly and you would like to reset a property
9-
to its default, you may use the `set` command with an empty string, or
10-
use the `edit` command and delete the property`s line.
7+
This command erases the named property from an internal cache of the cluster configuration on the local broker, so that on next startup Redpanda treats
8+
the property as if it was set to the default.
119

12-
This command erases a named property from an internal cache of the cluster
13-
configuration on the local node, so that on next startup redpanda will treat
14-
the setting as if it was set to the default.
10+
If your cluster is working properly and you want to reset a property
11+
to its default value, either use the `set` command with an empty string, or
12+
use the `edit` command and delete the line containing the property.
1513

1614
WARNING: Use this command only when Redpanda isn't running.
1715

@@ -28,8 +26,8 @@ rpk cluster config force-reset [PROPERTY...] [flags]
2826
|===
2927
|*Value* |*Type* |*Description*
3028

31-
|--cache-file |string |location of configuration cache file (defaults to
32-
redpanda data directory).
29+
|--cache-file |string |Location of configuration cache file (defaults to
30+
Redpanda `data` directory).
3331

3432
|-h, --help |- |Help for force-reset.
3533

modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config-get.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,10 @@
22

33
Get a cluster configuration property.
44

5+
ifndef::env-cloud[]
56
This command is provided for use in scripts. For interactive editing, or bulk
67
output, use the `edit` and `export` commands respectively.
8+
endif::[]
79

810
== Usage
911

modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config-import.adoc

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,7 @@ CAUTION: Redpanda does not support importing cluster-specific identification (su
44

55
Import cluster configuration from a file.
66

7-
Import configuration from a YAML file, usually generated with
8-
corresponding `export` command. This downloads the current cluster
9-
configuration, calculates the difference with the YAML file, and
10-
updates any properties that were changed. If a property is removed
11-
from the YAML file, it is reset to its default value.
7+
This command imports a cluster configuration from a YAML file, typically generated with the `export` command. The command first retrieves the current cluster configuration, compares it with the specified YAML file, and then updates any properties that were changed. If a property exists in the current configuration but is absent from the YAML file, that property is reset to its default value.
128

139
== Usage
1410

@@ -23,8 +19,8 @@ rpk cluster config import [flags]
2319
|===
2420
|*Value* |*Type* |*Description*
2521

26-
|-f, --filename |string |full path to file to import, e.g.
27-
'/tmp/config.yml'.
22+
|-f, --filename |string |Full path to file to import; for example,
23+
`/tmp/config.yml`.
2824

2925
|-h, --help |- |Help for import.
3026

modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config-lint.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22

33
Remove any deprecated content from `redpanda.yaml`.
44

5-
Deprecated content includes properties which were set via `redpanda.yaml`
6-
in earlier versions but are now managed via Redpanda`s central configuration store (and via `rpk cluster config edit`).
5+
Deprecated content includes properties that were set in the `redpanda.yaml` file
6+
in earlier versions but are now managed through Redpanda's central configuration store and through `rpk cluster config edit`.
77

88
== Usage
99

0 commit comments

Comments
 (0)