ex_docker_build v0.6.0 ExDockerBuild.API.Docker behaviour

Link to this section Summary

Link to this section Types

Link to this type container_id()
container_id() :: String.t()
Link to this type docker_credentials()
docker_credentials() :: %{
  docker_username: String.t(),
  docker_password: String.t(),
  docker_servername: String.t()
}
Link to this type image_id()
image_id() :: String.t()
Link to this type repository_name()
repository_name() :: String.t()
Link to this type tag_name()
tag_name() :: String.t()

Link to this section Callbacks

Link to this callback commit(container_id, map)
commit(container_id(), map()) ::
  {:ok, HTTPoison.Response.t()} | {:error, HTTPoison.Error.t()}
Link to this callback container_inspect(container_id, boolean)
container_inspect(container_id(), boolean()) ::
  {:ok, HTTPoison.Response.t()} | {:error, HTTPoison.Error.t()}
Link to this callback containers_logs(container_id, params, keyword)
containers_logs(container_id(), params, keyword()) ::
  {:ok, [String.t()]} | {:error, any()}
when params: %{
       optional(:stdout) => 1 | 0,
       optional(:stderr) => 1 | 0,
       optional(:tail) => pos_integer() | String.t(),
       optional(:timestamps) => 1 | 0,
       optional(:follow) => 1 | 0
     }
Link to this callback create_container(map, map)
create_container(map(), map()) ::
  {:ok, HTTPoison.Response.t()} | {:error, HTTPoison.Error.t()}
Link to this callback create_volume(map)
create_volume(map()) ::
  {:ok, HTTPoison.Response.t()} | {:error, HTTPoison.Error.t()}
Link to this callback delete_image(image_id, boolean)
delete_image(image_id(), boolean()) ::
  {:ok, HTTPoison.Response.t()} | {:error, HTTPoison.Error.t()}
Link to this callback get_archive(container_id, arg1)
get_archive(container_id(), String.t()) ::
  {:ok, HTTPoison.Response.t()} | {:error, HTTPoison.Error.t()}
Link to this callback pull(image_id)
pull(image_id()) ::
  {:ok, HTTPoison.Response.t()} | {:error, HTTPoison.Error.t()}
Link to this callback push_image(image_id, arg1, docker_credentials)
push_image(image_id(), String.t(), docker_credentials()) ::
  {:ok, HTTPoison.Response.t()} | {:error, HTTPoison.Error.t()}
Link to this callback remove_container(container_id, map)
remove_container(container_id(), map()) ::
  {:ok, HTTPoison.Response.t()} | {:error, HTTPoison.Error.t()}
Link to this callback start_container(container_id)
start_container(container_id()) ::
  {:ok, HTTPoison.Response.t()} | {:error, HTTPoison.Error.t()}
Link to this callback stop_container(container_id)
stop_container(container_id()) ::
  {:ok, HTTPoison.Response.t()} | {:error, HTTPoison.Error.t()}
Link to this callback tag_image(image_id, repository_name, tag_name)
tag_image(image_id(), repository_name(), tag_name()) ::
  {:ok, HTTPoison.Response.t()} | {:error, HTTPoison.Error.t()}
Link to this callback upload_file(container_id, arg1, arg2)
upload_file(container_id(), Path.t(), Path.t()) ::
  {:ok, HTTPoison.Response.t()} | {:error, HTTPoison.Error.t()}
Link to this callback wait_container(container_id, arg1)
wait_container(container_id(), pos_integer() | :infinity) ::
  {:ok, HTTPoison.Response.t()} | {:error, HTTPoison.Error.t()}