Type Alias: Mount ​
Mount:
object
Type declaration ​
| Name | Type | Description |
|---|---|---|
BindOptions? | object | Optional configuration for the bind type. |
BindOptions.CreateMountpoint? | boolean | Create mount point on host if missing |
BindOptions.NonRecursive? | boolean | Disable recursive bind mount. |
BindOptions.Propagation? | "private" | "rprivate" | "shared" | "rshared" | "slave" | "rslave" | A propagation mode with the value [r]private, [r]shared, or [r]slave. |
BindOptions.ReadOnlyForceRecursive? | boolean | Raise an error if the mount cannot be made recursively read-only. |
BindOptions.ReadOnlyNonRecursive? | boolean | Make the mount non-recursively read-only, but still leave the mount recursive (unless NonRecursive is set to true in conjunction). Added in v1.44, before that version all read-only mounts were non-recursive by default. To match the previous behaviour this will default to true for clients on versions prior to v1.44. |
Consistency? | string | The consistency requirement for the mount: default, consistent, cached, or delegated. |
ReadOnly? | boolean | Whether the mount should be read-only. |
Source? | string | Mount source (e.g. a volume name, a host path). |
Target? | string | Container path. |
TmpfsOptions? | object | Optional configuration for the tmpfs type. |
TmpfsOptions.Mode? | number | The permission mode for the tmpfs mount in an integer. |
TmpfsOptions.Options? | string[][] | The options to be passed to the tmpfs mount. An array of arrays. Flag options should be provided as 1-length arrays. Other types should be provided as as 2-length arrays, where the first item is the key and the second the value. |
TmpfsOptions.SizeBytes? | number | The size for the tmpfs mount in bytes. |
Type? | "bind" | "volume" | "tmpfs" | "npipe" | "cluster" | The mount type. Available types: - bind Mounts a file or directory from the host into the container. Must exist prior to creating the container. - volume Creates a volume with the given name and options (or uses a pre-existing volume with the same name and options). These are not removed when the container is removed. - tmpfs Create a tmpfs with the given options. The mount source cannot be specified for tmpfs. - npipe Mounts a named pipe from the host into the container. Must exist prior to creating the container. - cluster a Swarm cluster volume |
VolumeOptions? | object | Optional configuration for the volume type. |
VolumeOptions.DriverConfig? | object | Map of driver specific options |
VolumeOptions.DriverConfig.Name? | string | Name of the driver to use to create the volume. |
VolumeOptions.DriverConfig.Options? | object | key/value map of driver specific options. |
VolumeOptions.Labels? | object | User-defined key/value metadata. |
VolumeOptions.NoCopy? | boolean | Populate volume with data from the target. |
VolumeOptions.Subpath? | string | Source path inside the volume. Must be relative without any back traversals. |