docs: add rpk k8s command reference (26.2)#1801
Closed
JakeSCahill wants to merge 1 commit into
Closed
Conversation
Generated with doc-tools from rpk v26.2.1-rc3 with the k8s plugin 26.2.1-beta.3 installed. Flags for the plugin-provided multicluster commands are injected from the plugin's cobra help because the rpk plugin protocol does not expose flag data. Includes a beta note on the install page: no plugin release is marked latest during the beta, so installs must pin --plugin-version.
✅ Deploy Preview for redpanda-docs-preview ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Contributor
Author
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds reference pages for the
rpk k8scommand family shipped in 26.2 (DOC-2364):rpk k8s(install, uninstall, upgrade, version)rpk k8s multicluster(bootstrap, bundle, status)How these were generated
Generated with the standard doc-tools rpk generator from
rpk v26.2.1-rc3 --print-treewith the k8s plugin26.2.1-beta.3installed, plus two gap-fills:--help-autocomplete) exposes no flag data, so the flags tables for themulticlustersubcommands are parsed from the plugin's own cobra help (built from the operator source at thev26.2.1-beta.3tag) and injected into the tree before generation.Beta install caveat (documented on the install page)
During the beta,
rpk k8s installwithout flags fails withno latest Redpanda Kubernetes plugin release found: the plugin publisher only marks pureX.Y.Zversions as latest, so26.2.1-beta.3never becomeslatest(confirmed by Rafał Korepta;publish.gostableVersionRe). The install page documents pinning:rpk k8s install --plugin-version {operator-beta-version}.Release-day follow-ups (GA, July 28)
k8stoKNOWN_PLUGINSin docs-extensions-and-macros so the automation covers these pages (blocked until alatestplugin release exists, or the pipeline pins the version).docs-data/rpk-overrides.jsonon the automation branch.Validation
{operator-beta-version}resolves in the install note.