divo
v2.0.0

View Source Divo.Compose (divo v2.0.0)

Implements the basic docker-compose commands for running from your mix tasks. Run, stop, and kill container services.

These operations only apply to services managed by Divo, i.e. defined in your Mix.env file under the :myapp, :divo key.

Link to this section Summary

Functions

kill()

Builds and/or validates the compose file and executes the docker-compose down call to stop the containerized services and removes all resources created by the compose file such as containers, networks, and volumes.

run(opts \\ [])

Builds and/or validates the compose file and executes the docker-compose up call to start the entirety of the defined stack or a subset of the services defined in the stack based on supplying an optional list of service keys.

stop()

Builds and/or validates the compose file and executes the docker-compose stop call to stop the containerized services without removing the resources created by the compose file.

Link to this section Functions

Link to this function

kill()

View Source 
@spec kill() :: :ok | {:error, any()}

Builds and/or validates the compose file and executes the docker-compose down call to stop the containerized services and removes all resources created by the compose file such as containers, networks, and volumes.

Link to this function

run(opts \\ [])

View Source 
@spec run(keyword()) :: [any()]

Builds and/or validates the compose file and executes the docker-compose up call to start the entirety of the defined stack or a subset of the services defined in the stack based on supplying an optional list of service keys.

Link to this function

stop()

View Source 
@spec stop() :: :ok | {:error, any()}

Builds and/or validates the compose file and executes the docker-compose stop call to stop the containerized services without removing the resources created by the compose file.