|
1 | 1 | = rpk cluster config |
| 2 | +// tag::single-source[] |
2 | 3 |
|
3 | 4 | Interact with cluster configuration properties. |
4 | 5 |
|
5 | | -Cluster properties are redpanda settings which apply to all nodes in |
6 | | -the cluster. These are separate to node properties, which are set with |
| 6 | +ifdef::env-cloud[] |
| 7 | +Cluster properties are Redpanda settings that apply to all brokers in |
| 8 | +the cluster. |
| 9 | +endif::[] |
| 10 | + |
| 11 | +ifndef::env-cloud[] |
| 12 | +Cluster properties are Redpanda settings that apply to all brokers in |
| 13 | +the cluster. These are separate to broker properties, which are set with |
7 | 14 | `rpk redpanda config`. |
8 | 15 |
|
9 | 16 | Use the `edit` subcommand to interactively modify the cluster configuration, or |
10 | | -`export` and `import` to write configuration to a file that can be edited and |
| 17 | +`export` and `import` to write the configuration to a file that can be edited and |
11 | 18 | read back later. |
12 | 19 |
|
13 | | -These commands take an optional `--all` flag to include all properties including |
14 | | -low level tunables such as internal buffer sizes, that do not usually need |
| 20 | +These commands take an optional `--all` flag to include all properties such as |
| 21 | +low-level tunables (for example, internal buffer sizes) that do not usually need |
15 | 22 | to be changed during normal operations. These properties generally require |
16 | | -some expertize to set safely, so if in doubt, avoid using `--all`. |
| 23 | +some expertise to set safely, so if in doubt, avoid using `--all`. |
| 24 | +endif::[] |
17 | 25 |
|
18 | | -Modified properties are propagated immediately to all nodes. The `status` |
19 | | -subcommand can be used to verify that all nodes are up to date, and identify |
20 | | -any settings which were rejected by a node, for example if a node is running a |
21 | | -different redpanda version that does not recognize certain properties. |
| 26 | +Modified properties are propagated immediately to all brokers. The `status` |
| 27 | +subcommand can be used to verify that all brokers are up to date, and identify |
| 28 | +any settings which were rejected by a broker, for example if the broker is running a |
| 29 | +different Redpanda version that does not recognize certain properties. |
22 | 30 |
|
23 | 31 | == Usage |
24 | 32 |
|
@@ -46,3 +54,4 @@ rpk cluster config [command] |
46 | 54 | |-v, --verbose |- |Enable verbose logging. |
47 | 55 | |=== |
48 | 56 |
|
| 57 | +// end::single-source[] |
0 commit comments