From cbf1aa83fdd86572319854196dc5d6290ad06df5 Mon Sep 17 00:00:00 2001 From: GitHub Actions Date: Fri, 28 Apr 2023 15:43:46 +0000 Subject: [PATCH] Release prep v6.1.0 --- CHANGELOG.md | 380 +-------- REFERENCE.md | 2188 ++++++++++++++++++++++++------------------------- metadata.json | 2 +- 3 files changed, 1108 insertions(+), 1462 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 6746f932..57b929ca 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,13 +2,29 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](http://semver.org). -## [v6.0.2](/~https://github.com/puppetlabs/puppetlabs-docker/tree/v6.0.2) (2022-12-07) +## [v6.1.0](/~https://github.com/puppetlabs/puppetlabs-docker/tree/v6.1.0) (2023-04-28) + +[Full Changelog](/~https://github.com/puppetlabs/puppetlabs-docker/compare/v6.0.2...v6.1.0) + +### Added + +- \(CONT-351\) Syntax update [\#901](/~https://github.com/puppetlabs/puppetlabs-docker/pull/901) ([LukasAud](/~https://github.com/LukasAud)) + +### Fixed + +- Fix `docker` fact with recent version of docker [\#897](/~https://github.com/puppetlabs/puppetlabs-docker/pull/897) ([smortex](/~https://github.com/smortex)) + +### UNCATEGORIZED PRS; LABEL THEM ON GITHUB + +- Use puppet yaml helper to workaround psych \>4 breaking changes [\#877](/~https://github.com/puppetlabs/puppetlabs-docker/pull/877) ([gfargeas](/~https://github.com/gfargeas)) + +## [v6.0.2](/~https://github.com/puppetlabs/puppetlabs-docker/tree/v6.0.2) (2022-12-08) [Full Changelog](/~https://github.com/puppetlabs/puppetlabs-docker/compare/v6.0.1...v6.0.2) ### Fixed -- \(CONT-24\) docker_stack always redoploying [\#878](/~https://github.com/puppetlabs/puppetlabs-docker/pull/878) ([david22swan](/~https://github.com/david22swan)) +- \(CONT-24\) docker\_stack always redoploying [\#878](/~https://github.com/puppetlabs/puppetlabs-docker/pull/878) ([david22swan](/~https://github.com/david22swan)) ## [v6.0.1](/~https://github.com/puppetlabs/puppetlabs-docker/tree/v6.0.1) (2022-11-25) @@ -39,7 +55,7 @@ All notable changes to this project will be documented in this file. The format ### Fixed - pdksync - \(CONT-130\) Dropping Support for Debian 9 [\#859](/~https://github.com/puppetlabs/puppetlabs-docker/pull/859) ([jordanbreen28](/~https://github.com/jordanbreen28)) -- Change `stop_wait_time` value to match Docker default [\#858](/~https://github.com/puppetlabs/puppetlabs-docker/pull/858) ([sebcdri](/~https://github.com/sebcdri)) +- Change `stop\_wait\_time` value to match Docker default [\#858](/~https://github.com/puppetlabs/puppetlabs-docker/pull/858) ([sebcdri](/~https://github.com/sebcdri)) ## [v5.0.0](/~https://github.com/puppetlabs/puppetlabs-docker/tree/v5.0.0) (2022-08-19) @@ -318,6 +334,7 @@ All notable changes to this project will be documented in this file. The format - :bug: Fix wrong service detach handling [\#520](/~https://github.com/puppetlabs/puppetlabs-docker/pull/520) ([khaefeli](/~https://github.com/khaefeli)) - Fixing error: [\#516](/~https://github.com/puppetlabs/puppetlabs-docker/pull/516) ([darshannnn](/~https://github.com/darshannnn)) - Fix aliased plugin names [\#514](/~https://github.com/puppetlabs/puppetlabs-docker/pull/514) ([koshatul](/~https://github.com/koshatul)) +- Fix \#239 local\_user permission denied [\#497](/~https://github.com/puppetlabs/puppetlabs-docker/pull/497) ([thde](/~https://github.com/thde)) ## [v3.7.0-bna](/~https://github.com/puppetlabs/puppetlabs-docker/tree/v3.7.0-bna) (2019-08-08) @@ -352,7 +369,6 @@ All notable changes to this project will be documented in this file. The format ### Fixed - Tasks frozen string [\#499](/~https://github.com/puppetlabs/puppetlabs-docker/pull/499) ([khaefeli](/~https://github.com/khaefeli)) -- Fix \#239 local\_user permission denied [\#497](/~https://github.com/puppetlabs/puppetlabs-docker/pull/497) ([thde](/~https://github.com/thde)) - \(MODULES-9193\) Revert part of MODULES-9177 [\#490](/~https://github.com/puppetlabs/puppetlabs-docker/pull/490) ([eimlav](/~https://github.com/eimlav)) - \(MODULES-9177\) Fix version validation regex [\#489](/~https://github.com/puppetlabs/puppetlabs-docker/pull/489) ([eimlav](/~https://github.com/eimlav)) - Fix publish flag being erroneously added to docker service commands [\#471](/~https://github.com/puppetlabs/puppetlabs-docker/pull/471) ([twistedduck](/~https://github.com/twistedduck)) @@ -360,362 +376,6 @@ All notable changes to this project will be documented in this file. The format - Allow images tagged latest to update on each run [\#468](/~https://github.com/puppetlabs/puppetlabs-docker/pull/468) ([electrofelix](/~https://github.com/electrofelix)) - Fix docker::image to not run images [\#465](/~https://github.com/puppetlabs/puppetlabs-docker/pull/465) ([hugotanure](/~https://github.com/hugotanure)) -## [3.5.0](/~https://github.com/puppetlabs/puppetlabs-docker/tree/3.5.0) (2019-03-14) - -[Full Changelog](/~https://github.com/puppetlabs/puppetlabs-docker/compare/3.4.0...3.5.0) - -### UNCATEGORIZED PRS; LABEL THEM ON GITHUB - -- release 3.5.0 [\#458](/~https://github.com/puppetlabs/puppetlabs-docker/pull/458) ([davejrt](/~https://github.com/davejrt)) -- fix\(syntax\): Remove duplicate parenthesis [\#454](/~https://github.com/puppetlabs/puppetlabs-docker/pull/454) ([jfroche](/~https://github.com/jfroche)) -- making dependency ranges more logical [\#453](/~https://github.com/puppetlabs/puppetlabs-docker/pull/453) ([davejrt](/~https://github.com/davejrt)) -- Docker::Services:: fix command parameter used with an array [\#452](/~https://github.com/puppetlabs/puppetlabs-docker/pull/452) ([jacksgt](/~https://github.com/jacksgt)) -- adding in capability to attach multiple networks to container [\#451](/~https://github.com/puppetlabs/puppetlabs-docker/pull/451) ([davejrt](/~https://github.com/davejrt)) -- Docker::Services: Add networks parameter for swarm services [\#450](/~https://github.com/puppetlabs/puppetlabs-docker/pull/450) ([jacksgt](/~https://github.com/jacksgt)) -- Add ability to set service\_after\_override to false [\#448](/~https://github.com/puppetlabs/puppetlabs-docker/pull/448) ([esalberg](/~https://github.com/esalberg)) -- docker::services: Fix using multiple published ports [\#447](/~https://github.com/puppetlabs/puppetlabs-docker/pull/447) ([jacksgt](/~https://github.com/jacksgt)) -- Add ability to override After for docker.service [\#446](/~https://github.com/puppetlabs/puppetlabs-docker/pull/446) ([esalberg](/~https://github.com/esalberg)) - -## [3.4.0](/~https://github.com/puppetlabs/puppetlabs-docker/tree/3.4.0) (2019-02-25) - -[Full Changelog](/~https://github.com/puppetlabs/puppetlabs-docker/compare/e2.0...3.4.0) - -### UNCATEGORIZED PRS; LABEL THEM ON GITHUB - -- adding in documentation for use of stack type/provider [\#443](/~https://github.com/puppetlabs/puppetlabs-docker/pull/443) ([davejrt](/~https://github.com/davejrt)) -- release for v3.4.0 [\#442](/~https://github.com/puppetlabs/puppetlabs-docker/pull/442) ([davejrt](/~https://github.com/davejrt)) -- Add docker socket group overrides for systemd \(service and socket\) [\#441](/~https://github.com/puppetlabs/puppetlabs-docker/pull/441) ([esalberg](/~https://github.com/esalberg)) -- changing permissions to remove systemd warning [\#440](/~https://github.com/puppetlabs/puppetlabs-docker/pull/440) ([davejrt](/~https://github.com/davejrt)) -- including docker class in all tests of docker::run [\#437](/~https://github.com/puppetlabs/puppetlabs-docker/pull/437) ([davejrt](/~https://github.com/davejrt)) -- fixing errors with bundle file conditional statement [\#436](/~https://github.com/puppetlabs/puppetlabs-docker/pull/436) ([davejrt](/~https://github.com/davejrt)) -- \#432 Fix frozen string error [\#434](/~https://github.com/puppetlabs/puppetlabs-docker/pull/434) ([khaefeli](/~https://github.com/khaefeli)) -- adding in type/provider for docker stack [\#433](/~https://github.com/puppetlabs/puppetlabs-docker/pull/433) ([davejrt](/~https://github.com/davejrt)) -- Allow custom docker\_group and service\_name values in run.pp [\#431](/~https://github.com/puppetlabs/puppetlabs-docker/pull/431) ([esalberg](/~https://github.com/esalberg)) -- updating acceptance tests for cve-2019-5736 [\#430](/~https://github.com/puppetlabs/puppetlabs-docker/pull/430) ([davejrt](/~https://github.com/davejrt)) -- updating translate module version [\#429](/~https://github.com/puppetlabs/puppetlabs-docker/pull/429) ([davejrt](/~https://github.com/davejrt)) - -## [e2.0](/~https://github.com/puppetlabs/puppetlabs-docker/tree/e2.0) (2019-02-21) - -[Full Changelog](/~https://github.com/puppetlabs/puppetlabs-docker/compare/3.3.0...e2.0) - -## [3.3.0](/~https://github.com/puppetlabs/puppetlabs-docker/tree/3.3.0) (2019-02-13) - -[Full Changelog](/~https://github.com/puppetlabs/puppetlabs-docker/compare/3.2.0...3.3.0) - -### UNCATEGORIZED PRS; LABEL THEM ON GITHUB - -- updating changelog and metadata for release [\#427](/~https://github.com/puppetlabs/puppetlabs-docker/pull/427) ([davejrt](/~https://github.com/davejrt)) -- provide a more flexible range for the reboot module [\#426](/~https://github.com/puppetlabs/puppetlabs-docker/pull/426) ([davejrt](/~https://github.com/davejrt)) -- Increase apt pin from 10 to 500 [\#425](/~https://github.com/puppetlabs/puppetlabs-docker/pull/425) ([baurmatt](/~https://github.com/baurmatt)) -- don't fail if docker server is not running \(\#422\) [\#423](/~https://github.com/puppetlabs/puppetlabs-docker/pull/423) ([vchepkov](/~https://github.com/vchepkov)) -- Docker::Services: Add 'mounts' parameter [\#421](/~https://github.com/puppetlabs/puppetlabs-docker/pull/421) ([jacksgt](/~https://github.com/jacksgt)) -- readme udpate [\#416](/~https://github.com/puppetlabs/puppetlabs-docker/pull/416) ([davejrt](/~https://github.com/davejrt)) -- centos repo fix [\#413](/~https://github.com/puppetlabs/puppetlabs-docker/pull/413) ([davejrt](/~https://github.com/davejrt)) -- rhel fix [\#412](/~https://github.com/puppetlabs/puppetlabs-docker/pull/412) ([davejrt](/~https://github.com/davejrt)) -- Stack spec [\#411](/~https://github.com/puppetlabs/puppetlabs-docker/pull/411) ([davejrt](/~https://github.com/davejrt)) -- \(CLOUD-2201\) Readme updates [\#410](/~https://github.com/puppetlabs/puppetlabs-docker/pull/410) ([EamonnTP](/~https://github.com/EamonnTP)) -- Fix unit tests on windows [\#409](/~https://github.com/puppetlabs/puppetlabs-docker/pull/409) ([florindragos](/~https://github.com/florindragos)) -- Removing underscore characters from local\_user variable before using it with stdlib's pw\_hash [\#408](/~https://github.com/puppetlabs/puppetlabs-docker/pull/408) ([venushka](/~https://github.com/venushka)) - -## [3.2.0](/~https://github.com/puppetlabs/puppetlabs-docker/tree/3.2.0) (2019-01-16) - -[Full Changelog](/~https://github.com/puppetlabs/puppetlabs-docker/compare/3.1.0...3.2.0) - -### UNCATEGORIZED PRS; LABEL THEM ON GITHUB - -- fixing various issues with tests across all supported OS [\#406](/~https://github.com/puppetlabs/puppetlabs-docker/pull/406) ([davejrt](/~https://github.com/davejrt)) -- updating changelog and metadata for release [\#405](/~https://github.com/puppetlabs/puppetlabs-docker/pull/405) ([davejrt](/~https://github.com/davejrt)) -- Merge-back of release branch into master [\#361](/~https://github.com/puppetlabs/puppetlabs-docker/pull/361) ([MWilsonPuppet](/~https://github.com/MWilsonPuppet)) -- Update readme for docker stack [\#359](/~https://github.com/puppetlabs/puppetlabs-docker/pull/359) ([florindragos](/~https://github.com/florindragos)) -- Add docker stack tests [\#356](/~https://github.com/puppetlabs/puppetlabs-docker/pull/356) ([florindragos](/~https://github.com/florindragos)) -- Added support for awslogs [\#354](/~https://github.com/puppetlabs/puppetlabs-docker/pull/354) ([acurus-puppetmaster](/~https://github.com/acurus-puppetmaster)) -- Fix registry local\_user functionalitity. [\#353](/~https://github.com/puppetlabs/puppetlabs-docker/pull/353) ([stejanse](/~https://github.com/stejanse)) -- Docker stack on windows [\#350](/~https://github.com/puppetlabs/puppetlabs-docker/pull/350) ([florindragos](/~https://github.com/florindragos)) -- Fix acceptance tests for windows [\#349](/~https://github.com/puppetlabs/puppetlabs-docker/pull/349) ([florindragos](/~https://github.com/florindragos)) -- post release rebase of release branch into master [\#347](/~https://github.com/puppetlabs/puppetlabs-docker/pull/347) ([MWilsonPuppet](/~https://github.com/MWilsonPuppet)) -- CLOUD-2146 cleanup of docker compose acceptance tests [\#341](/~https://github.com/puppetlabs/puppetlabs-docker/pull/341) ([MWilsonPuppet](/~https://github.com/MWilsonPuppet)) -- adding in support for ubuntu 18.04 [\#340](/~https://github.com/puppetlabs/puppetlabs-docker/pull/340) ([davejrt](/~https://github.com/davejrt)) -- Check for empty IPAM Config [\#339](/~https://github.com/puppetlabs/puppetlabs-docker/pull/339) ([florindragos](/~https://github.com/florindragos)) -- Fix docker swarm tasks boolean params [\#338](/~https://github.com/puppetlabs/puppetlabs-docker/pull/338) ([florindragos](/~https://github.com/florindragos)) -- Update readme - Using a proxy on windows [\#337](/~https://github.com/puppetlabs/puppetlabs-docker/pull/337) ([florindragos](/~https://github.com/florindragos)) -- adding in official support of ubuntu 18.04 [\#333](/~https://github.com/puppetlabs/puppetlabs-docker/pull/333) ([davejrt](/~https://github.com/davejrt)) -- CLOUD-2069 Adding support for multiple compose files. [\#332](/~https://github.com/puppetlabs/puppetlabs-docker/pull/332) ([MWilsonPuppet](/~https://github.com/MWilsonPuppet)) -- Docker network [\#331](/~https://github.com/puppetlabs/puppetlabs-docker/pull/331) ([davejrt](/~https://github.com/davejrt)) -- Use versioncmp instead of type casting [\#330](/~https://github.com/puppetlabs/puppetlabs-docker/pull/330) ([PierreR](/~https://github.com/PierreR)) -- fixes puppet run failures with no IPAM driver [\#329](/~https://github.com/puppetlabs/puppetlabs-docker/pull/329) ([davejrt](/~https://github.com/davejrt)) -- CLOUD-2078-Uninstall Docker on Linux [\#328](/~https://github.com/puppetlabs/puppetlabs-docker/pull/328) ([MWilsonPuppet](/~https://github.com/MWilsonPuppet)) -- More idiomatic usage of parens for 'fail translate\(\(' [\#327](/~https://github.com/puppetlabs/puppetlabs-docker/pull/327) ([PierreR](/~https://github.com/PierreR)) -- Fix windows default paths [\#326](/~https://github.com/puppetlabs/puppetlabs-docker/pull/326) ([florindragos](/~https://github.com/florindragos)) -- Fix error messages from docker facts if docker not running [\#325](/~https://github.com/puppetlabs/puppetlabs-docker/pull/325) ([stdietrich](/~https://github.com/stdietrich)) -- add custom\_unless for docker::run exec [\#324](/~https://github.com/puppetlabs/puppetlabs-docker/pull/324) ([esalberg](/~https://github.com/esalberg)) -- Fix docker-compose provider to support images built on the fly [\#320](/~https://github.com/puppetlabs/puppetlabs-docker/pull/320) ([florindragos](/~https://github.com/florindragos)) -- Windows - remove docker on ensure absent [\#318](/~https://github.com/puppetlabs/puppetlabs-docker/pull/318) ([florindragos](/~https://github.com/florindragos)) -- Receive osfamily as parameter in docker\_run\_flags [\#317](/~https://github.com/puppetlabs/puppetlabs-docker/pull/317) ([florindragos](/~https://github.com/florindragos)) -- Add acceptance tests for installing docker from a zip file on windows [\#315](/~https://github.com/puppetlabs/puppetlabs-docker/pull/315) ([florindragos](/~https://github.com/florindragos)) -- Add option to download and install docker from a url on windows [\#311](/~https://github.com/puppetlabs/puppetlabs-docker/pull/311) ([florindragos](/~https://github.com/florindragos)) -- CLOUD-2046-Add logic for root dir flag [\#306](/~https://github.com/puppetlabs/puppetlabs-docker/pull/306) ([MWilsonPuppet](/~https://github.com/MWilsonPuppet)) -- fixing bug in upstart systems [\#304](/~https://github.com/puppetlabs/puppetlabs-docker/pull/304) ([davejrt](/~https://github.com/davejrt)) -- adds in exec unit test for addition of env vars into exec define [\#302](/~https://github.com/puppetlabs/puppetlabs-docker/pull/302) ([davejrt](/~https://github.com/davejrt)) -- removing keyring packages, no longer required [\#301](/~https://github.com/puppetlabs/puppetlabs-docker/pull/301) ([davejrt](/~https://github.com/davejrt)) -- \[CLOUD-2040\]enable extras repo only in CentOS 6 or lower [\#300](/~https://github.com/puppetlabs/puppetlabs-docker/pull/300) ([mihaibuzgau](/~https://github.com/mihaibuzgau)) -- Fix for registry password not being inserted due to single quotes [\#299](/~https://github.com/puppetlabs/puppetlabs-docker/pull/299) ([ConorPKeegan](/~https://github.com/ConorPKeegan)) -- Fix docker registry idempotency and add windows acceptance tests [\#298](/~https://github.com/puppetlabs/puppetlabs-docker/pull/298) ([florindragos](/~https://github.com/florindragos)) -- \[CLOUD-1981\] docker image update script runs in noop mode [\#297](/~https://github.com/puppetlabs/puppetlabs-docker/pull/297) ([mihaibuzgau](/~https://github.com/mihaibuzgau)) -- \[CLOUD-2041\] Windows service idempotence using powershell script [\#295](/~https://github.com/puppetlabs/puppetlabs-docker/pull/295) ([mihaibuzgau](/~https://github.com/mihaibuzgau)) -- Regex fix [\#292](/~https://github.com/puppetlabs/puppetlabs-docker/pull/292) ([davejrt](/~https://github.com/davejrt)) -- Do not use = for to set storage driver - fixes starting of docker-sto… [\#291](/~https://github.com/puppetlabs/puppetlabs-docker/pull/291) ([duritong](/~https://github.com/duritong)) -- \[CLOUD-2033\] determine if a compose service extends another compose service [\#288](/~https://github.com/puppetlabs/puppetlabs-docker/pull/288) ([mihaibuzgau](/~https://github.com/mihaibuzgau)) -- 2.0.0 [\#286](/~https://github.com/puppetlabs/puppetlabs-docker/pull/286) ([davejrt](/~https://github.com/davejrt)) -- Pass supplied environment variables to docker exec [\#135](/~https://github.com/puppetlabs/puppetlabs-docker/pull/135) ([jorhett](/~https://github.com/jorhett)) -- Removing value in the --prune parameter for docker stack deploy [\#407](/~https://github.com/puppetlabs/puppetlabs-docker/pull/407) ([venushka](/~https://github.com/venushka)) -- Cleanup containers spec [\#404](/~https://github.com/puppetlabs/puppetlabs-docker/pull/404) ([davejrt](/~https://github.com/davejrt)) -- Move container name sanitisation code to puppet function. [\#401](/~https://github.com/puppetlabs/puppetlabs-docker/pull/401) ([glorpen](/~https://github.com/glorpen)) -- Fix shared scripts on non systemd systems [\#400](/~https://github.com/puppetlabs/puppetlabs-docker/pull/400) ([glorpen](/~https://github.com/glorpen)) -- debian 9 and ubuntu 1804 pooler tests [\#399](/~https://github.com/puppetlabs/puppetlabs-docker/pull/399) ([davejrt](/~https://github.com/davejrt)) -- Update .travis.yml [\#398](/~https://github.com/puppetlabs/puppetlabs-docker/pull/398) ([davejrt](/~https://github.com/davejrt)) -- Do not load powershell profiles [\#396](/~https://github.com/puppetlabs/puppetlabs-docker/pull/396) ([florindragos](/~https://github.com/florindragos)) -- Fix stack acceptance tests [\#395](/~https://github.com/puppetlabs/puppetlabs-docker/pull/395) ([florindragos](/~https://github.com/florindragos)) -- fixing acceptance tests on debian [\#393](/~https://github.com/puppetlabs/puppetlabs-docker/pull/393) ([davejrt](/~https://github.com/davejrt)) -- Add support for default-addr-pool options to swarm init [\#391](/~https://github.com/puppetlabs/puppetlabs-docker/pull/391) ([sagepe](/~https://github.com/sagepe)) -- Enable PDK compliance [\#389](/~https://github.com/puppetlabs/puppetlabs-docker/pull/389) ([florindragos](/~https://github.com/florindragos)) -- fixing deep merge issue and yaml alias [\#387](/~https://github.com/puppetlabs/puppetlabs-docker/pull/387) ([davejrt](/~https://github.com/davejrt)) -- Adds a Usage example for daemon level extra\_parameters [\#386](/~https://github.com/puppetlabs/puppetlabs-docker/pull/386) ([mpepping](/~https://github.com/mpepping)) -- Fixing create\_resources for volumes [\#384](/~https://github.com/puppetlabs/puppetlabs-docker/pull/384) ([andytechdad](/~https://github.com/andytechdad)) -- docker::run: Support depend\_services with full systemd unit names [\#383](/~https://github.com/puppetlabs/puppetlabs-docker/pull/383) ([jameslikeslinux](/~https://github.com/jameslikeslinux)) -- \(WIP\) - removes packages that can still run docker after docker-ce is removed. [\#379](/~https://github.com/puppetlabs/puppetlabs-docker/pull/379) ([davejrt](/~https://github.com/davejrt)) -- Fix the docker\_compose options parameter position [\#378](/~https://github.com/puppetlabs/puppetlabs-docker/pull/378) ([FlorentPoinsaut](/~https://github.com/FlorentPoinsaut)) -- missing quote in swarm documentation [\#377](/~https://github.com/puppetlabs/puppetlabs-docker/pull/377) ([lcrownover](/~https://github.com/lcrownover)) -- Puppet 6 support [\#375](/~https://github.com/puppetlabs/puppetlabs-docker/pull/375) ([florindragos](/~https://github.com/florindragos)) -- Update default network example [\#374](/~https://github.com/puppetlabs/puppetlabs-docker/pull/374) ([davejrt](/~https://github.com/davejrt)) -- Handle compose files with services that have no image [\#373](/~https://github.com/puppetlabs/puppetlabs-docker/pull/373) ([walkamongus](/~https://github.com/walkamongus)) -- Allow multiple values for subnet in docker\_network [\#371](/~https://github.com/puppetlabs/puppetlabs-docker/pull/371) ([florindragos](/~https://github.com/florindragos)) -- parameterized package\_location for osfamily==RedHat [\#370](/~https://github.com/puppetlabs/puppetlabs-docker/pull/370) ([ZyanKLee](/~https://github.com/ZyanKLee)) -- Cloud 2191 fix stack acceptance test [\#368](/~https://github.com/puppetlabs/puppetlabs-docker/pull/368) ([MWilsonPuppet](/~https://github.com/MWilsonPuppet)) -- Create shared start/stop scripts for better extensibility [\#367](/~https://github.com/puppetlabs/puppetlabs-docker/pull/367) ([glorpen](/~https://github.com/glorpen)) -- rework all indentation [\#366](/~https://github.com/puppetlabs/puppetlabs-docker/pull/366) ([kapouik](/~https://github.com/kapouik)) -- Fixing incorrect variable names in docker\_compose/ruby.rb [\#365](/~https://github.com/puppetlabs/puppetlabs-docker/pull/365) ([lowerpuppet](/~https://github.com/lowerpuppet)) -- update docker\_stack to fix registry auth option [\#364](/~https://github.com/puppetlabs/puppetlabs-docker/pull/364) ([davejrt](/~https://github.com/davejrt)) - -## [3.1.0](/~https://github.com/puppetlabs/puppetlabs-docker/tree/3.1.0) (2018-10-22) - -[Full Changelog](/~https://github.com/puppetlabs/puppetlabs-docker/compare/3.0.0...3.1.0) - -## [3.0.0](/~https://github.com/puppetlabs/puppetlabs-docker/tree/3.0.0) (2018-09-27) - -[Full Changelog](/~https://github.com/puppetlabs/puppetlabs-docker/compare/2.0.0...3.0.0) - -## [2.0.0](/~https://github.com/puppetlabs/puppetlabs-docker/tree/2.0.0) (2018-07-18) - -[Full Changelog](/~https://github.com/puppetlabs/puppetlabs-docker/compare/1.1.0...2.0.0) - -### UNCATEGORIZED PRS; LABEL THEM ON GITHUB - -- Update metadata.json [\#285](/~https://github.com/puppetlabs/puppetlabs-docker/pull/285) ([davejrt](/~https://github.com/davejrt)) -- Health fix [\#284](/~https://github.com/puppetlabs/puppetlabs-docker/pull/284) ([davejrt](/~https://github.com/davejrt)) -- fixes restarting containers with changes to run arguments [\#283](/~https://github.com/puppetlabs/puppetlabs-docker/pull/283) ([davejrt](/~https://github.com/davejrt)) -- 2.0.0 release prep. [\#282](/~https://github.com/puppetlabs/puppetlabs-docker/pull/282) ([MWilsonPuppet](/~https://github.com/MWilsonPuppet)) -- CLOUD-2018-Add-health-check-interval [\#279](/~https://github.com/puppetlabs/puppetlabs-docker/pull/279) ([MWilsonPuppet](/~https://github.com/MWilsonPuppet)) -- Moved the docker run command to a separate file in /usr/local/bin and… [\#278](/~https://github.com/puppetlabs/puppetlabs-docker/pull/278) ([dploeger](/~https://github.com/dploeger)) -- Update README.md [\#277](/~https://github.com/puppetlabs/puppetlabs-docker/pull/277) ([davejrt](/~https://github.com/davejrt)) -- Update readme for networks and swarm on windows [\#276](/~https://github.com/puppetlabs/puppetlabs-docker/pull/276) ([florindragos](/~https://github.com/florindragos)) -- Fixes acceptance tests on linux for latest docker version [\#275](/~https://github.com/puppetlabs/puppetlabs-docker/pull/275) ([davejrt](/~https://github.com/davejrt)) -- Run docker services on windows [\#274](/~https://github.com/puppetlabs/puppetlabs-docker/pull/274) ([florindragos](/~https://github.com/florindragos)) -- CLOUD-2011 - update readme for Windows Support [\#273](/~https://github.com/puppetlabs/puppetlabs-docker/pull/273) ([mihaibuzgau](/~https://github.com/mihaibuzgau)) -- fix for restart\_check on windows [\#271](/~https://github.com/puppetlabs/puppetlabs-docker/pull/271) ([mihaibuzgau](/~https://github.com/mihaibuzgau)) -- fixing healthcheck WIP [\#270](/~https://github.com/puppetlabs/puppetlabs-docker/pull/270) ([davejrt](/~https://github.com/davejrt)) -- adding in acceptance test for storage driver [\#269](/~https://github.com/puppetlabs/puppetlabs-docker/pull/269) ([davejrt](/~https://github.com/davejrt)) -- 1.2.0 [\#268](/~https://github.com/puppetlabs/puppetlabs-docker/pull/268) ([davejrt](/~https://github.com/davejrt)) -- testing windows healthcheck cmd [\#267](/~https://github.com/puppetlabs/puppetlabs-docker/pull/267) ([davejrt](/~https://github.com/davejrt)) -- Support private docker registries on windows [\#266](/~https://github.com/puppetlabs/puppetlabs-docker/pull/266) ([florindragos](/~https://github.com/florindragos)) -- fixes fact for windows [\#264](/~https://github.com/puppetlabs/puppetlabs-docker/pull/264) ([davejrt](/~https://github.com/davejrt)) -- Cloud 1900 [\#263](/~https://github.com/puppetlabs/puppetlabs-docker/pull/263) ([davejrt](/~https://github.com/davejrt)) -- Configure Docker Swarm on Windows [\#262](/~https://github.com/puppetlabs/puppetlabs-docker/pull/262) ([florindragos](/~https://github.com/florindragos)) -- CLOUD-1967-Fixing -Docker\_stacks-image resolve [\#261](/~https://github.com/puppetlabs/puppetlabs-docker/pull/261) ([MWilsonPuppet](/~https://github.com/MWilsonPuppet)) -- adding in example for docker store [\#258](/~https://github.com/puppetlabs/puppetlabs-docker/pull/258) ([davejrt](/~https://github.com/davejrt)) -- \(CLOUD-1850\)-Restart docker container on unhealthy status [\#254](/~https://github.com/puppetlabs/puppetlabs-docker/pull/254) ([MWilsonPuppet](/~https://github.com/MWilsonPuppet)) -- Volumes acceptance test for Docker on Windows [\#253](/~https://github.com/puppetlabs/puppetlabs-docker/pull/253) ([mihaibuzgau](/~https://github.com/mihaibuzgau)) -- Run docker compose on windows [\#252](/~https://github.com/puppetlabs/puppetlabs-docker/pull/252) ([florindragos](/~https://github.com/florindragos)) -- Add docker exec functionality for Docker on Windows [\#251](/~https://github.com/puppetlabs/puppetlabs-docker/pull/251) ([mihaibuzgau](/~https://github.com/mihaibuzgau)) -- add docker run tests for Windows [\#249](/~https://github.com/puppetlabs/puppetlabs-docker/pull/249) ([mihaibuzgau](/~https://github.com/mihaibuzgau)) -- CLOUD-1854-Fixing github issue \#213 [\#247](/~https://github.com/puppetlabs/puppetlabs-docker/pull/247) ([MWilsonPuppet](/~https://github.com/MWilsonPuppet)) -- Add integration tests for Docker on Windows using vmpooler [\#246](/~https://github.com/puppetlabs/puppetlabs-docker/pull/246) ([mihaibuzgau](/~https://github.com/mihaibuzgau)) -- Docker run on windows [\#242](/~https://github.com/puppetlabs/puppetlabs-docker/pull/242) ([florindragos](/~https://github.com/florindragos)) -- make Windows Docker deployment idempotent [\#240](/~https://github.com/puppetlabs/puppetlabs-docker/pull/240) ([mihaibuzgau](/~https://github.com/mihaibuzgau)) -- fix "start a container with cpuset" acceptance test on ubuntu1404 [\#236](/~https://github.com/puppetlabs/puppetlabs-docker/pull/236) ([mihaibuzgau](/~https://github.com/mihaibuzgau)) -- changing docker spec to alpine due to issue with init on ubuntu [\#235](/~https://github.com/puppetlabs/puppetlabs-docker/pull/235) ([davejrt](/~https://github.com/davejrt)) -- Fix dependency cycle issue [\#233](/~https://github.com/puppetlabs/puppetlabs-docker/pull/233) ([rvdh](/~https://github.com/rvdh)) -- docker::stack unless and onlyif were doing "docker stack deploy ls" [\#231](/~https://github.com/puppetlabs/puppetlabs-docker/pull/231) ([hdeadman](/~https://github.com/hdeadman)) -- Update install.pp to Support Red Hat "yum" Package Provider [\#227](/~https://github.com/puppetlabs/puppetlabs-docker/pull/227) ([jmbelvar81](/~https://github.com/jmbelvar81)) -- Add Docker EE support for Windows Server 2016 [\#222](/~https://github.com/puppetlabs/puppetlabs-docker/pull/222) ([mihaibuzgau](/~https://github.com/mihaibuzgau)) -- Fix incompatiblity with puppet4 [\#221](/~https://github.com/puppetlabs/puppetlabs-docker/pull/221) ([TheBigLee](/~https://github.com/TheBigLee)) -- Repair syntax error in Readme [\#220](/~https://github.com/puppetlabs/puppetlabs-docker/pull/220) ([lokal-profil](/~https://github.com/lokal-profil)) -- adding in the functionality to define swarm clusters in hiera [\#219](/~https://github.com/puppetlabs/puppetlabs-docker/pull/219) ([davejrt](/~https://github.com/davejrt)) -- fix for \#208 [\#210](/~https://github.com/puppetlabs/puppetlabs-docker/pull/210) ([scotty-c](/~https://github.com/scotty-c)) -- unlocking puppet version for travis [\#205](/~https://github.com/puppetlabs/puppetlabs-docker/pull/205) ([davejrt](/~https://github.com/davejrt)) -- Readme volume [\#204](/~https://github.com/puppetlabs/puppetlabs-docker/pull/204) ([davejrt](/~https://github.com/davejrt)) -- Add support for onlyif in a docker exec [\#202](/~https://github.com/puppetlabs/puppetlabs-docker/pull/202) ([electrofelix](/~https://github.com/electrofelix)) -- Support refreshonly flag [\#201](/~https://github.com/puppetlabs/puppetlabs-docker/pull/201) ([electrofelix](/~https://github.com/electrofelix)) -- Use line breaks and continuation for run flags [\#200](/~https://github.com/puppetlabs/puppetlabs-docker/pull/200) ([electrofelix](/~https://github.com/electrofelix)) -- Limit Image -\> Run dependencies to those used [\#199](/~https://github.com/puppetlabs/puppetlabs-docker/pull/199) ([electrofelix](/~https://github.com/electrofelix)) -- 1.1.0 [\#196](/~https://github.com/puppetlabs/puppetlabs-docker/pull/196) ([davejrt](/~https://github.com/davejrt)) - -## [1.1.0](/~https://github.com/puppetlabs/puppetlabs-docker/tree/1.1.0) (2018-03-15) - -[Full Changelog](/~https://github.com/puppetlabs/puppetlabs-docker/compare/e1.1...1.1.0) - -### UNCATEGORIZED PRS; LABEL THEM ON GITHUB - -- CLOUD-1775 Minor Readme edits [\#195](/~https://github.com/puppetlabs/puppetlabs-docker/pull/195) ([EamonnTP](/~https://github.com/EamonnTP)) -- Close placeholders in README [\#194](/~https://github.com/puppetlabs/puppetlabs-docker/pull/194) ([johnmccabe](/~https://github.com/johnmccabe)) -- \(maint\)CLOUD-1768 - Adding acceptance test for cpuset flag [\#191](/~https://github.com/puppetlabs/puppetlabs-docker/pull/191) ([MWilsonPuppet](/~https://github.com/MWilsonPuppet)) -- adding in issue template [\#190](/~https://github.com/puppetlabs/puppetlabs-docker/pull/190) ([davejrt](/~https://github.com/davejrt)) -- Update README.md [\#188](/~https://github.com/puppetlabs/puppetlabs-docker/pull/188) ([davejrt](/~https://github.com/davejrt)) -- \(maint\)CLOUD-1768 Fixing incorrect cpuset flag \#183 [\#187](/~https://github.com/puppetlabs/puppetlabs-docker/pull/187) ([MWilsonPuppet](/~https://github.com/MWilsonPuppet)) -- Move the image parameter to the end [\#186](/~https://github.com/puppetlabs/puppetlabs-docker/pull/186) ([alikashmar](/~https://github.com/alikashmar)) -- CLOUD-1637 Readme update [\#185](/~https://github.com/puppetlabs/puppetlabs-docker/pull/185) ([MWilsonPuppet](/~https://github.com/MWilsonPuppet)) -- supported\_os\_fix [\#184](/~https://github.com/puppetlabs/puppetlabs-docker/pull/184) ([davejrt](/~https://github.com/davejrt)) -- Docker login Receipt is now removed if login fails and added acceptance tests [\#182](/~https://github.com/puppetlabs/puppetlabs-docker/pull/182) ([sigsegv11](/~https://github.com/sigsegv11)) -- Cloud 1654 [\#181](/~https://github.com/puppetlabs/puppetlabs-docker/pull/181) ([davejrt](/~https://github.com/davejrt)) -- Cloud 1719 [\#180](/~https://github.com/puppetlabs/puppetlabs-docker/pull/180) ([davejrt](/~https://github.com/davejrt)) -- Fix debian systemd [\#177](/~https://github.com/puppetlabs/puppetlabs-docker/pull/177) ([damoun](/~https://github.com/damoun)) -- fixing deletion of debian logic [\#176](/~https://github.com/puppetlabs/puppetlabs-docker/pull/176) ([davejrt](/~https://github.com/davejrt)) -- Cloud 1750 [\#175](/~https://github.com/puppetlabs/puppetlabs-docker/pull/175) ([davejrt](/~https://github.com/davejrt)) -- Update README.md [\#174](/~https://github.com/puppetlabs/puppetlabs-docker/pull/174) ([davejrt](/~https://github.com/davejrt)) -- Added option to pass a Dockerfile to $docker\_dir [\#171](/~https://github.com/puppetlabs/puppetlabs-docker/pull/171) ([genebean](/~https://github.com/genebean)) -- Use RHSM Repo ID as the default for the extras repo name on RHEL7 [\#168](/~https://github.com/puppetlabs/puppetlabs-docker/pull/168) ([nikdoof](/~https://github.com/nikdoof)) -- confining docker fact to 1.13 and later [\#166](/~https://github.com/puppetlabs/puppetlabs-docker/pull/166) ([davejrt](/~https://github.com/davejrt)) -- Update stack.rb [\#164](/~https://github.com/puppetlabs/puppetlabs-docker/pull/164) ([davejrt](/~https://github.com/davejrt)) -- Use `-o` option when downloading docker compose [\#162](/~https://github.com/puppetlabs/puppetlabs-docker/pull/162) ([alexjfisher](/~https://github.com/alexjfisher)) -- Add registry\_mirror parameter to services to match services flag function [\#160](/~https://github.com/puppetlabs/puppetlabs-docker/pull/160) ([esalberg](/~https://github.com/esalberg)) -- Readme.md patch [\#158](/~https://github.com/puppetlabs/puppetlabs-docker/pull/158) ([davejrt](/~https://github.com/davejrt)) -- Fixing typo that breaks docker-compose file version matching and enab… [\#157](/~https://github.com/puppetlabs/puppetlabs-docker/pull/157) ([sigsegv11](/~https://github.com/sigsegv11)) -- Add new parameter 'read\_only' to ::docker::run [\#154](/~https://github.com/puppetlabs/puppetlabs-docker/pull/154) ([jacksgt](/~https://github.com/jacksgt)) -- \(Enabling rubocop and lint on docker\) [\#150](/~https://github.com/puppetlabs/puppetlabs-docker/pull/150) ([sheenaajay](/~https://github.com/sheenaajay)) -- fix typo [\#149](/~https://github.com/puppetlabs/puppetlabs-docker/pull/149) ([seriv](/~https://github.com/seriv)) -- locking gem to stop upstream stdlib error [\#147](/~https://github.com/puppetlabs/puppetlabs-docker/pull/147) ([davejrt](/~https://github.com/davejrt)) -- Add more supported params to run example [\#146](/~https://github.com/puppetlabs/puppetlabs-docker/pull/146) ([w4tsn](/~https://github.com/w4tsn)) -- \(fix for \#143 and \#144\) [\#145](/~https://github.com/puppetlabs/puppetlabs-docker/pull/145) ([sheenaajay](/~https://github.com/sheenaajay)) -- Fix hiera examples [\#142](/~https://github.com/puppetlabs/puppetlabs-docker/pull/142) ([dol](/~https://github.com/dol)) -- Fix trivial README typo [\#136](/~https://github.com/puppetlabs/puppetlabs-docker/pull/136) ([alexjfisher](/~https://github.com/alexjfisher)) -- setting sane defaults for socket group on RedHat systems [\#134](/~https://github.com/puppetlabs/puppetlabs-docker/pull/134) ([davejrt](/~https://github.com/davejrt)) -- preparing for release [\#132](/~https://github.com/puppetlabs/puppetlabs-docker/pull/132) ([davejrt](/~https://github.com/davejrt)) -- Fix typo [\#130](/~https://github.com/puppetlabs/puppetlabs-docker/pull/130) ([shamil](/~https://github.com/shamil)) -- Cloud 1528 [\#129](/~https://github.com/puppetlabs/puppetlabs-docker/pull/129) ([davejrt](/~https://github.com/davejrt)) -- \(CLOUD-1673\) Remove epel dependecny in docker [\#127](/~https://github.com/puppetlabs/puppetlabs-docker/pull/127) ([sheenaajay](/~https://github.com/sheenaajay)) -- docker::compose proxy accepts http proxy [\#126](/~https://github.com/puppetlabs/puppetlabs-docker/pull/126) ([BobVanB](/~https://github.com/BobVanB)) -- Fix systemd escaping issue \#124 [\#125](/~https://github.com/puppetlabs/puppetlabs-docker/pull/125) ([olivierHa](/~https://github.com/olivierHa)) -- changing variable name due to facter bug [\#123](/~https://github.com/puppetlabs/puppetlabs-docker/pull/123) ([davejrt](/~https://github.com/davejrt)) -- replace Tuple with Array\[String\] [\#121](/~https://github.com/puppetlabs/puppetlabs-docker/pull/121) ([lobeck](/~https://github.com/lobeck)) -- \(CLOUD-1661\) Fixing rubocop error andaddingi18ngem [\#120](/~https://github.com/puppetlabs/puppetlabs-docker/pull/120) ([sheenaajay](/~https://github.com/sheenaajay)) -- removing manage\_kernel [\#116](/~https://github.com/puppetlabs/puppetlabs-docker/pull/116) ([davejrt](/~https://github.com/davejrt)) -- Repo fix arch [\#115](/~https://github.com/puppetlabs/puppetlabs-docker/pull/115) ([davejrt](/~https://github.com/davejrt)) -- stubbing processor fact to fix failures on osx [\#112](/~https://github.com/puppetlabs/puppetlabs-docker/pull/112) ([davejrt](/~https://github.com/davejrt)) -- Add resource type and provider for docker\_volumes [\#111](/~https://github.com/puppetlabs/puppetlabs-docker/pull/111) ([dhollinger](/~https://github.com/dhollinger)) -- \(CLOUD-1663\) update the apt module to the latest [\#110](/~https://github.com/puppetlabs/puppetlabs-docker/pull/110) ([sheenaajay](/~https://github.com/sheenaajay)) -- CLOUD-1610 Adding registry mirror flag [\#109](/~https://github.com/puppetlabs/puppetlabs-docker/pull/109) ([MWilsonPuppet](/~https://github.com/MWilsonPuppet)) -- Socket group [\#107](/~https://github.com/puppetlabs/puppetlabs-docker/pull/107) ([davejrt](/~https://github.com/davejrt)) -- Spec fix [\#105](/~https://github.com/puppetlabs/puppetlabs-docker/pull/105) ([davejrt](/~https://github.com/davejrt)) -- Add facts from docker version and docker info. [\#103](/~https://github.com/puppetlabs/puppetlabs-docker/pull/103) ([mterzo](/~https://github.com/mterzo)) -- remove docker\_cs param docs [\#101](/~https://github.com/puppetlabs/puppetlabs-docker/pull/101) ([LongLiveCHIEF](/~https://github.com/LongLiveCHIEF)) -- \(CLOUD\_1505\) validate functions [\#99](/~https://github.com/puppetlabs/puppetlabs-docker/pull/99) ([sheenaajay](/~https://github.com/sheenaajay)) -- docker::registry fixes [\#97](/~https://github.com/puppetlabs/puppetlabs-docker/pull/97) ([shamil](/~https://github.com/shamil)) -- 1.0.4 [\#96](/~https://github.com/puppetlabs/puppetlabs-docker/pull/96) ([davejrt](/~https://github.com/davejrt)) - -## [e1.1](/~https://github.com/puppetlabs/puppetlabs-docker/tree/e1.1) (2018-02-15) - -[Full Changelog](/~https://github.com/puppetlabs/puppetlabs-docker/compare/1.0.5...e1.1) - -## [1.0.5](/~https://github.com/puppetlabs/puppetlabs-docker/tree/1.0.5) (2018-01-30) - -[Full Changelog](/~https://github.com/puppetlabs/puppetlabs-docker/compare/1.0.4...1.0.5) - -## [1.0.4](/~https://github.com/puppetlabs/puppetlabs-docker/tree/1.0.4) (2018-01-03) - -[Full Changelog](/~https://github.com/puppetlabs/puppetlabs-docker/compare/1.0.3...1.0.4) - -## [1.0.3](/~https://github.com/puppetlabs/puppetlabs-docker/tree/1.0.3) (2018-01-02) - -[Full Changelog](/~https://github.com/puppetlabs/puppetlabs-docker/compare/e1.0...1.0.3) - -### UNCATEGORIZED PRS; LABEL THEM ON GITHUB - -- Allow setting commented TMPDIR in systemd file for backwards compatibility [\#90](/~https://github.com/puppetlabs/puppetlabs-docker/pull/90) ([esalberg](/~https://github.com/esalberg)) - -## [e1.0](/~https://github.com/puppetlabs/puppetlabs-docker/tree/e1.0) (2017-12-21) - -[Full Changelog](/~https://github.com/puppetlabs/puppetlabs-docker/compare/1.0.2...e1.0) - -### UNCATEGORIZED PRS; LABEL THEM ON GITHUB - -- Adding \. to regex on init.pp:540 to address issue \#84 [\#85](/~https://github.com/puppetlabs/puppetlabs-docker/pull/85) ([dmcanally](/~https://github.com/dmcanally)) -- gpg check optional [\#82](/~https://github.com/puppetlabs/puppetlabs-docker/pull/82) ([alvarolmedo](/~https://github.com/alvarolmedo)) -- Forcing pull when tag is latest [\#81](/~https://github.com/puppetlabs/puppetlabs-docker/pull/81) ([alvarolmedo](/~https://github.com/alvarolmedo)) -- fixing regex for older versions [\#80](/~https://github.com/puppetlabs/puppetlabs-docker/pull/80) ([davejrt](/~https://github.com/davejrt)) -- \(maint\)updating readme for github issue \#68 [\#79](/~https://github.com/puppetlabs/puppetlabs-docker/pull/79) ([MWilsonPuppet](/~https://github.com/MWilsonPuppet)) -- issue 77 - Removes unused variable. [\#78](/~https://github.com/puppetlabs/puppetlabs-docker/pull/78) ([mpepping](/~https://github.com/mpepping)) -- \(maint\)Fixing syntax error to get ci passing [\#76](/~https://github.com/puppetlabs/puppetlabs-docker/pull/76) ([MWilsonPuppet](/~https://github.com/MWilsonPuppet)) -- Fixed docker-compose issues. \#74 [\#75](/~https://github.com/puppetlabs/puppetlabs-docker/pull/75) ([pezzak](/~https://github.com/pezzak)) -- Add support for overlay2.override\_kernel\_check setting [\#71](/~https://github.com/puppetlabs/puppetlabs-docker/pull/71) ([gdubicki](/~https://github.com/gdubicki)) -- update docs for using legacy package [\#69](/~https://github.com/puppetlabs/puppetlabs-docker/pull/69) ([alexcreek](/~https://github.com/alexcreek)) -- Add Docker Fact [\#65](/~https://github.com/puppetlabs/puppetlabs-docker/pull/65) ([cdenneen](/~https://github.com/cdenneen)) -- Allow skipping usage of pw\_hash [\#63](/~https://github.com/puppetlabs/puppetlabs-docker/pull/63) ([jeefberkey](/~https://github.com/jeefberkey)) -- \(CLOUD-1560\)-adding-functionality to remove systemd service files. [\#61](/~https://github.com/puppetlabs/puppetlabs-docker/pull/61) ([MWilsonPuppet](/~https://github.com/MWilsonPuppet)) -- Additional flags for creating a network [\#60](/~https://github.com/puppetlabs/puppetlabs-docker/pull/60) ([coder-hugo](/~https://github.com/coder-hugo)) -- fixing incorrect repo url for redhat [\#59](/~https://github.com/puppetlabs/puppetlabs-docker/pull/59) ([davejrt](/~https://github.com/davejrt)) -- fixing commented out tmpdir [\#58](/~https://github.com/puppetlabs/puppetlabs-docker/pull/58) ([davejrt](/~https://github.com/davejrt)) -- Allow multiple label and env parameters on services [\#55](/~https://github.com/puppetlabs/puppetlabs-docker/pull/55) ([guimaluf](/~https://github.com/guimaluf)) -- Allow multiple docker::services declarations [\#54](/~https://github.com/puppetlabs/puppetlabs-docker/pull/54) ([guimaluf](/~https://github.com/guimaluf)) -- Allow multiple docker::secrets declarations [\#52](/~https://github.com/puppetlabs/puppetlabs-docker/pull/52) ([guimaluf](/~https://github.com/guimaluf)) -- Fix for Issue \#43 [\#48](/~https://github.com/puppetlabs/puppetlabs-docker/pull/48) ([RXM307](/~https://github.com/RXM307)) - -## [1.0.2](/~https://github.com/puppetlabs/puppetlabs-docker/tree/1.0.2) (2017-11-17) - -[Full Changelog](/~https://github.com/puppetlabs/puppetlabs-docker/compare/1.0.1...1.0.2) - -### UNCATEGORIZED PRS; LABEL THEM ON GITHUB - -- release prep 1.0.2 [\#47](/~https://github.com/puppetlabs/puppetlabs-docker/pull/47) ([scotty-c](/~https://github.com/scotty-c)) -- Cloud 1469 [\#46](/~https://github.com/puppetlabs/puppetlabs-docker/pull/46) ([davejrt](/~https://github.com/davejrt)) -- repos.pp: use ensure\_packages instead of package resource [\#41](/~https://github.com/puppetlabs/puppetlabs-docker/pull/41) ([hex2a](/~https://github.com/hex2a)) -- adding in logic to make docker::registry idempodent [\#40](/~https://github.com/puppetlabs/puppetlabs-docker/pull/40) ([davejrt](/~https://github.com/davejrt)) -- fixing yumrepo gpg url [\#37](/~https://github.com/puppetlabs/puppetlabs-docker/pull/37) ([davejrt](/~https://github.com/davejrt)) -- fixing issue \#21 [\#36](/~https://github.com/puppetlabs/puppetlabs-docker/pull/36) ([davejrt](/~https://github.com/davejrt)) -- Allow all digits \(IP\) for proxy URL [\#35](/~https://github.com/puppetlabs/puppetlabs-docker/pull/35) ([ianssoftcom](/~https://github.com/ianssoftcom)) -- \(maint\) Adding rspec\_junit\_formatter [\#34](/~https://github.com/puppetlabs/puppetlabs-docker/pull/34) ([MWilsonPuppet](/~https://github.com/MWilsonPuppet)) -- \(maint\)updating arrow alignment for puppet language style guide [\#32](/~https://github.com/puppetlabs/puppetlabs-docker/pull/32) ([MWilsonPuppet](/~https://github.com/MWilsonPuppet)) -- Cloud 1524 [\#31](/~https://github.com/puppetlabs/puppetlabs-docker/pull/31) ([davejrt](/~https://github.com/davejrt)) -- allow configuration of gem sources [\#29](/~https://github.com/puppetlabs/puppetlabs-docker/pull/29) ([LongLiveCHIEF](/~https://github.com/LongLiveCHIEF)) -- refactor inclusion of sub-classes [\#28](/~https://github.com/puppetlabs/puppetlabs-docker/pull/28) ([LongLiveCHIEF](/~https://github.com/LongLiveCHIEF)) -- adding in support for puppet 5 [\#27](/~https://github.com/puppetlabs/puppetlabs-docker/pull/27) ([davejrt](/~https://github.com/davejrt)) -- fixing unit tests [\#25](/~https://github.com/puppetlabs/puppetlabs-docker/pull/25) ([davejrt](/~https://github.com/davejrt)) -- \(maint\)fixing syntax error in compose spec file [\#23](/~https://github.com/puppetlabs/puppetlabs-docker/pull/23) ([MWilsonPuppet](/~https://github.com/MWilsonPuppet)) -- Updating proxy to allow for username and password to be passed. [\#22](/~https://github.com/puppetlabs/puppetlabs-docker/pull/22) ([dforste](/~https://github.com/dforste)) - -## [1.0.1](/~https://github.com/puppetlabs/puppetlabs-docker/tree/1.0.1) (2017-10-15) - -[Full Changelog](/~https://github.com/puppetlabs/puppetlabs-docker/compare/1.0.0...1.0.1) - -### UNCATEGORIZED PRS; LABEL THEM ON GITHUB - -- Release Prep for 1.0.1 [\#19](/~https://github.com/puppetlabs/puppetlabs-docker/pull/19) ([gregohardy](/~https://github.com/gregohardy)) -- Abstracted service\_name for docker-run.erb template [\#17](/~https://github.com/puppetlabs/puppetlabs-docker/pull/17) ([robert4man](/~https://github.com/robert4man)) -- Update README.md [\#13](/~https://github.com/puppetlabs/puppetlabs-docker/pull/13) ([kgeis](/~https://github.com/kgeis)) - -## [1.0.0](/~https://github.com/puppetlabs/puppetlabs-docker/tree/1.0.0) (2017-10-11) - -[Full Changelog](/~https://github.com/puppetlabs/puppetlabs-docker/compare/947a1f158444b4b9434dab3ccfa1306f885a67eb...1.0.0) - -### UNCATEGORIZED PRS; LABEL THEM ON GITHUB - -- Readme edits. [\#8](/~https://github.com/puppetlabs/puppetlabs-docker/pull/8) ([EamonnTP](/~https://github.com/EamonnTP)) -- \(CLOUD-1439\) Readme edits [\#7](/~https://github.com/puppetlabs/puppetlabs-docker/pull/7) ([EamonnTP](/~https://github.com/EamonnTP)) -- Adding stacks [\#6](/~https://github.com/puppetlabs/puppetlabs-docker/pull/6) ([scotty-c](/~https://github.com/scotty-c)) -- adding in contributors from forked module [\#5](/~https://github.com/puppetlabs/puppetlabs-docker/pull/5) ([davejrt](/~https://github.com/davejrt)) -- adding in fix for new apt module and updating metadata.json [\#4](/~https://github.com/puppetlabs/puppetlabs-docker/pull/4) ([davejrt](/~https://github.com/davejrt)) -- adding in docker secrets [\#3](/~https://github.com/puppetlabs/puppetlabs-docker/pull/3) ([davejrt](/~https://github.com/davejrt)) -- Cloud 1375 [\#2](/~https://github.com/puppetlabs/puppetlabs-docker/pull/2) ([davejrt](/~https://github.com/davejrt)) -- Merging personal testing fork into puppetlabs feature branch [\#1](/~https://github.com/puppetlabs/puppetlabs-docker/pull/1) ([davejrt](/~https://github.com/davejrt)) - # 3.5.0 Changes range for dependent modules diff --git a/REFERENCE.md b/REFERENCE.md index 8081db06..6531cf6c 100644 --- a/REFERENCE.md +++ b/REFERENCE.md @@ -9,21 +9,21 @@ #### Public 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::images`](#dockerimages) -* [`docker::install`](#dockerinstall): Module to install an up-to-date version of Docker from a package repository. +* [`docker::compose`](#docker--compose): install Docker Compose using the recommended curl command. +* [`docker::images`](#docker--images) +* [`docker::install`](#docker--install): 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) +* [`docker::machine`](#docker--machine): install Docker Machine using the recommended curl command. +* [`docker::networks`](#docker--networks) +* [`docker::params`](#docker--params): Default parameter values for the docker module +* [`docker::plugins`](#docker--plugins) +* [`docker::registry_auth`](#docker--registry_auth) +* [`docker::repos`](#docker--repos) +* [`docker::run_instance`](#docker--run_instance) +* [`docker::service`](#docker--service): manage the docker service daemon +* [`docker::swarms`](#docker--swarms) +* [`docker::systemd_reload`](#docker--systemd_reload): For systems that have systemd +* [`docker::volumes`](#docker--volumes) #### Private Classes @@ -31,18 +31,18 @@ Only for Debian, Red Hat and Windows ### 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 +* [`docker::exec`](#docker--exec): A define which executes a command inside a container. +* [`docker::image`](#docker--image): 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 +* [`docker::plugin`](#docker--plugin): A define that manages a docker plugin +* [`docker::registry`](#docker--registry): Module to configure private docker registries from which to pull Docker images +* [`docker::run`](#docker--run): A define which manages a running docker container. +* [`docker::secrets`](#docker--secrets) +* [`docker::services`](#docker--services): define that managers a Docker services +* [`docker::stack`](#docker--stack): deploys Docker stacks or compose v3 +* [`docker::swarm`](#docker--swarm): managers a Docker Swarm Mode cluster +* [`docker::system_user`](#docker--system_user): manage docker group users +* [`docker::windows_account`](#docker--windows_account): Windows account that owns the docker services ### Resource types @@ -53,8 +53,8 @@ from the registry ### Functions -* [`docker::escape`](#dockerescape) -* [`docker::sanitised_name`](#dockersanitised_name): == Function: docker::sanitised_name Function to sanitise container name. === Parameters [*name*] Name to sanitise +* [`docker::escape`](#docker--escape) +* [`docker::sanitised_name`](#docker--sanitised_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 @@ -92,128 +92,128 @@ Module to install an up-to-date version of Docker from package. 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) -* [`create_user`](#create_user) -* [`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_cli_package_name`](#docker_ce_cli_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) - -##### `version` +* [`version`](#-docker--version) +* [`ensure`](#-docker--ensure) +* [`prerequired_packages`](#-docker--prerequired_packages) +* [`dependent_packages`](#-docker--dependent_packages) +* [`tcp_bind`](#-docker--tcp_bind) +* [`tls_enable`](#-docker--tls_enable) +* [`tls_verify`](#-docker--tls_verify) +* [`tls_cacert`](#-docker--tls_cacert) +* [`tls_cert`](#-docker--tls_cert) +* [`tls_key`](#-docker--tls_key) +* [`ip_forward`](#-docker--ip_forward) +* [`iptables`](#-docker--iptables) +* [`ip_masq`](#-docker--ip_masq) +* [`icc`](#-docker--icc) +* [`bip`](#-docker--bip) +* [`mtu`](#-docker--mtu) +* [`bridge`](#-docker--bridge) +* [`fixed_cidr`](#-docker--fixed_cidr) +* [`default_gateway`](#-docker--default_gateway) +* [`ipv6`](#-docker--ipv6) +* [`ipv6_cidr`](#-docker--ipv6_cidr) +* [`default_gateway_ipv6`](#-docker--default_gateway_ipv6) +* [`socket_bind`](#-docker--socket_bind) +* [`log_level`](#-docker--log_level) +* [`log_driver`](#-docker--log_driver) +* [`log_opt`](#-docker--log_opt) +* [`selinux_enabled`](#-docker--selinux_enabled) +* [`use_upstream_package_source`](#-docker--use_upstream_package_source) +* [`pin_upstream_package_source`](#-docker--pin_upstream_package_source) +* [`apt_source_pin_level`](#-docker--apt_source_pin_level) +* [`service_state`](#-docker--service_state) +* [`service_enable`](#-docker--service_enable) +* [`manage_service`](#-docker--manage_service) +* [`root_dir`](#-docker--root_dir) +* [`dns`](#-docker--dns) +* [`dns_search`](#-docker--dns_search) +* [`socket_group`](#-docker--socket_group) +* [`extra_parameters`](#-docker--extra_parameters) +* [`shell_values`](#-docker--shell_values) +* [`proxy`](#-docker--proxy) +* [`no_proxy`](#-docker--no_proxy) +* [`storage_driver`](#-docker--storage_driver) +* [`dm_basesize`](#-docker--dm_basesize) +* [`dm_fs`](#-docker--dm_fs) +* [`dm_mkfsarg`](#-docker--dm_mkfsarg) +* [`dm_mountopt`](#-docker--dm_mountopt) +* [`dm_blocksize`](#-docker--dm_blocksize) +* [`dm_loopdatasize`](#-docker--dm_loopdatasize) +* [`dm_loopmetadatasize`](#-docker--dm_loopmetadatasize) +* [`dm_datadev`](#-docker--dm_datadev) +* [`dm_metadatadev`](#-docker--dm_metadatadev) +* [`dm_thinpooldev`](#-docker--dm_thinpooldev) +* [`dm_use_deferred_removal`](#-docker--dm_use_deferred_removal) +* [`dm_use_deferred_deletion`](#-docker--dm_use_deferred_deletion) +* [`dm_blkdiscard`](#-docker--dm_blkdiscard) +* [`dm_override_udev_sync_check`](#-docker--dm_override_udev_sync_check) +* [`overlay2_override_kernel_check`](#-docker--overlay2_override_kernel_check) +* [`manage_package`](#-docker--manage_package) +* [`service_name`](#-docker--service_name) +* [`docker_users`](#-docker--docker_users) +* [`create_user`](#-docker--create_user) +* [`docker_group`](#-docker--docker_group) +* [`daemon_environment_files`](#-docker--daemon_environment_files) +* [`repo_opt`](#-docker--repo_opt) +* [`storage_devs`](#-docker--storage_devs) +* [`storage_vg`](#-docker--storage_vg) +* [`storage_root_size`](#-docker--storage_root_size) +* [`storage_data_size`](#-docker--storage_data_size) +* [`storage_min_data_size`](#-docker--storage_min_data_size) +* [`storage_chunk_size`](#-docker--storage_chunk_size) +* [`storage_growpart`](#-docker--storage_growpart) +* [`storage_auto_extend_pool`](#-docker--storage_auto_extend_pool) +* [`storage_pool_autoextend_threshold`](#-docker--storage_pool_autoextend_threshold) +* [`storage_pool_autoextend_percent`](#-docker--storage_pool_autoextend_percent) +* [`tmp_dir_config`](#-docker--tmp_dir_config) +* [`tmp_dir`](#-docker--tmp_dir) +* [`registry_mirror`](#-docker--registry_mirror) +* [`nuget_package_provider_version`](#-docker--nuget_package_provider_version) +* [`docker_msft_provider_version`](#-docker--docker_msft_provider_version) +* [`docker_ce_start_command`](#-docker--docker_ce_start_command) +* [`docker_ce_package_name`](#-docker--docker_ce_package_name) +* [`docker_ce_cli_package_name`](#-docker--docker_ce_cli_package_name) +* [`docker_ce_source_location`](#-docker--docker_ce_source_location) +* [`docker_ce_key_source`](#-docker--docker_ce_key_source) +* [`docker_ce_key_id`](#-docker--docker_ce_key_id) +* [`docker_ce_release`](#-docker--docker_ce_release) +* [`docker_package_location`](#-docker--docker_package_location) +* [`docker_package_key_source`](#-docker--docker_package_key_source) +* [`docker_package_key_check_source`](#-docker--docker_package_key_check_source) +* [`docker_package_key_id`](#-docker--docker_package_key_id) +* [`docker_package_release`](#-docker--docker_package_release) +* [`docker_engine_start_command`](#-docker--docker_engine_start_command) +* [`docker_engine_package_name`](#-docker--docker_engine_package_name) +* [`docker_ce_channel`](#-docker--docker_ce_channel) +* [`docker_ee`](#-docker--docker_ee) +* [`docker_ee_package_name`](#-docker--docker_ee_package_name) +* [`docker_ee_source_location`](#-docker--docker_ee_source_location) +* [`docker_ee_key_source`](#-docker--docker_ee_key_source) +* [`docker_ee_key_id`](#-docker--docker_ee_key_id) +* [`docker_ee_repos`](#-docker--docker_ee_repos) +* [`docker_ee_release`](#-docker--docker_ee_release) +* [`package_release`](#-docker--package_release) +* [`labels`](#-docker--labels) +* [`execdriver`](#-docker--execdriver) +* [`package_source`](#-docker--package_source) +* [`os_lc`](#-docker--os_lc) +* [`storage_config`](#-docker--storage_config) +* [`storage_config_template`](#-docker--storage_config_template) +* [`storage_setup_file`](#-docker--storage_setup_file) +* [`service_provider`](#-docker--service_provider) +* [`service_config`](#-docker--service_config) +* [`service_config_template`](#-docker--service_config_template) +* [`service_overrides_template`](#-docker--service_overrides_template) +* [`socket_overrides_template`](#-docker--socket_overrides_template) +* [`socket_override`](#-docker--socket_override) +* [`service_after_override`](#-docker--service_after_override) +* [`service_hasstatus`](#-docker--service_hasstatus) +* [`service_hasrestart`](#-docker--service_hasrestart) +* [`acknowledge_unsupported_os`](#-docker--acknowledge_unsupported_os) +* [`have_systemd_v230`](#-docker--have_systemd_v230) + +##### `version` Data type: `Optional[String]` @@ -221,7 +221,7 @@ The package version to install, used to set the package name. Default value: `$docker::params::version` -##### `ensure` +##### `ensure` Data type: `String` @@ -229,7 +229,7 @@ Passed to the docker package. Default value: `$docker::params::ensure` -##### `prerequired_packages` +##### `prerequired_packages` Data type: `Variant[Array[String], Hash]` @@ -237,7 +237,7 @@ An array of additional packages that need to be installed to support docker. Default value: `$docker::params::prerequired_packages` -##### `dependent_packages` +##### `dependent_packages` Data type: `Array` @@ -246,7 +246,7 @@ Used when uninstalling to ensure containers cannot be run on the system. Default value: `$docker::params::dependent_packages` -##### `tcp_bind` +##### `tcp_bind` Data type: `Optional[Variant[String,Array[String]]]` @@ -255,7 +255,7 @@ tcp://127.0.0.1:4243 Default value: `$docker::params::tcp_bind` -##### `tls_enable` +##### `tls_enable` Data type: `Boolean` @@ -263,7 +263,7 @@ Enable TLS. Default value: `$docker::params::tls_enable` -##### `tls_verify` +##### `tls_verify` Data type: `Boolean` @@ -271,7 +271,7 @@ Use TLS and verify the remote Default value: `$docker::params::tls_verify` -##### `tls_cacert` +##### `tls_cacert` Data type: `Optional[String]` @@ -279,7 +279,7 @@ Path to TLS CA certificate Default value: `$docker::params::tls_cacert` -##### `tls_cert` +##### `tls_cert` Data type: `Optional[String]` @@ -287,7 +287,7 @@ Path to TLS certificate file Default value: `$docker::params::tls_cert` -##### `tls_key` +##### `tls_key` Data type: `Optional[String]` @@ -295,7 +295,7 @@ Path to TLS key file Default value: `$docker::params::tls_key` -##### `ip_forward` +##### `ip_forward` Data type: `Boolean` @@ -303,7 +303,7 @@ Enables IP forwarding on the Docker host. Default value: `$docker::params::ip_forward` -##### `iptables` +##### `iptables` Data type: `Boolean` @@ -311,7 +311,7 @@ Enable Docker's addition of iptables rules. Default value: `$docker::params::iptables` -##### `ip_masq` +##### `ip_masq` Data type: `Boolean` @@ -319,7 +319,7 @@ Enable IP masquerading for bridge's IP range. Default value: `$docker::params::ip_masq` -##### `icc` +##### `icc` Data type: `Optional[Boolean]` @@ -328,7 +328,7 @@ Enable or disable Docker's unrestricted inter-container and Docker daemon host c Default value: `$docker::params::icc` -##### `bip` +##### `bip` Data type: `Optional[String]` @@ -336,7 +336,7 @@ Specify docker's network bridge IP, in CIDR notation. Default value: `$docker::params::bip` -##### `mtu` +##### `mtu` Data type: `Optional[String]` @@ -344,7 +344,7 @@ Docker network MTU. Default value: `$docker::params::mtu` -##### `bridge` +##### `bridge` Data type: `Optional[String]` @@ -353,7 +353,7 @@ use 'none' to disable container networking Default value: `$docker::params::bridge` -##### `fixed_cidr` +##### `fixed_cidr` Data type: `Optional[String]` @@ -362,7 +362,7 @@ IPv4 subnet for fixed IPs Default value: `$docker::params::fixed_cidr` -##### `default_gateway` +##### `default_gateway` Data type: `Optional[String]` @@ -372,7 +372,7 @@ this address must be part of the bridge subnet Default value: `$docker::params::default_gateway` -##### `ipv6` +##### `ipv6` Data type: `Optional[Boolean]` @@ -380,7 +380,7 @@ Enables ipv6 support for the docker daemon Default value: `$docker::params::ipv6` -##### `ipv6_cidr` +##### `ipv6_cidr` Data type: `Optional[String]` @@ -388,7 +388,7 @@ IPv6 subnet for fixed IPs Default value: `$docker::params::ipv6_cidr` -##### `default_gateway_ipv6` +##### `default_gateway_ipv6` Data type: `Optional[String]` @@ -396,7 +396,7 @@ IPv6 address of the container default gateway: Default value: `$docker::params::default_gateway_ipv6` -##### `socket_bind` +##### `socket_bind` Data type: `String` @@ -404,7 +404,7 @@ The unix socket to bind to. Default value: `$docker::params::socket_bind` -##### `log_level` +##### `log_level` Data type: `Optional[String]` @@ -413,7 +413,7 @@ Valid values: debug, info, warn, error, fatal Default value: `$docker::params::log_level` -##### `log_driver` +##### `log_driver` Data type: `Optional[String]` @@ -425,7 +425,7 @@ Since custom log driver plugins are and must be possible, the value can not be v Default value: `$docker::params::log_driver` -##### `log_opt` +##### `log_opt` Data type: `Array` @@ -471,7 +471,7 @@ Valid values per log driver: Default value: `$docker::params::log_opt` -##### `selinux_enabled` +##### `selinux_enabled` Data type: `Optional[Boolean]` @@ -480,7 +480,7 @@ support the BTRFS storage driver. Default value: `$docker::params::selinux_enabled` -##### `use_upstream_package_source` +##### `use_upstream_package_source` Data type: `Optional[Boolean]` @@ -490,7 +490,7 @@ to false. Default value: `$docker::params::use_upstream_package_source` -##### `pin_upstream_package_source` +##### `pin_upstream_package_source` Data type: `Optional[Boolean]` @@ -500,7 +500,7 @@ package repository. See also "apt_source_pin_level". Default value: `$docker::params::pin_upstream_package_source` -##### `apt_source_pin_level` +##### `apt_source_pin_level` Data type: `Optional[Integer]` @@ -512,7 +512,7 @@ define pins is removed. Default value: `$docker::params::apt_source_pin_level` -##### `service_state` +##### `service_state` Data type: `String` @@ -520,7 +520,7 @@ Whether you want to docker daemon to start up Default value: `$docker::params::service_state` -##### `service_enable` +##### `service_enable` Data type: `Boolean` @@ -528,7 +528,7 @@ Whether you want to docker daemon to start up at boot Default value: `$docker::params::service_enable` -##### `manage_service` +##### `manage_service` Data type: `Boolean` @@ -536,7 +536,7 @@ Specify whether the service should be managed. Default value: `$docker::params::manage_service` -##### `root_dir` +##### `root_dir` Data type: `Optional[String]` @@ -544,7 +544,7 @@ Custom root directory for containers Default value: `$docker::params::root_dir` -##### `dns` +##### `dns` Data type: `Optional[Variant[String,Array]]` @@ -552,7 +552,7 @@ Custom dns server address Default value: `$docker::params::dns` -##### `dns_search` +##### `dns_search` Data type: `Optional[Variant[String,Array]]` @@ -560,7 +560,7 @@ Custom dns search domains Default value: `$docker::params::dns_search` -##### `socket_group` +##### `socket_group` Data type: `Optional[Variant[String,Boolean]]` @@ -568,23 +568,23 @@ Group ownership of the unix control socket. Default value: `$docker::params::socket_group` -##### `extra_parameters` +##### `extra_parameters` Data type: `Optional[Variant[String,Array]]` Any extra parameters that should be passed to the docker daemon. -Default value: ``undef`` +Default value: `undef` -##### `shell_values` +##### `shell_values` Data type: `Optional[Variant[String,Array]]` Array of shell values to pass into init script config files -Default value: ``undef`` +Default value: `undef` -##### `proxy` +##### `proxy` Data type: `Optional[String]` @@ -592,7 +592,7 @@ Will set the http_proxy and https_proxy env variables in /etc/sysconfig/docker ( Default value: `$docker::params::proxy` -##### `no_proxy` +##### `no_proxy` Data type: `Optional[String]` @@ -600,7 +600,7 @@ Will set the no_proxy variable in /etc/sysconfig/docker (redhat/centos) or /etc/ Default value: `$docker::params::no_proxy` -##### `storage_driver` +##### `storage_driver` Data type: `Optional[String]` @@ -609,7 +609,7 @@ Valid values: aufs, devicemapper, btrfs, overlay, overlay2, vfs, zfs Default value: `$docker::params::storage_driver` -##### `dm_basesize` +##### `dm_basesize` Data type: `Optional[String]` @@ -617,7 +617,7 @@ The size to use when creating the base device, which limits the size of images a Default value: `$docker::params::dm_basesize` -##### `dm_fs` +##### `dm_fs` Data type: `Optional[String]` @@ -625,7 +625,7 @@ The filesystem to use for the base image (xfs or ext4) Default value: `$docker::params::dm_fs` -##### `dm_mkfsarg` +##### `dm_mkfsarg` Data type: `Optional[String]` @@ -633,7 +633,7 @@ Specifies extra mkfs arguments to be used when creating the base device. Default value: `$docker::params::dm_mkfsarg` -##### `dm_mountopt` +##### `dm_mountopt` Data type: `Optional[String]` @@ -641,7 +641,7 @@ Specifies extra mount options used when mounting the thin devices. Default value: `$docker::params::dm_mountopt` -##### `dm_blocksize` +##### `dm_blocksize` Data type: `Optional[String]` @@ -651,7 +651,7 @@ Warning: _DO NOT_ change this parameter after the lvm devices have been initiali Default value: `$docker::params::dm_blocksize` -##### `dm_loopdatasize` +##### `dm_loopdatasize` Data type: `Optional[String]` @@ -659,7 +659,7 @@ Specifies the size to use when creating the loopback file for the "data" device Default value: `$docker::params::dm_loopdatasize` -##### `dm_loopmetadatasize` +##### `dm_loopmetadatasize` Data type: `Optional[String]` @@ -667,7 +667,7 @@ Specifies the size to use when creating the loopback file for the "metadata" dev Default value: `$docker::params::dm_loopmetadatasize` -##### `dm_datadev` +##### `dm_datadev` Data type: `Optional[String]` @@ -676,7 +676,7 @@ A custom blockdevice to use for data for the thin pool. Default value: `$docker::params::dm_datadev` -##### `dm_metadatadev` +##### `dm_metadatadev` Data type: `Optional[String]` @@ -685,7 +685,7 @@ A custom blockdevice to use for metadata for the thin pool. Default value: `$docker::params::dm_metadatadev` -##### `dm_thinpooldev` +##### `dm_thinpooldev` Data type: `Optional[String]` @@ -693,7 +693,7 @@ Specifies a custom block storage device to use for the thin pool. Default value: `$docker::params::dm_thinpooldev` -##### `dm_use_deferred_removal` +##### `dm_use_deferred_removal` Data type: `Optional[Boolean]` @@ -701,7 +701,7 @@ Enables use of deferred device removal if libdm and the kernel driver support th Default value: `$docker::params::dm_use_deferred_removal` -##### `dm_use_deferred_deletion` +##### `dm_use_deferred_deletion` Data type: `Optional[Boolean]` @@ -709,7 +709,7 @@ Enables use of deferred device deletion if libdm and the kernel driver support t Default value: `$docker::params::dm_use_deferred_deletion` -##### `dm_blkdiscard` +##### `dm_blkdiscard` Data type: `Optional[Boolean]` @@ -717,7 +717,7 @@ Enables or disables the use of blkdiscard when removing devicemapper devices. Default value: `$docker::params::dm_blkdiscard` -##### `dm_override_udev_sync_check` +##### `dm_override_udev_sync_check` Data type: `Optional[Boolean]` @@ -727,7 +727,7 @@ synchronization, to continue even though the configuration may be buggy. Default value: `$docker::params::dm_override_udev_sync_check` -##### `overlay2_override_kernel_check` +##### `overlay2_override_kernel_check` Data type: `Boolean` @@ -735,7 +735,7 @@ Overrides the Linux kernel version check allowing using overlay2 with kernel < 4 Default value: `$docker::params::overlay2_override_kernel_check` -##### `manage_package` +##### `manage_package` Data type: `Boolean` @@ -743,7 +743,7 @@ Won't install or define the docker package, useful if you want to use your own p Default value: `$docker::params::manage_package` -##### `service_name` +##### `service_name` Data type: `Optional[String]` @@ -751,7 +751,7 @@ Specify custom service name Default value: `$docker::params::service_name` -##### `docker_users` +##### `docker_users` Data type: `Array` @@ -759,15 +759,15 @@ Specify an array of users to add to the docker group Default value: `[]` -##### `create_user` +##### `create_user` Data type: `Boolean` If `true` the list of `docker_users` will be created as well as added to the docker group -Default value: ``true`` +Default value: `true` -##### `docker_group` +##### `docker_group` Data type: `String` @@ -775,7 +775,7 @@ Specify a string for the docker group Default value: `$docker::params::docker_group` -##### `daemon_environment_files` +##### `daemon_environment_files` Data type: `Array` @@ -784,7 +784,7 @@ service-overrides.conf Default value: `[]` -##### `repo_opt` +##### `repo_opt` Data type: `Optional[Variant[String,Hash]]` @@ -792,7 +792,7 @@ Specify a string to pass as repository options (RedHat only) Default value: `$docker::params::repo_opt` -##### `storage_devs` +##### `storage_devs` Data type: `Optional[String]` @@ -800,7 +800,7 @@ A quoted, space-separated list of devices to be used. Default value: `$docker::params::storage_devs` -##### `storage_vg` +##### `storage_vg` Data type: `Optional[String]` @@ -808,7 +808,7 @@ The volume group to use for docker storage. Default value: `$docker::params::storage_vg` -##### `storage_root_size` +##### `storage_root_size` Data type: `Optional[String]` @@ -816,7 +816,7 @@ The size to which the root filesystem should be grown. Default value: `$docker::params::storage_root_size` -##### `storage_data_size` +##### `storage_data_size` Data type: `Optional[String]` @@ -824,7 +824,7 @@ The desired size for the docker data LV Default value: `$docker::params::storage_data_size` -##### `storage_min_data_size` +##### `storage_min_data_size` Data type: `Optional[String]` @@ -832,7 +832,7 @@ The minimum size of data volume otherwise pool creation fails Default value: `$docker::params::storage_min_data_size` -##### `storage_chunk_size` +##### `storage_chunk_size` Data type: `Optional[String]` @@ -840,7 +840,7 @@ Controls the chunk size/block size of thin pool. Default value: `$docker::params::storage_chunk_size` -##### `storage_growpart` +##### `storage_growpart` Data type: `Optional[Boolean]` @@ -848,7 +848,7 @@ Enable resizing partition table backing root volume group. Default value: `$docker::params::storage_growpart` -##### `storage_auto_extend_pool` +##### `storage_auto_extend_pool` Data type: `Optional[String]` @@ -856,7 +856,7 @@ Enable/disable automatic pool extension using lvm Default value: `$docker::params::storage_auto_extend_pool` -##### `storage_pool_autoextend_threshold` +##### `storage_pool_autoextend_threshold` Data type: `Optional[String]` @@ -864,7 +864,7 @@ Auto pool extension threshold (in % of pool size) Default value: `$docker::params::storage_pool_autoextend_threshold` -##### `storage_pool_autoextend_percent` +##### `storage_pool_autoextend_percent` Data type: `Optional[String]` @@ -872,7 +872,7 @@ Extend the pool by specified percentage when threshold is hit. Default value: `$docker::params::storage_pool_autoextend_percent` -##### `tmp_dir_config` +##### `tmp_dir_config` Data type: `Optional[Boolean]` @@ -882,7 +882,7 @@ Note: false is backwards compatible prior to PR #58 Default value: `$docker::params::tmp_dir_config` -##### `tmp_dir` +##### `tmp_dir` Data type: `Optional[String]` @@ -890,7 +890,7 @@ Sets the tmp dir for Docker (path) Default value: `$docker::params::tmp_dir` -##### `registry_mirror` +##### `registry_mirror` Data type: `Optional[Variant[String,Array]]` @@ -898,7 +898,7 @@ Sets the prefered container registry mirror. Default value: `$docker::params::registry_mirror` -##### `nuget_package_provider_version` +##### `nuget_package_provider_version` Data type: `Optional[String]` @@ -906,7 +906,7 @@ The version of the NuGet Package provider Default value: `$docker::params::nuget_package_provider_version` -##### `docker_msft_provider_version` +##### `docker_msft_provider_version` Data type: `Optional[String]` @@ -914,7 +914,7 @@ The version of the Microsoft Docker Provider Module Default value: `$docker::params::docker_msft_provider_version` -##### `docker_ce_start_command` +##### `docker_ce_start_command` Data type: `String` @@ -922,7 +922,7 @@ Data type: `String` Default value: `$docker::params::docker_ce_start_command` -##### `docker_ce_package_name` +##### `docker_ce_package_name` Data type: `Optional[String]` @@ -930,7 +930,7 @@ Data type: `Optional[String]` Default value: `$docker::params::docker_ce_package_name` -##### `docker_ce_cli_package_name` +##### `docker_ce_cli_package_name` Data type: `String[1]` @@ -938,7 +938,7 @@ Data type: `String[1]` Default value: `$docker::params::docker_ce_cli_package_name` -##### `docker_ce_source_location` +##### `docker_ce_source_location` Data type: `Optional[String]` @@ -946,7 +946,7 @@ Data type: `Optional[String]` Default value: `$docker::params::package_ce_source_location` -##### `docker_ce_key_source` +##### `docker_ce_key_source` Data type: `Optional[String]` @@ -954,7 +954,7 @@ Data type: `Optional[String]` Default value: `$docker::params::package_ce_key_source` -##### `docker_ce_key_id` +##### `docker_ce_key_id` Data type: `Optional[String]` @@ -962,7 +962,7 @@ Data type: `Optional[String]` Default value: `$docker::params::package_ce_key_id` -##### `docker_ce_release` +##### `docker_ce_release` Data type: `Optional[String]` @@ -970,7 +970,7 @@ Data type: `Optional[String]` Default value: `$docker::params::package_ce_release` -##### `docker_package_location` +##### `docker_package_location` Data type: `Optional[String]` @@ -978,7 +978,7 @@ Data type: `Optional[String]` Default value: `$docker::params::package_source_location` -##### `docker_package_key_source` +##### `docker_package_key_source` Data type: `Optional[String]` @@ -986,7 +986,7 @@ Data type: `Optional[String]` Default value: `$docker::params::package_key_source` -##### `docker_package_key_check_source` +##### `docker_package_key_check_source` Data type: `Optional[Boolean]` @@ -994,7 +994,7 @@ Data type: `Optional[Boolean]` Default value: `$docker::params::package_key_check_source` -##### `docker_package_key_id` +##### `docker_package_key_id` Data type: `Optional[String]` @@ -1002,7 +1002,7 @@ Data type: `Optional[String]` Default value: `$docker::params::package_key_id` -##### `docker_package_release` +##### `docker_package_release` Data type: `Optional[String]` @@ -1010,7 +1010,7 @@ Data type: `Optional[String]` Default value: `$docker::params::package_release` -##### `docker_engine_start_command` +##### `docker_engine_start_command` Data type: `String` @@ -1018,7 +1018,7 @@ Data type: `String` Default value: `$docker::params::docker_engine_start_command` -##### `docker_engine_package_name` +##### `docker_engine_package_name` Data type: `String` @@ -1026,7 +1026,7 @@ Data type: `String` Default value: `$docker::params::docker_engine_package_name` -##### `docker_ce_channel` +##### `docker_ce_channel` Data type: `String` @@ -1034,7 +1034,7 @@ Data type: `String` Default value: `$docker::params::docker_ce_channel` -##### `docker_ee` +##### `docker_ee` Data type: `Optional[Boolean]` @@ -1042,7 +1042,7 @@ Data type: `Optional[Boolean]` Default value: `$docker::params::docker_ee` -##### `docker_ee_package_name` +##### `docker_ee_package_name` Data type: `Optional[String]` @@ -1050,7 +1050,7 @@ Data type: `Optional[String]` Default value: `$docker::params::package_ee_package_name` -##### `docker_ee_source_location` +##### `docker_ee_source_location` Data type: `Optional[String]` @@ -1058,7 +1058,7 @@ Data type: `Optional[String]` Default value: `$docker::params::package_ee_source_location` -##### `docker_ee_key_source` +##### `docker_ee_key_source` Data type: `Optional[String]` @@ -1066,7 +1066,7 @@ Data type: `Optional[String]` Default value: `$docker::params::package_ee_key_source` -##### `docker_ee_key_id` +##### `docker_ee_key_id` Data type: `Optional[String]` @@ -1074,7 +1074,7 @@ Data type: `Optional[String]` Default value: `$docker::params::package_ee_key_id` -##### `docker_ee_repos` +##### `docker_ee_repos` Data type: `Optional[String]` @@ -1082,7 +1082,7 @@ Data type: `Optional[String]` Default value: `$docker::params::package_ee_repos` -##### `docker_ee_release` +##### `docker_ee_release` Data type: `Optional[String]` @@ -1090,7 +1090,7 @@ Data type: `Optional[String]` Default value: `$docker::params::package_ee_release` -##### `package_release` +##### `package_release` Data type: `Optional[String]` @@ -1098,7 +1098,7 @@ Data type: `Optional[String]` Default value: `$docker::params::package_release` -##### `labels` +##### `labels` Data type: `Array` @@ -1106,7 +1106,7 @@ Data type: `Array` Default value: `$docker::params::labels` -##### `execdriver` +##### `execdriver` Data type: `Optional[String]` @@ -1114,7 +1114,7 @@ Data type: `Optional[String]` Default value: `$docker::params::execdriver` -##### `package_source` +##### `package_source` Data type: `Optional[String]` @@ -1122,7 +1122,7 @@ Data type: `Optional[String]` Default value: `$docker::params::package_source` -##### `os_lc` +##### `os_lc` Data type: `Optional[String]` @@ -1130,7 +1130,7 @@ Data type: `Optional[String]` Default value: `$docker::params::os_lc` -##### `storage_config` +##### `storage_config` Data type: `Optional[Variant[String,Boolean]]` @@ -1138,7 +1138,7 @@ Data type: `Optional[Variant[String,Boolean]]` Default value: `$docker::params::storage_config` -##### `storage_config_template` +##### `storage_config_template` Data type: `Optional[String]` @@ -1146,7 +1146,7 @@ Data type: `Optional[String]` Default value: `$docker::params::storage_config_template` -##### `storage_setup_file` +##### `storage_setup_file` Data type: `Optional[String]` @@ -1154,7 +1154,7 @@ Data type: `Optional[String]` Default value: `$docker::params::storage_setup_file` -##### `service_provider` +##### `service_provider` Data type: `Optional[String]` @@ -1162,7 +1162,7 @@ Data type: `Optional[String]` Default value: `$docker::params::service_provider` -##### `service_config` +##### `service_config` Data type: `Optional[Variant[String,Boolean]]` @@ -1170,7 +1170,7 @@ Data type: `Optional[Variant[String,Boolean]]` Default value: `$docker::params::service_config` -##### `service_config_template` +##### `service_config_template` Data type: `Optional[String]` @@ -1178,7 +1178,7 @@ Data type: `Optional[String]` Default value: `$docker::params::service_config_template` -##### `service_overrides_template` +##### `service_overrides_template` Data type: `Optional[Variant[String,Boolean]]` @@ -1186,7 +1186,7 @@ Data type: `Optional[Variant[String,Boolean]]` Default value: `$docker::params::service_overrides_template` -##### `socket_overrides_template` +##### `socket_overrides_template` Data type: `Optional[Variant[String,Boolean]]` @@ -1194,7 +1194,7 @@ Data type: `Optional[Variant[String,Boolean]]` Default value: `$docker::params::socket_overrides_template` -##### `socket_override` +##### `socket_override` Data type: `Optional[Boolean]` @@ -1202,7 +1202,7 @@ Data type: `Optional[Boolean]` Default value: `$docker::params::socket_override` -##### `service_after_override` +##### `service_after_override` Data type: `Optional[Variant[String,Boolean]]` @@ -1210,7 +1210,7 @@ Data type: `Optional[Variant[String,Boolean]]` Default value: `$docker::params::service_after_override` -##### `service_hasstatus` +##### `service_hasstatus` Data type: `Optional[Boolean]` @@ -1218,7 +1218,7 @@ Data type: `Optional[Boolean]` Default value: `$docker::params::service_hasstatus` -##### `service_hasrestart` +##### `service_hasrestart` Data type: `Optional[Boolean]` @@ -1226,15 +1226,15 @@ Data type: `Optional[Boolean]` Default value: `$docker::params::service_hasrestart` -##### `acknowledge_unsupported_os` +##### `acknowledge_unsupported_os` Data type: `Boolean` -Default value: ``false`` +Default value: `false` -##### `have_systemd_v230` +##### `have_systemd_v230` Data type: `Boolean` @@ -1242,7 +1242,7 @@ Data type: `Boolean` Default value: `$docker::params::have_systemd_v230` -### `docker::compose` +### `docker::compose` install Docker Compose using the recommended curl command. @@ -1250,16 +1250,16 @@ install Docker Compose using the recommended curl command. 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) +* [`ensure`](#-docker--compose--ensure) +* [`version`](#-docker--compose--version) +* [`install_path`](#-docker--compose--install_path) +* [`symlink_name`](#-docker--compose--symlink_name) +* [`proxy`](#-docker--compose--proxy) +* [`base_url`](#-docker--compose--base_url) +* [`raw_url`](#-docker--compose--raw_url) +* [`curl_ensure`](#-docker--compose--curl_ensure) -##### `ensure` +##### `ensure` Data type: `Enum[present,absent]` @@ -1268,7 +1268,7 @@ Valid values are absent present Default value: `present` -##### `version` +##### `version` Data type: `Optional[String]` @@ -1276,7 +1276,7 @@ The version of Docker Compose to install. Default value: `$docker::params::compose_version` -##### `install_path` +##### `install_path` Data type: `Optional[String]` @@ -1284,7 +1284,7 @@ The path where to install Docker Compose. Default value: `$docker::params::compose_install_path` -##### `symlink_name` +##### `symlink_name` Data type: `Optional[String]` @@ -1294,15 +1294,15 @@ necessary to set certain things before running the docker-compose binary Default value: `$docker::params::compose_symlink_name` -##### `proxy` +##### `proxy` Data type: `Optional[String]` Proxy to use for downloading Docker Compose. -Default value: ``undef`` +Default value: `undef` -##### `base_url` +##### `base_url` Data type: `Optional[String]` @@ -1312,7 +1312,7 @@ official repository Default value: `$docker::params::compose_base_url` -##### `raw_url` +##### `raw_url` Data type: `Optional[String]` @@ -1321,9 +1321,9 @@ 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`` +Default value: `undef` -##### `curl_ensure` +##### `curl_ensure` Data type: `Optional[Boolean]` @@ -1331,7 +1331,7 @@ Whether or not the curl package is ensured by this module. Default value: `$docker::params::curl_ensure` -### `docker::images` +### `docker::images` The docker::images class. @@ -1339,15 +1339,15 @@ The docker::images class. The following parameters are available in the `docker::images` class: -* [`images`](#images) +* [`images`](#-docker--images--images) -##### `images` +##### `images` -Data type: `Any` +Data type: `Hash` -### `docker::install` +### `docker::install` Module to install an up-to-date version of Docker from a package repository. Only for Debian, Red Hat and Windows @@ -1356,62 +1356,62 @@ Only for Debian, Red Hat and Windows 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) +* [`version`](#-docker--install--version) +* [`nuget_package_provider_version`](#-docker--install--nuget_package_provider_version) +* [`docker_msft_provider_version`](#-docker--install--docker_msft_provider_version) +* [`docker_ee_package_name`](#-docker--install--docker_ee_package_name) +* [`docker_download_url`](#-docker--install--docker_download_url) +* [`dependent_packages`](#-docker--install--dependent_packages) -##### `version` +##### `version` -Data type: `Any` +Data type: `Optional[String]` The package version to install, used to set the package name. Default value: `$docker::version` -##### `nuget_package_provider_version` +##### `nuget_package_provider_version` -Data type: `Any` +Data type: `Optional[String]` The version of the NuGet Package provider Default value: `$docker::nuget_package_provider_version` -##### `docker_msft_provider_version` +##### `docker_msft_provider_version` -Data type: `Any` +Data type: `Optional[String]` The version of the Microsoft Docker Provider Module Default value: `$docker::docker_msft_provider_version` -##### `docker_ee_package_name` +##### `docker_ee_package_name` -Data type: `Any` +Data type: `Optional[String]` The name of the Docker Enterprise Edition package Default value: `$docker::docker_ee_package_name` -##### `docker_download_url` +##### `docker_download_url` -Data type: `Any` +Data type: `Optional[String]` Default value: `$docker::package_location` -##### `dependent_packages` +##### `dependent_packages` -Data type: `Any` +Data type: `Array` Default value: `$docker::dependent_packages` -### `docker::machine` +### `docker::machine` install Docker Machine using the recommended curl command. @@ -1419,14 +1419,14 @@ install Docker Machine using the recommended curl command. 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) +* [`ensure`](#-docker--machine--ensure) +* [`version`](#-docker--machine--version) +* [`install_path`](#-docker--machine--install_path) +* [`proxy`](#-docker--machine--proxy) +* [`url`](#-docker--machine--url) +* [`curl_ensure`](#-docker--machine--curl_ensure) -##### `ensure` +##### `ensure` Data type: `Enum[present,absent]` @@ -1435,7 +1435,7 @@ Valid values are absent present Default value: `'present'` -##### `version` +##### `version` Data type: `Optional[String]` @@ -1443,7 +1443,7 @@ The version of Docker Machine to install. Default value: `$docker::params::machine_version` -##### `install_path` +##### `install_path` Data type: `Optional[String]` @@ -1451,23 +1451,23 @@ The path where to install Docker Machine. Default value: `$docker::params::machine_install_path` -##### `proxy` +##### `proxy` Data type: `Optional[String]` Proxy to use for downloading Docker Machine. -Default value: ``undef`` +Default value: `undef` -##### `url` +##### `url` Data type: `Optional[Variant[Stdlib::HTTPUrl, Stdlib::HTTPSUrl]]` The URL from which the docker machine binary should be fetched -Default value: ``undef`` +Default value: `undef` -##### `curl_ensure` +##### `curl_ensure` Data type: `Optional[Boolean]` @@ -1475,7 +1475,7 @@ Whether or not the curl package is ensured by this module. Default value: `$docker::params::curl_ensure` -### `docker::networks` +### `docker::networks` The docker::networks class. @@ -1483,21 +1483,21 @@ The docker::networks class. The following parameters are available in the `docker::networks` class: -* [`networks`](#networks) +* [`networks`](#-docker--networks--networks) -##### `networks` +##### `networks` Data type: `Optional[Hash[String, Hash]]` -Default value: ``undef`` +Default value: `undef` -### `docker::params` +### `docker::params` Default parameter values for the docker module -### `docker::plugins` +### `docker::plugins` The docker::plugins class. @@ -1505,15 +1505,15 @@ The docker::plugins class. The following parameters are available in the `docker::plugins` class: -* [`plugins`](#plugins) +* [`plugins`](#-docker--plugins--plugins) -##### `plugins` +##### `plugins` -Data type: `Any` +Data type: `Hash` -### `docker::registry_auth` +### `docker::registry_auth` The docker::registry_auth class. @@ -1521,15 +1521,15 @@ The docker::registry_auth class. The following parameters are available in the `docker::registry_auth` class: -* [`registries`](#registries) +* [`registries`](#-docker--registry_auth--registries) -##### `registries` +##### `registries` -Data type: `Any` +Data type: `Hash` -### `docker::repos` +### `docker::repos` The docker::repos class. @@ -1537,44 +1537,44 @@ The docker::repos class. The following parameters are available in the `docker::repos` class: -* [`location`](#location) -* [`key_source`](#key_source) -* [`key_check_source`](#key_check_source) -* [`architecture`](#architecture) +* [`location`](#-docker--repos--location) +* [`key_source`](#-docker--repos--key_source) +* [`key_check_source`](#-docker--repos--key_check_source) +* [`architecture`](#-docker--repos--architecture) -##### `location` +##### `location` -Data type: `Any` +Data type: `Optional[String]` Default value: `$docker::package_location` -##### `key_source` +##### `key_source` -Data type: `Any` +Data type: `Optional[String]` Default value: `$docker::package_key_source` -##### `key_check_source` +##### `key_check_source` -Data type: `Any` +Data type: `Optional[Boolean]` Default value: `$docker::package_key_check_source` -##### `architecture` +##### `architecture` -Data type: `Any` +Data type: `String` Default value: `$facts['os']['architecture']` -### `docker::run_instance` +### `docker::run_instance` The docker::run_instance class. @@ -1582,15 +1582,15 @@ The docker::run_instance class. The following parameters are available in the `docker::run_instance` class: -* [`instance`](#instance) +* [`instance`](#-docker--run_instance--instance) -##### `instance` +##### `instance` -Data type: `Any` +Data type: `Hash` -### `docker::service` +### `docker::service` manage the docker service daemon @@ -1598,165 +1598,165 @@ manage the docker service daemon 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) - -##### `tcp_bind` +* [`tcp_bind`](#-docker--service--tcp_bind) +* [`ip_forward`](#-docker--service--ip_forward) +* [`iptables`](#-docker--service--iptables) +* [`ip_masq`](#-docker--service--ip_masq) +* [`socket_bind`](#-docker--service--socket_bind) +* [`socket_group`](#-docker--service--socket_group) +* [`root_dir`](#-docker--service--root_dir) +* [`extra_parameters`](#-docker--service--extra_parameters) +* [`shell_values`](#-docker--service--shell_values) +* [`manage_service`](#-docker--service--manage_service) +* [`docker_command`](#-docker--service--docker_command) +* [`docker_start_command`](#-docker--service--docker_start_command) +* [`service_name`](#-docker--service--service_name) +* [`icc`](#-docker--service--icc) +* [`bridge`](#-docker--service--bridge) +* [`fixed_cidr`](#-docker--service--fixed_cidr) +* [`default_gateway`](#-docker--service--default_gateway) +* [`ipv6`](#-docker--service--ipv6) +* [`ipv6_cidr`](#-docker--service--ipv6_cidr) +* [`default_gateway_ipv6`](#-docker--service--default_gateway_ipv6) +* [`log_level`](#-docker--service--log_level) +* [`log_driver`](#-docker--service--log_driver) +* [`log_opt`](#-docker--service--log_opt) +* [`selinux_enabled`](#-docker--service--selinux_enabled) +* [`labels`](#-docker--service--labels) +* [`dns`](#-docker--service--dns) +* [`dns_search`](#-docker--service--dns_search) +* [`service_state`](#-docker--service--service_state) +* [`service_enable`](#-docker--service--service_enable) +* [`proxy`](#-docker--service--proxy) +* [`no_proxy`](#-docker--service--no_proxy) +* [`execdriver`](#-docker--service--execdriver) +* [`bip`](#-docker--service--bip) +* [`mtu`](#-docker--service--mtu) +* [`storage_driver`](#-docker--service--storage_driver) +* [`dm_basesize`](#-docker--service--dm_basesize) +* [`dm_fs`](#-docker--service--dm_fs) +* [`dm_mkfsarg`](#-docker--service--dm_mkfsarg) +* [`dm_mountopt`](#-docker--service--dm_mountopt) +* [`dm_blocksize`](#-docker--service--dm_blocksize) +* [`dm_loopdatasize`](#-docker--service--dm_loopdatasize) +* [`dm_loopmetadatasize`](#-docker--service--dm_loopmetadatasize) +* [`dm_datadev`](#-docker--service--dm_datadev) +* [`dm_metadatadev`](#-docker--service--dm_metadatadev) +* [`tmp_dir_config`](#-docker--service--tmp_dir_config) +* [`tmp_dir`](#-docker--service--tmp_dir) +* [`dm_thinpooldev`](#-docker--service--dm_thinpooldev) +* [`dm_use_deferred_removal`](#-docker--service--dm_use_deferred_removal) +* [`dm_use_deferred_deletion`](#-docker--service--dm_use_deferred_deletion) +* [`dm_blkdiscard`](#-docker--service--dm_blkdiscard) +* [`dm_override_udev_sync_check`](#-docker--service--dm_override_udev_sync_check) +* [`overlay2_override_kernel_check`](#-docker--service--overlay2_override_kernel_check) +* [`storage_devs`](#-docker--service--storage_devs) +* [`storage_vg`](#-docker--service--storage_vg) +* [`storage_root_size`](#-docker--service--storage_root_size) +* [`storage_data_size`](#-docker--service--storage_data_size) +* [`storage_min_data_size`](#-docker--service--storage_min_data_size) +* [`storage_chunk_size`](#-docker--service--storage_chunk_size) +* [`storage_growpart`](#-docker--service--storage_growpart) +* [`storage_auto_extend_pool`](#-docker--service--storage_auto_extend_pool) +* [`storage_pool_autoextend_threshold`](#-docker--service--storage_pool_autoextend_threshold) +* [`storage_pool_autoextend_percent`](#-docker--service--storage_pool_autoextend_percent) +* [`storage_config`](#-docker--service--storage_config) +* [`storage_config_template`](#-docker--service--storage_config_template) +* [`storage_setup_file`](#-docker--service--storage_setup_file) +* [`service_provider`](#-docker--service--service_provider) +* [`service_config`](#-docker--service--service_config) +* [`service_config_template`](#-docker--service--service_config_template) +* [`service_overrides_template`](#-docker--service--service_overrides_template) +* [`socket_overrides_template`](#-docker--service--socket_overrides_template) +* [`socket_override`](#-docker--service--socket_override) +* [`service_after_override`](#-docker--service--service_after_override) +* [`service_hasstatus`](#-docker--service--service_hasstatus) +* [`service_hasrestart`](#-docker--service--service_hasrestart) +* [`daemon_environment_files`](#-docker--service--daemon_environment_files) +* [`tls_enable`](#-docker--service--tls_enable) +* [`tls_verify`](#-docker--service--tls_verify) +* [`tls_cacert`](#-docker--service--tls_cacert) +* [`tls_cert`](#-docker--service--tls_cert) +* [`tls_key`](#-docker--service--tls_key) +* [`registry_mirror`](#-docker--service--registry_mirror) +* [`root_dir_flag`](#-docker--service--root_dir_flag) + +##### `tcp_bind` -Data type: `Any` +Data type: `Optional[Variant[String,Array[String]]]` Which tcp port, if any, to bind the docker service to. Default value: `$docker::tcp_bind` -##### `ip_forward` +##### `ip_forward` -Data type: `Any` +Data type: `Boolean` This flag interacts with the IP forwarding setting on your host system's kernel Default value: `$docker::ip_forward` -##### `iptables` +##### `iptables` -Data type: `Any` +Data type: `Boolean` Enable Docker's addition of iptables rules Default value: `$docker::iptables` -##### `ip_masq` +##### `ip_masq` -Data type: `Any` +Data type: `Boolean` Enable IP masquerading for bridge's IP range. Default value: `$docker::ip_masq` -##### `socket_bind` +##### `socket_bind` -Data type: `Any` +Data type: `String` Which local unix socket to bind the docker service to. Default value: `$docker::socket_bind` -##### `socket_group` +##### `socket_group` -Data type: `Any` +Data type: `Optional[Variant[String,Boolean]]` Which local unix socket to bind the docker service to. Default value: `$docker::socket_group` -##### `root_dir` +##### `root_dir` -Data type: `Any` +Data type: `Optional[String]` Specify a non-standard root directory for docker. Default value: `$docker::root_dir` -##### `extra_parameters` +##### `extra_parameters` -Data type: `Any` +Data type: `Optional[Variant[String,Array]]` Plain additional parameters to pass to the docker daemon Default value: `$docker::extra_parameters` -##### `shell_values` +##### `shell_values` -Data type: `Any` +Data type: `Optional[Variant[String,Array]]` Array of shell values to pass into init script config files Default value: `$docker::shell_values` -##### `manage_service` +##### `manage_service` -Data type: `Any` +Data type: `Boolean` Specify whether the service should be managed. Valid values are 'true', 'false'. @@ -1764,583 +1764,583 @@ Defaults to 'true'. Default value: `$docker::manage_service` -##### `docker_command` +##### `docker_command` -Data type: `Any` +Data type: `String` Default value: `$docker::docker_command` -##### `docker_start_command` +##### `docker_start_command` -Data type: `Any` +Data type: `String` Default value: `$docker::docker_start_command` -##### `service_name` +##### `service_name` -Data type: `Any` +Data type: `Optional[String]` Default value: `$docker::service_name` -##### `icc` +##### `icc` -Data type: `Any` +Data type: `Optional[Boolean]` Default value: `$docker::icc` -##### `bridge` +##### `bridge` -Data type: `Any` +Data type: `Optional[String]` Default value: `$docker::bridge` -##### `fixed_cidr` +##### `fixed_cidr` -Data type: `Any` +Data type: `Optional[String]` Default value: `$docker::fixed_cidr` -##### `default_gateway` +##### `default_gateway` -Data type: `Any` +Data type: `Optional[String]` Default value: `$docker::default_gateway` -##### `ipv6` +##### `ipv6` -Data type: `Any` +Data type: `Optional[Boolean]` Default value: `$docker::ipv6` -##### `ipv6_cidr` +##### `ipv6_cidr` -Data type: `Any` +Data type: `Optional[String]` Default value: `$docker::ipv6_cidr` -##### `default_gateway_ipv6` +##### `default_gateway_ipv6` -Data type: `Any` +Data type: `Optional[String]` Default value: `$docker::default_gateway_ipv6` -##### `log_level` +##### `log_level` -Data type: `Any` +Data type: `Optional[String]` Default value: `$docker::log_level` -##### `log_driver` +##### `log_driver` -Data type: `Any` +Data type: `Optional[String]` Default value: `$docker::log_driver` -##### `log_opt` +##### `log_opt` -Data type: `Any` +Data type: `Array` Default value: `$docker::log_opt` -##### `selinux_enabled` +##### `selinux_enabled` -Data type: `Any` +Data type: `Optional[Boolean]` Default value: `$docker::selinux_enabled` -##### `labels` +##### `labels` -Data type: `Any` +Data type: `Array` Default value: `$docker::labels` -##### `dns` +##### `dns` -Data type: `Any` +Data type: `Optional[Variant[String,Array]]` Default value: `$docker::dns` -##### `dns_search` +##### `dns_search` -Data type: `Any` +Data type: `Optional[Variant[String,Array]]` Default value: `$docker::dns_search` -##### `service_state` +##### `service_state` -Data type: `Any` +Data type: `String` Default value: `$docker::service_state` -##### `service_enable` +##### `service_enable` -Data type: `Any` +Data type: `Boolean` Default value: `$docker::service_enable` -##### `proxy` +##### `proxy` -Data type: `Any` +Data type: `Optional[String]` Default value: `$docker::proxy` -##### `no_proxy` +##### `no_proxy` -Data type: `Any` +Data type: `Optional[String]` Default value: `$docker::no_proxy` -##### `execdriver` +##### `execdriver` -Data type: `Any` +Data type: `Optional[String]` Default value: `$docker::execdriver` -##### `bip` +##### `bip` -Data type: `Any` +Data type: `Optional[String]` Default value: `$docker::bip` -##### `mtu` +##### `mtu` -Data type: `Any` +Data type: `Optional[String]` Default value: `$docker::mtu` -##### `storage_driver` +##### `storage_driver` -Data type: `Any` +Data type: `Optional[String]` Default value: `$docker::storage_driver` -##### `dm_basesize` +##### `dm_basesize` -Data type: `Any` +Data type: `Optional[String]` Default value: `$docker::dm_basesize` -##### `dm_fs` +##### `dm_fs` -Data type: `Any` +Data type: `Optional[String]` Default value: `$docker::dm_fs` -##### `dm_mkfsarg` +##### `dm_mkfsarg` -Data type: `Any` +Data type: `Optional[String]` Default value: `$docker::dm_mkfsarg` -##### `dm_mountopt` +##### `dm_mountopt` -Data type: `Any` +Data type: `Optional[String]` Default value: `$docker::dm_mountopt` -##### `dm_blocksize` +##### `dm_blocksize` -Data type: `Any` +Data type: `Optional[String]` Default value: `$docker::dm_blocksize` -##### `dm_loopdatasize` +##### `dm_loopdatasize` -Data type: `Any` +Data type: `Optional[String]` Default value: `$docker::dm_loopdatasize` -##### `dm_loopmetadatasize` +##### `dm_loopmetadatasize` -Data type: `Any` +Data type: `Optional[String]` Default value: `$docker::dm_loopmetadatasize` -##### `dm_datadev` +##### `dm_datadev` -Data type: `Any` +Data type: `Optional[String]` Default value: `$docker::dm_datadev` -##### `dm_metadatadev` +##### `dm_metadatadev` -Data type: `Any` +Data type: `Optional[String]` Default value: `$docker::dm_metadatadev` -##### `tmp_dir_config` +##### `tmp_dir_config` -Data type: `Any` +Data type: `Optional[Boolean]` Default value: `$docker::tmp_dir_config` -##### `tmp_dir` +##### `tmp_dir` -Data type: `Any` +Data type: `Optional[String]` Default value: `$docker::tmp_dir` -##### `dm_thinpooldev` +##### `dm_thinpooldev` -Data type: `Any` +Data type: `Optional[String]` Default value: `$docker::dm_thinpooldev` -##### `dm_use_deferred_removal` +##### `dm_use_deferred_removal` -Data type: `Any` +Data type: `Optional[Boolean]` Default value: `$docker::dm_use_deferred_removal` -##### `dm_use_deferred_deletion` +##### `dm_use_deferred_deletion` -Data type: `Any` +Data type: `Optional[Boolean]` Default value: `$docker::dm_use_deferred_deletion` -##### `dm_blkdiscard` +##### `dm_blkdiscard` -Data type: `Any` +Data type: `Optional[Boolean]` Default value: `$docker::dm_blkdiscard` -##### `dm_override_udev_sync_check` +##### `dm_override_udev_sync_check` -Data type: `Any` +Data type: `Optional[Boolean]` Default value: `$docker::dm_override_udev_sync_check` -##### `overlay2_override_kernel_check` +##### `overlay2_override_kernel_check` -Data type: `Any` +Data type: `Boolean` Default value: `$docker::overlay2_override_kernel_check` -##### `storage_devs` +##### `storage_devs` -Data type: `Any` +Data type: `Optional[String]` Default value: `$docker::storage_devs` -##### `storage_vg` +##### `storage_vg` -Data type: `Any` +Data type: `Optional[String]` Default value: `$docker::storage_vg` -##### `storage_root_size` +##### `storage_root_size` -Data type: `Any` +Data type: `Optional[String]` Default value: `$docker::storage_root_size` -##### `storage_data_size` +##### `storage_data_size` -Data type: `Any` +Data type: `Optional[String]` Default value: `$docker::storage_data_size` -##### `storage_min_data_size` +##### `storage_min_data_size` -Data type: `Any` +Data type: `Optional[String]` Default value: `$docker::storage_min_data_size` -##### `storage_chunk_size` +##### `storage_chunk_size` -Data type: `Any` +Data type: `Optional[String]` Default value: `$docker::storage_chunk_size` -##### `storage_growpart` +##### `storage_growpart` -Data type: `Any` +Data type: `Optional[Boolean]` Default value: `$docker::storage_growpart` -##### `storage_auto_extend_pool` +##### `storage_auto_extend_pool` -Data type: `Any` +Data type: `Optional[String]` Default value: `$docker::storage_auto_extend_pool` -##### `storage_pool_autoextend_threshold` +##### `storage_pool_autoextend_threshold` -Data type: `Any` +Data type: `Optional[String]` Default value: `$docker::storage_pool_autoextend_threshold` -##### `storage_pool_autoextend_percent` +##### `storage_pool_autoextend_percent` -Data type: `Any` +Data type: `Optional[String]` Default value: `$docker::storage_pool_autoextend_percent` -##### `storage_config` +##### `storage_config` -Data type: `Any` +Data type: `Optional[Variant[String,Boolean]]` Default value: `$docker::storage_config` -##### `storage_config_template` +##### `storage_config_template` -Data type: `Any` +Data type: `Optional[String]` Default value: `$docker::storage_config_template` -##### `storage_setup_file` +##### `storage_setup_file` -Data type: `Any` +Data type: `Optional[String]` Default value: `$docker::storage_setup_file` -##### `service_provider` +##### `service_provider` -Data type: `Any` +Data type: `Optional[String]` Default value: `$docker::service_provider` -##### `service_config` +##### `service_config` -Data type: `Any` +Data type: `Optional[Variant[String,Boolean]]` Default value: `$docker::service_config` -##### `service_config_template` +##### `service_config_template` -Data type: `Any` +Data type: `Optional[String]` Default value: `$docker::service_config_template` -##### `service_overrides_template` +##### `service_overrides_template` -Data type: `Any` +Data type: `Optional[Variant[String,Boolean]]` Default value: `$docker::service_overrides_template` -##### `socket_overrides_template` +##### `socket_overrides_template` -Data type: `Any` +Data type: `Optional[Variant[String,Boolean]]` Default value: `$docker::socket_overrides_template` -##### `socket_override` +##### `socket_override` -Data type: `Any` +Data type: `Optional[Boolean]` Default value: `$docker::socket_override` -##### `service_after_override` +##### `service_after_override` -Data type: `Any` +Data type: `Optional[Variant[String,Boolean]]` Default value: `$docker::service_after_override` -##### `service_hasstatus` +##### `service_hasstatus` -Data type: `Any` +Data type: `Optional[Boolean]` Default value: `$docker::service_hasstatus` -##### `service_hasrestart` +##### `service_hasrestart` -Data type: `Any` +Data type: `Optional[Boolean]` Default value: `$docker::service_hasrestart` -##### `daemon_environment_files` +##### `daemon_environment_files` -Data type: `Any` +Data type: `Array` Default value: `$docker::daemon_environment_files` -##### `tls_enable` +##### `tls_enable` -Data type: `Any` +Data type: `Boolean` Default value: `$docker::tls_enable` -##### `tls_verify` +##### `tls_verify` -Data type: `Any` +Data type: `Boolean` Default value: `$docker::tls_verify` -##### `tls_cacert` +##### `tls_cacert` -Data type: `Any` +Data type: `Optional[String]` Default value: `$docker::tls_cacert` -##### `tls_cert` +##### `tls_cert` -Data type: `Any` +Data type: `Optional[String]` Default value: `$docker::tls_cert` -##### `tls_key` +##### `tls_key` -Data type: `Any` +Data type: `Optional[String]` Default value: `$docker::tls_key` -##### `registry_mirror` +##### `registry_mirror` -Data type: `Any` +Data type: `Optional[Variant[String,Array]]` Default value: `$docker::registry_mirror` -##### `root_dir_flag` +##### `root_dir_flag` -Data type: `Any` +Data type: `String` Default value: `$docker::root_dir_flag` -### `docker::swarms` +### `docker::swarms` The docker::swarms class. @@ -2348,19 +2348,19 @@ The docker::swarms class. The following parameters are available in the `docker::swarms` class: -* [`swarms`](#swarms) +* [`swarms`](#-docker--swarms--swarms) -##### `swarms` +##### `swarms` -Data type: `Any` +Data type: `Hash` -### `docker::systemd_reload` +### `docker::systemd_reload` For systems that have systemd -### `docker::volumes` +### `docker::volumes` The docker::volumes class. @@ -2368,17 +2368,17 @@ The docker::volumes class. The following parameters are available in the `docker::volumes` class: -* [`volumes`](#volumes) +* [`volumes`](#-docker--volumes--volumes) -##### `volumes` +##### `volumes` -Data type: `Any` +Data type: `Hash` ## Defined types -### `docker::exec` +### `docker::exec` A define which executes a command inside a container. @@ -2386,34 +2386,34 @@ A define which executes a command inside a container. 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) +* [`detach`](#-docker--exec--detach) +* [`interactive`](#-docker--exec--interactive) +* [`env`](#-docker--exec--env) +* [`tty`](#-docker--exec--tty) +* [`container`](#-docker--exec--container) +* [`command`](#-docker--exec--command) +* [`unless`](#-docker--exec--unless) +* [`sanitise_name`](#-docker--exec--sanitise_name) +* [`refreshonly`](#-docker--exec--refreshonly) +* [`onlyif`](#-docker--exec--onlyif) -##### `detach` +##### `detach` Data type: `Boolean` -Default value: ``false`` +Default value: `false` -##### `interactive` +##### `interactive` Data type: `Boolean` -Default value: ``false`` +Default value: `false` -##### `env` +##### `env` Data type: `Array` @@ -2421,63 +2421,63 @@ Data type: `Array` Default value: `[]` -##### `tty` +##### `tty` Data type: `Boolean` -Default value: ``false`` +Default value: `false` -##### `container` +##### `container` Data type: `Optional[String]` -Default value: ``undef`` +Default value: `undef` -##### `command` +##### `command` Data type: `Optional[String]` -Default value: ``undef`` +Default value: `undef` -##### `unless` +##### `unless` Data type: `Optional[String]` -Default value: ``undef`` +Default value: `undef` -##### `sanitise_name` +##### `sanitise_name` Data type: `Boolean` -Default value: ``true`` +Default value: `true` -##### `refreshonly` +##### `refreshonly` Data type: `Boolean` -Default value: ``false`` +Default value: `false` -##### `onlyif` +##### `onlyif` Data type: `Optional[String]` -Default value: ``undef`` +Default value: `undef` -### `docker::image` +### `docker::image` Module to install an up-to-date version of a Docker image from the registry @@ -2486,16 +2486,16 @@ from the registry 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) +* [`ensure`](#-docker--image--ensure) +* [`image`](#-docker--image--image) +* [`image_tag`](#-docker--image--image_tag) +* [`image_digest`](#-docker--image--image_digest) +* [`docker_file`](#-docker--image--docker_file) +* [`docker_tar`](#-docker--image--docker_tar) +* [`force`](#-docker--image--force) +* [`docker_dir`](#-docker--image--docker_dir) -##### `ensure` +##### `ensure` Data type: `Enum[present,absent,latest]` @@ -2503,7 +2503,7 @@ Whether you want the image present or absent. Default value: `'present'` -##### `image` +##### `image` Data type: `Optional[Pattern[/^[\S]*$/]]` @@ -2512,55 +2512,55 @@ name of the puppet resource you can pass a value here. Default value: `$title` -##### `image_tag` +##### `image_tag` Data type: `Optional[String]` If you want a specific tag of the image to be installed -Default value: ``undef`` +Default value: `undef` -##### `image_digest` +##### `image_digest` Data type: `Optional[String]` If you want a specific content digest of the image to be installed -Default value: ``undef`` +Default value: `undef` -##### `docker_file` +##### `docker_file` Data type: `Optional[String]` If you want to add a docker image from specific docker file -Default value: ``undef`` +Default value: `undef` -##### `docker_tar` +##### `docker_tar` Data type: `Optional[String]` If you want to load a docker image from specific docker tar -Default value: ``undef`` +Default value: `undef` -##### `force` +##### `force` Data type: `Boolean` -Default value: ``false`` +Default value: `false` -##### `docker_dir` +##### `docker_dir` Data type: `Optional[String]` -Default value: ``undef`` +Default value: `undef` -### `docker::plugin` +### `docker::plugin` A define that manages a docker plugin @@ -2568,20 +2568,18 @@ A define that manages a docker plugin 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) - -##### `plugin_name` +* [`plugin_name`](#-docker--plugin--plugin_name) +* [`enabled`](#-docker--plugin--enabled) +* [`timeout`](#-docker--plugin--timeout) +* [`plugin_alias`](#-docker--plugin--plugin_alias) +* [`disable_on_install`](#-docker--plugin--disable_on_install) +* [`disable_content_trust`](#-docker--plugin--disable_content_trust) +* [`grant_all_permissions`](#-docker--plugin--grant_all_permissions) +* [`force_remove`](#-docker--plugin--force_remove) +* [`settings`](#-docker--plugin--settings) +* [`ensure`](#-docker--plugin--ensure) + +##### `plugin_name` Data type: `String` @@ -2591,69 +2589,63 @@ requires a plugin be disabled before it can be removed Default value: `$title` -##### `plugin_name` - -The name of the docker plugin - -Default value: `$title` - -##### `enabled` +##### `enabled` Data type: `Boolean` A setting to enable or disable an installed plugin. -Default value: ``true`` +Default value: `true` -##### `timeout` +##### `timeout` Data type: `Optional[String]` The number of seconds to wait when enabling a plugin -Default value: ``undef`` +Default value: `undef` -##### `plugin_alias` +##### `plugin_alias` Data type: `Optional[String]` An alternative name to use for an installed plugin -Default value: ``undef`` +Default value: `undef` -##### `disable_on_install` +##### `disable_on_install` Data type: `Boolean` Alters the default behaviour of enabling a plugin upon install -Default value: ``false`` +Default value: `false` -##### `disable_content_trust` +##### `disable_content_trust` Data type: `Boolean` Skip image verification -Default value: ``true`` +Default value: `true` -##### `grant_all_permissions` +##### `grant_all_permissions` Data type: `Boolean` Grant all permissions necessary to run the plugin -Default value: ``true`` +Default value: `true` -##### `force_remove` +##### `force_remove` Data type: `Boolean` Force the removal of an active plugin -Default value: ``true`` +Default value: `true` -##### `settings` +##### `settings` Data type: `Array` @@ -2661,7 +2653,7 @@ Any additional settings to pass to the plugin during install Default value: `[]` -##### `ensure` +##### `ensure` Data type: `Enum[present,absent]` @@ -2669,13 +2661,7 @@ Data type: `Enum[present,absent]` Default value: `'present'` -##### `grant_all_permissions` - - - -Default value: ``true`` - -### `docker::registry` +### `docker::registry` Module to configure private docker registries from which to pull Docker images @@ -2683,18 +2669,18 @@ Module to configure private docker registries from which to pull Docker images 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) +* [`server`](#-docker--registry--server) +* [`ensure`](#-docker--registry--ensure) +* [`username`](#-docker--registry--username) +* [`password`](#-docker--registry--password) +* [`pass_hash`](#-docker--registry--pass_hash) +* [`email`](#-docker--registry--email) +* [`local_user`](#-docker--registry--local_user) +* [`local_user_home`](#-docker--registry--local_user_home) +* [`receipt`](#-docker--registry--receipt) +* [`version`](#-docker--registry--version) -##### `server` +##### `server` Data type: `Optional[String]` @@ -2702,7 +2688,7 @@ The hostname and port of the private Docker registry. Ex: dockerreg:5000 Default value: `$title` -##### `ensure` +##### `ensure` Data type: `Enum[present,absent]` @@ -2710,42 +2696,42 @@ Whether or not you want to login or logout of a repository Default value: `'present'` -##### `username` +##### `username` Data type: `Optional[String]` Username for authentication to private Docker registry. auth is not required. -Default value: ``undef`` +Default value: `undef` -##### `password` +##### `password` Data type: `Optional[String]` Password for authentication to private Docker registry. Leave undef if auth is not required. -Default value: ``undef`` +Default value: `undef` -##### `pass_hash` +##### `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`` +Default value: `undef` -##### `email` +##### `email` Data type: `Optional[String]` Email for registration to private Docker registry. Leave undef if auth is not required. -Default value: ``undef`` +Default value: `undef` -##### `local_user` +##### `local_user` Data type: `String` @@ -2754,23 +2740,23 @@ users home directory Default value: `'root'` -##### `local_user_home` +##### `local_user_home` Data type: `Optional[String]` The local user home directory. -Default value: ``undef`` +Default value: `undef` -##### `receipt` +##### `receipt` Data type: `Boolean` Required to be true for idempotency -Default value: ``true`` +Default value: `true` -##### `version` +##### `version` Data type: `Optional[String]` @@ -2778,7 +2764,7 @@ Data type: `Optional[String]` Default value: `$docker::version` -### `docker::run` +### `docker::run` Sets a restart policy on the docker run. Note: If set, puppet will NOT setup an init script to manage, instead @@ -2841,78 +2827,78 @@ Default: false 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) -* [`syslog_facility`](#syslog_facility) -* [`read_only`](#read_only) - -##### `restart` - -Data type: `Optional[String]` - - - -Default value: ``undef`` - -##### `verify_digest` +* [`restart`](#-docker--run--restart) +* [`verify_digest`](#-docker--run--verify_digest) +* [`service_prefix`](#-docker--run--service_prefix) +* [`restart_service`](#-docker--run--restart_service) +* [`restart_service_on_docker_refresh`](#-docker--run--restart_service_on_docker_refresh) +* [`manage_service`](#-docker--run--manage_service) +* [`docker_service`](#-docker--run--docker_service) +* [`health_check_cmd`](#-docker--run--health_check_cmd) +* [`health_check_interval`](#-docker--run--health_check_interval) +* [`restart_on_unhealthy`](#-docker--run--restart_on_unhealthy) +* [`net`](#-docker--run--net) +* [`extra_parameters`](#-docker--run--extra_parameters) +* [`systemd_restart`](#-docker--run--systemd_restart) +* [`custom_unless`](#-docker--run--custom_unless) +* [`after_create`](#-docker--run--after_create) +* [`remain_after_exit`](#-docker--run--remain_after_exit) +* [`prepare_service_only`](#-docker--run--prepare_service_only) +* [`image`](#-docker--run--image) +* [`ensure`](#-docker--run--ensure) +* [`command`](#-docker--run--command) +* [`memory_limit`](#-docker--run--memory_limit) +* [`cpuset`](#-docker--run--cpuset) +* [`ports`](#-docker--run--ports) +* [`labels`](#-docker--run--labels) +* [`expose`](#-docker--run--expose) +* [`volumes`](#-docker--run--volumes) +* [`links`](#-docker--run--links) +* [`use_name`](#-docker--run--use_name) +* [`running`](#-docker--run--running) +* [`volumes_from`](#-docker--run--volumes_from) +* [`username`](#-docker--run--username) +* [`hostname`](#-docker--run--hostname) +* [`env`](#-docker--run--env) +* [`env_file`](#-docker--run--env_file) +* [`dns`](#-docker--run--dns) +* [`dns_search`](#-docker--run--dns_search) +* [`lxc_conf`](#-docker--run--lxc_conf) +* [`service_provider`](#-docker--run--service_provider) +* [`disable_network`](#-docker--run--disable_network) +* [`privileged`](#-docker--run--privileged) +* [`detach`](#-docker--run--detach) +* [`extra_systemd_parameters`](#-docker--run--extra_systemd_parameters) +* [`pull_on_start`](#-docker--run--pull_on_start) +* [`after`](#-docker--run--after) +* [`after_service`](#-docker--run--after_service) +* [`depends`](#-docker--run--depends) +* [`depend_services`](#-docker--run--depend_services) +* [`tty`](#-docker--run--tty) +* [`socket_connect`](#-docker--run--socket_connect) +* [`hostentries`](#-docker--run--hostentries) +* [`before_start`](#-docker--run--before_start) +* [`before_stop`](#-docker--run--before_stop) +* [`after_start`](#-docker--run--after_start) +* [`after_stop`](#-docker--run--after_stop) +* [`remove_container_on_start`](#-docker--run--remove_container_on_start) +* [`remove_container_on_stop`](#-docker--run--remove_container_on_stop) +* [`remove_volume_on_start`](#-docker--run--remove_volume_on_start) +* [`remove_volume_on_stop`](#-docker--run--remove_volume_on_stop) +* [`stop_wait_time`](#-docker--run--stop_wait_time) +* [`syslog_identifier`](#-docker--run--syslog_identifier) +* [`syslog_facility`](#-docker--run--syslog_facility) +* [`read_only`](#-docker--run--read_only) + +##### `restart` + +Data type: `Optional[String]` + + + +Default value: `undef` + +##### `verify_digest` Data type: `Optional[String]` @@ -2921,9 +2907,9 @@ checksum before starting the docker image. To get the digest of an image, run the following command: docker image inspect <> --format='{{index .RepoDigests 0}} -Default value: ``undef`` +Default value: `undef` -##### `service_prefix` +##### `service_prefix` Data type: `String` @@ -2932,16 +2918,16 @@ service resource title with. Default: 'docker-' Default value: `'docker-'` -##### `restart_service` +##### `restart_service` Data type: `Boolean` (optional) Whether or not to restart the service if the the generated init script changes. Default: true -Default value: ``true`` +Default value: `true` -##### `restart_service_on_docker_refresh` +##### `restart_service_on_docker_refresh` Data type: `Boolean` @@ -2949,9 +2935,9 @@ 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`` +Default value: `true` -##### `manage_service` +##### `manage_service` Data type: `Boolean` @@ -2959,9 +2945,9 @@ Data type: `Boolean` script. Disabling this may be useful if integrating with existing modules. Default: true -Default value: ``true`` +Default value: `true` -##### `docker_service` +##### `docker_service` Data type: `Variant[String,Boolean]` @@ -2971,49 +2957,49 @@ false -> no Service dependency anything else -> Service[docker_service] Default: false -Default value: ``false`` +Default value: `false` -##### `health_check_cmd` +##### `health_check_cmd` Data type: `Optional[String]` -Default value: ``undef`` +Default value: `undef` -##### `health_check_interval` +##### `health_check_interval` Data type: `Optional[Integer]` -Default value: ``undef`` +Default value: `undef` -##### `restart_on_unhealthy` +##### `restart_on_unhealthy` Data type: `Boolean` -Default value: ``false`` +Default value: `false` -##### `net` +##### `net` Data type: `Variant[String,Array[String[1],1],Undef]` -Default value: ``undef`` +Default value: `undef` -##### `extra_parameters` +##### `extra_parameters` Data type: `Optional[Variant[String,Array[String]]]` -Default value: ``undef`` +Default value: `undef` -##### `systemd_restart` +##### `systemd_restart` Data type: `String` @@ -3021,7 +3007,7 @@ Data type: `String` Default value: `'on-failure'` -##### `custom_unless` +##### `custom_unless` Data type: `Variant[String,Array]` @@ -3029,39 +3015,39 @@ Data type: `Variant[String,Array]` Default value: `[]` -##### `after_create` +##### `after_create` Data type: `Optional[String]` -Default value: ``undef`` +Default value: `undef` -##### `remain_after_exit` +##### `remain_after_exit` Data type: `Optional[String]` -Default value: ``undef`` +Default value: `undef` -##### `prepare_service_only` +##### `prepare_service_only` Data type: `Boolean` -Default value: ``false`` +Default value: `false` -##### `image` +##### `image` Data type: `Optional[Pattern[/^[\S]*$/]]` -Default value: ``undef`` +Default value: `undef` -##### `ensure` +##### `ensure` Data type: `Enum[present,absent]` @@ -3069,15 +3055,15 @@ Data type: `Enum[present,absent]` Default value: `'present'` -##### `command` +##### `command` Data type: `Optional[String]` -Default value: ``undef`` +Default value: `undef` -##### `memory_limit` +##### `memory_limit` Data type: `Pattern[/^[\d]*(b|k|m|g)$/]` @@ -3085,7 +3071,7 @@ Data type: `Pattern[/^[\d]*(b|k|m|g)$/]` Default value: `'0b'` -##### `cpuset` +##### `cpuset` Data type: `Variant[String,Array,Undef]` @@ -3093,7 +3079,7 @@ Data type: `Variant[String,Array,Undef]` Default value: `[]` -##### `ports` +##### `ports` Data type: `Variant[String,Array,Undef]` @@ -3101,7 +3087,7 @@ Data type: `Variant[String,Array,Undef]` Default value: `[]` -##### `labels` +##### `labels` Data type: `Variant[String,Array,Undef]` @@ -3109,7 +3095,7 @@ Data type: `Variant[String,Array,Undef]` Default value: `[]` -##### `expose` +##### `expose` Data type: `Variant[String,Array,Undef]` @@ -3117,7 +3103,7 @@ Data type: `Variant[String,Array,Undef]` Default value: `[]` -##### `volumes` +##### `volumes` Data type: `Variant[String,Array,Undef]` @@ -3125,7 +3111,7 @@ Data type: `Variant[String,Array,Undef]` Default value: `[]` -##### `links` +##### `links` Data type: `Variant[String,Array,Undef]` @@ -3133,23 +3119,23 @@ Data type: `Variant[String,Array,Undef]` Default value: `[]` -##### `use_name` +##### `use_name` Data type: `Boolean` -Default value: ``false`` +Default value: `false` -##### `running` +##### `running` Data type: `Boolean` -Default value: ``true`` +Default value: `true` -##### `volumes_from` +##### `volumes_from` Data type: `Variant[String,Array]` @@ -3157,23 +3143,23 @@ Data type: `Variant[String,Array]` Default value: `[]` -##### `username` +##### `username` Data type: `Variant[String,Boolean]` -Default value: ``false`` +Default value: `false` -##### `hostname` +##### `hostname` Data type: `Variant[String,Boolean]` -Default value: ``false`` +Default value: `false` -##### `env` +##### `env` Data type: `Variant[String,Array]` @@ -3181,7 +3167,7 @@ Data type: `Variant[String,Array]` Default value: `[]` -##### `env_file` +##### `env_file` Data type: `Variant[String,Array]` @@ -3189,7 +3175,7 @@ Data type: `Variant[String,Array]` Default value: `[]` -##### `dns` +##### `dns` Data type: `Variant[String,Array]` @@ -3197,7 +3183,7 @@ Data type: `Variant[String,Array]` Default value: `[]` -##### `dns_search` +##### `dns_search` Data type: `Variant[String,Array]` @@ -3205,7 +3191,7 @@ Data type: `Variant[String,Array]` Default value: `[]` -##### `lxc_conf` +##### `lxc_conf` Data type: `Variant[String,Array]` @@ -3213,39 +3199,39 @@ Data type: `Variant[String,Array]` Default value: `[]` -##### `service_provider` +##### `service_provider` Data type: `Optional[String]` -Default value: ``undef`` +Default value: `undef` -##### `disable_network` +##### `disable_network` Data type: `Boolean` -Default value: ``false`` +Default value: `false` -##### `privileged` +##### `privileged` Data type: `Boolean` -Default value: ``false`` +Default value: `false` -##### `detach` +##### `detach` Data type: `Optional[Boolean]` -Default value: ``undef`` +Default value: `undef` -##### `extra_systemd_parameters` +##### `extra_systemd_parameters` Data type: `Variant[String,Hash]` @@ -3253,15 +3239,15 @@ Data type: `Variant[String,Hash]` Default value: `{}` -##### `pull_on_start` +##### `pull_on_start` Data type: `Boolean` -Default value: ``false`` +Default value: `false` -##### `after` +##### `after` Data type: `Variant[String,Array]` @@ -3269,7 +3255,7 @@ Data type: `Variant[String,Array]` Default value: `[]` -##### `after_service` +##### `after_service` Data type: `Variant[String,Array]` @@ -3277,7 +3263,7 @@ Data type: `Variant[String,Array]` Default value: `[]` -##### `depends` +##### `depends` Data type: `Variant[String,Array]` @@ -3285,7 +3271,7 @@ Data type: `Variant[String,Array]` Default value: `[]` -##### `depend_services` +##### `depend_services` Data type: `Variant[String,Array]` @@ -3293,15 +3279,15 @@ Data type: `Variant[String,Array]` Default value: `['docker.service']` -##### `tty` +##### `tty` Data type: `Boolean` -Default value: ``false`` +Default value: `false` -##### `socket_connect` +##### `socket_connect` Data type: `Variant[String,Array]` @@ -3309,7 +3295,7 @@ Data type: `Variant[String,Array]` Default value: `[]` -##### `hostentries` +##### `hostentries` Data type: `Variant[String,Array]` @@ -3317,71 +3303,71 @@ Data type: `Variant[String,Array]` Default value: `[]` -##### `before_start` +##### `before_start` Data type: `Variant[String,Boolean]` -Default value: ``false`` +Default value: `false` -##### `before_stop` +##### `before_stop` Data type: `Variant[String,Boolean]` -Default value: ``false`` +Default value: `false` -##### `after_start` +##### `after_start` Data type: `Variant[String,Boolean]` -Default value: ``false`` +Default value: `false` -##### `after_stop` +##### `after_stop` Data type: `Variant[String,Boolean]` -Default value: ``false`` +Default value: `false` -##### `remove_container_on_start` +##### `remove_container_on_start` Data type: `Boolean` -Default value: ``true`` +Default value: `true` -##### `remove_container_on_stop` +##### `remove_container_on_stop` Data type: `Boolean` -Default value: ``true`` +Default value: `true` -##### `remove_volume_on_start` +##### `remove_volume_on_start` Data type: `Boolean` -Default value: ``false`` +Default value: `false` -##### `remove_volume_on_stop` +##### `remove_volume_on_stop` Data type: `Boolean` -Default value: ``false`` +Default value: `false` -##### `stop_wait_time` +##### `stop_wait_time` Data type: `Integer` @@ -3389,31 +3375,31 @@ Data type: `Integer` Default value: `10` -##### `syslog_identifier` +##### `syslog_identifier` Data type: `Optional[String]` -Default value: ``undef`` +Default value: `undef` -##### `syslog_facility` +##### `syslog_facility` Data type: `Optional[String]` -Default value: ``undef`` +Default value: `undef` -##### `read_only` +##### `read_only` Data type: `Boolean` -Default value: ``false`` +Default value: `false` -### `docker::secrets` +### `docker::secrets` The docker::secrets class. @@ -3421,12 +3407,12 @@ The docker::secrets class. The following parameters are available in the `docker::secrets` defined type: -* [`ensure`](#ensure) -* [`label`](#label) -* [`secret_name`](#secret_name) -* [`secret_path`](#secret_path) +* [`ensure`](#-docker--secrets--ensure) +* [`label`](#-docker--secrets--label) +* [`secret_name`](#-docker--secrets--secret_name) +* [`secret_path`](#-docker--secrets--secret_path) -##### `ensure` +##### `ensure` Data type: `Enum[present,absent]` @@ -3434,7 +3420,7 @@ Data type: `Enum[present,absent]` Default value: `'present'` -##### `label` +##### `label` Data type: `Variant[String,Array]` @@ -3442,23 +3428,23 @@ Data type: `Variant[String,Array]` Default value: `[]` -##### `secret_name` +##### `secret_name` Data type: `Optional[String]` -Default value: ``undef`` +Default value: `undef` -##### `secret_path` +##### `secret_path` Data type: `Optional[String]` -Default value: ``undef`` +Default value: `undef` -### `docker::services` +### `docker::services` define that managers a Docker services @@ -3466,28 +3452,28 @@ define that managers a Docker services 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) - -##### `ensure` +* [`ensure`](#-docker--services--ensure) +* [`image`](#-docker--services--image) +* [`detach`](#-docker--services--detach) +* [`env`](#-docker--services--env) +* [`label`](#-docker--services--label) +* [`publish`](#-docker--services--publish) +* [`replicas`](#-docker--services--replicas) +* [`tty`](#-docker--services--tty) +* [`user`](#-docker--services--user) +* [`workdir`](#-docker--services--workdir) +* [`extra_params`](#-docker--services--extra_params) +* [`update`](#-docker--services--update) +* [`scale`](#-docker--services--scale) +* [`host_socket`](#-docker--services--host_socket) +* [`registry_mirror`](#-docker--services--registry_mirror) +* [`mounts`](#-docker--services--mounts) +* [`networks`](#-docker--services--networks) +* [`command`](#-docker--services--command) +* [`create`](#-docker--services--create) +* [`service_name`](#-docker--services--service_name) + +##### `ensure` Data type: `Enum[present,absent]` @@ -3495,23 +3481,23 @@ This ensures that the service is present or not. Default value: `'present'` -##### `image` +##### `image` Data type: `Optional[Variant[String,Array]]` The Docker image to spwan the service from. -Default value: ``undef`` +Default value: `undef` -##### `detach` +##### `detach` Data type: `Boolean` Exit immediately instead of waiting for the service to converge (default true) -Default value: ``true`` +Default value: `true` -##### `env` +##### `env` Data type: `Array` @@ -3519,7 +3505,7 @@ Set environment variables Default value: `[]` -##### `label` +##### `label` Data type: `Array` @@ -3528,47 +3514,47 @@ This used as metdata to configure constraints etc. Default value: `[]` -##### `publish` +##### `publish` Data type: `Optional[Variant[String,Array]]` Publish port(s) as node ports. -Default value: ``undef`` +Default value: `undef` -##### `replicas` +##### `replicas` Data type: `Optional[Variant[String,Array]]` Number of tasks (containers per service) -Default value: ``undef`` +Default value: `undef` -##### `tty` +##### `tty` Data type: `Boolean` Allocate a pseudo-TTY -Default value: ``false`` +Default value: `false` -##### `user` +##### `user` Data type: `Optional[Variant[String,Array]]` Username or UID (format: [:]) -Default value: ``undef`` +Default value: `undef` -##### `workdir` +##### `workdir` Data type: `Optional[Variant[String,Array]]` Working directory inside the container -Default value: ``undef`` +Default value: `undef` -##### `extra_params` +##### `extra_params` Data type: `Array` @@ -3577,16 +3563,16 @@ This must be passed as an array. See docker service create --help for all option Default value: `[]` -##### `update` +##### `update` Data type: `Boolean` This changes the docker command to docker service update, you must pass a service name with this option -Default value: ``false`` +Default value: `false` -##### `scale` +##### `scale` Data type: `Boolean` @@ -3594,65 +3580,65 @@ This changes the docker command to docker service scale, this can only be used with service name and replicas -Default value: ``false`` +Default value: `false` -##### `host_socket` +##### `host_socket` Data type: `Optional[Variant[String,Array]]` This will allow the service to connect to the host linux socket. -Default value: ``undef`` +Default value: `undef` -##### `registry_mirror` +##### `registry_mirror` Data type: `Optional[Variant[String,Array]]` This will allow the service to set a registry mirror. -Default value: ``undef`` +Default value: `undef` -##### `mounts` +##### `mounts` Data type: `Optional[Variant[String,Array]]` Allows attaching filesystem mounts to the service (specified as an array) -Default value: ``undef`` +Default value: `undef` -##### `networks` +##### `networks` Data type: `Optional[Array]` Allows attaching the service to networks (specified as an array) -Default value: ``undef`` +Default value: `undef` -##### `command` +##### `command` Data type: `Optional[Variant[String,Array]]` Command to run on the container -Default value: ``undef`` +Default value: `undef` -##### `create` +##### `create` Data type: `Boolean` -Default value: ``true`` +Default value: `true` -##### `service_name` +##### `service_name` Data type: `Optional[Variant[String,Array]]` -Default value: ``undef`` +Default value: `undef` -### `docker::stack` +### `docker::stack` deploys Docker stacks or compose v3 @@ -3660,15 +3646,15 @@ deploys Docker stacks or compose v3 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) +* [`ensure`](#-docker--stack--ensure) +* [`stack_name`](#-docker--stack--stack_name) +* [`bundle_file`](#-docker--stack--bundle_file) +* [`prune`](#-docker--stack--prune) +* [`resolve_image`](#-docker--stack--resolve_image) +* [`with_registry_auth`](#-docker--stack--with_registry_auth) +* [`compose_files`](#-docker--stack--compose_files) -##### `ensure` +##### `ensure` Data type: `Enum[present,absent]` @@ -3676,57 +3662,57 @@ This ensures that the stack is present or not. Default value: `'present'` -##### `stack_name` +##### `stack_name` Data type: `Optional[String]` The name of the stack that you are deploying -Default value: ``undef`` +Default value: `undef` -##### `bundle_file` +##### `bundle_file` Data type: `Optional[String]` Path to a Distributed Application Bundle file Please note this is experimental -Default value: ``undef`` +Default value: `undef` -##### `prune` +##### `prune` Data type: `Boolean` Prune services that are no longer referenced -Default value: ``false`` +Default value: `false` -##### `resolve_image` +##### `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`` +Default value: `undef` -##### `with_registry_auth` +##### `with_registry_auth` Data type: `Boolean` Send registry authentication details to Swarm agents -Default value: ``false`` +Default value: `false` -##### `compose_files` +##### `compose_files` Data type: `Optional[Array]` -Default value: ``undef`` +Default value: `undef` -### `docker::swarm` +### `docker::swarm` managers a Docker Swarm Mode cluster @@ -3734,24 +3720,24 @@ managers a Docker Swarm Mode cluster 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) - -##### `ensure` +* [`ensure`](#-docker--swarm--ensure) +* [`init`](#-docker--swarm--init) +* [`join`](#-docker--swarm--join) +* [`advertise_addr`](#-docker--swarm--advertise_addr) +* [`autolock`](#-docker--swarm--autolock) +* [`cert_expiry`](#-docker--swarm--cert_expiry) +* [`default_addr_pool`](#-docker--swarm--default_addr_pool) +* [`default_addr_pool_mask_length`](#-docker--swarm--default_addr_pool_mask_length) +* [`dispatcher_heartbeat`](#-docker--swarm--dispatcher_heartbeat) +* [`external_ca`](#-docker--swarm--external_ca) +* [`force_new_cluster`](#-docker--swarm--force_new_cluster) +* [`listen_addr`](#-docker--swarm--listen_addr) +* [`max_snapshots`](#-docker--swarm--max_snapshots) +* [`snapshot_interval`](#-docker--swarm--snapshot_interval) +* [`token`](#-docker--swarm--token) +* [`manager_ip`](#-docker--swarm--manager_ip) + +##### `ensure` Data type: `Enum[present,absent]` @@ -3761,16 +3747,16 @@ have been removed before managers Default value: `'present'` -##### `init` +##### `init` Data type: `Boolean` This creates the first worker node for a new cluster. Set init to true to create a new cluster -Default value: ``false`` +Default value: `false` -##### `join` +##### `join` Data type: `Boolean` @@ -3778,116 +3764,116 @@ 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`` +Default value: `false` -##### `advertise_addr` +##### `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`` +Default value: `undef` -##### `autolock` +##### `autolock` Data type: `Boolean` Enable manager autolocking (requiring an unlock key to start a stopped manager) -Default value: ``false`` +Default value: `false` -##### `cert_expiry` +##### `cert_expiry` Data type: `Optional[String]` Validity period for node certificates (ns|us|ms|s|m|h) (default 2160h0m0s) -Default value: ``undef`` +Default value: `undef` -##### `default_addr_pool` +##### `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`` +Default value: `undef` -##### `default_addr_pool_mask_length` +##### `default_addr_pool_mask_length` Data type: `Optional[String]` Default subnet pools mask length for default-addr-pools (CIDR block number) -Default value: ``undef`` +Default value: `undef` -##### `dispatcher_heartbeat` +##### `dispatcher_heartbeat` Data type: `Optional[String]` Dispatcher heartbeat period (ns|us|ms|s|m|h) (default 5s) -Default value: ``undef`` +Default value: `undef` -##### `external_ca` +##### `external_ca` Data type: `Optional[String]` Specifications of one or more certificate signing endpoints -Default value: ``undef`` +Default value: `undef` -##### `force_new_cluster` +##### `force_new_cluster` Data type: `Boolean` Force create a new cluster from current state -Default value: ``false`` +Default value: `false` -##### `listen_addr` +##### `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`` +Default value: `undef` -##### `max_snapshots` +##### `max_snapshots` Data type: `Optional[String]` Number of additional Raft snapshots to retain -Default value: ``undef`` +Default value: `undef` -##### `snapshot_interval` +##### `snapshot_interval` Data type: `Optional[String]` Number of log entries between Raft snapshots (default 10000) -Default value: ``undef`` +Default value: `undef` -##### `token` +##### `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`` +Default value: `undef` -##### `manager_ip` +##### `manager_ip` Data type: `Optional[String]` The ip address of a manager node to join the cluster. -Default value: ``undef`` +Default value: `undef` -### `docker::system_user` +### `docker::system_user` manage docker group users @@ -3895,17 +3881,17 @@ manage docker group users The following parameters are available in the `docker::system_user` defined type: -* [`create_user`](#create_user) +* [`create_user`](#-docker--system_user--create_user) -##### `create_user` +##### `create_user` -Data type: `Any` +Data type: `Boolean` Boolean to cotrol whether the user should be created -Default value: ``true`` +Default value: `true` -### `docker::windows_account` +### `docker::windows_account` Windows account that owns the docker services @@ -3931,38 +3917,38 @@ Default value: `present` The following parameters are available in the `docker_compose` type. -* [`compose_files`](#compose_files) -* [`name`](#name) -* [`options`](#options) -* [`provider`](#provider) -* [`scale`](#scale) -* [`tmpdir`](#tmpdir) -* [`up_args`](#up_args) +* [`compose_files`](#-docker_compose--compose_files) +* [`name`](#-docker_compose--name) +* [`options`](#-docker_compose--options) +* [`provider`](#-docker_compose--provider) +* [`scale`](#-docker_compose--scale) +* [`tmpdir`](#-docker_compose--tmpdir) +* [`up_args`](#-docker_compose--up_args) -##### `compose_files` +##### `compose_files` An array of Docker Compose Files paths. -##### `name` +##### `name` namevar The name of the project -##### `options` +##### `options` Additional options to be passed directly to docker-compose. -##### `provider` +##### `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. -##### `scale` +##### `scale` A hash of compose services and number of containers. -##### `tmpdir` +##### `tmpdir` Override the temporary directory used by docker-compose. @@ -3973,7 +3959,7 @@ docker-composes temporary files to a known directory. The directory passed to this property must exist and be accessible by the user that is executing the puppet agent. -##### `up_args` +##### `up_args` Arguments to be passed directly to docker-compose up. @@ -4009,47 +3995,47 @@ The IPAM (IP Address Management) driver 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) +* [`additional_flags`](#-docker_network--additional_flags) +* [`aux_address`](#-docker_network--aux_address) +* [`gateway`](#-docker_network--gateway) +* [`ip_range`](#-docker_network--ip_range) +* [`name`](#-docker_network--name) +* [`options`](#-docker_network--options) +* [`provider`](#-docker_network--provider) +* [`subnet`](#-docker_network--subnet) -##### `additional_flags` +##### `additional_flags` Additional flags for the 'docker network create' -##### `aux_address` +##### `aux_address` Auxiliary ipv4 or ipv6 addresses used by the Network driver -##### `gateway` +##### `gateway` An ipv4 or ipv6 gateway for the server subnet -##### `ip_range` +##### `ip_range` The range of IP addresses used by the network -##### `name` +##### `name` namevar The name of the network -##### `options` +##### `options` Additional options for the network driver -##### `provider` +##### `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. -##### `subnet` +##### `subnet` The subnet in CIDR format that represents a network segment @@ -4073,32 +4059,32 @@ Default value: `present` 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) +* [`bundle_file`](#-docker_stack--bundle_file) +* [`compose_files`](#-docker_stack--compose_files) +* [`name`](#-docker_stack--name) +* [`provider`](#-docker_stack--provider) +* [`up_args`](#-docker_stack--up_args) -##### `bundle_file` +##### `bundle_file` Path to a Distributed Application Bundle file. -##### `compose_files` +##### `compose_files` An array of Docker Compose Files paths. -##### `name` +##### `name` namevar The name of the stack -##### `provider` +##### `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. -##### `up_args` +##### `up_args` Arguments to be passed directly to docker stack deploy. @@ -4130,28 +4116,28 @@ The location that the volume is mounted to The following parameters are available in the `docker_volume` type. -* [`name`](#name) -* [`options`](#options) -* [`provider`](#provider) +* [`name`](#-docker_volume--name) +* [`options`](#-docker_volume--options) +* [`provider`](#-docker_volume--provider) -##### `name` +##### `name` namevar The name of the volume -##### `options` +##### `options` Additional options for the volume driver -##### `provider` +##### `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 -### `docker::escape` +### `docker::escape` Type: Ruby 3.x API @@ -4163,7 +4149,7 @@ The docker::escape function. Returns: `Any` -### `docker::sanitised_name` +### `docker::sanitised_name` Type: Puppet Language diff --git a/metadata.json b/metadata.json index 3059ca7e..95918a11 100644 --- a/metadata.json +++ b/metadata.json @@ -1,6 +1,6 @@ { "name": "puppetlabs-docker", - "version": "6.0.2", + "version": "6.1.0", "author": "puppetlabs", "summary": "Module for installing and managing docker", "license": "Apache-2.0",