web-app-samples.md

Sample usages of Maven Plugin for Azure Web Apps

Table of Content

• V2 configuration
  • Web App on Linux
    • Tomcat with JRE 8
    • JRE 8
  • Web App on Windows
    • Deploy War File to Tomcat
  • Web App for Containers
    • Public Docker Hub
• Deploy to Existing App Service Plan
• Deploy to Web App Deployment Slot

Web App (on Linux) with Java 8, Tomcat

The following configuration is applicable for below scenario:

• Reference <serverId> in Maven's settings.xml to authenticate with Azure

• Web App on Linux

• Use Java 8 and Tomcat 8.5

• Deploy a WAR file to context path: /${project.build.finalName} in your Web App server

• Add Application Settings to your Web App

  <project>
     ...
     <packaging>war</packaging>
     ...
     <build>
        <plugins>
           <plugin>
              <groupId>com.microsoft.azure</groupId>
              <artifactId>azure-webapp-maven-plugin</artifactId>
              <version>1.15.0</version>
              <configuration>
                 <schemaVersion>V2</schemaVersion>
                 <!-- Reference <serverId> in Maven's settings.xml to authenticate with Azure -->
                 <auth>
                   <serverId>${AZURE_AUTH}</serverId>
                 </auth>
                 
                 <!-- Web App information -->
                 <resourceGroup>${RESOURCEGROUP_NAME}</resourceGroup>
                 <appName>${WEBAPP_NAME}</appName>
                 <region>westeurope</region>
                 <pricingTier>P1v2</pricingTier>
                 <!-- Java Runtime Stack for Web App on Windows-->
                 <runtime>
                   <os>Linux</os>                      
                     <javaVersion>Java 8</javaVersion>
                     <webContainer>Tomcat 8.5</webContainer>
                   </runtime>
                 <appSettings>
                    <property>
                    <!-- Tell Azure which port you want to use, required for springboot 
                       jar applications -->
                       <name>PORT</name>
                       <value>8081</value>
                    </property>
                    <!--JVM OPTIONS -->
                    <property>
                       <name>JAVA_OPTS</name>
                       <value>-Xmx512m -Xms512m</value>
                    </property>
                 </appSettings>
                 <!-- Deployment settings -->
                 <deployment>
                   <resources>
                     <resource>
                       <directory>${project.basedir}/target</directory>
                       <targetPath>${project.build.finalName}</targetPath>
                       <includes>
                         <include>*.war</include>
                       </includes>
                     </resource>
                   </resources>
                 </deployment>
              </configuration>
           </plugin>
           ...
        </plugins>
     </build>
  </project>

Web App (on Linux) with Java 8 and JAR deployment

The following configuration is applicable for below scenario:

• Reference <serverId> in Maven's settings.xml to authenticate with Azure

• Web App on Linux

• Use Java 8

• Deploy an executable jar file to /site/wwwroot/ directory in your Web App server

  <project>
     ...
     <packaging>jar</packaging>
     ...
     <build>
        <finalName>app</finalName>
        <plugins>
           <plugin>
              <groupId>com.microsoft.azure</groupId>
              <artifactId>azure-webapp-maven-plugin</artifactId>
              <version>1.15.0</version>
              <configuration>                  
                 <!-- Reference <serverId> in Maven's settings.xml to authenticate with Azure -->
                 <auth>
                   <serverId>${AZURE_AUTH}</serverId>
                 </auth>
                 
                 <!-- Web App information -->
                 <resourceGroup>${RESOURCEGROUP_NAME}</resourceGroup>
                 <appName>${WEBAPP_NAME}</appName>
                 <region>westeurope</region>
                 <pricingTier>P1v2</pricingTier>
                 
                 <!-- Java Runtime Stack for Web App on Windows-->
                 <runtime>
                   <os>Linux</os>
                   <javaVersion>jre8</javaVersion>
                 </runtime>
                 <!-- Deployment settings -->
                 <deployment>
                   <resources>
                     <resource>
                       <directory>${project.basedir}/target</directory>
                       <includes>
                         <include>*.jar</include>
                       </includes>
                     </resource>
                   </resources>
                 </deployment>
                 
                 <!-- This is to make sure the jar file can be released at the server side -->
                 <stopAppDuringDeployment>true</stopAppDuringDeployment>
  
              </configuration>
           </plugin>
           ...
        </plugins>
     </build>
  </project>

Web App (on Windows) with Java 8, Tomcat

The following configuration is applicable for below scenario:

• Reference <serverId> in Maven's settings.xml to authenticate with Azure

• Web App on Windows

• Use Java 8 and Tomcat 8.5

• Deploy the WAR file to context path: /${project.build.finalName} in your Web App server

• Add Application Settings to your Web App

  <project>
     ...
     <packaging>war</packaging>
     ...
     <build>
        <plugins>
           <plugin>
              <groupId>com.microsoft.azure</groupId>
              <artifactId>azure-webapp-maven-plugin</artifactId>
              <version>1.15.0</version>
              <configuration>                  
                 <!-- Reference <serverId> in Maven's settings.xml to authenticate with Azure -->
                 <auth>
                   <serverId>${AZURE_AUTH}</serverId>
                 </auth>
                 
                 <!-- Web App information -->
                 <resourceGroup>${RESOURCEGROUP_NAME}</resourceGroup>
                 <appName>${WEBAPP_NAME}</appName>
                 <region>westeurope</region>
                 <pricingTier>P1v2</pricingTier>
  
                 <!-- Java Runtime Stack for Web App on Windows-->
                 <runtime>
                   <os>Windows</os>
                   <javaVersion>Java 8</javaVersion>
                   <webContainer>Tomcat 8.5</webContainer>
                 </runtime>
                 <!-- Deployment settings -->
                 <deployment>
                   <resources>
                     <resource>
                       <directory>${project.basedir}/target</directory>
                       <targetPath>${project.build.finalName}</targetPath>
                       <includes>
                         <include>*.war</include>
                       </includes>
                     </resource>
                   </resources>
                 </deployment>
              </configuration>
           </plugin>
           ...
        </plugins>
     </build>
  </project>

Web App for Containers with public DockerHub container image

The following configuration is applicable for below scenario:

• Reference ${azure.auth.filePath} in Maven's settings.xml to authenticate with Azure

• Web App for Containers

• Use public DockerHub image springio/gs-spring-boot-docker:latest as runtime stack

• Add Application Settings to your Web App

  <project>
     ...
     <build>
        <plugins>
           <plugin>
              <groupId>com.microsoft.azure</groupId>
              <artifactId>azure-webapp-maven-plugin</artifactId>
              <version>1.15.0</version>
              <configuration>                  
                 <!-- Reference ${azure.auth.filePath} from Maven's settings.xml to authenticate with Azure -->
                 <auth>
                   <file>${azure.auth.filePath}</file>
                 </auth>
                 
                 <!-- Web App information -->
                 <resourceGroup>${RESOURCEGROUP_NAME}</resourceGroup>
                 <appName>${WEBAPP_NAME}</appName>
                 
                 <region>westeurope</region>
                 <pricingTier>P1v2</pricingTier>
                 
                 <!-- Runtime Stack specified by Docker container image -->
                 <runtime>
                   <os>Docker</os>
                   <image>springio/gs-spring-boot-docker:latest</image>
                 </runtime>
              </configuration>
           </plugin>
           ...
        </plugins>
     </build>
  </project>

Web App deployment to an existing App Service Plan

The following configuration is applicable for below scenario:

• Web App on Linux

• Use existing App Service Plan

• Use Java 8 and Tomcat 8.5

• Use WAR to deploy WAR file to ROOT: / in Tomcat

  <project>
     ...
     <packaging>war</packaging>
     ...
     <build>
        <plugins>
           <plugin>
              <groupId>com.microsoft.azure</groupId>
              <artifactId>azure-webapp-maven-plugin</artifactId>
              <version>1.15.0</version>
              <configuration>
                 
                 <!-- Web App information -->
                 <resourceGroup>${RESOURCEGROUP_NAME}</resourceGroup>
                 <appName>${WEBAPP_NAME}</appName>
  
                 <!-- Deploy Web App to the existing App Service Plan -->
                 <appServicePlanResourceGroup>${PLAN_RESOURCEGROUP_NAME}</appServicePlanResourceGroup>
                 <appServicePlanName>${PLAN_NAME}</appServicePlanName>
                 
                 <!-- Java Runtime Stack for Web App on Linux-->
                   <runtime>
                   <os>Linux</os>
                   <webContainer>Tomcat 8.5</webContainer>
                   <javaVersion>Java 8</javaVersion>
                 </runtime>
              </configuration>
           </plugin>
           ...
        </plugins>
     </build>
  </project>

Deploy to Web App Deployment Slot

The following configuration is applicable for below scenario:

• Reference <serverId> in Maven's settings.xml to authenticate with Azure
• Web App on Linux
• Use Java 8 and Tomcat 8.5
• Use WAR deployment to deploy war file to context path /${project.build.finalName} in your Web App server
• Create a deployment slot and copy configuration from parent Web App then do the deploy

<project>
    ...
    <build>
        <plugins>
            <plugin>
                <groupId>com.microsoft.azure</groupId>
                <artifactId>azure-webapp-maven-plugin</artifactId>
                <version>1.15.0</version>
                <configuration>
                    <authentication>
                        <serverId>${AZURE_AUTH}</serverId>
                    </authentication>
                    
                    <!-- Web App information -->
                    <resourceGroup>${RESOURCEGROUP_NAME}</resourceGroup>
                    <appName>${WEBAPP_NAME}</appName>

                    <!-- Deployment Slot Setting -->
                    <deploymentSlotSetting>
                        <name>${SLOT_NAME}</name>
                        <configurationSource>parent</configurationSource>
                    </deploymentSlotSetting>
                    
                    <!-- Java Runtime Stack for Web App on Linux-->
                    <runtime>
                      <os>Windows</os>
                      <javaVersion>Java 8</javaVersion>
                      <webContainer>Tomcat 8.5</webContainer>
                    </runtime>                  
                
                </configuration>
            </plugin>
        </plugins>
    </build>
</project>