DockerAPI.Containers
SourceSummary
create(container, client) | Create a container with a randomly generated name |
create(name, container, client) | Create a container with a specific name |
inspect(container, client) | Inspects a specific container |
kill(container, client) | Kill a running container |
list(client) | List all containers |
pause(container, client) | Pause the container |
remove(container, force \\ false, client) | Remove the container id from the filesystem |
rename(container, new_name, client) | Rename the container id to a new_name |
restart(container, client) | Restart a running container |
run(container, client) | Create and start a container with a randomly generated name |
run(name, container, client) | Create and start a container with a specific name |
start(container, client) | Start a container in a stopped state |
stop(container, client) | stop a container in a running state |
top(container, client) | List processes running inside the container |
unpause(container, client) | Unpause the container |
Functions
Specs:
- create(Map.t, DockerAPI.Client.t) :: Map.t
Create a container with a randomly generated name
See API Docs for map keys.
Specs:
- create(String.t, Map.t, DockerAPI.Client.t) :: Map.t
Create a container with a specific name.
See API Docs for map keys.
Specs:
- inspect(String.t | Map.t, DockerAPI.Client.t) :: Map.t
Inspects a specific container
Return low-level information on the container.
See API Docs for information on the body.
Specs:
- kill(String.t | Map.t, DockerAPI.Client.t) :: Map.t
Kill a running container
Specs:
- list(DockerAPI.Client.t) :: List.t
List all containers
See API Docs for information on the body.
Specs:
- pause(String.t | Map.t, DockerAPI.Client.t) :: Map.t
Pause the container
Specs:
- remove(String.t | Map.t, Map.t, DockerAPI.Client.t) :: Map.t
Remove the container id from the filesystem
Optionally force kill the container if it is running
Specs:
- rename(String.t | Map.t, String.t, DockerAPI.Client.t) :: Map.t
Rename the container id to a new_name
Specs:
- restart(String.t | Map.t, DockerAPI.Client.t) :: Map.t
Restart a running container
Specs:
- run(Map.t, DockerAPI.Client.t) :: Map.t
Create and start a container with a randomly generated name
See API Docs for map keys.
Specs:
- run(String.t, Map.t, DockerAPI.Client.t) :: Map.t
Create and start a container with a specific name.
See API Docs for map keys.
Specs:
- start(String.t | Map.t, DockerAPI.Client.t) :: Map.t
Start a container in a stopped state
Specs:
- stop(String.t | Map.t, DockerAPI.Client.t) :: Map.t
stop a container in a running state
Specs:
- top(String.t | Map.t, DockerAPI.Client.t) :: Map.t
List processes running inside the container
See API Docs for information on the body.
Specs:
- unpause(String.t | Map.t, DockerAPI.Client.t) :: Map.t
Unpause the container