Liking cljdoc? Tell your friends :D

clj-docker-client.core


buildclj

(build connection path repo)
(build connection path repo tag)

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

Assumes a Dockerfile to be present in that directory.

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

Assumes a Dockerfile to be present in that directory.
sourceraw docstring

connectclj

(connect)

Connects to the local Docker daemon with default settings.

Returns the connection.

Connects to the local Docker daemon with default settings.

Returns the connection.
sourceraw docstring

container-stateclj

(container-state connection name)

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

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

createclj

(create connection image cmd env-vars)

Creates a container.

Takes the image, entry point command and environment vars as a map and returns the id of the created container.

Creates a container.

Takes the image, entry point command and environment vars as a map
and returns the id of the created container.
sourceraw docstring

disconnectclj

(disconnect connection)

Closes the connection to the Docker server.

Closes the connection to the Docker server.
sourceraw docstring

image-lsclj

(image-ls connection)

Lists all available images.

Lists all available images.
sourceraw docstring

image-rmclj

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

Deletes an image by name or id.

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

Deletes an image by *name* or id.

The *name* is represented by <repo>:<tag>.
sourceraw docstring

killclj

(kill connection name)

Kills container with SIGKILL by name or id.

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

Kills container with SIGKILL by name or id.

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

logsclj

(logs connection name)

Returns a line-seq of logs from a container by name or id.

Returns a line-seq of logs from a container by name or id.
sourceraw docstring

pauseclj

(pause connection name)

Pauses a container by name or id.

Returns the name or id.

Pauses a container by name or id.

Returns the name or id.
sourceraw docstring

pingclj

(ping connection)

Healthiness check for the connection to the Docker server.

Returns OK if everything is fine.

Healthiness check for the connection to the Docker server.

Returns OK if everything is fine.
sourceraw docstring

psclj

(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?

Lists all containers.

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

pullclj

(pull connection name)

Pulls an image by name.

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

Pulls an image by *name*.

The *name* is represented by <repo>:<tag>.
sourceraw docstring

pushclj

(push connection name auth)

Pushes an image by name.

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

Pushes an image by *name*.

The *name* is represented by <repo>:<tag>.
sourceraw docstring

registerclj

(register username password)

Builds login info for a Docker registry.

Builds login info for a Docker registry.
sourceraw docstring

restartclj

(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.

Restarts a container with by name or id.

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

rmclj

(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.

Removes a container by name or id.

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

startclj

(start connection name)

Starts a created container asynchronously by name or id.

Returns the name or id.

Starts a created container asynchronously by name or id.

Returns the name or id.
sourceraw docstring

stopclj

(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.

Stops a container with SIGTERM by name or id.

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

un-pauseclj

(un-pause connection name)

Un-pauses a container by name or id.

Returns the name or id.

Un-pauses a container by name or id.

Returns the name or id.
sourceraw docstring

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close