class MStrap::Steps::ComposeStep

Overview

Runnable as mstrap compose, the Compose step provides a wrapper around docker-compose that loads all profile's services.yml, to allow managing all mstrap-managed Docker services.

NOTE Due to limitations with how step arguments work, any arguments intended for docker-compose must be seperated by -- so as to not get interpretted by the mstrap CLI options parser. For example, using mstrap compose -- --version to print the docker-compose version.

Defined in:

mstrap/steps/compose_step.cr

Constant Summary

REMOVED_FLAGS = ["-c", "-d", "-f", "-h", "--skip-project-update"]

Class Method Summary

Instance Method Summary

Instance methods inherited from class MStrap::Step

args : Array(String) args, bootstrap bootstrap, config : MStrap::Configuration config, options : MStrap::CLIOptions options, profile : MStrap::Defs::ProfileDef profile, user : MStrap::User user

Constructor methods inherited from class MStrap::Step

new(config : Configuration, cli_options : CLIOptions, args = [] of String) new

Class methods inherited from class MStrap::Step

description description, long_description long_description, requires_mstrap? requires_mstrap?, requires_shell_restart? requires_shell_restart?, setup_cmd!(cmd : Commander::Command) setup_cmd!

Instance methods inherited from module MStrap::DSL::System

cmd(env : Hash?, command : String, args : Array(String)?, shell = true, input = Process::Redirect::Inherit, output = Process::Redirect::Inherit, error = Process::Redirect::Inherit, quiet = false, sudo = false) cmd

Instance methods inherited from module MStrap::DSL::Logging

log(msg) log, logc(msg) logc, logd(msg) logd, logn(msg) logn, logw(msg) logw, success(msg) success

Class Method Detail

def self.description #

[View source]
def self.setup_cmd!(cmd) #

[View source]

Instance Method Detail

def bootstrap #
Description copied from class MStrap::Step

Executes the step


[View source]