Resource Type: docker_compose

Defined in:

lib/puppet/type/docker_compose.rb

Providers:

ruby

Overview

A type representing a Docker Compose file

Properties

• ensure (defaults to: present)

  The basic property that the resource should be in.

  Supported values:

  • present
  • absent

Parameters

• compose_files

  An array of Docker Compose Files paths.

• name (namevar)

  The name of the project

• options

  Additional options to be passed directly to docker-compose.

• provider

  The specific backend to use for this ‘docker_compose` resource. You will seldom need to specify this — Puppet will usually discover the appropriate provider for your platform.

• scale

  A hash of compose services and number of containers.

• tmpdir

  Override the temporary directory used by docker-compose.

  This property is useful when the /tmp directory has been mounted with the noexec option. Or is otherwise being prevented It allows the module consumer to redirect docker-composes temporary files to a known directory.

  The directory passed to this property must exist and be accessible by the user that is executing the puppet agent.

• up_args

  Arguments to be passed directly to docker-compose up.