diff --git a/CHANGELOG.md b/CHANGELOG.md index 21350fdb..b59775ed 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,7 +2,21 @@ 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). -## [v4.4.0](https://github.com/puppetlabs/puppetlabs-docker/tree/v4.4.0) (2022-05-31) +## [v5.0.0](https://github.com/puppetlabs/puppetlabs-docker/tree/v5.0.0) (2022-08-18) + +[Full Changelog](https://github.com/puppetlabs/puppetlabs-docker/compare/v4.4.0...v5.0.0) + +### Changed + +- Remove log\_driver limitations [\#792](https://github.com/puppetlabs/puppetlabs-docker/pull/792) ([timdeluxe](https://github.com/timdeluxe)) + +### Added + +- pdksync - \(GH-cat-11\) Certify Support for Ubuntu 22.04 [\#850](https://github.com/puppetlabs/puppetlabs-docker/pull/850) ([david22swan](https://github.com/david22swan)) +- adding optional variable for package\_key\_check\_source to RedHat [\#846](https://github.com/puppetlabs/puppetlabs-docker/pull/846) ([STaegtmeier](https://github.com/STaegtmeier)) +- New create\_user parameter on main class [\#841](https://github.com/puppetlabs/puppetlabs-docker/pull/841) ([traylenator](https://github.com/traylenator)) + +## [v4.4.0](https://github.com/puppetlabs/puppetlabs-docker/tree/v4.4.0) (2022-06-01) [Full Changelog](https://github.com/puppetlabs/puppetlabs-docker/compare/v4.3.0...v4.4.0) @@ -294,7 +308,7 @@ All notable changes to this project will be documented in this file. The format - \(FM-8151\) Add Windows Server 2019 support [\#493](https://github.com/puppetlabs/puppetlabs-docker/pull/493) ([eimlav](https://github.com/eimlav)) - Support for docker machine download and install [\#466](https://github.com/puppetlabs/puppetlabs-docker/pull/466) ([acurus-puppetmaster](https://github.com/acurus-puppetmaster)) -- Add service\_provider parameter to docker::run [\#376](https://github.com/puppetlabs/puppetlabs-docker/pull/376) ([iamjamestl](https://github.com/iamjamestl)) +- Add service\_provider parameter to docker::run [\#376](https://github.com/puppetlabs/puppetlabs-docker/pull/376) ([jameslikeslinux](https://github.com/jameslikeslinux)) ### Fixed @@ -428,7 +442,7 @@ All notable changes to this project will be documented in this file. The format - 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) ([iamjamestl](https://github.com/iamjamestl)) +- 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)) diff --git a/REFERENCE.md b/REFERENCE.md index a4a0961d..be55caf6 100644 --- a/REFERENCE.md +++ b/REFERENCE.md @@ -6,9 +6,10 @@ ### Classes +#### 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::config`](#dockerconfig) * [`docker::images`](#dockerimages) * [`docker::install`](#dockerinstall): Module to install an up-to-date version of Docker from a package repository. Only for Debian, Red Hat and Windows @@ -24,6 +25,10 @@ Only for Debian, Red Hat and Windows * [`docker::systemd_reload`](#dockersystemd_reload): For systems that have systemd * [`docker::volumes`](#dockervolumes) +#### Private Classes + +* `docker::config`: Configuration for docker + ### Defined types * [`docker::exec`](#dockerexec): A define which executes a command inside a container. @@ -146,6 +151,7 @@ The following parameters are available in the `docker` class: * [`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) @@ -412,24 +418,9 @@ Data type: `Optional[String]` Set the log driver. Docker default is json-file. -Valid values: none, json-file, syslog, journald, gelf, fluentd -Valid values description: - none : Disables any logging for the container. - docker logs won't be available with this driver. - json-file: Default logging driver for Docker. - Writes JSON messages to file. - syslog : Syslog logging driver for Docker. - Writes log messages to syslog. - journald : Journald logging driver for Docker. - Writes log messages to journald. - gelf : Graylog Extended Log Format (GELF) logging driver for Docker. - Writes log messages to a GELF endpoint: Graylog or Logstash. - fluentd : Fluentd logging driver for Docker. - Writes log messages to fluentd (forward input). - splunk : Splunk logging driver for Docker. - Writes log messages to Splunk (HTTP Event Collector). - awslogs : AWS Cloudwatch Logs logging driver for Docker. - Write log messages to Cloudwatch API +Please verify the value by yourself, before setting it. Valid shipped log drivers can be found here: +https://docs.docker.com/config/containers/logging/configure/#supported-logging-drivers +Since custom log driver plugins are and must be possible, the value can not be verified through code here. Default value: `$docker::params::log_driver` @@ -440,6 +431,9 @@ Data type: `Array` Set the log driver specific options Valid values per log driver: none : undef + local : + max-size=[0-9+][k|m|g] + max-file=[0-9+] json-file: max-size=[0-9+][k|m|g] max-file=[0-9+] @@ -764,6 +758,14 @@ Specify an array of users to add to the docker group Default value: `[]` +##### `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`` + ##### `docker_group` Data type: `String` @@ -1328,10 +1330,6 @@ Whether or not the curl package is ensured by this module. Default value: `$docker::params::curl_ensure` -### `docker::config` - -The docker::config class. - ### `docker::images` The docker::images class. diff --git a/metadata.json b/metadata.json index f377cf32..b610bf42 100644 --- a/metadata.json +++ b/metadata.json @@ -1,6 +1,6 @@ { "name": "puppetlabs-docker", - "version": "4.4.0", + "version": "5.0.0", "author": "puppetlabs", "summary": "Module for installing and managing docker", "license": "Apache-2.0",