clj-docker-client.core — lispyclouds/clj-docker-client 0.3.2

build clj

(build connection path repo)

(build connection path repo tag)

Builds an image from a provided directory, repo and optional tag.

WORKS ONLY IF DAEMON IS RUNNING LOCALLY.

Returns the id of the built image.

Assumes a Dockerfile to be present in that directory.

commit-container clj

(commit-container connection id repo tag command)

Creates an image from the changes of a container by name or id.

Takes the repo, tag of the image and the new entry point command. Returns the id of the new image.

connect clj

(connect)

(connect uri)

Connects to the local/remote Docker daemon with default settings.

Returns the connection.

Supply the URI as a string with protocol for a remote connection.

container-state clj

(container-state connection name)

Returns the current state of a created container by name or id.

cp clj

(cp connection id host-path container-path)

Copies the host-path recursively to the container by id/name to the container-path inside the container

create clj

(create {:keys [connection image command env exposed-ports working-dir user]
         :as props})

(create connection image-or-props)

(create connection image cmd)

(create connection image cmd env-vars)

(create connection image cmd env-vars exposed-ports)

(create connection image cmd env-vars exposed-ports working-dir)

(create connection
        image
        cmd
        env-vars
        exposed-ports
        working-dir
        user
        &
        [{:keys [network-mode] :as props}])

Creates a container.

Takes the following as params or as a map:

• image
• entry point command
• env vars, optional
• host->container port mapping, optional
• working dir, optional
• user, optional

Returns the id of the created container.

disconnect clj

(disconnect connection)

Closes the connection to the Docker server.

image-ls clj

(image-ls connection)

Lists all available images.

image-rm clj

(image-rm connection name)

(image-rm connection name force? no-prune?)

Deletes an image by name or id.

Returns the name of the removed image.

If forced? is set removal is forced. If no-prune? is set untagged parents aren't removed.

The name is represented by <repo>:<tag>.

info clj

(info connection)

Fetches system wide info about the connected Docker server.

inspect clj

(inspect connection container)

Inspects a container by name or id.

kill clj

(kill connection name)

Kills container with SIGKILL by name or id.

Assumes the container to be running. Returns the name or id.

logs clj

(logs connection name)

Returns a lazy seq of logs split by lines from a container by name or id.

logs-live clj

(logs-live connection name callback)

Live version of logs, takes a callback to be notified of Logs as the appear.

Attaches to the container and blocks until the attached container is finished.

network-connect clj

(network-connect connection network container)

Connects a container to a network.

Takes the name/id of the container and the name of the network.

network-create clj

(network-create connection name)

(network-create connection name check-duplicate?)

(network-create connection name check-duplicate? attachable?)

Creates a new docker network with a unique name.

network-disconnect clj

(network-disconnect connection network container)

Disconnects a container to a network.

Takes the name/id of the container and the name of the network.

network-ls clj

(network-ls connection)

Lists all networks.

network-rm clj

(network-rm connection name)

Removes a network by name.

pause clj

(pause connection name)

Pauses a container by name or id.

Returns the name or id.

ping clj

(ping connection)

Healthiness check for the connection to the Docker server.

Returns OK if everything is fine.

ps clj

(ps connection)

(ps connection all?)

Lists all containers.

Lists all running containers by default, all can be listed by passing a true param to all?

pull clj

(pull connection name)

Pulls an image by name.

The name is represented by <repo>:<tag>.

push clj

(push connection name)

Pushes an image by name.

Returns the name of the pushed image.

The name is represented by <repo>:<tag>.

restart clj

(restart connection name)

(restart connection name timeout)

Restarts a container with by name or id.

Waits for timeout secs or value of timeout before killing. Returns the name or id.

rm clj

(rm connection name)

(rm connection name force?)

Removes a container by name or id.

Pass true to force kill a running container and remove it. Returns the name or id.

run clj

(run connection image command env-vars exposed-ports)

(run connection image command env-vars exposed-ports detached?)

Runs a container with a specified image, command, env vars and host->container port mappings.

Returns the container id.

Runs synchronously by default, i.e. waits for the container exit. If detached? flag is true, executes asynchronously.

start clj

(start connection name)

Starts a created container asynchronously by name or id.

Returns the name or id.

stats clj

(stats connection name)

(stats connection name sample-duration)

Returns the resource stats of a created container by name or id/name.

Samples for 1 second by default. Pass sample-duration to change

stop clj

(stop connection name)

(stop connection name timeout)

Stops a container with SIGTERM by name or id.

Waits for timeout secs or value of timeout before killing. Returns the name or id.

stream-path clj

(stream-path connection id path)

Returns a input stream of a given path in a container by name.

The stream points to a tar archive of the supplied path.

Create a TarArchiveInputStream from this to process the archived files.

un-pause clj

(un-pause connection name)

Un-pauses a container by name or id.

Returns the name or id.

wait-container clj

(wait-container connection name)

Waits for the exit of a container by id or name.