Resource Type: dockerservice

Defined in:

lib/puppet/type/dockerservice.rb

Providers:

compose
composev2

Overview

Docker Compose service

Properties

• configuration

  Docker Compose configuration file content (YAML)

• ensure

  Whether a service should be running.

  Supported values:

  • stopped
  • running
  • false (alias for: stopped)
  • true (alias for: running)

Parameters

• basedir

  The directory where to store Docker Compose projects (it could be runtime or temporary directory). By default /var/run/compose

• build (defaults to: false)

  Specify whether to build Docker image

  Supported values:

  • true
  • false
  • yes
  • no
• name (namevar)

  Docker compose service name

• path (defaults to: docker-compose.yml)

  Path to Docker Compose configuration file. Path should be absolute or relative to Project directory

• project

  Docker Compose project name. It could be absolute path to a project directory or just alternate project name

• provider

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

• replace (defaults to: true)

  Whether to replace a configuration file or not

  Supported values:

  • true
  • false
  • yes
  • no
• restart

  Specify a restart command manually.

• start

  Specify a start command manually.

• status

  Specify a status command manually. This command must return 0 if the service is running and a nonzero value otherwise.

• stop

  Specify a stop command manually.