Forge Home

Modules

Puppet

Resources

PuppetEcosystemPuppet CommunityUpdates

docker_compose

This module install, set and manage Docker Compose
Project URLRSS FeedReport issues

46,569 downloads

46,262 latest version

4.6 quality score

We run a couple of automated
scans to help you access a
module's quality. Each module is
given a score based on how well
the author has formatted their
code and documentation and
modules are also checked for
malware using VirusTotal.

Please note, the information below
is for guidance only and neither of
these methods should be considered
an endorsement by Puppet.

Support the Puppet Community by contributing to this module

You are welcome to contribute to this module by suggesting new features, currency updates, or fixes. Every contribution is valuable to help ensure that the module remains compatible with the latest Puppet versions and continues to meet community needs. Complete the following steps:

  1. Review the module’s contribution guidelines and any licenses. Ensure that your planned contribution aligns with the author’s standards and any legal requirements.
  2. Fork the repository on GitHub, make changes on a branch of your fork, and submit a pull request. The pull request must clearly document your proposed change.

For questions about updating the module, contact the module’s author.

Version information

  • 0.1.1 (latest)
  • 0.1.0
released May 2nd 2017
This version is compatible with:

Start using this module

  • r10k or Code Manager
  • Bolt
  • Manual installation
  • Direct download

Add this module to your Puppetfile:

mod 'maxlareo-docker_compose', '0.1.1'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add maxlareo-docker_compose
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install maxlareo-docker_compose --version 0.1.1

Direct download is not typically how you would use a Puppet module to manage your infrastructure, but you may want to download the module in order to inspect the code.

Download
Tags: docker, containers, compose, docker-compose

Documentation

maxlareo/docker_compose — version 0.1.1 May 2nd 2017

docker_compose

Table of Contents

  1. Overview
  2. Module Description - What the module does and why it is useful
  3. Setup - The basics of getting started with docker_compose
  4. Usage - Configuration options and additional functionality
  5. Reference - An under-the-hood peek at what the module is doing and how
  6. Limitations - OS compatibility, etc.
  7. Development - Guide for contributing to the module

Overview

A Puppet module to install and set Docker Compose files and manage Docker containers through Docker Compose commands.

Support

This module is currently tested on:

  • Debian Jessie

Module Description

The docker_compose manage Docker Compose Files and Docker containers through them.

This module generate docker-compose.yml files conform to the official Docker Documentation.

Setup

What docker_compose affects

  • Curl present to download Docker Compose binary.
  • Docker Compose binary installed on the node.
  • Docker Compose files in ${name}/docker-compose.yml.

Setup Requirements

This module requires Docker to be installed and running. It also require puppetlabs-stdlib.

Beginning with docker_compose

Install Docker Compose

class { 'docker_compose': }

If using Hiera

---
classes:
  - docker_compose

Docker Compose example

docker_compose::compose { '/opt':
  version  => '2',
  services => {
    'hello-world' => {
      image => 'hello-world'
    },
  },
}

If using Hiera

docker_compose::compose:
  '/opt':
    version: '2'
    services:
      hello-world:
        image: hello-world

On the node, in the '/opt' folder, try docker-compose run hello-world to test it.

Usage

To declare a docker-compose file, use the docker_compose::compose resource. This resource use nested Hashes to describe each docker-compose.yml files.

The first Hash layer use the key as the path of the docker-compose file. The option version is mandatory and describe the docker compose syntax version. The rest is optional and try to follow the Docker Documentation syntax, using four options: services, volumes, networks and secrets.

A service definition contains configuration which will be applied to each container started for that service, much like passing command-line parameters to docker run. Likewise, network and volume definitions are analogous to docker network create and docker volume create.

Secrets configuration are availble from Docker Compose version 3 and grant access to secrets on a per-service basis using the per-service secrets.

Example of bare minimum to create a Docker Compose file

For a file to be created, only the hash key and the version has to be setted.

Create a docker-compose.yml file in '/opt':

docker_compose::compose { '/opt':
  version  => '2',
}

If using Hiera

docker_compose::compose:
  '/opt':
    version: '2'

Declare services / volumes / networks / secrets

Services, Volumes, Networks and Secrets are declared into a Hash, following the Docker Compose file syntax.

Declarations example of some services:

docker_compose::compose { '/opt':
  version  => '2',
  services => {
    'nginx' => {
      image => 'nginx:latest',
      container_name: 'nginx'
    },
    'mariadb' => {
      image => 'mariadb'
    },
  },
}

If using Hiera

docker_compose::compose:
  '/opt':
    version: '2'
      services:
        nginx:
          image: nginx
          container_name: nginx
        mariadb:
          image: mariadb

Full Example

Here is a full example of docker-compose file declarations with this module:

docker_compose::compose { '/opt':
  version  => '2',
  services => {
    nginx => {
      image => 'nginx:latest',
      container_name => 'nginx',
      networks => [ 'net-1' ],
      ports => [ '80:80','443:443' ],
      volumes => [ 'web:/var/www/html' ]
    },
    mariadb => {
      image => 'mariadb'
    },
  },
  volumes => {
    web => {},
  },
  networks => {
    net-1 => {
      ipam => {
        config => [
          { subnet => '172.50.1.0/24' }
        ],
      }
    },
  },
}

If using Hiera

docker_compose::compose:
  '/opt':
    version: '2'
    services:
      nginx:
        image: 'nginx'
        container_name: 'nginx'
        networks:
          - 'net-1'
        ports:
          - '80:80'
          - '443:443'
        volumes:
          - 'web:/var/www/html'
      mariadb:
        image: 'mariadb'
    volumes:
      web:
    networks:
      net-1:
        ipam:
          config:
            - subnet: '172.50.2.0/24'

Reference

Public Class

  • docker_compose

Private Class

  • docker_compose::install
  • docker_compose::params

Define

  • docker_compose::compose

Class docker_compose

Parameters

  • version The version of Docker Compose to be installed. String. Default: 1.8.1

  • docker_compose_path The docker-compose binary full path. String. Default: /usr/local/bin

Define docker_compose::compose

Parameters

  • version The docker-compose syntax version use into the file. String. Default: 2

  • owner The owner of the docker-compose file. String. Default: root

  • group The group of owner the docker-compose file. String. Default: root

  • ensure The puppet ensure state of the docker-compose file. String. Default: present

  • services The docker services describe into the docker-compose file. Hash. Default: undef

  • volumes The docker volumes describe into the docker-compose file. Hash. Default: undef

  • networks The docker networks describe into the docker-compose file. Hash. Default: undef

  • secrets The docker secrets describe into the docker-compose file. Hash. Default: undef

Limitations

This module is tested on Debian 8 and should work on every Debian based distribution.

For now only installation and files creation and management of Docker Compose are supported.

Further functionalities to come:

  • management of docker containers through docker-compose commands. For example, maintain "docker-compose up -d" or set "docker-compose down".
  • possibility to auto pull docker containers from docker-compose via cron. To maintain latest docker images running.

Development

Contributions will be gratefully accepted. Please go to the project page, fork the project, make your changes locally and then raise a pull request. Details on how to do this are available at https://guides.github.com/activities/forking.