Skip to content

docs: sweep rpk redpanda admin deprecation for 26.2 (DOC-2121) - #1832

Open
Feediver1 wants to merge 2 commits into
betafrom
DOC-2121-rpk-admin-deprecation
Open

docs: sweep rpk redpanda admin deprecation for 26.2 (DOC-2121)#1832
Feediver1 wants to merge 2 commits into
betafrom
DOC-2121-rpk-admin-deprecation

Conversation

@Feediver1

@Feediver1 Feediver1 commented Jul 27, 2026

Copy link
Copy Markdown
Contributor

Resolves https://redpandadata.atlassian.net/browse/DOC-2121

Sweeps all prose usage of the deprecated rpk redpanda admin commands, per redpanda#30332 (merged 2026-05-05, verified contained in the v26.2.1 tag). In 26.2 the old tree is hidden from help output and shimmed to the new rpk cluster commands.

Changes

  • Prose sweep (18 files): decommission/rolling-upgrade/rolling-restart pages and partials, node pools, nodewatcher, production readiness, use-admin-api, GBAC and cluster-diagnostics partials:
    • rpk redpanda admin brokers decommission[-status]rpk cluster brokers decommission[-status]
    • rpk redpanda admin brokers listrpk cluster info -b --detailed (existing sample outputs already match the new command's enriched broker table, so outputs are unchanged)
    • rpk redpanda admin config log-level setrpk cluster loggers set
  • Deprecated Features (upgrade:deprecated/index.adoc): new 26.2.1 row in rpk Renames with the full seven-command migration table.
  • What's New: deprecation entry, appended after the existing Kafka entry to avoid conflicting with docs: 26.2 What's New entries for shipped features (DOC-2395) #1828 (which inserts before it).
  • admin-addresses.adoc: the rpk redpanda admin flag-table row is annotated as deprecated (kept because the shims still work and still take --hosts).

Coordination with the 26.2 rpk regen

  • Xrefs that previously pointed at rpk-redpanda-admin-* reference pages now point at existing new pages where possible (rpk-cluster-info). Where the new pages don't exist yet (rpk-cluster-brokers-*, rpk-cluster-loggers-*), commands are plain code text with // TODO(DOC-2121) markers, following the pre-regen precedent from docs: fetch read coalescing (DOC-2386) #1821.
  • The 12 generated rpk-redpanda-admin-* pages and their nav entries are deliberately untouched: the regen owns their removal. When it drops them, the new rpk cluster pages need page-aliases for the 12 old URLs (flagged in the DOC-2121 research; not doable until the new pages exist).

Review notes

  • Two replacements are not 1:1 (brokers list and config print); each swapped site was checked in context, and the canonical brokers list replacement's --include-decommissioned flag was omitted where the docs only check active-broker health or versions.
  • cloud-docs and rp-connect-docs have zero occurrences (verified) — this repo is the full scope.

🤖 Generated with Claude Code

Preview pages

Representative pages (20 files changed in total; all verified rendering):

Note for reviewers: the left nav still lists the 12 generated rpk redpanda admin reference pages — deliberate; the 26.2 rpk regen owns their removal (see "Coordination with the 26.2 rpk regen").

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 <[email protected]>
@Feediver1
Feediver1 requested a review from a team as a code owner July 27, 2026 21:38
@netlify

netlify Bot commented Jul 27, 2026

Copy link
Copy Markdown

Deploy Preview for redpanda-docs-preview ready!

Name Link
🔨 Latest commit 3e30ca1
🔍 Latest deploy log https://app.netlify.com/projects/redpanda-docs-preview/deploys/6a681236103685000951d703
😎 Deploy Preview https://deploy-preview-1832--redpanda-docs-preview.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@coderabbitai

coderabbitai Bot commented Jul 27, 2026

Copy link
Copy Markdown
Contributor

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 5ed8baca-4ef4-49f7-9c56-08b3ee492410

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch DOC-2121-rpk-admin-deprecation

Comment @coderabbitai help to get the list of available commands.

@Feediver1
Feediver1 requested a review from r-vasquez July 27, 2026 21:40
Feediver1 added a commit that referenced this pull request Jul 28, 2026
- Replace rpk redpanda admin brokers list (deprecated in 26.2, swept in
  #1832) with rpk cluster info -b --detailed in the Limitations bullet.
- Move the Shadowing-topology sentence and xref out of the What's New
  entry: the target page ships in #1819, so this PR is now
  self-contained and can merge independently. #1819 re-adds the
  sentence alongside its page.

Co-Authored-By: Claude Fable 5 <[email protected]>
@Feediver1

Copy link
Copy Markdown
Contributor Author

@copilot resolve the merge conflicts in this pull request

Copilot AI commented Jul 28, 2026

Copy link
Copy Markdown
Contributor

@copilot resolve the merge conflicts in this pull request

Resolved in commit 3e30ca1 by merging origin/beta into this branch and fixing the conflict in modules/get-started/pages/release-notes/redpanda.adoc so both the deprecation note and the new Tiered Storage content are preserved.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants