Azure App Service で Tomcat、JBoss、または Java SE アプリのデータ ソースを構成する

共有サーバー レベルのデータ ソースを追加するには、Tomcat の server.xmlを編集する必要があります。 /home ディレクトリの外部にあるファイルの変更は一時的なものであるため、Tomcat の構成ファイルに対する変更は、次のようにプログラムで適用する必要があります。

• スタートアップ スクリプトをアップロードし、Settings>Configuration でスクリプトへのパスを設定します。 [ スタック設定 ] タブで、[ スタートアップ] コマンド ボックスにパスを追加します。 FTP を使用してスタートアップ スクリプトをアップロードできます。

スタートアップ スクリプトは、 XSL 変換 を server.xml ファイルに変換し、結果の XML ファイルを /usr/local/tomcat/conf/server.xmlに出力します。 スタートアップ スクリプトは、次のサンプル スクリプトのコメントに示すように、Web アプリlibxsltに応じて、xlstprocまたはをインストールする必要があります。 FTP を使用して、XSL ファイルとスタートアップ スクリプトをアップロードできます。

# Install the libxslt package on Alpine-based images:
apk add --update libxslt

# Install the xsltproc package on Debian or Ubuntu-based images:
apt install xsltproc

# Also copy the transform file to /home/tomcat/conf/
# Usage: xsltproc --output output.xml style.xsl input.xml
xsltproc --output /home/tomcat/conf/server.xml /home/tomcat/conf/transform.xsl /usr/local/tomcat/conf/server.xml

次の XSL ファイルの例では、新しいコネクタ ノードを Tomcat server.xml に追加します。

<xsl:stylesheet version="1.0" xmlns:xsl="http://www.w3.org/1999/XSL/Transform">
  <xsl:output method="xml" indent="yes"/>

  <xsl:template match="@* | node()" name="Copy">
    <xsl:copy>
      <xsl:apply-templates select="@* | node()"/>
    </xsl:copy>
  </xsl:template>

  <xsl:template match="@* | node()" mode="insertConnector">
    <xsl:call-template name="Copy" />
  </xsl:template>

  <xsl:template match="comment()[not(../Connector[@scheme = 'https']) and
                                 contains(., '&lt;Connector') and
                                 (contains(., 'scheme=&quot;https&quot;') or
                                  contains(., &quot;scheme='https'&quot;))]">
    <xsl:value-of select="." disable-output-escaping="yes" />
  </xsl:template>

  <xsl:template match="Service[not(Connector[@scheme = 'https'] or
                                   comment()[contains(., '&lt;Connector') and
                                             (contains(., 'scheme=&quot;https&quot;') or
                                              contains(., &quot;scheme='https'&quot;))]
                                  )]
                      ">
    <xsl:copy>
      <xsl:apply-templates select="@* | node()" mode="insertConnector" />
    </xsl:copy>
  </xsl:template>

  <!-- Add the new connector after the last existing connector if there is one -->
  <xsl:template match="Connector[last()]" mode="insertConnector">
    <xsl:call-template name="Copy" />

    <xsl:call-template name="AddConnector" />
  </xsl:template>

  <!-- ... or before the first engine if there's no existing connector -->
  <xsl:template match="Engine[1][not(preceding-sibling::Connector)]"
                mode="insertConnector">
    <xsl:call-template name="AddConnector" />

    <xsl:call-template name="Copy" />
  </xsl:template>

  <xsl:template name="AddConnector">
    <!-- Add new line -->
    <xsl:text>&#xa;</xsl:text>
    <!-- This is the new connector -->
    <Connector port="8443" protocol="HTTP/1.1" SSLEnabled="true" 
               maxThreads="150" scheme="https" secure="true" 
               keystoreFile="${{user.home}}/.keystore" keystorePass="changeit"
               clientAuth="false" sslProtocol="TLS" />
  </xsl:template>

</xsl:stylesheet>

構成を完了する

最後に、Tomcat クラスパスにドライバー JAR を配置し、App Service アプリを再起動します。

• JDBC ドライバー ファイルが Tomcat クラスローダーで確実に使用できるように、これらのファイルを /home/site/lib ディレクトリに配置します。 Cloud Shell で、ドライバー JAR ごとに az webapp deploy --type=lib を実行します。

az webapp deploy --resource-group <group-name> --name <app-name> --src-path <jar-name>.jar --type=lib --path <jar-name>.jar

サーバー レベルのデータ ソースを作成した場合は、App Service Linux アプリケーションを再起動します。 Tomcat は CATALINA_BASE を /home/tomcat にリセットし、更新された構成を使用します。

インストール場所は読み取り専用であるため、サーバー全体の構成用に Tomcat のインストールを直接変更することはできません。 Windows Tomcat のインストールにサーバー レベルの構成を変更する最も簡単な方法は、アプリの起動時に次の手順を完了することです。

1. Tomcat をローカル ディレクトリ (%LOCAL_EXPANDED%) にコピーし、そのコピーを CATALINA_BASEとして使用します。 ( この変数については Tomcat のドキュメントを参照してください)。
2. XSL 変換を使用して、共有データ ソースを %LOCAL_EXPANDED%\tomcat\conf\server.xml に追加します。

スタートアップ ファイルを追加する

startup.cmd ディレクトリに %HOME%\site\wwwroot という名前のファイルを作成します。 このファイルは、Tomcat サーバーが起動する前に自動的に実行されます。 ファイルには次のものが含まれている必要があります。

C:\Windows\System32\WindowsPowerShell\v1.0\powershell.exe -File  %HOME%\site\configure.ps1 > %HOME%\site\configure.log

PowerShell 構成スクリプトを追加する

次に、 configure.ps1 という構成スクリプトを %HOME%\site ディレクトリに追加します。 スクリプトには次のコードが含まれています。

# Locations of XML and XSL files
$source_xml = "$Env:AZURE_TOMCAT90_HOME\conf\server.xml"
$target_xml = "$Env:LOCAL_EXPANDED\tomcat\conf\server.xml"
$target_xsl = "$Env:HOME\site\server.xsl"
$marker_file = "$Env:HOME\site\config_done_marker"

# Define the transform function
# Useful if transforming multiple files
function TransformXML {
    param ($xml, $xsl, $output)

    if (-not $xml -or -not $xsl -or -not $output) {
        return 0
    }

    Try {
        $xslt_settings = New-Object System.Xml.Xsl.XsltSettings;
        $XmlUrlResolver = New-Object System.Xml.XmlUrlResolver;
        $xslt_settings.EnableScript = 1;

        $xslt = New-Object System.Xml.Xsl.XslCompiledTransform;
        $xslt.Load($xsl, $xslt_settings, $XmlUrlResolver);
        $xslt.Transform($xml, $output);
    }

    Catch {
        $ErrorMessage = $_.Exception.Message
        $FailedItem = $_.Exception.ItemName
        Write-Error 'Error'$ErrorMessage':'$FailedItem':' $_.Exception;
        return 0
    }
    return 1
}

# Start here

# Check for marker file indicating that configuration has already been done
if (Test-Path "$marker_file") {
    return 0
}

# Delete previous Tomcat directory if it exists
# In case previous configuration isn't completed or a new configuration should be forcefully installed
if (Test-Path "$Env:LOCAL_EXPANDED\tomcat") {
    Remove-Item -Path "$Env:LOCAL_EXPANDED\tomcat" -Recurse -Force
}

# Copy Tomcat to local
# When you use the environment variable $AZURE_TOMCAT90_HOME, the 'default' version of Tomcat is used
New-Item "$Env:LOCAL_EXPANDED\tomcat" -ItemType Directory
Copy-Item -Path "$Env:AZURE_TOMCAT90_HOME\*" "$Env:LOCAL_EXPANDED\tomcat" -Recurse

# Perform the required customization of Tomcat
$success = TransformXML -xml $source_xml -xsl $target_xsl -output $target_xml

# Mark that the operation succeeded if it did
if ($success) {
    New-Item -Path "$marker_file" -ItemType File
}

この PowerShell では、次の手順が完了します。

1. カスタム Tomcat コピーが存在するかどうかを確認します。 存在する場合は、スタートアップ スクリプトを停止できます。
2. Tomcat をローカルにコピーします。
3. XSL 変換を使用して、カスタム Tomcat の構成に共有データ ソースを追加します。
4. 構成が正常に完了したことを示します。

XSL 変換ファイルを追加する

組み込みの Tomcat のインストールをカスタマイズするための一般的なユース ケースは、server.xml、context.xml、または web.xml Tomcat 構成ファイルを変更することです。 App Service では、プラットフォーム機能を提供するために、既にこれらのファイルを変更しています。 これらの機能を引き続き使用するには、これらのファイルに変更を加えたときに、これらのファイルの内容を保持する必要があります。 このコンテンツを保持するには、 XSL 変換 (XSLT) を使用します。

server.xsl という XSL 変換ファイルを %HOME%_\site ディレクトリに追加します。 次の XSL 変換コードを使用して、新しいコネクタ ノードを server.xml に追加できます。 先頭の ID 変換は、構成ファイルの元の内容を保持します。

<xsl:stylesheet version="1.0" xmlns:xsl="http://www.w3.org/1999/XSL/Transform">
    <xsl:output method="xml" indent="yes"/>

    <!-- Identity transform: this transform ensures that the original contents of the file are included in the new file -->
    <!-- Ensure that your transform files include this block -->
    <xsl:template match="@* | node()" name="Copy">
      <xsl:copy>
        <xsl:apply-templates select="@* | node()"/>
      </xsl:copy>
    </xsl:template>

    <xsl:template match="@* | node()" mode="insertConnector">
      <xsl:call-template name="Copy" />
    </xsl:template>

    <xsl:template match="comment()[not(../Connector[@scheme = 'https']) and
                                   contains(., '&lt;Connector') and
                                   (contains(., 'scheme=&quot;https&quot;') or
                                    contains(., &quot;scheme='https'&quot;))]">
      <xsl:value-of select="." disable-output-escaping="yes" />
    </xsl:template>

    <xsl:template match="Service[not(Connector[@scheme = 'https'] or
                                     comment()[contains(., '&lt;Connector') and
                                               (contains(., 'scheme=&quot;https&quot;') or
                                                contains(., &quot;scheme='https'&quot;))]
                                    )]
                        ">
      <xsl:copy>
        <xsl:apply-templates select="@* | node()" mode="insertConnector" />
      </xsl:copy>
    </xsl:template>

    <!-- Add the new connector after the last existing connector if there is one -->
    <xsl:template match="Connector[last()]" mode="insertConnector">
      <xsl:call-template name="Copy" />

      <xsl:call-template name="AddConnector" />
    </xsl:template>

    <!-- ... or before the first engine if there's no existing connector -->
    <xsl:template match="Engine[1][not(preceding-sibling::Connector)]"
                  mode="insertConnector">
      <xsl:call-template name="AddConnector" />

      <xsl:call-template name="Copy" />
    </xsl:template>

    <xsl:template name="AddConnector">
      <!-- Add new line -->
      <xsl:text>&#xa;</xsl:text>
      <!-- This is the new connector -->
      <Connector port="8443" protocol="HTTP/1.1" SSLEnabled="true" 
                 maxThreads="150" scheme="https" secure="true" 
                 keystoreFile="${{user.home}}/.keystore" keystorePass="changeit"
                 clientAuth="false" sslProtocol="TLS" />
    </xsl:template>

</xsl:stylesheet>

CATALINA_BASE アプリの設定を設定する

プラットフォームでは、カスタム バージョンの Tomcat がインストールされている場所も認識している必要があります。 インストールの場所は、CATALINA_BASE のアプリ設定で設定できます。

この設定は、次のように、Azure CLI を使用して変更できます。

    az webapp config appsettings set -g $MyResourceGroup -n $MyUniqueApp --settings CATALINA_BASE="%LOCAL_EXPANDED%\tomcat"

または、Azure portal で設定を手動で変更することもできます。

1. 設定>環境変数>アプリ設定へ移動します。
2. [] を選択し、[] を追加します。
3. 次の値を使用して設定を作成します。
   1. 名前: CATALINA_BASE
   2. 値: "%LOCAL_EXPANDED%\tomcat"

構成を完了する

最後に、ドライバーの JAR を Tomcat クラスパス内に配置し、App Service を再起動します。 JDBC ドライバー ファイルが Tomcat クラスローダーで確実に使用できるように、これらのファイルを /home/site/lib ディレクトリに配置します。 Cloud Shell で、ドライバー JAR ごとに az webapp deploy --type=lib を実行します。

az webapp deploy --resource-group <group-name> --name <app-name> --src-path <jar-name>.jar --type=lib --target-path <jar-name>.jar

1. JBoss CLI コマンドを jboss-cli-commands.cli という名前のファイルに置きます。 JBoss コマンドを使用して、モジュールを追加し、データ ソースとして登録する必要があります。 次の例は、JNDI 名 java:jboss/datasources/postgresDS を持つ PostgreSQL データ ソースを作成するための JBoss CLI コマンドを示しています。

   module add --name=org.postgresql --resources=/home/site/libs/postgresql-42.7.4.jar
   /subsystem=datasources/jdbc-driver=postgresql:add(driver-name="postgresql",driver-module-name="org.postgresql",driver-class-name="org.postgresql.Driver",driver-xa-datasource-class-name="org.postgresql.xa.PGXADataSource")
   data-source add --name=postgresql --driver-name="postgresql" --jndi-name="java:jboss/datasources/postgresDS" --connection-url="jdbc:postgresql://\${env.DB_HOST}:5432/postgres" --user-name="\${env.DB_USERNAME}" --password="\${env.DB_PASSWORD}" --enabled=true --use-java-context=true
   

   module add コマンドでは 3 つの環境変数 (DB_HOST、 DB_USERNAME、および DB_PASSWORD) が使用されることに注意してください。この環境変数は、App Service でアプリ設定として追加する必要があります。 JBoss が値をプレーンテキストで保存しないように、スクリプトは --resolve-parameter-values フラグなしでそれらを追加します。

2. JBoss CLI コマンドを呼び出すスタートアップ スクリプト startup.sh を作成します。 次の例は、 jboss-cli-commands.cli ファイルを呼び出す方法を示しています。 後で、コンテナーの起動時にこのスクリプトを実行するように App Service を構成します。

   $JBOSS_HOME/bin/jboss-cli.sh --connect --file=/home/site/scripts/jboss-cli-commands.cli
   

3. 任意のデプロイ オプションを使用して、JDBC ドライバー、 jboss-cli-commands.cli と startup.sh をそれぞれのスクリプトで指定されたパスにアップロードします。 startup.sh をスタートアップ ファイルとしてアップロードします。 次に例を示します。

   • Azure CLI
   • Azure Maven プラグイン
   • Azure Pipelines

   export RESOURCE_GROUP_NAME=<resource-group-name>
   export APP_NAME=<app-name>
   
   # The lib type uploads to /home/site/libs by default.
   az webapp deploy --resource-group $RESOURCE_GROUP_NAME --name $APP_NAME --src-path postgresql-42.7.4.jar --target-path postgresql-42.7.4.jar --type lib
   az webapp deploy --resource-group $RESOURCE_GROUP_NAME --name $APP_NAME --src-path jboss-cli-commands.cli --target-path /home/site/scripts/jboss-cli-commands.cli --type static
   # The startup type uploads to /home/site/scripts/startup.sh by default.
   az webapp deploy --resource-group $RESOURCE_GROUP_NAME --name $APP_NAME --src-path startup.sh --type startup
   

   詳細については、「App Service へのファイルのデプロイ」を参照してください。

データ ソースが JBoss サーバーに追加されたことを確認するには、Web アプリに SSH 接続し、 $JBOSS_HOME/bin/jboss-cli.sh --connect実行します。 JBoss に接続したら、 /subsystem=datasources:read-resource を実行してデータ ソースの一覧を出力します。

jboss-cli-commands.cli の定義に従って、JNDI 名java:jboss/datasources/postgresDSを使用して PostgreSQL 接続にアクセスできます。

1. JBoss CLI コマンドを jboss-cli-commands.cli という名前のファイルに置きます。 JBoss コマンドを使用して、モジュールを追加し、データ ソースとして登録する必要があります。 次の例は、JNDI 名が java:jboss/datasources/mysqlDS の MySQL データ ソースを作成するための JBoss CLI コマンドを示しています。

   module add --name=com.mysql.mysql-connector-j --resources=/home/site/libs/mysql-connector-j-9.1.0.jar
   /subsystem=datasources/jdbc-driver=mysql:add(driver-name="mysql",driver-module-name="com.mysql.mysql-connector-j",driver-class-name="com.mysql.cj.jdbc.Driver",driver-xa-datasource-class-name="com.mysql.cj.jdbc.MysqlXADataSource")
   data-source add --name=mysql --driver-name="mysql" --jndi-name="java:jboss/datasources/mysqlDS" --connection-url="jdbc:mysql://\${env.DB_HOST}:5432/mysql?serverTimezone=UTC" --user-name="\${env.DB_USERNAME}" --password="\${env.DB_PASSWORD}" --enabled=true --use-java-context=true
   

   module add コマンドでは 3 つの環境変数 (DB_HOST、 DB_USERNAME、および DB_PASSWORD) が使用されることに注意してください。この環境変数は、App Service でアプリ設定として追加する必要があります。 JBoss が値をプレーンテキストで保存しないように、スクリプトは --resolve-parameter-values フラグなしでそれらを追加します。

2. JBoss CLI コマンドを呼び出すスタートアップ スクリプト startup.sh を作成します。 次の例は、 jboss-cli-commands.cli ファイルを呼び出す方法を示しています。 後で、コンテナーの起動時にこのスクリプトを実行するように App Service を構成します。

   $JBOSS_HOME/bin/jboss-cli.sh --connect --file=/home/site/scripts/jboss-cli-commands.cli
   

3. 任意のデプロイ オプションを使用して、JDBC ドライバー、 jboss-cli-commands.cli と startup.sh をそれぞれのスクリプトで指定されたパスにアップロードします。 startup.sh をスタートアップ ファイルとしてアップロードします。 次に例を示します。

   • Azure CLI
   • Azure Maven プラグイン
   • Azure Pipelines

   export RESOURCE_GROUP_NAME=<resource-group-name>
   export APP_NAME=<app-name>
   
   # The lib type uploads to /home/site/libs by default.
   az webapp deploy --resource-group $RESOURCE_GROUP_NAME --name $APP_NAME --src-path mysql-connector-j-9.1.0.jar --target-path mysql-connector-j-9.1.0.jar --type lib
   az webapp deploy --resource-group $RESOURCE_GROUP_NAME --name $APP_NAME --src-path jboss-cli-commands.cli --target-path /home/site/scripts/jboss-cli-commands.cli --type static
   # The startup type uploads to /home/site/scripts/startup.sh by default.
   az webapp deploy --resource-group $RESOURCE_GROUP_NAME --name $APP_NAME --src-path startup.sh --type startup
   

   詳細については、「App Service へのファイルのデプロイ」を参照してください。

データ ソースが JBoss サーバーに追加されたことを確認するには、Web アプリに SSH 接続し、 $JBOSS_HOME/bin/jboss-cli.sh --connect実行します。 JBoss に接続したら、 /subsystem=datasources:read-resource を実行してデータ ソースの一覧を出力します。

jboss-cli-commands.cli の定義に従って、java:jboss/datasources/mysqlDS JNDI 名を使用して MySQL 接続にアクセスできます。

1. JBoss CLI コマンドを jboss-cli-commands.cli という名前のファイルに置きます。 JBoss コマンドを使用して、モジュールを追加し、データ ソースとして登録する必要があります。 次の例は、JNDI 名が java:jboss/datasources/sqlDSの Azure SQL データベースのデータ ソースを作成するための JBoss CLI コマンドを示しています。

   module add --name=sqlserver --resources=/home/site/libs/mssql-jdbc-11.2.3.jre17.jar
   /subsystem=datasources/jdbc-driver=sqlserver:add(driver-name="sqlserver",driver-module-name="sqlserver",driver-class-name="com.microsoft.sqlserver.jdbc.SQLServerDriver",driver-xa-datasource-class-name="com.microsoft.sqlserver.jdbc.SQLServerXADataSource")
   data-source add --name=sqlDS --jndi-name=java:jboss/datasources/sqlDS --driver-name=sqlserver --connection-url="jdbc:sqlserver://\${env.DB_HOST}:1433;databaseName=master" --user-name="\${env.DB_USERNAME}" --password="\${env.DB_PASSWORD}" --validate-on-match=true --background-validation=false --valid-connection-checker-class-name=org.jboss.jca.adapters.jdbc.extensions.mssql.MSSQLValidConnectionChecker --exception-sorter-class-name=org.jboss.jca.adapters.jdbc.extensions.mssql.MSSQLExceptionSorter
   

   module add コマンドでは 3 つの環境変数 (DB_HOST、 DB_USERNAME、および DB_PASSWORD) が使用されることに注意してください。この環境変数は、App Service でアプリ設定として追加する必要があります。 JBoss が値をプレーンテキストで保存しないように、スクリプトは --resolve-parameter-values フラグなしでそれらを追加します。

2. JBoss CLI コマンドを呼び出すスタートアップ スクリプト startup.sh を作成します。 次の例は、 jboss-cli-commands.cli ファイルを呼び出す方法を示しています。 後で、コンテナーの起動時にこのスクリプトを実行するように App Service を構成します。

   $JBOSS_HOME/bin/jboss-cli.sh --connect --file=/home/site/scripts/jboss-cli-commands.cli
   

3. 任意のデプロイ オプションを使用して、JDBC ドライバー、 jboss-cli-commands.cli と startup.sh をそれぞれのスクリプトで指定されたパスにアップロードします。 startup.sh をスタートアップ ファイルとしてアップロードします。 次に例を示します。

   • Azure CLI
   • Azure Maven プラグイン
   • Azure Pipelines

   export RESOURCE_GROUP_NAME=<resource-group-name>
   export APP_NAME=<app-name>
   
   # The lib type uploads to /home/site/libs by default.
   az webapp deploy --resource-group $RESOURCE_GROUP_NAME --name $APP_NAME --src-path mssql-jdbc-11.2.3.jre17.jar --target-path mssql-jdbc-11.2.3.jre17.jar --type lib
   az webapp deploy --resource-group $RESOURCE_GROUP_NAME --name $APP_NAME --src-path jboss-cli-commands.cli --target-path /home/site/scripts/jboss-cli-commands.cli --type static
   # The startup type uploads to /home/site/scripts/startup.sh by default.
   az webapp deploy --resource-group $RESOURCE_GROUP_NAME --name $APP_NAME --src-path startup.sh --type startup
   

   詳細については、「App Service へのファイルのデプロイ」を参照してください。

データ ソースが JBoss サーバーに追加されたことを確認するには、webapp に SSH で接続して、$JBOSS_HOME/bin/jboss-cli.sh --connect を実行します。 JBoss に接続したら、 /subsystem=datasources:read-resource を実行してデータ ソースの一覧を出力します。

jboss-cli-commands.cli の定義に従って、JNDI 名java:jboss/datasources/sqlDSを使用して SQL Database 接続にアクセスできます。