Package io.quarkus.deployment.pkg

Interface PackageConfig.JarConfig.AppcdsConfig

Enclosing interface:
PackageConfig.JarConfig
public static interface PackageConfig.JarConfig.AppcdsConfig
Configuration for AppCDS generation.

  • Method Summary

    Modifier and Type
    Method
    Description
    Optional<String>
    builderImage()
    When AppCDS generation is enabled, if this property is set, then the JVM used to generate the AppCDS file will be the JVM present in the container image.
    boolean
    enabled()
    Whether to automate the creation of AppCDS.
    boolean
    useContainer()
    Whether creation of the AppCDS archive should run in a container if available.

  • Method Details

    • enabled

      @WithDefault("false") boolean enabled()
      Whether to automate the creation of AppCDS. Furthermore, this option only works for Java 11+ and is considered experimental for the time being. Finally, care must be taken to use the same exact JVM version when building and running the application.

    • builderImage

      Optional<String> builderImage()
      When AppCDS generation is enabled, if this property is set, then the JVM used to generate the AppCDS file will be the JVM present in the container image. The builder image is expected to have the 'java' binary on its PATH. This flag is useful when the JVM to be used at runtime is not the same exact JVM version as the one used to build the jar. Note that this property is consulted only when quarkus.package.jar.appcds.enabled=true and it requires having docker available during the build.

    • useContainer

      @WithDefault("true") boolean useContainer()
      Whether creation of the AppCDS archive should run in a container if available.

      Normally, if either a suitable container image to use to create the AppCDS archive can be determined automatically or if one is explicitly set using the quarkus.<package-type>.appcds.builder-image setting, the AppCDS archive is generated by running the JDK contained in the image as a container.

      If this option is set to false, a container will not be used to generate the AppCDS archive. Instead, the JDK used to build the application is also used to create the archive. Note that the exact same JDK version must be used to run the application in this case.

      Ignored if quarkus.package.jar.appcds.enabled is set to false.