Configurare le origini dati per un'app Tomcat, JBoss o Java SE nel servizio app di Azure

L'aggiunta di un'origine dati condivisa a livello di server richiede di modificare il server.xml di Tomcat. Il modo più affidabile per eseguire questa operazione è il seguente:

1. Per prima cosa, caricare uno script di avvio e impostare il percorso dello script in Configurazione>Comando di avvio. È possibile caricare lo script di avvio usando FTP.

Lo script di avvio crea una trasformazione xsl nel file server.xml e restituisce il file XML risultante in /usr/local/tomcat/conf/server.xml. Lo script di avvio deve installare libxslt tramite apk. Il file xsl e lo script di avvio possono essere caricati tramite FTP. Di seguito è riportato uno script di avvio di esempio.

# Install libxslt. Also copy the transform file to /home/tomcat/conf/
apk add --update libxslt

# 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

Il file XSL di esempio seguente aggiunge un nuovo nodo connettore al server.xml Tomcat.

<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 Connnector if there's 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>

Completare la configurazione

Infine, inserire i file driver con estensione jar nel classpath Tomcat e riavviare il Servizio app di Azure.

1. Assicurarsi che i file driver JDBC siano disponibili per il caricatore di classe Tomcat inserendoli nella directory /home/site/lib. In Cloud Shell eseguire az webapp deploy --type=lib per ogni file JAR del driver:

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

Se è stata creata un'origine dati a livello di server, riavviare l'applicazione Linux del Servizio app. Tomcat reimposta CATALINA_BASE su /home/tomcat e usa la configurazione aggiornata.

Non è possibile modificare direttamente un'installazione Tomcat per la configurazione a livello di server perché il percorso di installazione è di sola lettura. Per apportare modifiche alla configurazione a livello di server all'installazione di Windows Tomcat, il modo più semplice consiste nell'eseguire le operazioni seguenti all'avvio dell'app:

1. Copiare Tomcat in una directory locale (%LOCAL_EXPANDED%) e usarla come CATALINA_BASE (vedere la documentazione di Tomcat in questa variabile).
2. Aggiungere le origini dati condivise a %LOCAL_EXPANDED%\tomcat\conf\server.xml usando la trasformazione XSL.

Aggiungere un file di avvio

Creare un file denominato startup.cmd %HOME%\site\wwwroot directory. Questo file viene eseguito automaticamente prima dell'avvio del server Tomcat. Il file deve avere il contenuto seguente:

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

Aggiungere lo script di configurazione di PowerShell

Aggiungere quindi lo script di configurazione denominato configure.ps1 alla directory %HOME%_\site con il codice seguente:

# Locations of xml and xsl files
$target_xml="$Env:LOCAL_EXPANDED\tomcat\conf\server.xml"
$target_xsl="$Env:HOME\site\server.xsl"

# 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
        echo  'Error'$ErrorMessage':'$FailedItem':' $_.Exception;
        return 0
    }
    return 1
}

# Start here

# Check for marker file indicating that config has already been done
if(Test-Path "$Env:LOCAL_EXPANDED\tomcat\config_done_marker"){
    return 0
}

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

md -Path "$Env:LOCAL_EXPANDED\tomcat"

# Copy Tomcat to local
# Using the environment variable $AZURE_TOMCAT90_HOME uses the 'default' version of Tomcat
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 $target_xml -xsl $target_xsl -output $target_xml

# Mark that the operation was a success if successful
if($success){
    New-Item -Path "$Env:LOCAL_EXPANDED\tomcat\config_done_marker" -ItemType File
}

Questo PowerShell completa i passaggi seguenti:

1. Controllare se esiste già una copia Tomcat personalizzata. In caso affermativo, lo script di avvio può terminare qui.
2. Copiare Tomcat in locale.
3. Aggiungere origini dati condivise alla configurazione di Tomcat personalizzata usando la trasformazione XSL.
4. Indicare che la configurazione è stata completata correttamente.

Aggiungere un file di trasformazione XSL

Un caso d'uso comune per personalizzare l'installazione predefinita di Tomcat consiste nel modificare i file di configurazione server.xml, context.xml o web.xml Tomcat. Il servizio app modifica già questi file per fornire funzionalità della piattaforma. Per continuare a usare queste funzionalità, è importante conservare il contenuto di questi file quando si apportano modifiche. A tale scopo, usare una trasformazione XSL (XSLT).

Aggiungere un file di trasformazione XSL denominato configure.ps1 alla directory %HOME%_\site. È possibile usare il codice di trasformazione XSL seguente per aggiungere un nuovo nodo connettore a server.xml. La trasformazione dell'identità all'inizio mantiene il contenuto originale del file di configurazione.

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

    <!-- Identity transform: this 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 Connnector if there's 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>

Configurare l'impostazione dell'app CATALINA_BASE

La piattaforma deve anche sapere dove è installata la versione personalizzata di Tomcat. È possibile configurare il percorso dell'installazione nell'impostazione dell'app CATALINA_BASE.

È possibile usare l'interfaccia della riga di comando di Azure per modificare questa impostazione:

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

In alternativa, è possibile modificare manualmente l'impostazione nel portale di Azure:

1. Passare a Impostazioni>Configurazione>Impostazioni applicazione.
2. Selezionare Nuova impostazione applicazione.
3. Usare questi valori per creare l'impostazione:
   1. Nome: CATALINA_BASE
   2. Valore: "%LOCAL_EXPANDED%\tomcat"

Completare la configurazione

Infine, inserire i file driver con estensione JAR nel classpath Tomcat e riavviare il Servizio app di Azure. Assicurarsi che i file driver JDBC siano disponibili per il caricatore di classe Tomcat inserendoli nella directory /home/site/lib. In Cloud Shell eseguire az webapp deploy --type=lib per ogni file JAR del driver:

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

1. Inserire i comandi dell'interfaccia della riga di comando di JBoss in un file denominato jboss-cli-commands.cli. I comandi JBoss devono aggiungere il modulo e registrarlo come origine dati. L'esempio seguente illustra i comandi dell'interfaccia della riga di comando di JBoss per la creazione di un'origine dati PostgreSQL con il nome java:jboss/datasources/postgresDSJNDI .

   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
   

   Si noti che il module add comando usa tre variabili di ambiente (DB_HOST, DB_USERNAMEe DB_PASSWORD), che è necessario aggiungere in servizio app come impostazioni dell'app. Lo script li aggiunge senza il --resolve-parameter-values flag in modo che JBoss non salvi i valori in testo non crittografato.

2. Creare uno script di avvio, startup.sh, che chiama i comandi dell'interfaccia della riga di comando di JBoss. Nell'esempio seguente viene illustrato come chiamare jboss-cli-commands.cli. Successivamente, si configurerà il servizio app per eseguire questo script all'avvio del contenitore.

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

3. Usando un'opzione di distribuzione di propria scelta, caricare il driver JDBC, jboss-cli-commands.cli e startup.sh nei percorsi specificati nei rispettivi script. In particolare, caricare startup.sh come file di avvio. Ad esempio:

   • Interfaccia della riga di comando di Azure
   • Plug-in 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
   

   Per altre informazioni, vedere Distribuire file in servizio app.

Per verificare che l'origine dati sia stata aggiunta al server JBoss, eseguire SSH nell'app Web ed eseguire $JBOSS_HOME/bin/jboss-cli.sh --connect. Dopo aver eseguito la connessione a JBoss, eseguire il /subsystem=datasources:read-resource per stampare un elenco delle origini dati.

Come definito in precedenza da jboss-cli-commands.cli , è possibile accedere alla connessione PostgreSQL usando il nome java:jboss/datasources/postgresDSJNDI .

1. Inserire i comandi dell'interfaccia della riga di comando di JBoss in un file denominato jboss-cli-commands.cli. I comandi JBoss devono aggiungere il modulo e registrarlo come origine dati. L'esempio seguente illustra i comandi dell'interfaccia della riga di comando di JBoss per la creazione di un'origine dati MySQL con il nome java:jboss/datasources/mysqlDSJNDI .

   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
   

   Si noti che il module add comando usa tre variabili di ambiente (DB_HOST, DB_USERNAMEe DB_PASSWORD), che è necessario aggiungere in servizio app come impostazioni dell'app. Lo script li aggiunge senza il --resolve-parameter-values flag in modo che JBoss non salvi i valori in testo non crittografato.

2. Creare uno script di avvio, startup.sh, che chiama i comandi dell'interfaccia della riga di comando di JBoss. Nell'esempio seguente viene illustrato come chiamare jboss-cli-commands.cli. Successivamente, si configurerà il servizio app per eseguire questo script all'avvio del contenitore.

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

3. Usando un'opzione di distribuzione di propria scelta, caricare il driver JDBC, jboss-cli-commands.cli e startup.sh nei percorsi specificati nei rispettivi script. In particolare, caricare startup.sh come file di avvio. Ad esempio:

   • Interfaccia della riga di comando di Azure
   • Plug-in 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
   

   Per altre informazioni, vedere Distribuire file in servizio app.

Per verificare che l'origine dati sia stata aggiunta al server JBoss, eseguire SSH nell'app Web ed eseguire $JBOSS_HOME/bin/jboss-cli.sh --connect. Dopo aver eseguito la connessione a JBoss, eseguire il /subsystem=datasources:read-resource per stampare un elenco delle origini dati.

Come definito in precedenza da jboss-cli-commands.cli , è possibile accedere alla connessione MySQL usando il nome java:jboss/datasources/mysqlDSJNDI .

1. Inserire i comandi dell'interfaccia della riga di comando di JBoss in un file denominato jboss-cli-commands.cli. I comandi JBoss devono aggiungere il modulo e registrarlo come origine dati. L'esempio seguente illustra i comandi dell'interfaccia della riga di comando di JBoss per la creazione di un'origine dati per database SQL di Azure con il nome java:jboss/datasources/sqlDSJNDI .

   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
   

   Si noti che il module add comando usa tre variabili di ambiente (DB_HOST, DB_USERNAMEe DB_PASSWORD), che è necessario aggiungere in servizio app come impostazioni dell'app. Lo script li aggiunge senza il --resolve-parameter-values flag in modo che JBoss non salvi i valori in testo non crittografato.

2. Creare uno script di avvio, startup.sh, che chiama i comandi dell'interfaccia della riga di comando di JBoss. Nell'esempio seguente viene illustrato come chiamare jboss-cli-commands.cli. Successivamente, si configurerà il servizio app per eseguire questo script all'avvio del contenitore.

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

3. Usando un'opzione di distribuzione di propria scelta, caricare il driver JDBC, jboss-cli-commands.cli e startup.sh nei percorsi specificati nei rispettivi script. In particolare, caricare startup.sh come file di avvio. Ad esempio:

   • Interfaccia della riga di comando di Azure
   • Plug-in 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
   

   Per altre informazioni, vedere Distribuire file in servizio app.

Per verificare che l'origine dati sia stata aggiunta al server JBoss, eseguire SSH nell'app Web ed eseguire $JBOSS_HOME/bin/jboss-cli.sh --connect. Dopo aver eseguito la connessione a JBoss, eseguire il /subsystem=datasources:read-resource per stampare un elenco delle origini dati.

Come definito in precedenza da jboss-cli-commands.cli, è possibile accedere alla connessione database SQL usando il nome java:jboss/datasources/sqlDSJNDI .