Package com.atlassian.bamboo.specs.builders.task

Class DockerRunContainerTask

java.lang.Object

com.atlassian.bamboo.specs.api.builders.EntityPropertiesBuilder<P>

com.atlassian.bamboo.specs.api.builders.task.Task<T,P>

com.atlassian.bamboo.specs.builders.task.AbstractDockerTask<DockerRunContainerTask,DockerRunContainerTaskProperties>

com.atlassian.bamboo.specs.builders.task.DockerRunContainerTask

public class DockerRunContainerTask
extends AbstractDockerTask<DockerRunContainerTask,DockerRunContainerTaskProperties>

Task used to run a Docker container.

Field Summary

Fields inherited from class com.atlassian.bamboo.specs.builders.task.AbstractDockerTask

environmentVariables, workingSubdirectory

Fields inherited from class com.atlassian.bamboo.specs.api.builders.task.Task

conditions, description, requirements, taskEnabled

Constructor Summary

Constructors

Constructor	Description
DockerRunContainerTask()

Method Summary

Modifier and Type	Method	Description
DockerRunContainerTask	additionalArguments(String additionalArguments)	Sets additional arguments to docker run command, e.g --memory="64m".
DockerRunContainerTask	appendPortMapping(int hostPort, int containerPort)	Append a host-container port mapping.
DockerRunContainerTask	appendVolumeMapping(String hostDirectory, String containerDataVolume)	Appends a host-container volume mapping.
protected @NotNull DockerRunContainerTaskProperties	build()
DockerRunContainerTask	clearPortMappings()	Clears port mappings configuration.
DockerRunContainerTask	clearVolumeMappings()	Clears volume mappings configuration.
DockerRunContainerTask	containerCommand(String containerCommand)	Specifies container command.
DockerRunContainerTask	containerEnvironmentVariables(String containerEnvironmentVariables)	Specifies container environment variables.
DockerRunContainerTask	containerName(String containerName)	Specifies container name.
DockerRunContainerTask	containerWorkingDirectory(String containerWorkingDirectory)	Sets container working directory.
DockerRunContainerTask	detachContainer(boolean detachContainer)	Determines if container should be run in a detached mode.
boolean	equals(Object o)
int	hashCode()
DockerRunContainerTask	imageName(String imageName)	Specifies image name to run.
DockerRunContainerTask	linkToDetachedContainers(boolean linkToDetachedContainers)	Determines whether this container should be linked to other containers which were defined prior to this one via DockerRunContainerTask within the same job.
DockerRunContainerTask	serviceTimeout(Duration serviceTimeout)	Sets timeout on waiting till container service starts.
DockerRunContainerTask	serviceTimeoutInSeconds(long serviceTimeout)	Sets timeout in seconds on waiting till container service starts.
DockerRunContainerTask	serviceURLPattern(String serviceURLPattern)	Bamboo will check if container service is up and running by querying this URL.
DockerRunContainerTask	waitToStart(boolean waitToStart)	Determines if Bamboo should wait for a service to start.

Methods inherited from class com.atlassian.bamboo.specs.builders.task.AbstractDockerTask

environmentVariables, workingSubdirectory

Methods inherited from class com.atlassian.bamboo.specs.api.builders.task.Task

conditions, description, enabled, requirements, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DockerRunContainerTask

public DockerRunContainerTask()

Method Detail

imageName

public DockerRunContainerTask imageName(String imageName)

Specifies image name to run. Optionally registry name, namespace and tag may be added here, e.g registry.address:port/namespace/repository:tag.

This field is mandatory.

detachContainer

public DockerRunContainerTask detachContainer(boolean detachContainer)

Determines if container should be run in a detached mode. Defaults to false.

If set to true specifing a container name is mandatory.

containerName

public DockerRunContainerTask containerName(String containerName)

Specifies container name.

appendPortMapping

public DockerRunContainerTask appendPortMapping(int hostPort,
                                                int containerPort)

Append a host-container port mapping.

clearPortMappings

public DockerRunContainerTask clearPortMappings()

Clears port mappings configuration.

waitToStart

public DockerRunContainerTask waitToStart(boolean waitToStart)

Determines if Bamboo should wait for a service to start. Defaults to false.

If sets to true service URL pattern and timeout settings are mandatory.

serviceURLPattern

public DockerRunContainerTask serviceURLPattern(String serviceURLPattern)

Bamboo will check if container service is up and running by querying this URL. Defaults to http://localhost:${docker.port}

Note: You can use ${docker.port} to get the first exposed container port.

serviceTimeoutInSeconds

public DockerRunContainerTask serviceTimeoutInSeconds(long serviceTimeout)

Sets timeout in seconds on waiting till container service starts. Defaults to 120.

serviceTimeout

public DockerRunContainerTask serviceTimeout(Duration serviceTimeout)

Sets timeout on waiting till container service starts. Defaults to 120 seconds.

linkToDetachedContainers

public DockerRunContainerTask linkToDetachedContainers(boolean linkToDetachedContainers)

Determines whether this container should be linked to other containers which were defined prior to this one via DockerRunContainerTask within the same job.

containerEnvironmentVariables

public DockerRunContainerTask containerEnvironmentVariables(String containerEnvironmentVariables)

Specifies container environment variables.

containerCommand

public DockerRunContainerTask containerCommand(String containerCommand)

Specifies container command.

containerWorkingDirectory

public DockerRunContainerTask containerWorkingDirectory(String containerWorkingDirectory)

Sets container working directory. Defaults to /data

additionalArguments

public DockerRunContainerTask additionalArguments(String additionalArguments)

Sets additional arguments to docker run command, e.g --memory="64m".

appendVolumeMapping

public DockerRunContainerTask appendVolumeMapping(String hostDirectory,
                                                  String containerDataVolume)

Appends a host-container volume mapping. Default mapping entry is ${bamboo.working.directory} -> /data. Note: You can clear it by running clearVolumeMappings().

clearVolumeMappings

public DockerRunContainerTask clearVolumeMappings()

Clears volume mappings configuration. Please remember that default container working directory is /data. You can update it via containerWorkingDirectory(String).

build

@NotNull
protected @NotNull DockerRunContainerTaskProperties build()

Specified by:

build in class Task<DockerRunContainerTask,DockerRunContainerTaskProperties>

equals

public boolean equals(Object o)

Overrides:

equals in class AbstractDockerTask<DockerRunContainerTask,DockerRunContainerTaskProperties>

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractDockerTask<DockerRunContainerTask,DockerRunContainerTaskProperties>