This is a simple Docker client written in Java. We build and test docker-client on Docker versions 1.6 - 1.10 (specifically the ones here). See Docker docs on the mapping between Docker version and API version.
// Create a client based on DOCKER_HOST and DOCKER_CERT_PATH env varsfinalDockerClientdocker = DefaultDockerClient.fromEnv().build();
// Pull an imagedocker.pull("busybox");
// Pull an image from a private repository// Server address defaults to "https://index.docker.io/v1/"AuthConfigauthConfig = AuthConfig.builder().email("foo@bar.com").username("foobar")
.password("secret-password").serverAddress("https://myprivateregistry.com/v1/").build();
docker.pull("foobar/busybox-private:latest", authConfig);
// You can also set the AuthConfig for the DockerClient instead of passing everytime you call pull()DockerClientdocker = DefaultDockerClient.fromEnv().authConfig(authConfig).build();
// Bind container ports to host portsfinalString[] ports = {"80", "22"};
finalMap<String, List<PortBinding>> portBindings = newHashMap<String, List<PortBinding>>();
for (Stringport : ports) {
List<PortBinding> hostPorts = newArrayList<PortBinding>();
hostPorts.add(PortBinding.of("0.0.0.0", port));
portBindings.put(port, hostPorts);
}
// Bind container port 443 to an automatically allocated available host port.List<PortBinding> randomPort = newArrayList<PortBinding>();
randomPort.add(PortBinding.randomPort("0.0.0.0"));
portBindings.put("443", randomPort);
finalHostConfighostConfig = HostConfig.builder().portBindings(portBindings).build();
// Create container with exposed portsfinalContainerConfigcontainerConfig = ContainerConfig.builder()
.hostConfig(hostConfig)
.image("busybox").exposedPorts(ports)
.cmd("sh", "-c", "while :; do sleep 1; done")
.build();
finalContainerCreationcreation = docker.createContainer(containerConfig);
finalStringid = creation.id();
// Inspect containerfinalContainerInfoinfo = docker.inspectContainer(id);
// Start containerdocker.startContainer(id);
// Exec command inside running container with attached STDOUT and STDERRfinalString[] command = {"bash", "-c", "ls"};
finalStringexecId = docker.execCreate(
id, command, DockerClient.ExecCreateParam.attachStdout(),
DockerClient.ExecCreateParam.attachStderr());
finalLogStreamoutput = docker.execStart(execId);
finalStringexecOutput = output.readFully();
// Kill containerdocker.killContainer(id);
// Remove containerdocker.removeContainer(id);
// Close the docker clientdocker.close();If you're looking for how to use docker-client, see the User Manual. If you're looking for how to build and develop it, keep reading.
docker-client should be buildable on any platform with Docker, JDK7+, and a recent version of Maven 3.
If you are using Docker for Mac and DefaultDockerClient.fromEnv(), it might not be clear
what value to use for the DOCKER_HOST environment variable. The value you should use is
DOCKER_HOST=unix:///var/run/docker.sock, at least as of version 1.11.1-beta11.
As of version 4.0.8 of docker-client, DefaultDockerClient.fromEnv() uses
unix:///var/run/docker.sock on OS X by default.
Make sure Docker daemon is running and that you can do docker ps.
You can run tests on their own with mvn test. Note that the tests start and stop a large number of
containers, so the list of containers you see with docker ps -a will start to get pretty long
after many test runs. You may find it helpful to occassionally issue docker rm $(docker ps -aq).
Commits to the master branch will trigger our continuous integration agent to build the jar and release by uploading to Sonatype. If you are a project maintainer with the necessary credentials, you can also build and release locally by running the below.
mvn release:clean
mvn release:prepare
mvn release:performPlease note that in releases 2.7.6 and earlier, the default artifact was the shaded version. When upgrading to version 2.7.7, you will need to include the shaded classifier if you relied on the shaded dependencies in the docker-client jar.
Standard:
<dependency>
<groupId>com.spotify</groupId>
<artifactId>docker-client</artifactId>
<version>3.5.12</version>
</dependency>Shaded:
<dependency>
<groupId>com.spotify</groupId>
<artifactId>docker-client</artifactId>
<classifier>shaded</classifier>
<version>3.5.12</version>
</dependency>This is particularly important if you use Jersey 1.x in your project. To avoid conflicts with docker-client and Jersey 2.x, you will need to explicitly specify the shaded version above.