Skip to content

Latest commit

 

History

History
165 lines (114 loc) · 5.36 KB

README.md

File metadata and controls

165 lines (114 loc) · 5.36 KB
Raw

Quarkus Images

This repository contains the container images used by Quarkus.

NOTE: Require CEKit 3.3.x

Quarkus images

The images are available on Quay.io

  • ubi-quarkus-native-image - provides the native-image executable. Used by the Maven and Gradle plugin from Quarkus to build linux64 executables
  • centos-quarkus-maven - Image delivering GraalVM, Maven, Podman and Buildah; this image can be used to build a native executable from source.
  • ubi-quarkus-native-s2i - S2I builder image for OpenShift building a native image from source code (using Gradle or Maven)
  • ubi-quarkus-native-binary-s2i - S2I builder image for OpenShift taking a pre-built native executable as input

To pull these images use:

  • docker pull quay.io/quarkus/ubi-quarkus-native-image:VERSION
  • docker pull quay.io/quarkus/centos-quarkus-maven:VERSION
  • docker pull quay.io/quarkus/ubi-quarkus-native-s2i:VERSION
  • docker pull quay.io/quarkus/ubi-quarkus-native-binary-s2i:VERSION

with VERSION being the version. The version matches the GraalVM version used in the image, for example: 19.2.1. For GraalVM 19.3.0+, the VERSION is suffixed with -java8 or -java11 (except for ubi-quarkus-native-binary-s2i). For example:

quay.io/quarkus/ubi-quarkus-native-s2i:19.3.0-java8 <-- GraalVM 19.3.0 with java 8 support
quay.io/quarkus/ubi-quarkus-native-s2i:19.3.0-java11 <-- GraalVM 19.3.0 with java 11 support
quay.io/quarkus/ubi-quarkus-native-binary-s2i:19.3.0 <-- Native binary s2i

NOTE: You may wonder why we don't use latest. It's because latest has introduced more problems than benefits especially when reproducing issues. For this reason, we recommend using a stable version.

Build

For each overrides file, run the cekit build command. For example:

$ cekit -v build --overrides-file quarkus-native-image-overrides-java8.yaml docker

Note about CEKit

We recommend using virtualenv to run cekit. On MacOS X, you can run the build as follows:

virtualenv --python=python3 ~/cekit
source ~/cekit/bin/activate
pip install -U cekit
pip install odcs
pip install docker
pip install docker_squash
pip install behave
pip install lxml
make

Run

docker run -it -v /path/to/quarkus-app:/project \
    --rm \
    quay.io/quarkus/ubi-quarkus-native-image:$TAG \
    -jar target/my-application-shaded.jar

The path given to the jar parameter is relative to the mounted path (/project volume).

Images

native-image

This image provides GRAALVM and the native-image executable. It is used by the Quarkus Maven plugin and Quarkus Gradle plugin to generate linux 64 executable.

S2I - Source to Image

S2I (Source to Image) are builder images used by OpenShift to build image streams. Two S2I are available:

  • GraalVM Native S2I - build your source code using Maven or Gradle and create a new container image from the produced native executable.
  • Binary S2I - build a new container image from a provided native executable. This executable is generally built on your machine, and uploaded.

Both resulting containers are based on UBI images.

Centos + GraalVM + Maven Image

For more information about this image, please refer to its module README: centos-quarkus-maven

GraalVM versioning model

The GraalVM module version defines the version you ship with the image. For instance, the version 19.2.0 provides GraalVM 19.2.0.

This version is also the version of the image, followed when necessary with java8 or java11.

Updating GraalVM version

To change the version, update its module in the image.yaml or in the overrides.yaml file that uses it, i.e.:

centos-quarkus-native-s2i.yaml

modules:
  install:
  ...
  - name: graalvm
    version: 1.0.0-rc15

Also, edit the images.yaml file to make the version element match the GraalVM version.

The same applies to configure the Maven version.

Building, testing and pushing the images

Before proceed make sure you have CEKit installed, to install on Fedora:

$ sudo dnf install cekit

For other Systems, please refer to the docs.

Build:

Build + squash

$ make
Testing:

This step will build (squashing) and test the images

$ make test
Push the images:

This step will build (squashing), test and push the images to quay.io/quarkus This step requires the write permission for the Quarkus organization on Quay.io.

make push

Continuous Integration and Automation

This repository uses GitHub Actions to build the images. On each PR, the images are built. Check the Actions tab in the GitHub project.

To push the images to Quay, you need to trigger a deployment. Once the images have been built from master successfully, issue the following cURL command:

curl -X POST -H "Authorization: token $GITHUB_TOKEN" \
    -H "Accept: application/vnd.github.ant-man-preview+json"  \
    -H "Content-Type: application/json" \
    https://api.github.com/repos/quarkusio/quarkus-images/deployments \
    --data '{"ref": "master", "environment": "quay"}'

Note that you need a GITHUB_TOKEN (API token) to trigger the deployment.