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.

Returns the id of the built image.

Assumes a Dockerfile to be present in that directory.

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

Returns the id of the built image.

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

commit-containerclj

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

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.
sourceraw docstring

connectclj

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

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

cpclj

(cp connection id host-path container-path)

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

Copies the contents of the host-path to the container by id/name
to the container-path inside the container
sourceraw docstring

createclj

(create connection image)
(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)

Creates a container.

Takes the image, entry point command, env vars and host->container port mapping.

Returns the id of the created container.

Creates a container.

Takes the image, entry point command, env vars and host->container port mapping.

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.

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

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>.
sourceraw docstring

infoclj

(info connection)

Fetches system wide info about the connected Docker server.

Fetches system wide info about the connected Docker server.
sourceraw docstring

inspectclj

(inspect connection container)

Inspects a container by name or id.

Inspects a container by name or id.
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 lazy seq of logs split by lines from a container by name or id.

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

network-connectclj

(network-connect connection network container)

Connects a container to a network.

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

Connects a container to a network.

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

network-createclj

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

Creates a new docker network with a unique name.
sourceraw docstring

network-disconnectclj

(network-disconnect connection network container)

Disconnects a container to a network.

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

Disconnects a container to a network.

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

network-lsclj

(network-ls connection)

Lists all networks.

Lists all networks.
sourceraw docstring

network-rmclj

(network-rm connection name)

Removes a network by name.

Removes a network by name.
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.

Returns the name of the pushed image.

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

Pushes an image by *name*.

Returns the name of the pushed image.

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

runclj

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

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

stream-pathclj

(stream-path connection id path)

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

Returns a tar stream of a given path in a container by name.
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

wait-containerclj

(wait-container connection name)

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

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

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

× close