The English version of quarkus.io is the official project site. Translated sites are community supported on a best-effort basis.
Back to Guides
このページを編集

コンテナーイメージ

Quarkus は、コンテナーイメージをビルド (およびプッシュ) するためのエクステンションを提供しています。現在は以下をサポートしています。

コンテナーイメージのエクステンション

Jib

エクステンション quarkus-container-image-jib は、コンテナーイメージのビルドを実行するために Jib を使用しています。Jib を Quarkus で使用する主な利点は、すべての依存関係 (target/lib の下にあるすべてのもの) が実際のアプリケーションとは別のレイヤーにキャッシュされるため、リビルドが非常に高速かつ小規模に (プッシュする場合) 行えることです。このエクステンションを使用するもう 1 つの重要な利点は、コンテナーイメージレジストリーにプッシュする機能さえあれば、専用のクライアントサイドツール (Docker など) やデーモンプロセス (Docker デーモンなど) を実行しなくてもコンテナーイーメージを作成できることです。

この機能を使用するには、以下のエクステンションをプロジェクトに追加します。

コマンドラインインタフェース
quarkus extension add container-image-jib
Maven
./mvnw quarkus:add-extension -Dextensions='container-image-jib'
Gradle
./gradlew addExtension --extensions='container-image-jib'
必要なことがコンテナーイメージを構築するだけで、レジストリーへのプッシュが不要な場合 (基本的には quarkus.container-image.build=true を設定して quarkus.container-image.push のままにしておくことで、デフォルトは false になります)、このエクステンションはコンテナーイメージを作成し、Docker デーモンに登録します。これは、Docker がイメージのビルドには使われなくても必要であることを意味します。また、このモードを使用すると、 docker images を実行するとコンテナーイメージが表示されます。

追加ファイルの追加

コンテナーイメージに追加のファイル(Quarkus のビルドで作成されたもの以外)を追加する必要がある場合があります。このような場合に対応するため、Quarkus は、 src/main/jib 以下のファイルをすべてビルドされたコンテナーイメージにコピーします (これは、Jib Maven や Gradle プラグインがサポートしているのと基本的に同じ考え方です)。例えば、 src/main/jib/foo/bar が存在すると、 /foo/bar がコンテナファイルシステムに追加されます。

JVM デバッグ

ビルドしたコンテナイメージでは、実行時に条件付きでJavaデバッグを有効にする必要がある場合があります。

ベース・イメージが変更されていない場合（したがって ubi9/openjdk-17-runtime 、または ubi9/openjdk-21-runtime ）、起動時にJVMにデバッグ・ポートをリッスンさせるために、 quarkus.jib.jvm-additional-arguments 設定プロパティを使用できます。

具体的な構成例:

quarkus.jib.jvm-additional-arguments=-agentlib:jdwp=transport=dt_socket\\,server=y\\,suspend=n\\,address=*:5005

他のベースイメージでは、環境変数の設定によりデバッグが可能になる起動スクリプトが提供されている場合があり、その場合はコンテナの起動時に環境変数を設定します。

カスタムエントリーポイント

最後に、 quarkus.jib.jvm-entrypoint 設定プロパティを使用すると、コンテナのエントリポイントを完全にオーバーライドすることができるため、JVMのデバッグ構成をハードコードするか、詳細を処理するスクリプトを指定することができます。

たとえば、コンテナのビルドにベースイメージ ubi9/openjdk-17-runtime または ubi9/openjdk-21-runtime を使用する場合、アプリケーションのプロパティファイルにエントリポイントをハードコードすることができます。

application.properties の例
quarkus.jib.jvm-entrypoint=java,-Dcustom.param=custom_value,-jar,quarkus-run.jar

または、カスタムスタートアップスクリプトを作成し、プロパティファイルで参照することもできます。この方法は、環境変数を使用してアプリケーションのパラメータを設定する必要がある場合に有効です。

application.properties の例
quarkus.jib.jvm-entrypoint=/bin/sh,run-java.sh
例 src/main/jib/home/jboss/run-java.sh
java \
  -Djavax.net.ssl.trustStore=/deployments/truststore \
  -Djavax.net.ssl.trustStorePassword="$TRUST_STORE_PASSWORD" \
  -jar quarkus-run.jar
/home/jboss は、ベースイメージ ubi9/openjdk-17-runtime および ubi9/openjdk-21-runtime 内のすべての quarkus バイナリの WORKDIR です (ubi9/openjdk-17-runtime の Dockerfile、window="_blank")

マルチモジュールプロジェクトとレイヤリング

Quarkusアプリケーションを1つのモジュールとし、さらにさまざまなサポートプロジェクトの依存関係を他のモジュールとして含むマルチモジュールプロジェクトを構築する場合、Quarkusでは、サポートモジュールが通常のアプリケーション依存関係よりも頻繁に変更されることを想定して、それらのサポートモジュールを他のアプリケーション依存関係とは別のコンテナイメージレイヤーに配置することをサポートしています。このため、アプリケーションの依存関係に変更がない場合は、リビルドを高速に行うことができます。

この機能を有効にするには、ビルドツール起動時にシステムプロパティとして、またはビルドツールプロパティとして、プロパティ quarkus.bootstrap.workspace-discovery を true に設定する必要があります。このプロパティは、ビルドプロセスの非常に早い段階で認識される必要があるため、 application.properties で設定しても正しく 機能しません 。

AppCDS

Quarkusは、Jibを使用したコンテナイメージの生成時に、 アプリケーションクラスデータ共有 アーカイブを生成して含めることをサポートしています。詳細については、 AppCDSのドキュメント を参照してください。

Docker

エクステンション quarkus-container-image-docker は、Docker ビルドを実行するために src/main/docker 下で Docker バイナリーと生成された Dockerfiles を使用しています。

この機能を使用するには、以下のエクステンションをプロジェクトに追加します。

コマンドラインインタフェース
quarkus extension add container-image-docker
Maven
./mvnw quarkus:add-extension -Dextensions='container-image-docker'
Gradle
./gradlew addExtension --extensions='container-image-docker'

quarkus-container-image-docker エクスンテンションは、docker buildx build を使って、 マルチプラットフォーム (またはマルチアーキ) イメージを作成することができます。以下の Dockerオプション のセクションにある quarkus.docker.buildx.* の設定項目を参照してください。

docker buildx build は、単一のプラットフォーム向けにビルドする場合のみ、ビルド結果の docker images への読み込み をサポートします。したがって、 quarkus.docker.buildx.platform プロパティに複数の引数を指定した場合、結果のイメージは docker images にロードされません。 quarkus.docker.buildx.platform が省略された場合、または単一のプラットフォームのみが指定された場合は、その後 docker images にロードされるようになります。

つまり、一度に複数のプラットフォーム用のイメージをビルドしたい場合（例： quarkus.docker.buildx.platform=linux/amd64,linux/arm64 ）、ビルドプロセスの一部としてイメージ（ quarkus.container-image.push=true ）を直接プッシュする必要があります。Docker buildxはマルチプラットフォームイメージのビルド時にローカルレジストリへのロードをサポートしていません。

Podman

エクステンション quarkus-container-image-podman は、コンテナビルドを実行するために Podman と src/main/docker の下に生成された Dockerfiles を使用します。

この機能を使用するには、以下のエクステンションをプロジェクトに追加します。

コマンドラインインタフェース
quarkus extension add container-image-podman
Maven
./mvnw quarkus:add-extension -Dextensions='container-image-podman'
Gradle
./gradlew addExtension --extensions='container-image-podman'
DockerとPodmanエクステンションの使い分け

Podmanは Docker互換のAPI を公開しているため、 Docker拡張 機能はPodmanと常に下位互換性があります。Dockerエクステンションを使用して、Podmanでコンテナイメージを構築できます（ QuarkusでPodmanを使用するガイド を参照してください）。

DockerとPodmanのどちらかに特化した処理を行う場合は、それぞれ quarkus-container-image-docker または quarkus-container-image-podman エクステンションを使用してください。

例えば、マルチプラットフォームイメージのビルドはDockerとPodmanで実装が異なります。Dockerは buildxプラグイン を使用しますが、Podmanはマルチプラットフォームイメージを ネイティブ にビルドできます。このため、その機能を実行するには特定のエクステンションを使用する必要があります。

OpenShift

エクステンション quarkus-container-image-openshift は、OpenShift クラスタ内でコンテナのビルドを実行するために OpenShift バイナリビルドを使用しています。バイナリビルドの背景にある考え方は、アーティファクトとその依存関係をクラスタにアップロードするだけで、ビルド中にそれらがビルダーイメージ（デフォルトは fabric8/s2i-java ）にマージされるというものです。

このアプローチの利点は、クラスターへの変更を簡単にロールアウトできる OpenShift の DeploymentConfig と組み合わせることができることです。

この機能を使用するには、以下のエクステンションをプロジェクトに追加します。

コマンドラインインタフェース
quarkus extension add container-image-openshift
Maven
./mvnw quarkus:add-extension -Dextensions='container-image-openshift'
Gradle
./gradlew addExtension --extensions='container-image-openshift'

OpenShiftのビルドでは、 BuildConfig 、ビルダーイメージ用と出力イメージ用の2つの ImageStream リソースを作成する必要があります。このようなオブジェクトの作成は、Quarkus Kubernetesエクステンションによって行われます。

Buildpack

quarkus-container-image-buildpack は、コンテナイメージのビルドを行うために buildpacks を使用しています。buildpacksは、実際のビルドにDockerデーモンを使用します。buildpacksはDockerの代替品をサポートしていますが、このエクステンションはDockerでのみ動作します。

さらに、ユーザーはどのビルドイメージを使用するかを設定する必要があります（デフォルトのイメージは提供されていません）。例えば、以下のようになります。

quarkus.buildpack.jvm-builder-image=<jvm builder image>

またはネイティブの場合、

quarkus.buildpack.native-builder-image=<native builder image>

この機能を使用するには、以下のエクステンションをプロジェクトに追加します。

コマンドラインインタフェース
quarkus extension add container-image-buildpack
Maven
./mvnw quarkus:add-extension -Dextensions='container-image-buildpack'
Gradle
./gradlew addExtension --extensions='container-image-buildpack'
buildpack コンテナイメージエクステンションを使用する際には、プロパティ設定に quarkus.container-image.build=true を追加しないことを強くお勧めします。代わりにビルドコマンドのオプションとして渡すことをお勧めします。

ビルド

プロジェクト用のコンテナーイメージを作成するには、Quarkus がサポートしている方法のいずれかで、 quarkus.container-image.build=true を設定する必要があります。

コマンドラインインタフェース
quarkus build quarkus deploy openshift
Maven
./mvnw install -Dquarkus.container-image.build=true
Gradle
./gradlew build -Dquarkus.container-image.build=true
ネイティブコンテナイメージをビルドしたいときに、すでに既存のネイティブイメージがある場合は、 -Dquarkus.native.reuse-existing=true を設定すれば、ネイティブイメージのビルドは再実行されません。

@QuarkusIntegrationTest の利用

作成されたイメージでテストを実行するためには、Quarkus がサポートしている方法のいずれかで、 quarkus.container-image.build=true を設定する必要があります。

Maven
./mvnw verify -Dquarkus.container-image.build=true
Gradle
./gradlew quarkusIntTest -Dquarkus.container-image.build=true

プッシュ

プロジェクトにコンテナーイメージをプッシュするには、Quarkus がサポートしている方法のいずれかで、 quarkus.container-image.push=true を設定する必要があります。

コマンドラインインタフェース
quarkus build quarkus deploy openshift
Maven
./mvnw install -Dquarkus.container-image.push=true
Gradle
./gradlew build -Dquarkus.container-image.push=true
レジストリーが設定されていない場合 (quarkus.container-image.registry を使用) は、 docker.io がデフォルトとして使用されます。

複数のエクステンションから選択する

複数のエクステンションを同じビルドの一部として使用することは意味がありません。複数のコンテナイメージエクステンションが存在する場合は、エラーが発生してユーザーに通知されます。ユーザーは、不要なエクステンションを削除するか、 application.properties を使用してエクステンションを選択することができます。

例えば、 container-image-docker と container-image-podman の両方が存在し、ユーザーが container-image-docker を使用する必要がある場合：

quarkus.container-image.builder=docker

systemd-notify との統合

PodmanとSystemdを使用してQuarkusアプリケーションをLinuxサービスとしてデプロイするためにコンテナイメージをビルドする場合、 Quarkus Systemd Notify Extension をアプリケーションの一部として含めることを検討するとよいでしょう：

コマンドラインインタフェース
quarkus extension add io.quarkiverse.systemd.notify:quarkus-systemd-notify
Maven
./mvnw quarkus:add-extension -Dextensions='io.quarkiverse.systemd.notify:quarkus-systemd-notify'
Gradle
./gradlew addExtension --extensions='io.quarkiverse.systemd.notify:quarkus-systemd-notify'

カスタマイズ

以下のプロパティーを使用して、コンテナーイメージのビルドプロセスをカスタマイズすることができます。

コンテナーイメージオプション

ビルド時に固定される設定プロパティ - 他のすべての設定プロパティは実行時にオーバーライド可能

Configuration property

型

デフォルト

quarkus.container-image.group

The group the container image will be part of

Environment variable: QUARKUS_CONTAINER_IMAGE_GROUP

Show more

string

quarkus.container-image.name

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

Environment variable: QUARKUS_CONTAINER_IMAGE_NAME

Show more

string

${quarkus.application.name:unset}

quarkus.container-image.tag

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

Environment variable: QUARKUS_CONTAINER_IMAGE_TAG

Show more

string

${quarkus.application.version:latest}

quarkus.container-image.additional-tags

Additional tags of the container image.

Environment variable: QUARKUS_CONTAINER_IMAGE_ADDITIONAL_TAGS

Show more

list of string

quarkus.container-image.labels."label-name"

Custom labels to add to the generated image.

Environment variable: QUARKUS_CONTAINER_IMAGE_LABELS__LABEL_NAME_

Show more

Map<String,String>

quarkus.container-image.registry

The container registry to use

Environment variable: QUARKUS_CONTAINER_IMAGE_REGISTRY

Show more

string

quarkus.container-image.image

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

Environment variable: QUARKUS_CONTAINER_IMAGE_IMAGE

Show more

string

quarkus.container-image.username

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

Environment variable: QUARKUS_CONTAINER_IMAGE_USERNAME

Show more

string

quarkus.container-image.password

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

Environment variable: QUARKUS_CONTAINER_IMAGE_PASSWORD

Show more

string

quarkus.container-image.insecure

Whether or not insecure registries are allowed

Environment variable: QUARKUS_CONTAINER_IMAGE_INSECURE

Show more

boolean

false

quarkus.container-image.build

Whether or not a image build will be performed.

Environment variable: QUARKUS_CONTAINER_IMAGE_BUILD

Show more

boolean

quarkus.container-image.push

Whether or not an image push will be performed.

Environment variable: QUARKUS_CONTAINER_IMAGE_PUSH

Show more

boolean

quarkus.container-image.builder

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

Environment variable: QUARKUS_CONTAINER_IMAGE_BUILDER

Show more

string

CI 環境の利用

さまざまな CI 環境では、Quarkus アプリケーションを作成してレジストリーをプッシュするために、コンテナーイメージ Quarkus エクステンションと組み合わせることで、すぐに使えるコンテナーイメージレジストリ-を利用できます。

例えば、 GitLab はこのようなレジストリーを提供しており、提供されている CI 環境では、環境変数 CI_REGISTRY_IMAGE (詳しくは GitLab の ドキュメント を参照) を利用できるようになっています。なお、Quarkus ではこのように利用できます。

quarkus.container-image.image=${CI_REGISTRY_IMAGE}
プロパティと環境変数を組み合わせる方法については、 こちらをご覧ください。

Jib オプション

一般的なコンテナーイメージのオプションに加えて、 container-image-jib では以下のオプションも用意されています。

ビルド時に固定される設定プロパティ - 他のすべての設定プロパティは、実行時にオーバーライド可能

Configuration property

型

デフォルト

quarkus.jib.base-jvm-image

The base image to be used when a container image is being produced for the jar build. When the application is built against Java 21 or higher, registry.access.redhat.com/ubi9/openjdk-21-runtime:1.21 is used as the default. Otherwise registry.access.redhat.com/ubi9/openjdk-17-runtime:1.21 is used as the default.

Environment variable: QUARKUS_JIB_BASE_JVM_IMAGE

Show more

string

quarkus.jib.base-native-image

The base image to be used when a container image is being produced for the native binary build. The default is "quay.io/quarkus/ubi9-quarkus-micro-image:2.0". You can also use "registry.access.redhat.com/ubi9/ubi-minimal" which is a bigger base image, but provide more built-in utilities such as the microdnf package manager.

Environment variable: QUARKUS_JIB_BASE_NATIVE_IMAGE

Show more

string

quay.io/quarkus/ubi9-quarkus-micro-image:2.0

quarkus.jib.jvm-arguments

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

Environment variable: QUARKUS_JIB_JVM_ARGUMENTS

Show more

list of string

-Djava.util.logging.manager=org.jboss.logmanager.LogManager

quarkus.jib.jvm-additional-arguments

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

Environment variable: QUARKUS_JIB_JVM_ADDITIONAL_ARGUMENTS

Show more

list of string

quarkus.jib.native-arguments

Additional arguments to pass when starting the native application

Environment variable: QUARKUS_JIB_NATIVE_ARGUMENTS

Show more

list of string

quarkus.jib.jvm-entrypoint

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

  • Entrypoint "INHERIT" means to inherit entrypoint from base image, jvmArguments field is used for arguments

  • A valid entrypoint is jar package specific (see quarkus.package.jar.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 unless entrypoint is "INHERIT"

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

Environment variable: QUARKUS_JIB_JVM_ENTRYPOINT

Show more

list of string

quarkus.jib.native-entrypoint

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

  • Entrypoint "INHERIT" means to inherit entrypoint from base image, nativeArguments field is used for arguments

  • 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 unless entrypoint is "INHERIT"

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

Environment variable: QUARKUS_JIB_NATIVE_ENTRYPOINT

Show more

list of string

quarkus.jib.environment-variables."environment-variable-name"

Environment variables to add to the container image

Environment variable: QUARKUS_JIB_ENVIRONMENT_VARIABLES__ENVIRONMENT_VARIABLE_NAME_

Show more

Map<String,String>

quarkus.jib.base-registry-username

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

Environment variable: QUARKUS_JIB_BASE_REGISTRY_USERNAME

Show more

string

quarkus.jib.base-registry-password

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

Environment variable: QUARKUS_JIB_BASE_REGISTRY_PASSWORD

Show more

string

quarkus.jib.ports

The ports to expose

Environment variable: QUARKUS_JIB_PORTS

Show more

list of int

${quarkus.http.port:8080}

quarkus.jib.user

The user to use in generated image

Environment variable: QUARKUS_JIB_USER

Show more

string

quarkus.jib.working-directory

The working directory to use in the generated image. The default value is chosen to work in accordance with the default base image.

Environment variable: QUARKUS_JIB_WORKING_DIRECTORY

Show more

string

/home/jboss

quarkus.jib.always-cache-base-image

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.

Environment variable: QUARKUS_JIB_ALWAYS_CACHE_BASE_IMAGE

Show more

boolean

false

quarkus.jib.platforms

List of target platforms. Each platform is defined using the pattern:

<os>|<arch>[/variant]|<os>/<arch>[/variant]

for example:

linux/amd64,linux/arm64/v8

If not specified, OS default is linux and architecture default is amd64. If more than one platform is configured, it is important to note that the base image has to be a Docker manifest or an OCI image index containing a version of each chosen platform. The feature does not work with native images, as cross-compilation is not supported. This configuration is based on an incubating feature of Jib. See Jib FAQ for more information.

Environment variable: QUARKUS_JIB_PLATFORMS

Show more

list of string

quarkus.jib.image-digest-file

The path of a file in which the digest of the generated image will be written. If the path is relative, the base path is the output directory of the build tool.

Environment variable: QUARKUS_JIB_IMAGE_DIGEST_FILE

Show more

string

jib-image.digest

quarkus.jib.image-id-file

The path of a file in which the id of the generated image will be written. If the path is relative, the base path is the output directory of the build tool.

Environment variable: QUARKUS_JIB_IMAGE_ID_FILE

Show more

string

jib-image.id

quarkus.jib.offline-mode

Whether, or not to operate offline.

Environment variable: QUARKUS_JIB_OFFLINE_MODE

Show more

boolean

false

quarkus.jib.docker-executable-name

Name of binary used to execute the docker commands. This is only used by Jib when the container image is being built locally.

Environment variable: QUARKUS_JIB_DOCKER_EXECUTABLE_NAME

Show more

string

quarkus.jib.docker-environment."environment-variable-name"

Sets environment variables used by the Docker executable. This is only used by Jib when the container image is being built locally.

Environment variable: QUARKUS_JIB_DOCKER_ENVIRONMENT__ENVIRONMENT_VARIABLE_NAME_

Show more

Map<String,String>

quarkus.jib.use-current-timestamp

Whether to set the creation time to the actual build time. Otherwise, the creation time will be set to the Unix epoch (00:00:00, January 1st, 1970 in UTC). See Jib FAQ for more information

Environment variable: QUARKUS_JIB_USE_CURRENT_TIMESTAMP

Show more

boolean

true

quarkus.jib.use-current-timestamp-file-modification

Whether to set the modification time (last modified time) of the files put by Jib in the image to the actual build time. Otherwise, the modification time will be set to the Unix epoch (00:00:00, January 1st, 1970 in UTC). If the modification time is constant (flag is set to false so Unix epoch is used) across two consecutive builds, the docker layer sha256 digest will be different only if the actual files added by Jib to the docker layer were changed. More exactly, having 2 consecutive builds will generate different docker layers only if the actual content of the files within the docker layer was changed. If the current timestamp is used the sha256 digest of the docker layer will always be different even if the content of the files didn’t change.

Environment variable: QUARKUS_JIB_USE_CURRENT_TIMESTAMP_FILE_MODIFICATION

Show more

boolean

true

quarkus.jib.base-image-layers-cache

The directory to use for caching base image layers. If not specified, the Jib default directory is used.

Environment variable: QUARKUS_JIB_BASE_IMAGE_LAYERS_CACHE

Show more

string

quarkus.jib.application-layers-cache

The directory to use for caching application layers. If not specified, the Jib default directory is used.

Environment variable: QUARKUS_JIB_APPLICATION_LAYERS_CACHE

Show more

string

Docker オプション

一般的なコンテナーイメージのオプションに加えて、 container-image-docker では以下のオプションも用意されています。

ビルド時に固定される設定プロパティ - 他のすべての設定プロパティは、実行時にオーバーライド可能

Configuration property

型

デフォルト

quarkus.docker.dockerfile-jvm-path

Path to the JVM Dockerfile. If set to an absolute path then the absolute path will be used, otherwise the path will be considered relative to the project root. If not set src/main/docker/Dockerfile.jvm will be used.

Environment variable: QUARKUS_DOCKER_DOCKERFILE_JVM_PATH

Show more

string

src/main/docker/Dockerfile.jvm

quarkus.docker.dockerfile-native-path

Path to the native Dockerfile. If set to an absolute path then the absolute path will be used, otherwise the path will be considered relative to the project root. If not set src/main/docker/Dockerfile.native will be used.

Environment variable: QUARKUS_DOCKER_DOCKERFILE_NATIVE_PATH

Show more

string

src/main/docker/Dockerfile.native

quarkus.docker.build-args."arg-name"

Build args passed to docker via --build-arg

Environment variable: QUARKUS_DOCKER_BUILD_ARGS__ARG_NAME_

Show more

Map<String,String>

quarkus.docker.cache-from

Images to consider as cache sources. Values are passed to docker build/podman build via the cache-from option

Environment variable: QUARKUS_DOCKER_CACHE_FROM

Show more

list of string

quarkus.docker.network

The networking mode for the RUN instructions during build

Environment variable: QUARKUS_DOCKER_NETWORK

Show more

string

quarkus.docker.executable-name

Name of binary used to execute the docker/podman commands. This setting can override the global container runtime detection.

Environment variable: QUARKUS_DOCKER_EXECUTABLE_NAME

Show more

string

quarkus.docker.additional-args

Additional arbitrary arguments passed to the executable when building the container image.

Environment variable: QUARKUS_DOCKER_ADDITIONAL_ARGS

Show more

list of string

Configuration for Docker Buildx options

型

デフォルト

quarkus.docker.buildx.platform

Which platform(s) to target during the build. See https://docs.docker.com/engine/reference/commandline/buildx_build/#platform

Environment variable: QUARKUS_DOCKER_BUILDX_PLATFORM

Show more

list of string

quarkus.docker.buildx.output

Sets the export action for the build result. See https://docs.docker.com/engine/reference/commandline/buildx_build/#output. Note that any filesystem paths need to be absolute paths, not relative from where the command is executed from.

Environment variable: QUARKUS_DOCKER_BUILDX_OUTPUT

Show more

string

quarkus.docker.buildx.progress

Set type of progress output (auto, plain, tty). Use plain to show container output (default “auto”). See https://docs.docker.com/engine/reference/commandline/buildx_build/#progress

Environment variable: QUARKUS_DOCKER_BUILDX_PROGRESS

Show more

string

Podman オプション

一般的なコンテナ・イメージ・オプションに加えて、 container-image-podman には以下のオプションもあります：

ビルド時に固定される設定プロパティ - 他のすべての設定プロパティは、実行時にオーバーライド可能

Configuration property

タイプ

デフォルト

quarkus.podman.dockerfile-jvm-path

Path to the JVM Dockerfile. If set to an absolute path then the absolute path will be used, otherwise the path will be considered relative to the project root. If not set src/main/docker/Dockerfile.jvm will be used.

Environment variable: QUARKUS_PODMAN_DOCKERFILE_JVM_PATH

Show more

string

src/main/docker/Dockerfile.jvm

quarkus.podman.dockerfile-native-path

Path to the native Dockerfile. If set to an absolute path then the absolute path will be used, otherwise the path will be considered relative to the project root. If not set src/main/docker/Dockerfile.native will be used.

Environment variable: QUARKUS_PODMAN_DOCKERFILE_NATIVE_PATH

Show more

string

src/main/docker/Dockerfile.native

quarkus.podman.build-args."arg-name"

Build args passed to docker via --build-arg

Environment variable: QUARKUS_PODMAN_BUILD_ARGS__ARG_NAME_

Show more

Map<String,String>

quarkus.podman.cache-from

Images to consider as cache sources. Values are passed to docker build/podman build via the cache-from option

Environment variable: QUARKUS_PODMAN_CACHE_FROM

Show more

list of string

quarkus.podman.network

The networking mode for the RUN instructions during build

Environment variable: QUARKUS_PODMAN_NETWORK

Show more

string

quarkus.podman.executable-name

Name of binary used to execute the docker/podman commands. This setting can override the global container runtime detection.

Environment variable: QUARKUS_PODMAN_EXECUTABLE_NAME

Show more

string

quarkus.podman.additional-args

Additional arbitrary arguments passed to the executable when building the container image.

Environment variable: QUARKUS_PODMAN_ADDITIONAL_ARGS

Show more

list of string

quarkus.podman.platform

Which platform(s) to target during the build. See https://docs.podman.io/en/latest/markdown/podman-build.1.html#platform-os-arch-variant

Environment variable: QUARKUS_PODMAN_PLATFORM

Show more

list of string

quarkus.podman.tls-verify

Require HTTPS and verify certificates when contacting registries

Environment variable: QUARKUS_PODMAN_TLS_VERIFY

Show more

boolean

true

OpenShift オプション

一般的なコンテナ・イメージ・オプションに加えて、 container-image-openshift は以下のオプションも用意されています。

ビルド時に固定される設定プロパティ - 他のすべての設定プロパティは、実行時にオーバーライド可能

Configuration property

タイプ

デフォルト

quarkus.openshift.build-strategy

The build config strategy to use.

Environment variable: QUARKUS_OPENSHIFT_BUILD_STRATEGY

Show more

binary, docker

binary

quarkus.openshift.base-jvm-image

The base image to be used when a container image is being produced for the jar build. The value of this property is used to create an ImageStream for the builder image used in the Openshift build. When it references images already available in the internal Openshift registry, the corresponding streams are used instead. When the application is built against Java 21 or higher, registry.access.redhat.com/ubi9/openjdk-21:1.21 is used as the default. Otherwise registry.access.redhat.com/ubi9/openjdk-17:1.21 is used as the default.

Environment variable: QUARKUS_OPENSHIFT_BASE_JVM_IMAGE

Show more

string

quarkus.openshift.base-native-image

The base image to be used when a container image is being produced for the native binary build. The value of this property is used to create an ImageStream for the builder image used in the Openshift build. When it references images already available in the internal Openshift registry, the corresponding streams are used instead.

Environment variable: QUARKUS_OPENSHIFT_BASE_NATIVE_IMAGE

Show more

string

quay.io/quarkus/ubi9-quarkus-native-binary-s2i:2.0

quarkus.openshift.jvm-dockerfile

The default Dockerfile to use for jvm builds

Environment variable: QUARKUS_OPENSHIFT_JVM_DOCKERFILE

Show more

string

src/main/docker/Dockerfile.jvm

quarkus.openshift.native-dockerfile

The default Dockerfile to use for native builds

Environment variable: QUARKUS_OPENSHIFT_NATIVE_DOCKERFILE

Show more

string

src/main/docker/Dockerfile.native

quarkus.openshift.jvm-arguments

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

Environment variable: QUARKUS_OPENSHIFT_JVM_ARGUMENTS

Show more

list of string

quarkus.openshift.native-arguments

Additional arguments to pass when starting the native application

Environment variable: QUARKUS_OPENSHIFT_NATIVE_ARGUMENTS

Show more

list of string

quarkus.openshift.jar-directory

The directory where the jar is added during the assemble phase. This is dependent on the S2I image and should be supplied if a non default image is used.

Environment variable: QUARKUS_OPENSHIFT_JAR_DIRECTORY

Show more

string

quarkus.openshift.jar-file-name

The resulting filename of the jar in the S2I image. This option may be used if the selected S2I image uses a fixed name for the jar.

Environment variable: QUARKUS_OPENSHIFT_JAR_FILE_NAME

Show more

string

quarkus.openshift.native-binary-directory

The directory where the native binary is added during the assemble phase. This is dependent on the S2I image and should be supplied if a non-default image is used.

Environment variable: QUARKUS_OPENSHIFT_NATIVE_BINARY_DIRECTORY

Show more

string

quarkus.openshift.native-binary-file-name

The resulting filename of the native binary in the S2I image. This option may be used if the selected S2I image uses a fixed name for the native binary.

Environment variable: QUARKUS_OPENSHIFT_NATIVE_BINARY_FILE_NAME

Show more

string

quarkus.openshift.build-timeout

The build timeout.

Environment variable: QUARKUS_OPENSHIFT_BUILD_TIMEOUT

Show more

Duration 

PT5M

quarkus.openshift.build-log-level

The log level of OpenShift build log.

Environment variable: QUARKUS_OPENSHIFT_BUILD_LOG_LEVEL

Show more

fatal, error, warn, info, debug, trace

info

quarkus.openshift.image-push-secret

The image push secret to use for pushing to external registries. (see: https://cloud.redhat.com/blog/pushing-application-images-to-an-external-registry)

Environment variable: QUARKUS_OPENSHIFT_IMAGE_PUSH_SECRET

Show more

string
期間フォーマットについて

期間の値を書くには、標準の java.time.Duration フォーマットを使います。 詳細は Duration#parse() Java API documentation を参照してください。

数字で始まる簡略化した書式を使うこともできます:

  • 数値のみの場合は、秒単位の時間を表します。

  • 数値の後に ms が続く場合は、ミリ秒単位の時間を表します。

その他の場合は、簡略化されたフォーマットが解析のために java.time.Duration フォーマットに変換されます：

  • 数値の後に h 、 m 、 s が続く場合は、その前に PT が付けられます。

  • 数値の後に d が続く場合は、その前に P が付けられます。

Buildpack Options

In addition to the generic container image options, the container-image-buildpack also provides the following options:

ビルド時に固定される設定プロパティ - 他のすべての設定プロパティは、実行時にオーバーライド可能

Configuration property

タイプ

デフォルト

quarkus.buildpack.jvm-builder-image

The buildpacks builder image to use when building the project in jvm mode.

Environment variable: QUARKUS_BUILDPACK_JVM_BUILDER_IMAGE

Show more

string

paketocommunity/builder-ubi-base:latest

quarkus.buildpack.native-builder-image

The buildpacks builder image to use when building the project in native mode.

Environment variable: QUARKUS_BUILDPACK_NATIVE_BUILDER_IMAGE

Show more

string

quarkus.buildpack.lifecycle-image

The lifecycle image to use when building the project This is optional, but can be used to override the lifecycle present within a builder image.

Environment variable: QUARKUS_BUILDPACK_LIFECYCLE_IMAGE

Show more

string

quarkus.buildpack.platform-level

The platform level to force for the build. Normally the platform level is determined from the intersection of the builder image supported levels, and the platform implementation supported levels. Sometimes it can be beneficial to force the platform to a particular version to force behavior during the build.

Environment variable: QUARKUS_BUILDPACK_PLATFORM_LEVEL

Show more

string

quarkus.buildpack.trust-builder-image

Should the builder image be 'trusted' ? Trusted builders are allowed to attempt to use the creator lifecycle, which runs all the build phases within a single container. This is only possible for builders that do not use extensions. Running all phases in one container exposes some phases to information they may not see normally with a container-per-phase.

Environment variable: QUARKUS_BUILDPACK_TRUST_BUILDER_IMAGE

Show more

boolean

quarkus.buildpack.builder-env."environment-variable-name"

Environment key/values to pass to buildpacks.

Environment variable: QUARKUS_BUILDPACK_BUILDER_ENV__ENVIRONMENT_VARIABLE_NAME_

Show more

Map<String,String>

quarkus.buildpack.registry-user."registry-host"

Usernames to use with registry hosts

Environment variable: QUARKUS_BUILDPACK_REGISTRY_USER__REGISTRY_HOST_

Show more

Map<String,String>

quarkus.buildpack.registry-password."registry-host"

Passwords to use with registry hosts

Environment variable: QUARKUS_BUILDPACK_REGISTRY_PASSWORD__REGISTRY_HOST_

Show more

Map<String,String>

quarkus.buildpack.registry-token."registry-host"

Tokens to use with registry hosts

Environment variable: QUARKUS_BUILDPACK_REGISTRY_TOKEN__REGISTRY_HOST_

Show more

Map<String,String>

quarkus.buildpack.run-image

The buildpacks run image to use when building the project When not supplied, the run image is determined by the builder image. If extensions are used by the builder image, they may override the run image.

Environment variable: QUARKUS_BUILDPACK_RUN_IMAGE

Show more

string

quarkus.buildpack.pull-timeout-seconds

Initial pull timeout for builder/run images, in seconds

Environment variable: QUARKUS_BUILDPACK_PULL_TIMEOUT_SECONDS

Show more

int

300

quarkus.buildpack.pull-timeout-increase-seconds

Increase pull timeout for builder/run images after failure, in seconds

Environment variable: QUARKUS_BUILDPACK_PULL_TIMEOUT_INCREASE_SECONDS

Show more

int

15

quarkus.buildpack.pull-retry-count

How many times to retry an image pull after a failure

Environment variable: QUARKUS_BUILDPACK_PULL_RETRY_COUNT

Show more

int

3

quarkus.buildpack.docker-host

DOCKER_HOST value to use. This value is normally auto-determined, and is available for override if needed. If not set, the env var DOCKER_HOST is used, if that is not set the platform will test if podman is available on the path, if so, it will use podman to configure the appropriate values. If podman is not on the path, docker is assumed, and per-platform defaults for docker are used.

Environment variable: QUARKUS_BUILDPACK_DOCKER_HOST

Show more

string

quarkus.buildpack.docker-socket

Path to the Docker socket to use. This value is normally auto-determined, and is available for override if needed. The path to the socket can vary, especially when the docker/podman daemon is running inside a VM, if useDaemon mode is true, then this path must refer to the path that can be used to mount the socket inside a container, so may refer to the path to the socket in the VM rather than the host.

Environment variable: QUARKUS_BUILDPACK_DOCKER_SOCKET

Show more

string

quarkus.buildpack.use-daemon

use Daemon mode? Should the buildpack build have the docker socket mounted into the build container(s). If this is false, then the image will be built directly as layers in a remote registry, this will probably require registry credentials to be passed. Defaults to 'true'

Environment variable: QUARKUS_BUILDPACK_USE_DAEMON

Show more

boolean

true

quarkus.buildpack.docker-network

Use specified docker network during build This can be handy when building against a locally hosted docker registry, where you will require the build containers to be part of the 'host' network to enable them to access the local registry.

Environment variable: QUARKUS_BUILDPACK_DOCKER_NETWORK

Show more

string

quarkus.buildpack.log-level

Log level to use. The log level to use when executing the build phases in containers. Defaults to 'info', supported values are 'info', 'warn' and 'debug'

Environment variable: QUARKUS_BUILDPACK_LOG_LEVEL

Show more

string

info

quarkus.buildpack.get-use-timestamps

Should the container log information include timestamps?

Environment variable: QUARKUS_BUILDPACK_GET_USE_TIMESTAMPS

Show more

boolean

true

関連コンテンツ

同じトピックについて

Quarkusはオープンです。このプロジェクトのすべての依存関係は、Apache Software License 2.0 または互換性のあるライセンスのもとで利用可能です。

このウェブサイトはJekyll で構築され、GitHub Pages にホストされ、完全にオープンソースです。改善したい場合は、ウェブサイトをフォークし、修正してみせてください。

ナビゲーション
フォローする
ヘルプ
言語
Quarkusはコミュニティプロジェクトで構成されています
CC by 3.0 | Privacy Policy Sponsored by