イメージのカスタマイズ
EBX® Container Editionイメージを親イメージとして使用して、カスタマイズされたイメージを作成できます。
Docker ファイルで指定されたユーザー
EBX® Container Edition イメージの Docker ファイルは、ユーザー ebx を指定します。
イメージを拡張する Docker ファイルでは、次のサンプルのように、現在のユーザーを root に設定し、後で ebx に戻す必要がある場合があります。
FROM ebx:6.2.3
USER root
# Do something requiring being root...
USER ebx
デフォルト構成の設定
デフォルトの EBX® 構成の設定は、/opt/ebx/conf/ebx-container.properties に基づくべきではありません。このファイルは、実行時にオーバーライドされる可能性があるためです。
代わりに、Docker ファイルで次のように進めます。
-
ファイル /opt/ebx/webapps/ebx/WEB-INF/ebx-default.properties の名前を、たとえば ebx-default-original.properties に変更します。
-
新しいファイル /opt/ebx/webapps/ebx/WEB-INF/ebx-default.properties コンテナの新しいプロパティ値を作成します。このファイルは、ebx-default-original.properties などの元のプロパティファイルの新しい名前に設定されたプロパティ ebx.file.previous を定義する必要があります。
EBX® でサポートされているプロパティのリストについては、TIBCO EBX® メイン構成ファイル の章を参照してください。
以下は、ロケールを「en-US」に設定したサンプルの Docker ファイルを示しています。
FROM ebx:6.2.3
USER root
RUN mv /opt/ebx/webapps/ebx/WEB-INF/ebx-default.properties \
/opt/ebx/webapps/ebx/WEB-INF/ebx-default-original.properties
RUN echo "ebx.file.previous=ebx-default-original.properties" >> \
/opt/ebx/webapps/ebx/WEB-INF/ebx-default.properties
RUN echo "ebx.locales.available=en-US" >> /opt/ebx/webapps/ebx/WEB-INF/ebx-default.properties
USER ebx
カスタムモジュールの追加
カスタムモジュールを開発することで、EBX® を拡張できます。EBX® モジュールは、XML スキーマドキュメント、Java クラス、静的リソースなどのさまざまなリソースをパッケージ化した標準の Jakarta EE Web アプリケーションです。
EBX® モジュールの詳細については、TIBCO EBX® モジュールのパッケージ化 の章を参照してください。
EBX® Container Editionでは、モジュールを「アンパック (展開)」 WAR として展開することをお勧めします。これにより、起動が速くなり、Tomcat が WAR ファイルを解凍する必要がないため、コンテナサイズが不必要に大きくなるのを防ぐことができます。
モジュールをイメージに追加するための推奨される方法は、次のとおりです。
-
WAR をフォルダー /opt/ebx/webapps にコピーします。前述のように、展開形式が推奨されます。
-
module\_war\_name.xml という名前の関連する Tomcat コンテキスト XML ファイルを作成し、フォルダー /opt/ebx/contexts にコピーします。
-
オプションで、共有 JAR をフォルダー /opt/ebx/lib にコピーします。
Tomcat コンテキスト XML ファイルには次の内容が含まれている必要があります。
<?xml version="1.0" encoding="UTF-8"?>
<Context docBase="${ebx.container.base}/webapps/module_war_name"/>
環境変数 EBX\_ROOT\_PATH を正しくサポートするには、変数 ${ebx.container.base} を使用する必要があります。
Tomcat コンテキストの詳細については、https://tomcat.apache.org/tomcat-10.1-doc/config/context.html#Defining_a_context を参照してください。
以下にサンプルの Docker ファイルを示します。
FROM ebx:6.2.3
USER root
COPY "./module_name.xml" "/opt/ebx/contexts"
COPY "./module_name" "/opt/ebx/webapps"
USER ebx
新しいロケールの追加
1つ以上のロケールを追加するには、言語パックソフトウェアのzipファイルが必要です。以下は、Dockerfile を作成し、ターゲットイメージをビルドするシェルスクリプトです。このスクリプトは、ニーズに合わせて変更できます。
#!/bin/bash
#
# Build a docker image tag including language packs for
# a specified version available from the current folder.
#
# Usage: build.sh <lp-version> <from-tag> <build-tag>
#
set -e
LP_VERSION="$1"
FROM_TAG="$2"
BUILD_TAG="$3"
if (( $# != 3 )); then
echo "Syntax $0 <lp-version> <from-tag> <build-tag>" 1>&2
exit 1
fi
EBX_LOCALES=""
if [ -d files ]; then
rm -rf files
fi
mkdir -p "files/lib"
for zip in TIB_ebx-lp_${LP_VERSION}_addon_*_languagepack*.zip ; do
locale=$(echo ${zip} | sed -e 's/.*languagepack-\([a-zA-Z-]*\).zip/\1/g')
EBX_LOCALES="${EBX_LOCALES},${locale}"
echo unzip locale=${locale}
unzip -oq ${zip}
if [ -d ${locale} ] ; then
mkdir -p "files/webapps/ebx-manager/www/${locale}"
mv "${locale}/" "files/webapps/ebx-manager/www/"
fi
done
mv *.jar "files/lib"
cat > Dockerfile << EOF
FROM ${FROM_TAG}
COPY "files" "/opt/ebx"
USER root
RUN mv "/opt/ebx/webapps/ebx/WEB-INF/ebx-default.properties" \
"/opt/ebx/webapps/ebx/WEB-INF/ebx-default-original.properties" &&\
echo "ebx.file.previous=ebx-default-original.properties" >> \
"/opt/ebx/webapps/ebx/WEB-INF/ebx-default.properties" &&\
echo "ebx.locales.available=en-US,fr-FR${EBX_LOCALES}" >> \
"/opt/ebx/webapps/ebx/WEB-INF/ebx-default.properties"
USER ebx
EOF
docker build -t ${BUILD_TAG} .
echo "To run a container using this image, use command:"
echo " EBX_LOCALES=${EBX_LOCALES}"
echo " docker run -p 8080:8080 -d ${BUILD_TAG}"
この例では、lib とオプションのドキュメントがコピーされ、デフォルト構成の設定セクションで説明されている方法を使用してロケールが設定されます。
新しい JDBC ドライバーの追加
新しい JDBC ドライバーの追加は、新しいライブラリの追加に似ています。正しい権限で「/opt/ebx/lib」フォルダーにある jar ファイルをコピーするだけです。以下は、Oracle JDBCドライバーの例を示しています。
FROM ebx:6.2.3
USER root
ADD \
https://repo1.maven.org/maven2/com/oracle/database/jdbc/ojdbc11/23.8.0.25.04/ojdbc11-23.8.0.25.04.jar \
"/opt/ebx/lib/"
RUN chmod +r "/opt/ebx/lib/ojdbc11-23.8.0.25.04.jar"
USER ebx
詳細については、データベースドライバーを参照してください。
JNDIでのデータベース設定
EBX® 用の JNDI データソースを設定するには、Docker イメージをカスタマイズする必要があります。以下の Dockerfile のサンプルは、ebx.xml 設定を統合するために必要な手順を示しています。
FROM ebx:6.2.3
USER root
RUN mv "/opt/ebx/webapps/ebx/WEB-INF/ebx-default.properties" \
"/opt/ebx/webapps/ebx/WEB-INF/ebx-default-original.properties" ; \
mv "/opt/ebx/contexts/ebx.xml" \
"/opt/ebx/contexts/ebx.original" ; \
echo "ebx.file.previous=ebx-default-original.properties" >> \
"/opt/ebx/webapps/ebx/WEB-INF/ebx-default.properties" ; \
echo "ebx.persistence.url=" >> /opt/ebx/webapps/ebx/WEB-INF/ebx-default.properties
COPY "./ebx.xml" "/opt/ebx/contexts"
USER ebx
ebx.xml ファイルは、Web アプリケーションのコンテキストを管理し、EBX® で使用される JNDI データソースの重要な設定情報を含んでいます。
重要な点: 以下にリストされている各プロパティは、データベース (例: Oracle、PostgreSQL、SQL Server など) またはクラウドプロバイダーに応じて、慎重に調整、追加、または削除する必要があります。
重要: このサンプルファイルは、デプロイメントイメージに統合する前に、特定の環境に合わせて調整する必要があります。ebx.xml ファイルには UTF-8 エンコーディングが必要です。
<?xml version="1.0" encoding="UTF-8"?>
<Context docBase="${ebx.container.base}/webapps/ebx" crossContext="true">
<Resource
name="jdbc/EBX_REPOSITORY"
auth="Container"
type="javax.sql.DataSource"
factory="org.apache.tomcat.jdbc.pool.DataSourceFactory"
username="<username>"
password="<password>"
driverClassName="<driverClassName>"
url="<url>"
maxTotal="100"
minIdle="10"
maxIdle="25"
initialSize="10"
validationQuery="<validationQuery>"
rollbackOnReturn="false"
enableAutoCommitOnReturn="false"
/>
</Context>
注
JNDI データソースを設定することで、EBX® はその JDBC 接続方法を使用するように指示されます。その結果、EBX® は 'EBX\_DB\_' で始まる環境変数を考慮しなくなります。
JNDIでのメール設定
EBX® 用の JNDI メールセッションを設定するには、Docker イメージをカスタマイズする必要があります。以下の Dockerfile のサンプルは、ebx.xml 設定を統合するために必要な手順を示しています。
FROM ebx:6.2.3
USER root
RUN mv "/opt/ebx/webapps/ebx/WEB-INF/ebx-default.properties" \
"/opt/ebx/webapps/ebx/WEB-INF/ebx-default-original.properties" ; \
mv "/opt/ebx/contexts/ebx.xml" \
"/opt/ebx/contexts/ebx.original" ; \
echo "ebx.file.previous=ebx-default-original.properties" >> \
"/opt/ebx/webapps/ebx/WEB-INF/ebx-default.properties" ; \
echo "ebx.mail.activate=true" >> /opt/ebx/webapps/ebx/WEB-INF/ebx-default.properties ; \
echo "ebx.mail.smtp.host=" >> /opt/ebx/webapps/ebx/WEB-INF/ebx-default.properties
COPY "./ebx.xml" "/opt/ebx/contexts"
USER ebx
ebx.xml ファイルは、Web アプリケーションのコンテキストを管理し、EBX® で使用される JNDI メールセッションの重要な設定情報を含んでいます。
重要な点: 以下にリストされている各プロパティは、メールマネージャーまたはクラウドプロバイダーに応じて、慎重に調整、追加、または削除する必要があります。
重要: このサンプルファイルは、デプロイメントイメージに統合する前に、特定の環境に合わせて調整する必要があります。ebx.xml ファイルには UTF-8 エンコーディングが必要です。
<?xml version="1.0" encoding="UTF-8"?>
<Context docBase="${ebx.container.base}/webapps/ebx" crossContext="true">
<Resource
name="mail/EBX_MAIL_SESSION"
auth="Container"
type="jakarta.mail.Session"
factory="org.apache.naming.factory.MailSessionFactory"
mail.debug="false"
mail.smtp.host="<host>"
mail.smtp.port="<port>"
mail.smtp.auth="true"
mail.smtp.user="<user>"
password="<password>"
mail.smtp.ssl.enable="true"
mail.smtp.starttls.enable="false"
mail.smtp.connectiontimeout="600000"
mail.smtp.timeout="600000"
mail.smtp.writetimeout="600000"
mail.transport.protocol="smtp"
description="Mail session for Tomcat 10.x resource" />
/>
</Context>
注
JNDI メールセッションを設定することで、EBX® はそのメール接続方法を使用するように指示されます。その結果、EBX® は 'EBX\_SMTP\_' で始まる環境変数を考慮しなくなります。
メタデータ分類子データベースのドライバー追加
メタデータ分類子データベースのドライバーを追加するには、対応する Python モジュールをインストールする必要があります。Python モジュールは Python 仮想環境内にインストールする必要があります。以下の例は、ドライバーを追加するために Docker イメージをカスタマイズする方法を示しています。
PostgreSQL データベースの場合:
FROM ebx:6.2.3
RUN pipenv install psycopg2-binary
Oracle データベースの場合:
FROM ebx:6.2.3
RUN pipenv install oracledb
Microsoft SQL Server データベースの場合:
FROM ebx:6.2.3
USER root
# Install Microsoft SQL ODBC driver
RUN UBUNTU_VERSION=$(grep VERSION_ID /etc/os-release | cut -d '"' -f 2) && \
echo "Detected Ubuntu version: $UBUNTU_VERSION" && \
curl -sSL -O https://packages.microsoft.com/config/ubuntu/$UBUNTU_VERSION/packages-microsoft-prod.deb && \
dpkg -i packages-microsoft-prod.deb && \
rm packages-microsoft-prod.deb && \
apt-get update && \
ACCEPT_EULA=Y apt-get install -y msodbcsql18 && \
apt-get clean && rm -rf /var/lib/apt/lists/*
USER ebx
RUN pipenv install pyodbc
SQLAlchemy で使用できるデータベースドライバーの詳細については、SQLAlchemy ダイアレクトを参照してください。