You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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
Copy file name to clipboardExpand all lines: CHANGELOG.md
+23-1
Original file line number
Diff line number
Diff 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
+
1
23
# Version 2.0.0
2
24
3
25
Various fixes for github issues
@@ -129,4 +151,4 @@ Forked for garethr/docker v5.3.0
Copy file name to clipboardExpand all lines: README.md
+23-18
Original file line number
Diff line number
Diff line change
@@ -37,7 +37,7 @@ The Puppet docker module installs, configures, and manages [Docker](https://gith
37
37
38
38
## Description
39
39
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).
41
41
42
42
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.
43
43
@@ -57,7 +57,7 @@ class { 'docker':
57
57
}
58
58
```
59
59
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.
61
61
62
62
To ensure the module configures the latest repositories, add the following code to the manifest file:
63
63
@@ -232,15 +232,15 @@ service { 'docker'
232
232
233
233
### Images
234
234
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.
236
236
237
237
To install a Docker image, add the `docker::image` defined type to the manifest file:
238
238
239
239
```puppet
240
240
docker::image { 'base': }
241
241
```
242
242
243
-
The code above is equivalent to running the `docker pull base` command. However, it removes the default fiveminute execution timeout.
243
+
The code above is equivalent to running the `docker pull base` command. However, it removes the default five-minute execution timeout.
244
244
245
245
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:
246
246
@@ -360,15 +360,17 @@ To pull the image before it starts, specify the `pull_on_start` parameter.
360
360
361
361
To execute a command before the container stops, specify the `before_stop` parameter.
362
362
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.
364
364
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.
366
366
367
-
The `extra_parameters` parametercontains 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.
368
368
369
369
By default, automatic restarting of the service on failure is enabled by the service file for systemd based systems.
370
370
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.
372
374
373
375
To use an image tag, add the following code to the manifest file:
374
376
@@ -403,15 +405,15 @@ If using Hiera, you can configure the `docker::run_instance` class:
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.
407
409
408
410
```puppet
409
411
docker::run { 'helloworld':
410
412
ensure => absent,
411
413
}
412
414
```
413
415
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.
415
417
416
418
```puppet
417
419
docker::run { 'helloworld':
@@ -470,7 +472,7 @@ A defined network can be used on a `docker::run` resource with the `net` paramet
470
472
471
473
#### Windows
472
474
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).
474
476
475
477
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.
476
478
@@ -543,7 +545,7 @@ class {'docker::compose':
543
545
```
544
546
Set the `version` parameter to any version you need to install.
545
547
546
-
This is a example of a Compose file:
548
+
This is an example of a Compose file:
547
549
548
550
```yaml
549
551
compose_test:
@@ -562,7 +564,7 @@ docker_compose { 'test':
562
564
563
565
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.
564
566
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.
566
568
567
569
```puppet
568
570
docker_compose { 'test':
@@ -585,7 +587,7 @@ docker_compose {'test':
585
587
}
586
588
```
587
589
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.
589
591
590
592
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.
591
593
@@ -720,7 +722,7 @@ Ran on 1 node in 6.16 seconds
720
722
721
723
### Docker services
722
724
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.
724
726
725
727
To create a Docker service, add the following code to the manifest file:
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).
0 commit comments