redpanda-data · vbotbuildovich · Aug 3, 2026
@@ -1,3 +1,4 @@
+ifndef::env-cloud[]
 = rpk cluster brokers
 :description: Manage Redpanda cluster brokers.
 :page-aliases: reference:rpk/rpk-redpanda/rpk-redpanda-admin-brokers.adoc
@@ -49,3 +50,4 @@ rpk cluster brokers [flags]
 |===
 
 // end::single-source[]
+endif::[]
@@ -1,3 +1,4 @@
+ifndef::env-cloud[]
 = rpk cluster config edit
 :description: Edit cluster-wide configuration properties. This command opens a text editor to modify the cluster's configuration.
 :page-platforms: linux,darwin
@@ -51,3 +52,4 @@ rpk cluster config edit [flags]
 |===
 
 // end::single-source[]
+endif::[]
@@ -1,3 +1,4 @@
+ifndef::env-cloud[]
 = rpk cluster config export
 :description: pass:q[Export cluster configuration. Writes out a YAML representation of the cluster configuration to a file, suitable for editing and later applying with the corresponding `import` command.]
 :page-platforms: linux,darwin
@@ -46,3 +47,4 @@ rpk cluster config export [flags]
 |===
 
 // end::single-source[]
+endif::[]
@@ -1,3 +1,4 @@
+ifndef::env-cloud[]
 = rpk cluster config force-reset
 :description: Forcibly clear a cluster configuration property on this node. This command is not for general changes to cluster configuration: use this only when Redpanda will not start due to a configuration issue.
 :page-platforms: linux,darwin
@@ -51,3 +52,4 @@ rpk cluster config force-reset <property...> [flags]
 |===
 
 // end::single-source[]
+endif::[]
@@ -1,3 +1,4 @@
+ifndef::env-cloud[]
 = rpk cluster config import
 :description: pass:q[Import cluster configuration from a file. Import configuration from a YAML file, usually generated with corresponding `export` command.]
 :page-platforms: linux,darwin
@@ -45,3 +46,4 @@ rpk cluster config import [flags]
 |===
 
 // end::single-source[]
+endif::[]
@@ -1,3 +1,4 @@
+ifndef::env-cloud[]
 = rpk cluster config lint
 :description: pass:q[Remove any deprecated content from `redpanda.yaml`. Deprecated content includes properties which were set via `redpanda.yaml` in earlier versions of redpanda, but are now managed via Redpanda's central configuration store (and via `rpk cluster config edit`).]
 :page-platforms: linux,darwin
@@ -33,3 +34,4 @@ rpk cluster config lint [flags]
 |===
 
 // end::single-source[]
+endif::[]
@@ -1,11 +1,11 @@
 = rpk cluster config status
-:description: Get the configuration status of Redpanda brokers. For each broker, the command output shows: - Whether you need to restart the broker to apply the new settings.
+:description: Get the configuration status of Redpanda brokers. For each broker, the command output shows: - Whether you need to restart the broker to apply the new settings - Any settings that the broker has flagged as invalid or unknown The command also returns the version of cluster configuration that each broker has applied.
 :page-platforms: linux,darwin
 
 // This content is autogenerated. Do not edit manually. To customize content, see the writer's guide: https://github.com/redpanda-data/docs/blob/main/docs-data/RPK_OVERRIDES_GUIDE.adoc
 
 // tag::single-source[]
-:description: Get the configuration status of Redpanda brokers. For each broker, the command output shows: - Whether you need to restart the broker to apply the new settings.
+:description: Get the configuration status of Redpanda brokers. For each broker, the command output shows: - Whether you need to restart the broker to apply the new settings - Any settings that the broker has flagged as invalid or unknown The command also returns the version of cluster configuration that each broker has applied.
 ifndef::env-cloud[]
 Get the configuration status of Redpanda brokers.
 

@@ -79,7 +79,7 @@ endif::[]
 |Set a single cluster configuration property. This command is provided for use in scripts.
 
 |xref:reference:rpk/rpk-cluster/rpk-cluster-config-status.adoc[`rpk cluster config status`]
-|Get the configuration status of Redpanda brokers. For each broker, the command output shows: - Whether you need to restart the broker to apply the new settings.
+|Get the configuration status of Redpanda brokers. For each broker, the command output shows: - Whether you need to restart the broker to apply the new settings - Any settings that the broker has flagged as invalid or unknown The command also returns the version of cluster configuration that each broker has applied.
 
 |===
 

@@ -1,3 +1,4 @@
+ifndef::env-cloud[]
 = rpk cluster health
 :description: Queries cluster for health overview. Health overview is created based on the health reports collected periodically from all nodes in the cluster.
 :page-platforms: linux,darwin
@@ -72,3 +73,4 @@ rpk cluster health --exit-when-healthy
 |===
 
 // end::single-source[]
+endif::[]
@@ -1,11 +1,11 @@
 = rpk cluster license set
-:description: Upload license to the cluster.
+:description: Upload license to the cluster You can either provide a path to a file containing the license:
 :page-platforms: linux,darwin
 
 // This content is autogenerated. Do not edit manually. To customize content, see the writer's guide: https://github.com/redpanda-data/docs/blob/main/docs-data/RPK_OVERRIDES_GUIDE.adoc
 
 // tag::single-source[]
-:description: Upload license to the cluster.
+:description: Upload license to the cluster You can either provide a path to a file containing the license:
 Upload license to the cluster.
 
 You can either provide a path to a file containing the license:

@@ -1,3 +1,4 @@
+ifndef::env-cloud[]
 = rpk cluster license
 :description: Manage cluster license.
 :page-platforms: linux,darwin
@@ -25,7 +26,7 @@ rpk cluster license [flags]
 |Retrieve license information:
 
 |xref:reference:rpk/rpk-cluster/rpk-cluster-license-set.adoc[`rpk cluster license set`]
-|Upload license to the cluster.
+|Upload license to the cluster You can either provide a path to a file containing the license:
 
 |===
 
@@ -43,3 +44,4 @@ rpk cluster license [flags]
 |===
 
 // end::single-source[]
+endif::[]
@@ -1,3 +1,4 @@
+ifndef::env-cloud[]
 = rpk cluster loggers
 :description: List and configure Redpanda broker loggers.
 :page-aliases: reference:rpk/rpk-redpanda/rpk-redpanda-admin-config-log-level.adoc
@@ -46,3 +47,4 @@ rpk cluster loggers [flags]
 |===
 
 // end::single-source[]
+endif::[]
@@ -1,3 +1,4 @@
+ifndef::env-cloud[]
 = rpk cluster maintenance
 :description: Interact with cluster maintenance mode. Maintenance mode is a state that a node may be placed into in which the node may be shutdown or restarted with minimal disruption to client workloads.
 :page-platforms: linux,darwin
@@ -64,3 +65,4 @@ rpk cluster maintenance [flags]
 |===
 
 // end::single-source[]
+endif::[]
@@ -1,11 +1,11 @@
 = rpk cluster partitions disable
-:description: pass:q[Disable partitions of a topic. You may disable all partitions of a topic using the `--all` flag or you may select a set of topic/partitions to disable with the `--partitions`/`-p` flag.]
+:description: pass:q[Disable partitions of a topic You may disable all partitions of a topic using the `--all` flag or you may select a set of topic/partitions to disable with the `--partitions`/`-p` flag. The partition flag accepts the format `\{namespace}/\{topic}/[partitions...]` where namespace and topic are optional parameters.]
 :page-platforms: linux,darwin
 
 // This content is autogenerated. Do not edit manually. To customize content, see the writer's guide: https://github.com/redpanda-data/docs/blob/main/docs-data/RPK_OVERRIDES_GUIDE.adoc
 
 // tag::single-source[]
-:description: pass:q[Disable partitions of a topic. You may disable all partitions of a topic using the `--all` flag or you may select a set of topic/partitions to disable with the `--partitions`/`-p` flag.]
+:description: pass:q[Disable partitions of a topic You may disable all partitions of a topic using the `--all` flag or you may select a set of topic/partitions to disable with the `--partitions`/`-p` flag. The partition flag accepts the format `\{namespace}/\{topic}/[partitions...]` where namespace and topic are optional parameters.]
 Disable partitions of a topic.
 
 You may disable all partitions of a topic using the `--all` flag or you may select 

@@ -1,11 +1,11 @@
 = rpk cluster partitions enable
-:description: pass:q[Enable partitions of a topic. You may enable all partitions of a topic using the `--all` flag or you may select a set of topic/partitions to enable with the `--partitions`/`-p` flag.]
+:description: pass:q[Enable partitions of a topic You may enable all partitions of a topic using the `--all` flag or you may select a set of topic/partitions to enable with the `--partitions`/`-p` flag. The partition flag accepts the format `\{namespace}/\{topic}/[partitions...]` where namespace and topic are optional parameters.]
 :page-platforms: linux,darwin
 
 // This content is autogenerated. Do not edit manually. To customize content, see the writer's guide: https://github.com/redpanda-data/docs/blob/main/docs-data/RPK_OVERRIDES_GUIDE.adoc
 
 // tag::single-source[]
-:description: pass:q[Enable partitions of a topic. You may enable all partitions of a topic using the `--all` flag or you may select a set of topic/partitions to enable with the `--partitions`/`-p` flag.]
+:description: pass:q[Enable partitions of a topic You may enable all partitions of a topic using the `--all` flag or you may select a set of topic/partitions to enable with the `--partitions`/`-p` flag. The partition flag accepts the format `\{namespace}/\{topic}/[partitions...]` where namespace and topic are optional parameters.]
 Enable partitions of a topic.
 
 You may enable all partitions of a topic using the `--all` flag or you may select 

@@ -1,12 +1,12 @@
 = rpk cluster partitions list
-:description: List partitions in the cluster. This commands lists the cluster-level metadata of all partitions in the cluster.
+:description: List partitions in the cluster This commands lists the cluster-level metadata of all partitions in the cluster. It shows the current replica assignments on both brokers and CPU cores for given topics.
 :page-aliases: reference:rpk/rpk-redpanda/rpk-redpanda-admin-partitions-list.adoc
 :page-platforms: linux,darwin
 
 // This content is autogenerated. Do not edit manually. To customize content, see the writer's guide: https://github.com/redpanda-data/docs/blob/main/docs-data/RPK_OVERRIDES_GUIDE.adoc
 
 // tag::single-source[]
-:description: List partitions in the cluster. This commands lists the cluster-level metadata of all partitions in the cluster.
+:description: List partitions in the cluster This commands lists the cluster-level metadata of all partitions in the cluster. It shows the current replica assignments on both brokers and CPU cores for given topics.
 List partitions in the cluster.
 
 This commands lists the cluster-level metadata of all partitions in the cluster.

@@ -1,3 +1,4 @@
+ifndef::env-cloud[]
 = rpk cluster partitions
 :description: Manage cluster partitions.
 :page-aliases: reference:rpk/rpk-redpanda/rpk-redpanda-admin-partitions.adoc
@@ -29,13 +30,13 @@ rpk cluster partitions [flags]
 |Queries cluster for partition balancer status: If continuous partition balancing is enabled, Redpanda will continuously reassign partitions from both unavailable nodes and from nodes using more disk space than the configured limit. Use this command to monitor the partition balancer status and the partition distribution across brokers in the cluster.
 
 |xref:reference:rpk/rpk-cluster/rpk-cluster-partitions-disable.adoc[`rpk cluster partitions disable`]
-|Disable partitions of a topic. You may disable all partitions of a topic using the `--all` flag or you may select a set of topic/partitions to disable with the `--partitions`/`-p` flag.
+|Disable partitions of a topic You may disable all partitions of a topic using the `--all` flag or you may select a set of topic/partitions to disable with the `--partitions`/`-p` flag. The partition flag accepts the format `\{namespace}/\{topic}/[partitions...]` where namespace and topic are optional parameters.
 
 |xref:reference:rpk/rpk-cluster/rpk-cluster-partitions-enable.adoc[`rpk cluster partitions enable`]
-|Enable partitions of a topic. You may enable all partitions of a topic using the `--all` flag or you may select a set of topic/partitions to enable with the `--partitions`/`-p` flag.
+|Enable partitions of a topic You may enable all partitions of a topic using the `--all` flag or you may select a set of topic/partitions to enable with the `--partitions`/`-p` flag. The partition flag accepts the format `\{namespace}/\{topic}/[partitions...]` where namespace and topic are optional parameters.
 
 |xref:reference:rpk/rpk-cluster/rpk-cluster-partitions-list.adoc[`rpk cluster partitions list`]
-|List partitions in the cluster. This commands lists the cluster-level metadata of all partitions in the cluster.
+|List partitions in the cluster This commands lists the cluster-level metadata of all partitions in the cluster. It shows the current replica assignments on both brokers and CPU cores for given topics.
 
 |xref:reference:rpk/rpk-cluster/rpk-cluster-partitions-move.adoc[`rpk cluster partitions move`]
 |Move partition replicas across nodes / cores. This command changes replica assignments for given partitions.
@@ -68,3 +69,4 @@ rpk cluster partitions [flags]
 |===
 
 // end::single-source[]
+endif::[]
@@ -1,11 +1,11 @@
 = rpk cluster quotas alter
-:description: Add or delete a client quota. This command allows you to add or delete a client quota.
+:description: Add or delete a client quota This command allows you to add or delete a client quota. A client quota consists of an entity (to whom the quota is applied) and a quota type (what is being applied).
 :page-platforms: linux,darwin
 
 // This content is autogenerated. Do not edit manually. To customize content, see the writer's guide: https://github.com/redpanda-data/docs/blob/main/docs-data/RPK_OVERRIDES_GUIDE.adoc
 
 // tag::single-source[]
-:description: Add or delete a client quota. This command allows you to add or delete a client quota.
+:description: Add or delete a client quota This command allows you to add or delete a client quota. A client quota consists of an entity (to whom the quota is applied) and a quota type (what is being applied).
 Add or delete a client quota.
 
 This command allows you to add or delete a client quota.

@@ -29,7 +29,7 @@ rpk cluster quota
 |Command |Description
 
 |xref:reference:rpk/rpk-cluster/rpk-cluster-quotas-alter.adoc[`rpk cluster quotas alter`]
-|Add or delete a client quota. This command allows you to add or delete a client quota.
+|Add or delete a client quota This command allows you to add or delete a client quota. A client quota consists of an entity (to whom the quota is applied) and a quota type (what is being applied).
 
 |xref:reference:rpk/rpk-cluster/rpk-cluster-quotas-describe.adoc[`rpk cluster quotas describe`]
 |Describe client quotas. This command describes client quotas that match the provided filtering criteria.

@@ -1,3 +1,4 @@
+ifndef::env-cloud[]
 = rpk cluster self-test
 :description: Start, stop and query runs of Redpanda self-test through the Admin API listener.
 :page-platforms: linux,darwin
@@ -53,3 +54,4 @@ rpk cluster self-test [flags]
 * xref:reference:rpk/rpk-cluster/rpk-cluster-self-test-stop.adoc[rpk cluster self-test stop]
 
 // end::single-source[]
+endif::[]
@@ -1,3 +1,4 @@
+ifndef::env-cloud[]
 = rpk cluster storage restore
 :description: Interact with the topic restoration process. This command is used to restore topics from the archival bucket, which can be useful for disaster recovery or if a topic was accidentally deleted.
 :page-aliases: reference:rpk/rpk-cluster/rpk-cluster-storage-recovery.adoc
@@ -66,3 +67,4 @@ rpk cluster storage recovery
 * xref:manage:whole-cluster-restore.adoc[Whole-Cluster Restore]
 
 // end::single-source[]
+endif::[]
@@ -1,11 +1,11 @@
 = rpk cluster txn list
-:description: List transactions and their current states. This command lists all known transactions in the cluster, the producer ID for the transactional ID, and the and the state of the transaction.
+:description: pass:q[List transactions and their current states This command lists all known transactions in the cluster, the producer ID for the transactional ID, and the and the state of the transaction. For information on what the columns in the output mean, see `rpk cluster txn --help`.]
 :page-platforms: linux,darwin
 
 // This content is autogenerated. Do not edit manually. To customize content, see the writer's guide: https://github.com/redpanda-data/docs/blob/main/docs-data/RPK_OVERRIDES_GUIDE.adoc
 
 // tag::single-source[]
-:description: List transactions and their current states. This command lists all known transactions in the cluster, the producer ID for the transactional ID, and the and the state of the transaction.
+:description: pass:q[List transactions and their current states This command lists all known transactions in the cluster, the producer ID for the transactional ID, and the and the state of the transaction. For information on what the columns in the output mean, see `rpk cluster txn --help`.]
 List transactions and their current states.
 
 This command lists all known transactions in the cluster, the producer ID for

@@ -85,7 +85,7 @@ rpk cluster transaction
 |Describe transactional producers to partitions. This command describes partitions that active transactional producers are producing to.
 
 |xref:reference:rpk/rpk-cluster/rpk-cluster-txn-list.adoc[`rpk cluster txn list`]
-|List transactions and their current states. This command lists all known transactions in the cluster, the producer ID for the transactional ID, and the and the state of the transaction.
+|List transactions and their current states This command lists all known transactions in the cluster, the producer ID for the transactional ID, and the and the state of the transaction. For information on what the columns in the output mean, see `rpk cluster txn --help`.
 
 |===
 

@@ -1,3 +1,4 @@
+ifndef::env-cloud[]
 = rpk cluster upgrade
 :description: pass:q[Check and finalize major-version upgrades. When the cluster configuration `features_auto_finalization` is disabled, an upgrade stays pending after all brokers are on the new version, so you can downgrade while soak-testing.]
 :page-platforms: linux,darwin
@@ -47,3 +48,4 @@ rpk cluster upgrade [flags]
 |===
 
 // end::single-source[]
+endif::[]
@@ -1,11 +1,11 @@
 = rpk generate grafana-dashboard
-:description: Generate Grafana Dashboards for Redpanda Metrics. Use this command to generate sample Grafana dashboards for Redpanda metrics.
+:description: Generate Grafana Dashboards for Redpanda Metrics Use this command to generate sample Grafana dashboards for Redpanda metrics. These dashboards can be imported into a Grafana or Grafana Cloud instance.
 :page-platforms: linux,darwin
 
 // This content is autogenerated. Do not edit manually. To customize content, see the writer's guide: https://github.com/redpanda-data/docs/blob/main/docs-data/RPK_OVERRIDES_GUIDE.adoc
 
 // tag::single-source[]
-:description: Generate Grafana Dashboards for Redpanda Metrics. Use this command to generate sample Grafana dashboards for Redpanda metrics.
+:description: Generate Grafana Dashboards for Redpanda Metrics Use this command to generate sample Grafana dashboards for Redpanda metrics. These dashboards can be imported into a Grafana or Grafana Cloud instance.
 Generate Grafana Dashboards for Redpanda Metrics.
 
 Use this command to generate sample Grafana dashboards for Redpanda metrics.