Akd v0.3.0 Akd.Build.Docker View Source

A native Hook module that comes shipped with Akd.

This module uses Akd.Hook.

Provides a set of operations that build an elixir app in a Docker container using a specified Dockerfile at a deployment's build_at destination.

This hook assumes that there is docker 17.x installed on the build_at destination.

This hook also assumes that the given Dockerfile has all the operations setup.

Ensures to cleanup and remove the Docker images/containers created by this build. run_ensure is set to false on default. So, by default it doesn't remove the containers. This is to speed up the next build. If you wish to remove these containers, make sure to pass run_ensure as true.

Doesn't have any Rollback operations.

Options:

run_ensure: boolean. Specifies whether to a run a command or not.
ignore_failure: boolean. Specifies whether to continue if this hook fails.
cmd_envs: list of tuples. Specifies the environments to provide while building the distillery release.

Defaults:

run_ensure: false
ignore_failure: false

Link to this section Summary

Functions

get_hooks(deployment, opts)

Callback implementation for get_hooks/2

Link to this section Functions

get_hooks(deployment, opts)

get_hooks(Akd.Deployment.t(), list()) :: Akd.Hook.t()

get_hooks(Akd.Deployment.t(), Keyword.t()) :: [Akd.Hook.t()]

Callback implementation for get_hooks/2.

This function returns a list of operations that can be used to build a release using distillery on the build_at destination of a deployment.

Examples

iex> deployment = %Akd.Deployment{mix_env: "prod",
...> build_at: Akd.Destination.local("."),
...> publish_to: Akd.Destination.local("."),
...> name: "name",
...> vsn: "0.1.1"}
iex> Akd.Build.Docker.get_hooks(deployment, [])
[%Akd.Hook{ensure: [%Akd.Operation{cmd: "docker rm $(docker ps -a -q)",
  cmd_envs: [],
  destination: %Akd.Destination{host: :local, path: ".",
   user: :current}}], ignore_failure: false,
main: [%Akd.Operation{cmd: "docker build -f Dockerfile -t name:0.1.1 .",
  cmd_envs: [],
  destination: %Akd.Destination{host: :local, path: ".",
   user: :current}}], rollback: [], run_ensure: false}]

Akd

v0.3.0