DockerAPI.Exec (DockerAPI v0.3.0) View Source

Run new commands inside running containers. Refer to the command-line reference for more information.

Official document

https://docs.docker.com/engine/api/v1.40/#tag/Exec

Link to this section Summary

Link to this section Functions

Link to this function

create(container, body \\ %{})

View Source

Create an exec instance

Official document

https://docs.docker.com/engine/api/v1.40/#operation/ContainerExec

Example

DockerAPI.Connection.new() |> DockerAPI.Container.create!([], %{image: "ubuntu", tty: true}) |> DockerAPI.Container.start!() |> DockerAPI.Exec.create(%{"Cmd": ["now"]}) {:ok, %DockerAPI.Exec{ connection: %DockerAPI.Connection{ headers: [], identity_token: nil, options: [], url: "http+unix://%2Fvar%2Frun%2Fdocker.sock", version: nil }, id: "0785ff143b5eb5c624e1c3a2e1aad5afca2e2314ed1375d14b97ace1fb190bc9" }}

Link to this function

create!(container, body \\ %{})

View Source

DockerAPI.Exec.create/2

Inspect an exec instance

Official document

https://docs.docker.com/engine/api/v1.40/#operation/ExecInspect

Example

DockerAPI.Connection.new("http+unix://%2Fvar%2Frun%2Fdocker.sock", [], [recv_timeout: :infinity]) |> DockerAPI.Container.create!([], %{image: "ubuntu", tty: true}) |> DockerAPI.Container.start!() |> DockerAPI.Exec.create!(%{"Cmd": ["date"], tty: true}) |> DockerAPI.Exec.inspect() {:ok, %{ "CanRemove" => false, "ContainerID" => "06e465ea63ea586171cf3bced58b5127190eec7a3b9d8f1d107cb00f96f7f9ac", "DetachKeys" => "", "ExitCode" => nil, "ID" => "3da59eb80146d3c978fe662728dea8d17529f03543882e20128c1c0d79b71f7a", "OpenStderr" => false, "OpenStdin" => false, "OpenStdout" => false, "Pid" => 0, "ProcessConfig" => %{ "arguments" => [], "entrypoint" => "date", "privileged" => false, "tty" => true }, "Running" => false }}

DockerAPI.Exec.inspect/1

Link to this function

resize(exec, params \\ [])

View Source

Resize an exec instance

Official document

https://docs.docker.com/engine/api/v1.40/#operation/ExecResize

Example

Please help!

Link to this function

resize!(exec, params \\ [])

View Source

DockerAPI.Exec.resize/2

Link to this function

start(exec, body \\ %{})

View Source

Start an exec instance

Official document

https://docs.docker.com/engine/api/v1.40/#operation/ExecStart

Example

DockerAPI.Connection.new() |> DockerAPI.Container.create!([], %{image: "ubuntu", tty: true}) |> DockerAPI.Container.start!() |> DockerAPI.Exec.create!(%{"Cmd": ["date"]}) |> DockerAPI.Exec.start() :ok

Link to this function

start!(exec, body \\ %{})

View Source

DockerAPI.Exec.start/2