Docker Support Feature
fun BuildFeatures.dockerRegistryConnections(init: DockerSupportFeature.() -> Unit): DockerSupportFeature
Docker Registry Connections feature allows automatically signing in to a DockerHub or other container registry before the build start.
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 {
dockerRegistryConnections {
loginToRegistry = on {
dockerRegistryId = "PROJECT_EXT_11,PROJECT_EXT_13"
}
cleanupPushedImages = true
}
}
})Content copied to clipboard
See also
Properties
Functions
Link copied to clipboard
fun booleanParameter(customName: String? = null, trueValue: String? = "true", falseValue: String? = "false"): DelegateProvider<Boolean>
fun booleanParameter(customName: String? = null, trueValue: String? = "true", falseValue: String? = "false", yamlName: String? = null): DelegateProvider<Boolean?>
Link copied to clipboard
fun <T : CompoundParam<T>> compoundParameter(customName: String? = null, yamlName: String? = null): DelegateProvider<T>
Link copied to clipboard
Copies parameters of this object to the specified target
Link copied to clipboard
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
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
fun on(init: DockerSupportFeature.LoginToRegistry.On.() -> Unit = {}): DockerSupportFeature.LoginToRegistry.On
Link copied to clipboard
Link copied to clipboard
open fun stringParameter(customName: String? = null, yamlName: String? = null): DelegateProvider<String>
Link copied to clipboard
Validates this object and reports found errors to the provided consumer