イメージの実行
サポートポリシー
Docker
TIBCO EBX® Container Edition は、Docker Engine バージョン 20.10 でテストされています。
Kubernetes
現在の EBX® Container Edition リリースは、認定された Kubernetes 実装バージョン 1.26 および Red Hat® OpenShift® 4.13.1 でテストされました。
EBX® Container Edition の Helm チャートサンプルが GitHub から提供されています。
詳細については、https://github.com/TIBCOSoftware/ebx-container-edition を参照してください。
EBX® の開始
初回起動アシスタント
埋め込み H2 データベースを含むデフォルト構成で EBX® を起動するには、次のコマンドを実行します。
docker run -p 8080:8080 -d ebx:6.2.3
ブラウザーを使用して、URL http://localhost:8080 で EBX® に接続できます。これにより、EBX® の構成に役立つ初回起動アシスタントが表示されます。
初回起動アシスタントの詳細については、初期化と初回起動アシスタントの章を参照してください。
自動初期化
最初の起動時に自動初期化と埋め込み H2 データベースを使用して EBX® を起動するには、次のコマンドを実行します。
docker run -d -p 8080:8080 \
-e "EBX_FLA_DISABLED=true" \
-e "EBX_INSTALL_ADMIN_PASSWORD=<password>" \
-e "EBX_INSTALL_LICENSE=XXXXX-XXXXX-XXXXX-XXXXX" \
ebx:6.2.3
EBX® リポジトリは、最初の起動時に自動的に作成されます。
ブラウザーを使用して、URL http://localhost:8080 で EBX® に接続できます。これにより、EBX® ログイン画面が表示されます。管理者のユーザー名は admin で、パスワードは前のコマンドで指定したものです。
注意
管理者に別のユーザー名を指定することができます。詳細については、初回起動時のリポジトリの自動インストール を参照してください。
サポートされるブラウザー
サポートされているブラウザーの詳細については、サポートされる Web ブラウザー を参照してください。
コンテナへのアクセス
次のコマンドは、デフォルトユーザーを使用して EBX® コンテナ内で bash シェルを開始します。
docker exec -it <container-id> bash
root として接続するには、次のコマンドを使用します。
docker exec -it --user root <container-id> bash
環境変数
この章では、EBX® Container Edition でサポートされている環境変数について説明します。
すべてオプションです。
初回起動アシスタントの無効化
セキュリティ上の理由から、すべての状況で初回起動アシスタントを無効にすることをお勧めします。
これは、環境変数 EBX\_FLA\_DISABLED を true にすることで設定されます。
初回起動時のリポジトリの自動インストール
リポジトリがまだ初期化されておらず、初回起動アシスタントが無効になっている場合、次の必須変数が指定されていれば、EBX® は自動的にインストールをトリガーします。
| 名称 | デフォルト | 説明 |
|---|---|---|
| EBX\_INSTALL\_ADMIN\_LOGIN | admin | EBX® 管理者のログイン名を設定します。 リポジトリ変数 EBX\_FLA\_DISABLED の値が true でない場合、またはリポジトリがすでに初期化されている場合、このパラメーターは無視されます。 |
| EBX\_INSTALL\_ADMIN\_PASSWORD | EBX® 管理者のログイン名を設定します。 このパラメーターは、EBX\_FLA\_DISABLED の値が true の場合は必須であり、リポジトリ変数 EBX\_FLA\_DISABLED の値が true でない場合や、リポジトリがすでに初期化されている場合は無視されます。 | |
| EBX\_INSTALL\_LICENSE | EBX® ライセンスキーがまだ定義されていない場合に設定します。 |
注意
必須変数が指定されていない場合、EBX® はエラーメッセージを表示します。
例
リポジトリを自動的にインストールするには、次のコマンドを使用して EBX® を起動します。
docker run -d -p 8080:8080 \
-e "EBX_FLA_DISABLED=true" \
-e "EBX_INSTALL_ADMIN_LOGIN=<login-name>" \
-e "EBX_INSTALL_ADMIN_PASSWORD=<password>" \
-e "EBX_INSTALL_LICENSE=XXXXX-XXXXX-XXXXX-XXXXX" \
ebx:6.2.3
EBX® ライセンスキーの定義
専用のライセンスキーで EBX® を起動するには、次のコマンドを実行します。
docker run -d -p 8080:8080 \
-e "EBX_INSTALL_LICENSE=XXXXX-XXXXX-XXXXX-XXXXX" \
ebx:6.2.3
注意: EBX\_INSTALL\_LICENSE は、ライセンスキーが永続化された場所にすでに定義されている場合、無視されます。
ライセンスキーは、/ebx/data/ebx-license.properties の場所に永続化されます。
詳細については、ボリューム を参照してください。
EBX® 実行モード
このプロパティは、EBX® の実行方法を定義します。
| 名称 | デフォルト | 説明 |
|---|---|---|
| EBX\_BACKEND\_MODE | 開発 | 3 つの実行モードが利用可能です: 開発、統合、本番。 |
docker run -d -p 8080:8080 \
-e "EBX_BACKEND_MODE=production" \
ebx:6.2.3
詳細については、EBX® 実行モード を参照してください。
URL 構成
一部の EBX® 機能では、URL を生成する必要があります。これを行うには、特定の構成が必要になる場合があります。たとえば、EBX® がリバースプロキシの背後または Kubernetes クラスターで実行されている場合です。
| 名称 | デフォルト | 説明 |
|---|---|---|
| EBX\_IS\_SECURED | 着信リクエストが HTTPS の場合、「true」が想定され、そうでない場合は「false」が想定されます。 | 「true」の場合、プロトコル「HTTPS」が常に想定されます。この値は、コンテナがリバースプロキシ、ファイアウォール、または HTTPS 暗号化を処理する Ingress の背後にある場合に役立ちます。 これにより、EBX 認証 Cookie も secure に設定されます。 これは、最新のブラウザーを使用しているユーザーは HTTP を使用してログインできないことを意味します。 「false」の場合、プロトコル「HTTP」が想定されます。 |
| EBX\_AUTHENTICATION\_REDIRECT\_TO\_HTTPS | デフォルトは「false」です。 | 「true」の場合、ログインフォームへの受信リクエストが HTTP であれば、HTTPS を強制するためにリダイレクトが発生します。 コンテナがリバースプロキシ、ファイアウォール、または HTTPS 暗号化を処理する Ingress の背後にある場合は、このプロパティを false に設定する必要があります。 |
| EBX\_HOSTNAME | 着信 HTTP(S) リクエストによって指定されたホスト名 | EBX® サーバーのホスト名 |
| EBX\_PORT | 着信 HTTP リクエストによって指定されたポート番号。 | EBX® サーバーの HTTP ポート番号。 |
| EBX\_PORT\_SECURED | 着信 HTTPS リクエストによって指定されたポート番号。 | EBX® サーバーの HTTPS ポート番号。 注意 HTTPS サポートは、暗号化を処理するリバースプロキシまたは Ingress によって提供される必要があります。 |
| EBX\_ROOT\_PATH | デフォルトでは、コンテキストパスは空です。 | 設定すると、すべての EBX® URL にこの値がプレフィックスとして付けられます。値が / の場合を除き、値には先頭に / を付ける必要があり、末尾に / を付けることはできません。 たとえば、有効な値は /mdm/sales です。 この変数の設定は、同じホスト名で EBX の複数のインスタンスを実行する場合に役立ちます。 |
| EBX\_URL\_DEFAULT | この環境変数は、バックグラウンドタスクが EBX への URL を計算する必要がある場合に使用されます。 パスコンポーネントを含まない完全な URL に設定する必要があります (EBX\_ROOT\_PATH はパスコンポーネントに適用されます)。 たとえば、有効な値は https://host_name です。 EBX\_URL\_DEFAULT が無指定で、かつ EBX\_HOSTNAME が指定されている場合、デフォルトは次の仮定に基づいて計算されます。 - EBX\_IS\_SECURED が true の場合、ポート番号が EBX\_PORT\_SECURED (デフォルトは 443) に等しい HTTPS が想定されます。 - EBX\_IS\_SECURED が false または設定されていない場合は、ポート番号が EBX\_PORT (デフォルトは 80) に等しい HTTP が想定されます。 |
EBX® データベース接続
サポートされているデータベースについては、サポートされるデータベースの章を参照してください。
デフォルトでは、埋め込みの H2 データベースが使用されます。この H2 データベースのデータは、場所 /ebx/data/h2 に保持されます。
外部データベースは、次の変数を使用して構成できます。
| 名称 | 同等の TIBCO EBX® メイン構成ファイル | 説明 |
|---|---|---|
| EBX\_DB\_FACTORY | ebx.persistence.factory | データベースサーバーの種類を指定します。 |
| EBX\_DB\_URL | ebx.persistence.url | JDBC URL。形式は次のとおりです: jdbc:<dialect>://<database\_host>:<database\_port\_number>/<database\_name>。 |
| EBX\_DB\_USER | ebx.persistence.user | データベースのユーザー ID |
| EBX\_DB\_PASSWORD | ebx.persistence.password | データベースユーザーのパスワード |
これらの変数の詳細については、EBX® リポジトリの構成の章の TIBCO EBX® メイン構成ファイルに相当するものを参照してください。
注意
コンテナには、H2、PostgreSQL、Microsoft SQL Server 用の JDBC ドライバーのみが含まれています。EBX® でサポートされている他のデータベースを使用するには、ドライバーを追加する必要があります。
ドライバーを追加する方法については、新しい JDBC ドライバーの追加を参照してください。
EBX® を JNDI データソースを使用するように構成できます。詳細については、JNDI でのデータベースの構成 を参照してください。
例
PostgreSQL データベースに接続する EBX® のインスタンスを起動するには、次のコマンドを実行します。
docker run -d -p 8080:8080 \
-e "EBX_DB_FACTORY=postgresql" \
-e "EBX_DB_URL=jdbc:postgresql://<database_host>:<database_port>/<database_name>" \
-e "EBX_DB_USER=<user_name>" \
-e "EBX_DB_PASSWORD=<user_password>" \
ebx:6.2.3
メタデータ分類子データベース接続
メタデータ分類子は、SQLAlchemy ツールキットを使用してデータベースに接続します。SQLAlchemy ツールキットは、ほとんどの一般的なデータベースをサポートしています。
デフォルトでは、埋め込み SQLite データベースが使用されます。この SQLite データベースのデータは、/ebx/data/sqlite/ebx-metadata-classifier.db の場所に永続化されます。
外部データベースは、次の変数を使用して構成できます。
| 名称 | 説明 |
|---|---|
| EBX\_METADATA\_CLASSIFIER\_DB\_URL | 資格情報なしの SQLAlchemy URL。形式は次のとおりです: <dialect>://<database\_host>:<database\_port>/<database\_name>。 |
| EBX\_METADATA\_CLASSIFIER\_DB\_USER | データベースのユーザー ID |
| EBX\_METADATA\_CLASSIFIER\_DB\_PASSWORD | データベースユーザーのパスワード |
コンテナには、デフォルトデータベース (SQLite) 用のドライバーのみが含まれています。SQLAlchemy でサポートされている他のデータベースを使用するには、ドライバーを追加する必要があります。
ドライバーを追加する方法については、メタデータ分類子データベース用のドライバーの追加 を参照してください。
例
PostgreSQL データベースに接続する Metadata のインスタンスを起動するには、次のコマンドを実行します。
docker run -d -p 8080:8080 \
-e "EBX_METADATA_CLASSIFIER_DB_URL=postgresql://<database_host>:<database_port>/<database_name>" \
-e "EBX_METADATA_CLASSIFIER_DB_USER=<user_name>" \
-e "EBX_METADATA_CLASSIFIER_DB_PASSWORD=<user_password>" \
ebx:6.2.3
注意
-
メタデータ分類子データベース名 (database\_name) は、データベース接続 と同じにすることができます。
-
特定のデータベース API ドライバーの使用方法と、接続 URL で特殊文字をエスケープする方法については、SQLAlchemy のドキュメントを参照してください。
-
H2 データベースは SQLAlchemy ではサポートされていません。
ディレクトリ接続
EBX® ディレクトリは、次の環境変数を使用して構成できます。
| 名称 | 同等の TIBCO EBX® メイン構成ファイル | 説明 |
|---|---|---|
| EBX\_DIRECTORY\_FACTORY | ebx.directory.factory | Java ディレクトリファクトリクラス名を指定します (オプション)。 |
| EBX\_DIRECTORY\_SYNCHRONIZED\_SOURCE | ebx.directory.synchronized.source | 同期ディレクトリの実装 (LDAP、SCIM、または OnLogin) を有効にして指定します。 |
| EBX\_SSO\_PROTOCOL | ebx.directory.sso.protocol | SSO プロトコル (OIDC または SAML2) を有効にして指定します。 |
詳細については、ユーザーおよびロールディレクトリの構成 を参照してください。
同期ディレクトリ
EBX® 同期ディレクトリは、次の環境変数を使用して構成できます。
| 名称 | 同等の TIBCO EBX® メイン構成ファイル (スペースは削除する必要があります) |
|---|---|
| EBX\_DIRECTORY\_SYNCHRONIZED\_ROLE\_MAPPER | ebx.directory.synchronized. role.mapper |
| EBX\_DIRECTORY\_SYNCHRONIZED\_ROLE\_MAPPER\_DEFAULT\_ADMINISTRATOR | ebx.directory.synchronized. role.mapper.default. administrator |
| EBX\_DIRECTORY\_SYNCHRONIZED\_ROLE\_MAPPER\_DEFAULT\_READ\_ONLY | ebx.directory.synchronized. role.mapper.default. read\_oly |
| EBX\_DIRECTORY\_SYNCHRONIZED\_MAPPING\_LDAP\_ATTRIBUTES | ebx.directory.synchronized. mapping.ldap.attributes |
| EBX\_DIRECTORY\_SYNCHRONIZED\_SSO\_MAPPING\_SAML2\_ATTRIBUTES\_ROLE\_NAME | ebx.directory.synchronized. sso.mapping.saml2. attributes.role.name |
| EBX\_DIRECTORY\_SYNCHRONIZED\_SSO\_MAPPING\_SAML2\_ATTRIBUTES | ebx.directory.synchronized. sso.mapping.saml2. attributes |
| EBX\_DIRECTORY\_SYNCHRONIZED\_SSO\_MAPPING\_OIDC\_CLAIMS\_ROLE\_NAME | ebx.directory.synchronized. sso.mapping.oidc. claims.role.name |
| EBX\_DIRECTORY\_SYNCHRONIZED\_SSO\_MAPPING\_OIDC\_CLAIMS | ebx.directory.synchronized. sso.mapping.oidc. claims |
| EBX\_DIRECTORY\_SYNCHRONIZED\_SSO\_MAPPING\_BEARER\_CLAIMS\_ROLE\_NAME | ebx.directory.synchronized. sso.mapping.bearer. claims.role.name |
| EBX\_DIRECTORY\_SYNCHRONIZED\_SSO\_MAPPING\_BEARER\_CLAIMS | ebx.directory.synchronized. sso.mapping.bearer. claims |
| EBX\_DIRECTORY\_SYNCHRONIZED\_SSO\_MAPPING\_ATTRIBUTE.MAIL | ebx.directory.synchronized. sso.mapping.attribute. mail |
| EBX\_DIRECTORY\_SYNCHRONIZED\_SSO\_DISPLAY\_USER | ebx.directory.synchronized. sso.display.user |
| EBX\_DIRECTORY\_SYNCHRONIZED\_SSO\_LISTENERS | ebx.directory.synchronized. sso.listeners |
LDAP 接続
既存の LDAP ディレクトリへの EBX® 統合は、次の環境変数を使用して構成できます。
| 名称 | 同等の TIBCO EBX® メイン構成ファイル (スペースは削除する必要があります) |
|---|---|
| EBX\_LDAP\_DEFAULT\_HOSTNAME | ebx.directory.ldap.default.hostName |
| EBX\_LDAP\_DEFAULT\_PORT | ebx.directory.ldap.default.port |
| EBX\_LDAP\_DEFAULT\_CONNECTION\_TIMEOUT | ebx.directory.ldap.default. connectionTimeOutInSeconds |
| EBX\_LDAP\_DEFAULT\_BIND\_DN\_OR\_USER | ebx.directory.ldap.default.bindDnOrUser |
| EBX\_LDAP\_DEFAULT\_BIND\_PASSWORD | ebx.directory.ldap.default.bindPassword |
| EBX\_LDAP\_DEFAULT\_AUTHENTICATION\_METHOD | ebx.directory.ldap.default. authenticationMethod |
| EBX\_LDAP\_DEFAULT\_ENCRYPTION\_METHOD | ebx.directory.ldap.default. encryptionMethod |
| EBX\_LDAP\_DEFAULT\_MAPPING\_ROLE\_REFERENCE\_ATTRIBUTE | ebx.directory.ldap.default.mapping. role.referenceAttribute |
| EBX\_LDAP\_DEFAULT\_MAPPING\_ROLE\_MEMBER\_ATTRIBUTE | ebx.directory.ldap.default.mapping. role.memberAttribute |
| EBX\_LDAP\_DEFAULT\_MAPPING\_USER\_REFERENCE\_ATTRIBUTE | ebx.directory.ldap.default.mapping. user.referenceAttribute |
| EBX\_LDAP\_DEFAULT\_MAPPING\_USER\_REFERENCE\_COMPONENT\_DN | ebx.directory.ldap.default.mapping. user.referenceComponentInDN |
| EBX\_LDAP\_DEFAULT\_MAPPING\_ROLE\_MAIL\_ATTRIBUTE | ebx.directory.ldap.default.mapping. role.mailAttribute |
| EBX\_LDAP\_DEFAULT\_MAPPING\_USER\_MAIL\_ATTRIBUTE | ebx.directory.ldap.default.mapping. user.mailAttribute |
| EBX\_LDAP\_DEFAULT\_DISPLAY\_ROLE | ebx.directory.ldap.default.display.role |
| EBX\_LDAP\_DEFAULT\_DISPLAY\_USER | ebx.directory.ldap.default.display.user |
| EBX\_LDAP\_DEFAULT\_DISPLAY\_USER\_ALL | ebx.directory.ldap.default.display.user.all |
USER\_SEARCH、USER\_GROUPS\_SEARCH、ALL\_USERS\_SEARCH、ALL\_GROUPS\_SEARCH の各リクエストは、次の環境変数を使用して構成できます。
たとえば、USER\_SEARCH リクエストは次のようになります。
| 名称 | 同等の TIBCO EBX® メイン構成ファイル (スペースは削除する必要があります) |
|---|---|
| EBX\_LDAP\_DEFAULT\_REQUEST\_USER\_SEARCH\_BASEDN | ebx.directory.ldap.default.request. userSearch.baseDN |
| EBX\_LDAP\_DEFAULT\_REQUEST\_USER\_SEARCH\_FILTER | ebx.directory.ldap.default.request. userSearch.filter |
| EBX\_LDAP\_DEFAULT\_REQUEST\_USER\_SEARCH\_SCOPE | ebx.directory.ldap.default.request. userSearch.scope |
| EBX\_LDAP\_DEFAULT\_REQUEST\_USER\_SEARCH\_CACHE\_EXPIRATION | ebx.directory.ldap.default.request. userSearch.cache.expirationInSeconds |
| EBX\_LDAP\_DEFAULT\_REQUEST\_USER\_SEARCH\_CACHE\_REFRESH | ebx.directory.ldap.default.request. userSearch.cache.refreshInSeconds |
| EBX\_LDAP\_DEFAULT\_REQUEST\_USER\_SEARCH\_CACHE\_MAX\_SIZE | ebx.directory.ldap.default.request. userSearch.cache.maxSize |
| EBX\_LDAP\_DEFAULT\_REQUEST\_USER\_SEARCH\_PAGE\_SIZE | ebx.directory.ldap.default.request. userSearch.pageSize |
| EBX\_LDAP\_DEFAULT\_REQUEST\_USER\_SEARCH\_TIME\_LIMIT | ebx.directory.ldap.default.request. userSearch.timeLimitInSeconds |
詳細については、組み込み LDAP ディレクトリ を参照してください。
例
LDAP 接続でインスタンスを起動するには、次のコマンドを実行します。
docker run -d -p 8080:8080 \
-e "EBX_DIRECTORY_FACTORY=com.orchestranetworks.service.directory.ldap.LdapDirectoryFactory" \
-e "EBX_LDAP_DEFAULT_HOSTNAME=localhost" \
-e "EBX_LDAP_DEFAULT_PORT=389" \
-e "EBX_LDAP_DEFAULT_MAPPING_ROLE_REFERENCE_ATTRIBUTE=cn" \
-e "EBX_LDAP_DEFAULT_MAPPING_ROLE_MEMBER_ATTRIBUTE=member" \
-e "EBX_LDAP_DEFAULT_MAPPING_USER_REFERENCE_ATTRIBUTE=uid" \
-e "EBX_LDAP_DEFAULT_DISPLAY_ROLE={{cn}}" \
-e "EBX_LDAP_DEFAULT_DISPLAY_USER={{cn}} ({{mail}})" \
-e "EBX_LDAP_DEFAULT_DISPLAY_USER_ALL=true
-e "EBX_LDAP_DEFAULT_REQUEST_USER_SEARCH_BASEDN=dc=example,dc=org" \
-e "EBX_LDAP_DEFAULT_REQUEST_USER_SEARCH_FILTER=(uid={{login}})" \
-e "EBX_LDAP_DEFAULT_REQUEST_USER_GROUPS_SEARCH_BASEDN=dc=example,dc=org" \
-e "EBX_LDAP_DEFAULT_REQUEST_USER_GROUPS_SEARCH_FILTER=(&(objectClass=groupOfNames)(member={{dn}}))" \
-e "EBX_LDAP_DEFAULT_REQUEST_ALL_GROUPS_SEARCH_BASEDN=dc=example,dc=org" \
-e "EBX_LDAP_DEFAULT_REQUEST_ALL_GROUPS_SEARCH_FILTER=(objectClass=groupOfNames)" \
-e "EBX_LDAP_DEFAULT_REQUEST_ALL_USERS_SEARCH_BASEDN=dc=example,dc=org" \
-e "EBX_LDAP_DEFAULT_REQUEST_ALL_USERS_SEARCH_FILTER=(objectClass=inetOrgPerson)" \
ebx:6.2.3
注意
LDAP ディレクトリを有効にするには、EBX\_DIRECTORY\_FACTORY を com.orchestranetworks.service.directory.ldap.LdapDirectoryFactory に定義する必要があります。
SSO SAML 2.0 接続
EBX® シングルサインオン (SSO) SAML 2.0 組み込みは、次の環境変数を使用して構成できます。
| 名称 | 同等の TIBCO EBX® メイン構成ファイル |
|---|---|
| EBX\_SAML2\_DEFAULT\_SP\_BASE\_URL | ebx.directory.saml2.default.sp.base.url |
| EBX\_SAML2\_DEFAULT\_SP\_ENTITY\_ID | ebx.directory.saml2.default.sp.entity.id |
| EBX\_SAML2\_DEFAULT\_KEYSTORE\_URI | ebx.directory.saml2.default.keystore.uri |
| EBX\_SAML2\_DEFAULT\_KEYSTORE\_TYPE | ebx.directory.saml2.default.keystore.type |
| EBX\_SAML2\_DEFAULT\_KEYSTORE\_PATH | ebx.directory.saml2.default.keystore.path |
| EBX\_SAML2\_DEFAULT\_KEYSTORE\_PASSWORD | ebx.directory.saml2.default.keystore.password |
| EBX\_SAML2\_DEFAULT\_KEYSTORE\_KEY\_ALIAS | ebx.directory.saml2.default.keystore.key.alias |
| EBX\_SAML2\_DEFAULT\_KEYSTORE\_KEY\_PASSWORD | ebx.directory.saml2.default.keystore.key.password |
| EBX\_SAML2\_DEFAULT\_NAME\_ID\_ATTRIBUTE | ebx.directory.saml2.default.name.id.attribute |
| EBX\_SAML2\_DEFAULT\_NAME\_ID\_FORMAT | ebx.directory.saml2.default.name.id.format |
| EBX\_SAML2\_DEFAULT\_AUTHN\_REQUESTS\_SIGNED | ebx.directory.saml2.default.authn.requests.signed |
| EBX\_SAML2\_DEFAULT\_WANT\_ASSERTIONS\_SIGNED | ebx.directory.saml2.default.want.assertions.signed |
| EBX\_SAML2\_DEFAULT\_WANT\_RESPONSES\_SIGNED | ebx.directory.saml2.default.want.responses.signed |
| EBX\_SAML2\_DEFAULT\_SP\_LOGOUT\_REQUEST\_SIGNED | ebx.directory.saml2.default.sp.logout.request.signed |
詳細については、SAML 2.0 を参照してください。
SSO OpenID Connect 接続
EBX® シングルサインオン (SSO) OpenID Connect 組み込みは、次の環境変数を使用して構成できます。
| 名称 | 同等の TIBCO EBX® メイン構成ファイル |
|---|---|
| EBX\_OIDC\_DEFAULT\_CLIENT\_BASE\_URL | ebx.directory.oidc.default.client.base.url |
| EBX\_OIDC\_DEFAULT\_CLIENT\_ID | ebx.directory.oidc.default.client.id |
| EBX\_OIDC\_DEFAULT\_CLIENT\_SECRET | ebx.directory.oidc.default.client.secret |
| EBX\_OIDC\_DEFAULT\_DISCOVERY\_URI | ebx.directory.oidc.default.discovery.uri |
| EBX\_OIDC\_DEFAULT\_CLAIM\_USERNAME | ebx.directory.oidc.default.claim.username |
| EBX\_OIDC\_DEFAULT\_HTTP\_CONNECT\_TIMEOUT | ebx.directory.oidc.default.http.connect.timeout |
| EBX\_OIDC\_DEFAULT\_HTTP\_READ\_TIMEOUT | ebx.directory.oidc.default.http.read.timeout |
詳細については、OpenID Connect を参照してください。
ベアラー認証
EBX® ベアラー認証は、次の環境変数を使用して構成できます。
| 名称 | 同等の TIBCO EBX® メイン構成ファイル (スペースは削除する必要があります) |
|---|---|
| EBX\_BEARER\_DEFAULT\_ENABLED | ebx.directory.bearer.default.enabled |
| EBX\_BEARER\_DEFAULT\_JWT\_JWKS\_URI | ebx.directory.bearer.default. jwt.jwks.uri |
| EBX\_BEARER\_DEFAULT\_JWT\_ISSUERS | ebx.directory.bearer.default. jwt.issuers |
| EBX\_BEARER\_DEFAULT\_SCOPE\_DATASERVICES | ebx.directory.bearer.default. scope.dataservices |
| EBX\_BEARER\_DEFAULT\_JWT\_CLAIM\_USERNAME | ebx.directory.bearer.default. jwt.claim.username |
| EBX\_BEARER\_DEFAULT\_JWT\_ENCRYPTION\_ENABLED | ebx.directory.bearer.default. jwt.encryption.enabled |
| EBX\_BEARER\_DEFAULT\_JWT\_ENCRYPTION\_KEY\_URI | ebx.directory.bearer.default. jwt.encryption.key.uri |
| EBX\_BEARER\_DEFAULT\_JWT\_ENCRYPTION\_KEYSTORE\_TYPE | ebx.directory.bearer.default. jwt.encryption.keystore.type |
| EBX\_BEARER\_DEFAULT\_JWT\_ENCRYPTION\_KEYSTORE\_PATH | ebx.directory.bearer.default. jwt.encryption.keystore.path |
| EBX\_BEARER\_DEFAULT\_JWT\_ENCRYPTION\_KEYSTORE\_PASSWORD | ebx.directory.bearer.default. jwt.encryption.keystore.password |
| EBX\_BEARER\_DEFAULT\_JWT\_ENCRYPTION\_KEYSTORE\_KEY\_ALIAS | ebx.directory.bearer.default. jwt.encryption.keystore.key.alias |
| EBX\_BEARER\_DEFAULT\_JWT\_ENCRYPTION\_KEYSTORE\_KEY\_PASSWORD | ebx.directory.bearer.default. jwt.encryption.keystore.key.password |
| EBX\_BEARER\_DEFAULT\_INTROSPECTION\_REQUEST | ebx.directory.bearer.default. introspection.request |
詳細については、ベアラー認証 プロパティを参照してください。
SCIM ディレクトリ
EBX® SCIM ディレクトリは、次の環境変数を使用して構成できます。
| 名称 | 同等の TIBCO EBX® メイン構成ファイル (スペースは削除する必要があります) |
|---|---|
| EBX\_SCIM\_DEFAULT\_REQUEST\_USERS\_URL | ebx.directory.scim.default.request.users.url |
| EBX\_SCIM\_DEFAULT\_REQUEST\_USERS\_HEADERS | ebx.directory.scim.default.request.users.headers |
| EBX\_SCIM\_DEFAULT\_REQUEST\_USERS\_PAGE\_SIZE | ebx.directory.scim.default.request.users.page.size |
| EBX\_SCIM\_DEFAULT\_REQUEST\_USERS\_CACHE\_MAX\_SIZE | ebx.directory.scim.default.request.users.cache. max.size |
| EBX\_SCIM\_DEFAULT\_REQUEST\_USERS\_CACHE\_EXPIRATION | ebx.directory.scim.default.request.users.cache. expiration |
| EBX\_SCIM\_DEFAULT\_REQUEST\_GROUPS\_URL | ebx.directory.scim.default.request.groups.url |
| EBX\_SCIM\_DEFAULT\_REQUEST\_GROUPS\_HEADERS | ebx.directory.scim.default.request.groups.headers |
| EBX\_SCIM\_DEFAULT\_REQUEST\_GROUPS\_PAGE\_SIZE | ebx.directory.scim.default.request.groups.page.size |
| EBX\_SCIM\_DEFAULT\_REQUEST\_GROUPS\_CACHE\_MAX\_SIZE | ebx.directory.scim.default.request.groups.cache. max.size |
| EBX\_SCIM\_DEFAULT\_REQUEST\_GROUPS\_CACHE\_EXPIRATION | ebx.directory.scim.default.request.groups.cache. expiration |
詳細については、SCIM 機能 プロパティを参照してください。
メール接続
EBX メールサービスは、次の環境変数を使用して構成できます。
| 名称 | 同等の TIBCO EBX® メイン構成ファイル | デフォルト | 説明 |
|---|---|---|---|
| EBX\_SMTP\_HOST | ebx.mail.smtp.host | SMTP サーバーのホスト名 | |
| EBX\_SMTP\_PORT | ebx.mail.smtp.port | SMTP サーバーのポート番号 | |
| EBX\_SMTP\_CONNECTION\_TIMEOUT | ebx.mail.smtp.connectionTimeout | 600000 | SMTP ソケット接続のタイムアウト値 (ミリ秒)。 |
| EBX\_SMTP\_TIMEOUT | ebx.mail.smtp.timeout | 600000 | SMTP ソケット読み取りタイムアウト値 (ミリ秒)。 |
| EBX\_SMTP\_WRITE\_TIMEOUT | ebx.mail.smtp.writeTimeout | 600000 | SMTP ソケット書き込みタイムアウト値 (ミリ秒)。 |
| EBX\_SMTP\_LOGIN | ebx.mail.smtp.login | SMTP サーバーのログイン ID | |
| EBX\_SMTP\_PASSWORD | ebx.mail.smtp.password | SMTP サーバーのログインパスワード | |
| EBX\_SMTP\_SSL\_ENABLED | ebx.mail.smtp.ssl.activate | true | SSL を有効にします。値は「true」または「false」にすることができます。 |
| EBX\_WORKFLOW\_MAIL\_SENDER | ebx.manager.workflow.mail.sender | ワークフローの送信者のメール。設定されていない場合、ワークフローは通知を送信できません。 |
使用されるプロパティの詳細については、SMTP とメールの有効化と構成の章を参照してください。
メモリ構成
環境変数 JAVA\_MEMORY\_PERCENT を使用して、EBX® を実行する JVM に割り当てられるコンテナメモリの割合を構成できます。0 から 100 の整数値にする必要があります。
設定されていない場合、起動時にデフォルト値が使用されます。
注意
この変数は高度な使用法のためのものです。設定が低すぎたり高すぎたりすると、ランタイムの問題が発生する可能性があります。
REST サービスの認証
REST サービスの基本認証はデフォルトでは有効になっていません。
この機能を有効にするには、環境変数 EBX\_REST\_AUTHENTICATION\_BASIC を true に設定します。
ステージング
環境変数 EBX\_STAGING\_ACTIVATED は、値が true の場合はステージング機能をアクティブ化し、値が false の場合は非アクティブ化します。
デフォルトでは、ステージングはアクティブ化されています。
構成ファイル
現在、EBX®の構成には 2 つの Java プロパティファイルが使用されています。
起動時に、EBX® は次の順序でプロパティファイルを読み取ります。
-
/opt/ebx/webapps/ebx/WEB-INF/ebx-default.properties
-
/my\_custom/conf/ebx-container.properties
ebx-default.properties ファイル
ファイル /opt/ebx/webapps/ebx/WEB-INF/ebx-default.properties は、コンテナのデフォルトの EBX® 構成プロパティを設定します。
EBX® を次のバージョンに簡単に更新できなくなる可能性があるため、実行時に決して変更しないでください。代わりに /opt/ebx/conf/ebx-container.properties を使用してください。
ebx-container.properties ファイル
ファイル /opt/ebx/conf/ebx-container.properties はデフォルトで空です。ここで指定されたプロパティ値は、ebx-default.properties で設定された値をオーバーライドします。
このファイルは、実行時にプロパティを変更するのに役立ちます。実行時にプロパティを変更するには、新しいファイルを作成します。たとえば、/my\_custom/conf/ebx-container.properties のように、新しいプロパティ値を含み、親フォルダーをホストからコンテナにマウントします。
docker run -v /my-custom/conf:/opt/ebx/conf -p 8080:8080 -d ebx:6.2.3
EBX® でサポートされているプロパティのリストについては、TIBCO EBX® メイン構成ファイル の章を参照してください。
ボリューム
このイメージは、次のボリュームを定義します。
| 位置 | 説明 |
|---|---|
| /ebx/data | EBX® ルートディレクトリはこのボリュームにあります。これには、EBX® インデックスと、H2 埋め込みデータベースが使用されている場合は永続化されたデータが含まれます。 SSD などの高性能ボリュームを使用することをお勧めします。 NFS マウントなどの共有ネットワークボリュームの使用は推奨されず、パフォーマンスと安定性の問題が発生する可能性があります。 |
| /ebx/logs | このボリュームはログファイルに使用されます。 |
| /ebx/temp | このボリュームは一時ファイルに使用されます。 |
すべての専用ボリュームで EBX® を起動するには、次のコマンドを実行します。
docker run -d -p 8080:8080 \
-v /my_custom/data:/ebx/data \
-v /my_custom/logs:/ebx/logs \
-v /my_custom/temp:/ebx/temp \
ebx:6.2.3
注意
ボリューム /ebx/data は、外部データベースが使用されている場合でも永続ボリュームにマップする必要があります。そうでない場合、EBX® は起動時にインデックスを再構築する必要があり、起動時間が大幅に増加する可能性があります。
Linux ユーザーとグループ
コンテナはユーザー ebx (uid 1500) を使用して起動されます。ユーザー ebx のプライマリグループは root (guid 0) です。
注意
Red Hat® OpenShift® は、コンテナの起動時に 1500 以外の UID を使用する場合があります。詳細については、Red Hat® OpenShift® のドキュメントを参照してください。
ホスト構成
EBX コンテナが多数のメモリマップファイルに必要なリソースを予約できるように、ホストを構成する必要がある場合があります。
Linux OS の場合
-
コマンド ulimit -n は、512000 以上の値を返す必要があります。
-
コマンド sysctl vm.max\_map\_count は、 262144 以上の値を返す必要があります。
ログアクセス
ログは stdout および stderr 出力ストリームに送信され、次のコマンドを使用して表示できます。
docker logs <container-id>
EBX® と Tomcat の両方のログが表示されます。
ログファイルは、フォルダー /ebx/logs にもあります。
-
EBX® ログファイルはフォルダー /ebx/logs/ebx にあります。
-
Tomcat ログファイルはフォルダー /ebx/logs/tomcat にあります。