Skip to content

Commit 6ed318a

Browse files
kbatuigasmicheleRP
andauthored
25.1 rpk single source (#1106)
Co-authored-by: Michele Cyran <michele@redpanda.com>
1 parent 3385ea2 commit 6ed318a

16 files changed

Lines changed: 338 additions & 31 deletions

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

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,5 +29,4 @@ rpk cluster config get <key> [flags]
2929
|--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details.
3030

3131
|-v, --verbose |- |Enable verbose logging.
32-
|===
33-
32+
|===

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

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

3-
Set a single cluster configuration property.
4+
Set a cluster configuration property. You can set a single property or multiple properties at once, for example:
45

5-
This command is provided for use in scripts. For interactive editing, or bulk
6-
changes, use the `edit` and `import` commands respectively.
7-
8-
You may also use `<key>=<value>` notation for setting configuration properties:
6+
[,bash]
7+
----
8+
rpk cluster config set audit_enabled true
9+
----
910

1011
[,bash]
1112
----
12-
rpk cluster config set log_retention_ms=-1
13+
rpk cluster config set iceberg_enabled=true iceberg_catalog_type=rest
1314
----
1415

15-
If an empty string is given as the value, the property is reset to its default.
16+
You must use `<key>=<value>` notation to set multiple properties.
17+
18+
ifndef::env-cloud[]
19+
If you set the cluster property value to an empty string, the property is reset to its default.
20+
21+
This command is provided for use in scripts. For interactive editing, or bulk
22+
changes, use the `edit` and `import` commands respectively.
23+
endif::[]
24+
25+
ifdef::env-cloud[]
26+
The output returns an operation ID. Use the xref:reference:rpk/rpk-cluster/rpk-cluster-config-status.adoc[`status`] command to check the progress of the configuration change.
27+
endif::[]
28+
29+
For a list of available properties, see xref:reference:properties/cluster-properties.adoc[].
1630

1731
== Usage
1832

@@ -54,3 +68,5 @@ Workaround: Use `--` to disable parsing for all subsequent characters. For examp
5468
rpk cluster config set -- delete_retention_ms -1
5569
```
5670
====
71+
72+
// end::single-source[]

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

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

3-
Get configuration status of redpanda nodes.
4+
ifndef::env-cloud[]
5+
Get the configuration status of Redpanda brokers.
46

5-
For each node, indicate whether a restart is required for settings to
6-
take effect, and any settings that the node has identified as invalid
7-
or unknown properties.
7+
For each broker, the command output shows:
88

9-
Additionally show the version of cluster configuration that each node
10-
has applied: under normal circumstances these should all be equal,
11-
a lower number shows that a node is out of sync, perhaps because it
12-
is offline.
9+
- Whether you need to restart the broker to apply the new settings
10+
- Any settings that the broker has flagged as invalid or unknown
11+
12+
The command also returns the version of cluster configuration that each broker
13+
has applied. The version should be the same across all brokers, and
14+
it is incremented each time a configuration change is applied to the
15+
cluster. If a broker is using an earlier version as indicated by a lower number,
16+
it may be out of sync with the rest of the cluster. This can happen if a broker
17+
is offline or if it has not yet applied the latest configuration changes. The cluster configuration version number is not the same as the Redpanda version number.
18+
endif::[]
19+
20+
ifdef::env-cloud[]
21+
Check the progress of a cluster configuration change.
22+
23+
Some cluster properties require a rolling restart when updated, and it can take several minutes for the update to complete. This command lists the long-running operations run by the update and their status:
24+
25+
- In progress (running)
26+
- Completed
27+
- Failed
28+
29+
[,bash,role=no-copy]
30+
----
31+
OPERATION-ID STATUS STARTED COMPLETED
32+
d0ec1obmpnr7lv17bfpg RUNNING 2025-05-08 14:34:09
33+
d0ec0sor49uba166af3g RUNNING 2025-05-08 14:32:20
34+
----
35+
endif::[]
1336

1437
== Usage
1538

@@ -37,3 +60,4 @@ rpk cluster config status [flags]
3760
|-v, --verbose |- |Enable verbose logging.
3861
|===
3962

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

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 from broker properties, which apply to only that broker and 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. Use the `status`
27+
subcommand 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[]

modules/reference/pages/rpk/rpk-cluster/rpk-cluster-storage-cancel-mount.adoc

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,11 @@
11
= rpk cluster storage cancel mount
22
// tag::single-source[]
33

4+
ifdef::env-cloud[]
5+
NOTE: This command is only supported in BYOC and Dedicated clusters.
6+
7+
endif::[]
8+
49
Cancels a mount/unmount operation on a topic.
510

611
Use the migration ID that is emitted when the mount or unmount operation is executed. You can also get the migration ID by listing the mount/unmount operations.

modules/reference/pages/rpk/rpk-cluster/rpk-cluster-storage-list-mount.adoc

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,12 @@
11
= rpk cluster storage list mount
22
// tag::single-source[]
33

4-
List mount/unmount operations on a topic in the Redpanda cluster from glossterm:tiered-storage[].
4+
ifdef::env-cloud[]
5+
NOTE: This command is only supported in BYOC and Dedicated clusters.
6+
7+
endif::[]
8+
9+
List mount/unmount operations on a topic in the Redpanda cluster from glossterm:Tiered Storage[].
510

611
You can also filter the list by state using the `--filter` flag. The possible states are:
712

modules/reference/pages/rpk/rpk-cluster/rpk-cluster-storage-list-mountable.adoc

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,11 @@
11
= rpk cluster storage list-mountable
22
// tag::single-source[]
33

4+
ifdef::env-cloud[]
5+
NOTE: This command is only supported in BYOC and Dedicated clusters.
6+
7+
endif::[]
8+
49
List topics that are available to mount from object storage.
510

611
This command displays topics that exist in object storage and can be mounted to your Redpanda cluster. Each topic includes its location in object storage and namespace information if applicable.

modules/reference/pages/rpk/rpk-cluster/rpk-cluster-storage-mount.adoc

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,12 @@
11
= rpk cluster storage mount
22
// tag::single-source[]
33

4-
Mount a topic to the Redpanda cluster from glossterm:tiered-storage[].
4+
ifdef::env-cloud[]
5+
NOTE: This command is only supported in BYOC and Dedicated clusters.
6+
7+
endif::[]
8+
9+
Mount a topic to the Redpanda cluster from glossterm:Tiered Storage[].
510

611
This command mounts a topic in the Redpanda cluster using log segments stored in Tiered Storage.
712

modules/reference/pages/rpk/rpk-cluster/rpk-cluster-storage-status-mount.adoc

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,12 @@
11
= rpk cluster storage status mount
22
// tag::single-source[]
33

4-
Status of mount/unmount operation on topic in a Redpanda cluster from glossterm:tiered-storage[].
4+
ifdef::env-cloud[]
5+
NOTE: This command is only supported in BYOC and Dedicated clusters.
6+
7+
endif::[]
8+
9+
Status of mount/unmount operation on topic in a Redpanda cluster from glossterm:Tiered Storage[].
510

611
== Usage
712

modules/reference/pages/rpk/rpk-cluster/rpk-cluster-storage-unmount.adoc

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,12 @@
11
= rpk cluster storage unmount
22
// tag::single-source[]
33

4-
Unmount a topic from the Redpanda cluster and secure it in glossterm:tiered-storage[].
4+
ifdef::env-cloud[]
5+
NOTE: This command is only supported in BYOC and Dedicated clusters.
6+
7+
endif::[]
8+
9+
Unmount a topic from the Redpanda cluster and secure it in glossterm:Tiered Storage[].
510

611
This command performs an operation that:
712

0 commit comments

Comments
 (0)