Skip to content

Commit 62cd539

Browse files
committed
Forgot single source tag for main cluster config command
1 parent a29fcb4 commit 62cd539

1 file changed

Lines changed: 19 additions & 10 deletions

File tree

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

Lines changed: 19 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,32 @@
11
= rpk cluster config
2+
// tag::single-source[]
23

34
Interact with cluster configuration properties.
45

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
714
`rpk redpanda config`.
815

916
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
1118
read back later.
1219

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
1522
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::[]
1725

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.
2230

2331
== Usage
2432

@@ -46,3 +54,4 @@ rpk cluster config [command]
4654
|-v, --verbose |- |Enable verbose logging.
4755
|===
4856

57+
// end::single-source[]

0 commit comments

Comments
 (0)