Forge Home

Modules

Puppet

Resources

PuppetEcosystemPuppet CommunityUpdates

docker_systemd

Configure systemd services to run Docker containers.
Project URLRSS FeedReport issues

13,131 downloads

7,229 latest version

5.0 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.5.0 (latest)
  • 0.4.3
  • 0.4.2
  • 0.4.1
  • 0.4.0
  • 0.3.1
  • 0.3.0
  • 0.2.3
  • 0.2.2
  • 0.2.1
  • 0.2.0
  • 0.1.3
  • 0.1.2
  • 0.1.1
released Dec 16th 2016
This version is compatible with:
  • Puppet Enterprise >= 3.7.0
  • Puppet >= 3.4.0
  • , ,

Start using this module

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

Add this module to your Puppetfile:

mod 'ajsmith-docker_systemd', '0.5.0'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add ajsmith-docker_systemd
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install ajsmith-docker_systemd --version 0.5.0

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, systemd

Documentation

ajsmith/docker_systemd — version 0.5.0 Dec 16th 2016

docker_systemd

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_systemd
  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
  8. Release Notes

Overview

This module creates systemd services to run Docker containers.

Module Description

This module provides comprehensive systemd service configuration to manage the running of Docker containers. An important feature it provides is it can configure systemd dependencies so that Docker containers are started in the correct order, which is needed for sharing volumes or establishing links between containers. This is needed to support more sophisticated usage patterns, such as data volume containers.

Setup

What docker_systemd affects

This module generates systemd unit files in /etc/systemd/system. These unit files have a prefix of "docker-", followed by the name of the container.

When docker_systemd services are started, the resulting Docker containers will be stored using Docker's storage driver.

If any Docker images are pulled as a result of running a Docker container, those images will be stored using Docker's storage driver.

This module does not install Docker for you. Plenty of ways to install Docker already exist, so this module does not add yet another way to do it.

This module does not build Docker images. If you need to build images, the puppetlabs/docker_platform module does that just fine.

Setup Requirements

This module requires Docker to be installed and running before any systemd container services are run.

Usage

docker_systemd::container

docker_systemd::container configures a standalone Docker container to run under systemd.

docker_systemd::container { "httpd":
  image   => "httpd",
  publish => ["80:80/tcp"],
  link    => ["db:db"],
  volume  => ["/var/www/html:/var/www/html:ro"]
}

In the above example, a systemd service is configured to run the httpd container, and it publishes port 80 when it runs. The container starts immediately and is configured to start on boot. The container name is based on the title and is named "httpd". The systemd service is also based on the title and is named "docker-httpd.service".

The following options are available for docker_systemd::container:

  • ensure: Takes any ensure value accepted by the Service resource type (Default running).

  • enable: Takes any enable value accepted by the Service resource type (Default true).

  • hostname: The hostname associated with the container.

  • image: The name of the docker image to use.

  • privileged: If set to 'true' give extended privileges to this container.

  • pull_image: Always pull image before starting the container. (Default false)

  • command: Command and arguments to be run by the container.

  • depends: Dependencies on other systemd docker units which need to be started before this one. (List)

  • volume: Volumes to be used by this container. (List)

  • volumes_from: Containers which this container mounts volumes from. (List)

  • link: Containers which this container links to. (List)

  • log_driver: Set log driver to use.

  • log_opt: Set options for the log driver. (List)

  • memory: Memory limit.

  • memory_reservation: Memory soft limit.

  • memory_swap: Swap limit equal to memory plus swap: '-1' to enable unlimited swap.

  • memory_swappiness: Tune container memory swappiness (0 to 100).

  • net: Set network mode.

  • publish: Ports which should be published by this container. (List)

  • entrypoint: Run this container with a different entrypoint.

  • env: Set environment variables in the container. (List)

  • env_file: Use environment file in the container. (List)

  • systemd_env_file: Path to a systemd environment file to use.

  • systemd_depends: Dependencies on other systemd targets. (List)

docker_systemd::exec

docker_systemd::exec allows a docker exec command to be invoked within a docker_systemd::container. No additional containers are created for an exec service, and it depends on the container which it runs against.

docker_systemd::exec { "httpd":
  command => "/bin/ls"
}

The above example configures /bin/ls to be run from within the container of the "docker-httpd" service. The systemd service for this is named "docker-httpd-exec.service" and it depends on "docker-httpd.service".

The following options are available for docker_systemd::exec:

  • command: Command and arguments to be run by the container.

  • container: Identifier of the container if different than the title.

docker_systemd::data_volume_container

docker_systemd::data_volume_container configures a systemd unit for a data volume container. This type of container is only run once at system startup, and is run using an entrypoint of /bin/true. The main purpose of such a container is to provide volume storage to other containers.

docker_systemd::data_volume_container { "httpd-data":
  image => "httpd"
}

The above example creates a data volume container named "httpd-data" from the "httpd" image. The systemd service for this is named "docker-httpd-data.service".

The following options are available for docker_systemd::data_volume_container:

  • image: The name of the docker image to use.

  • pull_image: Always pull image before starting the container. (Default false)

  • systemd_env_file: Path to a systemd environment file to use.

  • systemd_depends: Dependencies on other systemd targets. (List)

For more information about the data volume container pattern, see the official Docker documentation for Creating and mounting a data volume container.

Limitations

This module targets Red Hat Linux systems capable of running Docker:

  • RHEL 7
  • CentOS 7
  • Fedora 20+

Development

Issues and pull requests are welcome! Send those to: https://github.com/ajsmith/puppet-docker_systemd

Release Notes

v0.5.0

  • Add support for memory options on containers:
    • --memory
    • --memory-reservation
    • --memory-swap
    • --memory-swappiness

v0.4.3

  • Fix ordering issue introduced in v0.4.1.

v0.4.2

  • Re-release to fix a build issue in the last release.

v0.4.1

  • Notify container services after systemd unit configurations are reloaded.

v0.4.0

  • Add support for declaring general systemd dependencies.
  • Add support for additional options on containers:
    • --hostname
    • --log-driver
    • --log-opt
    • --net
    • --privileged
  • Add support for additional options on data volume containers:
    • --hostname
    • --privileged
  • Improve error handling for data volume container services.

v0.3.1

  • Documentation updates.

v0.3.0

  • Automatically invoke 'systemctl daemon-reload' when unit files are updated.
  • Add support for systemd environment files.
  • Add option to always pull image before running containers.

v0.2.3

  • Add --volume option for containers.

v0.2.2

  • Add --env and --env-file configuration options for containers.

v0.2.1

  • Add Puppet version compatibility to metadata.

v0.2.0

  • Fixed a bug that prevented a container image from being configured.
  • Added rspec tests for defined resource types.

v0.1.3

  • OS support info fixes.

v0.1.2

  • Metadata updates.

v0.1.1

  • Initial release.