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

CRI: clarify `Mount.host_path` docs Kubernetes-commit: e9f0ea6f86f099cbc47e1939ea6d4edde3d51d1c
kubernetes · Oct 13, 2024 · 8706270 · 8706270
2 parents 399f041 + eb41052
commit 8706270
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 4 deletions.
diff --git a/pkg/apis/runtime/v1/api.pb.go b/pkg/apis/runtime/v1/api.pb.go
diff --git a/pkg/apis/runtime/v1/api.proto b/pkg/apis/runtime/v1/api.proto
@@ -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.