Clarify host_port field in CRI

Kubernetes-commit: d5c072117dbe97893e48d8d73f097e722bfecfe4
kubernetes · Mar 1, 2025 · e7dc3e2 · e7dc3e2
1 parent 084fa1d
commit e7dc3e2
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 2 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
@@ -201,7 +201,16 @@ message PortMapping {
     Protocol protocol = 1;
     // Port number within the container. Default: 0 (not specified).
     int32 container_port = 2;
-    // Port number on the host. Default: 0 (not specified).
+    // Port number on the host to map the container port to.
+    //
+    // * Valid host port range is 1-65535.
+    // * The value 0 has explicit semantic meaning: it indicates NO host port should be allocated.
+    // * The value 0 does NOT indicate dynamic port allocation. Future implementations
+    //   of dynamic allocation will use different values/semantics.
+    // * Implementations MUST handle the case where this field is explicitly set to 0,
+    //   This field SHOULD be omitted when no port is required.
+    //
+    // Default: If omitted, container port will not be exposed on the host.
     int32 host_port = 3;
     // Host IP.
     string host_ip = 4;