Merge pull request #127920 from saschagrunert/mount-hostpath-docs

CRI: clarify `Mount.host_path` docs
This commit is contained in:
Kubernetes Prow Robot 2024-10-13 02:24:26 +01:00 committed by GitHub
commit e9f0ea6f86
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 8 additions and 4 deletions

View File

@ -627,8 +627,10 @@ func (m *PortMapping) GetHostIp() string {
type Mount struct {
// Path of the mount within the container.
ContainerPath string `protobuf:"bytes,1,opt,name=container_path,json=containerPath,proto3" json:"container_path,omitempty"`
// Path of the mount on the host. If the hostPath doesn't exist, then runtimes
// should report error. If the hostpath is a symbolic link, runtimes should
// Path of the mount on the host. Has to be empty if the image field below
// is provided, because those fields are mutually exclusive. If the image
// field below is nil and the host path doesn't exist, 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.
HostPath string `protobuf:"bytes,2,opt,name=host_path,json=hostPath,proto3" json:"host_path,omitempty"`
// If set, the mount is read-only.

View File

@ -221,8 +221,10 @@ enum MountPropagation {
message Mount {
// Path of the mount within the container.
string container_path = 1;
// Path of the mount on the host. If the hostPath doesn't exist, then runtimes
// should report error. If the hostpath is a symbolic link, runtimes should
// Path of the mount on the host. Has to be empty if the image field below
// is provided, because those fields are mutually exclusive. If the image
// field below is nil and the host path doesn't exist, 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;
// If set, the mount is read-only.