docs: document volume request lifecycle contracts#68
Open
AleksZimin wants to merge 2 commits into
Open
Conversation
Signed-off-by: Aleksandr Zimin <alexandr.zimin@flant.com>
Provide executable VCR and VRR examples and document the actual validation, RBAC, identity, and retention behavior used by snapshot consumers. Signed-off-by: Aleksandr Zimin <alexandr.zimin@flant.com>
AleksZimin
marked this pull request as ready for review
July 23, 2026 13:08
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.
Description
Document the effective
VolumeCaptureRequestandVolumeRestoreRequestcontracts:This PR changes documentation only. It does not alter CRDs, controllers, provisioner behavior, or deployment resources. It has no impact on the control plane, Prometheus, ingress controllers, or other critical cluster components.
Why do we need it, and what problem does it solve?
State-snapshotter and domain controllers depend on VCR/VRR behavior, but the previous documentation included invalid examples and overstated identity, template, RBAC, and retention guarantees.
A consumer following those examples could create a VRR that the executor silently ignores, misunderstand which fields are authoritative, or make incorrect assumptions about artifact lifetime and access control.
What is the expected result?
Consumers can determine:
No runtime behavior changes.
Validation performed:
git diff --checkpassed.E2E and manual cluster tests were not run.
Checklist