Package io.micronaut.gradle.crac

Interface CRaCConfiguration

public interface CRaCConfiguration

  • Method Summary

    Modifier and Type
    Method
    Description
    org.gradle.api.provider.Property<String>
    getArch()
    The architecture to use for building the CRaC enabled images.
    org.gradle.api.provider.Property<String>
    getBaseImage()
    The base image to use for CRaC checkpoint generation and the final image.
    org.gradle.api.file.RegularFileProperty
    getCheckpointScript()
    The checkpoint script to copy in to the checkpoint image and execute prior to snapshotting.
    org.gradle.api.provider.Property<Boolean>
    getEnabled()
    If set to false, CRaC support will be disabled.
    org.gradle.api.provider.ListProperty<String>
    getFinalArgs()
    Any arguments passed to java in the final image
    org.gradle.api.provider.Property<org.gradle.jvm.toolchain.JavaLanguageVersion>
    getJavaVersion()
    The java version to use for building the CRaC enabled images.
    org.gradle.api.provider.Property<String>
    getNetwork()
    The optional docker network name to use during building
    org.gradle.api.provider.Property<String>
    getOs()
    Filters the jdk result by the operating system the package is targeting.
    org.gradle.api.provider.Property<String>
    getPlatform()
    Deprecated.
    use getArch() instead
    org.gradle.api.provider.Property<String>
    getPreCheckpointReadinessCommand()
    Prior to creating a checkpoint and running the warmup script, we require to know if the application is up.
    org.gradle.api.file.RegularFileProperty
    getWarmupScript()
    The warmup script to copy in to the checkpoint image and execute prior to snapshotting.

  • Method Details

    • getEnabled

      org.gradle.api.provider.Property<Boolean> getEnabled()
      If set to false, CRaC support will be disabled.
      Returns:
      the enabled property

    • getBaseImage

      org.gradle.api.provider.Property<String> getBaseImage()
      The base image to use for CRaC checkpoint generation and the final image.
      Returns:
      the base image

    • getArch

      org.gradle.api.provider.Property<String> getArch()
      The architecture to use for building the CRaC enabled images. Defaults to the current architecture. Currently only "amd64" and "aarch64" are supported.
      Returns:
      the architecture

    • getOs

      org.gradle.api.provider.Property<String> getOs()
      Filters the jdk result by the operating system the package is targeting. Defaults to "linux-glibc".
      Returns:
      the operating system

    • getJavaVersion

      org.gradle.api.provider.Property<org.gradle.jvm.toolchain.JavaLanguageVersion> getJavaVersion()
      The java version to use for building the CRaC enabled images. Currently only '17' is supported.
      Returns:
      the java version

    • getPlatform

      @Deprecated org.gradle.api.provider.Property<String> getPlatform()
      Deprecated.
      use getArch() instead
      The platform to specify in the FROM instruction defaults to "linux/amd64".
      Returns:
      the platform (can be removed with platform.convention(null) in the CRaCConfiguration extension)

    • getNetwork

      @Optional org.gradle.api.provider.Property<String> getNetwork()
      The optional docker network name to use during building
      Returns:
      the network name

    • getFinalArgs

      org.gradle.api.provider.ListProperty<String> getFinalArgs()
      Any arguments passed to java in the final image
      Returns:
      list of arguments

    • getWarmupScript

      @PathSensitive(RELATIVE) org.gradle.api.file.RegularFileProperty getWarmupScript()
      The warmup script to copy in to the checkpoint image and execute prior to snapshotting.
      Returns:
      The script to add to the checkpoint image.

    • getCheckpointScript

      @PathSensitive(RELATIVE) org.gradle.api.file.RegularFileProperty getCheckpointScript()
      The checkpoint script to copy in to the checkpoint image and execute prior to snapshotting.
      Returns:
      The script to add to the checkpoint image.

    • getPreCheckpointReadinessCommand

      org.gradle.api.provider.Property<String> getPreCheckpointReadinessCommand()
      Prior to creating a checkpoint and running the warmup script, we require to know if the application is up. This property allows you to define your own check for this if the default "curl --output /dev/null --silent --head http://localhost:8080" is not sufficient.
      Returns:
      the bash command to run to check the app is running, it should exit with 0 if the app is up.