7.2. CRD パラメーターの詳細

replicas

実行する JBoss Web Server イメージの Pod 数

例:
replicas: 2

applicationName

JWS Operator がデプロイする Web アプリケーションの名前

アプリケーション名は、OpenShift 名前空間またはプロジェクト内で一意の値である必要があります。JWS Operator は、指定されたアプリケーション名を使用して、Web アプリケーションにアクセスするためのルートを作成します。

例:
applicationName: my-app

useSessionClustering

DNSping セッションクラスタリングを有効にする

デフォルトで false に設定されています。このパラメーターを true に設定すると、セッションクラスタリングは ENV_FILES 環境変数とシェルスクリプトを使用して server.xml ファイルにクラスタリングを追加するため、イメージは JBoss Web Server イメージに基づく必要があります。

例:
useSessionClustering: true

webImage

JWS Operator が既存イメージから Pod をデプロイする方法を制御する一連のパラメーター

このパラメーターには、applicationImage、imagePullSecret、webApp、および webServerHealthCheck フィールドが含まれます。

webImage:
      applicationImage

デプロイするアプリケーションイメージの名前へのフルパス

例:
applicationImage: quay.io/$user/my-image-name

webImage:
      imagePullSecret

JWS Operator がリポジトリーからイメージをプルするために使用するシークレットの名前

シークレットにはキー .dockerconfigjson が含まれている必要があります。JWS Operator はシークレットをマウントし、--authfile/mount_point/.dockerconfigjson と同様にそれを使用して、リポジトリーからイメージをプルします。

Secret オブジェクト定義ファイルには、複数のユーザー名とパスワードの値またはトークンが含まれている場合があり、イメージストリーム内のイメージ、ビルダーイメージ、および JWS Operator によってビルドされたイメージにアクセスできます。

例:
imagePullSecret: mysecret

webImage:
      webApp

アプリケーションイメージに追加する Web アプリケーションを JWS Operator がビルドする方法を記述する一連のパラメーター

webApp パラメーターを指定しないと、JWS Operator はアプリケーションをビルドせずに Web アプリケーションをデプロイします。

このパラメーターには、name、sourceRepositoryURL、sourceRepositoryRef、contextDir、webAppWarImage、webAppWarImagePushSecret、builder フィールドが含まれます。

webImage:
      webApp:
           name

Web アプリケーションファイルの名前

デフォルトの名前は ROOT.war です。

例:
name: my-app.war

webImage:
      webApp:
           sourceRepositoryURL

アプリケーションのソースファイルがある URL

ソースには、Maven ビルドをサポートする Maven pom.xml ファイルが含まれている必要があります。Maven がアプリケーションの .war ファイルを生成すると、JWS Operator がアプリケーションのデプロイに使用するイメージの webapps ディレクトリーに .war ファイルがコピーされます (例: /opt/jws-5.x/tomcat/webapps)。

例:
sourceRepositoryUrl: 'https://github.com/$user/demo-webapp.git'

webImage:
      webApp:
           sourceRepositoryRef

JWS Operator が使用するソースリポジトリーのブランチ

例:
sourceRepositoryRef: main

webImage:
      webApp:
           contextDir

pom.xml ファイルが配置され、mvn install コマンドが実行されるソースリポジトリー内のサブディレクトリー

例:
contextDir: /

webImage:
      webApp:
           webAppWarImage

JWS Operator がビルドされたイメージをプッシュするイメージの URL

webImage:
      webApp:
           webAppWarImagePushSecret

JWS Operator がイメージをリポジトリーにプッシュするために使用するシークレットの名前

シークレットにはキー .dockerconfigjson が含まれている必要があります。JWS Operator はシークレットをマウントし、--authfile /mount_point/.dockerconfigjson と同様に使用して、イメージをリポジトリーにプッシュします。

JWS Operator がプルシークレットを使用してリポジトリーからイメージをプルする場合は、プルシークレットの名前を webAppWarImagePushSecret パラメーターの値として指定する必要があります。詳細は、imagePullSecret を参照してください。

例:
imagePullSecret: mysecret

webImage:
      webApp:
           builder

JWS Operator が Web アプリケーションをビルドし、イメージを作成してイメージリポジトリーにプッシュする方法を記述する一連のパラメーター

このパラメーターには、image、imagePullSecret、および applicationBuildScript フィールドが含まれます。

webImage:
      webApp:
           builder:
                image

JWS Operator が Web アプリケーションをビルドするコンテナーのイメージ

例:
image: quay.io/$user/tomcat10-buildah

webImage:
      webApp:
           builder:
                imagePullSecret

JWS Operator がリポジトリーからビルダーイメージをプルするために使用するシークレットの名前 (指定されている場合)

シークレットにはキー .dockerconfigjson が含まれている必要があります。JWS Operator はシークレットをマウントし、--authfile/mount_point/.dockerconfigjson と同様にそれを使用して、リポジトリーからイメージをプルします。

Secret オブジェクト定義ファイルには、複数のユーザー名とパスワードの値またはトークンが含まれている場合があり、イメージストリーム内のイメージ、ビルダーイメージ、および JWS Operator によってビルドされたイメージにアクセスできます。

例:
imagePullSecret: mysecret

webImage:
      webApp:
           builder:
                applicationBuildScript

ビルダーイメージがアプリケーションの .war ファイルをビルドし、それを /mnt ディレクトリーに移動するために使用するスクリプト

このパラメーターの値を指定しないと、ビルダーイメージは Maven と Buildah を使用するデフォルトのスクリプトを使用します。

webImage:
      webServerHealthCheck

JWS Operator が使用するヘルスチェック

デフォルトの動作では、パラメーターを必要としないヘルスバルブが使用されます。

このパラメーターには、serverReadinessScript および serverLivenessScript フィールドが含まれます。

webImage:
      webServerHealthCheck:
           serverReadinessScript

Pod Readiness ヘルスチェックのロジックを指定する文字列

このパラメーターが指定されていないと、JWS Operator は、OpenShift 内部レジストリーを使用して http://localhost:8080/health をチェックします (デフォルトのヘルスチェック)。

例:
serverReadinessScript: /bin/bash -c " /usr/bin/curl --noproxy '*' -s 'http://localhost:8080/health' | /usr/bin/grep -i 'status.*UP'"

webImage:
      webServerHealthCheck:
           serverLivenessScript

Pod Liveness ヘルスチェックのロジックを指定する文字列

このパラメーターは任意です。

webImageStream

実行またはビルドするイメージを提供するイメージストリームを JWS Operator が使用する方法を制御する一連のパラメーター

JWS Operator は、イメージストリーム内の最新イメージを使用します。

このパラメーターには、applicationImage、imagePullSecret、webApp、および webServerHealthCheck フィールドが含まれます。

webImageStream:
      imageStreamName

JWS Operator によるベースイメージの検索を可能にするために作成したイメージストリームの名前

例:
imageStreamName: my-image-name-imagestream:latest

webImageStream:
      imageStreamNamespace

イメージストリームを作成した名前空間またはプロジェクト

例:
imageStreamNamespace: my-namespace

webImageStream:
      webSources

アプリケーションソースファイルの場所とビルド方法を記述する一連のパラメーター

webSources パラメーターを指定しない場合、JWS Operator は最新イメージをイメージストリームにデプロイします。

このパラメーターには、sourceRepositoryUrl、sourceRepositoryRef、contextDir、および webSourcesParams フィールドが含まれます。

webImageStream:
      webSources:
           sourceRepositoryUrl

アプリケーションのソースファイルがある URL

ソースには、Maven ビルドをサポートする Maven pom.xml ファイルが含まれている必要があります。Maven がアプリケーションの .war ファイルを生成すると、JWS Operator がアプリケーションのデプロイに使用するイメージの webapps ディレクトリーに .war ファイルがコピーされます (例: /opt/jws-5.x/tomcat/webapps)。

例:
sourceRepositoryUrl: 'https://github.com/$user/demo-webapp.git'

webImageStream:
      webSources:
           sourceRepositoryRef

JWS Operator が使用するソースリポジトリーのブランチ

例:
sourceRepositoryRef: main

webImageStream:
      webSources:
           contextDir

pom.xml ファイルが配置され、mvn install コマンドが実行されるソースリポジトリー内のサブディレクトリー

例:
contextDir: /

webImageStream:
      webSources:
           webhookSecrets

Webhook を通じてビルドをトリガーするためのシークレット名を指定するパラメーターのセット

このパラメーターには、generic、github、gitlab フィールドが含まれます。

webImageStream:
      webSources:
           webhookSecrets:
                generic

ビルドをトリガーできる汎用 Webhook のシークレットの名前

シークレットの作成の詳細は、Webhook のシークレットの作成 を参照してください。

汎用 Webhook の使用の詳細は、Webhook トリガー を参照してください。

例:
generic: jws-secret

webImageStream:
      webSources:
           webhookSecrets:
                github

ビルドをトリガーできる GitHub Webhook のシークレットの名前

シークレットの作成の詳細は、Webhook のシークレットの作成 を参照してください。

GitHub Webhook の使用の詳細は、Webhook トリガー を参照してください。

例:
github: jws-secret

webImageStream:
      webSources:
           webhookSecrets:
                gitlab

ビルドをトリガーできる GitLab webhook のシークレットの名前

シークレットの作成の詳細は、Webhook のシークレットの作成 を参照してください。

GitLab webhook の使用の詳細は、Webhook トリガー を参照してください。

例:
gitlab: jws-secret

webImageStream:
      webSources:
           webSourcesParams

アプリケーションイメージのビルド方法を説明する一連のパラメーター

このパラメーターは任意です。

このパラメーターには、mavenMirrorUrl、artifactDir、genericWebhookSecret、および githubWebhookSecret フィールドが含まれます。

webImageStream:
      webSources:
           webSourcesParams:
                mavenMirrorUrl

Maven が Web アプリケーションのビルドに使用する Maven プロキシー URL

クラスターがインターネットにアクセスできない場合、このパラメーターは必須です。

webImageStream:
      webSources:
           webSourcesParams:
                artifactDir

Maven が Web アプリケーション用に生成する .war ファイルを Maven が格納するディレクトリー

このディレクトリーの内容は、JWS Operator がアプリケーションのデプロイに使用するイメージの webapps ディレクトリーにコピーされます (例: /opt/jws-5.x/tomcat/webapps)。

デフォルト値は target です。

webImageStream:
      webSources:
           webSourcesParams:
                genericWebHookSecret

Webhook のシークレット文字列

シークレットの作成の詳細は、Webhook のシークレットの作成 を参照してください。

汎用 Webhook の使用の詳細は、Webhook トリガー を参照してください。

たとえば:
genericWebhookSecret: qwerty

webImageStream:
      webSources:
           webSourcesParams:
                githubWebhookSecret

GitHub 固有の Webhook シークレット文字列

シークレットの作成の詳細は、Webhook のシークレットの作成 を参照してください。

GitHub Webhook の使用の詳細は、Webhook トリガー を参照してください。

webImageStream:
      webServerHealthCheck

JWS Operator が使用するヘルスチェック

デフォルトの動作では、パラメーターを必要としないヘルスバルブが使用されます。

このパラメーターには、serverReadinessScript および serverLivenessScript フィールドが含まれます。

webImageStream:
      webServerHealthCheck:
           serverReadinessScript

Pod Readiness ヘルスチェックのロジックを指定する文字列

このパラメーターが指定されていないと、JWS Operator は、OpenShift 内部レジストリーを使用して http://localhost:8080/health をチェックします (デフォルトのヘルスチェック)。

例:
serverReadinessScript: /bin/bash -c " /usr/bin/curl --noproxy '*' -s 'http://localhost:8080/health' | /usr/bin/grep -i 'status.*UP'"

webImageStream:
      webServerHealthCheck:
           serverLivenessScript

Pod Liveness ヘルスチェックのロジックを指定する文字列

このパラメーターは任意です。

tlsConfig

Web サーバーの TLS 設定を指定するパラメーターのセット

このパラメーターには、routeHostname、certificateVerification、tlsSecret、および tlsPassword フィールドが含まれます。

tlsConfig:
      routeHostname

Operator がルートを作成するかどうか、またはルートが TLS を使用するかどうかを示します。

サポートされている値は NONE と tls です。

例:
routeHostname: NONE

tlsConfig:
      certificateVerification

Operator がクライアント証明書で TLS コネクターを使用するかどうかを示します。

サポートされる値は、required、optional、または empty です。

詳細は、certificateVerification 属性に関する Apache Tomcat HTTP Connector のドキュメント を参照してください。

例:
certificateVerification: required

tlsConfig:
      tlsSecret

サーバー証明書 (server.cert) とサーバーキー (server.key) に使用するシークレット、およびクライアント証明書用のオプションの CA 証明書 (ca.cert)

例:
tlsSecret: tlssecret

tlsConfig:
      tlsPassword

サーバーキーを保護するために使用されるパスフレーズ (server.key)

例:
tlsPassword: changeit

environmentVariables

デプロイメント用の環境変数

persistentLogs

永続ボリュームとログ設定を指定するパラメーターのセット

このパラメーターには、catalinaLogs、enableAccessLogs、volumeName、および storageClass フィールドが含まれます。

persistentLogs:
      catalinaLogs

Pod の障害が発生した場合も利用できるように、各 Pod の catalina.out ログファイルを永続ボリュームに保存するかどうかを示します。

サポートされている値は true または false です。

例:
catalinaLogs: true

persistentLogs:
      enableAccessLogs

Pod の障害が発生した場合でも利用できるように、各 Pod の access_log ログファイルを永続ボリュームに保存するかどうかを示します。

サポートされている値は true または false です。

例:
enableAccessLogs: true

persistentLogs:
      volumeName

ログファイルを保存するために使用される永続ボリュームの名前

例:
volumeName: pv0000

persistentLogs:
      storageClass

ログファイルを保存するために使用される永続ボリュームのストレージクラスの名前

例:
storageClass: nfs-client

podResources

Web サーバーが使用する CPU とメモリーリソースの設定を指定します。

これらの値は、limits と requests の下に分類する必要があります。

以下に例を示します。

resources:
   limits:
      cpu: 500m
   requests:
      cpu: 200m

これらの値は自動スケーリングに使用されます。自動スケーリングの詳細は、Horizontal Pod Autoscaler を使用した Pod の自動スケーリング を参照してください。

securityContext

アプリケーションの実行に必要なセキュリティー機能を定義します。

useInsightsClient

Red Hat が提供するランタイムインベントリー Operator との接続を作成するかどうかを示します。

サポートされている値は true または false です。

例:
useInsightsClient: true

INSIGHTS_DEBUG 環境変数を true に設定すると、Insights クライアントのデバッグログを有効化できます。