diff options
author | Joffrey F <joffrey@docker.com> | 2016-01-04 17:59:52 -0800 |
---|---|---|
committer | Joffrey F <joffrey@docker.com> | 2016-01-04 17:59:52 -0800 |
commit | ba0543e4acb6bf3268ae453fa6fead1a06ba660a (patch) | |
tree | 32e9cfbd95f56a1e9200e80ad06f78ae96a1048b /docs | |
parent | ee0788e4ad07349bb2856a0f1bb40b3e9501d622 (diff) | |
download | docker-py-725-devices-format.tar.gz |
Improve host devices support725-devices-format
Add unit tests for utils.parse_devices
Rewrite documentation
Support dict and string format for device declaration
Signed-off-by: Joffrey F <joffrey@docker.com>
Diffstat (limited to 'docs')
-rw-r--r-- | docs/host-devices.md | 8 | ||||
-rw-r--r-- | docs/hostconfig.md | 13 |
2 files changed, 8 insertions, 13 deletions
diff --git a/docs/host-devices.md b/docs/host-devices.md index a35d340..d0d6669 100644 --- a/docs/host-devices.md +++ b/docs/host-devices.md @@ -12,7 +12,7 @@ cli.create_container( ) ``` -Each string is a single mapping using the colon (':') as the separator. So the -above example essentially allow the container to have read write permissions to -access the host's /dev/sda via a node named /dev/xvda in the container. The -devices parameter is a list to allow multiple devices to be mapped. +Each string is a single mapping using the following format: +`<path_on_host>:<path_in_container>:<cgroup_permissions>` +The above example allows the container to have read-write access to +the host's `/dev/sda` via a node named `/dev/xvda` inside the container. diff --git a/docs/hostconfig.md b/docs/hostconfig.md index 6b11798..b7b3b66 100644 --- a/docs/hostconfig.md +++ b/docs/hostconfig.md @@ -104,17 +104,12 @@ for example: * mem_swappiness (int): Tune a container's memory swappiness behavior. Accepts number between 0 and 100. * cpu_group (int): The length of a CPU period in microseconds. -* cpu_period (int): Microseconds of CPU time that the container can get in a CPU period. +* cpu_period (int): Microseconds of CPU time that the container can get in a + CPU period. * group_add (list): List of additional group names and/or IDs that the container process will run as. -* devices (list): A list of devices to add to the container specified as dicts - in the form: - ``` - { "PathOnHost": "/dev/deviceName", - "PathInContainer": "/dev/deviceName", - "CgroupPermissions": "mrw" - } - ``` +* devices (list): Host device bindings. See [host devices](host-devices.md) + for more information. **Returns** (dict) HostConfig dictionary |