Package io.quarkus.container.image.deployment

Class ContainerImageConfig

java.lang.Object

io.quarkus.container.image.deployment.ContainerImageConfig

@ConfigRoot
public class ContainerImageConfig
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
Optional<List<String>>	additionalTags	Additional tags of the container image.
Optional<Boolean>	build	Whether or not a image build will be performed.
Optional<String>	builder	The name of the container image extension to use (e.g.
Optional<String>	group	The group the container image will be part of
Optional<String>	image	Represents the entire image string.
boolean	insecure	Whether or not insecure registries are allowed
Map<String,String>	labels	Custom labels to add to the generated image.
String	name	The name of the container image.
Optional<String>	password	The password to use to authenticate with the registry where the built image will be pushed
Optional<Boolean>	push	Whether or not an image push will be performed.
Optional<String>	registry	The container registry to use
Optional<String>	tag	The tag of the container image.
Optional<String>	username	The username to use to authenticate with the registry where the built image will be pushed

Constructor Summary

Constructors

Constructor	Description
ContainerImageConfig()

Method Summary

Modifier and Type	Method	Description
Optional<String>	getEffectiveGroup()	Since user.name which is default value can be uppercase and uppercase values are not allowed in the repository part of image references, we need to make the username lowercase.
boolean	isBuildExplicitlyDisabled()
boolean	isBuildExplicitlyEnabled()
boolean	isPushExplicitlyDisabled()
boolean	isPushExplicitlyEnabled()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

group

@ConfigItem(defaultValue="${user.name}")
@ConvertWith(io.quarkus.runtime.configuration.TrimmedStringConverter.class)
public Optional<String> group

The group the container image will be part of

name

@ConfigItem(defaultValue="${quarkus.application.name:unset}")
@ConvertWith(io.quarkus.runtime.configuration.TrimmedStringConverter.class)
public String name

The name of the container image. If not set defaults to the application name

tag

@ConfigItem(defaultValue="${quarkus.application.version:latest}")
public Optional<String> tag

The tag of the container image. If not set defaults to the application version

additionalTags

@ConfigItem
public Optional<List<String>> additionalTags

Additional tags of the container image.

labels

@ConfigItem
public Map<String,String> labels

Custom labels to add to the generated image.

registry

@ConfigItem
public Optional<String> registry

The container registry to use

image

@ConfigItem
public Optional<String> image

Represents the entire image string. If set, then group, name, registry, tags, additionalTags are ignored

username

@ConfigItem
public Optional<String> username

The username to use to authenticate with the registry where the built image will be pushed

password

@ConfigItem
public Optional<String> password

The password to use to authenticate with the registry where the built image will be pushed

insecure

@ConfigItem
public boolean insecure

Whether or not insecure registries are allowed

build

@ConfigItem
public Optional<Boolean> build

Whether or not a image build will be performed.

push

@ConfigItem
public Optional<Boolean> push

Whether or not an image push will be performed.

builder

@ConfigItem
public Optional<String> builder

The name of the container image extension to use (e.g. docker, jib, s2i). The option will be used in case multiple extensions are present.

Constructor Detail

ContainerImageConfig

public ContainerImageConfig()

Method Detail

isBuildExplicitlyEnabled

public boolean isBuildExplicitlyEnabled()

isBuildExplicitlyDisabled

public boolean isBuildExplicitlyDisabled()

isPushExplicitlyEnabled

public boolean isPushExplicitlyEnabled()

isPushExplicitlyDisabled

public boolean isPushExplicitlyDisabled()

getEffectiveGroup

public Optional<String> getEffectiveGroup()

Since user.name which is default value can be uppercase and uppercase values are not allowed in the repository part of image references, we need to make the username lowercase. If spaces exist in the user name, we replace them with the dash character. We purposely don't change the value of an explicitly set group.