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

Per aggiungere un'origine dati condivisa a livello di server, è necessario modificare il server.xml di Tomcat server.xml. Poiché le modifiche apportate ai file all'esterno della /home directory sono temporanee, le modifiche apportate ai file di configurazione di Tomcat devono essere applicate a livello di codice, come indicato di seguito:

• Caricare uno script di avvio e impostare il percorso dello script inConfigurazione>. Nella scheda Impostazioni stack aggiungere il percorso nella casella di comando Avvio . È possibile caricare lo script di avvio usando FTP.

Lo script di avvio crea una trasformazione XSL nel server.xml file e restituisce il file XML risultante in /usr/local/tomcat/conf/server.xml. Lo script di avvio deve installare libxslt o xlstproc, a seconda della distribuzione della versione di Tomcat dell'app Web, come indicato nel commento nello script di esempio seguente. È possibile usare FTP per caricare il file XSL e lo script di avvio.

# 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

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 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>

Completare la configurazione

Infine, posizionare i file JAR del driver nel classpath di Tomcat e riavviare l'app di App Service.

• 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 hai creato un'origine dati a livello di server, riavvia l'applicazione Linux dell'App Service. 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. Il modo più semplice per apportare modifiche alla configurazione a livello di server per l'installazione di Windows Tomcat consiste nel completare i passaggi seguenti all'avvio dell'app:

1. Copiare Tomcat in una directory locale (%LOCAL_EXPANDED%) e usare tale copia come CATALINA_BASE. Vedere la documentazione di Tomcat su 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 nella directory %HOME%\site\wwwroot. Questo file viene eseguito automaticamente prima dell'avvio del server Tomcat. Il file deve contenere quanto segue:

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

Aggiungere lo script di configurazione di PowerShell

Aggiungere quindi uno script di configurazione denominato configure.ps1 alla %HOME%\site directory . Lo script contiene questo codice:

# 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
}

Questo PowerShell completa i passaggi seguenti:

1. Controllare se esiste una copia Tomcat personalizzata. Se ne esiste uno, lo script di avvio può interrompersi.
2. Copiare Tomcat in locale.
3. Aggiungere origini dati condivise alla configurazione personalizzata di Tomcat mediante 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à, è necessario conservare il contenuto di questi file quando si apportano modifiche. Per mantenere questo contenuto, usare una trasformazione XSL (XSLT).

Aggiungere un file di trasformazione XSL denominato server.xsl 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 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>

Impostare 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 delle variabili ambientaliImpostazioni app.
2. Seleziona Aggiungi.
3. Usare questi valori per creare l'impostazione:
   1. Nome: CATALINA_BASE
   2. Valore: "%LOCAL_EXPANDED%\tomcat"

Completare la configurazione

Infine, inserisci i JAR dei driver nel classpath Tomcat e riavvia il tuo Servizio App. 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 CLI di JBoss per la creazione di un'origine dati PostgreSQL con il nome JNDI java:jboss/datasources/postgresDS.

   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. L'esempio seguente illustra come chiamare il file jboss-cli-commands.cli . Successivamente, si configura 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. 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 l'app in Servizio app.

Per verificare che l'origine dati venga aggiunta al server JBoss, accedi alla tua app web tramite SSH ed esegui $JBOSS_HOME/bin/jboss-cli.sh --connect. Dopo aver eseguito la connessione a JBoss, eseguire /subsystem=datasources:read-resource per stampare un elenco delle origini dati.

Per la definizione in 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 JNDI java:jboss/datasources/mysqlDS.

   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. L'esempio seguente illustra come chiamare il file jboss-cli-commands.cli . Successivamente, si configura 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. 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 l'app in Servizio app.

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

Per la definizione in jboss-cli-commands.cli, è possibile accedere alla connessione MySQL usando il nome java:jboss/datasources/mysqlDS.

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 JBoss CLI per la creazione di un'origine dati per un database SQL di Azure con il nome JNDI java:jboss/datasources/sqlDS.

   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. L'esempio seguente illustra come chiamare il file jboss-cli-commands.cli . Successivamente, si configura 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. 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 l'app 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 /subsystem=datasources:read-resource per stampare un elenco delle origini dati.

Per la definizione in jboss-cli-commands.cli, è possibile accedere alla connessione al database SQL usando il nome java:jboss/datasources/sqlDSJNDI .