com.amihaiemil.docker

Interface Swarm

public interface Swarm

Docker engines can be clustered together in a swarm.

See the swarm mode and swarm API documentation for more information.

Since:

0.0.1

Version:

$Id: 30f740918a7b6ea40cd4621ad3e2f4bb28720e3a $

Author:

George Aristy ([email protected])

Method Summary

Modifier and Type	Method and Description
Docker	docker() Docker engine.
String	init(javax.json.JsonObject spec) Initialize a new swarm by providing a full specification.
String	init(String listenAddress) Initialize a new swarm.
javax.json.JsonObject	inspect() Inspects this swarm, returning low-level information about it in Json format.
void	leave(boolean force) Leave the Swarm.

Method Detail

inspect

javax.json.JsonObject inspect()
                       throws IOException

Inspects this swarm, returning low-level information about it in Json format. It is recommended to wrap this Json into a live object, with an interface, which would animate it.

Returns:

Swarm info in Json format.

Throws:

IOException - If something goes wrong.

init

String init(String listenAddress)
     throws IOException

Initialize a new swarm.

Parameters:

listenAddress - Listen address used for inter-manager communication. This can either be in the form of '192.168.1.1:4567' or 'eth0:4567' where the port number is optional in both cases.

Returns:

The swarm's token.

Throws:

IOException - If something goes wrong.

init

String init(javax.json.JsonObject spec)
     throws IOException

Initialize a new swarm by providing a full specification.

Parameters:

spec - Full specification for the swarm.

Returns:

The swarm's token.

Throws:

IOException - If something goes wrong.

leave

void leave(boolean force)
    throws IOException

Leave the Swarm.

Parameters:

force - Force leave swarm, even if this is the last manager or that it will break the cluster.

Throws:

IOException - If something goes wrong.

docker

Docker docker()

Docker engine.

Returns:

Docker.