Puppet Class: docker

Inherits:

docker::params

docker::params
docker

show all

Defined in:

manifests/init.pp

Overview

Class: docker

Module to install an up-to-date version of Docker from package.

Parameters

version

The package version to install, used to set the package name. Defaults to undefined

ensure

Passed to the docker package. Defaults to present

prerequired_packages

An array of additional packages that need to be installed to support docker. Defaults change depending on the operating system.

docker_cs

Whether or not to use the CS (Commercial Support) Docker packages. Defaults to false.

tcp_bind

The tcp socket to bind to in the format tcp://127.0.0.1:4243 Defaults to undefined

tls_enable

Enable TLS. Defaults to false

tls_verify

Use TLS and verify the remote Defaults to true

tls_cacert

Path to TLS CA certificate Defaults to '/etc/docker/ca.pem'

tls_cert

Path to TLS certificate file Defaults to '/etc/docker/cert.pem'

tls_key

Path to TLS key file Defaults to '/etc/docker/cert.key'

ip_forward

Enables IP forwarding on the Docker host. The default is true.

iptables

Enable Docker's addition of iptables rules. Default is true.

ip_masq

Enable IP masquerading for bridge's IP range. The default is true.

bip

Specify docker's network bridge IP, in CIDR notation. Defaults to undefined.

mtu

Docker network MTU. Defaults to undefined.

bridge

Attach containers to a pre-existing network bridge use 'none' to disable container networking Defaults to undefined.

fixed_cidr

IPv4 subnet for fixed IPs 10.20.0.0/16 Defaults to undefined

default_gateway

IPv4 address of the container default gateway; this address must be part of the bridge subnet (which is defined by bridge) Defaults to undefined

socket_bind

The unix socket to bind to. Defaults to unix:///var/run/docker.sock.

log_level

Set the logging level Defaults to undef: docker defaults to info if no value specified Valid values: debug, info, warn, error, fatal

log_driver

Set the log driver. Defaults to undef. Docker default is json-file. Valid values: none, json-file, syslog, journald, gelf, fluentd Valid values description:

none     : Disables any logging for the container.
           docker logs won't be available with this driver.
json-file: Default logging driver for Docker.
           Writes JSON messages to file.
syslog   : Syslog logging driver for Docker.
           Writes log messages to syslog.
journald : Journald logging driver for Docker.
           Writes log messages to journald.
gelf     : Graylog Extended Log Format (GELF) logging driver for Docker.
           Writes log messages to a GELF endpoint: Graylog or Logstash.
fluentd  : Fluentd logging driver for Docker.
           Writes log messages to fluentd (forward input).

log_opt

Set the log driver specific options Defaults to undef Valid values per log driver:

none     : undef
json-file:
           max-size=[0-9+][k|m|g]
           max-file=[0-9+]
syslog   :
           syslog-address=[tcp|udp]://host:port
           syslog-address=unix://path
           syslog-facility=daemon|kern|user|mail|auth|
                           syslog|lpr|news|uucp|cron|
                           authpriv|ftp|
                           local0|local1|local2|local3|
                           local4|local5|local6|local7
           syslog-tag="some_tag"
journald : undef
gelf     :
           gelf-address=udp://host:port
           gelf-tag="some_tag"
fluentd  :
           fluentd-address=host:port
           fluentd-tag={{.ID}} - short container id (12 characters)|
                       {{.FullID}} - full container id
                       {{.Name}} - container name

selinux_enabled

Enable selinux support. Default is false. SELinux does not presently support the BTRFS storage driver. Valid values: true, false

use_upstream_package_source

Whether or not to use the upstream package source. If you run your own package mirror, you may set this to false.

package_source_location

If you're using an upstream package source, what is it's location. Defaults to get.docker.com/ubuntu on Debian

service_state

Whether you want to docker daemon to start up Defaults to running

service_enable

Whether you want to docker daemon to start up at boot Defaults to true

manage_service

Specify whether the service should be managed. Valid values are 'true', 'false'. Defaults to 'true'.

root_dir

Custom root directory for containers Defaults to undefined

manage_kernel

Attempt to install the correct Kernel required by docker Defaults to true

dns

Custom dns server address Defaults to undefined

dns_search

Custom dns search domains Defaults to undefined

socket_group

Group ownership of the unix control socket. Defaults to undefined

extra_parameters

Any extra parameters that should be passed to the docker daemon. Defaults to undefined

shell_values

Array of shell values to pass into init script config files

proxy

Will set the http_proxy and https_proxy env variables in /etc/sysconfig/docker (redhat/centos) or /etc/default/docker (debian)

no_proxy

Will set the no_proxy variable in /etc/sysconfig/docker (redhat/centos) or /etc/default/docker (debian)

storage_driver

Specify a storage driver to use Default is undef: let docker choose the correct one Valid values: aufs, devicemapper, btrfs, overlay, vfs, zfs

dm_basesize

The size to use when creating the base device, which limits the size of images and containers. Default value is 10G

dm_fs

The filesystem to use for the base image (xfs or ext4) Defaults to ext4

dm_mkfsarg

Specifies extra mkfs arguments to be used when creating the base device.

dm_mountopt

Specifies extra mount options used when mounting the thin devices.

dm_blocksize

A custom blocksize to use for the thin pool. Default blocksize is 64K. Warning: _DO NOT_ change this parameter after the lvm devices have been initialized.

dm_loopdatasize

Specifies the size to use when creating the loopback file for the “data” device which is used for the thin pool Default size is 100G

dm_loopmetadatasize

Specifies the size to use when creating the loopback file for the “metadata” device which is used for the thin pool Default size is 2G

dm_datadev

(deprecated - dm_thinpooldev should be used going forward) A custom blockdevice to use for data for the thin pool.

dm_metadatadev

(deprecated - dm_thinpooldev should be used going forward) A custom blockdevice to use for metadata for the thin pool.

dm_thinpooldev

Specifies a custom block storage device to use for the thin pool.

dm_use_deferred_removal

Enables use of deferred device removal if libdm and the kernel driver support the mechanism.

dm_use_deferred_deletion

Enables use of deferred device deletion if libdm and the kernel driver support the mechanism.

dm_blkdiscard

Enables or disables the use of blkdiscard when removing devicemapper devices. Defaults to false

dm_override_udev_sync_check

By default, the devicemapper backend attempts to synchronize with the udev device manager for the Linux kernel. This option allows disabling that synchronization, to continue even though the configuration may be buggy. Defaults to true

manage_package

Won't install or define the docker package, useful if you want to use your own package Defaults to true

package_name

Specify custom package name Default is set on a per system basis in docker::params

service_name

Specify custom service name Default is set on a per system basis in docker::params

docker_command

Specify a custom docker command name Default is set on a per system basis in docker::params

daemon_subcommand

Specify a subcommand/flag for running docker as daemon Default is set on a per system basis in docker::params

docker_users

Specify an array of users to add to the docker group Default is empty

repo_opt

Specify a string to pass as repository options (RedHat only)

storage_devs

A quoted, space-separated list of devices to be used.

storage_vg

The volume group to use for docker storage.

storage_root_size

The size to which the root filesystem should be grown.

storage_data_size

The desired size for the docker data LV

storage_min_data_size

The minimum size of data volume otherwise pool creation fails

storage_chunk_size

Controls the chunk size/block size of thin pool.

storage_growpart

Enable resizing partition table backing root volume group.

storage_auto_extend_pool

Enable/disable automatic pool extension using lvm

storage_pool_autoextend_threshold

Auto pool extension threshold (in % of pool size)

storage_pool_autoextend_percent

Extend the pool by specified percentage when threshold is hit.

Parameter Summary

version (Any) => $docker::params::version
ensure (Any) => $docker::params::ensure
prerequired_packages (Any) => $docker::params::prerequired_packages
docker_cs (Any) => $docker::params::docker_cs
tcp_bind (Any) => $docker::params::tcp_bind
tls_enable (Any) => $docker::params::tls_enable
tls_verify (Any) => $docker::params::tls_verify
tls_cacert (Any) => $docker::params::tls_cacert
tls_cert (Any) => $docker::params::tls_cert
tls_key (Any) => $docker::params::tls_key
ip_forward (Any) => $docker::params::ip_forward
ip_masq (Any) => $docker::params::ip_masq
bip (Any) => $docker::params::bip
mtu (Any) => $docker::params::mtu
iptables (Any) => $docker::params::iptables
socket_bind (Any) => $docker::params::socket_bind
fixed_cidr (Any) => $docker::params::fixed_cidr
bridge (Any) => $docker::params::bridge
default_gateway (Any) => $docker::params::default_gateway
log_level (Any) => $docker::params::log_level
log_driver (Any) => $docker::params::log_driver
log_opt (Any) => $docker::params::log_opt
selinux_enabled (Any) => $docker::params::selinux_enabled
use_upstream_package_source (Any) => $docker::params::use_upstream_package_source
package_source_location (Any) => $docker::params::package_source_location
package_release (Any) => $docker::params::package_release
package_repos (Any) => $docker::params::package_repos
package_key (Any) => $docker::params::package_key
package_key_source (Any) => $docker::params::package_key_source
service_state (Any) => $docker::params::service_state
service_enable (Any) => $docker::params::service_enable
manage_service (Any) => $docker::params::manage_service
root_dir (Any) => $docker::params::root_dir
tmp_dir (Any) => $docker::params::tmp_dir
manage_kernel (Any) => $docker::params::manage_kernel
dns (Any) => $docker::params::dns
dns_search (Any) => $docker::params::dns_search
socket_group (Any) => $docker::params::socket_group
labels (Any) => $docker::params::labels
extra_parameters (Any) => undef
shell_values (Any) => undef
proxy (Any) => $docker::params::proxy
no_proxy (Any) => $docker::params::no_proxy
storage_driver (Any) => $docker::params::storage_driver
dm_basesize (Any) => $docker::params::dm_basesize
dm_fs (Any) => $docker::params::dm_fs
dm_mkfsarg (Any) => $docker::params::dm_mkfsarg
dm_mountopt (Any) => $docker::params::dm_mountopt
dm_blocksize (Any) => $docker::params::dm_blocksize
dm_loopdatasize (Any) => $docker::params::dm_loopdatasize
dm_loopmetadatasize (Any) => $docker::params::dm_loopmetadatasize
dm_datadev (Any) => $docker::params::dm_datadev
dm_metadatadev (Any) => $docker::params::dm_metadatadev
dm_thinpooldev (Any) => $docker::params::dm_thinpooldev
dm_use_deferred_removal (Any) => $docker::params::dm_use_deferred_removal
dm_use_deferred_deletion (Any) => $docker::params::dm_use_deferred_deletion
dm_blkdiscard (Any) => $docker::params::dm_blkdiscard
dm_override_udev_sync_check (Any) => $docker::params::dm_override_udev_sync_check
execdriver (Any) => $docker::params::execdriver
manage_package (Any) => $docker::params::manage_package
package_source (Any) => $docker::params::package_source
manage_epel (Any) => $docker::params::manage_epel
package_name (Any) => $docker::params::package_name
service_name (Any) => $docker::params::service_name
docker_command (Any) => $docker::params::docker_command
daemon_subcommand (Any) => $docker::params::daemon_subcommand
docker_users (Any) => []
repo_opt (Any) => $docker::params::repo_opt
nowarn_kernel (Any) => $docker::params::nowarn_kernel
storage_devs (Any) => $docker::params::storage_devs
storage_vg (Any) => $docker::params::storage_vg
storage_root_size (Any) => $docker::params::storage_root_size
storage_data_size (Any) => $docker::params::storage_data_size
storage_min_data_size (Any) => $docker::params::storage_min_data_size
storage_chunk_size (Any) => $docker::params::storage_chunk_size
storage_growpart (Any) => $docker::params::storage_growpart
storage_auto_extend_pool (Any) => $docker::params::storage_auto_extend_pool
storage_pool_autoextend_threshold (Any) => $docker::params::storage_pool_autoextend_threshold
storage_pool_autoextend_percent (Any) => $docker::params::storage_pool_autoextend_percent
storage_config (Any) => $docker::params::storage_config
storage_config_template (Any) => $docker::params::storage_config_template
service_provider (Any) => $docker::params::service_provider
service_config (Any) => $docker::params::service_config
service_config_template (Any) => $docker::params::service_config_template
service_overrides_template (Any) => $docker::params::service_overrides_template
service_hasstatus (Any) => $docker::params::service_hasstatus
service_hasrestart (Any) => $docker::params::service_hasrestart