io.quarkus.container.image.jib.deployment

Class JibConfig

java.lang.Object

io.quarkus.container.image.jib.deployment.JibConfig

@ConfigRoot(phase=BUILD_TIME)
public class JibConfig
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
boolean	alwaysCacheBaseImage Controls the optimization which skips downloading base image layers that exist in a target registry.
String	baseJvmImage The base image to be used when a container image is being produced for the jar build
String	baseNativeImage The base image to be used when a container image is being produced for the native binary build
Optional<String>	baseRegistryPassword The password to use to authenticate with the registry used to pull the base JVM image
Optional<String>	baseRegistryUsername The username to use to authenticate with the registry used to pull the base JVM image
Map<String,String>	environmentVariables Environment variables to add to the container image
List<String>	jvmArguments Additional JVM arguments to pass to the JVM when starting the application
Optional<List<String>>	jvmEntrypoint If this is set, then it will be used as the entry point of the container image.
Map<String,String>	labels Custom labels to add to the generated image
Optional<List<String>>	nativeArguments Additional arguments to pass when starting the native application
Optional<List<String>>	nativeEntrypoint If this is set, then it will be used as the entry point of the container image.
List<Integer>	ports The ports to expose
Optional<String>	user The user to use in generated image

Constructor Summary

Constructors

Constructor and Description
JibConfig()

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

baseJvmImage

@ConfigItem(defaultValue="fabric8/java-alpine-openjdk11-jre")
public String baseJvmImage

The base image to be used when a container image is being produced for the jar build

baseNativeImage

@ConfigItem(defaultValue="registry.access.redhat.com/ubi8/ubi-minimal")
public String baseNativeImage

The base image to be used when a container image is being produced for the native binary build

jvmArguments

@ConfigItem(defaultValue="-Djava.util.logging.manager=org.jboss.logmanager.LogManager")
public List<String> jvmArguments

Additional JVM arguments to pass to the JVM when starting the application

nativeArguments

@ConfigItem
public Optional<List<String>> nativeArguments

Additional arguments to pass when starting the native application

jvmEntrypoint

@ConfigItem
public Optional<List<String>> jvmEntrypoint

If this is set, then it will be used as the entry point of the container image. There are a few things to be aware of when creating an entry point

• A valid entrypoint is jar package specific (see quarkus.package.type)
• A valid entrypoint depends on the location of both the launching scripts and the application jar file. To that end it's helpful to remember that when fast-jar packaging is used (the default), all necessary application jars are added to the /work directory and that the same directory is also used as the working directory. When legacy-jar or uber-jar are used, the application jars are unpacked under the /app directory and that directory is used as the working directory.
• Even if the jvmArguments field is set, it is ignored completely

When this is not set, a proper default entrypoint will be constructed. As a final note, a very useful tool for inspecting container image layers that can greatly aid when debugging problems with endpoints is dive

nativeEntrypoint

@ConfigItem
public Optional<List<String>> nativeEntrypoint

If this is set, then it will be used as the entry point of the container image. There are a few things to be aware of when creating an entry point

• A valid entrypoint depends on the location of both the launching scripts and the native binary file. To that end it's helpful to remember that the native application is added to the /work directory and that and the same directory is also used as the working directory
• Even if the nativeArguments field is set, it is ignored completely

When this is not set, a proper default entrypoint will be constructed. As a final note, a very useful tool for inspecting container image layers that can greatly aid when debugging problems with endpoints is dive

environmentVariables

@ConfigItem
public Map<String,String> environmentVariables

Environment variables to add to the container image

labels

@ConfigItem
public Map<String,String> labels

Custom labels to add to the generated image

baseRegistryUsername

@ConfigItem
public Optional<String> baseRegistryUsername

The username to use to authenticate with the registry used to pull the base JVM image

baseRegistryPassword

@ConfigItem
public Optional<String> baseRegistryPassword

The password to use to authenticate with the registry used to pull the base JVM image

ports

@ConfigItem(defaultValue="8080")
public List<Integer> ports

The ports to expose

user

@ConfigItem
public Optional<String> user

The user to use in generated image

alwaysCacheBaseImage

@ConfigItem(defaultValue="false")
public boolean alwaysCacheBaseImage

Controls the optimization which skips downloading base image layers that exist in a target registry. If the user does not set this property, then read as false. If true, base image layers are always pulled and cached. If false, base image layers will not be pulled/cached if they already exist on the target registry.

Constructor Detail

JibConfig

public JibConfig()