docs(volumes): Document access_mode and warm-plug volumes#130
Open
JeromeJaggi wants to merge 1 commit into
Open
docs(volumes): Document access_mode and warm-plug volumes#130JeromeJaggi wants to merge 1 commit into
JeromeJaggi wants to merge 1 commit into
Conversation
Replace the old binary read-only-sharing description in the Shared volumes section with the access_mode field and its three values ro-many, rw-once, rw-many. Add a Warm-plug volumes section explaining how to attach a new volume to an instance with a snapshot via PATCH; the change is queued and applied on the next scale-to-zero wake-up. Signed-off-by: Jerome Jaggi <jerome@unikraft.io>
JeromeJaggi
temporarily deployed
to
pull-requests
GitHub Actions
Inactive
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.
Summary
Two v0.9 volume features that weren't yet in the public docs.
access_modefieldThe Shared volumes section was still describing the old binary model: "more than one instance can mount the same volume simultaneously as long as all mounts are in read-only mode" with the
readonly: trueflag. v0.9 introduced a richeraccess_modefield with three values:ro-manyroxrw-oncerworw-manyrwxThis PR replaces the old prose and example with the new
access_modefield, including guidance on which mode fits which workload.Warm-plug volumes
New section explaining that a
PATCH /instances/{name}can add a volume to an instance that already has a snapshot. The platform queues the change and applies it on the next scale-to-zero wake-up. Same mechanism as the queued-update for ROMs.Verification
make lintpasses 0/0/0 on the modified file.prod-staging.Risk flags
access_mode,ro-many/rw-once/rw-many, alias spellingsrox/rwo/rwx) come from the v0.9 platform team update slides. If the actual API field name or value spelling differs, please flag during review and I'll fix.PATCH /instances/{name}. If the canonical endpoint or body format differs (e.g., a separate `/volumes/attach` endpoint), please flag.Audit reference
Items #4 (shared RW virtiofs / `access_mode`) and #5 (warm-plug volumes) from the v0.9 docs audit.
This PR was created by an AI agent.