Skip to content

Commit 88a1f46

Browse files
authored
Merge pull request #854 from puppetlabs/release-prep
Release prep v5.0.0
2 parents 298f7e7 + dc0713a commit 88a1f46

File tree

3 files changed

+39
-27
lines changed

3 files changed

+39
-27
lines changed

CHANGELOG.md

Lines changed: 17 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,21 @@
22

33
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).
44

5-
## [v4.4.0](https://github.com/puppetlabs/puppetlabs-docker/tree/v4.4.0) (2022-05-31)
5+
## [v5.0.0](https://github.com/puppetlabs/puppetlabs-docker/tree/v5.0.0) (2022-08-18)
6+
7+
[Full Changelog](https://github.com/puppetlabs/puppetlabs-docker/compare/v4.4.0...v5.0.0)
8+
9+
### Changed
10+
11+
- Remove log\_driver limitations [\#792](https://github.com/puppetlabs/puppetlabs-docker/pull/792) ([timdeluxe](https://github.com/timdeluxe))
12+
13+
### Added
14+
15+
- pdksync - \(GH-cat-11\) Certify Support for Ubuntu 22.04 [\#850](https://github.com/puppetlabs/puppetlabs-docker/pull/850) ([david22swan](https://github.com/david22swan))
16+
- adding optional variable for package\_key\_check\_source to RedHat [\#846](https://github.com/puppetlabs/puppetlabs-docker/pull/846) ([STaegtmeier](https://github.com/STaegtmeier))
17+
- New create\_user parameter on main class [\#841](https://github.com/puppetlabs/puppetlabs-docker/pull/841) ([traylenator](https://github.com/traylenator))
18+
19+
## [v4.4.0](https://github.com/puppetlabs/puppetlabs-docker/tree/v4.4.0) (2022-06-01)
620

721
[Full Changelog](https://github.com/puppetlabs/puppetlabs-docker/compare/v4.3.0...v4.4.0)
822

@@ -294,7 +308,7 @@ All notable changes to this project will be documented in this file. The format
294308

295309
- \(FM-8151\) Add Windows Server 2019 support [\#493](https://github.com/puppetlabs/puppetlabs-docker/pull/493) ([eimlav](https://github.com/eimlav))
296310
- Support for docker machine download and install [\#466](https://github.com/puppetlabs/puppetlabs-docker/pull/466) ([acurus-puppetmaster](https://github.com/acurus-puppetmaster))
297-
- Add service\_provider parameter to docker::run [\#376](https://github.com/puppetlabs/puppetlabs-docker/pull/376) ([iamjamestl](https://github.com/iamjamestl))
311+
- Add service\_provider parameter to docker::run [\#376](https://github.com/puppetlabs/puppetlabs-docker/pull/376) ([jameslikeslinux](https://github.com/jameslikeslinux))
298312

299313
### Fixed
300314

@@ -428,7 +442,7 @@ All notable changes to this project will be documented in this file. The format
428442
- fixing deep merge issue and yaml alias [\#387](https://github.com/puppetlabs/puppetlabs-docker/pull/387) ([davejrt](https://github.com/davejrt))
429443
- Adds a Usage example for daemon level extra\_parameters [\#386](https://github.com/puppetlabs/puppetlabs-docker/pull/386) ([mpepping](https://github.com/mpepping))
430444
- Fixing create\_resources for volumes [\#384](https://github.com/puppetlabs/puppetlabs-docker/pull/384) ([andytechdad](https://github.com/andytechdad))
431-
- docker::run: Support depend\_services with full systemd unit names [\#383](https://github.com/puppetlabs/puppetlabs-docker/pull/383) ([iamjamestl](https://github.com/iamjamestl))
445+
- docker::run: Support depend\_services with full systemd unit names [\#383](https://github.com/puppetlabs/puppetlabs-docker/pull/383) ([jameslikeslinux](https://github.com/jameslikeslinux))
432446
- \(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))
433447
- Fix the docker\_compose options parameter position [\#378](https://github.com/puppetlabs/puppetlabs-docker/pull/378) ([FlorentPoinsaut](https://github.com/FlorentPoinsaut))
434448
- missing quote in swarm documentation [\#377](https://github.com/puppetlabs/puppetlabs-docker/pull/377) ([lcrownover](https://github.com/lcrownover))

REFERENCE.md

Lines changed: 21 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,10 @@
66

77
### Classes
88

9+
#### Public Classes
10+
911
* [`docker`](#docker): Module to install an up-to-date version of Docker from package.
1012
* [`docker::compose`](#dockercompose): install Docker Compose using the recommended curl command.
11-
* [`docker::config`](#dockerconfig)
1213
* [`docker::images`](#dockerimages)
1314
* [`docker::install`](#dockerinstall): Module to install an up-to-date version of Docker from a package repository.
1415
Only for Debian, Red Hat and Windows
@@ -24,6 +25,10 @@ Only for Debian, Red Hat and Windows
2425
* [`docker::systemd_reload`](#dockersystemd_reload): For systems that have systemd
2526
* [`docker::volumes`](#dockervolumes)
2627

28+
#### Private Classes
29+
30+
* `docker::config`: Configuration for docker
31+
2732
### Defined types
2833

2934
* [`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:
146151
* [`manage_package`](#manage_package)
147152
* [`service_name`](#service_name)
148153
* [`docker_users`](#docker_users)
154+
* [`create_user`](#create_user)
149155
* [`docker_group`](#docker_group)
150156
* [`daemon_environment_files`](#daemon_environment_files)
151157
* [`repo_opt`](#repo_opt)
@@ -412,24 +418,9 @@ Data type: `Optional[String]`
412418

413419
Set the log driver.
414420
Docker default is json-file.
415-
Valid values: none, json-file, syslog, journald, gelf, fluentd
416-
Valid values description:
417-
none : Disables any logging for the container.
418-
docker logs won't be available with this driver.
419-
json-file: Default logging driver for Docker.
420-
Writes JSON messages to file.
421-
syslog : Syslog logging driver for Docker.
422-
Writes log messages to syslog.
423-
journald : Journald logging driver for Docker.
424-
Writes log messages to journald.
425-
gelf : Graylog Extended Log Format (GELF) logging driver for Docker.
426-
Writes log messages to a GELF endpoint: Graylog or Logstash.
427-
fluentd : Fluentd logging driver for Docker.
428-
Writes log messages to fluentd (forward input).
429-
splunk : Splunk logging driver for Docker.
430-
Writes log messages to Splunk (HTTP Event Collector).
431-
awslogs : AWS Cloudwatch Logs logging driver for Docker.
432-
Write log messages to Cloudwatch API
421+
Please verify the value by yourself, before setting it. Valid shipped log drivers can be found here:
422+
https://docs.docker.com/config/containers/logging/configure/#supported-logging-drivers
423+
Since custom log driver plugins are and must be possible, the value can not be verified through code here.
433424

434425
Default value: `$docker::params::log_driver`
435426

@@ -440,6 +431,9 @@ Data type: `Array`
440431
Set the log driver specific options
441432
Valid values per log driver:
442433
none : undef
434+
local :
435+
max-size=[0-9+][k|m|g]
436+
max-file=[0-9+]
443437
json-file:
444438
max-size=[0-9+][k|m|g]
445439
max-file=[0-9+]
@@ -764,6 +758,14 @@ Specify an array of users to add to the docker group
764758

765759
Default value: `[]`
766760

761+
##### <a name="create_user"></a>`create_user`
762+
763+
Data type: `Boolean`
764+
765+
If `true` the list of `docker_users` will be created as well as added to the docker group
766+
767+
Default value: ``true``
768+
767769
##### <a name="docker_group"></a>`docker_group`
768770

769771
Data type: `String`
@@ -1328,10 +1330,6 @@ Whether or not the curl package is ensured by this module.
13281330

13291331
Default value: `$docker::params::curl_ensure`
13301332

1331-
### <a name="dockerconfig"></a>`docker::config`
1332-
1333-
The docker::config class.
1334-
13351333
### <a name="dockerimages"></a>`docker::images`
13361334

13371335
The docker::images class.

metadata.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "puppetlabs-docker",
3-
"version": "4.4.0",
3+
"version": "5.0.0",
44
"author": "puppetlabs",
55
"summary": "Module for installing and managing docker",
66
"license": "Apache-2.0",

0 commit comments

Comments
 (0)