Page Menu
Home
Software Heritage
Search
Configure Global Search
Log In
Files
F8391888
REFERENCE.md
No One
Temporary
Actions
View File
Edit File
Delete File
View Transforms
Subscribe
Mute Notifications
Award Token
Flag For Later
Size
96 KB
Subscribers
None
REFERENCE.md
View Options
#
Reference
<!--
DO
NOT
EDIT
:
This
document
was
generated
by
Puppet
Strings
-->
##
Table
of
Contents
###
Classes
*
[
`
docker
`
](#
docker
):
Module
to
install
an
up
-
to
-
date
version
of
Docker
from
package
.
*
[
`
docker
::
compose
`
](#
dockercompose
):
install
Docker
Compose
using
the
recommended
curl
command
.
*
[
`
docker
::
config
`
](#
dockerconfig
)
*
[
`
docker
::
images
`
](#
dockerimages
)
*
[
`
docker
::
install
`
](#
dockerinstall
):
Module
to
install
an
up
-
to
-
date
version
of
Docker
from
a
package
repository
.
Only
for
Debian
,
Red
Hat
and
Windows
*
[
`
docker
::
machine
`
](#
dockermachine
):
install
Docker
Machine
using
the
recommended
curl
command
.
*
[
`
docker
::
networks
`
](#
dockernetworks
)
*
[
`
docker
::
params
`
](#
dockerparams
):
Default
parameter
values
for
the
docker
module
*
[
`
docker
::
plugins
`
](#
dockerplugins
)
*
[
`
docker
::
registry_auth
`
](#
dockerregistry_auth
)
*
[
`
docker
::
repos
`
](#
dockerrepos
)
*
[
`
docker
::
run_instance
`
](#
dockerrun_instance
)
*
[
`
docker
::
service
`
](#
dockerservice
):
manage
the
docker
service
daemon
*
[
`
docker
::
swarms
`
](#
dockerswarms
)
*
[
`
docker
::
systemd_reload
`
](#
dockersystemd_reload
):
For
systems
that
have
systemd
*
[
`
docker
::
volumes
`
](#
dockervolumes
)
###
Defined
types
*
[
`
docker
::
exec
`
](#
dockerexec
):
A
define
which
executes
a
command
inside
a
container
.
*
[
`
docker
::
image
`
](#
dockerimage
):
Module
to
install
an
up
-
to
-
date
version
of
a
Docker
image
from
the
registry
*
[
`
docker
::
plugin
`
](#
dockerplugin
):
A
define
that
manages
a
docker
plugin
*
[
`
docker
::
registry
`
](#
dockerregistry
):
Module
to
configure
private
docker
registries
from
which
to
pull
Docker
images
*
[
`
docker
::
run
`
](#
dockerrun
):
A
define
which
manages
a
running
docker
container
.
*
[
`
docker
::
secrets
`
](#
dockersecrets
)
*
[
`
docker
::
services
`
](#
dockerservices
):
define
that
managers
a
Docker
services
*
[
`
docker
::
stack
`
](#
dockerstack
):
deploys
Docker
stacks
or
compose
v3
*
[
`
docker
::
swarm
`
](#
dockerswarm
):
managers
a
Docker
Swarm
Mode
cluster
*
[
`
docker
::
system_user
`
](#
dockersystem_user
):
manage
docker
group
users
*
[
`
docker
::
windows_account
`
](#
dockerwindows_account
):
Windows
account
that
owns
the
docker
services
###
Resource
types
*
[
`
docker_compose
`
](#
docker_compose
):
A
type
representing
a
Docker
Compose
file
*
[
`
docker_network
`
](#
docker_network
):
Type
representing
a
Docker
network
*
[
`
docker_stack
`
](#
docker_stack
):
A
type
representing
a
Docker
Stack
*
[
`
docker_volume
`
](#
docker_volume
):
A
type
representing
a
Docker
volume
###
Functions
*
[
`
docker
::
sanitised_name
`
](#
dockersanitised_name
):
==
Function
:
docker
::
sanitised_name
Function
to
sanitise
container
name
.
===
Parameters
[*
name
*]
Name
to
sanitise
*
[
`
docker_exec_flags
`
](#
docker_exec_flags
):
Transforms
a
hash
into
a
string
of
docker
exec
flags
*
[
`
docker_params_changed
`
](#
docker_params_changed
)
*
[
`
docker_plugin_enable_flags
`
](#
docker_plugin_enable_flags
):
Transforms
a
hash
into
a
string
of
docker
plugin
remove
flags
*
[
`
docker_plugin_install_flags
`
](#
docker_plugin_install_flags
):
Transforms
a
hash
into
a
string
of
docker
plugin
install
flags
*
[
`
docker_plugin_remove_flags
`
](#
docker_plugin_remove_flags
):
Transforms
a
hash
into
a
string
of
docker
plugin
remove
flags
*
[
`
docker_run_flags
`
](#
docker_run_flags
):
Transforms
a
hash
into
a
string
of
docker
flags
*
[
`
docker_secrets_flags
`
](#
docker_secrets_flags
):
Transforms
a
hash
into
a
string
of
docker
swarm
init
flags
*
[
`
docker_service_flags
`
](#
docker_service_flags
):
Transforms
a
hash
into
a
string
of
docker
swarm
init
flags
*
[
`
docker_stack_flags
`
](#
docker_stack_flags
):
Transforms
a
hash
into
a
string
of
docker
stack
flags
*
[
`
docker_swarm_init_flags
`
](#
docker_swarm_init_flags
):
Transforms
a
hash
into
a
string
of
docker
swarm
init
flags
*
[
`
docker_swarm_join_flags
`
](#
docker_swarm_join_flags
):
Transforms
a
hash
into
a
string
of
docker
swarm
init
flags
###
Tasks
*
[
`
node_ls
`
](#
node_ls
):
List
nodes
in
the
swarm
*
[
`
node_rm
`
](#
node_rm
):
Update
a
node
*
[
`
node_update
`
](#
node_update
):
Update
a
node
*
[
`
service_create
`
](#
service_create
):
Create
a
new
Docker
service
*
[
`
service_rm
`
](#
service_rm
):
Remove
one
replicated
service
*
[
`
service_scale
`
](#
service_scale
):
Scale
one
replicated
service
*
[
`
service_update
`
](#
service_update
):
Updates
an
existing
service
.
*
[
`
swarm_init
`
](#
swarm_init
):
Initializes
a
swarm
*
[
`
swarm_join
`
](#
swarm_join
):
Join
a
swarm
*
[
`
swarm_leave
`
](#
swarm_leave
):
Leave
a
swarm
*
[
`
swarm_token
`
](#
swarm_token
):
Gets
the
swarm
token
from
the
server
*
[
`
swarm_update
`
](#
swarm_update
):
Updates
an
existing
service
.
##
Classes
###
<
a
name
=
"docker"
></
a
>
`
docker
`
Module
to
install
an
up
-
to
-
date
version
of
Docker
from
package
.
####
Parameters
The
following
parameters
are
available
in
the
`
docker
`
class
:
*
[
`
version
`
](#
version
)
*
[
`
ensure
`
](#
ensure
)
*
[
`
prerequired_packages
`
](#
prerequired_packages
)
*
[
`
dependent_packages
`
](#
dependent_packages
)
*
[
`
tcp_bind
`
](#
tcp_bind
)
*
[
`
tls_enable
`
](#
tls_enable
)
*
[
`
tls_verify
`
](#
tls_verify
)
*
[
`
tls_cacert
`
](#
tls_cacert
)
*
[
`
tls_cert
`
](#
tls_cert
)
*
[
`
tls_key
`
](#
tls_key
)
*
[
`
ip_forward
`
](#
ip_forward
)
*
[
`
iptables
`
](#
iptables
)
*
[
`
ip_masq
`
](#
ip_masq
)
*
[
`
icc
`
](#
icc
)
*
[
`
bip
`
](#
bip
)
*
[
`
mtu
`
](#
mtu
)
*
[
`
bridge
`
](#
bridge
)
*
[
`
fixed_cidr
`
](#
fixed_cidr
)
*
[
`
default_gateway
`
](#
default_gateway
)
*
[
`
ipv6
`
](#
ipv6
)
*
[
`
ipv6_cidr
`
](#
ipv6_cidr
)
*
[
`
default_gateway_ipv6
`
](#
default_gateway_ipv6
)
*
[
`
socket_bind
`
](#
socket_bind
)
*
[
`
log_level
`
](#
log_level
)
*
[
`
log_driver
`
](#
log_driver
)
*
[
`
log_opt
`
](#
log_opt
)
*
[
`
selinux_enabled
`
](#
selinux_enabled
)
*
[
`
use_upstream_package_source
`
](#
use_upstream_package_source
)
*
[
`
pin_upstream_package_source
`
](#
pin_upstream_package_source
)
*
[
`
apt_source_pin_level
`
](#
apt_source_pin_level
)
*
[
`
service_state
`
](#
service_state
)
*
[
`
service_enable
`
](#
service_enable
)
*
[
`
manage_service
`
](#
manage_service
)
*
[
`
root_dir
`
](#
root_dir
)
*
[
`
dns
`
](#
dns
)
*
[
`
dns_search
`
](#
dns_search
)
*
[
`
socket_group
`
](#
socket_group
)
*
[
`
extra_parameters
`
](#
extra_parameters
)
*
[
`
shell_values
`
](#
shell_values
)
*
[
`
proxy
`
](#
proxy
)
*
[
`
no_proxy
`
](#
no_proxy
)
*
[
`
storage_driver
`
](#
storage_driver
)
*
[
`
dm_basesize
`
](#
dm_basesize
)
*
[
`
dm_fs
`
](#
dm_fs
)
*
[
`
dm_mkfsarg
`
](#
dm_mkfsarg
)
*
[
`
dm_mountopt
`
](#
dm_mountopt
)
*
[
`
dm_blocksize
`
](#
dm_blocksize
)
*
[
`
dm_loopdatasize
`
](#
dm_loopdatasize
)
*
[
`
dm_loopmetadatasize
`
](#
dm_loopmetadatasize
)
*
[
`
dm_datadev
`
](#
dm_datadev
)
*
[
`
dm_metadatadev
`
](#
dm_metadatadev
)
*
[
`
dm_thinpooldev
`
](#
dm_thinpooldev
)
*
[
`
dm_use_deferred_removal
`
](#
dm_use_deferred_removal
)
*
[
`
dm_use_deferred_deletion
`
](#
dm_use_deferred_deletion
)
*
[
`
dm_blkdiscard
`
](#
dm_blkdiscard
)
*
[
`
dm_override_udev_sync_check
`
](#
dm_override_udev_sync_check
)
*
[
`
overlay2_override_kernel_check
`
](#
overlay2_override_kernel_check
)
*
[
`
manage_package
`
](#
manage_package
)
*
[
`
service_name
`
](#
service_name
)
*
[
`
docker_users
`
](#
docker_users
)
*
[
`
docker_group
`
](#
docker_group
)
*
[
`
daemon_environment_files
`
](#
daemon_environment_files
)
*
[
`
repo_opt
`
](#
repo_opt
)
*
[
`
storage_devs
`
](#
storage_devs
)
*
[
`
storage_vg
`
](#
storage_vg
)
*
[
`
storage_root_size
`
](#
storage_root_size
)
*
[
`
storage_data_size
`
](#
storage_data_size
)
*
[
`
storage_min_data_size
`
](#
storage_min_data_size
)
*
[
`
storage_chunk_size
`
](#
storage_chunk_size
)
*
[
`
storage_growpart
`
](#
storage_growpart
)
*
[
`
storage_auto_extend_pool
`
](#
storage_auto_extend_pool
)
*
[
`
storage_pool_autoextend_threshold
`
](#
storage_pool_autoextend_threshold
)
*
[
`
storage_pool_autoextend_percent
`
](#
storage_pool_autoextend_percent
)
*
[
`
tmp_dir_config
`
](#
tmp_dir_config
)
*
[
`
tmp_dir
`
](#
tmp_dir
)
*
[
`
registry_mirror
`
](#
registry_mirror
)
*
[
`
nuget_package_provider_version
`
](#
nuget_package_provider_version
)
*
[
`
docker_msft_provider_version
`
](#
docker_msft_provider_version
)
*
[
`
docker_ce_start_command
`
](#
docker_ce_start_command
)
*
[
`
docker_ce_package_name
`
](#
docker_ce_package_name
)
*
[
`
docker_ce_source_location
`
](#
docker_ce_source_location
)
*
[
`
docker_ce_key_source
`
](#
docker_ce_key_source
)
*
[
`
docker_ce_key_id
`
](#
docker_ce_key_id
)
*
[
`
docker_ce_release
`
](#
docker_ce_release
)
*
[
`
docker_package_location
`
](#
docker_package_location
)
*
[
`
docker_package_key_source
`
](#
docker_package_key_source
)
*
[
`
docker_package_key_check_source
`
](#
docker_package_key_check_source
)
*
[
`
docker_package_key_id
`
](#
docker_package_key_id
)
*
[
`
docker_package_release
`
](#
docker_package_release
)
*
[
`
docker_engine_start_command
`
](#
docker_engine_start_command
)
*
[
`
docker_engine_package_name
`
](#
docker_engine_package_name
)
*
[
`
docker_ce_channel
`
](#
docker_ce_channel
)
*
[
`
docker_ee
`
](#
docker_ee
)
*
[
`
docker_ee_package_name
`
](#
docker_ee_package_name
)
*
[
`
docker_ee_source_location
`
](#
docker_ee_source_location
)
*
[
`
docker_ee_key_source
`
](#
docker_ee_key_source
)
*
[
`
docker_ee_key_id
`
](#
docker_ee_key_id
)
*
[
`
docker_ee_repos
`
](#
docker_ee_repos
)
*
[
`
docker_ee_release
`
](#
docker_ee_release
)
*
[
`
package_release
`
](#
package_release
)
*
[
`
labels
`
](#
labels
)
*
[
`
execdriver
`
](#
execdriver
)
*
[
`
package_source
`
](#
package_source
)
*
[
`
os_lc
`
](#
os_lc
)
*
[
`
storage_config
`
](#
storage_config
)
*
[
`
storage_config_template
`
](#
storage_config_template
)
*
[
`
storage_setup_file
`
](#
storage_setup_file
)
*
[
`
service_provider
`
](#
service_provider
)
*
[
`
service_config
`
](#
service_config
)
*
[
`
service_config_template
`
](#
service_config_template
)
*
[
`
service_overrides_template
`
](#
service_overrides_template
)
*
[
`
socket_overrides_template
`
](#
socket_overrides_template
)
*
[
`
socket_override
`
](#
socket_override
)
*
[
`
service_after_override
`
](#
service_after_override
)
*
[
`
service_hasstatus
`
](#
service_hasstatus
)
*
[
`
service_hasrestart
`
](#
service_hasrestart
)
*
[
`
acknowledge_unsupported_os
`
](#
acknowledge_unsupported_os
)
*
[
`
have_systemd_v230
`
](#
have_systemd_v230
)
#####
<
a
name
=
"version"
></
a
>
`
version
`
Data
type
:
`
Optional
[
String
]
`
The
package
version
to
install
,
used
to
set
the
package
name
.
Default
value
:
`
$
docker
::
params
::
version
`
#####
<
a
name
=
"ensure"
></
a
>
`
ensure
`
Data
type
:
`
String
`
Passed
to
the
docker
package
.
Default
value
:
`
$
docker
::
params
::
ensure
`
#####
<
a
name
=
"prerequired_packages"
></
a
>
`
prerequired_packages
`
Data
type
:
`
Variant
[
Array
[
String
],
Hash
]
`
An
array
of
additional
packages
that
need
to
be
installed
to
support
docker
.
Default
value
:
`
$
docker
::
params
::
prerequired_packages
`
#####
<
a
name
=
"dependent_packages"
></
a
>
`
dependent_packages
`
Data
type
:
`
Array
`
An
array
of
packages
installed
by
the
docker
-
ce
package
v
18.09
and
later
.
Used
when
uninstalling
to
ensure
containers
cannot
be
run
on
the
system
.
Default
value
:
`
$
docker
::
params
::
dependent_packages
`
#####
<
a
name
=
"tcp_bind"
></
a
>
`
tcp_bind
`
Data
type
:
`
Optional
[
Variant
[
String
,
Array
[
String
]]]
`
The
tcp
socket
to
bind
to
in
the
format
tcp
:
//127.0.0.1:4243
Default
value
:
`
$
docker
::
params
::
tcp_bind
`
#####
<
a
name
=
"tls_enable"
></
a
>
`
tls_enable
`
Data
type
:
`
Boolean
`
Enable
TLS
.
Default
value
:
`
$
docker
::
params
::
tls_enable
`
#####
<
a
name
=
"tls_verify"
></
a
>
`
tls_verify
`
Data
type
:
`
Boolean
`
Use
TLS
and
verify
the
remote
Default
value
:
`
$
docker
::
params
::
tls_verify
`
#####
<
a
name
=
"tls_cacert"
></
a
>
`
tls_cacert
`
Data
type
:
`
Optional
[
String
]
`
Path
to
TLS
CA
certificate
Default
value
:
`
$
docker
::
params
::
tls_cacert
`
#####
<
a
name
=
"tls_cert"
></
a
>
`
tls_cert
`
Data
type
:
`
Optional
[
String
]
`
Path
to
TLS
certificate
file
Default
value
:
`
$
docker
::
params
::
tls_cert
`
#####
<
a
name
=
"tls_key"
></
a
>
`
tls_key
`
Data
type
:
`
Optional
[
String
]
`
Path
to
TLS
key
file
Default
value
:
`
$
docker
::
params
::
tls_key
`
#####
<
a
name
=
"ip_forward"
></
a
>
`
ip_forward
`
Data
type
:
`
Boolean
`
Enables
IP
forwarding
on
the
Docker
host
.
Default
value
:
`
$
docker
::
params
::
ip_forward
`
#####
<
a
name
=
"iptables"
></
a
>
`
iptables
`
Data
type
:
`
Boolean
`
Enable
Docker
'
s
addition
of
iptables
rules
.
Default
value
:
`
$
docker
::
params
::
iptables
`
#####
<
a
name
=
"ip_masq"
></
a
>
`
ip_masq
`
Data
type
:
`
Boolean
`
Enable
IP
masquerading
for
bridge
'
s
IP
range
.
Default
value
:
`
$
docker
::
params
::
ip_masq
`
#####
<
a
name
=
"icc"
></
a
>
`
icc
`
Data
type
:
`
Optional
[
Boolean
]
`
Enable
or
disable
Docker
'
s
unrestricted
inter
-
container
and
Docker
daemon
host
communication
.
(
Requires
iptables
=
true
to
disable
)
Default
value
:
`
$
docker
::
params
::
icc
`
#####
<
a
name
=
"bip"
></
a
>
`
bip
`
Data
type
:
`
Optional
[
String
]
`
Specify
docker
'
s
network
bridge
IP
,
in
CIDR
notation
.
Default
value
:
`
$
docker
::
params
::
bip
`
#####
<
a
name
=
"mtu"
></
a
>
`
mtu
`
Data
type
:
`
Optional
[
String
]
`
Docker
network
MTU
.
Default
value
:
`
$
docker
::
params
::
mtu
`
#####
<
a
name
=
"bridge"
></
a
>
`
bridge
`
Data
type
:
`
Optional
[
String
]
`
Attach
containers
to
a
pre
-
existing
network
bridge
use
'
none
'
to
disable
container
networking
Default
value
:
`
$
docker
::
params
::
bridge
`
#####
<
a
name
=
"fixed_cidr"
></
a
>
`
fixed_cidr
`
Data
type
:
`
Optional
[
String
]
`
IPv4
subnet
for
fixed
IPs
10.20
.
0.0
/
16
Default
value
:
`
$
docker
::
params
::
fixed_cidr
`
#####
<
a
name
=
"default_gateway"
></
a
>
`
default_gateway
`
Data
type
:
`
Optional
[
String
]
`
IPv4
address
of
the
container
default
gateway
;
this
address
must
be
part
of
the
bridge
subnet
(
which
is
defined
by
bridge
)
Default
value
:
`
$
docker
::
params
::
default_gateway
`
#####
<
a
name
=
"ipv6"
></
a
>
`
ipv6
`
Data
type
:
`
Optional
[
Boolean
]
`
Enables
ipv6
support
for
the
docker
daemon
Default
value
:
`
$
docker
::
params
::
ipv6
`
#####
<
a
name
=
"ipv6_cidr"
></
a
>
`
ipv6_cidr
`
Data
type
:
`
Optional
[
String
]
`
IPv6
subnet
for
fixed
IPs
Default
value
:
`
$
docker
::
params
::
ipv6_cidr
`
#####
<
a
name
=
"default_gateway_ipv6"
></
a
>
`
default_gateway_ipv6
`
Data
type
:
`
Optional
[
String
]
`
IPv6
address
of
the
container
default
gateway
:
Default
value
:
`
$
docker
::
params
::
default_gateway_ipv6
`
#####
<
a
name
=
"socket_bind"
></
a
>
`
socket_bind
`
Data
type
:
`
String
`
The
unix
socket
to
bind
to
.
Default
value
:
`
$
docker
::
params
::
socket_bind
`
#####
<
a
name
=
"log_level"
></
a
>
`
log_level
`
Data
type
:
`
Optional
[
String
]
`
Set
the
logging
level
Valid
values
:
debug
,
info
,
warn
,
error
,
fatal
Default
value
:
`
$
docker
::
params
::
log_level
`
#####
<
a
name
=
"log_driver"
></
a
>
`
log_driver
`
Data
type
:
`
Optional
[
String
]
`
Set
the
log
driver
.
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
).
splunk
:
Splunk
logging
driver
for
Docker
.
Writes
log
messages
to
Splunk
(
HTTP
Event
Collector
).
awslogs
:
AWS
Cloudwatch
Logs
logging
driver
for
Docker
.
Write
log
messages
to
Cloudwatch
API
Default
value
:
`
$
docker
::
params
::
log_driver
`
#####
<
a
name
=
"log_opt"
></
a
>
`
log_opt
`
Data
type
:
`
Array
`
Set
the
log
driver
specific
options
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
splunk
:
splunk
-
token
=<
splunk_http_event_collector_token
>
splunk
-
url
=
https
:
//your_splunk_instance:8088
awslogs
:
awslogs
-
group
=<
Cloudwatch
Log
Group
>
awslogs
-
stream
=<
Cloudwatch
Log
Stream
>
awslogs
-
create
-
group
=
true
|
false
awslogs
-
datetime
-
format
=<
Date
format
>
-
strftime
expression
awslogs
-
multiline
-
pattern
=
multiline
start
pattern
using
a
regular
expression
tag
={{.
ID
}}
-
short
container
id
(
12
characters
)|
{{.
FullID
}}
-
full
container
id
{{.
Name
}}
-
container
name
Default
value
:
`
$
docker
::
params
::
log_opt
`
#####
<
a
name
=
"selinux_enabled"
></
a
>
`
selinux_enabled
`
Data
type
:
`
Optional
[
Boolean
]
`
Enable
selinux
support
.
Default
is
false
.
SELinux
does
not
presently
support
the
BTRFS
storage
driver
.
Default
value
:
`
$
docker
::
params
::
selinux_enabled
`
#####
<
a
name
=
"use_upstream_package_source"
></
a
>
`
use_upstream_package_source
`
Data
type
:
`
Optional
[
Boolean
]
`
Whether
or
not
to
use
the
upstream
package
source
.
If
you
run
your
own
package
mirror
,
you
may
set
this
to
false
.
Default
value
:
`
$
docker
::
params
::
use_upstream_package_source
`
#####
<
a
name
=
"pin_upstream_package_source"
></
a
>
`
pin_upstream_package_source
`
Data
type
:
`
Optional
[
Boolean
]
`
Pin
upstream
package
source
;
this
option
currently
only
has
any
effect
on
apt
-
based
distributions
.
Set
to
false
to
remove
pinning
on
the
upstream
package
repository
.
See
also
"apt_source_pin_level"
.
Default
value
:
`
$
docker
::
params
::
pin_upstream_package_source
`
#####
<
a
name
=
"apt_source_pin_level"
></
a
>
`
apt_source_pin_level
`
Data
type
:
`
Optional
[
Integer
]
`
What
level
to
pin
our
source
package
repository
to
;
this
only
is
relevent
if
you
'
re
on
an
apt
-
based
system
(
Debian
,
Ubuntu
,
etc
)
and
$
use_upstream_package_source
is
set
to
true
.
Set
this
to
false
to
disable
pinning
,
and
undef
to
ensure
the
apt
preferences
file
apt
::
source
uses
to
define
pins
is
removed
.
Default
value
:
`
$
docker
::
params
::
apt_source_pin_level
`
#####
<
a
name
=
"service_state"
></
a
>
`
service_state
`
Data
type
:
`
String
`
Whether
you
want
to
docker
daemon
to
start
up
Default
value
:
`
$
docker
::
params
::
service_state
`
#####
<
a
name
=
"service_enable"
></
a
>
`
service_enable
`
Data
type
:
`
Boolean
`
Whether
you
want
to
docker
daemon
to
start
up
at
boot
Default
value
:
`
$
docker
::
params
::
service_enable
`
#####
<
a
name
=
"manage_service"
></
a
>
`
manage_service
`
Data
type
:
`
Boolean
`
Specify
whether
the
service
should
be
managed
.
Default
value
:
`
$
docker
::
params
::
manage_service
`
#####
<
a
name
=
"root_dir"
></
a
>
`
root_dir
`
Data
type
:
`
Optional
[
String
]
`
Custom
root
directory
for
containers
Default
value
:
`
$
docker
::
params
::
root_dir
`
#####
<
a
name
=
"dns"
></
a
>
`
dns
`
Data
type
:
`
Optional
[
Variant
[
String
,
Array
]]
`
Custom
dns
server
address
Default
value
:
`
$
docker
::
params
::
dns
`
#####
<
a
name
=
"dns_search"
></
a
>
`
dns_search
`
Data
type
:
`
Optional
[
Variant
[
String
,
Array
]]
`
Custom
dns
search
domains
Default
value
:
`
$
docker
::
params
::
dns_search
`
#####
<
a
name
=
"socket_group"
></
a
>
`
socket_group
`
Data
type
:
`
Optional
[
Variant
[
String
,
Boolean
]]
`
Group
ownership
of
the
unix
control
socket
.
Default
value
:
`
$
docker
::
params
::
socket_group
`
#####
<
a
name
=
"extra_parameters"
></
a
>
`
extra_parameters
`
Data
type
:
`
Optional
[
Variant
[
String
,
Array
]]
`
Any
extra
parameters
that
should
be
passed
to
the
docker
daemon
.
Default
value
:
``
undef
``
#####
<
a
name
=
"shell_values"
></
a
>
`
shell_values
`
Data
type
:
`
Optional
[
Variant
[
String
,
Array
]]
`
Array
of
shell
values
to
pass
into
init
script
config
files
Default
value
:
``
undef
``
#####
<
a
name
=
"proxy"
></
a
>
`
proxy
`
Data
type
:
`
Optional
[
String
]
`
Will
set
the
http_proxy
and
https_proxy
env
variables
in
/
etc
/
sysconfig
/
docker
(
redhat
/
centos
)
or
/
etc
/
default
/
docker
(
debian
)
Default
value
:
`
$
docker
::
params
::
proxy
`
#####
<
a
name
=
"no_proxy"
></
a
>
`
no_proxy
`
Data
type
:
`
Optional
[
String
]
`
Will
set
the
no_proxy
variable
in
/
etc
/
sysconfig
/
docker
(
redhat
/
centos
)
or
/
etc
/
default
/
docker
(
debian
)
Default
value
:
`
$
docker
::
params
::
no_proxy
`
#####
<
a
name
=
"storage_driver"
></
a
>
`
storage_driver
`
Data
type
:
`
Optional
[
String
]
`
Specify
a
storage
driver
to
use
Valid
values
:
aufs
,
devicemapper
,
btrfs
,
overlay
,
overlay2
,
vfs
,
zfs
Default
value
:
`
$
docker
::
params
::
storage_driver
`
#####
<
a
name
=
"dm_basesize"
></
a
>
`
dm_basesize
`
Data
type
:
`
Optional
[
String
]
`
The
size
to
use
when
creating
the
base
device
,
which
limits
the
size
of
images
and
containers
.
Default
value
:
`
$
docker
::
params
::
dm_basesize
`
#####
<
a
name
=
"dm_fs"
></
a
>
`
dm_fs
`
Data
type
:
`
Optional
[
String
]
`
The
filesystem
to
use
for
the
base
image
(
xfs
or
ext4
)
Default
value
:
`
$
docker
::
params
::
dm_fs
`
#####
<
a
name
=
"dm_mkfsarg"
></
a
>
`
dm_mkfsarg
`
Data
type
:
`
Optional
[
String
]
`
Specifies
extra
mkfs
arguments
to
be
used
when
creating
the
base
device
.
Default
value
:
`
$
docker
::
params
::
dm_mkfsarg
`
#####
<
a
name
=
"dm_mountopt"
></
a
>
`
dm_mountopt
`
Data
type
:
`
Optional
[
String
]
`
Specifies
extra
mount
options
used
when
mounting
the
thin
devices
.
Default
value
:
`
$
docker
::
params
::
dm_mountopt
`
#####
<
a
name
=
"dm_blocksize"
></
a
>
`
dm_blocksize
`
Data
type
:
`
Optional
[
String
]
`
A
custom
blocksize
to
use
for
the
thin
pool
.
Default
blocksize
is
64
K
.
Warning
:
_DO
NOT_
change
this
parameter
after
the
lvm
devices
have
been
initialized
.
Default
value
:
`
$
docker
::
params
::
dm_blocksize
`
#####
<
a
name
=
"dm_loopdatasize"
></
a
>
`
dm_loopdatasize
`
Data
type
:
`
Optional
[
String
]
`
Specifies
the
size
to
use
when
creating
the
loopback
file
for
the
"data"
device
which
is
used
for
the
thin
pool
Default
value
:
`
$
docker
::
params
::
dm_loopdatasize
`
#####
<
a
name
=
"dm_loopmetadatasize"
></
a
>
`
dm_loopmetadatasize
`
Data
type
:
`
Optional
[
String
]
`
Specifies
the
size
to
use
when
creating
the
loopback
file
for
the
"metadata"
device
which
is
used
for
the
thin
pool
Default
value
:
`
$
docker
::
params
::
dm_loopmetadatasize
`
#####
<
a
name
=
"dm_datadev"
></
a
>
`
dm_datadev
`
Data
type
:
`
Optional
[
String
]
`
(
deprecated
-
dm_thinpooldev
should
be
used
going
forward
)
A
custom
blockdevice
to
use
for
data
for
the
thin
pool
.
Default
value
:
`
$
docker
::
params
::
dm_datadev
`
#####
<
a
name
=
"dm_metadatadev"
></
a
>
`
dm_metadatadev
`
Data
type
:
`
Optional
[
String
]
`
(
deprecated
-
dm_thinpooldev
should
be
used
going
forward
)
A
custom
blockdevice
to
use
for
metadata
for
the
thin
pool
.
Default
value
:
`
$
docker
::
params
::
dm_metadatadev
`
#####
<
a
name
=
"dm_thinpooldev"
></
a
>
`
dm_thinpooldev
`
Data
type
:
`
Optional
[
String
]
`
Specifies
a
custom
block
storage
device
to
use
for
the
thin
pool
.
Default
value
:
`
$
docker
::
params
::
dm_thinpooldev
`
#####
<
a
name
=
"dm_use_deferred_removal"
></
a
>
`
dm_use_deferred_removal
`
Data
type
:
`
Optional
[
Boolean
]
`
Enables
use
of
deferred
device
removal
if
libdm
and
the
kernel
driver
support
the
mechanism
.
Default
value
:
`
$
docker
::
params
::
dm_use_deferred_removal
`
#####
<
a
name
=
"dm_use_deferred_deletion"
></
a
>
`
dm_use_deferred_deletion
`
Data
type
:
`
Optional
[
Boolean
]
`
Enables
use
of
deferred
device
deletion
if
libdm
and
the
kernel
driver
support
the
mechanism
.
Default
value
:
`
$
docker
::
params
::
dm_use_deferred_deletion
`
#####
<
a
name
=
"dm_blkdiscard"
></
a
>
`
dm_blkdiscard
`
Data
type
:
`
Optional
[
Boolean
]
`
Enables
or
disables
the
use
of
blkdiscard
when
removing
devicemapper
devices
.
Default
value
:
`
$
docker
::
params
::
dm_blkdiscard
`
#####
<
a
name
=
"dm_override_udev_sync_check"
></
a
>
`
dm_override_udev_sync_check
`
Data
type
:
`
Optional
[
Boolean
]
`
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
.
Default
value
:
`
$
docker
::
params
::
dm_override_udev_sync_check
`
#####
<
a
name
=
"overlay2_override_kernel_check"
></
a
>
`
overlay2_override_kernel_check
`
Data
type
:
`
Boolean
`
Overrides
the
Linux
kernel
version
check
allowing
using
overlay2
with
kernel
<
4.0
.
Default
value
:
`
$
docker
::
params
::
overlay2_override_kernel_check
`
#####
<
a
name
=
"manage_package"
></
a
>
`
manage_package
`
Data
type
:
`
Boolean
`
Won
'
t
install
or
define
the
docker
package
,
useful
if
you
want
to
use
your
own
package
Default
value
:
`
$
docker
::
params
::
manage_package
`
#####
<
a
name
=
"service_name"
></
a
>
`
service_name
`
Data
type
:
`
Optional
[
String
]
`
Specify
custom
service
name
Default
value
:
`
$
docker
::
params
::
service_name
`
#####
<
a
name
=
"docker_users"
></
a
>
`
docker_users
`
Data
type
:
`
Array
`
Specify
an
array
of
users
to
add
to
the
docker
group
Default
value
:
`
[]
`
#####
<
a
name
=
"docker_group"
></
a
>
`
docker_group
`
Data
type
:
`
String
`
Specify
a
string
for
the
docker
group
Default
value
:
`
$
docker
::
params
::
docker_group
`
#####
<
a
name
=
"daemon_environment_files"
></
a
>
`
daemon_environment_files
`
Data
type
:
`
Array
`
Specify
additional
environment
files
to
add
to
the
service
-
overrides
.
conf
Default
value
:
`
[]
`
#####
<
a
name
=
"repo_opt"
></
a
>
`
repo_opt
`
Data
type
:
`
Optional
[
Variant
[
String
,
Hash
]]
`
Specify
a
string
to
pass
as
repository
options
(
RedHat
only
)
Default
value
:
`
$
docker
::
params
::
repo_opt
`
#####
<
a
name
=
"storage_devs"
></
a
>
`
storage_devs
`
Data
type
:
`
Optional
[
String
]
`
A
quoted
,
space
-
separated
list
of
devices
to
be
used
.
Default
value
:
`
$
docker
::
params
::
storage_devs
`
#####
<
a
name
=
"storage_vg"
></
a
>
`
storage_vg
`
Data
type
:
`
Optional
[
String
]
`
The
volume
group
to
use
for
docker
storage
.
Default
value
:
`
$
docker
::
params
::
storage_vg
`
#####
<
a
name
=
"storage_root_size"
></
a
>
`
storage_root_size
`
Data
type
:
`
Optional
[
String
]
`
The
size
to
which
the
root
filesystem
should
be
grown
.
Default
value
:
`
$
docker
::
params
::
storage_root_size
`
#####
<
a
name
=
"storage_data_size"
></
a
>
`
storage_data_size
`
Data
type
:
`
Optional
[
String
]
`
The
desired
size
for
the
docker
data
LV
Default
value
:
`
$
docker
::
params
::
storage_data_size
`
#####
<
a
name
=
"storage_min_data_size"
></
a
>
`
storage_min_data_size
`
Data
type
:
`
Optional
[
String
]
`
The
minimum
size
of
data
volume
otherwise
pool
creation
fails
Default
value
:
`
$
docker
::
params
::
storage_min_data_size
`
#####
<
a
name
=
"storage_chunk_size"
></
a
>
`
storage_chunk_size
`
Data
type
:
`
Optional
[
String
]
`
Controls
the
chunk
size
/
block
size
of
thin
pool
.
Default
value
:
`
$
docker
::
params
::
storage_chunk_size
`
#####
<
a
name
=
"storage_growpart"
></
a
>
`
storage_growpart
`
Data
type
:
`
Optional
[
Boolean
]
`
Enable
resizing
partition
table
backing
root
volume
group
.
Default
value
:
`
$
docker
::
params
::
storage_growpart
`
#####
<
a
name
=
"storage_auto_extend_pool"
></
a
>
`
storage_auto_extend_pool
`
Data
type
:
`
Optional
[
String
]
`
Enable
/
disable
automatic
pool
extension
using
lvm
Default
value
:
`
$
docker
::
params
::
storage_auto_extend_pool
`
#####
<
a
name
=
"storage_pool_autoextend_threshold"
></
a
>
`
storage_pool_autoextend_threshold
`
Data
type
:
`
Optional
[
String
]
`
Auto
pool
extension
threshold
(
in
%
of
pool
size
)
Default
value
:
`
$
docker
::
params
::
storage_pool_autoextend_threshold
`
#####
<
a
name
=
"storage_pool_autoextend_percent"
></
a
>
`
storage_pool_autoextend_percent
`
Data
type
:
`
Optional
[
String
]
`
Extend
the
pool
by
specified
percentage
when
threshold
is
hit
.
Default
value
:
`
$
docker
::
params
::
storage_pool_autoextend_percent
`
#####
<
a
name
=
"tmp_dir_config"
></
a
>
`
tmp_dir_config
`
Data
type
:
`
Optional
[
Boolean
]
`
Whether
to
set
the
TMPDIR
value
in
the
systemd
config
file
Default
:
true
(
set
the
value
);
false
will
comment
out
the
line
.
Note
:
false
is
backwards
compatible
prior
to
PR
#
58
Default
value
:
`
$
docker
::
params
::
tmp_dir_config
`
#####
<
a
name
=
"tmp_dir"
></
a
>
`
tmp_dir
`
Data
type
:
`
Optional
[
String
]
`
Sets
the
tmp
dir
for
Docker
(
path
)
Default
value
:
`
$
docker
::
params
::
tmp_dir
`
#####
<
a
name
=
"registry_mirror"
></
a
>
`
registry_mirror
`
Data
type
:
`
Optional
[
Variant
[
String
,
Array
]]
`
Sets
the
prefered
container
registry
mirror
.
Default
value
:
`
$
docker
::
params
::
registry_mirror
`
#####
<
a
name
=
"nuget_package_provider_version"
></
a
>
`
nuget_package_provider_version
`
Data
type
:
`
Optional
[
String
]
`
The
version
of
the
NuGet
Package
provider
Default
value
:
`
$
docker
::
params
::
nuget_package_provider_version
`
#####
<
a
name
=
"docker_msft_provider_version"
></
a
>
`
docker_msft_provider_version
`
Data
type
:
`
Optional
[
String
]
`
The
version
of
the
Microsoft
Docker
Provider
Module
Default
value
:
`
$
docker
::
params
::
docker_msft_provider_version
`
#####
<
a
name
=
"docker_ce_start_command"
></
a
>
`
docker_ce_start_command
`
Data
type
:
`
String
`
Default
value
:
`
$
docker
::
params
::
docker_ce_start_command
`
#####
<
a
name
=
"docker_ce_package_name"
></
a
>
`
docker_ce_package_name
`
Data
type
:
`
Optional
[
String
]
`
Default
value
:
`
$
docker
::
params
::
docker_ce_package_name
`
#####
<
a
name
=
"docker_ce_source_location"
></
a
>
`
docker_ce_source_location
`
Data
type
:
`
Optional
[
String
]
`
Default
value
:
`
$
docker
::
params
::
package_ce_source_location
`
#####
<
a
name
=
"docker_ce_key_source"
></
a
>
`
docker_ce_key_source
`
Data
type
:
`
Optional
[
String
]
`
Default
value
:
`
$
docker
::
params
::
package_ce_key_source
`
#####
<
a
name
=
"docker_ce_key_id"
></
a
>
`
docker_ce_key_id
`
Data
type
:
`
Optional
[
String
]
`
Default
value
:
`
$
docker
::
params
::
package_ce_key_id
`
#####
<
a
name
=
"docker_ce_release"
></
a
>
`
docker_ce_release
`
Data
type
:
`
Optional
[
String
]
`
Default
value
:
`
$
docker
::
params
::
package_ce_release
`
#####
<
a
name
=
"docker_package_location"
></
a
>
`
docker_package_location
`
Data
type
:
`
Optional
[
String
]
`
Default
value
:
`
$
docker
::
params
::
package_source_location
`
#####
<
a
name
=
"docker_package_key_source"
></
a
>
`
docker_package_key_source
`
Data
type
:
`
Optional
[
String
]
`
Default
value
:
`
$
docker
::
params
::
package_key_source
`
#####
<
a
name
=
"docker_package_key_check_source"
></
a
>
`
docker_package_key_check_source
`
Data
type
:
`
Optional
[
Boolean
]
`
Default
value
:
`
$
docker
::
params
::
package_key_check_source
`
#####
<
a
name
=
"docker_package_key_id"
></
a
>
`
docker_package_key_id
`
Data
type
:
`
Optional
[
String
]
`
Default
value
:
`
$
docker
::
params
::
package_key_id
`
#####
<
a
name
=
"docker_package_release"
></
a
>
`
docker_package_release
`
Data
type
:
`
Optional
[
String
]
`
Default
value
:
`
$
docker
::
params
::
package_release
`
#####
<
a
name
=
"docker_engine_start_command"
></
a
>
`
docker_engine_start_command
`
Data
type
:
`
String
`
Default
value
:
`
$
docker
::
params
::
docker_engine_start_command
`
#####
<
a
name
=
"docker_engine_package_name"
></
a
>
`
docker_engine_package_name
`
Data
type
:
`
String
`
Default
value
:
`
$
docker
::
params
::
docker_engine_package_name
`
#####
<
a
name
=
"docker_ce_channel"
></
a
>
`
docker_ce_channel
`
Data
type
:
`
String
`
Default
value
:
`
$
docker
::
params
::
docker_ce_channel
`
#####
<
a
name
=
"docker_ee"
></
a
>
`
docker_ee
`
Data
type
:
`
Optional
[
Boolean
]
`
Default
value
:
`
$
docker
::
params
::
docker_ee
`
#####
<
a
name
=
"docker_ee_package_name"
></
a
>
`
docker_ee_package_name
`
Data
type
:
`
Optional
[
String
]
`
Default
value
:
`
$
docker
::
params
::
package_ee_package_name
`
#####
<
a
name
=
"docker_ee_source_location"
></
a
>
`
docker_ee_source_location
`
Data
type
:
`
Optional
[
String
]
`
Default
value
:
`
$
docker
::
params
::
package_ee_source_location
`
#####
<
a
name
=
"docker_ee_key_source"
></
a
>
`
docker_ee_key_source
`
Data
type
:
`
Optional
[
String
]
`
Default
value
:
`
$
docker
::
params
::
package_ee_key_source
`
#####
<
a
name
=
"docker_ee_key_id"
></
a
>
`
docker_ee_key_id
`
Data
type
:
`
Optional
[
String
]
`
Default
value
:
`
$
docker
::
params
::
package_ee_key_id
`
#####
<
a
name
=
"docker_ee_repos"
></
a
>
`
docker_ee_repos
`
Data
type
:
`
Optional
[
String
]
`
Default
value
:
`
$
docker
::
params
::
package_ee_repos
`
#####
<
a
name
=
"docker_ee_release"
></
a
>
`
docker_ee_release
`
Data
type
:
`
Optional
[
String
]
`
Default
value
:
`
$
docker
::
params
::
package_ee_release
`
#####
<
a
name
=
"package_release"
></
a
>
`
package_release
`
Data
type
:
`
Optional
[
String
]
`
Default
value
:
`
$
docker
::
params
::
package_release
`
#####
<
a
name
=
"labels"
></
a
>
`
labels
`
Data
type
:
`
Array
`
Default
value
:
`
$
docker
::
params
::
labels
`
#####
<
a
name
=
"execdriver"
></
a
>
`
execdriver
`
Data
type
:
`
Optional
[
String
]
`
Default
value
:
`
$
docker
::
params
::
execdriver
`
#####
<
a
name
=
"package_source"
></
a
>
`
package_source
`
Data
type
:
`
Optional
[
String
]
`
Default
value
:
`
$
docker
::
params
::
package_source
`
#####
<
a
name
=
"os_lc"
></
a
>
`
os_lc
`
Data
type
:
`
Optional
[
String
]
`
Default
value
:
`
$
docker
::
params
::
os_lc
`
#####
<
a
name
=
"storage_config"
></
a
>
`
storage_config
`
Data
type
:
`
Optional
[
Variant
[
String
,
Boolean
]]
`
Default
value
:
`
$
docker
::
params
::
storage_config
`
#####
<
a
name
=
"storage_config_template"
></
a
>
`
storage_config_template
`
Data
type
:
`
Optional
[
String
]
`
Default
value
:
`
$
docker
::
params
::
storage_config_template
`
#####
<
a
name
=
"storage_setup_file"
></
a
>
`
storage_setup_file
`
Data
type
:
`
Optional
[
String
]
`
Default
value
:
`
$
docker
::
params
::
storage_setup_file
`
#####
<
a
name
=
"service_provider"
></
a
>
`
service_provider
`
Data
type
:
`
Optional
[
String
]
`
Default
value
:
`
$
docker
::
params
::
service_provider
`
#####
<
a
name
=
"service_config"
></
a
>
`
service_config
`
Data
type
:
`
Optional
[
Variant
[
String
,
Boolean
]]
`
Default
value
:
`
$
docker
::
params
::
service_config
`
#####
<
a
name
=
"service_config_template"
></
a
>
`
service_config_template
`
Data
type
:
`
Optional
[
String
]
`
Default
value
:
`
$
docker
::
params
::
service_config_template
`
#####
<
a
name
=
"service_overrides_template"
></
a
>
`
service_overrides_template
`
Data
type
:
`
Optional
[
Variant
[
String
,
Boolean
]]
`
Default
value
:
`
$
docker
::
params
::
service_overrides_template
`
#####
<
a
name
=
"socket_overrides_template"
></
a
>
`
socket_overrides_template
`
Data
type
:
`
Optional
[
Variant
[
String
,
Boolean
]]
`
Default
value
:
`
$
docker
::
params
::
socket_overrides_template
`
#####
<
a
name
=
"socket_override"
></
a
>
`
socket_override
`
Data
type
:
`
Optional
[
Boolean
]
`
Default
value
:
`
$
docker
::
params
::
socket_override
`
#####
<
a
name
=
"service_after_override"
></
a
>
`
service_after_override
`
Data
type
:
`
Optional
[
Variant
[
String
,
Boolean
]]
`
Default
value
:
`
$
docker
::
params
::
service_after_override
`
#####
<
a
name
=
"service_hasstatus"
></
a
>
`
service_hasstatus
`
Data
type
:
`
Optional
[
Boolean
]
`
Default
value
:
`
$
docker
::
params
::
service_hasstatus
`
#####
<
a
name
=
"service_hasrestart"
></
a
>
`
service_hasrestart
`
Data
type
:
`
Optional
[
Boolean
]
`
Default
value
:
`
$
docker
::
params
::
service_hasrestart
`
#####
<
a
name
=
"acknowledge_unsupported_os"
></
a
>
`
acknowledge_unsupported_os
`
Data
type
:
`
Boolean
`
Default
value
:
``
false
``
#####
<
a
name
=
"have_systemd_v230"
></
a
>
`
have_systemd_v230
`
Data
type
:
`
Boolean
`
Default
value
:
`
$
docker
::
params
::
have_systemd_v230
`
###
<
a
name
=
"dockercompose"
></
a
>
`
docker
::
compose
`
install
Docker
Compose
using
the
recommended
curl
command
.
####
Parameters
The
following
parameters
are
available
in
the
`
docker
::
compose
`
class
:
*
[
`
ensure
`
](#
ensure
)
*
[
`
version
`
](#
version
)
*
[
`
install_path
`
](#
install_path
)
*
[
`
symlink_name
`
](#
symlink_name
)
*
[
`
proxy
`
](#
proxy
)
*
[
`
base_url
`
](#
base_url
)
*
[
`
raw_url
`
](#
raw_url
)
*
[
`
curl_ensure
`
](#
curl_ensure
)
#####
<
a
name
=
"ensure"
></
a
>
`
ensure
`
Data
type
:
`
Optional
[
Enum
[
present
,
absent
]]
`
Whether
to
install
or
remove
Docker
Compose
Valid
values
are
absent
present
Default
value
:
`'
present
'`
#####
<
a
name
=
"version"
></
a
>
`
version
`
Data
type
:
`
Optional
[
String
]
`
The
version
of
Docker
Compose
to
install
.
Default
value
:
`
$
docker
::
params
::
compose_version
`
#####
<
a
name
=
"install_path"
></
a
>
`
install_path
`
Data
type
:
`
Optional
[
String
]
`
The
path
where
to
install
Docker
Compose
.
Default
value
:
`
$
docker
::
params
::
compose_install_path
`
#####
<
a
name
=
"symlink_name"
></
a
>
`
symlink_name
`
Data
type
:
`
Optional
[
String
]
`
The
name
of
the
symlink
created
pointing
to
the
actual
docker
-
compose
binary
This
allows
use
of
own
docker
-
compose
wrapper
scripts
for
the
times
it
'
s
necessary
to
set
certain
things
before
running
the
docker
-
compose
binary
Default
value
:
`
$
docker
::
params
::
compose_symlink_name
`
#####
<
a
name
=
"proxy"
></
a
>
`
proxy
`
Data
type
:
`
Optional
[
String
]
`
Proxy
to
use
for
downloading
Docker
Compose
.
Default
value
:
``
undef
``
#####
<
a
name
=
"base_url"
></
a
>
`
base_url
`
Data
type
:
`
Optional
[
String
]
`
The
base
url
for
installation
This
allows
use
of
a
mirror
that
follows
the
same
layout
as
the
official
repository
Default
value
:
`
$
docker
::
params
::
compose_base_url
`
#####
<
a
name
=
"raw_url"
></
a
>
`
raw_url
`
Data
type
:
`
Optional
[
String
]
`
Override
the
raw
URL
for
installation
The
default
is
to
build
a
URL
from
baseurl
.
If
rawurl
is
set
,
the
caller
is
responsible
for
ensuring
the
URL
points
to
the
correct
version
and
architecture
.
Default
value
:
``
undef
``
#####
<
a
name
=
"curl_ensure"
></
a
>
`
curl_ensure
`
Data
type
:
`
Optional
[
Boolean
]
`
Whether
or
not
the
curl
package
is
ensured
by
this
module
.
Default
value
:
`
$
docker
::
params
::
curl_ensure
`
###
<
a
name
=
"dockerconfig"
></
a
>
`
docker
::
config
`
The
docker
::
config
class
.
###
<
a
name
=
"dockerimages"
></
a
>
`
docker
::
images
`
The
docker
::
images
class
.
####
Parameters
The
following
parameters
are
available
in
the
`
docker
::
images
`
class
:
*
[
`
images
`
](#
images
)
#####
<
a
name
=
"images"
></
a
>
`
images
`
Data
type
:
`
Any
`
###
<
a
name
=
"dockerinstall"
></
a
>
`
docker
::
install
`
Module
to
install
an
up
-
to
-
date
version
of
Docker
from
a
package
repository
.
Only
for
Debian
,
Red
Hat
and
Windows
####
Parameters
The
following
parameters
are
available
in
the
`
docker
::
install
`
class
:
*
[
`
version
`
](#
version
)
*
[
`
nuget_package_provider_version
`
](#
nuget_package_provider_version
)
*
[
`
docker_msft_provider_version
`
](#
docker_msft_provider_version
)
*
[
`
docker_ee_package_name
`
](#
docker_ee_package_name
)
*
[
`
docker_download_url
`
](#
docker_download_url
)
*
[
`
dependent_packages
`
](#
dependent_packages
)
#####
<
a
name
=
"version"
></
a
>
`
version
`
Data
type
:
`
Any
`
The
package
version
to
install
,
used
to
set
the
package
name
.
Default
value
:
`
$
docker
::
version
`
#####
<
a
name
=
"nuget_package_provider_version"
></
a
>
`
nuget_package_provider_version
`
Data
type
:
`
Any
`
The
version
of
the
NuGet
Package
provider
Default
value
:
`
$
docker
::
nuget_package_provider_version
`
#####
<
a
name
=
"docker_msft_provider_version"
></
a
>
`
docker_msft_provider_version
`
Data
type
:
`
Any
`
The
version
of
the
Microsoft
Docker
Provider
Module
Default
value
:
`
$
docker
::
docker_msft_provider_version
`
#####
<
a
name
=
"docker_ee_package_name"
></
a
>
`
docker_ee_package_name
`
Data
type
:
`
Any
`
The
name
of
the
Docker
Enterprise
Edition
package
Default
value
:
`
$
docker
::
docker_ee_package_name
`
#####
<
a
name
=
"docker_download_url"
></
a
>
`
docker_download_url
`
Data
type
:
`
Any
`
Default
value
:
`
$
docker
::
package_location
`
#####
<
a
name
=
"dependent_packages"
></
a
>
`
dependent_packages
`
Data
type
:
`
Any
`
Default
value
:
`
$
docker
::
dependent_packages
`
###
<
a
name
=
"dockermachine"
></
a
>
`
docker
::
machine
`
install
Docker
Machine
using
the
recommended
curl
command
.
####
Parameters
The
following
parameters
are
available
in
the
`
docker
::
machine
`
class
:
*
[
`
ensure
`
](#
ensure
)
*
[
`
version
`
](#
version
)
*
[
`
install_path
`
](#
install_path
)
*
[
`
proxy
`
](#
proxy
)
*
[
`
url
`
](#
url
)
*
[
`
curl_ensure
`
](#
curl_ensure
)
#####
<
a
name
=
"ensure"
></
a
>
`
ensure
`
Data
type
:
`
Optional
[
Enum
[
present
,
absent
]]
`
Whether
to
install
or
remove
Docker
Machine
Valid
values
are
absent
present
Default
value
:
`'
present
'`
#####
<
a
name
=
"version"
></
a
>
`
version
`
Data
type
:
`
Optional
[
String
]
`
The
version
of
Docker
Machine
to
install
.
Default
value
:
`
$
docker
::
params
::
machine_version
`
#####
<
a
name
=
"install_path"
></
a
>
`
install_path
`
Data
type
:
`
Optional
[
String
]
`
The
path
where
to
install
Docker
Machine
.
Default
value
:
`
$
docker
::
params
::
machine_install_path
`
#####
<
a
name
=
"proxy"
></
a
>
`
proxy
`
Data
type
:
`
Optional
[
String
]
`
Proxy
to
use
for
downloading
Docker
Machine
.
Default
value
:
``
undef
``
#####
<
a
name
=
"url"
></
a
>
`
url
`
Data
type
:
`
Optional
[
Variant
[
Stdlib
::
HTTPUrl
,
Stdlib
::
HTTPSUrl
]]
`
The
URL
from
which
the
docker
machine
binary
should
be
fetched
Default
value
:
``
undef
``
#####
<
a
name
=
"curl_ensure"
></
a
>
`
curl_ensure
`
Data
type
:
`
Optional
[
Boolean
]
`
Whether
or
not
the
curl
package
is
ensured
by
this
module
.
Default
value
:
`
$
docker
::
params
::
curl_ensure
`
###
<
a
name
=
"dockernetworks"
></
a
>
`
docker
::
networks
`
The
docker
::
networks
class
.
####
Parameters
The
following
parameters
are
available
in
the
`
docker
::
networks
`
class
:
*
[
`
networks
`
](#
networks
)
#####
<
a
name
=
"networks"
></
a
>
`
networks
`
Data
type
:
`
Any
`
###
<
a
name
=
"dockerparams"
></
a
>
`
docker
::
params
`
Default
parameter
values
for
the
docker
module
###
<
a
name
=
"dockerplugins"
></
a
>
`
docker
::
plugins
`
The
docker
::
plugins
class
.
####
Parameters
The
following
parameters
are
available
in
the
`
docker
::
plugins
`
class
:
*
[
`
plugins
`
](#
plugins
)
#####
<
a
name
=
"plugins"
></
a
>
`
plugins
`
Data
type
:
`
Any
`
###
<
a
name
=
"dockerregistry_auth"
></
a
>
`
docker
::
registry_auth
`
The
docker
::
registry_auth
class
.
####
Parameters
The
following
parameters
are
available
in
the
`
docker
::
registry_auth
`
class
:
*
[
`
registries
`
](#
registries
)
#####
<
a
name
=
"registries"
></
a
>
`
registries
`
Data
type
:
`
Any
`
###
<
a
name
=
"dockerrepos"
></
a
>
`
docker
::
repos
`
The
docker
::
repos
class
.
####
Parameters
The
following
parameters
are
available
in
the
`
docker
::
repos
`
class
:
*
[
`
location
`
](#
location
)
*
[
`
key_source
`
](#
key_source
)
*
[
`
key_check_source
`
](#
key_check_source
)
*
[
`
architecture
`
](#
architecture
)
#####
<
a
name
=
"location"
></
a
>
`
location
`
Data
type
:
`
Any
`
Default
value
:
`
$
docker
::
package_location
`
#####
<
a
name
=
"key_source"
></
a
>
`
key_source
`
Data
type
:
`
Any
`
Default
value
:
`
$
docker
::
package_key_source
`
#####
<
a
name
=
"key_check_source"
></
a
>
`
key_check_source
`
Data
type
:
`
Any
`
Default
value
:
`
$
docker
::
package_key_check_source
`
#####
<
a
name
=
"architecture"
></
a
>
`
architecture
`
Data
type
:
`
Any
`
Default
value
:
`
$
facts
[
'
os
'
][
'
architecture
'
]
`
###
<
a
name
=
"dockerrun_instance"
></
a
>
`
docker
::
run_instance
`
The
docker
::
run_instance
class
.
####
Parameters
The
following
parameters
are
available
in
the
`
docker
::
run_instance
`
class
:
*
[
`
instance
`
](#
instance
)
#####
<
a
name
=
"instance"
></
a
>
`
instance
`
Data
type
:
`
Any
`
###
<
a
name
=
"dockerservice"
></
a
>
`
docker
::
service
`
manage
the
docker
service
daemon
####
Parameters
The
following
parameters
are
available
in
the
`
docker
::
service
`
class
:
*
[
`
tcp_bind
`
](#
tcp_bind
)
*
[
`
ip_forward
`
](#
ip_forward
)
*
[
`
iptables
`
](#
iptables
)
*
[
`
ip_masq
`
](#
ip_masq
)
*
[
`
socket_bind
`
](#
socket_bind
)
*
[
`
socket_group
`
](#
socket_group
)
*
[
`
root_dir
`
](#
root_dir
)
*
[
`
extra_parameters
`
](#
extra_parameters
)
*
[
`
shell_values
`
](#
shell_values
)
*
[
`
manage_service
`
](#
manage_service
)
*
[
`
docker_command
`
](#
docker_command
)
*
[
`
docker_start_command
`
](#
docker_start_command
)
*
[
`
service_name
`
](#
service_name
)
*
[
`
icc
`
](#
icc
)
*
[
`
bridge
`
](#
bridge
)
*
[
`
fixed_cidr
`
](#
fixed_cidr
)
*
[
`
default_gateway
`
](#
default_gateway
)
*
[
`
ipv6
`
](#
ipv6
)
*
[
`
ipv6_cidr
`
](#
ipv6_cidr
)
*
[
`
default_gateway_ipv6
`
](#
default_gateway_ipv6
)
*
[
`
log_level
`
](#
log_level
)
*
[
`
log_driver
`
](#
log_driver
)
*
[
`
log_opt
`
](#
log_opt
)
*
[
`
selinux_enabled
`
](#
selinux_enabled
)
*
[
`
labels
`
](#
labels
)
*
[
`
dns
`
](#
dns
)
*
[
`
dns_search
`
](#
dns_search
)
*
[
`
service_state
`
](#
service_state
)
*
[
`
service_enable
`
](#
service_enable
)
*
[
`
proxy
`
](#
proxy
)
*
[
`
no_proxy
`
](#
no_proxy
)
*
[
`
execdriver
`
](#
execdriver
)
*
[
`
bip
`
](#
bip
)
*
[
`
mtu
`
](#
mtu
)
*
[
`
storage_driver
`
](#
storage_driver
)
*
[
`
dm_basesize
`
](#
dm_basesize
)
*
[
`
dm_fs
`
](#
dm_fs
)
*
[
`
dm_mkfsarg
`
](#
dm_mkfsarg
)
*
[
`
dm_mountopt
`
](#
dm_mountopt
)
*
[
`
dm_blocksize
`
](#
dm_blocksize
)
*
[
`
dm_loopdatasize
`
](#
dm_loopdatasize
)
*
[
`
dm_loopmetadatasize
`
](#
dm_loopmetadatasize
)
*
[
`
dm_datadev
`
](#
dm_datadev
)
*
[
`
dm_metadatadev
`
](#
dm_metadatadev
)
*
[
`
tmp_dir_config
`
](#
tmp_dir_config
)
*
[
`
tmp_dir
`
](#
tmp_dir
)
*
[
`
dm_thinpooldev
`
](#
dm_thinpooldev
)
*
[
`
dm_use_deferred_removal
`
](#
dm_use_deferred_removal
)
*
[
`
dm_use_deferred_deletion
`
](#
dm_use_deferred_deletion
)
*
[
`
dm_blkdiscard
`
](#
dm_blkdiscard
)
*
[
`
dm_override_udev_sync_check
`
](#
dm_override_udev_sync_check
)
*
[
`
overlay2_override_kernel_check
`
](#
overlay2_override_kernel_check
)
*
[
`
storage_devs
`
](#
storage_devs
)
*
[
`
storage_vg
`
](#
storage_vg
)
*
[
`
storage_root_size
`
](#
storage_root_size
)
*
[
`
storage_data_size
`
](#
storage_data_size
)
*
[
`
storage_min_data_size
`
](#
storage_min_data_size
)
*
[
`
storage_chunk_size
`
](#
storage_chunk_size
)
*
[
`
storage_growpart
`
](#
storage_growpart
)
*
[
`
storage_auto_extend_pool
`
](#
storage_auto_extend_pool
)
*
[
`
storage_pool_autoextend_threshold
`
](#
storage_pool_autoextend_threshold
)
*
[
`
storage_pool_autoextend_percent
`
](#
storage_pool_autoextend_percent
)
*
[
`
storage_config
`
](#
storage_config
)
*
[
`
storage_config_template
`
](#
storage_config_template
)
*
[
`
storage_setup_file
`
](#
storage_setup_file
)
*
[
`
service_provider
`
](#
service_provider
)
*
[
`
service_config
`
](#
service_config
)
*
[
`
service_config_template
`
](#
service_config_template
)
*
[
`
service_overrides_template
`
](#
service_overrides_template
)
*
[
`
socket_overrides_template
`
](#
socket_overrides_template
)
*
[
`
socket_override
`
](#
socket_override
)
*
[
`
service_after_override
`
](#
service_after_override
)
*
[
`
service_hasstatus
`
](#
service_hasstatus
)
*
[
`
service_hasrestart
`
](#
service_hasrestart
)
*
[
`
daemon_environment_files
`
](#
daemon_environment_files
)
*
[
`
tls_enable
`
](#
tls_enable
)
*
[
`
tls_verify
`
](#
tls_verify
)
*
[
`
tls_cacert
`
](#
tls_cacert
)
*
[
`
tls_cert
`
](#
tls_cert
)
*
[
`
tls_key
`
](#
tls_key
)
*
[
`
registry_mirror
`
](#
registry_mirror
)
*
[
`
root_dir_flag
`
](#
root_dir_flag
)
#####
<
a
name
=
"tcp_bind"
></
a
>
`
tcp_bind
`
Data
type
:
`
Any
`
Which
tcp
port
,
if
any
,
to
bind
the
docker
service
to
.
Default
value
:
`
$
docker
::
tcp_bind
`
#####
<
a
name
=
"ip_forward"
></
a
>
`
ip_forward
`
Data
type
:
`
Any
`
This
flag
interacts
with
the
IP
forwarding
setting
on
your
host
system
'
s
kernel
Default
value
:
`
$
docker
::
ip_forward
`
#####
<
a
name
=
"iptables"
></
a
>
`
iptables
`
Data
type
:
`
Any
`
Enable
Docker
'
s
addition
of
iptables
rules
Default
value
:
`
$
docker
::
iptables
`
#####
<
a
name
=
"ip_masq"
></
a
>
`
ip_masq
`
Data
type
:
`
Any
`
Enable
IP
masquerading
for
bridge
'
s
IP
range
.
Default
value
:
`
$
docker
::
ip_masq
`
#####
<
a
name
=
"socket_bind"
></
a
>
`
socket_bind
`
Data
type
:
`
Any
`
Which
local
unix
socket
to
bind
the
docker
service
to
.
Default
value
:
`
$
docker
::
socket_bind
`
#####
<
a
name
=
"socket_group"
></
a
>
`
socket_group
`
Data
type
:
`
Any
`
Which
local
unix
socket
to
bind
the
docker
service
to
.
Default
value
:
`
$
docker
::
socket_group
`
#####
<
a
name
=
"root_dir"
></
a
>
`
root_dir
`
Data
type
:
`
Any
`
Specify
a
non
-
standard
root
directory
for
docker
.
Default
value
:
`
$
docker
::
root_dir
`
#####
<
a
name
=
"extra_parameters"
></
a
>
`
extra_parameters
`
Data
type
:
`
Any
`
Plain
additional
parameters
to
pass
to
the
docker
daemon
Default
value
:
`
$
docker
::
extra_parameters
`
#####
<
a
name
=
"shell_values"
></
a
>
`
shell_values
`
Data
type
:
`
Any
`
Array
of
shell
values
to
pass
into
init
script
config
files
Default
value
:
`
$
docker
::
shell_values
`
#####
<
a
name
=
"manage_service"
></
a
>
`
manage_service
`
Data
type
:
`
Any
`
Specify
whether
the
service
should
be
managed
.
Valid
values
are
'
true
'
,
'
false
'
.
Defaults
to
'
true
'
.
Default
value
:
`
$
docker
::
manage_service
`
#####
<
a
name
=
"docker_command"
></
a
>
`
docker_command
`
Data
type
:
`
Any
`
Default
value
:
`
$
docker
::
docker_command
`
#####
<
a
name
=
"docker_start_command"
></
a
>
`
docker_start_command
`
Data
type
:
`
Any
`
Default
value
:
`
$
docker
::
docker_start_command
`
#####
<
a
name
=
"service_name"
></
a
>
`
service_name
`
Data
type
:
`
Any
`
Default
value
:
`
$
docker
::
service_name
`
#####
<
a
name
=
"icc"
></
a
>
`
icc
`
Data
type
:
`
Any
`
Default
value
:
`
$
docker
::
icc
`
#####
<
a
name
=
"bridge"
></
a
>
`
bridge
`
Data
type
:
`
Any
`
Default
value
:
`
$
docker
::
bridge
`
#####
<
a
name
=
"fixed_cidr"
></
a
>
`
fixed_cidr
`
Data
type
:
`
Any
`
Default
value
:
`
$
docker
::
fixed_cidr
`
#####
<
a
name
=
"default_gateway"
></
a
>
`
default_gateway
`
Data
type
:
`
Any
`
Default
value
:
`
$
docker
::
default_gateway
`
#####
<
a
name
=
"ipv6"
></
a
>
`
ipv6
`
Data
type
:
`
Any
`
Default
value
:
`
$
docker
::
ipv6
`
#####
<
a
name
=
"ipv6_cidr"
></
a
>
`
ipv6_cidr
`
Data
type
:
`
Any
`
Default
value
:
`
$
docker
::
ipv6_cidr
`
#####
<
a
name
=
"default_gateway_ipv6"
></
a
>
`
default_gateway_ipv6
`
Data
type
:
`
Any
`
Default
value
:
`
$
docker
::
default_gateway_ipv6
`
#####
<
a
name
=
"log_level"
></
a
>
`
log_level
`
Data
type
:
`
Any
`
Default
value
:
`
$
docker
::
log_level
`
#####
<
a
name
=
"log_driver"
></
a
>
`
log_driver
`
Data
type
:
`
Any
`
Default
value
:
`
$
docker
::
log_driver
`
#####
<
a
name
=
"log_opt"
></
a
>
`
log_opt
`
Data
type
:
`
Any
`
Default
value
:
`
$
docker
::
log_opt
`
#####
<
a
name
=
"selinux_enabled"
></
a
>
`
selinux_enabled
`
Data
type
:
`
Any
`
Default
value
:
`
$
docker
::
selinux_enabled
`
#####
<
a
name
=
"labels"
></
a
>
`
labels
`
Data
type
:
`
Any
`
Default
value
:
`
$
docker
::
labels
`
#####
<
a
name
=
"dns"
></
a
>
`
dns
`
Data
type
:
`
Any
`
Default
value
:
`
$
docker
::
dns
`
#####
<
a
name
=
"dns_search"
></
a
>
`
dns_search
`
Data
type
:
`
Any
`
Default
value
:
`
$
docker
::
dns_search
`
#####
<
a
name
=
"service_state"
></
a
>
`
service_state
`
Data
type
:
`
Any
`
Default
value
:
`
$
docker
::
service_state
`
#####
<
a
name
=
"service_enable"
></
a
>
`
service_enable
`
Data
type
:
`
Any
`
Default
value
:
`
$
docker
::
service_enable
`
#####
<
a
name
=
"proxy"
></
a
>
`
proxy
`
Data
type
:
`
Any
`
Default
value
:
`
$
docker
::
proxy
`
#####
<
a
name
=
"no_proxy"
></
a
>
`
no_proxy
`
Data
type
:
`
Any
`
Default
value
:
`
$
docker
::
no_proxy
`
#####
<
a
name
=
"execdriver"
></
a
>
`
execdriver
`
Data
type
:
`
Any
`
Default
value
:
`
$
docker
::
execdriver
`
#####
<
a
name
=
"bip"
></
a
>
`
bip
`
Data
type
:
`
Any
`
Default
value
:
`
$
docker
::
bip
`
#####
<
a
name
=
"mtu"
></
a
>
`
mtu
`
Data
type
:
`
Any
`
Default
value
:
`
$
docker
::
mtu
`
#####
<
a
name
=
"storage_driver"
></
a
>
`
storage_driver
`
Data
type
:
`
Any
`
Default
value
:
`
$
docker
::
storage_driver
`
#####
<
a
name
=
"dm_basesize"
></
a
>
`
dm_basesize
`
Data
type
:
`
Any
`
Default
value
:
`
$
docker
::
dm_basesize
`
#####
<
a
name
=
"dm_fs"
></
a
>
`
dm_fs
`
Data
type
:
`
Any
`
Default
value
:
`
$
docker
::
dm_fs
`
#####
<
a
name
=
"dm_mkfsarg"
></
a
>
`
dm_mkfsarg
`
Data
type
:
`
Any
`
Default
value
:
`
$
docker
::
dm_mkfsarg
`
#####
<
a
name
=
"dm_mountopt"
></
a
>
`
dm_mountopt
`
Data
type
:
`
Any
`
Default
value
:
`
$
docker
::
dm_mountopt
`
#####
<
a
name
=
"dm_blocksize"
></
a
>
`
dm_blocksize
`
Data
type
:
`
Any
`
Default
value
:
`
$
docker
::
dm_blocksize
`
#####
<
a
name
=
"dm_loopdatasize"
></
a
>
`
dm_loopdatasize
`
Data
type
:
`
Any
`
Default
value
:
`
$
docker
::
dm_loopdatasize
`
#####
<
a
name
=
"dm_loopmetadatasize"
></
a
>
`
dm_loopmetadatasize
`
Data
type
:
`
Any
`
Default
value
:
`
$
docker
::
dm_loopmetadatasize
`
#####
<
a
name
=
"dm_datadev"
></
a
>
`
dm_datadev
`
Data
type
:
`
Any
`
Default
value
:
`
$
docker
::
dm_datadev
`
#####
<
a
name
=
"dm_metadatadev"
></
a
>
`
dm_metadatadev
`
Data
type
:
`
Any
`
Default
value
:
`
$
docker
::
dm_metadatadev
`
#####
<
a
name
=
"tmp_dir_config"
></
a
>
`
tmp_dir_config
`
Data
type
:
`
Any
`
Default
value
:
`
$
docker
::
tmp_dir_config
`
#####
<
a
name
=
"tmp_dir"
></
a
>
`
tmp_dir
`
Data
type
:
`
Any
`
Default
value
:
`
$
docker
::
tmp_dir
`
#####
<
a
name
=
"dm_thinpooldev"
></
a
>
`
dm_thinpooldev
`
Data
type
:
`
Any
`
Default
value
:
`
$
docker
::
dm_thinpooldev
`
#####
<
a
name
=
"dm_use_deferred_removal"
></
a
>
`
dm_use_deferred_removal
`
Data
type
:
`
Any
`
Default
value
:
`
$
docker
::
dm_use_deferred_removal
`
#####
<
a
name
=
"dm_use_deferred_deletion"
></
a
>
`
dm_use_deferred_deletion
`
Data
type
:
`
Any
`
Default
value
:
`
$
docker
::
dm_use_deferred_deletion
`
#####
<
a
name
=
"dm_blkdiscard"
></
a
>
`
dm_blkdiscard
`
Data
type
:
`
Any
`
Default
value
:
`
$
docker
::
dm_blkdiscard
`
#####
<
a
name
=
"dm_override_udev_sync_check"
></
a
>
`
dm_override_udev_sync_check
`
Data
type
:
`
Any
`
Default
value
:
`
$
docker
::
dm_override_udev_sync_check
`
#####
<
a
name
=
"overlay2_override_kernel_check"
></
a
>
`
overlay2_override_kernel_check
`
Data
type
:
`
Any
`
Default
value
:
`
$
docker
::
overlay2_override_kernel_check
`
#####
<
a
name
=
"storage_devs"
></
a
>
`
storage_devs
`
Data
type
:
`
Any
`
Default
value
:
`
$
docker
::
storage_devs
`
#####
<
a
name
=
"storage_vg"
></
a
>
`
storage_vg
`
Data
type
:
`
Any
`
Default
value
:
`
$
docker
::
storage_vg
`
#####
<
a
name
=
"storage_root_size"
></
a
>
`
storage_root_size
`
Data
type
:
`
Any
`
Default
value
:
`
$
docker
::
storage_root_size
`
#####
<
a
name
=
"storage_data_size"
></
a
>
`
storage_data_size
`
Data
type
:
`
Any
`
Default
value
:
`
$
docker
::
storage_data_size
`
#####
<
a
name
=
"storage_min_data_size"
></
a
>
`
storage_min_data_size
`
Data
type
:
`
Any
`
Default
value
:
`
$
docker
::
storage_min_data_size
`
#####
<
a
name
=
"storage_chunk_size"
></
a
>
`
storage_chunk_size
`
Data
type
:
`
Any
`
Default
value
:
`
$
docker
::
storage_chunk_size
`
#####
<
a
name
=
"storage_growpart"
></
a
>
`
storage_growpart
`
Data
type
:
`
Any
`
Default
value
:
`
$
docker
::
storage_growpart
`
#####
<
a
name
=
"storage_auto_extend_pool"
></
a
>
`
storage_auto_extend_pool
`
Data
type
:
`
Any
`
Default
value
:
`
$
docker
::
storage_auto_extend_pool
`
#####
<
a
name
=
"storage_pool_autoextend_threshold"
></
a
>
`
storage_pool_autoextend_threshold
`
Data
type
:
`
Any
`
Default
value
:
`
$
docker
::
storage_pool_autoextend_threshold
`
#####
<
a
name
=
"storage_pool_autoextend_percent"
></
a
>
`
storage_pool_autoextend_percent
`
Data
type
:
`
Any
`
Default
value
:
`
$
docker
::
storage_pool_autoextend_percent
`
#####
<
a
name
=
"storage_config"
></
a
>
`
storage_config
`
Data
type
:
`
Any
`
Default
value
:
`
$
docker
::
storage_config
`
#####
<
a
name
=
"storage_config_template"
></
a
>
`
storage_config_template
`
Data
type
:
`
Any
`
Default
value
:
`
$
docker
::
storage_config_template
`
#####
<
a
name
=
"storage_setup_file"
></
a
>
`
storage_setup_file
`
Data
type
:
`
Any
`
Default
value
:
`
$
docker
::
storage_setup_file
`
#####
<
a
name
=
"service_provider"
></
a
>
`
service_provider
`
Data
type
:
`
Any
`
Default
value
:
`
$
docker
::
service_provider
`
#####
<
a
name
=
"service_config"
></
a
>
`
service_config
`
Data
type
:
`
Any
`
Default
value
:
`
$
docker
::
service_config
`
#####
<
a
name
=
"service_config_template"
></
a
>
`
service_config_template
`
Data
type
:
`
Any
`
Default
value
:
`
$
docker
::
service_config_template
`
#####
<
a
name
=
"service_overrides_template"
></
a
>
`
service_overrides_template
`
Data
type
:
`
Any
`
Default
value
:
`
$
docker
::
service_overrides_template
`
#####
<
a
name
=
"socket_overrides_template"
></
a
>
`
socket_overrides_template
`
Data
type
:
`
Any
`
Default
value
:
`
$
docker
::
socket_overrides_template
`
#####
<
a
name
=
"socket_override"
></
a
>
`
socket_override
`
Data
type
:
`
Any
`
Default
value
:
`
$
docker
::
socket_override
`
#####
<
a
name
=
"service_after_override"
></
a
>
`
service_after_override
`
Data
type
:
`
Any
`
Default
value
:
`
$
docker
::
service_after_override
`
#####
<
a
name
=
"service_hasstatus"
></
a
>
`
service_hasstatus
`
Data
type
:
`
Any
`
Default
value
:
`
$
docker
::
service_hasstatus
`
#####
<
a
name
=
"service_hasrestart"
></
a
>
`
service_hasrestart
`
Data
type
:
`
Any
`
Default
value
:
`
$
docker
::
service_hasrestart
`
#####
<
a
name
=
"daemon_environment_files"
></
a
>
`
daemon_environment_files
`
Data
type
:
`
Any
`
Default
value
:
`
$
docker
::
daemon_environment_files
`
#####
<
a
name
=
"tls_enable"
></
a
>
`
tls_enable
`
Data
type
:
`
Any
`
Default
value
:
`
$
docker
::
tls_enable
`
#####
<
a
name
=
"tls_verify"
></
a
>
`
tls_verify
`
Data
type
:
`
Any
`
Default
value
:
`
$
docker
::
tls_verify
`
#####
<
a
name
=
"tls_cacert"
></
a
>
`
tls_cacert
`
Data
type
:
`
Any
`
Default
value
:
`
$
docker
::
tls_cacert
`
#####
<
a
name
=
"tls_cert"
></
a
>
`
tls_cert
`
Data
type
:
`
Any
`
Default
value
:
`
$
docker
::
tls_cert
`
#####
<
a
name
=
"tls_key"
></
a
>
`
tls_key
`
Data
type
:
`
Any
`
Default
value
:
`
$
docker
::
tls_key
`
#####
<
a
name
=
"registry_mirror"
></
a
>
`
registry_mirror
`
Data
type
:
`
Any
`
Default
value
:
`
$
docker
::
registry_mirror
`
#####
<
a
name
=
"root_dir_flag"
></
a
>
`
root_dir_flag
`
Data
type
:
`
Any
`
Default
value
:
`
$
docker
::
root_dir_flag
`
###
<
a
name
=
"dockerswarms"
></
a
>
`
docker
::
swarms
`
The
docker
::
swarms
class
.
####
Parameters
The
following
parameters
are
available
in
the
`
docker
::
swarms
`
class
:
*
[
`
swarms
`
](#
swarms
)
#####
<
a
name
=
"swarms"
></
a
>
`
swarms
`
Data
type
:
`
Any
`
###
<
a
name
=
"dockersystemd_reload"
></
a
>
`
docker
::
systemd_reload
`
For
systems
that
have
systemd
###
<
a
name
=
"dockervolumes"
></
a
>
`
docker
::
volumes
`
The
docker
::
volumes
class
.
####
Parameters
The
following
parameters
are
available
in
the
`
docker
::
volumes
`
class
:
*
[
`
volumes
`
](#
volumes
)
#####
<
a
name
=
"volumes"
></
a
>
`
volumes
`
Data
type
:
`
Any
`
##
Defined
types
###
<
a
name
=
"dockerexec"
></
a
>
`
docker
::
exec
`
A
define
which
executes
a
command
inside
a
container
.
####
Parameters
The
following
parameters
are
available
in
the
`
docker
::
exec
`
defined
type
:
*
[
`
detach
`
](#
detach
)
*
[
`
interactive
`
](#
interactive
)
*
[
`
env
`
](#
env
)
*
[
`
tty
`
](#
tty
)
*
[
`
container
`
](#
container
)
*
[
`
command
`
](#
command
)
*
[
`
unless
`
](#
unless
)
*
[
`
sanitise_name
`
](#
sanitise_name
)
*
[
`
refreshonly
`
](#
refreshonly
)
*
[
`
onlyif
`
](#
onlyif
)
#####
<
a
name
=
"detach"
></
a
>
`
detach
`
Data
type
:
`
Optional
[
Boolean
]
`
Default
value
:
``
false
``
#####
<
a
name
=
"interactive"
></
a
>
`
interactive
`
Data
type
:
`
Optional
[
Boolean
]
`
Default
value
:
``
false
``
#####
<
a
name
=
"env"
></
a
>
`
env
`
Data
type
:
`
Optional
[
Array
]
`
Default
value
:
`
[]
`
#####
<
a
name
=
"tty"
></
a
>
`
tty
`
Data
type
:
`
Optional
[
Boolean
]
`
Default
value
:
``
false
``
#####
<
a
name
=
"container"
></
a
>
`
container
`
Data
type
:
`
Optional
[
String
]
`
Default
value
:
``
undef
``
#####
<
a
name
=
"command"
></
a
>
`
command
`
Data
type
:
`
Optional
[
String
]
`
Default
value
:
``
undef
``
#####
<
a
name
=
"unless"
></
a
>
`
unless
`
Data
type
:
`
Optional
[
String
]
`
Default
value
:
``
undef
``
#####
<
a
name
=
"sanitise_name"
></
a
>
`
sanitise_name
`
Data
type
:
`
Optional
[
Boolean
]
`
Default
value
:
``
true
``
#####
<
a
name
=
"refreshonly"
></
a
>
`
refreshonly
`
Data
type
:
`
Optional
[
Boolean
]
`
Default
value
:
``
false
``
#####
<
a
name
=
"onlyif"
></
a
>
`
onlyif
`
Data
type
:
`
Optional
[
String
]
`
Default
value
:
``
undef
``
###
<
a
name
=
"dockerimage"
></
a
>
`
docker
::
image
`
Module
to
install
an
up
-
to
-
date
version
of
a
Docker
image
from
the
registry
####
Parameters
The
following
parameters
are
available
in
the
`
docker
::
image
`
defined
type
:
*
[
`
ensure
`
](#
ensure
)
*
[
`
image
`
](#
image
)
*
[
`
image_tag
`
](#
image_tag
)
*
[
`
image_digest
`
](#
image_digest
)
*
[
`
docker_file
`
](#
docker_file
)
*
[
`
docker_tar
`
](#
docker_tar
)
*
[
`
force
`
](#
force
)
*
[
`
docker_dir
`
](#
docker_dir
)
#####
<
a
name
=
"ensure"
></
a
>
`
ensure
`
Data
type
:
`
Optional
[
Enum
[
present
,
absent
,
latest
]]
`
Whether
you
want
the
image
present
or
absent
.
Default
value
:
`'
present
'`
#####
<
a
name
=
"image"
></
a
>
`
image
`
Data
type
:
`
Optional
[
Pattern
[/^[\
S
]*$/]]
`
If
you
want
the
name
of
the
image
to
be
different
from
the
name
of
the
puppet
resource
you
can
pass
a
value
here
.
Default
value
:
`
$
title
`
#####
<
a
name
=
"image_tag"
></
a
>
`
image_tag
`
Data
type
:
`
Optional
[
String
]
`
If
you
want
a
specific
tag
of
the
image
to
be
installed
Default
value
:
``
undef
``
#####
<
a
name
=
"image_digest"
></
a
>
`
image_digest
`
Data
type
:
`
Optional
[
String
]
`
If
you
want
a
specific
content
digest
of
the
image
to
be
installed
Default
value
:
``
undef
``
#####
<
a
name
=
"docker_file"
></
a
>
`
docker_file
`
Data
type
:
`
Optional
[
String
]
`
If
you
want
to
add
a
docker
image
from
specific
docker
file
Default
value
:
``
undef
``
#####
<
a
name
=
"docker_tar"
></
a
>
`
docker_tar
`
Data
type
:
`
Optional
[
String
]
`
If
you
want
to
load
a
docker
image
from
specific
docker
tar
Default
value
:
``
undef
``
#####
<
a
name
=
"force"
></
a
>
`
force
`
Data
type
:
`
Optional
[
Boolean
]
`
Default
value
:
``
false
``
#####
<
a
name
=
"docker_dir"
></
a
>
`
docker_dir
`
Data
type
:
`
Optional
[
String
]
`
Default
value
:
``
undef
``
###
<
a
name
=
"dockerplugin"
></
a
>
`
docker
::
plugin
`
A
define
that
manages
a
docker
plugin
####
Parameters
The
following
parameters
are
available
in
the
`
docker
::
plugin
`
defined
type
:
*
[
`
plugin_name
`
](#
plugin_name
)
*
[
`
plugin_name
`
](#
plugin_name
)
*
[
`
enabled
`
](#
enabled
)
*
[
`
timeout
`
](#
timeout
)
*
[
`
plugin_alias
`
](#
plugin_alias
)
*
[
`
disable_on_install
`
](#
disable_on_install
)
*
[
`
disable_content_trust
`
](#
disable_content_trust
)
*
[
`
grant_all_permissions
`
](#
grant_all_permissions
)
*
[
`
force_remove
`
](#
force_remove
)
*
[
`
settings
`
](#
settings
)
*
[
`
ensure
`
](#
ensure
)
*
[
`
grant_all_permissions
`
](#
grant_all_permissions
)
#####
<
a
name
=
"plugin_name"
></
a
>
`
plugin_name
`
Data
type
:
`
String
`
This
ensures
whether
the
plugin
is
installed
or
not
.
Note
that
the
default
behaviour
of
docker
plugin
requires
a
plugin
be
disabled
before
it
can
be
removed
Default
value
:
`
$
title
`
#####
<
a
name
=
"plugin_name"
></
a
>
`
plugin_name
`
The
name
of
the
docker
plugin
Default
value
:
`
$
title
`
#####
<
a
name
=
"enabled"
></
a
>
`
enabled
`
Data
type
:
`
Optional
[
Boolean
]
`
A
setting
to
enable
or
disable
an
installed
plugin
.
Default
value
:
``
true
``
#####
<
a
name
=
"timeout"
></
a
>
`
timeout
`
Data
type
:
`
Optional
[
String
]
`
The
number
of
seconds
to
wait
when
enabling
a
plugin
Default
value
:
``
undef
``
#####
<
a
name
=
"plugin_alias"
></
a
>
`
plugin_alias
`
Data
type
:
`
Optional
[
String
]
`
An
alternative
name
to
use
for
an
installed
plugin
Default
value
:
``
undef
``
#####
<
a
name
=
"disable_on_install"
></
a
>
`
disable_on_install
`
Data
type
:
`
Optional
[
Boolean
]
`
Alters
the
default
behaviour
of
enabling
a
plugin
upon
install
Default
value
:
``
false
``
#####
<
a
name
=
"disable_content_trust"
></
a
>
`
disable_content_trust
`
Data
type
:
`
Optional
[
Boolean
]
`
Skip
image
verification
Default
value
:
``
true
``
#####
<
a
name
=
"grant_all_permissions"
></
a
>
`
grant_all_permissions
`
Data
type
:
`
Optional
[
Boolean
]
`
Grant
all
permissions
necessary
to
run
the
plugin
Default
value
:
``
true
``
#####
<
a
name
=
"force_remove"
></
a
>
`
force_remove
`
Data
type
:
`
Optional
[
Boolean
]
`
Force
the
removal
of
an
active
plugin
Default
value
:
``
true
``
#####
<
a
name
=
"settings"
></
a
>
`
settings
`
Data
type
:
`
Optional
[
Array
]
`
Any
additional
settings
to
pass
to
the
plugin
during
install
Default
value
:
`
[]
`
#####
<
a
name
=
"ensure"
></
a
>
`
ensure
`
Data
type
:
`
Optional
[
Enum
[
present
,
absent
]]
`
Default
value
:
`'
present
'`
#####
<
a
name
=
"grant_all_permissions"
></
a
>
`
grant_all_permissions
`
Default
value
:
``
true
``
###
<
a
name
=
"dockerregistry"
></
a
>
`
docker
::
registry
`
Module
to
configure
private
docker
registries
from
which
to
pull
Docker
images
####
Parameters
The
following
parameters
are
available
in
the
`
docker
::
registry
`
defined
type
:
*
[
`
server
`
](#
server
)
*
[
`
ensure
`
](#
ensure
)
*
[
`
username
`
](#
username
)
*
[
`
password
`
](#
password
)
*
[
`
pass_hash
`
](#
pass_hash
)
*
[
`
email
`
](#
email
)
*
[
`
local_user
`
](#
local_user
)
*
[
`
local_user_home
`
](#
local_user_home
)
*
[
`
receipt
`
](#
receipt
)
*
[
`
version
`
](#
version
)
#####
<
a
name
=
"server"
></
a
>
`
server
`
Data
type
:
`
Optional
[
String
]
`
The
hostname
and
port
of
the
private
Docker
registry
.
Ex
:
dockerreg
:
5000
Default
value
:
`
$
title
`
#####
<
a
name
=
"ensure"
></
a
>
`
ensure
`
Data
type
:
`
Optional
[
Enum
[
present
,
absent
]]
`
Whether
or
not
you
want
to
login
or
logout
of
a
repository
Default
value
:
`'
present
'`
#####
<
a
name
=
"username"
></
a
>
`
username
`
Data
type
:
`
Optional
[
String
]
`
Username
for
authentication
to
private
Docker
registry
.
auth
is
not
required
.
Default
value
:
``
undef
``
#####
<
a
name
=
"password"
></
a
>
`
password
`
Data
type
:
`
Optional
[
String
]
`
Password
for
authentication
to
private
Docker
registry
.
Leave
undef
if
auth
is
not
required
.
Default
value
:
``
undef
``
#####
<
a
name
=
"pass_hash"
></
a
>
`
pass_hash
`
Data
type
:
`
Optional
[
String
]
`
The
hash
to
be
used
for
receipt
.
If
left
as
undef
,
a
hash
will
be
generated
Default
value
:
``
undef
``
#####
<
a
name
=
"email"
></
a
>
`
email
`
Data
type
:
`
Optional
[
String
]
`
Email
for
registration
to
private
Docker
registry
.
Leave
undef
if
auth
is
not
required
.
Default
value
:
``
undef
``
#####
<
a
name
=
"local_user"
></
a
>
`
local_user
`
Data
type
:
`
Optional
[
String
]
`
The
local
user
to
log
in
as
.
Docker
will
store
credentials
in
this
users
home
directory
Default
value
:
`'
root
'`
#####
<
a
name
=
"local_user_home"
></
a
>
`
local_user_home
`
Data
type
:
`
Optional
[
String
]
`
The
local
user
home
directory
.
Default
value
:
``
undef
``
#####
<
a
name
=
"receipt"
></
a
>
`
receipt
`
Data
type
:
`
Optional
[
Boolean
]
`
Required
to
be
true
for
idempotency
Default
value
:
``
true
``
#####
<
a
name
=
"version"
></
a
>
`
version
`
Data
type
:
`
Optional
[
String
]
`
Default
value
:
`
$
docker
::
version
`
###
<
a
name
=
"dockerrun"
></
a
>
`
docker
::
run
`
Sets
a
restart
policy
on
the
docker
run
.
Note
:
If
set
,
puppet
will
NOT
setup
an
init
script
to
manage
,
instead
it
will
do
a
raw
docker
run
command
using
a
CID
file
to
track
the
container
ID
.
If
you
want
a
normal
named
container
with
an
init
script
and
a
restart
policy
you
must
use
the
extra_parameters
feature
and
pass
it
in
like
this
:
extra_parameters
=>
[
'
--
restart
=
always
'
]
However
,
if
your
system
is
using
sytemd
this
restart
policy
will
be
ineffective
because
the
ExecStop
commands
will
run
which
will
cause
docker
to
stop
restarting
it
.
In
this
case
you
should
use
the
systemd_restart
option
to
specify
the
policy
you
want
.
This
will
allow
the
docker
container
to
be
restarted
if
it
dies
,
without
puppet
help
.
(
optional
)
Specifies
the
command
to
execute
to
check
that
the
container
is
healthy
using
the
docker
health
check
functionality
.
Default
:
undef
(
optional
)
Specifies
the
interval
that
the
health
check
command
will
execute
in
seconds
.
Default
:
undef
(
optional
)
Checks
the
health
status
of
Docker
container
and
if
it
is
unhealthy
the
service
will
be
restarted
.
The
health_check_cmd
parameter
must
be
set
to
true
to
use
this
functionality
.
Default
:
undef
The
docker
network
to
attach
to
a
container
.
Can
be
a
String
or
Array
(
if
using
multiple
networks
)
Default
:
bridge
An
array
of
additional
command
line
arguments
to
pass
to
the
`
docker
run
`
command
.
Useful
for
adding
additional
new
or
experimental
options
that
the
module
does
not
yet
support
.
(
optional
)
If
the
container
is
to
be
managed
by
a
systemd
unit
file
set
the
Restart
option
on
the
unit
file
.
Can
be
any
valid
value
for
this
systemd
configuration
.
Most
commonly
used
are
on
-
failure
or
always
.
Default
:
on
-
failure
(
optional
)
Specify
an
additional
unless
for
the
Docker
run
command
when
using
restart
.
Default
:
undef
(
optional
)
Specifies
the
command
to
execute
after
container
is
created
but
before
it
is
started
.
Default
:
undef
(
optional
)
If
the
container
is
to
be
managed
by
a
systemd
unit
file
set
the
RemainAfterExit
option
on
the
unit
file
.
Can
be
any
valid
value
for
this
systemd
configuration
.
Default
:
Not
included
in
unit
file
(
optional
)
Prepare
the
service
and
enable
it
as
usual
but
do
not
run
it
right
away
.
Useful
when
building
VM
images
using
masterless
Puppet
and
then
letting
the
Docker
images
to
be
downloaded
when
a
new
VM
is
created
.
Default
:
false
####
Parameters
The
following
parameters
are
available
in
the
`
docker
::
run
`
defined
type
:
*
[
`
restart
`
](#
restart
)
*
[
`
verify_digest
`
](#
verify_digest
)
*
[
`
service_prefix
`
](#
service_prefix
)
*
[
`
restart_service
`
](#
restart_service
)
*
[
`
restart_service_on_docker_refresh
`
](#
restart_service_on_docker_refresh
)
*
[
`
manage_service
`
](#
manage_service
)
*
[
`
docker_service
`
](#
docker_service
)
*
[
`
health_check_cmd
`
](#
health_check_cmd
)
*
[
`
health_check_interval
`
](#
health_check_interval
)
*
[
`
restart_on_unhealthy
`
](#
restart_on_unhealthy
)
*
[
`
net
`
](#
net
)
*
[
`
extra_parameters
`
](#
extra_parameters
)
*
[
`
systemd_restart
`
](#
systemd_restart
)
*
[
`
custom_unless
`
](#
custom_unless
)
*
[
`
after_create
`
](#
after_create
)
*
[
`
remain_after_exit
`
](#
remain_after_exit
)
*
[
`
prepare_service_only
`
](#
prepare_service_only
)
*
[
`
image
`
](#
image
)
*
[
`
ensure
`
](#
ensure
)
*
[
`
command
`
](#
command
)
*
[
`
memory_limit
`
](#
memory_limit
)
*
[
`
cpuset
`
](#
cpuset
)
*
[
`
ports
`
](#
ports
)
*
[
`
labels
`
](#
labels
)
*
[
`
expose
`
](#
expose
)
*
[
`
volumes
`
](#
volumes
)
*
[
`
links
`
](#
links
)
*
[
`
use_name
`
](#
use_name
)
*
[
`
running
`
](#
running
)
*
[
`
volumes_from
`
](#
volumes_from
)
*
[
`
username
`
](#
username
)
*
[
`
hostname
`
](#
hostname
)
*
[
`
env
`
](#
env
)
*
[
`
env_file
`
](#
env_file
)
*
[
`
dns
`
](#
dns
)
*
[
`
dns_search
`
](#
dns_search
)
*
[
`
lxc_conf
`
](#
lxc_conf
)
*
[
`
service_provider
`
](#
service_provider
)
*
[
`
disable_network
`
](#
disable_network
)
*
[
`
privileged
`
](#
privileged
)
*
[
`
detach
`
](#
detach
)
*
[
`
extra_systemd_parameters
`
](#
extra_systemd_parameters
)
*
[
`
pull_on_start
`
](#
pull_on_start
)
*
[
`
after
`
](#
after
)
*
[
`
after_service
`
](#
after_service
)
*
[
`
depends
`
](#
depends
)
*
[
`
depend_services
`
](#
depend_services
)
*
[
`
tty
`
](#
tty
)
*
[
`
socket_connect
`
](#
socket_connect
)
*
[
`
hostentries
`
](#
hostentries
)
*
[
`
before_start
`
](#
before_start
)
*
[
`
before_stop
`
](#
before_stop
)
*
[
`
after_start
`
](#
after_start
)
*
[
`
after_stop
`
](#
after_stop
)
*
[
`
remove_container_on_start
`
](#
remove_container_on_start
)
*
[
`
remove_container_on_stop
`
](#
remove_container_on_stop
)
*
[
`
remove_volume_on_start
`
](#
remove_volume_on_start
)
*
[
`
remove_volume_on_stop
`
](#
remove_volume_on_stop
)
*
[
`
stop_wait_time
`
](#
stop_wait_time
)
*
[
`
syslog_identifier
`
](#
syslog_identifier
)
*
[
`
read_only
`
](#
read_only
)
#####
<
a
name
=
"restart"
></
a
>
`
restart
`
Data
type
:
`
Optional
[
String
]
`
Default
value
:
``
undef
``
#####
<
a
name
=
"verify_digest"
></
a
>
`
verify_digest
`
Data
type
:
`
Optional
[
String
]
`
(
optional
)
Make
sure
,
that
the
image
has
not
modified
.
Compares
the
digest
checksum
before
starting
the
docker
image
.
To
get
the
digest
of
an
image
,
run
the
following
command
:
docker
image
inspect
<<
image
>>
--
format
=
'
{{
index
.
RepoDigests
0
}}
Default
value
:
``
undef
``
#####
<
a
name
=
"service_prefix"
></
a
>
`
service_prefix
`
Data
type
:
`
Optional
[
String
]
`
(
optional
)
The
name
to
prefix
the
startup
script
with
and
the
Puppet
service
resource
title
with
.
Default
:
'
docker
-
'
Default
value
:
`'
docker
-
'`
#####
<
a
name
=
"restart_service"
></
a
>
`
restart_service
`
Data
type
:
`
Optional
[
Boolean
]
`
(
optional
)
Whether
or
not
to
restart
the
service
if
the
the
generated
init
script
changes
.
Default
:
true
Default
value
:
``
true
``
#####
<
a
name
=
"restart_service_on_docker_refresh"
></
a
>
`
restart_service_on_docker_refresh
`
Data
type
:
`
Optional
[
Boolean
]
`
Whether
or
not
to
restart
the
service
if
the
docker
service
is
restarted
.
Only
has
effect
if
the
docker_service
parameter
is
set
.
Default
:
true
Default
value
:
``
true
``
#####
<
a
name
=
"manage_service"
></
a
>
`
manage_service
`
Data
type
:
`
Optional
[
Boolean
]
`
(
optional
)
Whether
or
not
to
create
a
puppet
Service
resource
for
the
init
script
.
Disabling
this
may
be
useful
if
integrating
with
existing
modules
.
Default
:
true
Default
value
:
``
true
``
#####
<
a
name
=
"docker_service"
></
a
>
`
docker_service
`
Data
type
:
`
Variant
[
String
,
Boolean
]
`
(
optional
)
If
(
and
how
)
the
Docker
service
itself
is
managed
by
Puppet
true
->
Service
[
'
docker
'
]
false
->
no
Service
dependency
anything
else
->
Service
[
docker_service
]
Default
:
false
Default
value
:
``
false
``
#####
<
a
name
=
"health_check_cmd"
></
a
>
`
health_check_cmd
`
Data
type
:
`
Optional
[
String
]
`
Default
value
:
``
undef
``
#####
<
a
name
=
"health_check_interval"
></
a
>
`
health_check_interval
`
Data
type
:
`
Optional
[
Integer
]
`
Default
value
:
``
undef
``
#####
<
a
name
=
"restart_on_unhealthy"
></
a
>
`
restart_on_unhealthy
`
Data
type
:
`
Optional
[
Boolean
]
`
Default
value
:
``
false
``
#####
<
a
name
=
"net"
></
a
>
`
net
`
Data
type
:
`
Variant
[
String
,
Array
]
`
Default
value
:
`'
bridge
'`
#####
<
a
name
=
"extra_parameters"
></
a
>
`
extra_parameters
`
Data
type
:
`
Optional
[
Variant
[
String
,
Array
[
String
]]]
`
Default
value
:
``
undef
``
#####
<
a
name
=
"systemd_restart"
></
a
>
`
systemd_restart
`
Data
type
:
`
Optional
[
String
]
`
Default
value
:
`'
on
-
failure
'`
#####
<
a
name
=
"custom_unless"
></
a
>
`
custom_unless
`
Data
type
:
`
Optional
[
Variant
[
String
,
Array
]]
`
Default
value
:
`
[]
`
#####
<
a
name
=
"after_create"
></
a
>
`
after_create
`
Data
type
:
`
Optional
[
String
]
`
Default
value
:
``
undef
``
#####
<
a
name
=
"remain_after_exit"
></
a
>
`
remain_after_exit
`
Data
type
:
`
Optional
[
String
]
`
Default
value
:
``
undef
``
#####
<
a
name
=
"prepare_service_only"
></
a
>
`
prepare_service_only
`
Data
type
:
`
Optional
[
Boolean
]
`
Default
value
:
``
false
``
#####
<
a
name
=
"image"
></
a
>
`
image
`
Data
type
:
`
Optional
[
Pattern
[/^[\
S
]*$/]]
`
#####
<
a
name
=
"ensure"
></
a
>
`
ensure
`
Data
type
:
`
Optional
[
Enum
[
present
,
absent
]]
`
Default
value
:
`'
present
'`
#####
<
a
name
=
"command"
></
a
>
`
command
`
Data
type
:
`
Optional
[
String
]
`
Default
value
:
``
undef
``
#####
<
a
name
=
"memory_limit"
></
a
>
`
memory_limit
`
Data
type
:
`
Optional
[
Pattern
[/^[\
d
]*(
b
|
k
|
m
|
g
)$/]]
`
Default
value
:
`'
0
b
'`
#####
<
a
name
=
"cpuset"
></
a
>
`
cpuset
`
Data
type
:
`
Variant
[
String
,
Array
,
Undef
]
`
Default
value
:
`
[]
`
#####
<
a
name
=
"ports"
></
a
>
`
ports
`
Data
type
:
`
Variant
[
String
,
Array
,
Undef
]
`
Default
value
:
`
[]
`
#####
<
a
name
=
"labels"
></
a
>
`
labels
`
Data
type
:
`
Variant
[
String
,
Array
,
Undef
]
`
Default
value
:
`
[]
`
#####
<
a
name
=
"expose"
></
a
>
`
expose
`
Data
type
:
`
Variant
[
String
,
Array
,
Undef
]
`
Default
value
:
`
[]
`
#####
<
a
name
=
"volumes"
></
a
>
`
volumes
`
Data
type
:
`
Variant
[
String
,
Array
,
Undef
]
`
Default
value
:
`
[]
`
#####
<
a
name
=
"links"
></
a
>
`
links
`
Data
type
:
`
Variant
[
String
,
Array
,
Undef
]
`
Default
value
:
`
[]
`
#####
<
a
name
=
"use_name"
></
a
>
`
use_name
`
Data
type
:
`
Optional
[
Boolean
]
`
Default
value
:
``
false
``
#####
<
a
name
=
"running"
></
a
>
`
running
`
Data
type
:
`
Optional
[
Boolean
]
`
Default
value
:
``
true
``
#####
<
a
name
=
"volumes_from"
></
a
>
`
volumes_from
`
Data
type
:
`
Optional
[
Variant
[
String
,
Array
]]
`
Default
value
:
`
[]
`
#####
<
a
name
=
"username"
></
a
>
`
username
`
Data
type
:
`
Variant
[
String
,
Boolean
]
`
Default
value
:
``
false
``
#####
<
a
name
=
"hostname"
></
a
>
`
hostname
`
Data
type
:
`
Variant
[
String
,
Boolean
]
`
Default
value
:
``
false
``
#####
<
a
name
=
"env"
></
a
>
`
env
`
Data
type
:
`
Optional
[
Variant
[
String
,
Array
]]
`
Default
value
:
`
[]
`
#####
<
a
name
=
"env_file"
></
a
>
`
env_file
`
Data
type
:
`
Optional
[
Variant
[
String
,
Array
]]
`
Default
value
:
`
[]
`
#####
<
a
name
=
"dns"
></
a
>
`
dns
`
Data
type
:
`
Optional
[
Variant
[
String
,
Array
]]
`
Default
value
:
`
[]
`
#####
<
a
name
=
"dns_search"
></
a
>
`
dns_search
`
Data
type
:
`
Optional
[
Variant
[
String
,
Array
]]
`
Default
value
:
`
[]
`
#####
<
a
name
=
"lxc_conf"
></
a
>
`
lxc_conf
`
Data
type
:
`
Optional
[
Variant
[
String
,
Array
]]
`
Default
value
:
`
[]
`
#####
<
a
name
=
"service_provider"
></
a
>
`
service_provider
`
Data
type
:
`
Optional
[
String
]
`
Default
value
:
``
undef
``
#####
<
a
name
=
"disable_network"
></
a
>
`
disable_network
`
Data
type
:
`
Optional
[
Boolean
]
`
Default
value
:
``
false
``
#####
<
a
name
=
"privileged"
></
a
>
`
privileged
`
Data
type
:
`
Optional
[
Boolean
]
`
Default
value
:
``
false
``
#####
<
a
name
=
"detach"
></
a
>
`
detach
`
Data
type
:
`
Optional
[
Boolean
]
`
Default
value
:
``
undef
``
#####
<
a
name
=
"extra_systemd_parameters"
></
a
>
`
extra_systemd_parameters
`
Data
type
:
`
Optional
[
Variant
[
String
,
Hash
]]
`
Default
value
:
`
{}
`
#####
<
a
name
=
"pull_on_start"
></
a
>
`
pull_on_start
`
Data
type
:
`
Optional
[
Boolean
]
`
Default
value
:
``
false
``
#####
<
a
name
=
"after"
></
a
>
`
after
`
Data
type
:
`
Optional
[
Variant
[
String
,
Array
]]
`
Default
value
:
`
[]
`
#####
<
a
name
=
"after_service"
></
a
>
`
after_service
`
Data
type
:
`
Optional
[
Variant
[
String
,
Array
]]
`
Default
value
:
`
[]
`
#####
<
a
name
=
"depends"
></
a
>
`
depends
`
Data
type
:
`
Optional
[
Variant
[
String
,
Array
]]
`
Default
value
:
`
[]
`
#####
<
a
name
=
"depend_services"
></
a
>
`
depend_services
`
Data
type
:
`
Optional
[
Variant
[
String
,
Array
]]
`
Default
value
:
`
[
'
docker
.
service
'
]
`
#####
<
a
name
=
"tty"
></
a
>
`
tty
`
Data
type
:
`
Optional
[
Boolean
]
`
Default
value
:
``
false
``
#####
<
a
name
=
"socket_connect"
></
a
>
`
socket_connect
`
Data
type
:
`
Optional
[
Variant
[
String
,
Array
]]
`
Default
value
:
`
[]
`
#####
<
a
name
=
"hostentries"
></
a
>
`
hostentries
`
Data
type
:
`
Optional
[
Variant
[
String
,
Array
]]
`
Default
value
:
`
[]
`
#####
<
a
name
=
"before_start"
></
a
>
`
before_start
`
Data
type
:
`
Variant
[
String
,
Boolean
]
`
Default
value
:
``
false
``
#####
<
a
name
=
"before_stop"
></
a
>
`
before_stop
`
Data
type
:
`
Variant
[
String
,
Boolean
]
`
Default
value
:
``
false
``
#####
<
a
name
=
"after_start"
></
a
>
`
after_start
`
Data
type
:
`
Variant
[
String
,
Boolean
]
`
Default
value
:
``
false
``
#####
<
a
name
=
"after_stop"
></
a
>
`
after_stop
`
Data
type
:
`
Variant
[
String
,
Boolean
]
`
Default
value
:
``
false
``
#####
<
a
name
=
"remove_container_on_start"
></
a
>
`
remove_container_on_start
`
Data
type
:
`
Optional
[
Boolean
]
`
Default
value
:
``
true
``
#####
<
a
name
=
"remove_container_on_stop"
></
a
>
`
remove_container_on_stop
`
Data
type
:
`
Optional
[
Boolean
]
`
Default
value
:
``
true
``
#####
<
a
name
=
"remove_volume_on_start"
></
a
>
`
remove_volume_on_start
`
Data
type
:
`
Optional
[
Boolean
]
`
Default
value
:
``
false
``
#####
<
a
name
=
"remove_volume_on_stop"
></
a
>
`
remove_volume_on_stop
`
Data
type
:
`
Optional
[
Boolean
]
`
Default
value
:
``
false
``
#####
<
a
name
=
"stop_wait_time"
></
a
>
`
stop_wait_time
`
Data
type
:
`
Optional
[
Integer
]
`
Default
value
:
`
0
`
#####
<
a
name
=
"syslog_identifier"
></
a
>
`
syslog_identifier
`
Data
type
:
`
Optional
[
String
]
`
Default
value
:
``
undef
``
#####
<
a
name
=
"read_only"
></
a
>
`
read_only
`
Data
type
:
`
Optional
[
Boolean
]
`
Default
value
:
``
false
``
###
<
a
name
=
"dockersecrets"
></
a
>
`
docker
::
secrets
`
The
docker
::
secrets
class
.
####
Parameters
The
following
parameters
are
available
in
the
`
docker
::
secrets
`
defined
type
:
*
[
`
ensure
`
](#
ensure
)
*
[
`
label
`
](#
label
)
*
[
`
secret_name
`
](#
secret_name
)
*
[
`
secret_path
`
](#
secret_path
)
#####
<
a
name
=
"ensure"
></
a
>
`
ensure
`
Data
type
:
`
Optional
[
Enum
[
present
,
absent
]]
`
Default
value
:
`'
present
'`
#####
<
a
name
=
"label"
></
a
>
`
label
`
Data
type
:
`
Optional
[
Variant
[
String
,
Array
]]
`
Default
value
:
`
[]
`
#####
<
a
name
=
"secret_name"
></
a
>
`
secret_name
`
Data
type
:
`
Optional
[
String
]
`
Default
value
:
``
undef
``
#####
<
a
name
=
"secret_path"
></
a
>
`
secret_path
`
Data
type
:
`
Optional
[
String
]
`
Default
value
:
``
undef
``
###
<
a
name
=
"dockerservices"
></
a
>
`
docker
::
services
`
define
that
managers
a
Docker
services
####
Parameters
The
following
parameters
are
available
in
the
`
docker
::
services
`
defined
type
:
*
[
`
ensure
`
](#
ensure
)
*
[
`
image
`
](#
image
)
*
[
`
detach
`
](#
detach
)
*
[
`
env
`
](#
env
)
*
[
`
label
`
](#
label
)
*
[
`
publish
`
](#
publish
)
*
[
`
replicas
`
](#
replicas
)
*
[
`
tty
`
](#
tty
)
*
[
`
user
`
](#
user
)
*
[
`
workdir
`
](#
workdir
)
*
[
`
extra_params
`
](#
extra_params
)
*
[
`
update
`
](#
update
)
*
[
`
scale
`
](#
scale
)
*
[
`
host_socket
`
](#
host_socket
)
*
[
`
registry_mirror
`
](#
registry_mirror
)
*
[
`
mounts
`
](#
mounts
)
*
[
`
networks
`
](#
networks
)
*
[
`
command
`
](#
command
)
*
[
`
create
`
](#
create
)
*
[
`
service_name
`
](#
service_name
)
#####
<
a
name
=
"ensure"
></
a
>
`
ensure
`
Data
type
:
`
Optional
[
Enum
[
present
,
absent
]]
`
This
ensures
that
the
service
is
present
or
not
.
Default
value
:
`'
present
'`
#####
<
a
name
=
"image"
></
a
>
`
image
`
Data
type
:
`
Optional
[
Variant
[
String
,
Array
]]
`
The
Docker
image
to
spwan
the
service
from
.
Default
value
:
``
undef
``
#####
<
a
name
=
"detach"
></
a
>
`
detach
`
Data
type
:
`
Optional
[
Boolean
]
`
Exit
immediately
instead
of
waiting
for
the
service
to
converge
(
default
true
)
Default
value
:
``
true
``
#####
<
a
name
=
"env"
></
a
>
`
env
`
Data
type
:
`
Optional
[
Array
]
`
Set
environment
variables
Default
value
:
`
[]
`
#####
<
a
name
=
"label"
></
a
>
`
label
`
Data
type
:
`
Optional
[
Array
]
`
Service
labels
.
This
used
as
metdata
to
configure
constraints
etc
.
Default
value
:
`
[]
`
#####
<
a
name
=
"publish"
></
a
>
`
publish
`
Data
type
:
`
Optional
[
Variant
[
String
,
Array
]]
`
Publish
port
(
s
)
as
node
ports
.
Default
value
:
``
undef
``
#####
<
a
name
=
"replicas"
></
a
>
`
replicas
`
Data
type
:
`
Optional
[
Variant
[
String
,
Array
]]
`
Number
of
tasks
(
containers
per
service
)
Default
value
:
``
undef
``
#####
<
a
name
=
"tty"
></
a
>
`
tty
`
Data
type
:
`
Optional
[
Boolean
]
`
Allocate
a
pseudo
-
TTY
Default
value
:
``
false
``
#####
<
a
name
=
"user"
></
a
>
`
user
`
Data
type
:
`
Optional
[
Variant
[
String
,
Array
]]
`
Username
or
UID
(
format
:
<
name
|
uid
>[:<
group
|
gid
>])
Default
value
:
``
undef
``
#####
<
a
name
=
"workdir"
></
a
>
`
workdir
`
Data
type
:
`
Optional
[
Variant
[
String
,
Array
]]
`
Working
directory
inside
the
container
Default
value
:
``
undef
``
#####
<
a
name
=
"extra_params"
></
a
>
`
extra_params
`
Data
type
:
`
Optional
[
Array
]
`
Allows
you
to
pass
any
other
flag
that
the
Docker
service
create
supports
.
This
must
be
passed
as
an
array
.
See
docker
service
create
--
help
for
all
options
Default
value
:
`
[]
`
#####
<
a
name
=
"update"
></
a
>
`
update
`
Data
type
:
`
Optional
[
Boolean
]
`
This
changes
the
docker
command
to
docker
service
update
,
you
must
pass
a
service
name
with
this
option
Default
value
:
``
false
``
#####
<
a
name
=
"scale"
></
a
>
`
scale
`
Data
type
:
`
Optional
[
Boolean
]
`
This
changes
the
docker
command
to
docker
service
scale
,
this
can
only
be
used
with
service
name
and
replicas
Default
value
:
``
false
``
#####
<
a
name
=
"host_socket"
></
a
>
`
host_socket
`
Data
type
:
`
Optional
[
Variant
[
String
,
Array
]]
`
This
will
allow
the
service
to
connect
to
the
host
linux
socket
.
Default
value
:
``
undef
``
#####
<
a
name
=
"registry_mirror"
></
a
>
`
registry_mirror
`
Data
type
:
`
Optional
[
Variant
[
String
,
Array
]]
`
This
will
allow
the
service
to
set
a
registry
mirror
.
Default
value
:
``
undef
``
#####
<
a
name
=
"mounts"
></
a
>
`
mounts
`
Data
type
:
`
Optional
[
Variant
[
String
,
Array
]]
`
Allows
attaching
filesystem
mounts
to
the
service
(
specified
as
an
array
)
Default
value
:
``
undef
``
#####
<
a
name
=
"networks"
></
a
>
`
networks
`
Data
type
:
`
Optional
[
Array
]
`
Allows
attaching
the
service
to
networks
(
specified
as
an
array
)
Default
value
:
``
undef
``
#####
<
a
name
=
"command"
></
a
>
`
command
`
Data
type
:
`
Optional
[
Variant
[
String
,
Array
]]
`
Command
to
run
on
the
container
Default
value
:
``
undef
``
#####
<
a
name
=
"create"
></
a
>
`
create
`
Data
type
:
`
Optional
[
Boolean
]
`
Default
value
:
``
true
``
#####
<
a
name
=
"service_name"
></
a
>
`
service_name
`
Data
type
:
`
Optional
[
Variant
[
String
,
Array
]]
`
Default
value
:
``
undef
``
###
<
a
name
=
"dockerstack"
></
a
>
`
docker
::
stack
`
deploys
Docker
stacks
or
compose
v3
####
Parameters
The
following
parameters
are
available
in
the
`
docker
::
stack
`
defined
type
:
*
[
`
ensure
`
](#
ensure
)
*
[
`
stack_name
`
](#
stack_name
)
*
[
`
bundle_file
`
](#
bundle_file
)
*
[
`
prune
`
](#
prune
)
*
[
`
resolve_image
`
](#
resolve_image
)
*
[
`
with_registry_auth
`
](#
with_registry_auth
)
*
[
`
compose_files
`
](#
compose_files
)
#####
<
a
name
=
"ensure"
></
a
>
`
ensure
`
Data
type
:
`
Optional
[
Enum
[
present
,
absent
]]
`
This
ensures
that
the
stack
is
present
or
not
.
Default
value
:
`'
present
'`
#####
<
a
name
=
"stack_name"
></
a
>
`
stack_name
`
Data
type
:
`
Optional
[
String
]
`
The
name
of
the
stack
that
you
are
deploying
Default
value
:
``
undef
``
#####
<
a
name
=
"bundle_file"
></
a
>
`
bundle_file
`
Data
type
:
`
Optional
[
String
]
`
Path
to
a
Distributed
Application
Bundle
file
Please
note
this
is
experimental
Default
value
:
``
undef
``
#####
<
a
name
=
"prune"
></
a
>
`
prune
`
Data
type
:
`
Optional
[
Boolean
]
`
Prune
services
that
are
no
longer
referenced
Default
value
:
``
false
``
#####
<
a
name
=
"resolve_image"
></
a
>
`
resolve_image
`
Data
type
:
`
Optional
[
Enum
[
'
always
','
changed
','
never
'
]]
`
Query
the
registry
to
resolve
image
digest
and
supported
platforms
Only
accepts
(
"always"
|
"changed"
|
"never"
)
Default
value
:
``
undef
``
#####
<
a
name
=
"with_registry_auth"
></
a
>
`
with_registry_auth
`
Data
type
:
`
Optional
[
Boolean
]
`
Send
registry
authentication
details
to
Swarm
agents
Default
value
:
``
false
``
#####
<
a
name
=
"compose_files"
></
a
>
`
compose_files
`
Data
type
:
`
Optional
[
Array
]
`
Default
value
:
``
undef
``
###
<
a
name
=
"dockerswarm"
></
a
>
`
docker
::
swarm
`
managers
a
Docker
Swarm
Mode
cluster
####
Parameters
The
following
parameters
are
available
in
the
`
docker
::
swarm
`
defined
type
:
*
[
`
ensure
`
](#
ensure
)
*
[
`
init
`
](#
init
)
*
[
`
join
`
](#
join
)
*
[
`
advertise_addr
`
](#
advertise_addr
)
*
[
`
autolock
`
](#
autolock
)
*
[
`
cert_expiry
`
](#
cert_expiry
)
*
[
`
default_addr_pool
`
](#
default_addr_pool
)
*
[
`
default_addr_pool_mask_length
`
](#
default_addr_pool_mask_length
)
*
[
`
dispatcher_heartbeat
`
](#
dispatcher_heartbeat
)
*
[
`
external_ca
`
](#
external_ca
)
*
[
`
force_new_cluster
`
](#
force_new_cluster
)
*
[
`
listen_addr
`
](#
listen_addr
)
*
[
`
max_snapshots
`
](#
max_snapshots
)
*
[
`
snapshot_interval
`
](#
snapshot_interval
)
*
[
`
token
`
](#
token
)
*
[
`
manager_ip
`
](#
manager_ip
)
#####
<
a
name
=
"ensure"
></
a
>
`
ensure
`
Data
type
:
`
Optional
[
Enum
[
present
,
absent
]]
`
This
ensures
that
the
cluster
is
present
or
not
.
Note
this
forcefully
removes
a
node
from
the
cluster
.
Make
sure
all
worker
nodes
have
been
removed
before
managers
Default
value
:
`'
present
'`
#####
<
a
name
=
"init"
></
a
>
`
init
`
Data
type
:
`
Optional
[
Boolean
]
`
This
creates
the
first
worker
node
for
a
new
cluster
.
Set
init
to
true
to
create
a
new
cluster
Default
value
:
``
false
``
#####
<
a
name
=
"join"
></
a
>
`
join
`
Data
type
:
`
Optional
[
Boolean
]
`
This
adds
either
a
worker
or
manger
node
to
the
cluster
.
The
role
of
the
node
is
defined
by
the
join
token
.
Set
to
true
to
join
the
cluster
Default
value
:
``
false
``
#####
<
a
name
=
"advertise_addr"
></
a
>
`
advertise_addr
`
Data
type
:
`
Optional
[
String
]
`
The
address
that
your
node
will
advertise
to
the
cluster
for
raft
.
On
multihomed
servers
this
flag
must
be
passed
Default
value
:
``
undef
``
#####
<
a
name
=
"autolock"
></
a
>
`
autolock
`
Data
type
:
`
Optional
[
Boolean
]
`
Enable
manager
autolocking
(
requiring
an
unlock
key
to
start
a
stopped
manager
)
Default
value
:
``
false
``
#####
<
a
name
=
"cert_expiry"
></
a
>
`
cert_expiry
`
Data
type
:
`
Optional
[
String
]
`
Validity
period
for
node
certificates
(
ns
|
us
|
ms
|
s
|
m
|
h
)
(
default
2160
h0m0s
)
Default
value
:
``
undef
``
#####
<
a
name
=
"default_addr_pool"
></
a
>
`
default_addr_pool
`
Data
type
:
`
Optional
[
Array
]
`
Array
of
default
subnet
pools
for
global
scope
networks
([
'
30.30
.
0.0
/
16
','
40.40
.
0.0
/
16
'
])
Default
value
:
``
undef
``
#####
<
a
name
=
"default_addr_pool_mask_length"
></
a
>
`
default_addr_pool_mask_length
`
Data
type
:
`
Optional
[
String
]
`
Default
subnet
pools
mask
length
for
default
-
addr
-
pools
(
CIDR
block
number
)
Default
value
:
``
undef
``
#####
<
a
name
=
"dispatcher_heartbeat"
></
a
>
`
dispatcher_heartbeat
`
Data
type
:
`
Optional
[
String
]
`
Dispatcher
heartbeat
period
(
ns
|
us
|
ms
|
s
|
m
|
h
)
(
default
5
s
)
Default
value
:
``
undef
``
#####
<
a
name
=
"external_ca"
></
a
>
`
external_ca
`
Data
type
:
`
Optional
[
String
]
`
Specifications
of
one
or
more
certificate
signing
endpoints
Default
value
:
``
undef
``
#####
<
a
name
=
"force_new_cluster"
></
a
>
`
force_new_cluster
`
Data
type
:
`
Optional
[
Boolean
]
`
Force
create
a
new
cluster
from
current
state
Default
value
:
``
false
``
#####
<
a
name
=
"listen_addr"
></
a
>
`
listen_addr
`
Data
type
:
`
Optional
[
String
]
`
The
address
that
your
node
will
listen
to
the
cluster
for
raft
.
On
multihomed
servers
this
flag
must
be
passed
Default
value
:
``
undef
``
#####
<
a
name
=
"max_snapshots"
></
a
>
`
max_snapshots
`
Data
type
:
`
Optional
[
String
]
`
Number
of
additional
Raft
snapshots
to
retain
Default
value
:
``
undef
``
#####
<
a
name
=
"snapshot_interval"
></
a
>
`
snapshot_interval
`
Data
type
:
`
Optional
[
String
]
`
Number
of
log
entries
between
Raft
snapshots
(
default
10000
)
Default
value
:
``
undef
``
#####
<
a
name
=
"token"
></
a
>
`
token
`
Data
type
:
`
Optional
[
String
]
`
The
authentication
token
to
join
the
cluster
.
The
token
also
defines
the
type
of
node
(
worker
or
manager
)
Default
value
:
``
undef
``
#####
<
a
name
=
"manager_ip"
></
a
>
`
manager_ip
`
Data
type
:
`
Optional
[
String
]
`
The
ip
address
of
a
manager
node
to
join
the
cluster
.
Default
value
:
``
undef
``
###
<
a
name
=
"dockersystem_user"
></
a
>
`
docker
::
system_user
`
manage
docker
group
users
####
Parameters
The
following
parameters
are
available
in
the
`
docker
::
system_user
`
defined
type
:
*
[
`
create_user
`
](#
create_user
)
#####
<
a
name
=
"create_user"
></
a
>
`
create_user
`
Data
type
:
`
Any
`
Boolean
to
cotrol
whether
the
user
should
be
created
Default
value
:
``
true
``
###
<
a
name
=
"dockerwindows_account"
></
a
>
`
docker
::
windows_account
`
Windows
account
that
owns
the
docker
services
##
Resource
types
###
<
a
name
=
"docker_compose"
></
a
>
`
docker_compose
`
A
type
representing
a
Docker
Compose
file
####
Properties
The
following
properties
are
available
in
the
`
docker_compose
`
type
.
#####
`
ensure
`
Valid
values
:
`
present
`
,
`
absent
`
The
basic
property
that
the
resource
should
be
in
.
Default
value
:
`
present
`
####
Parameters
The
following
parameters
are
available
in
the
`
docker_compose
`
type
.
*
[
`
compose_files
`
](#
compose_files
)
*
[
`
name
`
](#
name
)
*
[
`
options
`
](#
options
)
*
[
`
provider
`
](#
provider
)
*
[
`
scale
`
](#
scale
)
*
[
`
up_args
`
](#
up_args
)
#####
<
a
name
=
"compose_files"
></
a
>
`
compose_files
`
An
array
of
Docker
Compose
Files
paths
.
#####
<
a
name
=
"name"
></
a
>
`
name
`
namevar
The
name
of
the
project
#####
<
a
name
=
"options"
></
a
>
`
options
`
Additional
options
to
be
passed
directly
to
docker
-
compose
.
#####
<
a
name
=
"provider"
></
a
>
`
provider
`
The
specific
backend
to
use
for
this
`
docker_compose
`
resource
.
You
will
seldom
need
to
specify
this
---
Puppet
will
usually
discover
the
appropriate
provider
for
your
platform
.
#####
<
a
name
=
"scale"
></
a
>
`
scale
`
A
hash
of
compose
services
and
number
of
containers
.
#####
<
a
name
=
"up_args"
></
a
>
`
up_args
`
Arguments
to
be
passed
directly
to
docker
-
compose
up
.
###
<
a
name
=
"docker_network"
></
a
>
`
docker_network
`
Type
representing
a
Docker
network
####
Properties
The
following
properties
are
available
in
the
`
docker_network
`
type
.
#####
`
driver
`
The
network
driver
used
by
the
network
#####
`
ensure
`
Valid
values
:
`
present
`
,
`
absent
`
The
basic
property
that
the
resource
should
be
in
.
Default
value
:
`
present
`
#####
`
id
`
The
ID
of
the
network
provided
by
Docker
#####
`
ipam_driver
`
The
IPAM
(
IP
Address
Management
)
driver
####
Parameters
The
following
parameters
are
available
in
the
`
docker_network
`
type
.
*
[
`
additional_flags
`
](#
additional_flags
)
*
[
`
aux_address
`
](#
aux_address
)
*
[
`
gateway
`
](#
gateway
)
*
[
`
ip_range
`
](#
ip_range
)
*
[
`
name
`
](#
name
)
*
[
`
options
`
](#
options
)
*
[
`
provider
`
](#
provider
)
*
[
`
subnet
`
](#
subnet
)
#####
<
a
name
=
"additional_flags"
></
a
>
`
additional_flags
`
Additional
flags
for
the
'
docker
network
create
'
#####
<
a
name
=
"aux_address"
></
a
>
`
aux_address
`
Auxiliary
ipv4
or
ipv6
addresses
used
by
the
Network
driver
#####
<
a
name
=
"gateway"
></
a
>
`
gateway
`
An
ipv4
or
ipv6
gateway
for
the
server
subnet
#####
<
a
name
=
"ip_range"
></
a
>
`
ip_range
`
The
range
of
IP
addresses
used
by
the
network
#####
<
a
name
=
"name"
></
a
>
`
name
`
namevar
The
name
of
the
network
#####
<
a
name
=
"options"
></
a
>
`
options
`
Additional
options
for
the
network
driver
#####
<
a
name
=
"provider"
></
a
>
`
provider
`
The
specific
backend
to
use
for
this
`
docker_network
`
resource
.
You
will
seldom
need
to
specify
this
---
Puppet
will
usually
discover
the
appropriate
provider
for
your
platform
.
#####
<
a
name
=
"subnet"
></
a
>
`
subnet
`
The
subnet
in
CIDR
format
that
represents
a
network
segment
###
<
a
name
=
"docker_stack"
></
a
>
`
docker_stack
`
A
type
representing
a
Docker
Stack
####
Properties
The
following
properties
are
available
in
the
`
docker_stack
`
type
.
#####
`
ensure
`
Valid
values
:
`
present
`
,
`
absent
`
The
basic
property
that
the
resource
should
be
in
.
Default
value
:
`
present
`
####
Parameters
The
following
parameters
are
available
in
the
`
docker_stack
`
type
.
*
[
`
bundle_file
`
](#
bundle_file
)
*
[
`
compose_files
`
](#
compose_files
)
*
[
`
name
`
](#
name
)
*
[
`
provider
`
](#
provider
)
*
[
`
up_args
`
](#
up_args
)
#####
<
a
name
=
"bundle_file"
></
a
>
`
bundle_file
`
Path
to
a
Distributed
Application
Bundle
file
.
#####
<
a
name
=
"compose_files"
></
a
>
`
compose_files
`
An
array
of
Docker
Compose
Files
paths
.
#####
<
a
name
=
"name"
></
a
>
`
name
`
namevar
The
name
of
the
stack
#####
<
a
name
=
"provider"
></
a
>
`
provider
`
The
specific
backend
to
use
for
this
`
docker_stack
`
resource
.
You
will
seldom
need
to
specify
this
---
Puppet
will
usually
discover
the
appropriate
provider
for
your
platform
.
#####
<
a
name
=
"up_args"
></
a
>
`
up_args
`
Arguments
to
be
passed
directly
to
docker
stack
deploy
.
###
<
a
name
=
"docker_volume"
></
a
>
`
docker_volume
`
A
type
representing
a
Docker
volume
####
Properties
The
following
properties
are
available
in
the
`
docker_volume
`
type
.
#####
`
driver
`
The
volume
driver
used
by
the
volume
#####
`
ensure
`
Valid
values
:
`
present
`
,
`
absent
`
The
basic
property
that
the
resource
should
be
in
.
Default
value
:
`
present
`
#####
`
mountpoint
`
The
location
that
the
volume
is
mounted
to
####
Parameters
The
following
parameters
are
available
in
the
`
docker_volume
`
type
.
*
[
`
name
`
](#
name
)
*
[
`
options
`
](#
options
)
*
[
`
provider
`
](#
provider
)
#####
<
a
name
=
"name"
></
a
>
`
name
`
namevar
The
name
of
the
volume
#####
<
a
name
=
"options"
></
a
>
`
options
`
Additional
options
for
the
volume
driver
#####
<
a
name
=
"provider"
></
a
>
`
provider
`
The
specific
backend
to
use
for
this
`
docker_volume
`
resource
.
You
will
seldom
need
to
specify
this
---
Puppet
will
usually
discover
the
appropriate
provider
for
your
platform
.
##
Functions
###
<
a
name
=
"dockersanitised_name"
></
a
>
`
docker
::
sanitised_name
`
Type
:
Puppet
Language
==
Function
:
docker
::
sanitised_name
Function
to
sanitise
container
name
.
===
Parameters
[*
name
*]
Name
to
sanitise
####
`
docker
::
sanitised_name
(
Any
$
name
)
`
==
Function
:
docker
::
sanitised_name
Function
to
sanitise
container
name
.
===
Parameters
[*
name
*]
Name
to
sanitise
Returns
:
`
Any
`
#####
`
name
`
Data
type
:
`
Any
`
###
<
a
name
=
"docker_exec_flags"
></
a
>
`
docker_exec_flags
`
Type
:
Ruby
3
.
x
API
Transforms
a
hash
into
a
string
of
docker
exec
flags
####
`
docker_exec_flags
()
`
Transforms
a
hash
into
a
string
of
docker
exec
flags
Returns
:
`
Any
`
###
<
a
name
=
"docker_params_changed"
></
a
>
`
docker_params_changed
`
Type
:
Ruby
4
.
x
API
The
docker_params_changed
function
.
####
`
docker_params_changed
(
Hash
$
opts
)
`
The
docker_params_changed
function
.
Returns
:
`
String
`
#####
`
opts
`
Data
type
:
`
Hash
`
###
<
a
name
=
"docker_plugin_enable_flags"
></
a
>
`
docker_plugin_enable_flags
`
Type
:
Ruby
3
.
x
API
Transforms
a
hash
into
a
string
of
docker
plugin
remove
flags
####
`
docker_plugin_enable_flags
()
`
Transforms
a
hash
into
a
string
of
docker
plugin
remove
flags
Returns
:
`
Any
`
###
<
a
name
=
"docker_plugin_install_flags"
></
a
>
`
docker_plugin_install_flags
`
Type
:
Ruby
3
.
x
API
Transforms
a
hash
into
a
string
of
docker
plugin
install
flags
####
`
docker_plugin_install_flags
()
`
Transforms
a
hash
into
a
string
of
docker
plugin
install
flags
Returns
:
`
Any
`
###
<
a
name
=
"docker_plugin_remove_flags"
></
a
>
`
docker_plugin_remove_flags
`
Type
:
Ruby
3
.
x
API
Transforms
a
hash
into
a
string
of
docker
plugin
remove
flags
####
`
docker_plugin_remove_flags
()
`
Transforms
a
hash
into
a
string
of
docker
plugin
remove
flags
Returns
:
`
Any
`
###
<
a
name
=
"docker_run_flags"
></
a
>
`
docker_run_flags
`
Type
:
Ruby
3
.
x
API
Transforms
a
hash
into
a
string
of
docker
flags
####
`
docker_run_flags
()
`
Transforms
a
hash
into
a
string
of
docker
flags
Returns
:
`
Any
`
###
<
a
name
=
"docker_secrets_flags"
></
a
>
`
docker_secrets_flags
`
Type
:
Ruby
3
.
x
API
Transforms
a
hash
into
a
string
of
docker
swarm
init
flags
####
`
docker_secrets_flags
()
`
Transforms
a
hash
into
a
string
of
docker
swarm
init
flags
Returns
:
`
Any
`
###
<
a
name
=
"docker_service_flags"
></
a
>
`
docker_service_flags
`
Type
:
Ruby
3
.
x
API
Transforms
a
hash
into
a
string
of
docker
swarm
init
flags
####
`
docker_service_flags
()
`
Transforms
a
hash
into
a
string
of
docker
swarm
init
flags
Returns
:
`
Any
`
###
<
a
name
=
"docker_stack_flags"
></
a
>
`
docker_stack_flags
`
Type
:
Ruby
3
.
x
API
Transforms
a
hash
into
a
string
of
docker
stack
flags
####
`
docker_stack_flags
()
`
Transforms
a
hash
into
a
string
of
docker
stack
flags
Returns
:
`
Any
`
###
<
a
name
=
"docker_swarm_init_flags"
></
a
>
`
docker_swarm_init_flags
`
Type
:
Ruby
3
.
x
API
Transforms
a
hash
into
a
string
of
docker
swarm
init
flags
####
`
docker_swarm_init_flags
()
`
Transforms
a
hash
into
a
string
of
docker
swarm
init
flags
Returns
:
`
Any
`
###
<
a
name
=
"docker_swarm_join_flags"
></
a
>
`
docker_swarm_join_flags
`
Type
:
Ruby
3
.
x
API
Transforms
a
hash
into
a
string
of
docker
swarm
init
flags
####
`
docker_swarm_join_flags
()
`
Transforms
a
hash
into
a
string
of
docker
swarm
init
flags
Returns
:
`
Any
`
##
Tasks
###
<
a
name
=
"node_ls"
></
a
>
`
node_ls
`
List
nodes
in
the
swarm
**
Supports
noop
?**
false
####
Parameters
#####
`
filter
`
Data
type
:
`
Optional
[
String
[
1
]]
`
Filter
output
based
on
conditions
provided
#####
`
quiet
`
Data
type
:
`
Optional
[
Boolean
]
`
Only
display
IDs
###
<
a
name
=
"node_rm"
></
a
>
`
node_rm
`
Update
a
node
**
Supports
noop
?**
false
####
Parameters
#####
`
force
`
Data
type
:
`
Optional
[
Boolean
]
`
Force
remove
a
node
from
the
swarm
#####
`
node
`
Data
type
:
`
String
[
1
]
`
Hostname
or
ID
of
the
node
in
the
swarm
###
<
a
name
=
"node_update"
></
a
>
`
node_update
`
Update
a
node
**
Supports
noop
?**
false
####
Parameters
#####
`
availability
`
Data
type
:
`
Optional
[
Enum
[
'
active
'
,
'
pause
'
,
'
drain
'
]]
`
Availability
of
the
node
#####
`
role
`
Data
type
:
`
Optional
[
Enum
[
'
manager
'
,
'
worker
'
]]
`
Role
of
the
node
#####
`
label_add
`
Data
type
:
`
Optional
[
Array
]
`
Add
or
update
a
node
label
(
key
=
value
)
#####
`
label_rm
`
Data
type
:
`
Optional
[
Array
]
`
Remove
a
node
label
if
exists
.
#####
`
node
`
Data
type
:
`
String
[
1
]
`
ID
of
the
node
in
the
swarm
###
<
a
name
=
"service_create"
></
a
>
`
service_create
`
Create
a
new
Docker
service
**
Supports
noop
?**
false
####
Parameters
#####
`
service
`
Data
type
:
`
String
[
1
]
`
The
name
of
the
service
to
create
#####
`
image
`
Data
type
:
`
String
[
1
]
`
The
new
image
to
use
for
the
service
#####
`
replicas
`
Data
type
:
`
Integer
`
Number
of
replicas
#####
`
expose
`
Data
type
:
`
Variant
[
String
,
Array
,
Undef
]
`
Publish
service
ports
externally
to
the
swarm
#####
`
env
`
Data
type
:
`
Optional
[
Hash
]
`
Set
environment
variables
#####
`
command
`
Data
type
:
`
Variant
[
String
,
Array
,
Undef
]
`
Command
to
run
on
the
container
#####
`
extra_params
`
Data
type
:
`
Optional
[
Array
]
`
Allows
you
to
pass
any
other
flag
that
the
Docker
service
create
supports
.
#####
`
detach
`
Data
type
:
`
Optional
[
Boolean
]
`
Exit
immediately
instead
of
waiting
for
the
service
to
converge
###
<
a
name
=
"service_rm"
></
a
>
`
service_rm
`
Remove
one
replicated
service
**
Supports
noop
?**
false
####
Parameters
#####
`
service
`
Data
type
:
`
String
[
1
]
`
Name
or
ID
of
the
service
###
<
a
name
=
"service_scale"
></
a
>
`
service_scale
`
Scale
one
replicated
service
**
Supports
noop
?**
false
####
Parameters
#####
`
service
`
Data
type
:
`
String
[
1
]
`
Name
or
ID
of
the
service
#####
`
scale
`
Data
type
:
`
Integer
`
Number
of
replicas
#####
`
detach
`
Data
type
:
`
Optional
[
Boolean
]
`
Exit
immediately
instead
of
waiting
for
the
service
to
converge
###
<
a
name
=
"service_update"
></
a
>
`
service_update
`
Updates
an
existing
service
.
**
Supports
noop
?**
false
####
Parameters
#####
`
service
`
Data
type
:
`
String
[
1
]
`
The
service
to
update
#####
`
image
`
Data
type
:
`
String
[
1
]
`
The
new
image
to
use
for
the
service
#####
`
constraint_add
`
Data
type
:
`
Optional
[
Array
]
`
Add
or
update
a
service
constraint
(
selector
==
value
,
selector
!=
value
)
#####
`
constraint_rm
`
Data
type
:
`
Optional
[
Array
]
`
Remove
a
service
constraint
if
exists
.
###
<
a
name
=
"swarm_init"
></
a
>
`
swarm_init
`
Initializes
a
swarm
**
Supports
noop
?**
false
####
Parameters
#####
`
advertise_addr
`
Data
type
:
`
Optional
[
String
[
1
]]
`
Advertised
address
#####
`
autolock
`
Data
type
:
`
Optional
[
Boolean
]
`
Enable
manager
autolocking
#####
`
cert_expiry
`
Data
type
:
`
Optional
[
String
[
1
]]
`
Validity
period
for
node
certificates
#####
`
dispatcher_heartbeat
`
Data
type
:
`
Optional
[
String
[
1
]]
`
Dispatcher
heartbeat
period
#####
`
external_ca
`
Data
type
:
`
Optional
[
String
[
1
]]
`
Specifications
of
one
or
more
certificate
signing
endpoints
#####
`
force_new_cluster
`
Data
type
:
`
Optional
[
Boolean
]
`
Force
create
a
new
cluster
from
current
state
#####
`
listen_addr
`
Data
type
:
`
Optional
[
String
[
1
]]
`
Listen
address
#####
`
max_snapshots
`
Data
type
:
`
Optional
[
Integer
[
1
]]
`
Number
of
additional
Raft
snapshots
to
retain
#####
`
snapshot_interval
`
Data
type
:
`
Optional
[
Integer
[
1
]]
`
Number
of
log
entries
between
Raft
snapshots
###
<
a
name
=
"swarm_join"
></
a
>
`
swarm_join
`
Join
a
swarm
**
Supports
noop
?**
false
####
Parameters
#####
`
advertise_addr
`
Data
type
:
`
Optional
[
String
[
1
]]
`
Advertised
address
#####
`
listen_addr
`
Data
type
:
`
Optional
[
String
[
1
]]
`
Listen
address
#####
`
token
`
Data
type
:
`
String
[
1
]
`
Join
token
for
the
swarm
#####
`
manager_ip
`
Data
type
:
`
String
[
1
]
`
IP
Address
of
the
swarm
manager
###
<
a
name
=
"swarm_leave"
></
a
>
`
swarm_leave
`
Leave
a
swarm
**
Supports
noop
?**
false
####
Parameters
#####
`
force
`
Data
type
:
`
Optional
[
Boolean
]
`
Force
this
node
to
leave
the
swarm
,
ignoring
warnings
###
<
a
name
=
"swarm_token"
></
a
>
`
swarm_token
`
Gets
the
swarm
token
from
the
server
**
Supports
noop
?**
false
####
Parameters
#####
`
node_role
`
Data
type
:
`
String
[
1
]
`
The
role
of
the
node
joining
the
swarm
###
<
a
name
=
"swarm_update"
></
a
>
`
swarm_update
`
Updates
an
existing
service
.
**
Supports
noop
?**
false
####
Parameters
#####
`
service
`
Data
type
:
`
String
[
1
]
`
The
service
to
update
#####
`
image
`
Data
type
:
`
String
[
1
]
`
The
new
image
to
use
for
the
service
File Metadata
Details
Attached
Mime Type
text/plain
Expires
Jun 4 2025, 6:51 PM (11 w, 5 d ago)
Storage Engine
blob
Storage Format
Raw Data
Storage Handle
3306564
Attached To
R205 puppet-puppetlabs-docker
Event Timeline
Log In to Comment