org.jenkinsci.plugins.docker.workflow.client

Class DockerClient

java.lang.Object

org.jenkinsci.plugins.docker.workflow.client.DockerClient

public class DockerClient
extends Object

Simple docker client for Pipeline.

Author:

tom.fennelly@gmail.com

Field Summary

Fields

Modifier and Type	Field and Description
static String	CGROUP_MATCHER_PATTERN Known cgroup formats 4:cpuset:/system.slice/docker-3dd988081e7149463c043b5d9c57d7309e079c5e9290f91feba1cc45a04d6a5b.scope 2:cpu:/docker/3dd988081e7149463c043b5d9c57d7309e079c5e9290f91feba1cc45a04d6a5b
static String	DOCKER_DATE_TIME_FORMAT

Constructor Summary

Constructors

Constructor and Description
DockerClient(hudson.Launcher launcher, hudson.model.Node node, String toolName)

Method Summary

Modifier and Type	Method and Description
com.google.common.base.Optional<String>	getContainerIdIfContainerized() Checks if this DockerClient instance is running inside a container and returns the id of the container if so.
org.jenkinsci.plugins.docker.commons.fingerprint.ContainerRecord	getContainerRecord(hudson.EnvVars launchEnv, String containerId)
List<String>	getVolumes(hudson.EnvVars launchEnv, String containerID) Inspect the mounts of a container.
String	inspect(hudson.EnvVars launchEnv, String objectId, String fieldPath) Inspect a docker image/container.
String	inspectRequiredField(hudson.EnvVars launchEnv, String objectId, String fieldPath) Inspect a docker image/container.
protected static hudson.util.VersionNumber	parseVersionNumber(String versionString) Parse a Docker version string (e.g.
void	rm(hudson.EnvVars launchEnv, String containerId) Remove a container.
String	run(hudson.EnvVars launchEnv, String image, String args, String workdir, Map<String,String> volumes, Collection<String> volumesFromContainers, hudson.EnvVars containerEnv, String user, String entrypoint) Run a docker image.
void	stop(hudson.EnvVars launchEnv, String containerId) Stop a container.
hudson.util.VersionNumber	version() Get the docker version.
String	whoAmI() Who is executing this DockerClient instance.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DOCKER_DATE_TIME_FORMAT

public static final String DOCKER_DATE_TIME_FORMAT

See Also:

Constant Field Values

CGROUP_MATCHER_PATTERN

public static final String CGROUP_MATCHER_PATTERN

Known cgroup formats 4:cpuset:/system.slice/docker-3dd988081e7149463c043b5d9c57d7309e079c5e9290f91feba1cc45a04d6a5b.scope 2:cpu:/docker/3dd988081e7149463c043b5d9c57d7309e079c5e9290f91feba1cc45a04d6a5b

See Also:

Constant Field Values

Constructor Detail

DockerClient

public DockerClient(@Nonnull
                    hudson.Launcher launcher,
                    @CheckForNull
                    hudson.model.Node node,
                    @CheckForNull
                    String toolName)

Method Detail

run

public String run(@Nonnull
                  hudson.EnvVars launchEnv,
                  @Nonnull
                  String image,
                  @CheckForNull
                  String args,
                  @CheckForNull
                  String workdir,
                  @Nonnull
                  Map<String,String> volumes,
                  @Nonnull
                  Collection<String> volumesFromContainers,
                  @Nonnull
                  hudson.EnvVars containerEnv,
                  @Nonnull
                  String user,
                  @Nonnull
                  String entrypoint)
           throws IOException,
                  InterruptedException

Run a docker image.

Parameters:

launchEnv - Docker client launch environment.

image - The image name.

args - Any additional arguments for the docker run command.

workdir - The working directory in the container, or null for default.

volumes - Volumes to be bound. Supply an empty list if no volumes are to be bound.

volumesFromContainers - Mounts all volumes from the given containers.

containerEnv - Environment variables to set in container.

user - The uid:gid to execute the container command as. Use whoAmI().

entrypoint - The command to execute in the image container being run.

Returns:

The container ID.

Throws:

IOException

InterruptedException

stop

public void stop(@Nonnull
                 hudson.EnvVars launchEnv,
                 @Nonnull
                 String containerId)
          throws IOException,
                 InterruptedException

Stop a container.

Also removes (rm(EnvVars, String)) the container.

Parameters:

launchEnv - Docker client launch environment.

containerId - The container ID.

Throws:

IOException

InterruptedException

rm

public void rm(@Nonnull
               hudson.EnvVars launchEnv,
               @Nonnull
               String containerId)
        throws IOException,
               InterruptedException

Remove a container.

Parameters:

launchEnv - Docker client launch environment.

containerId - The container ID.

Throws:

IOException

InterruptedException

inspect

@CheckForNull
public String inspect(@Nonnull
                                    hudson.EnvVars launchEnv,
                                    @Nonnull
                                    String objectId,
                                    @Nonnull
                                    String fieldPath)
                             throws IOException,
                                    InterruptedException

Inspect a docker image/container.

Parameters:

launchEnv - Docker client launch environment.

objectId - The image/container ID.

fieldPath - The data path of the data required e.g. .NetworkSettings.IPAddress.

Returns:

The inspected field value. Null if the command failed

Throws:

IOException

InterruptedException

inspectRequiredField

@Nonnull
public String inspectRequiredField(@Nonnull
                                            hudson.EnvVars launchEnv,
                                            @Nonnull
                                            String objectId,
                                            @Nonnull
                                            String fieldPath)
                                     throws IOException,
                                            InterruptedException

Inspect a docker image/container.

Parameters:

launchEnv - Docker client launch environment.

objectId - The image/container ID.

fieldPath - The data path of the data required e.g. .NetworkSettings.IPAddress.

Returns:

The inspected field value. May be an empty string

Throws:

IOException - Execution error. Also fails if cannot retrieve the requested field from the request

InterruptedException - Interrupted

Since:

1.1

version

@CheckForNull
public hudson.util.VersionNumber version()
                                                throws IOException,
                                                       InterruptedException

Get the docker version.

Returns:

The VersionNumber instance if the version string matches the expected format, otherwise null.

Throws:

IOException

InterruptedException

parseVersionNumber

protected static hudson.util.VersionNumber parseVersionNumber(@Nonnull
                                                              String versionString)

Parse a Docker version string (e.g. "Docker version 1.5.0, build a8a31ef").

Parameters:

versionString - The version string to parse.

Returns:

The VersionNumber instance if the version string matched the expected format, otherwise null.

whoAmI

public String whoAmI()
              throws IOException,
                     InterruptedException

Who is executing this DockerClient instance.

Returns:

a String containing the uid:gid.

Throws:

IOException

InterruptedException

getContainerIdIfContainerized

public com.google.common.base.Optional<String> getContainerIdIfContainerized()
                                                                      throws IOException,
                                                                             InterruptedException

Checks if this DockerClient instance is running inside a container and returns the id of the container if so.

Returns:

an optional string containing the container id, or absent if it isn't containerized.

Throws:

IOException

InterruptedException

See Also:

Discussion

getContainerRecord

public org.jenkinsci.plugins.docker.commons.fingerprint.ContainerRecord getContainerRecord(@Nonnull
                                                                                           hudson.EnvVars launchEnv,
                                                                                           String containerId)
                                                                                    throws IOException,
                                                                                           InterruptedException

Throws:

IOException

InterruptedException

getVolumes

public List<String> getVolumes(@Nonnull
                               hudson.EnvVars launchEnv,
                               String containerID)
                        throws IOException,
                               InterruptedException

Inspect the mounts of a container. These might have been declared VOLUMEs, or mounts defined via --volume.

Parameters:

launchEnv - Docker client launch environment.

containerID - The container ID.

Returns:

a list of filesystem paths inside the container

Throws:

IOException - Execution error. Also fails if cannot retrieve the requested field from the request

InterruptedException - Interrupted