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

Class DockerRunContainerTask

    • Constructor Detail

      • DockerRunContainerTask

        public DockerRunContainerTask()

    • Method Detail

      • imageName

        public DockerRunContainerTask imageName​(java.lang.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​(java.lang.String containerName)
        Specifies container name.

      • appendPortMapping

        public DockerRunContainerTask appendPortMapping​(int hostPort,
                                                int containerPort)
        Append a host-container port mapping.

      • 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​(java.lang.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​(java.time.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​(java.lang.String containerEnvironmentVariables)
        Specifies container environment variables.

      • containerCommand

        public DockerRunContainerTask containerCommand​(java.lang.String containerCommand)
        Specifies container command.

      • containerWorkingDirectory

        public DockerRunContainerTask containerWorkingDirectory​(java.lang.String containerWorkingDirectory)
        Sets container working directory. Defaults to /data

      • additionalArguments

        public DockerRunContainerTask additionalArguments​(java.lang.String additionalArguments)
        Sets additional arguments to docker run command, e.g --memory="64m".

      • appendVolumeMapping

        public DockerRunContainerTask appendVolumeMapping​(java.lang.String hostDirectory,
                                                  java.lang.String containerDataVolume)
        Appends a host-container volume mapping. Default mapping entry is ${bamboo.working.directory} -> /data. Note: You can clear it by running clearVolumeMappings().