ct_containers_docker (ct_containers v0.1.1)
Link to this section Summary
Functions
Reads the host address from a ContainerInfo acquired by inspect/1
Extracts the status information from a ContainerInfo acquired by inspect/1
Link to this section Types
Link to this type
container_engine_cb_module/0
-type container_engine_cb_module() :: module().
Link to this type
container_id/0
-type container_id() :: string() | binary().
Link to this type
ct_container_context/0
-type ct_container_context() :: #{image => binary(), wait_strategy => wait_strategy(), wait_timeout => number(), port_mapping => list(), labels => labels(), binds => list(), network => {atom(), binary()}, alias => binary(), env => #{binary() => binary()}, container_engine_module => module()}.
Link to this type
labels/0
-type labels() :: #{binary() => binary()}.
Link to this type
port_mapping/0
-type port_mapping() :: {1..65535, tcp | udp}.
Link to this type
wait_strategy/0
-type wait_strategy() :: fun((container_id(), container_engine_cb_module(), wait_strategy_ctx()) -> {true | false, wait_strategy_ctx()}).
Link to this type
wait_strategy_ctx/0
-type wait_strategy_ctx() :: map().
Link to this section Functions
Link to this function
container_logs(ContainerId)
-spec container_logs(binary()) -> {ok, binary()}.
Link to this function
create_container(ContainerSpec)
-spec create_container(ct_containers_container:ct_container_context()) -> {ok, binary()}.
Link to this function
create_network(Name, Labels)
Link to this function
delete_container(ContainerId)
-spec delete_container(binary()) -> {ok, binary()}.
Link to this function
delete_network(Identifier)
Link to this function
detach_container(NetworkId, ContainerName)
Link to this function
host(ContainerId)
-spec host(container_id()) -> {ok, binary()}.
Link to this function
inspect(ContainerId)
-spec inspect(binary()) -> {ok, map()}.
Link to this function
list_containers()
Link to this function
list_containers(_)
-spec list_containers([{filters, map()}] | []) -> {ok, list()}.
Link to this function
list_networks(_)
Link to this function
port(ContainerId, _)
-spec port(container_id(), port_mapping()) -> {ok, 1..65565}.
Link to this function
prune_networks()
Link to this function
pull_image(Image)
Link to this function
start_container(ContainerId)
-spec start_container(binary()) -> {ok, binary()}.
Link to this function
status(ContainerId)
-spec status(container_id()) -> {ok, binary()}.
Link to this function
stop_container(ContainerId)
-spec stop_container(binary()) -> {ok, binary()}.