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
constructor(init: DockerSupportFeature.() -> Unit)
constructor()

Properties

Link copied to clipboard

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

Link copied to clipboard

Specifies whether the feature is enabled, true by default

Link copied to clipboard
var id: String?

Build feature id, if not specified will be generated

Link copied to clipboard

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

Link copied to clipboard
Link copied to clipboard

Build feature type

Functions

Link copied to clipboard
fun booleanParameter(customName: String? = null, trueValue: String? = "true", falseValue: String? = "false"): DelegateProvider<Boolean?>
Link copied to clipboard
fun clear()
Link copied to clipboard
fun <T : CompoundParam<T>> compoundParameter(customName: String? = null): DelegateProvider<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): DelegateProvider<Double>
Link copied to clipboard
fun <E : Enum<E>> enumParameter(customName: String? = null, mapping: Map<E, String?>? = null): DelegateProvider<E>
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): DelegateProvider<Int>
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): DelegateProvider<String>
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