io.dekorate.docker.annotation

Annotation Type DockerBuild

@Target(value={CONSTRUCTOR,TYPE})
 @Retention(value=RUNTIME)
public @interface DockerBuild

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	autoBuildEnabled Flag to automatically register a build hook after compilation.
boolean	autoDeployEnabled Flag to trigger the registration of the deploy hook.
boolean	autoPushEnabled Flag to automatically push the image, to the specified registry.
String	dockerFile The relative path of the Dockerfile, from the module root.
boolean	enabled
String	group The group of the application.
String	image The name of the image to be generated.
String	name The name of the application.
String	registry The registry that holds the image.
String	version The version of the application.

Element Detail

enabled

public abstract boolean enabled

Default:

true

registry

public abstract String registry

The registry that holds the image.

Returns:

The registry or empty string if no registry has been specified.

Default:

""

group

public abstract String group

The group of the application. This value will be use as image user.

Returns:

The specified group name.

Default:

""

name

public abstract String name

The name of the application. This value will be used as name.

Returns:

The specified application name.

Default:

""

version

public abstract String version

The version of the application. This value be used as image tag.

Returns:

The version.

Default:

""

image

public abstract String image

The name of the image to be generated. This property overrides group, name and version.

Returns:

the image name.

Default:

""

dockerFile

public abstract String dockerFile

The relative path of the Dockerfile, from the module root.

Returns:

The relative path.

Default:

"Dockerfile"

autoPushEnabled

public abstract boolean autoPushEnabled

Flag to automatically push the image, to the specified registry.

Returns:

True if hook is to be registered, false otherwise.

Default:

false

autoBuildEnabled

public abstract boolean autoBuildEnabled

Flag to automatically register a build hook after compilation.

Returns:

True if hook is to be registered, false otherwise.

Default:

false

autoDeployEnabled

public abstract boolean autoDeployEnabled

Flag to trigger the registration of the deploy hook. It's generally preferable to use `-Ddekorate.deploy=true` instead of hardcoding this here.

Returns:

True for automatic registration of the build hook.

Default:

false