Browse Source

Merge pull request #30468 from ralphtheninja/master

update api docs on Placement.Constraints for services
Vincent Demeester 8 years ago
parent
commit
0b47ca4339
1 changed files with 14 additions and 4 deletions
  1. 14 4
      docs/api/v1.24.md

+ 14 - 4
docs/api/v1.24.md

@@ -4460,7 +4460,11 @@ List services
               "Condition": "any",
               "MaxAttempts": 0
             },
-            "Placement": {}
+            "Placement": {
+              "Constraints": [
+                "node.role == worker"
+              ]
+            }
           },
           "Mode": {
             "Replicated": {
@@ -4576,7 +4580,11 @@ image](#create-an-image) section for more details.
             "max-size": "10M"
           }
         },
-        "Placement": {},
+        "Placement": {
+          "Constraints": [
+            "node.role == worker"
+          ]
+        },
         "Resources": {
           "Limits": {
             "MemoryBytes": 104857600
@@ -4683,7 +4691,8 @@ image](#create-an-image) section for more details.
           is 0, which is ignored).
         - **Window** – Windows is the time window used to evaluate the restart policy (default value is
           0, which is unbounded).
-    - **Placement** – An array of constraints.
+    - **Placement** – Restrictions on where a service can run.
+        - **Constraints** – An array of constraints, e.g. `[ "node.role == manager" ]`.
 - **Mode** – Scheduling mode for the service (`replicated` or `global`, defaults to `replicated`).
 - **UpdateConfig** – Specification for the update strategy of the service.
     - **Parallelism** – Maximum number of tasks to be updated in one iteration (0 means unlimited
@@ -4922,7 +4931,8 @@ image](#create-an-image) section for more details.
           is 0, which is ignored).
         - **Window** – Windows is the time window used to evaluate the restart policy (default value is
           0, which is unbounded).
-    - **Placement** – An array of constraints.
+    - **Placement** – Restrictions on where a service can run.
+        - **Constraints** – An array of constraints, e.g. `[ "node.role == manager" ]`.
 - **Mode** – Scheduling mode for the service (`replicated` or `global`, defaults to `replicated`).
 - **UpdateConfig** – Specification for the update strategy of the service.
     - **Parallelism** – Maximum number of tasks to be updated in one iteration (0 means unlimited