promise-type-docker-compose

Promise type to manage containers using docker compose

Maintainer

Bas van der Vlies

Module stats

Total Downloads: 1
Updated: Jan 8, 2024

Installation version

Version
Released on Jan 8, 2024

Tags

Installation

                    
cfbs add promise-type-docker-compose
Description
Dependencies
Comments

docker_compose promise type

Synopsis

  • Name: docker_compose
  • Version: 1.0.0
  • Description: Handle the state of the containers defined in the yaml file

Requirements

  • jq (json command line tool)
  • docker compose (command line tool)

Attributes

Name Type Description Mandatory Default
file string Docker compose yaml file Yes Promiser
state string State of the docker images: start, stop, restart, kill, up Yes -
envfile string Specify which env-file needs to be included No -

Examples

Make sure that the docker images are specified in the yaml file are running

bundle agent main
{
    docker_compose:
        "/srv/traefik/docker_compose.yaml"
            state => "start";
}

THis is how we handle a restart if the docker compose file has been changed

bundle agent main
{
    docker_compose:
        "/srv/traefik/docker_compose.yaml"
            state => "restart",                                                                                                                                                                                 
            if => not(canonify("$(this.promiser)_restarted"));  
}

Authors

This software was created by the team at SURF HPCV

Contribute

Feel free to open pull requests to expand this documentation, add features or fix problems. You can also pick up an existing task or file an issue in our bug tracker.

License

This software is licensed under the GNU General Public License v2.0. See LICENSE in the root of the repository for the full license text.

comments powered by Disqus