QuarkusアプリケーションのOpenShiftへのデプロイ
OpenShiftは、コンテナ化されたアプリケーションを開発および実行するためのKubernetesベースのプラットフォームです。 Quarkusは、正常なデフォルトとユーザーが提供する設定に基づいてOpenShiftリソースを自動的に生成する機能を提供します。
アプリケーション開発者として、Quarkus アプリケーションを OpenShift にデプロイすることができます。
この機能は quarkus-openshift
エクステンションによって提供され、複数のデプロイオプションをサポートしています:
1. OpenShift ビルドストラテジーの概要
- Docker build
-
このストラテジーはOpenShiftクラスタの外、ローカルまたはCI環境で成果物をビルドし、Dockerfileと共にOpenShiftビルドシステムに提供します。 成果物にはJARファイルやネイティブ実行ファイルが含まれます。コンテナはOpenShiftクラスタ内でビルドされ、イメージストリームとして提供されます。
OpenShift を使用します。Dockerビルドストラテジーは、JVM向けのQuarkusアプリケーションやネイティブ実行ファイルにコンパイルされたQuarkusアプリケーションをサポートするため、推奨されるビルドストラテジーです。
ただし、以前のQuarkusバージョンとの互換性を保つため、デフォルトのビルドストラテジーはS2Iです。OpenShift を選択するにはDockerビルドストラテジーを選択するには、 |
- Source to Image (S2I)
-
ビルドプロセスはOpenShiftクラスタ内で実行されます。 QuarkusはS2Iを使用してQuarkusをJVMアプリケーションとしてデプロイすることを完全にサポートしています。
- Binary S2I
-
このストラテジーでは、S2Iビルドプロセスの入力としてJARファイルを使用し、アプリケーションのビルドとデプロイをスピードアップします。
2. プロジェクトのブートストラップ
まず、OpenShift エクステンションを含む新しいプロジェクトが必要です。そして、アプリケーションをビルドしてデプロイする前に、OpenShift クラスタにログインする必要があります。
2.1. OpenShiftエクステンションの追加
アプリケーションを OpenShift クラスタ内で動作するコンテナイメージとしてビルドしてデプロイするには、 Quarkus OpenShift extension quarkus-openshift
を依存関係としてプロジェクトに追加する必要があります。
このエクステンションは、イメージストリーム、ビルド設定、デプロイメント、サービス定義などの OpenShift リソースも生成します。アプリケーションに quarkus-smallrye-health
エクステンションが含まれている場合、OpenShift は health エンドポイントにアクセスし、アプリケーションのstartup、liveness、readinessを確認できます。
Quarkus 3.8以降、OpenShiftで非推奨となっている |
-
Quarkus Mavenプロジェクトがあること
-
quarkus-openshift
エクステンションをプロジェクトに追加するには、以下のいずれかの方法を使用します:-
pom.xml
ファイルを設定します:pom.xml<dependency> <groupId>io.quarkus</groupId> <artifactId>quarkus-openshift</artifactId> </dependency>
-
OpenShift CLIで以下のコマンドを入力します:
./mvnw quarkus:add-extension -Dextensions="io.quarkus:quarkus-openshift"
-
Quarkus CLIで以下のコマンドを入力します:
quarkus extension add 'quarkus-openshift'
-
3. OpenShiftクラスタへのログイン
OpenShift CLI を使用してOpenShiftクラスタにログインできます:
oc login -u myUsername (1)
1 | サーバーのURLやパスワードなど、必要な情報の入力を求められます。 |
または、APIトークンを使用してログインすることもできます:
oc login --token=myToken --server=myServerUrl
トークンは、OpenShift ウェブコンソールの Copy Login Command リンクを使用して要求できます。 |
最後に、OpenShift CLIを使用する必要は全くありません。代わりに、 quarkus.kubernetes-client.api-server-url
configプロパティを設定し、 quarkus.kubernetes-client.token
、または quarkus.kubernetes-client.username
、 quarkus.kubernetes-client.password
でそれぞれ認証します:
quarkus build quarkus deploy openshift
./mvnw install -Dquarkus.kubernetes-client.api-server-url=myServerUrl -Dquarkus.kubernetes-client.token=myToken
./gradlew build -Dquarkus.kubernetes-client.api-server-url=myServerUrl -Dquarkus.kubernetes-client.token=myToken
3.1. 必要な OpenShift プロジェクトへの切替
OpenShift を使用することができます。CLI を使用してアプリケーションを作成し、OpenShift プロジェクトを管理します。 この情報を使って OpenShift プロジェクトを作成したり、既存のプロジェクトに切り替えることができます。
-
OpenShift クラスタにアクセスでき、
oc
ツールの最新の互換バージョンがインストールされています。
-
oc
ツールにログインします:oc login
-
現在のプロジェクト・スペースを表示するには、以下のコマンドを入力します:
oc project -q
-
以下のいずれかの手順で、必要な OpenShift プロジェクトに移動します:
-
プロジェクトがすでに存在する場合は、そのプロジェクトに切り替えます:
oc project <project_name>
-
プロジェクトが存在しない場合は、新規プロジェクトを作成します:
oc new-project <project_name>
-
4. ビルドとデプロイ
以下のデプロイオプションのいずれかを使用して、ビルドとデプロイを行うことができます:
4.1. OpenShiftアプリケーションを手動で設定
デプロイメント設定をより詳細に制御する必要がある場合は、最初にコンテナイメージをビルドし、OpenShift アプリケーションを手動で設定することができます。
コンテナイメージのビルドをトリガーする場合:
./mvnw clean package -Dquarkus.container-image.build=true
実行されるビルドは、 s2iバイナリビルド です。
ビルドの入力はローカルでビルドされたJARファイルで、ビルドの出力は自動的にデプロイをトリガーするように設定された ImageStream
です。
ベースイメージまたはビルダーイメージは、それぞれ JVM 用に base-jvm-image
を、ネイティブモード用に base-native-image
を使って指定します。
これらのプロパティがopenshift内部レジストリの既存の ImageStreamTag
を参照するために使用されない限り、イメージ用の ImageStream
が自動的に生成されます。
例:
quarkus.openshift.base-jvm-image=image-registry.openshift-image-registry.svc:5000/some-project/openjdk-11:17.1.16.
ビルド中に、自己署名証明書が原因で
詳細については、 Kubernetesへのデプロイ を参照。 |
ビルドが完了したら、関連する ImageStream
から新しいアプリケーションを作成できます。
oc get is (1)
oc new-app --name=greeting <project>/openshift-quickstart:1.0.0-SNAPSHOT (2)
oc get svc
oc expose svc/greeting (3)
oc get routes (4)
curl http://<route>/hello (5)
1 | 作成されたイメージ・ストリームを一覧表示します。私たちのアプリケーションのイメージ・ストリームは、<project>/openshift-quickstart:1.0.0-SNAPSHOT としてタグ付けされるべきです。 |
2 | イメージソースから新しいアプリケーションを作成します。 |
3 | サービスを外部に公開します。 |
4 | 公開されているルートのリストを取得します。 |
5 | アプリケーションにアクセスします。 |
このセットアップの後、次回コンテナイメージがビルドされると、OpenShiftへのデプロイが自動的にトリガーされます。つまり、上記の手順を繰り返す必要はありません。
4.2. 非S2Iビルド
OpenShift エクステンションは container-image-s2i を使用するように設定されています。しかし、以下のような他のコンテナイメージエクステンションを使用することも可能です:
s2i コンテナイメージエクステンション以外を使用する場合、外部の dockerImageRepository
を指し示す ImageStream
が作成されます。イメージはビルドされてレジストリにプッシュされ、 ImageStream
は dockerImageRepository
で利用可能なタグを入力します。
イメージのビルドに使用するエクステンションを選択するには次のようにします。
quarkus.container-image.builder=docker
あるいは
quarkus.container-image.builder=jib
5. カスタマイズ
利用可能なカスタマイズオプションは、すべて OpenShift設定オプションで利用できます。
いくつかの例は、以下のセクションで提供されています。
5.1. ルートの公開
Quarkusアプリケーションの Route
を公開するには次のようにします。
quarkus.openshift.route.expose=true
このプロパティを
以下にリストされているすべてのプロパティも同様です。 |
5.1.1. Routeリソースの保護
着信接続を保護するために、OpenShift は証明書を提供するためにいくつかのタイプの TLS 終端を提供します。
ルートを保護する方法の詳細については、 OpenShift Container Platform のドキュメントを参照してください。
次の例では、"quarkus.openshift.route.tls" プロパティを追加して、パススルー終端を使用して保護されたRouteを設定する方法を示します:
quarkus.openshift.route.expose=true
quarkus.openshift.route.target-port=https
## Route TLS configuration:
quarkus.openshift.route.tls.termination=passthrough
quarkus.openshift.route.tls.insecure-edge-termination-policy=None
5.4. 環境変数
OpenShiftでは環境変数の定義方法が複数用意されています。
-
キー/値のペア
-
Secret または ConfigMap からすべての値をインポート
-
Secret または ConfigMap の指定されたフィールドで識別される単一の値を補間
-
同じリソース内のフィールドから値を補間
5.4.1. キー/値のペアからの環境変数
生成されたリソースに環境変数としてキーとバリューのペアを追加する場合:
quarkus.openshift.env.vars.my-env-var=foobar
上記のコマンドは MY_ENV_VAR=foobar
を環境変数として追加します。
キー my-env-var
は大文字に変換され、ダッシュはアンダースコアに置き換えられ、 MY_ENV_VAR
となります。
5.4.2. シークレットからの環境変数
Secret
のすべてのキーと値のペアを環境変数として追加するには、ソースとして使用する各 Secret
をカンマ ( ,
) で区切って、以下の設定を適用します:
quarkus.openshift.env.secrets=my-secret,my-other-secret
これはコンテナ定義に以下を生成します:
envFrom:
- secretRef:
name: my-secret
optional: false
- secretRef:
name: my-other-secret
optional: false
以下のコードは、 my-secret
シークレットから keyName
フィールドで識別される値を foo
環境変数に抽出します:
quarkus.openshift.env.mapping.foo.from-secret=my-secret
quarkus.openshift.env.mapping.foo.with-key=keyName
これにより、コンテナの env
セクションに次の内容が生成されます。
- env:
- name: FOO
valueFrom:
secretKeyRef:
key: keyName
name: my-secret
optional: false
5.4.3. ConfigMapからの環境変数
ConfigMap
のすべてのキー/値ペアを環境変数として追加するには、ソースとして使用する各 ConfigMap
をカンマ ( ,
) で区切って、以下の設定を適用します:
quarkus.openshift.env.configmaps=my-config-map,another-config-map
これはコンテナ定義に以下を生成します:
envFrom:
- configMapRef:
name: my-config-map
optional: false
- configMapRef:
name: another-config-map
optional: false
The following extracts a value identified by the keyName
field from the my-config-map
ConfigMap into a foo
environment variable:
quarkus.openshift.env.mapping.foo.from-configmap=my-configmap
quarkus.openshift.env.mapping.foo.with-key=keyName
これにより、コンテナの env
セクションに次の内容が生成されます。
- env:
- name: FOO
valueFrom:
configMapKeyRef:
key: keyName
name: my-configmap
optional: false
5.4.4. フィールドからの環境変数
ソースとして使用するフィールドのパスを指定することで、他のフィールドの値を使用して新しい環境変数を追加することもできます。 例:
quarkus.openshift.env.fields.foo=metadata.name
5.4.5. 生成されるデプロイメントリソースの変更
Deployment
リ ソ ース を生成す る だけでな く 、 application.properties
を使って DeploymentConfig
、 StatefulSet
、 Job
、 CronJob
リ ソ ース を取得す る こ と も で き ます:
quarkus.openshift.deployment-kind=StatefulSet
5.4.5.1. Job リソースの生成
Job リソースを生成したい場合、 application.properties
を使って以下のプロパティを追加する必要があります:
quarkus.openshift.deployment-kind=Job
Picocli エクステンションを使用している場合、デフォルトで Job リソースが生成されます。 |
Kubernetes Jobが使用する引数は、 quarkus.openshift.arguments
プロパティを通して提供できます。
例えば、 quarkus.openshift.arguments=A,B
プロパティを追加してください。
最後に、Kubernetes JobはOpenShiftにインストールされるたびに起動されます。 Kubernetesジョブの実行方法の詳細については、 サンプルジョブの実行 を参照してください。
Kubernetes Jobの残りの設定は、 quarkus.openshift.job.xxx
のプロパティを使用して設定できます (詳細については、quarkus.openshift.job.parallelismを参照してください)。
5.4.5.2. CronJob リソースの生成
CronJobリソースを生成したい場合、 application.properties
ファイルを使用して以下のプロパティを追加する必要があります:
quarkus.openshift.deployment-kind=CronJob
# Cron expression to run the job every hour
quarkus.openshift.cron-job.schedule=0 * * * *
CronJobリソースは、 quarkus.openshift.cron-job.schedule プロパティを通してジョブを起動するタイミングを指定する Cron 式を必要とします。これが提供されない場合、ビルドは失敗します。
|
Kubernetes CronJobの残りの設定は、 quarkus.openshift.cron-job.xxx
(詳細については、 quarkus.openshift.cron-job.parallelism を参照)のプロパティを使用して設定できます。
5.4.6. バリデーション
2つの定義が衝突した場合、たとえば、値を誤って代入したり、変数がフィールドから派生していることを指定したりすると、ビルド時にエラーがスローされます。クラスタにアプリケーションをデプロイする前に問題を修正することができます。
同様に、2つの冗長な定義、例えば同じシークレットからのインジェクションを2回定義しても問題は発生しませんが、その定義を重複させる意図はなかったかもしれないという警告が表示されます。
5.4.6.1. 下位互換性
OpenShift エクステンションの以前のバージョンでは、環境変数を追加するための異なる構文がサポートされていました。古い構文はまだサポートされていますが、非推奨です。
旧 |
新 |
||
素の変数 |
|
|
|
フィールドから |
|
|
|
すべての |
|
|
|
すべての |
|
|
|
ある |
|
|
|
|
|
||
ある |
|
|
|
|
|
古い構文を保持したまま新しい構文を使用して同じ変数を再定義した場合、新しいバージョン *のみ* が保持され、問題を警告します。 例えば、 `quarkus.openshift.env-vars.my-env-var.value=foobar` と `quarkus.openshift.env.vars.my-env-var=newValue` の両方を定義した場合、エクステンションは環境変数 `MY_ENV_VAR=newValue` を生成し、警告を発します。 |
5.5. Volumeのマウント
OpenShiftのエクステンションでは、アプリケーションのボリュームとマウントの両方を設定できます。 簡単な設定でどんなボリュームでもマウントできます:
quarkus.openshift.mounts.my-volume.path=/where/to/mount
これで、私のポッドにボリューム my-volume
のマウントがパス /where/to/mount
に追加されます。
以下のセクションで示すように、ボリューム自体を設定できます:
6. Knative - OpenShiftサーバーレス
OpenShiftでは、 OpenShift Serverless の機能を利用することで、Knativeを利用することもできます。
まず、QuarkusにKnativeリソースの生成を指示します:
quarkus.kubernetes.deployment-target=knative
OpenShift S2Iを活用してクラスタ上でコンテナイメージをビルドし、得られたコンテナイメージをKnativeアプリケーションに使用するには、以下の設定プロパティを設定します:
# set the Kubernetes namespace which will be used to run the application
quarkus.container-image.group=geoand
# set the container image registry - this is the standard URL used to refer to the internal OpenShift registry
quarkus.container-image.registry=image-registry.openshift-image-registry.svc:5000
その後、標準の quarkus.kubernetes.deploy=true
プロパティを有効にすることで、アプリケーションを OpenShift Serverless にデプロイできます。
7. 設定リファレンス
ビルド時に固定される設定プロパティ - 他のすべての設定プロパティは実行時にオーバーライド可能
Configuration property |
タイプ |
デフォルト |
---|---|---|
The optional list of Secret names to load environment variables from. Environment variable: Show more |
list of string |
|
The optional list of ConfigMap names to load environment variables from. Environment variable: Show more |
list of string |
|
The map associating environment variable names to their associated field references they take their value from. Environment variable: Show more |
Map<String,String> |
|
The environment variable value Environment variable: Show more |
string |
|
The optional name of the Secret from which a value is to be extracted. Mutually exclusive with Environment variable: Show more |
string |
|
The optional name of the ConfigMap from which a value is to be extracted. Mutually exclusive with Environment variable: Show more |
string |
|
The key identifying the field from which the value is extracted. Environment variable: Show more |
string |
required |
The optional prefix to use when adding the environment variable to the container. Environment variable: Show more |
string |
|
The optional prefix to use when adding the environment variable to the container. Environment variable: Show more |
string |
|
The name of the group this component belongs too. Environment variable: Show more |
string |
|
The name of the application. This value will be used for naming Kubernetes resources like: - Deployment - Service and so on … Environment variable: Show more |
string |
|
The version of the application. Environment variable: Show more |
string |
|
The namespace the generated resources should belong to. If not value is set, then the 'namespace' field will not be added to the 'metadata' section of the generated manifests. This in turn means that when the manifests are applied to a cluster, the namespace will be resolved from the current Kubernetes context (see organize-cluster-access-kubeconfig for more details). Environment variable: Show more |
string |
|
Custom labels to add to all resources. Environment variable: Show more |
Map<String,String> |
|
Custom annotations to add to all resources. Environment variable: Show more |
Map<String,String> |
|
The type of service that will be generated for the application Environment variable: Show more |
|
|
Whether to add the build timestamp to the Kubernetes annotations This is a very useful way to have manifests of successive builds of the same application differ - thus ensuring that Kubernetes will apply the updated resources. Environment variable: Show more |
ブーリアン |
|
If Environment variable: Show more |
ブーリアン |
|
If Environment variable: Show more |
ブーリアン |
|
Working directory. Environment variable: Show more |
string |
|
list of string |
||
The arguments. Environment variable: Show more |
list of string |
|
The service account. Environment variable: Show more |
string |
|
If set, it will change the name of the container according to the configuration. Environment variable: Show more |
string |
|
The port number. Refers to the container port. Environment variable: Show more |
int |
|
The host port. Environment variable: Show more |
int |
|
The application path (refers to web application path). Environment variable: Show more |
string |
|
The protocol. Environment variable: Show more |
|
|
The nodePort to which this port should be mapped to. This only takes affect when the serviceType is set to node-port. Environment variable: Show more |
int |
|
If enabled, the port will be configured to use the schema HTTPS. Environment variable: Show more |
ブーリアン |
|
Image pull policy. Environment variable: Show more |
|
|
The image pull secret. Environment variable: Show more |
list of string |
|
Enable generation of image pull secret, when the container image username and password are provided. Environment variable: Show more |
ブーリアン |
|
The port number to use when configuring the Environment variable: Show more |
int |
|
The port name for selecting the port of the Environment variable: Show more |
string |
|
The http path to use for the probe. For this to work, the container port also needs to be set. Assuming the container port has been set (as per above comment), if execAction or tcpSocketAction are not set, an HTTP probe will be used automatically even if no path is set (which will result in the root path being used). If Smallrye Health is used, the path will automatically be set according to the health check path. Environment variable: Show more |
string |
|
The scheme of the Environment variable: Show more |
string |
|
The command to use for the probe. Environment variable: Show more |
string |
|
The tcp socket to use for the probe (the format is host:port). Environment variable: Show more |
string |
|
The gRPC port to use for the probe (the format is either port or port:service). Environment variable: Show more |
string |
|
If enabled and Environment variable: Show more |
ブーリアン |
|
The amount of time to wait before starting to probe. Environment variable: Show more |
|
|
The period in which the action should be called. Environment variable: Show more |
|
|
The amount of time to wait for each action. Environment variable: Show more |
|
|
The success threshold to use. Environment variable: Show more |
int |
|
The failure threshold to use. Environment variable: Show more |
int |
|
The port number to use when configuring the Environment variable: Show more |
int |
|
The port name for selecting the port of the Environment variable: Show more |
string |
|
The http path to use for the probe. For this to work, the container port also needs to be set. Assuming the container port has been set (as per above comment), if execAction or tcpSocketAction are not set, an HTTP probe will be used automatically even if no path is set (which will result in the root path being used). If Smallrye Health is used, the path will automatically be set according to the health check path. Environment variable: Show more |
string |
|
The scheme of the Environment variable: Show more |
string |
|
The command to use for the probe. Environment variable: Show more |
string |
|
The tcp socket to use for the probe (the format is host:port). Environment variable: Show more |
string |
|
The gRPC port to use for the probe (the format is either port or port:service). Environment variable: Show more |
string |
|
If enabled and Environment variable: Show more |
ブーリアン |
|
The amount of time to wait before starting to probe. Environment variable: Show more |
|
|
The period in which the action should be called. Environment variable: Show more |
|
|
The amount of time to wait for each action. Environment variable: Show more |
|
|
The success threshold to use. Environment variable: Show more |
int |
|
The failure threshold to use. Environment variable: Show more |
int |
|
The port number to use when configuring the Environment variable: Show more |
int |
|
The port name for selecting the port of the Environment variable: Show more |
string |
|
The http path to use for the probe. For this to work, the container port also needs to be set. Assuming the container port has been set (as per above comment), if execAction or tcpSocketAction are not set, an HTTP probe will be used automatically even if no path is set (which will result in the root path being used). If Smallrye Health is used, the path will automatically be set according to the health check path. Environment variable: Show more |
string |
|
The scheme of the Environment variable: Show more |
string |
|
The command to use for the probe. Environment variable: Show more |
string |
|
The tcp socket to use for the probe (the format is host:port). Environment variable: Show more |
string |
|
The gRPC port to use for the probe (the format is either port or port:service). Environment variable: Show more |
string |
|
If enabled and Environment variable: Show more |
ブーリアン |
|
The amount of time to wait before starting to probe. Environment variable: Show more |
|
|
The period in which the action should be called. Environment variable: Show more |
|
|
The amount of time to wait for each action. Environment variable: Show more |
|
|
The success threshold to use. Environment variable: Show more |
int |
|
The failure threshold to use. Environment variable: Show more |
int |
|
When true (the default), emit a set of annotations to identify services that should be scraped by prometheus for metrics. In configurations that use the Prometheus operator with ServiceMonitor, annotations may not be necessary. Environment variable: Show more |
ブーリアン |
|
When true (the default), emit a set of annotations to identify services that should be scraped by prometheus for metrics. In configurations that use the Prometheus operator with ServiceMonitor, annotations may not be necessary. Environment variable: Show more |
ブーリアン |
|
Define the annotation prefix used for scrape values, this value will be used as the base for other annotation name defaults. Altering the base for generated annotations can make it easier to define re-labeling rules and avoid unexpected knock-on effects. The default value is Environment variable: Show more |
string |
|
Define the annotation used to indicate services that should be scraped. By default, Environment variable: Show more |
string |
|
Define the annotation used to indicate the path to scrape. By default, Environment variable: Show more |
string |
|
Define the annotation used to indicate the port to scrape. By default, Environment variable: Show more |
string |
|
Define the annotation used to indicate the scheme to use for scraping By default, Environment variable: Show more |
string |
|
The name of the volumeName to mount. Environment variable: Show more |
string |
|
The path to mount. Environment variable: Show more |
string |
|
Path within the volumeName from which the container’s volumeName should be mounted. Environment variable: Show more |
string |
|
ReadOnly. Environment variable: Show more |
ブーリアン |
|
The name of the secret to mount. Environment variable: Show more |
string |
required |
Default mode. When specifying an octal number, leading zero must be present. Environment variable: Show more |
string |
|
The path where the file will be mounted. Environment variable: Show more |
string |
required |
It must be a value between 0000 and 0777. If not specified, the volume defaultMode will be used. Environment variable: Show more |
int |
|
Optional Environment variable: Show more |
ブーリアン |
|
The name of the ConfigMap to mount. Environment variable: Show more |
string |
required |
Default mode. When specifying an octal number, leading zero must be present. Environment variable: Show more |
string |
|
The path where the file will be mounted. Environment variable: Show more |
string |
required |
It must be a value between 0000 and 0777. If not specified, the volume defaultMode will be used. Environment variable: Show more |
int |
|
Optional Environment variable: Show more |
ブーリアン |
|
EmptyDir volumes. Environment variable: Show more |
list of string |
|
Git repository URL. Environment variable: Show more |
string |
required |
The directory of the repository to mount. Environment variable: Show more |
string |
|
The commit hash to use. Environment variable: Show more |
string |
|
The name of the claim to mount. Environment variable: Show more |
string |
required |
Default mode. When specifying an octal number, leading zero must be present. Environment variable: Show more |
string |
|
Optional Environment variable: Show more |
ブーリアン |
|
The name of the disk to mount. Environment variable: Show more |
string |
required |
The partition. Environment variable: Show more |
int |
|
Filesystem type. Environment variable: Show more |
string |
|
Whether the volumeName is read only or not. Environment variable: Show more |
ブーリアン |
|
The share name. Environment variable: Show more |
string |
required |
The secret name. Environment variable: Show more |
string |
required |
Whether the volumeName is read only or not. Environment variable: Show more |
ブーリアン |
|
The name of the disk to mount. Environment variable: Show more |
string |
required |
The URI of the vhd blob object OR the resourceID of an Azure managed data disk if Kind is Managed Environment variable: Show more |
string |
required |
Kind of disk. Environment variable: Show more |
|
|
Disk caching mode. Environment variable: Show more |
|
|
File system type. Environment variable: Show more |
string |
|
Whether the volumeName is read only or not. Environment variable: Show more |
ブーリアン |
|
The optional list of Secret names to load environment variables from. Environment variable: Show more |
list of string |
|
The optional list of ConfigMap names to load environment variables from. Environment variable: Show more |
list of string |
|
The map associating environment variable names to their associated field references they take their value from. Environment variable: Show more |
Map<String,String> |
|
The environment variable value Environment variable: Show more |
string |
|
The optional name of the Secret from which a value is to be extracted. Mutually exclusive with Environment variable: Show more |
string |
|
The optional name of the ConfigMap from which a value is to be extracted. Mutually exclusive with Environment variable: Show more |
string |
|
The key identifying the field from which the value is extracted. Environment variable: Show more |
string |
required |
The optional prefix to use when adding the environment variable to the container. Environment variable: Show more |
string |
|
The optional prefix to use when adding the environment variable to the container. Environment variable: Show more |
string |
|
The container image. Environment variable: Show more |
string |
|
Working directory. Environment variable: Show more |
string |
|
The commands Environment variable: Show more |
list of string |
|
The arguments Environment variable: Show more |
list of string |
|
The service account. Environment variable: Show more |
string |
|
The host under which the application is going to be exposed. Environment variable: Show more |
string |
|
The port number. Refers to the container port. Environment variable: Show more |
int |
|
The host port. Environment variable: Show more |
int |
|
The application path (refers to web application path). Environment variable: Show more |
string |
|
The protocol. Environment variable: Show more |
|
|
The nodePort to which this port should be mapped to. This only takes affect when the serviceType is set to node-port. Environment variable: Show more |
int |
|
If enabled, the port will be configured to use the schema HTTPS. Environment variable: Show more |
ブーリアン |
|
Image pull policy. Environment variable: Show more |
|
|
The image pull secrets. Environment variable: Show more |
list of string |
|
The port number to use when configuring the Environment variable: Show more |
int |
|
The port name for selecting the port of the Environment variable: Show more |
string |
|
The http path to use for the probe. For this to work, the container port also needs to be set. Assuming the container port has been set (as per above comment), if execAction or tcpSocketAction are not set, an HTTP probe will be used automatically even if no path is set (which will result in the root path being used). If Smallrye Health is used, the path will automatically be set according to the health check path. Environment variable: Show more |
string |
|
The scheme of the Environment variable: Show more |
string |
|
The command to use for the probe. Environment variable: Show more |
string |
|
The tcp socket to use for the probe (the format is host:port). Environment variable: Show more |
string |
|
The gRPC port to use for the probe (the format is either port or port:service). Environment variable: Show more |
string |
|
If enabled and Environment variable: Show more |
ブーリアン |
|
The amount of time to wait before starting to probe. Environment variable: Show more |
|
|
The period in which the action should be called. Environment variable: Show more |
|
|
The amount of time to wait for each action. Environment variable: Show more |
|
|
The success threshold to use. Environment variable: Show more |
int |
|
The failure threshold to use. Environment variable: Show more |
int |
|
The port number to use when configuring the Environment variable: Show more |
int |
|
The port name for selecting the port of the Environment variable: Show more |
string |
|
The http path to use for the probe. For this to work, the container port also needs to be set. Assuming the container port has been set (as per above comment), if execAction or tcpSocketAction are not set, an HTTP probe will be used automatically even if no path is set (which will result in the root path being used). If Smallrye Health is used, the path will automatically be set according to the health check path. Environment variable: Show more |
string |
|
The scheme of the Environment variable: Show more |
string |
|
The command to use for the probe. Environment variable: Show more |
string |
|
The tcp socket to use for the probe (the format is host:port). Environment variable: Show more |
string |
|
The gRPC port to use for the probe (the format is either port or port:service). Environment variable: Show more |
string |
|
If enabled and Environment variable: Show more |
ブーリアン |
|
The amount of time to wait before starting to probe. Environment variable: Show more |
|
|
The period in which the action should be called. Environment variable: Show more |
|
|
The amount of time to wait for each action. Environment variable: Show more |
|
|
The success threshold to use. Environment variable: Show more |
int |
|
The failure threshold to use. Environment variable: Show more |
int |
|
The name of the volumeName to mount. Environment variable: Show more |
string |
|
The path to mount. Environment variable: Show more |
string |
|
Path within the volumeName from which the container’s volumeName should be mounted. Environment variable: Show more |
string |
|
ReadOnly. Environment variable: Show more |
ブーリアン |
|
CPU Requirements Environment variable: Show more |
string |
|
Memory Requirements Environment variable: Show more |
string |
|
CPU Requirements Environment variable: Show more |
string |
|
Memory Requirements Environment variable: Show more |
string |
|
The optional list of Secret names to load environment variables from. Environment variable: Show more |
list of string |
|
The optional list of ConfigMap names to load environment variables from. Environment variable: Show more |
list of string |
|
The map associating environment variable names to their associated field references they take their value from. Environment variable: Show more |
Map<String,String> |
|
The environment variable value Environment variable: Show more |
string |
|
The optional name of the Secret from which a value is to be extracted. Mutually exclusive with Environment variable: Show more |
string |
|
The optional name of the ConfigMap from which a value is to be extracted. Mutually exclusive with Environment variable: Show more |
string |
|
The key identifying the field from which the value is extracted. Environment variable: Show more |
string |
required |
The optional prefix to use when adding the environment variable to the container. Environment variable: Show more |
string |
|
The optional prefix to use when adding the environment variable to the container. Environment variable: Show more |
string |
|
The container image. Environment variable: Show more |
string |
|
Working directory. Environment variable: Show more |
string |
|
The commands Environment variable: Show more |
list of string |
|
The arguments Environment variable: Show more |
list of string |
|
The service account. Environment variable: Show more |
string |
|
The host under which the application is going to be exposed. Environment variable: Show more |
string |
|
The port number. Refers to the container port. Environment variable: Show more |
int |
|
The host port. Environment variable: Show more |
int |
|
The application path (refers to web application path). Environment variable: Show more |
string |
|
The protocol. Environment variable: Show more |
|
|
The nodePort to which this port should be mapped to. This only takes affect when the serviceType is set to node-port. Environment variable: Show more |
int |
|
If enabled, the port will be configured to use the schema HTTPS. Environment variable: Show more |
ブーリアン |
|
Image pull policy. Environment variable: Show more |
|
|
The image pull secrets. Environment variable: Show more |
list of string |
|
The port number to use when configuring the Environment variable: Show more |
int |
|
The port name for selecting the port of the Environment variable: Show more |
string |
|
The http path to use for the probe. For this to work, the container port also needs to be set. Assuming the container port has been set (as per above comment), if execAction or tcpSocketAction are not set, an HTTP probe will be used automatically even if no path is set (which will result in the root path being used). If Smallrye Health is used, the path will automatically be set according to the health check path. Environment variable: Show more |
string |
|
The scheme of the Environment variable: Show more |
string |
|
The command to use for the probe. Environment variable: Show more |
string |
|
The tcp socket to use for the probe (the format is host:port). Environment variable: Show more |
string |
|
The gRPC port to use for the probe (the format is either port or port:service). Environment variable: Show more |
string |
|
If enabled and Environment variable: Show more |
ブーリアン |
|
The amount of time to wait before starting to probe. Environment variable: Show more |
|
|
The period in which the action should be called. Environment variable: Show more |
|
|
The amount of time to wait for each action. Environment variable: Show more |
|
|
The success threshold to use. Environment variable: Show more |
int |
|
The failure threshold to use. Environment variable: Show more |
int |
|
The port number to use when configuring the Environment variable: Show more |
int |
|
The port name for selecting the port of the Environment variable: Show more |
string |
|
The http path to use for the probe. For this to work, the container port also needs to be set. Assuming the container port has been set (as per above comment), if execAction or tcpSocketAction are not set, an HTTP probe will be used automatically even if no path is set (which will result in the root path being used). If Smallrye Health is used, the path will automatically be set according to the health check path. Environment variable: Show more |
string |
|
The scheme of the Environment variable: Show more |
string |
|
The command to use for the probe. Environment variable: Show more |
string |
|
The tcp socket to use for the probe (the format is host:port). Environment variable: Show more |
string |
|
The gRPC port to use for the probe (the format is either port or port:service). Environment variable: Show more |
string |
|
If enabled and Environment variable: Show more |
ブーリアン |
|
The amount of time to wait before starting to probe. Environment variable: Show more |
|
|
The period in which the action should be called. Environment variable: Show more |
|
|
The amount of time to wait for each action. Environment variable: Show more |
|
|
The success threshold to use. Environment variable: Show more |
int |
|
The failure threshold to use. Environment variable: Show more |
int |
|
The name of the volumeName to mount. Environment variable: Show more |
string |
|
The path to mount. Environment variable: Show more |
string |
|
Path within the volumeName from which the container’s volumeName should be mounted. Environment variable: Show more |
string |
|
ReadOnly. Environment variable: Show more |
ブーリアン |
|
CPU Requirements Environment variable: Show more |
string |
|
Memory Requirements Environment variable: Show more |
string |
|
CPU Requirements Environment variable: Show more |
string |
|
Memory Requirements Environment variable: Show more |
string |
|
The ip address. Environment variable: Show more |
string |
|
The hostnames to resolve to the ip. Environment variable: Show more |
list of string |
|
The key of the nodeSelector. Environment variable: Show more |
string |
required |
The value of the nodeSelector. Environment variable: Show more |
string |
required |
CPU Requirements Environment variable: Show more |
string |
|
Memory Requirements Environment variable: Show more |
string |
|
CPU Requirements Environment variable: Show more |
string |
|
Memory Requirements Environment variable: Show more |
string |
|
If set, the secret will mounted to the application container and its contents will be used for application configuration. Environment variable: Show more |
string |
|
If set, the config map will be mounted to the application container and its contents will be used for application configuration. Environment variable: Show more |
string |
|
The name of the role. Environment variable: Show more |
string |
|
The namespace of the role. Environment variable: Show more |
string |
|
Labels to add into the Role resource. Environment variable: Show more |
Map<String,String> |
|
API groups of the policy rule. Environment variable: Show more |
list of string |
|
Non resource URLs of the policy rule. Environment variable: Show more |
list of string |
|
Resource names of the policy rule. Environment variable: Show more |
list of string |
|
Resources of the policy rule. Environment variable: Show more |
list of string |
|
Verbs of the policy rule. Environment variable: Show more |
list of string |
|
The name of the cluster role. Environment variable: Show more |
string |
|
Labels to add into the ClusterRole resource. Environment variable: Show more |
Map<String,String> |
|
API groups of the policy rule. Environment variable: Show more |
list of string |
|
Non resource URLs of the policy rule. Environment variable: Show more |
list of string |
|
Resource names of the policy rule. Environment variable: Show more |
list of string |
|
Resources of the policy rule. Environment variable: Show more |
list of string |
|
Verbs of the policy rule. Environment variable: Show more |
list of string |
|
The name of the service account. Environment variable: Show more |
string |
|
The namespace of the service account. Environment variable: Show more |
string |
|
Labels of the service account. Environment variable: Show more |
Map<String,String> |
|
If true, this service account will be used in the generated Deployment resource. Environment variable: Show more |
ブーリアン |
|
Name of the RoleBinding resource to be generated. If not provided, it will use the application name plus the role ref name. Environment variable: Show more |
string |
|
Labels to add into the RoleBinding resource. Environment variable: Show more |
Map<String,String> |
|
The name of the Role resource to use by the RoleRef element in the generated Role Binding resource. By default, it’s "view" role name. Environment variable: Show more |
string |
|
If the Role sets in the Environment variable: Show more |
ブーリアン |
|
The "name" resource to use by the Subject element in the generated Role Binding resource. Environment variable: Show more |
string |
|
The "kind" resource to use by the Subject element in the generated Role Binding resource. By default, it uses the "ServiceAccount" kind. Environment variable: Show more |
string |
|
The "apiGroup" resource that matches with the "kind" property. By default, it’s empty. Environment variable: Show more |
string |
|
The "namespace" resource to use by the Subject element in the generated Role Binding resource. By default, it will use the same as provided in the generated resources. Environment variable: Show more |
string |
|
Name of the ClusterRoleBinding resource to be generated. If not provided, it will use the application name plus the role ref name. Environment variable: Show more |
string |
|
Labels to add into the RoleBinding resource. Environment variable: Show more |
Map<String,String> |
|
The name of the ClusterRole resource to use by the RoleRef element in the generated ClusterRoleBinding resource. Environment variable: Show more |
string |
required |
The "name" resource to use by the Subject element in the generated Role Binding resource. Environment variable: Show more |
string |
|
The "kind" resource to use by the Subject element in the generated Role Binding resource. By default, it uses the "ServiceAccount" kind. Environment variable: Show more |
string |
|
The "apiGroup" resource that matches with the "kind" property. By default, it’s empty. Environment variable: Show more |
string |
|
The "namespace" resource to use by the Subject element in the generated Role Binding resource. By default, it will use the same as provided in the generated resources. Environment variable: Show more |
string |
|
The SELinux level label that applies to the container. Environment variable: Show more |
string |
|
The SELinux role label that applies to the container. Environment variable: Show more |
string |
|
The SELinux type label that applies to the container. Environment variable: Show more |
string |
|
The SELinux user label that applies to the container. Environment variable: Show more |
string |
|
The name of the GMSA credential spec to use. Environment variable: Show more |
string |
|
GMSACredentialSpec is where the GMSA admission webhook (windows-gsma) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field. Environment variable: Show more |
string |
|
The UserName in Windows to run the entrypoint of the container process. Environment variable: Show more |
string |
|
HostProcess determines if a container should be run as a 'Host Process' container. Environment variable: Show more |
ブーリアン |
|
The UID to run the entrypoint of the container process. Environment variable: Show more |
長 |
|
The GID to run the entrypoint of the container process. Environment variable: Show more |
長 |
|
Indicates that the container must run as a non-root user. Environment variable: Show more |
ブーリアン |
|
A list of groups applied to the first process run in each container, in addition to the container’s primary GID. If unspecified, no groups will be added to any container. Environment variable: Show more |
list of long |
|
A special supplemental group that applies to all containers in a pod. Environment variable: Show more |
長 |
|
Sysctls hold a list of namespaced sysctls used for the pod. Environment variable: Show more |
Map<String,String> |
|
It holds policies that will be used for applying fsGroup to a volume when volume is mounted. Values: OnRootMismatch, Always Environment variable: Show more |
|
|
Switch used to control whether non-idempotent fields are included in generated kubernetes resources to improve git-ops compatibility. Environment variable: Show more |
ブーリアン |
|
Whether the vcs-uri annotation should be added to the generated configuration. Environment variable: Show more |
ブーリアン |
|
Optional override of the vcs-uri annotation. Environment variable: Show more |
string |
|
The OpenShift flavor / version to use. Older versions of OpenShift have minor differences in the labels and fields they support. This option allows users to have their manifests automatically aligned to the OpenShift 'flavor' they use. Environment variable: Show more |
|
|
The kind of the deployment resource to use. Supported values are 'Deployment', 'StatefulSet', 'Job', 'CronJob' and 'DeploymentConfig'. Defaults to 'DeploymentConfig' if Environment variable: Show more |
|
|
The number of desired pods Environment variable: Show more |
int |
|
The nodePort to set when serviceType is set to nodePort Environment variable: Show more |
int |
|
If true, the service will be exposed Environment variable: Show more |
ブーリアン |
|
The host under which the application is going to be exposed Environment variable: Show more |
string |
|
The target named port. If not provided, it will be deducted from the Service resource ports. Options are: "http" and "https". Environment variable: Show more |
string |
|
Custom annotations to add to exposition (route or ingress) resources Environment variable: Show more |
Map<String,String> |
|
Custom labels to add to exposition (route or ingress) resources Environment variable: Show more |
Map<String,String> |
|
The cert authority certificate contents. Environment variable: Show more |
string |
|
The certificate contents. Environment variable: Show more |
string |
|
The contents of the ca certificate of the final destination. Environment variable: Show more |
string |
|
The desired behavior for insecure connections to a route. Environment variable: Show more |
string |
|
The key file contents. Environment variable: Show more |
string |
|
The termination type. Environment variable: Show more |
string |
|
Specifies the maximum desired number of pods the job should run at any given time. Environment variable: Show more |
int |
|
Specifies the desired number of successfully finished pods the job should be run with. Environment variable: Show more |
int |
|
CompletionMode specifies how Pod completions are tracked. Environment variable: Show more |
|
|
Specifies the number of retries before marking this job failed. Environment variable: Show more |
int |
|
Specifies the duration in seconds relative to the startTime that the job may be continuously active before the system tries to terminate it; value must be positive integer. Environment variable: Show more |
長 |
|
Limits the lifetime of a Job that has finished execution (either Complete or Failed). If this field is set, ttlSecondsAfterFinished after the Job finishes, it is eligible to be automatically deleted. Environment variable: Show more |
int |
|
Suspend specifies whether the Job controller should create Pods or not. Environment variable: Show more |
ブーリアン |
|
Restart policy when the job container fails. Environment variable: Show more |
|
|
The schedule in Cron format, see Cron. Environment variable: Show more |
string |
|
The time zone for the job schedule. The default value is the local time of the kube-controller-manager. Environment variable: Show more |
string |
|
ConcurrencyPolicy describes how the job will be handled. Environment variable: Show more |
|
|
Deadline in seconds for starting the job if it misses scheduled time for any reason. Missed jobs executions will be counted as failed ones. Environment variable: Show more |
長 |
|
The number of failed finished jobs to retain. The default value is 1. Environment variable: Show more |
int |
|
The number of successful finished jobs to retain. The default value is 3. Environment variable: Show more |
int |
|
Specifies the maximum desired number of pods the job should run at any given time. Environment variable: Show more |
int |
|
Specifies the desired number of successfully finished pods the job should be run with. Environment variable: Show more |
int |
|
CompletionMode specifies how Pod completions are tracked. Environment variable: Show more |
|
|
Specifies the number of retries before marking this job failed. Environment variable: Show more |
int |
|
Specifies the duration in seconds relative to the startTime that the job may be continuously active before the system tries to terminate it; value must be positive integer. Environment variable: Show more |
長 |
|
Limits the lifetime of a Job that has finished execution (either Complete or Failed). If this field is set, ttlSecondsAfterFinished after the Job finishes, it is eligible to be automatically deleted. Environment variable: Show more |
int |
|
Suspend specifies whether the Job controller should create Pods or not. Environment variable: Show more |
ブーリアン |
|
Restart policy when the job container fails. Environment variable: Show more |
|
|
If true, the debug mode in pods will be enabled. Environment variable: Show more |
ブーリアン |
|
The transport to use. Environment variable: Show more |
string |
|
If enabled, it means the JVM will wait for the debugger to attach before executing the main class. If false, the JVM will immediately execute the main class, while listening for the debugger connection. Environment variable: Show more |
string |
|
It specifies the address at which the debug socket will listen. Environment variable: Show more |
int |
|
If true, the init task will be generated. Otherwise, the init task resource generation will be skipped. Environment variable: Show more |
ブーリアン |
|
The init task image to use by the init container. Environment variable: Show more |
string |
|
Image pull policy. Environment variable: Show more |
|
|
If true, the init task will be generated. Otherwise, the init task resource generation will be skipped. Environment variable: Show more |
ブーリアン |
|
The init task image to use by the init container. Environment variable: Show more |
string |
|
Image pull policy. Environment variable: Show more |
|
|
If set to true, Quarkus will attempt to deploy the application to the target Kubernetes cluster Environment variable: Show more |
ブーリアン |
|
If deploy is enabled, it will follow this strategy to update the resources to the target Kubernetes cluster. Environment variable: Show more |
|
|
期間フォーマットについて
期間の値を書くには、標準の 数字で始まる簡略化した書式を使うこともできます:
その他の場合は、簡略化されたフォーマットが解析のために
|