DockerSupportFeature

open class DockerSupportFeature : BuildFeature
fun BuildFeatures.dockerSupport(init: DockerSupportFeature.() -> Unit): DockerSupportFeature

Docker Support feature tracks pushed images and adds a dedicated tab with information about them.

Example.

// Adding docker connections on the project level:
project {

    ...

    buildType(DockerBuild)

    features {
        // Docker registry connection at https://docker.io
        dockerRegistry {
            id = "PROJECT_EXT_11"
            name = "Docker Registry"
            url = "https://docker.io" // It is the default, can be omitted
            userName = "user"
            password = "credentialsJSON:******"
        }

        // Amazon Docker ECR registry connection
        dockerECRRegistry {
            id = "PROJECT_EXT_13"
            displayName = "Amazon ECR"
            ecrType = ecrPrivate()

            registryId = "112233"
            regionCode = "us-east-1"

            credentialsType = accessKeys()
            credentialsProvider = accessKey {
                accessKeyId = "AMAZON_KEY_ID"
                secretAccessKey = "credentialsJSON:******"
            }
        }
    }
}

// And now use these 2 connections in the build configuration, as a build feature:
object DockerBuild : BuildType({
    name = "My build with docker connections"

    features {
        dockerSupport {
            loginToRegistry = on {
                dockerRegistryId = "PROJECT_EXT_11,PROJECT_EXT_13"
            }
            cleanupPushedImages = true
        }
    }
})

See also

Constructors

Link copied to clipboard
fun DockerSupportFeature(init: DockerSupportFeature.() -> Unit)
Link copied to clipboard
fun DockerSupportFeature()

Types

Link copied to clipboard
sealed class LoginToRegistry : CompoundParam<DockerSupportFeature.LoginToRegistry>

Functions

Link copied to clipboard
fun booleanParameter(    customName: String? = null,     trueValue: String? = "true",     falseValue: String? = "false"): <ERROR CLASS><Parametrized, <ERROR CLASS><Parametrized, T?>>
Link copied to clipboard
fun clear()
Link copied to clipboard
fun <T : CompoundParam<T>> compoundParameter(customName: String? = null): <ERROR CLASS><Parametrized, <ERROR CLASS><Parametrized, T?>>
Link copied to clipboard
fun <T : Parametrized> copyParamsTo(target: T): T

Copies parameters of this object to the specified target

Link copied to clipboard
open fun create(): BuildFeature

Creates an instance of this build feature via reflection using a no argument constructor, used during copying. Throws an error if this class doesn't have a default constructor. Subclasses can override it to create an instance without using a default constructor.

Link copied to clipboard
fun doubleParameter(customName: String? = null): <ERROR CLASS><Parametrized, <ERROR CLASS><Parametrized, T?>>
Link copied to clipboard
fun <E : Enum<E>> enumParameter(customName: String? = null, mapping: Map<E, String?>? = null): <ERROR CLASS><Parametrized, <ERROR CLASS><Parametrized, T?>>
Link copied to clipboard
fun findRawParam(paramName: String): Parameter?
Link copied to clipboard
fun hasParam(paramName: String): Boolean
Link copied to clipboard
fun intParameter(customName: String? = null): <ERROR CLASS><Parametrized, <ERROR CLASS><Parametrized, T?>>
Link copied to clipboard
Link copied to clipboard
fun param(name: String, value: String)

Adds parameter with specified name and value

Link copied to clipboard
fun removeRawParam(paramName: String)
Link copied to clipboard
open fun stringParameter(customName: String? = null): <ERROR CLASS><Parametrized, <ERROR CLASS><Parametrized, T?>>
Link copied to clipboard
open override fun toString(): String
Link copied to clipboard
open override fun validate(consumer: ErrorConsumer)

Validates this object and reports found errors to the provided consumer

Properties

Link copied to clipboard
var cleanupPushedImages: <ERROR CLASS>

On server clean-up, delete pushed docker images from registry.

Link copied to clipboard
var enabled: Boolean = true

Specifies whether the feature is enabled, true by default

Link copied to clipboard
var id: String? = null

Build feature id, if not specified will be generated

Link copied to clipboard
var loginToRegistry: <ERROR CLASS>

Log in to the Docker registry with the given ID before the build.

Link copied to clipboard
val params: List<Parameter>
Link copied to clipboard
var type: String

Build feature type