CRI: clarify Mount.host_path docs
#127920
Merged
Conversation
This file contains 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
k8s-ci-robot
added
release-note-none
saschagrunert
changed the title
Mount.host_path docsMount.host_path docs
k8s-ci-robot
added
cncf-cla: yes
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: saschagrunert The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
k8s-ci-robot
added
the
approved
saschagrunert
force-pushed
the
mount-hostpath-docs
branch
from
2b79c89 to
8a43496
Compare
k8s-ci-robot
added
size/S
saschagrunert
changed the title
Mount.host_path docsMount.host_path docs
k8s-ci-robot
removed
the
do-not-merge/work-in-progress
hashim21223445
approved these changes
Oct 8, 2024
carlory
reviewed
Oct 8, 2024
| // Path of the mount on the host. Can be empty if the image field below is | ||
| // provided. If the host path doesn't exist and image is nil, then runtimes | ||
| // should report an error. If the hostpath is a symbolic link, runtimes | ||
| // should follow the symlink and mount the real destination to container. | ||
| string host_path = 2; |
There was a problem hiding this comment.
If they can't be used together, it's better to mention that host_path and the following image are mutually exclusive.
There was a problem hiding this comment.
IMO, they represent different volume sources.
There was a problem hiding this comment.
Updated the doc comment as suggested.
Mention that the `host_path` can be empty if image volumes are being used. Signed-off-by: Sascha Grunert <sgrunert@redhat.com>
saschagrunert
force-pushed
the
mount-hostpath-docs
branch
from
8a43496 to
ce9351c
Compare
|
/test pull-kubernetes-integration |
|
/triage accepted |
k8s-ci-robot
added
triage/accepted
|
LGTM looking forward to others' review |
|
/lgtm |
k8s-ci-robot
added
the
lgtm
|
LGTM label has been added. Git tree hash: b4c1aa289838e15fcfbaf5b9276070eb94b13b43
|
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 type of PR is this?
/kind documentation
What this PR does / why we need it:
Mention that the
host_pathcan be empty if image volumes are being used.Which issue(s) this PR fixes:
None
Special notes for your reviewer:
PTAL @kubernetes/sig-node-pr-reviews
cc @carlory
Does this PR introduce a user-facing change?
Additional documentation e.g., KEPs (Kubernetes Enhancement Proposals), usage docs, etc.: