Browse code

Merge pull request #8286 from ClusterHQ/8285-volume-api-docs

Document Volumes and Binds

James Turnbull authored on 2014/10/01 04:53:41
Showing 1 changed files
... ...
@@ -155,6 +155,8 @@ Json Parameters:
155 155
         exit code is non-zero.  If `on-failure` is used, `MaximumRetryCount`
156 156
         controls the number of times to retry before giving up.
157 157
         The default is not to restart. (optional)
158
+-   **Volumes** – An object mapping mountpoint paths (strings) inside the
159
+        container to empty objects.
158 160
 -   **config** – the container's configuration
159 161
 
160 162
 Query Parameters:
... ...
@@ -445,6 +447,11 @@ Start the container `id`
445 445
 
446 446
 Json Parameters:
447 447
 
448
+-   **Binds** – A list of volume bindings for this container.  Each volume
449
+        binding is a string of the form `container_path` (to create a new
450
+        volume for the container), `host_path:container_path` (to bind-mount
451
+        a host path into the container), or `host_path:container_path:ro`
452
+        (to make the bind-mount read-only inside the container).
448 453
 -   **hostConfig** – the container's host configuration (optional)
449 454
 
450 455
 Status Codes: