Browse code

Add PortConfig.PublishMode to API documentation

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>

Sebastiaan van Stijn authored on 2017/10/04 22:34:08
Showing 1 changed files
... ...
@@ -3042,6 +3042,24 @@ definitions:
3042 3042
       PublishedPort:
3043 3043
         description: "The port on the swarm hosts."
3044 3044
         type: "integer"
3045
+      PublishMode:
3046
+        description: |
3047
+          The mode in which port is published.
3048
+
3049
+          <p><br /></p>
3050
+
3051
+          - "ingress" makes the target port accessible on on every node,
3052
+            regardless of whether there is a task for the service running on
3053
+            that node or not.
3054
+          - "host" bypasses the routing mesh and publish the port directly on
3055
+            the swarm node where that service is running.
3056
+
3057
+        type: "string"
3058
+        enum:
3059
+          - "ingress"
3060
+          - "host"
3061
+        default: "ingress"
3062
+        example: "ingress"
3045 3063
 
3046 3064
   EndpointSpec:
3047 3065
     description: "Properties that can be configured to access and load balance a service."