DockerAPI.Swarm (DockerAPI v0.3.0) View Source

Engines can be clustered together in a swarm. Refer to the swarm mode documentation for more information.

Official document

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

Link to this section Summary

Link to this section Functions

Link to this function

initialize(conn, body \\ %{})

View Source

Initialize a new swarm

Official document

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

Example

Please help!

Link to this function

initialize!(conn, body \\ %{})

View Source

DockerAPI.Swarm.initialize/2

Inspect swarm

Official document

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

Example

Please help!

DockerAPI.Swarm.inspect/1

Join an existing swarm

Official document

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

Example

Please help!

Link to this function

join!(conn, body \\ %{})

View Source

DockerAPI.Swarm.join/2

Link to this function

leave(conn, params \\ [])

View Source

Leave a swarm

Official document

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

Example

Please help!

Link to this function

leave!(conn, params \\ [])

View Source

DockerAPI.Swarm.leave/2

Link to this function

unlock(conn, body \\ %{})

View Source

Unlock a locked manager

Official document

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

Example

Please help!

Link to this function

unlock!(conn, body \\ %{})

View Source

DockerAPI.Swarm.unlock/2

Get the unlock key

Official document

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

Example

Please help!

DockerAPI.Swarm.unlock_key/1

Link to this function

update(conn, params \\ [], body \\ %{})

View Source

Update a swarm

Official document

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

Example

Please help!

Link to this function

update!(conn, params \\ [], body \\ %{})

View Source

DockerAPI.Swarm.update/3