document support for port's host_ip in "long syntax"

Signed-off-by: Nicolas De Loof <nicolas.deloof@gmail.com>
krutkurt · May 25, 2021 · 151c35e · 151c35e
1 parent 002f33d
commit 151c35e
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 0 deletions.
diff --git a/schema/compose-spec.json b/schema/compose-spec.json
@@ -316,6 +316,7 @@
                 "type": "object",
                 "properties": {
                   "mode": {"type": "string"},
+                  "host_ip": {"type": "string"},
                   "target": {"type": "integer"},
                   "published": {"type": "integer"},
                   "protocol": {"type": "string"}

diff --git a/spec.md b/spec.md
@@ -1491,12 +1491,14 @@ expressed in the short form.
 
 - `target`: the container port
 - `published`: the publicly exposed port
+- `host_ip`: the Host IP mapping, unspecified means all network interfaces (`0.0.0.0`) 
 - `protocol`: the port protocol (`tcp` or `udp`), unspecified means any protocol
 - `mode`: `host` for publishing a host port on each node, or `ingress` for a port to be load balanced.
 
 ```yml
 ports:
   - target: 80
+    host_ip: 127.0.0.1
     published: 8080
     protocol: tcp
     mode: host