Update to docker_container module proposal

This commit is contained in:
chouseknecht 2016-03-04 07:03:08 -05:00
parent d6546a7513
commit 3d0637292c

View file

@ -24,12 +24,7 @@ Parameters for connecting to the API are not listed here. They are included in t
``` ```
blkio_weight: blkio_weight:
description: description:
- Block IO weight - Block IO (relative weight), between 10 and 1000.
default: null
blkio_weight_devices:
description:
- List of C(DEVICE_NAME:WEIGHT) pairs
default: null default: null
capabilities: capabilities:
@ -37,16 +32,6 @@ capabilities:
- List of capabilities to add to the container. - List of capabilities to add to the container.
default: null default: null
capabilities_drop:
description:
- List of capabilities to remove from the container
default: null
cgroup_parent:
description:
- Optional parent cgroup for the container
default: null
command: command:
description: description:
- Command or list of commands to execute in the container when it starts. - Command or list of commands to execute in the container when it starts.
@ -54,12 +39,12 @@ command:
cpu_period: cpu_period:
description: description:
- Limit CPU CFS (Completely Fair Scheduler) period. Expressed in milliseconds. - Limit CPU CFS (Completely Fair Scheduler) period
default: 0 default: 0
cpu_quota: cpu_quota:
description: description:
- Limit CPU CFS (Completely Fair Scheduler) quota. Expressed in milliseconds. - Limit CPU CFS (Completely Fair Scheduler) quota
default: 0 default: 0
cpuset_cpus: cpuset_cpus:
@ -74,8 +59,8 @@ cpuset_mems:
cpu_shares: cpu_shares:
description: description:
- CPU shares. Integer value. - CPU shares (relative weight).
default: 0 default: null
detach: detach:
description: description:
@ -85,27 +70,8 @@ detach:
devices: devices:
description: description:
- List of host devices to add to the container - List of host device bindings to add to the container. Each binding is a mapping expressed
default: null in the format: <path_on_host>:<path_in_container>:<cgroup_permissions>
device_read_bps
description:
- List. Limit read rate (bytes per second) from a device in the format C(/dev/sda:1mb)
default: null
device_read_iops:
description:
- List. Limit read rate (IO per second) from a device in the format C(/dev/sda:1000)
default: null
device_write_bps:
description:
- List. Limit write rate (bytes per second) to a device in the foramt C(/dev/sda:1mb)
default: null
device_write_iops:
description:
- List. Limit write rate (IO per second) to a device C(/dev/sda:1000)
default: null default: null
dns_servers: dns_servers:
@ -118,14 +84,14 @@ dns_search_domains:
- List of custom DNS search domains. - List of custom DNS search domains.
default: null default: null
env_vars: env:
description: description:
- Dictionary of key,value pairs. - Dictionary of key,value pairs.
default: null default: null
entrypoint: entrypoint:
description: description:
- Overwrite the default ENTRYPOINT of the image. - String or list of commands that overwrite the default ENTRYPOINT of the image.
default: null default: null
etc_hosts: etc_hosts:
@ -140,6 +106,8 @@ exposed_ports:
If the port is already exposed using EXPOSE in a Dockerfile, it does not If the port is already exposed using EXPOSE in a Dockerfile, it does not
need to be exposed again. need to be exposed again.
default: null default: null
aliases:
- exposed
force_kill: force_kill:
description: description:
@ -149,7 +117,7 @@ force_kill:
groups: groups:
description: description:
- List of additional groups to join. - List of additional group names and/or IDs that the container process will run as.
default: null default: null
hostname: hostname:
@ -191,8 +159,8 @@ keep_volumes:
kill_signal: kill_signal:
description: description:
- Signal used to kill a running container when state is absent. - Override default signal used to kill a running container.
default: KILL default null:
kernel_memory: kernel_memory:
description: description:
@ -202,7 +170,7 @@ kernel_memory:
labels: labels:
description: description:
- Set meta data on the cotnainer. Dictionary of key value paris: - Dictionary of key value pairs.
default: null default: null
links: links:
@ -253,7 +221,7 @@ memory_swap:
Number is a positive integer. Unit can be one of b, k, m, or g. Number is a positive integer. Unit can be one of b, k, m, or g.
default: 0 default: 0
memory_swapiness: memory_swappiness:
description: description:
- Tune a container's memory swappiness behavior. Accepts an integer between 0 and 100. - Tune a container's memory swappiness behavior. Accepts an integer between 0 and 100.
default: 0 default: 0
@ -274,10 +242,10 @@ network_mode:
- none - none
default: null default: null
net_alias: oom_killer:
description: desription:
- Add network scoped alias to the container. - Whether or not to disable OOM Killer for the container.
default: null default: false
paused: paused:
description: description:
@ -302,6 +270,8 @@ published_ports:
- Container ports must be exposed either in the Dockerfile or via the C(expose) option. - Container ports must be exposed either in the Dockerfile or via the C(expose) option.
- A value of ALL will publish all exposed container ports to random host ports, ignoring - A value of ALL will publish all exposed container ports to random host ports, ignoring
any other mappings. any other mappings.
aliases:
- ports
read_only: read_only:
description: description:
@ -375,8 +345,8 @@ state:
stop_signal: stop_signal:
description: description:
- Signal used to stop the container. - Override default signal used to stop the container.
default: SIGINT default: null
stop_timeout: stop_timeout:
description: description:
@ -418,6 +388,11 @@ volumes:
private label for the volume. private label for the volume.
default: null default: null
volume_driver:
description:
- The container's volume driver.
default: none
volumes_from: volumes_from:
description: description:
- List of container names or Ids to get volumes from. - List of container names or Ids to get volumes from.