5.2. 環境変数
5.2.1. 情報環境変数
以下の情報は、イメージに関する情報を伝えるように設計されており、ユーザーが変更すべきではありません。
変数名 | 説明 | 値の例 |
---|---|---|
AB_JOLOKIA_AUTH_OPENSHIFT | - | true |
AB_JOLOKIA_HTTPS | - | true |
AB_JOLOKIA_PASSWORD_RANDOM | - | true |
JBOSS_IMAGE_NAME | イメージ名 ("name" ラベルと同じ) | rh-sso-7/sso76-openshift-rhel8 |
JBOSS_IMAGE_VERSION | イメージのバージョン ("version" ラベルと同じ) | 7.6 |
JBOSS_MODULES_SYSTEM_PKGS | - | org.jboss.logmanager,jdk.nashorn.api |
5.2.2. 設定環境変数
設定環境変数は、再ビルドを必要とせずにイメージを便利に調整するように設計されており、必要に応じてユーザーが設定する必要があります。
変数名 | 説明 | 値の例 |
---|---|---|
AB_JOLOKIA_AUTH_OPENSHIFT |
OpenShift TLS 通信のクライアント認証を切り替えます。このパラメーターの値は、提供されるクライアントの証明書に含まれる必要がある相対識別名になります。このパラメーターを有効にすると、Jolokia が自動的に https 通信モードに切り替わります。デフォルトの CA 証明書は | true |
AB_JOLOKIA_CONFIG |
設定されている場合には、このファイル (パスを含む) を Jolokia JVM エージェントプロパティーとして使用します (Jolokia の reference manual を参照)。設定されていない場合は、本書に定義されている設定を使用して | /opt/jolokia/custom.properties |
AB_JOLOKIA_DISCOVERY_ENABLED | Jolokia の検索を有効にします。デフォルトは false に設定されます。 | true |
AB_JOLOKIA_HOST | バインド先のホストアドレス。デフォルトは 0.0.0.0 です。 | 127.0.0.1 |
AB_JOLOKIA_HTTPS |
https との安全な通信を有効にします。デフォルトでは、AB_JOLOKIA_OPTS に serverCert 設定が指定されていないと、自己署名サーバー証明書が生成されます。注記: 値が空の文字列に設定されていると、https は | true |
AB_JOLOKIA_ID | 使用するエージェント ID (デフォルトではコンテナー ID である $HOSTNAME)。 | openjdk-app-1-xqlsj |
AB_JOLOKIA_OFF |
設定すると、Jolokia のアクティベートが無効になります (つまり、空の値をエコーします)。Jolokia はデフォルトで有効になります。注記: 値が空の文字列に設定されていると、https は | true |
AB_JOLOKIA_OPTS |
エージェント設定に追加されるその他のオプション。これらは | backlog=20 |
AB_JOLOKIA_PASSWORD | Basic 認証のパスワード。デフォルトでは認証は無効になっています。 | mypassword |
AB_JOLOKIA_PASSWORD_RANDOM | これが設定されていると、AB_JOLOKIA_PASSWORD 用に無作為に生成され、/opt/jolokia/etc/jolokia.pw ファイルに保存されます。 | true |
AB_JOLOKIA_PORT | 使用するポート (デフォルト: 8778)。 | 5432 |
AB_JOLOKIA_USER | Basic 認証のユーザー。デフォルトは jolokia に設定されます。 | myusername |
CONTAINER_CORE_LIMIT | CFS Bandwidth Control で説明されているように、計算されたコア制限。 | 2 |
GC_ADAPTIVE_SIZE_POLICY_WEIGHT | 現在のガベージコレクション (GC) 時間と以前の GC 時間に指定される重み。 | 90 |
GC_MAX_HEAP_FREE_RATIO | 縮小を回避するための GC 後のヒープ解放の最大パーセンテージ。 | 40 |
GC_MAX_METASPACE_SIZE | メタスペースの最大サイズ。 | 100 |
GC_TIME_RATIO_MIN_HEAP_FREE_RATIO | 拡大を回避するための GC 後のヒープ解放の最小パーセンテージ。 | 20 |
GC_TIME_RATIO | ガベージコレクションで費やされた時間に対する、ガベージコレクションの外で費やされた時間 (たとえば、アプリケーションの実行に費やされた時間) の比率を指定します。 | 4 |
JAVA_DIAGNOSTICS | これを設定して、問題が発生したときのいくつかの診断情報を標準化します。 | true |
JAVA_INITIAL_MEM_RATIO |
これは、最大ヒープメモリーを基にデフォルトの初期ヒープメモリーを算出するために使用されます。デフォルトは 100 で、初期ヒープサイズに最大ヒープの 100% が使用されることを意味します。このメカニズムを省略するには、この値を 0 に設定します。この場合は、 | 100 |
JAVA_MAX_MEM_RATIO |
これは、コンテナーの制限に基づいてデフォルトの最大ヒープメモリーを算出するために使用されます。コンテナーのメモリー制約のない Docker コンテナーで使用されると、このオプションは影響を受けません。メモリー制約がある場合、 | 40 |
JAVA_OPTS_APPEND | サーバー起動オプション。 | -Dkeycloak.migration.action=export -Dkeycloak.migration.provider=dir -Dkeycloak.migration.dir=/tmp |
MQ_SIMPLE_DEFAULT_PHYSICAL_DESTINATION |
後方互換性を維持するには、true に設定して、 | false |
OPENSHIFT_KUBE_PING_LABELS | クラスタリングのラベルセレクター。 | app=sso-app |
OPENSHIFT_KUBE_PING_NAMESPACE | クラスタリングプロジェクトの名前空間。 | myproject |
SCRIPT_DEBUG |
| true |
SSO_ADMIN_PASSWORD |
Red Hat Single Sign-On サーバーの | adm-password |
SSO_ADMIN_USERNAME |
Red Hat Single Sign-On サーバーの | admin |
SSO_HOSTNAME |
Red Hat Single Sign-On サーバーのカスタムホスト名。デフォルトでは設定されません。設定されていないと、要求ヘッダーを使用して Red Hat Single Sign-On サーバーのホスト名を判断する | rh-sso-server.openshift.example.com |
SSO_REALM | この環境変数を指定すると、Red Hat Single Sign-On サーバーに作成されるレルムの名前。 | demo |
SSO_SERVICE_PASSWORD | Red Hat Single Sign-On サービスユーザーのパスワード | mgmt-password |
SSO_SERVICE_USERNAME | Red Hat Single Sign-On サービスへのアクセスに使用されるユーザー名。これは、指定の Red Hat Single Sign-On レルム内にアプリケーションクライアントを作成するためにクライアントによって使用されます。この環境変数が指定されている場合は、このユーザーが作成されます。 | sso-mgmtuser |
SSO_TRUSTSTORE | シークレット内のトラストストアファイルの名前。 | truststore.jks |
SSO_TRUSTSTORE_DIR | トラストストアディレクトリー。 | /etc/sso-secret-volume |
SSO_TRUSTSTORE_PASSWORD | トラストストアと証明書のパスワード。 | mykeystorepass |
SSO_TRUSTSTORE_SECRET | トラストストアファイルが含まれるシークレットの名前。sso-truststore-volume ボリュームに使用します。 | truststore-secret |
OpenShift 向けの Red Hat Single Sign-On の利用可能な アプリケーションテンプレート は、前述の設定変数 を一般的な OpenShift 変数 (たとえば APPLICATION_NAME または SOURCE_REPOSITORY_URL)、製品固有の変数 (たとえば HORNETQ_CLUSTER_PASSWORD)、またはデータベースイメージに典型的な設定変数 (たとえば POSTGRESQL_MAX_CONNECTIONS) と組み合わせることができます。これらの異なるタイプの設定変数はすべて、Red Hat Single Sign-On 対応アプリケーションをデプロイメントして、可能な限り意図したユースケースに沿ったものにするために、必要に応じて調整できます。Red Hat Single Sign-On が有効なアプリケーションのアプリケーションテンプレートのカテゴリーごとに利用可能な設定変数のリストを以下に示します。
5.2.3. すべての Red Hat Single Sign-On イメージのテンプレート変数
変数 | 説明 |
---|---|
APPLICATION_NAME | アプリケーションの名前。 |
DB_MAX_POOL_SIZE | 設定されたデータソースに xa-pool/max-pool-size を設定します。 |
DB_TX_ISOLATION | 設定されたデータソースの transaction-isolation を設定します。 |
DB_USERNAME | データベースのユーザー名。 |
HOSTNAME_HTTP | http サービスルートのカスタムホスト名。デフォルトのホスト名 (例: <application-name>.<project>.<default-domain-suffix>) は空白のままにします。 |
HOSTNAME_HTTPS | https サービスルートのカスタムホスト名。デフォルトのホスト名 (例: <application-name>.<project>.<default-domain-suffix>) は空白のままにします。 |
HTTPS_KEYSTORE | シークレット内のキーストアファイルの名前。HTTPS_PASSWORD および HTTPS_NAME とともに定義されている場合は、HTTPS を有効にし、SSL 証明書の鍵ファイルを $JBOSS_HOME/standalone/configuration 下の相対パスに設定します。 |
HTTPS_KEYSTORE_TYPE | キーストアファイルのタイプ (JKS または JCEKS)。 |
HTTPS_NAME | サーバー証明書に関連付けられた名前 (例: jboss)。HTTPS_PASSWORD および HTTPS_KEYSTORE とともに定義された場合は、HTTPS を有効にし、SSL 名を設定します。 |
HTTPS_PASSWORD | キーストアおよび証明書のパスワード (例: mykeystorepass)。HTTPS_NAME および HTTPS_KEYSTORE とともに定義された場合は、HTTPS を有効にし、SSL キーパスワードを設定します。 |
HTTPS_SECRET | キーストアファイルが含まれるシークレットの名前。 |
IMAGE_STREAM_NAMESPACE | Red Hat ミドルウェアイメージの ImageStreams がインストールされている namespaceこれらの ImageStream は通常 openshift 名前空間にインストールされます。ImageStreams を別の名前空間またはプロジェクトでインストールした場合に限り、これを変更する必要があります。 |
JGROUPS_CLUSTER_PASSWORD | JGroups クラスターパスワード。 |
JGROUPS_ENCRYPT_KEYSTORE | シークレット内のキーストアファイルの名前。 |
JGROUPS_ENCRYPT_NAME | サーバー証明書に関連付けられた名前 (例: secret-key)。 |
JGROUPS_ENCRYPT_PASSWORD | キーストアおよび証明書のパスワード (password など)。 |
JGROUPS_ENCRYPT_SECRET | キーストアファイルが含まれるシークレットの名前。 |
SSO_ADMIN_USERNAME |
Red Hat Single Sign-On サーバーの |
SSO_ADMIN_PASSWORD |
Red Hat Single Sign-On サーバーの |
SSO_REALM | この環境変数を指定すると、Red Hat Single Sign-On サーバーに作成されるレルムの名前。 |
SSO_SERVICE_USERNAME | Red Hat Single Sign-On サービスへのアクセスに使用されるユーザー名。これは、指定の Red Hat Single Sign-On レルム内にアプリケーションクライアントを作成するためにクライアントによって使用されます。この環境変数が指定されている場合は、このユーザーが作成されます。 |
SSO_SERVICE_PASSWORD | Red Hat Single Sign-On サービスユーザーのパスワード |
SSO_TRUSTSTORE | シークレット内のトラストストアファイルの名前。 |
SSO_TRUSTSTORE_SECRET | トラストストアファイルが含まれるシークレットの名前。sso-truststore-volume ボリュームに使用します。 |
SSO_TRUSTSTORE_PASSWORD | トラストストアと証明書のパスワード。 |
5.2.4. sso76-ocp3-postgresql、sso76-ocp4-postgresql、sso76-ocp3-postgresql-persistent、sso76-ocp4-postgresql-persistent、sso76-ocp3-x509-postgresql-persistent、および sso76-ocp4-x509-postgresql-persistent に固有のテンプレート変数。
変数 | 説明 |
---|---|
DB_USERNAME | データベースのユーザー名。 |
DB_PASSWORD | データベースユーザーのパスワード。 |
DB_JNDI | java:/jboss/datasources/postgresql などのデータソースを解決するアプリケーションによって使用されるデータベースの JNDI 名 |
POSTGRESQL_MAX_CONNECTIONS | 許可されるクライアント接続の最大数。これにより、準備済みトランザクションの最大数も設定します。 |
POSTGRESQL_SHARED_BUFFERS | データのキャッシュに使用する PostgreSQL 専用のメモリー容量を設定します。 |
5.2.5. 一般的な S2I イメージ (eap64 および eap71) 用のテンプレート変数
変数 | 説明 |
---|---|
APPLICATION_NAME | アプリケーションの名前。 |
ARTIFACT_DIR | アーティファクトディレクトリー。 |
AUTO_DEPLOY_EXPLODED | デプロイメント形式のデプロイメントコンテンツが自動的にデプロイされるかどうかを制御します。 |
CONTEXT_DIR | ビルドする Git プロジェクト内のパス。ルートプロジェクトディレクトリーの場合は空になります。 |
GENERIC_WEBHOOK_SECRET | 汎用ビルドのトリガーシークレット。 |
GITHUB_WEBHOOK_SECRET | GitHub トリガーシークレット。 |
HORNETQ_CLUSTER_PASSWORD | HornetQ クラスター管理者パスワード。 |
HORNETQ_QUEUES | キューの名前。 |
HORNETQ_TOPICS | トピック名。 |
HOSTNAME_HTTP | http サービスルートのカスタムホスト名。デフォルトのホスト名 (例: <application-name>.<project>.<default-domain-suffix>) は空白のままにします。 |
HOSTNAME_HTTPS | https サービスルートのカスタムホスト名。デフォルトのホスト名 (例: <application-name>.<project>.<default-domain-suffix>) は空白のままにします。 |
HTTPS_KEYSTORE_TYPE | キーストアファイルのタイプ (JKS または JCEKS)。 |
HTTPS_KEYSTORE | シークレット内のキーストアファイルの名前。HTTPS_PASSWORD および HTTPS_NAME とともに定義されている場合は、HTTPS を有効にし、SSL 証明書の鍵ファイルを $JBOSS_HOME/standalone/configuration 下の相対パスに設定します。 |
HTTPS_NAME | サーバー証明書に関連付けられた名前 (例: jboss)。HTTPS_PASSWORD および HTTPS_KEYSTORE とともに定義された場合は、HTTPS を有効にし、SSL 名を設定します。 |
HTTPS_PASSWORD | キーストアおよび証明書のパスワード (例: mykeystorepass)。HTTPS_NAME および HTTPS_KEYSTORE とともに定義された場合は、HTTPS を有効にし、SSL キーパスワードを設定します。 |
HTTPS_SECRET | キーストアファイルが含まれるシークレットの名前。 |
IMAGE_STREAM_NAMESPACE | Red Hat ミドルウェアイメージの ImageStreams がインストールされている namespaceこれらの ImageStream は通常 openshift 名前空間にインストールされます。ImageStreams を別の名前空間またはプロジェクトでインストールした場合に限り、これを変更する必要があります。 |
JGROUPS_CLUSTER_PASSWORD | JGroups クラスターパスワード。 |
JGROUPS_ENCRYPT_KEYSTORE | シークレット内のキーストアファイルの名前。 |
JGROUPS_ENCRYPT_NAME | サーバー証明書に関連付けられた名前 (例: secret-key)。 |
JGROUPS_ENCRYPT_PASSWORD | キーストアおよび証明書のパスワード (password など)。 |
JGROUPS_ENCRYPT_SECRET | キーストアファイルが含まれるシークレットの名前。 |
SOURCE_REPOSITORY_REF | Git ブランチ/タグ参照。 |
SOURCE_REPOSITORY_URL | アプリケーションの Git ソース URI。 |
5.2.6. 自動クライアント登録用に、eap64-sso-s2i および eap71-sso-s2i に固有のテンプレート変数
変数 | 説明 |
---|---|
SSO_URL | Red Hat Single Sign-On サーバーの場所。 |
SSO_REALM | この環境変数を指定すると、Red Hat Single Sign-On サーバーに作成されるレルムの名前。 |
SSO_USERNAME | Red Hat Single Sign-On サービスへのアクセスに使用されるユーザー名。これは、指定の Red Hat Single Sign-On レルム内にアプリケーションクライアントを作成するために使用されます。これは、sso76- テンプレートのいずれかで指定された SSO_SERVICE_USERNAME と一致する必要があります。 |
SSO_PASSWORD | Red Hat Single Sign-On サービスユーザーのパスワード |
SSO_PUBLIC_KEY | Red Hat Single Sign-On 公開鍵。公開鍵は、中間者によるセキュリティー攻撃を回避するために、テンプレートに渡すことが推奨されます。 |
SSO_SECRET | 機密アクセスのための Red Hat Single Sign-On クライアントシークレット。 |
SSO_SERVICE_URL | Red Hat Single Sign-On サービスの場所。 |
SSO_TRUSTSTORE_SECRET | トラストストアファイルが含まれるシークレットの名前。sso-truststore-volume ボリュームに使用します。 |
SSO_TRUSTSTORE | シークレット内のトラストストアファイルの名前。 |
SSO_TRUSTSTORE_PASSWORD | トラストストアと証明書のパスワード。 |
SSO_BEARER_ONLY | Red Hat Single Sign-On クライアントアクセスタイプ。 |
SSO_DISABLE_SSL_CERTIFICATE_VALIDATION | true の場合は、EAP と Red Hat Single Sign-On Server 間の SSL 通信が安全ではない場合 (つまり、curl で証明書の検証が無効なっている場合) |
SSO_ENABLE_CORS | Red Hat Single Sign-On アプリケーションの CORS を有効にします。 |
5.2.7. SAML クライアントでの自動クライアント登録用に、eap64-sso-s2i および eap71-sso-s2i に固有のテンプレート変数
変数 | 説明 |
---|---|
SSO_SAML_CERTIFICATE_NAME | サーバー証明書に関連付けられた名前。 |
SSO_SAML_KEYSTORE_PASSWORD | キーストアおよび証明書のパスワード。 |
SSO_SAML_KEYSTORE | シークレット内のキーストアファイルの名前。 |
SSO_SAML_KEYSTORE_SECRET | キーストアファイルが含まれるシークレットの名前。 |
SSO_SAML_LOGOUT_PAGE | SAML アプリケーションの Red Hat Single Sign-On のログアウトページ。 |