Browse Source

Merge pull request #20990 from sds/fix-data-volume-rest-api-docs

Fix documentation for creating containers with data volumes
Sebastiaan van Stijn 9 years ago
parent
commit
f480c69625

+ 6 - 2
docs/reference/api/docker_remote_api_v1.22.md

@@ -257,6 +257,9 @@ Create a container
                "Propagation": ""
                "Propagation": ""
              }
              }
            ],
            ],
+           "Volumes": {
+             "/volumes/data": {}
+           }
            "WorkingDir": "",
            "WorkingDir": "",
            "NetworkDisabled": false,
            "NetworkDisabled": false,
            "MacAddress": "12:34:56:78:9a:bc",
            "MacAddress": "12:34:56:78:9a:bc",
@@ -373,7 +376,6 @@ Json Parameters:
 -   **StopSignal** - Signal to stop a container as a string or unsigned integer. `SIGTERM` by default.
 -   **StopSignal** - Signal to stop a container as a string or unsigned integer. `SIGTERM` by default.
 -   **HostConfig**
 -   **HostConfig**
     -   **Binds** – A list of volume bindings for this container. Each volume binding is a string in one of these forms:
     -   **Binds** – A list of volume bindings for this container. Each volume binding is a string in one of these forms:
-           + `container_path` to create a new volume for the container
            + `host_path:container_path` to bind-mount a host path into the container
            + `host_path:container_path` to bind-mount a host path into the container
            + `host_path:container_path:ro` to make the bind-mount read-only inside the container.
            + `host_path:container_path:ro` to make the bind-mount read-only inside the container.
            + `volume_name:container_path` to bind-mount a volume managed by a volume plugin into the container.
            + `volume_name:container_path` to bind-mount a volume managed by a volume plugin into the container.
@@ -491,7 +493,9 @@ Return low-level information on the container `id`
 			"StdinOnce": false,
 			"StdinOnce": false,
 			"Tty": false,
 			"Tty": false,
 			"User": "",
 			"User": "",
-			"Volumes": null,
+			"Volumes": {
+                          "/volumes/data": {}
+                        },
 			"WorkingDir": "",
 			"WorkingDir": "",
 			"StopSignal": "SIGTERM"
 			"StopSignal": "SIGTERM"
 		},
 		},

+ 6 - 2
docs/reference/api/docker_remote_api_v1.23.md

@@ -276,6 +276,9 @@ Create a container
                "Propagation": ""
                "Propagation": ""
              }
              }
            ],
            ],
+           "Volumes": {
+             "/volumes/data": {}
+           }
            "WorkingDir": "",
            "WorkingDir": "",
            "NetworkDisabled": false,
            "NetworkDisabled": false,
            "MacAddress": "12:34:56:78:9a:bc",
            "MacAddress": "12:34:56:78:9a:bc",
@@ -393,7 +396,6 @@ Json Parameters:
 -   **StopSignal** - Signal to stop a container as a string or unsigned integer. `SIGTERM` by default.
 -   **StopSignal** - Signal to stop a container as a string or unsigned integer. `SIGTERM` by default.
 -   **HostConfig**
 -   **HostConfig**
     -   **Binds** – A list of volume bindings for this container. Each volume binding is a string in one of these forms:
     -   **Binds** – A list of volume bindings for this container. Each volume binding is a string in one of these forms:
-           + `container_path` to create a new volume for the container
            + `host_path:container_path` to bind-mount a host path into the container
            + `host_path:container_path` to bind-mount a host path into the container
            + `host_path:container_path:ro` to make the bind-mount read-only inside the container.
            + `host_path:container_path:ro` to make the bind-mount read-only inside the container.
            + `volume_name:container_path` to bind-mount a volume managed by a volume plugin into the container.
            + `volume_name:container_path` to bind-mount a volume managed by a volume plugin into the container.
@@ -511,7 +513,9 @@ Return low-level information on the container `id`
 			"StdinOnce": false,
 			"StdinOnce": false,
 			"Tty": false,
 			"Tty": false,
 			"User": "",
 			"User": "",
-			"Volumes": null,
+			"Volumes": {
+                          "/volumes/data": {}
+                        },
 			"WorkingDir": "",
 			"WorkingDir": "",
 			"StopSignal": "SIGTERM"
 			"StopSignal": "SIGTERM"
 		},
 		},