From b4fe9614079d706aa010b5018ccc803ad9877011 Mon Sep 17 00:00:00 2001 From: Joyce Fee Date: Mon, 27 Jul 2026 17:37:34 -0400 Subject: [PATCH 1/4] docs: DOC-2121: Sweep rpk redpanda admin commands for 26.2 deprecation Replace deprecated rpk redpanda admin commands with their rpk cluster replacements across 18 prose files, per redpanda#30332 (shipped 26.2): - brokers decommission/decommission-status -> rpk cluster brokers ... - brokers list -> rpk cluster info -b --detailed - config log-level set -> rpk cluster loggers set Add the migration table to Deprecated Features, a What's New entry, and a deprecation note on the admin-addresses flag table. Xrefs to not-yet-generated rpk-cluster-brokers/loggers pages are left as code text with TODO(DOC-2121) markers until the 26.2 rpk regen lands. Co-Authored-By: Claude Fable 5 --- .../kubernetes/k-production-readiness.adoc | 4 ++-- .../manual/production/production-readiness.adoc | 2 +- modules/get-started/pages/admin-addresses.adoc | 2 +- .../get-started/pages/release-notes/redpanda.adoc | 6 ++++++ .../cluster-maintenance/decommission-brokers.adoc | 9 +++++---- .../pages/kubernetes/k-decommission-brokers.adoc | 9 +++++---- modules/manage/pages/kubernetes/k-node-pools.adoc | 2 +- modules/manage/pages/kubernetes/k-nodewatcher.adoc | 3 ++- .../manage/pages/kubernetes/k-rolling-restart.adoc | 2 +- modules/manage/pages/use-admin-api.adoc | 5 +++-- modules/manage/partials/gbac-dp.adoc | 2 +- .../troubleshoot/partials/cluster-diagnostics.adoc | 3 ++- modules/upgrade/pages/deprecated/index.adoc | 14 ++++++++++++++ .../pages/k-migrate-node-pools-manually.adoc | 4 ++-- modules/upgrade/pages/k-migrate-node-pools.adoc | 8 ++++---- modules/upgrade/pages/k-rolling-upgrade.adoc | 6 +++--- modules/upgrade/pages/rolling-upgrade.adoc | 4 ++-- .../rolling-upgrades/post-upgrade-tasks.adoc | 2 +- .../rolling-upgrades/rolling-restart-intro.adoc | 4 ++-- .../rolling-upgrades/upgrade-your-version.adoc | 4 ++-- 20 files changed, 60 insertions(+), 35 deletions(-) diff --git a/modules/deploy/pages/redpanda/kubernetes/k-production-readiness.adoc b/modules/deploy/pages/redpanda/kubernetes/k-production-readiness.adoc index ce2ea648b5..ef75c37195 100644 --- a/modules/deploy/pages/redpanda/kubernetes/k-production-readiness.adoc +++ b/modules/deploy/pages/redpanda/kubernetes/k-production-readiness.adoc @@ -166,7 +166,7 @@ Decommissioning is used to permanently remove a broker from the cluster, such as .Input [,bash] ---- -kubectl exec -n -c redpanda -- rpk redpanda admin brokers list -X user= -X pass= -X sasl.mechanism= +kubectl exec -n -c redpanda -- rpk cluster info -b --detailed -X user= -X pass= -X sasl.mechanism= ---- .Output @@ -216,7 +216,7 @@ Check that Redpanda is running the https://github.com/redpanda-data/redpanda/rel .Input [,bash] ---- -kubectl exec -n -c redpanda -- rpk redpanda admin brokers list -X user= -X pass= -X sasl.mechanism= +kubectl exec -n -c redpanda -- rpk cluster info -b --detailed -X user= -X pass= -X sasl.mechanism= ---- .Output diff --git a/modules/deploy/pages/redpanda/manual/production/production-readiness.adoc b/modules/deploy/pages/redpanda/manual/production/production-readiness.adoc index 552f47182f..889c3b3c2a 100644 --- a/modules/deploy/pages/redpanda/manual/production/production-readiness.adoc +++ b/modules/deploy/pages/redpanda/manual/production/production-readiness.adoc @@ -538,7 +538,7 @@ Check that no brokers are in a decommissioned state. .Input [source,bash] ---- -rpk redpanda admin brokers list +rpk cluster info -b --detailed ---- .Output diff --git a/modules/get-started/pages/admin-addresses.adoc b/modules/get-started/pages/admin-addresses.adoc index 15325a735e..cd9b42b326 100644 --- a/modules/get-started/pages/admin-addresses.adoc +++ b/modules/get-started/pages/admin-addresses.adoc @@ -26,7 +26,7 @@ The following table shows which `rpk` commands require the `-X admin.hosts` or ` | `rpk cluster` (all except `rpk cluster info` and `rpk cluster metadata`) | `-X admin.hosts` -| `rpk redpanda admin` +| `rpk redpanda admin` (deprecated in 26.2, see xref:upgrade:deprecated/index.adoc[Deprecated features]) | `--hosts` |=== diff --git a/modules/get-started/pages/release-notes/redpanda.adoc b/modules/get-started/pages/release-notes/redpanda.adoc index a0d27a5b3b..9d8c8e6d4e 100644 --- a/modules/get-started/pages/release-notes/redpanda.adoc +++ b/modules/get-started/pages/release-notes/redpanda.adoc @@ -13,3 +13,9 @@ This topic includes new content added in version {page-component-version}. For a Redpanda version 26.2 validates a broader set of non-Java Apache Kafka® clients at their current versions that support Kafka 4.x, in addition to the Apache Kafka Java client. Newly validated clients include `confluent-kafka-go` and Sarama for Go, and `kafka-python` and `confluent-kafka-python` for Python. Validation confirms connectivity and correctness across core Kafka APIs, such as produce, consume, and transaction operations. See xref:develop:kafka-clients.adoc[Kafka Compatibility] for the full list of validated clients and known exceptions. + +== Simplified cluster administration commands: `rpk redpanda admin` deprecated + +Cluster administration moves fully under `rpk cluster`: broker decommissioning, recommissioning, logger control, and per-broker configuration and partition listings now live alongside the other cluster commands, and `rpk cluster info -b --detailed` reports broker membership, liveness, and versions. The `rpk redpanda admin` command tree is deprecated and hidden from help output. The old commands still work and print a pointer to their replacements, but they are planned for removal in a future major release. + +See xref:upgrade:deprecated/index.adoc[Deprecated Features] for the full command migration table. diff --git a/modules/manage/pages/cluster-maintenance/decommission-brokers.adoc b/modules/manage/pages/cluster-maintenance/decommission-brokers.adoc index 61d7fe03ed..f670de262d 100644 --- a/modules/manage/pages/cluster-maintenance/decommission-brokers.adoc +++ b/modules/manage/pages/cluster-maintenance/decommission-brokers.adoc @@ -185,7 +185,7 @@ To determine the number of cores that are available across the remaining brokers [,bash] ---- -rpk redpanda admin brokers list +rpk cluster info -b --detailed ---- .Example output @@ -234,7 +234,7 @@ rpk cluster info \ + [,bash] ---- -rpk redpanda admin brokers decommission \ +rpk cluster brokers decommission \ --hosts : \ --force ---- @@ -247,7 +247,7 @@ If you see `Success, broker has been decommissioned!`, the broker is + [,bash] ---- -rpk redpanda admin brokers decommission-status \ +rpk cluster brokers decommission-status \ -X admin.hosts=: ---- + @@ -268,5 +268,6 @@ If these steps do not allow the decommissioning process to complete, enable `TRA include::shared:partial$suggested-reading.adoc[] -* xref:reference:rpk/rpk-redpanda/rpk-redpanda-admin-brokers-decommission.adoc[`rpk-redpanda-admin-brokers-decommission`] +// TODO(DOC-2121): Add an xref when the 26.2 rpk regen adds the rpk-cluster-brokers-decommission page. +* `rpk cluster brokers decommission` * https://redpanda.com/blog/raft-protocol-reconfiguration-solution[Engineering a more robust Raft group reconfiguration^] diff --git a/modules/manage/pages/kubernetes/k-decommission-brokers.adoc b/modules/manage/pages/kubernetes/k-decommission-brokers.adoc index 894ef9c110..c2f6259340 100644 --- a/modules/manage/pages/kubernetes/k-decommission-brokers.adoc +++ b/modules/manage/pages/kubernetes/k-decommission-brokers.adoc @@ -197,7 +197,7 @@ Next, determine the number of cores that are available across the remaining brok [,bash] ---- -rpk redpanda admin brokers list +rpk cluster info -b --detailed ---- .Example output @@ -297,7 +297,7 @@ NOTE: When scaling in a cluster, you cannot choose which broker is removed. Redp + ```bash kubectl --namespace exec -ti -c -- \ - rpk redpanda admin brokers decommission + rpk cluster brokers decommission ``` + This message is displayed before the decommission process is complete. @@ -312,7 +312,7 @@ TIP: If the broker is not running, use the `--force` flag. + ```bash kubectl --namespace exec -ti -c -- \ - rpk redpanda admin brokers decommission-status + rpk cluster brokers decommission-status ``` + The output uses cached cluster health data that is refreshed every 10 seconds. When the completion column for all rows is 100%, the broker is decommissioned. @@ -737,6 +737,7 @@ include::shared:partial$suggested-reading.adoc[] - xref:manage:kubernetes/k-node-pools.adoc[Node Pools] -- xref:reference:rpk/rpk-redpanda/rpk-redpanda-admin-brokers-decommission.adoc[`rpk-redpanda-admin-brokers-decommission`] +// TODO(DOC-2121): Add an xref when the 26.2 rpk regen adds the rpk-cluster-brokers-decommission page. +- `rpk cluster brokers decommission` - https://redpanda.com/blog/raft-protocol-reconfiguration-solution[Engineering a more robust Raft group reconfiguration^] diff --git a/modules/manage/pages/kubernetes/k-node-pools.adoc b/modules/manage/pages/kubernetes/k-node-pools.adoc index a56074de75..a8b38cc6bd 100644 --- a/modules/manage/pages/kubernetes/k-node-pools.adoc +++ b/modules/manage/pages/kubernetes/k-node-pools.adoc @@ -428,7 +428,7 @@ Monitor the decommission progress: [source,bash] ---- -rpk redpanda admin brokers list +rpk cluster info -b --detailed ---- Wait until only the Redpanda CR-managed brokers remain. diff --git a/modules/manage/pages/kubernetes/k-nodewatcher.adoc b/modules/manage/pages/kubernetes/k-nodewatcher.adoc index 67ed8e278c..a0db4db934 100644 --- a/modules/manage/pages/kubernetes/k-nodewatcher.adoc +++ b/modules/manage/pages/kubernetes/k-nodewatcher.adoc @@ -176,4 +176,5 @@ kubectl get persistentvolume --namespace After the PVCUnbinder has finished, xref:manage:kubernetes/k-decommission-brokers.adoc[decommission the broker] that was removed from the node. This is necessary to prevent a potential loss of quorum and ensure cluster stability. -NOTE: Make sure to use the `--force` flag when decommissioning the broker with xref:reference:rpk/rpk-redpanda/rpk-redpanda-admin-brokers-decommission.adoc[`rpk redpanda admin brokers decommission`]. This flag is required when the broker is no longer running. +// TODO(DOC-2121): Add an xref when the 26.2 rpk regen adds the rpk-cluster-brokers-decommission page. +NOTE: Make sure to use the `--force` flag when decommissioning the broker with `rpk cluster brokers decommission`. This flag is required when the broker is no longer running. diff --git a/modules/manage/pages/kubernetes/k-rolling-restart.adoc b/modules/manage/pages/kubernetes/k-rolling-restart.adoc index a895701006..7d7e6f47d1 100644 --- a/modules/manage/pages/kubernetes/k-rolling-restart.adoc +++ b/modules/manage/pages/kubernetes/k-rolling-restart.adoc @@ -124,7 +124,7 @@ To view additional information about your brokers, run: ```bash kubectl exec --namespace -c redpanda -- \ - rpk redpanda admin brokers list + rpk cluster info -b --detailed ``` include::shared:partial$suggested-reading.adoc[] diff --git a/modules/manage/pages/use-admin-api.adoc b/modules/manage/pages/use-admin-api.adoc index a3b6717faf..2990eb75d6 100644 --- a/modules/manage/pages/use-admin-api.adoc +++ b/modules/manage/pages/use-admin-api.adoc @@ -64,11 +64,12 @@ curl \ rpk:: + -- -For Linux deployments only, run xref:reference:rpk/rpk-redpanda/rpk-redpanda-admin-brokers-decommission.adoc[`rpk redpanda admin brokers decommission`]: +// TODO(DOC-2121): Add an xref when the 26.2 rpk regen adds the rpk-cluster-brokers-decommission page. +For Linux deployments only, run `rpk cluster brokers decommission`: [,bash] ---- -rpk redpanda admin brokers decommission +rpk cluster brokers decommission ---- -- ==== diff --git a/modules/manage/partials/gbac-dp.adoc b/modules/manage/partials/gbac-dp.adoc index 6808dd2ff2..f94f33daf4 100644 --- a/modules/manage/partials/gbac-dp.adoc +++ b/modules/manage/partials/gbac-dp.adoc @@ -417,7 +417,7 @@ rpk cluster config get nested_group_behavior + [,bash] ---- -rpk redpanda admin config log-level set security --level debug +rpk cluster loggers set security --level debug ---- + This helps diagnose incorrect claim paths, missing groups, or token content issues. The debug level reverts automatically after the expiry period (default: 300 seconds). diff --git a/modules/troubleshoot/partials/cluster-diagnostics.adoc b/modules/troubleshoot/partials/cluster-diagnostics.adoc index cd748929cd..940f5ae041 100644 --- a/modules/troubleshoot/partials/cluster-diagnostics.adoc +++ b/modules/troubleshoot/partials/cluster-diagnostics.adoc @@ -155,7 +155,8 @@ After applying these changes, verify the log level by <