Skip to content

Commit 58adcd6

Browse files
MarkWsheenaajay
MarkW
authored andcommitted
post release rebase of release branch into master (#347)
* adding in note about use of latest image tag * release prep for 3.0.0 (#342) * V3.0.0 release prep (#343) * release prep for 3.0.0 * Readme updates prior to release prep * Minor updates Minor updates * CLOUD-2146-cleanup-of-cocker-compose-acceptance-tests (#341) (#344) * pinning puppet version to fix failing spec tests (#346) * CLOUD-2146-cleanup-of-cocker-compose-acceptance-tests (#341) * pinning puppet version to fix failing spec tests
1 parent 272e68c commit 58adcd6

File tree

4 files changed

+48
-21
lines changed

4 files changed

+48
-21
lines changed

CHANGELOG.md

+23-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,25 @@
1+
# Version 3.0.0
2+
3+
Various fixes for github issues
4+
- 206
5+
- 226
6+
- 241
7+
- 280
8+
- 281
9+
- 287
10+
- 289
11+
- 294
12+
- 303
13+
- 312
14+
- 314
15+
16+
Adding in the following features/functionality
17+
18+
-Support for multiple compose files.
19+
20+
A full list of issues and PRs associated with this release can be found [here](https://github.com/puppetlabs/puppetlabs-docker/issues?q=is%3Aissue+milestone%3AV3.0.0+is%3Aclosed)
21+
22+
123
# Version 2.0.0
224

325
Various fixes for github issues
@@ -129,4 +151,4 @@ Forked for garethr/docker v5.3.0
129151
Added support for:
130152
- Docker services within a swarm cluster
131153
- Swarm mode
132-
- Docker secrets
154+
- Docker secrets

Gemfile

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ group :test do
77
elsif puppet_git_url = ENV['PUPPET_GIT_URL']
88
gem "puppet", :git => puppet_git_url
99
else
10-
gem "puppet"
10+
gem "puppet", "5.5.6"
1111
end
1212
gem "puppet-lint", "2.3.3"
1313
gem "puppet-lint-unquoted_string-check", "0.3.0"

README.md

+23-18
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ The Puppet docker module installs, configures, and manages [Docker](https://gith
3737

3838
## Description
3939

40-
This module installs, configures, and manages [Docker](https://github.com/docker/docker).
40+
This module install, configures, and manages [Docker](https://github.com/docker/docker).
4141

4242
Due to the new naming convention for Docker packages, this module prefaces any params that refer to the release with `_ce` or `_engine`. Examples of these are documented in this README.
4343

@@ -57,7 +57,7 @@ class { 'docker':
5757
}
5858
```
5959

60-
The latest Docker [repositories](https://docs.docker.com/engine/installation/linux/docker-ce/debian/#set-up-the-repository) are now the default repositories for version 17.06 and above. If you are using a version prior to this, the old repositories are still configured based on the version number passed into the module.
60+
The latest Docker [repositories](https://docs.docker.com/engine/installation/linux/docker-ce/debian/#set-up-the-repository) are now the default repositories for version 17.06 and above. If you are using an older version, the repositories are still configured based on the version number passed into the module.
6161

6262
To ensure the module configures the latest repositories, add the following code to the manifest file:
6363

@@ -232,15 +232,15 @@ service { 'docker'
232232
233233
### Images
234234
235-
Each image requires a unique name, otherwise the installation fails when a duplicate name is detected.
235+
Each image requires a unique name; otherwise, the installation fails when a duplicate name is detected.
236236
237237
To install a Docker image, add the `docker::image` defined type to the manifest file:
238238
239239
```puppet
240240
docker::image { 'base': }
241241
```
242242

243-
The code above is equivalent to running the `docker pull base` command. However, it removes the default five minute execution timeout.
243+
The code above is equivalent to running the `docker pull base` command. However, it removes the default five-minute execution timeout.
244244

245245
To include an optional parameter for installing image tags that is the equivalent to running `docker pull -t="precise" ubuntu`, add the following code to the manifest file:
246246

@@ -360,15 +360,17 @@ To pull the image before it starts, specify the `pull_on_start` parameter.
360360

361361
To execute a command before the container stops, specify the `before_stop` parameter.
362362

363-
Add the container name to the `after` parameter to specify which containers start first. This affects the generation of the `init.d/systemd` script.
363+
Adding the container name to the `after` parameter to specify which containers start first, affects the generation of the `init.d/systemd` script.
364364

365-
Add container dependencies to the `depends` parameter. The container starts before this container and stops before the depended container. This affects the generation of the `init.d/systemd` script. Use the `depend_services` parameter to specify dependencies for generic services, which are not Docker related, that start before this container.
365+
Add container dependencies to the `depends` parameter. The container starts before this container and stops before the depended container. This affects the generation of the `init.d/systemd` script. Use the `depend_services` parameter to specify dependencies for general services, which are not Docker related, that start before this container.
366366

367-
The `extra_parameters` parameter contains an array of command line arguments to pass to the `docker run` command. This parameter is useful for adding additional or experimental options that the docker module currently does not support.
367+
The `extra_parameters` parameter, which contains an array of command line arguments to pass to the `docker run` command, is useful for adding additional or experimental options that the docker module currently does not support.
368368

369369
By default, automatic restarting of the service on failure is enabled by the service file for systemd based systems.
370370

371-
It is highly recommended that an image tag be used at all times with the `docker::run` define type. If not, the latest image will be used, whether it be in a remote registry or installed on the server already by the `docker::image` define type.
371+
It's recommended that an image tag is used at all times with the `docker::run` define type. If not, the latest image ise used, whether it be in a remote registry or installed on the server already by the `docker::image` define type.
372+
373+
NOTE: As of v3.0.0, if the latest tag is used, the image will be the latest at the time the of the initial puppet run. Any subsequent puppet runs will always reference the latest local image. For this this reason it highly recommended that an alternative tag be used, or the image be removed before pulling latest again.
372374

373375
To use an image tag, add the following code to the manifest file:
374376

@@ -403,15 +405,15 @@ If using Hiera, you can configure the `docker::run_instance` class:
403405
command: '/bin/sh -c "while true; do echo hello world; sleep 1; done"'
404406
```
405407
406-
To remove a running container, add the following code to the manifest file. This will also remove the systemd service file associated with the container.
408+
To remove a running container, add the following code to the manifest file. This also removes the systemd service file associated with the container.
407409
408410
```puppet
409411
docker::run { 'helloworld':
410412
ensure => absent,
411413
}
412414
```
413415

414-
To enable the restart of an unhealthy container add the following code to the manifest file.In order to set the health check interval time set the optional health_check_interval parameter, the default health check interval is 30 seconds.
416+
To enable the restart of an unhealthy container, add the following code to the manifest file. In order to set the health check interval time set the optional health_check_interval parameter, the default health check interval is 30 seconds.
415417

416418
```puppet
417419
docker::run { 'helloworld':
@@ -470,7 +472,7 @@ A defined network can be used on a `docker::run` resource with the `net` paramet
470472

471473
#### Windows
472474

473-
On windows, only one NAT network is supported. To support multiple networks Windows Server 2016 with KB4015217 is required. See [Windows Container Network Drivers](https://docs.microsoft.com/en-us/virtualization/windowscontainers/container-networking/network-drivers-topologies) and [Windows Container Networking](https://docs.microsoft.com/en-us/virtualization/windowscontainers/container-networking/architecture).
475+
On windows, only one NAT network is supported. To support multiple networks, Windows Server 2016 with KB4015217 is required. See [Windows Container Network Drivers](https://docs.microsoft.com/en-us/virtualization/windowscontainers/container-networking/network-drivers-topologies) and [Windows Container Networking](https://docs.microsoft.com/en-us/virtualization/windowscontainers/container-networking/architecture).
474476

475477
The Docker daemon will create a default NAT network on the first start unless specified otherwise. To disable the network creation, use the parameter `bridge => 'none'` when installing docker.
476478

@@ -543,7 +545,7 @@ class {'docker::compose':
543545
```
544546
Set the `version` parameter to any version you need to install.
545547

546-
This is a example of a Compose file:
548+
This is an example of a Compose file:
547549

548550
```yaml
549551
compose_test:
@@ -562,7 +564,7 @@ docker_compose { 'test':
562564

563565
Puppet automatically runs Compose, because the relevant Compose services aren't running. If required, include additional options such as enabling experimental features and scaling rules.
564566

565-
In the example below, Puppet runs Compose when the number of containers specified for a service don't match the scale values.
567+
In the example below, Puppet runs Compose when the number of containers specified for a service doesn't match the scale values.
566568

567569
```puppet
568570
docker_compose { 'test':
@@ -585,7 +587,7 @@ docker_compose {'test':
585587
}
586588
```
587589

588-
Please note you should supply your master docker-compose file as the first element in the array. As per docker multi compose file support compose files will be merged in the order they are specified in the array.
590+
Please note you should supply your master docker-compose file as the first element in the array. As per docker, multi compose file support compose files are merged in the order they are specified in the array.
589591

590592
If you are using a v3.2 compose file or above on a Docker Swarm cluster, use the `docker::stack` class. Include the file resource before you run the stack command.
591593

@@ -720,7 +722,7 @@ Ran on 1 node in 6.16 seconds
720722

721723
### Docker services
722724

723-
Docker services create distributed applications across multiple swarm nodes. Each Docker service contains a set of containers which are replicated across the swarm.
725+
Docker services create distributed applications across multiple swarm nodes. Each Docker service replicates a set of containers across the swarm.
724726

725727
To create a Docker service, add the following code to the manifest file:
726728

@@ -888,6 +890,7 @@ docker::plugin {'foo/fooplugin:latest'
888890
ensure => 'absent',
889891
force_remove => true,
890892
}
893+
thub.com
891894
```
892895

893896
## Reference
@@ -937,14 +940,15 @@ docker::plugin {'foo/fooplugin:latest'
937940

938941
The following parameters are available in the `docker_compose` type:
939942

940-
#### `name`
943+
#### 'compose_files'
941944

942-
The Docker compose file path.
945+
An array containing the docker compose file paths.
943946

944947
#### `scale`
945948

946949
A hash of the name of compose services and number of containers.
947-
Values- Compose services: 'string' , containers: 'an integrer'.
950+
951+
Values - Compose services: 'string' , containers: 'integer'.
948952

949953
#### `options`
950954

@@ -1500,3 +1504,4 @@ This module supports:
15001504
## Development
15011505

15021506
If you would like to contribute to this module, see the guidelines in [CONTRIBUTING.MD](https://github.com/puppetlabs/puppetlabs-docker/blob/master/CONTRIBUTING.md).
1507+

metadata.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "puppetlabs-docker",
3-
"version": "2.0.0",
3+
"version": "3.0.0",
44
"author": "Puppet Labs",
55
"summary": "Module for installing and managing docker",
66
"license": "Apache-2.0",

0 commit comments

Comments
 (0)