openaperture_builder v0.0.1 → Overview → OpenAperture → Builder → Docker

OpenAperture.Builder.Docker

Summary
Types
Functions

This module contains the logic for interacting with Docker.

Summary↑

build(docker, interrupt_handler \\ nil)	Method to execute a docker build
cleanup_image_cache(docker, image_id \\ nil)	Method to cleanup any cache associated with an image id
execute_async(docker, docker_cmd, interrupt_handler, stdout_log_uuid \\ UUID.uuid1(), stderr_log_uuid \\ UUID.uuid1())
init(docker)	Method to initialize a Docker struct. Validates required values are populated
log_file_from_uuid(uuid)
login(docker)	Method to execute a docker login against a specified Docker registry
pull(docker, image_name)	Method to execute a docker pull from a specified Docker registry
push(docker)	Method to execute a docker push to a specified Docker registry
tag(docker, image_id, list3)	Method to execute add a docker tag

Types ↑

t :: %OpenAperture.Builder.Docker{authenticated: term, docker_host: term, docker_repo_url: term, image_id: term, output_dir: term, registry_email: term, registry_password: term, registry_url: term, registry_username: term, stderr_build_log_uuid: term, stdout_build_log_uuid: term}

Functions

build(docker, interrupt_handler \\ nil)

(function) # ↑

Specs:

build(OpenAperture.Builder.Docker, Fun) :: {:ok, String.t} | {:error, String.t}

Method to execute a docker build.

cleanup_image_cache(docker, image_id \\ nil)

(function) # ↑

Specs:

cleanup_image_cache(OpenAperture.Builder.Docker, String.t) :: :ok | {:error, String.t}

Method to cleanup any cache associated with an image id

execute_async(docker, docker_cmd, interrupt_handler, stdout_log_uuid \\ UUID.uuid1(), stderr_log_uuid \\ UUID.uuid1())

(function) # ↑

Specs:

execute_async(OpenAperture.Builder.Docker.t, String.t, Fun, String.t, String.t) :: {:ok, String.t, String.t} | {:error, String.t, String.t, String.t}

init(docker)

(function) # ↑

Specs:

init(OpenAperture.Builder.Docker) :: {:ok, OpenAperture.Builder.Docker} | {:error, String.t}

Method to initialize a Docker struct. Validates required values are populated.

log_file_from_uuid(uuid)

(function) # ↑

Specs:

log_file_from_uuid(String.t) :: String.t

Specs:

Method to execute a docker login against a specified Docker registry.

pull(docker, image_name)

(function) # ↑

Specs:

pull(OpenAperture.Builder.Docker, String.t) :: :ok | {:error, String.t}

Method to execute a docker pull from a specified Docker registry.

push(docker)

(function) # ↑

Specs:

push(OpenAperture.Builder.Docker) :: :ok | :error

Method to execute a docker push to a specified Docker registry.

tag(docker, image_id, list3)

(function) # ↑

Specs:

tag(OpenAperture.Builder.Docker, String.t, [String.t]) :: :ok | :error
tag(OpenAperture.Builder.Docker, String.t, [String.t]) :: {:ok, String.t} | {:error, String.t}

Method to execute add a docker tag.