Skip to content

Release prep v5.0.0 #854

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 19, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 17 additions & 3 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand Down Expand Up @@ -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

Expand Down Expand Up @@ -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))
Expand Down
44 changes: 21 additions & 23 deletions REFERENCE.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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.
Expand Down Expand Up @@ -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)
Expand Down Expand Up @@ -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`

Expand All @@ -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+]
Expand Down Expand Up @@ -764,6 +758,14 @@ Specify an array of users to add to the docker group

Default value: `[]`

##### <a name="create_user"></a>`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``

##### <a name="docker_group"></a>`docker_group`

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

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

### <a name="dockerconfig"></a>`docker::config`

The docker::config class.

### <a name="dockerimages"></a>`docker::images`

The docker::images class.
Expand Down
2 changes: 1 addition & 1 deletion metadata.json
Original file line number Diff line number Diff line change
@@ -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",
Expand Down