Skip to content

docker job from docker/36.0.2

Github source: 9b2b4d7 or master branch

Properties

bridge

Name of the network bridge to attach containers (defaults to docker0)

cidr_prefix

CIDR notation prefix (first 2 octets) for the network bridges IP

debug

Enable debug mode

Default
false

default_gateway

Container default gateway IPv4 address

default_gateway_v6

Container default gateway IPv6 address

default_ulimits

Array of default ulimits for containers

dns_options

Array of DNS options to be used

Array of DNS search domains to be used

dns_servers

Array of DNS servers to be used

env

http_proxy

HTTP proxy that Docker should use

https_proxy

HTTPS proxy that Docker should use

no_proxy

List of comma-separated hosts that Docker should skip connecting to the proxy

exec_options

Array of exec driver options

flannel

Enable flannel support

Default
false

icc

Allow unrestricted inter-container and Docker daemon host communication

Default
true

insecure_registries

Array of insecure registries (no certificate verification for HTTPS and enable HTTP fallback)

ip

Default IP when binding container ports

ip_forward

Enable net.ipv4.ip_forward and IPv6 forwarding

Default
true

ip_masq

Enable IP masquerading

Default
true

iptables

Enable Docker’s addition of iptables rules

Default
true

ipv6

Enable IPv6 networking

Default
false

labels

Array of key=value labels for the daemon

live_restore

Keep containers running if the daemon becomes unavailable

Default
false

log_driver

Default driver for container logs

log_level

Set the logging level (debug, info, warn, error, fatal)

Default
info

log_options

Array of log driver options

mtu

Set the containers network MTU (if no value is provided: default to the default route MTU or 1500 if no default route is available)

registry_ca_cert

Array of domain names and certificates used to securely communicate with a private docker registry

Default
[]
Example
registry_ca_cert:
- ca_cert: |+
    -----BEGIN CERTIFICATE-----
    -----END CERTIFICATE-----
  domain_name: |+
    "mydockerregistrydomain.com"
- ca_cert: |+
    -----BEGIN CERTIFICATE-----
    -----END CERTIFICATE-----
  domain_name: |+
    "mydockerregistrydomain2.com"

registry_mirrors

Array of preferred Docker registry mirrors

selinux_enable

Enable selinux support

Default
false

shared_mounts_enable

Enable shared_mounts

Default
false

storage_driver

Use a specific storage driver

Default
overlay2

storage_options

Array of storage driver options

store_dir

Path to use as the root of the Docker runtime

Default
/var/vcap/store

tcp_address

TCP address where Docker daemon will listen to (if not set, TCP will not be available)

Default
127.0.0.1

tcp_port

TCP port where Docker daemon will listen to (if not set, TCP will not be available)

Default
"4243"

tls_cacert

Trust only remotes providing a certificate signed by the CA given here, if tcp_address not 127.0.0.1

tls_cert

TLS certificate file, if tcp_address not 127.0.0.1

tls_key

TLS key file, if tcp_address not 127.0.0.1

ulimit

nofile

Maximum number of open files

Default
8192

userland_proxy

Use userland proxy for loopback traffic

Default
true

vm

max_map_count

If set, sets vm.max_map_count on VM

Default
""

Templates

Templates are rendered and placed onto corresponding instances during the deployment process. This job's templates will be placed into /var/vcap/jobs/docker/ directory (learn more).

  • bin/cgroupfs-mount (from bin/cgroupfs-mount)
  • bin/ctl (from bin/ctl)
  • bin/envrc (from bin/envrc)
  • bin/job_properties.sh (from bin/job_properties.sh.erb)
  • bin/setup-user-env (from bin/setup-user-env)
  • config/docker.cacert (from config/docker.cacert.erb)
  • config/docker.cert (from config/docker.cert.erb)
  • config/docker.key (from config/docker.key.erb)
  • config/docker_registry_certs (from config/docker_registry_certs.erb)

Packages

Packages are compiled and placed onto corresponding instances during the deployment process. Packages will be placed into /var/vcap/packages/ directory.