[deckhouse-cli] fix mirror docs - #429
Merged
Merged
Conversation
Signed-off-by: Pavel Okhlopkov <[email protected]>
Signed-off-by: Pavel Okhlopkov <[email protected]>
Glitchy-Sheep
approved these changes
Jul 31, 2026
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
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.
What this PR does
Documentation only — no code changes. It adds first-time reference docs for two previously undocumented command trees and brings the mirror and plugins docs in line with the current implementation.
d8 system— newinternal/system/README.md(the command had no docs). Covers the whole tree:get/editof thekube-systembootstrap Secrets, the module lifecycle (enable/disable/maintenance/approve/apply-now/values/snapshots),package scan,queue,logs, andcollect-debug-info— with the three cluster-access paths and theleader=truepod requirement spelled out, plus a safety section.d8 status— newinternal/status/README.md(also undocumented). Documents the read-only, nine-section cluster health report: the source resource and columns of each section, the credential masking in the settings section, prerequisites/RBAC, and that sections are independent/best-effort.d8 mirror— expandedinternal/mirror/README.MD(+PROXY-REGISTRY.mdanddocs/mirror-pull-dry-run.md). Adds Release Channel Selection (single-channel pulls, tag-pinned behaviour, suspended channels, LTS/CSE editions), VEX vulnerability-attestation images, package filtering/mirroring/selection, Security Databases, Editions, and multi-version pinning.d8 plugins— corrected and extendeddocs/plugins.mdandinternal/plugins/README.md(see fixes below).README.md— adds the missingstatusrow to the command table and pointssystemat its new README.Why we need it
Two command trees (
system,status) shipped with no reference documentation, and the plugins docs had drifted from the code — including a wrong RBAC role that would have led admins to bind the wrong ClusterRole. This aligns the docs with the implementation and fills the gaps, following the style of the existinginternal/cr/README.md.Notable correctness fixes (plugins)
d8:registry-packages-proxy:cli-download(the self-update role); the plugin download path requiresd8:registry-packages-proxy:packages-download. Worth a reviewer confirming against the platform RBAC manifests.--sourcebypass exists (pulls straight from a registry, force-enables--skip-cluster-checks); now documented as such.x509/endpoint-discovery attribution (it's the kube-API leg, not the proxy), and added the missing 5xx, endpoint-discovery, and cluster-unreachable rows.noneOf(forbidden modules), conditional plugin deps, and the cluster snapshot (three reads, lazy, cached, 30s timeout).