clj-docker-client.core — timokramer/clj-docker-client 0.5.1-1

categories clj

(categories)

(categories version)

Returns the available categories.

Takes an optional API version for specific ones.

client clj

(client {:keys [category conn api-version] :as args})

Constructs a client for a specified category.

Returns the client.

Examples are: :containers, :images, etc

connect clj

(connect {:keys [uri connect-timeout read-timeout write-timeout call-timeout]})

Connects to the provided :uri in the connection options.

Optionally takes connect, read, write and call timeout in ms. All are set to 0 by default, which is no timeout.

Returns the connection.

The url must be fully qualified with the protocol. eg. unix:///var/run/docker.sock or https://my.docker.host:6375

doc clj

(doc {:keys [category api-version]} operation)

Returns the doc of the supplied category and operation

invoke clj

(invoke {:keys [category conn api-version]} {:keys [op params as]})

Performs the operation with the specified client and a map of options.

Returns the resulting map.

Options are: :op specifying the operation to invoke. Required. :params specifying the params to be passed to the :op. :as specifying the result. Can be either of :stream, :socket, :data. Defaults to :data.

If a :socket is requested, the underlying UNIX socket is returned.

ops clj

(ops client)

Returns the supported ops for a client.