This information was added to an older version of the API
documentation (through 164ab2cfc9900a5e9a8037d41faea2bfdf3d64f1 and
5213a0a67ec635a45e640364e8aa9bf5f431625e), but only added in the
"docs" branch.
This patch copies the information to the swagger file.
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
(cherry picked from commit 79c877cfa71f7929facda0160bfec12ebed4e0ef)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
| ... | ... |
@@ -628,12 +628,44 @@ definitions: |
| 628 | 628 |
Binds: |
| 629 | 629 |
type: "array" |
| 630 | 630 |
description: | |
| 631 |
- A list of volume bindings for this container. Each volume binding is a string in one of these forms: |
|
| 632 |
- |
|
| 633 |
- - `host-src:container-dest` to bind-mount a host path into the container. Both `host-src`, and `container-dest` must be an _absolute_ path. |
|
| 634 |
- - `host-src:container-dest:ro` to make the bind mount read-only inside the container. Both `host-src`, and `container-dest` must be an _absolute_ path. |
|
| 635 |
- - `volume-name:container-dest` to bind-mount a volume managed by a volume driver into the container. `container-dest` must be an _absolute_ path. |
|
| 636 |
- - `volume-name:container-dest:ro` to mount the volume read-only inside the container. `container-dest` must be an _absolute_ path. |
|
| 631 |
+ A list of volume bindings for this container. Each volume binding |
|
| 632 |
+ is a string in one of these forms: |
|
| 633 |
+ |
|
| 634 |
+ - `host-src:container-dest[:options]` to bind-mount a host path |
|
| 635 |
+ into the container. Both `host-src`, and `container-dest` must |
|
| 636 |
+ be an _absolute_ path. |
|
| 637 |
+ - `volume-name:container-dest[:options]` to bind-mount a volume |
|
| 638 |
+ managed by a volume driver into the container. `container-dest` |
|
| 639 |
+ must be an _absolute_ path. |
|
| 640 |
+ |
|
| 641 |
+ `options` is an optional, comma-delimited list of: |
|
| 642 |
+ |
|
| 643 |
+ - `nocopy` disables automatic copying of data from the container |
|
| 644 |
+ path to the volume. The `nocopy` flag only applies to named volumes. |
|
| 645 |
+ - `[ro|rw]` mounts a volume read-only or read-write, respectively. |
|
| 646 |
+ If omitted or set to `rw`, volumes are mounted read-write. |
|
| 647 |
+ - `[z|Z]` applies SELinux labels to allow or deny multiple containers |
|
| 648 |
+ to read and write to the same volume. |
|
| 649 |
+ - `z`: a _shared_ content label is applied to the content. This |
|
| 650 |
+ label indicates that multiple containers can share the volume |
|
| 651 |
+ content, for both reading and writing. |
|
| 652 |
+ - `Z`: a _private unshared_ label is applied to the content. |
|
| 653 |
+ This label indicates that only the current container can use |
|
| 654 |
+ a private volume. Labeling systems such as SELinux require |
|
| 655 |
+ proper labels to be placed on volume content that is mounted |
|
| 656 |
+ into a container. Without a label, the security system can |
|
| 657 |
+ prevent a container's processes from using the content. By |
|
| 658 |
+ default, the labels set by the host operating system are not |
|
| 659 |
+ modified. |
|
| 660 |
+ - `[[r]shared|[r]slave|[r]private]` specifies mount |
|
| 661 |
+ [propagation behavior](https://www.kernel.org/doc/Documentation/filesystems/sharedsubtree.txt). |
|
| 662 |
+ This only applies to bind-mounted volumes, not internal volumes |
|
| 663 |
+ or named volumes. Mount propagation requires the source mount |
|
| 664 |
+ point (the location where the source directory is mounted in the |
|
| 665 |
+ host operating system) to have the correct propagation properties. |
|
| 666 |
+ For shared volumes, the source mount point must be set to `shared`. |
|
| 667 |
+ For slave volumes, the mount must be set to either `shared` or |
|
| 668 |
+ `slave`. |
|
| 637 | 669 |
items: |
| 638 | 670 |
type: "string" |
| 639 | 671 |
ContainerIDFile: |