io.micronaut.build.services

Class DockerService

java.lang.Object

io.micronaut.build.services.DockerService

@Singleton
public class DockerService
extends Object

Provides methods to work with Docker images.

Since:

1.1

Author:

Álvaro Sánchez-Mariscal

Constructor Summary

Constructors

Constructor and Description
DockerService(org.apache.maven.project.MavenProject mavenProject)

Method Summary

Modifier and Type	Method and Description
String	buildImage(com.github.dockerjava.api.command.BuildImageCmd builder) Builds the Docker image from the given BuildImageCmd builder.
com.github.dockerjava.api.command.BuildImageCmd	buildImageCmd() Creates a default BuildImageCmd.
com.github.dockerjava.api.command.BuildImageCmd	buildImageCmd(String dockerfileName) Creates the BuildImageCmd by loading the given Dockerfile as classpath resource.
File	copyFromContainer(String imageId, String containerPath) Copies a file from the specified container path in the given image ID, into a temporal location.
File	loadDockerfileAsResource(String name) Loads the given Dockerfile as classpath resource and copies it into a temporary location in the target directory.
File	loadDockerfileAsResource(String name, String targetFileName) Loads the given Dockerfile as classpath resource and copies it into a temporary location in the target directory.
com.github.dockerjava.api.command.PushImageCmd	pushImageCmd(String imageName) Creates a PushImageCmd from the given image name.
void	runPrivilegedImageAndWait(String imageId, Integer timeoutSeconds, String checkpointNetworkName, String... binds) Creates a container based on a given image, and runs it.

Methods inherited from class java.lang.Object

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

Constructor Detail

DockerService

@Inject
public DockerService(org.apache.maven.project.MavenProject mavenProject)

Method Detail

buildImageCmd

public com.github.dockerjava.api.command.BuildImageCmd buildImageCmd(String dockerfileName)
                                                              throws IOException

Creates the BuildImageCmd by loading the given Dockerfile as classpath resource.

Throws:

IOException

buildImageCmd

public com.github.dockerjava.api.command.BuildImageCmd buildImageCmd()

Creates a default BuildImageCmd.

buildImage

public String buildImage(com.github.dockerjava.api.command.BuildImageCmd builder)

Builds the Docker image from the given BuildImageCmd builder.

Returns:

The resulting image ID.

runPrivilegedImageAndWait

public void runPrivilegedImageAndWait(String imageId,
                                      Integer timeoutSeconds,
                                      String checkpointNetworkName,
                                      String... binds)
                               throws IOException

Creates a container based on a given image, and runs it.

Parameters:

imageId - the image to use

timeoutSeconds - the timeout in seconds for the container to finish execution

binds - the bind mounts to use

Throws:

IOException

copyFromContainer

public File copyFromContainer(String imageId,
                              String containerPath)

Copies a file from the specified container path in the given image ID, into a temporal location.

loadDockerfileAsResource

public File loadDockerfileAsResource(String name)
                              throws IOException

Loads the given Dockerfile as classpath resource and copies it into a temporary location in the target directory.

Throws:

IOException

loadDockerfileAsResource

public File loadDockerfileAsResource(String name,
                                     String targetFileName)
                              throws IOException

Loads the given Dockerfile as classpath resource and copies it into a temporary location in the target directory.

Throws:

IOException

pushImageCmd

public com.github.dockerjava.api.command.PushImageCmd pushImageCmd(String imageName)

Creates a PushImageCmd from the given image name.