Deploy a KumuluzEE Web App to Azure App Service with Maven

Article
03/30/2023

In this quickstart, you'll use the Maven Plugin for Azure App Service Web Apps to deploy a KumuluzEE application to Azure App Service on Linux. You'll want to choose Java SE deployment over Tomcat and WAR files when you want to consolidate your app's dependencies, runtime, and configuration into a single deployable artifact.

If you don’t have an Azure subscription, create a free account before you begin.

Prerequisites

The Azure CLI, either locally or through Azure Cloud Shell.
A supported Java Development Kit (JDK). For more information about the JDKs available for use when developing on Azure, see Java support on Azure and Azure Stack.
Apache Maven, version 3.

The simplest and easiest way to get the Maven Plugin deploying your KumuluzEE application is by using Azure CLI.

Sign into your Azure account by using the Azure CLI:

az login

Follow the instructions to complete the sign-in process.

Create sample app from MicroProfile Starter

In this section, you'll create a KumuluzEE application and test it locally.

Create Java SE 8 base Project

Open a web browser and navigate to the MicroProfile Starter site.

Input or Select the field like follows.

Field	Value
groupId	com.microsoft.azure.samples.kumuluzee
artifactId	kumuluzEE-hello-azure
MicroProfile Version	MP 3.2
Java SE Version	Java 8
MicroProfile Runtime	KumuluzEE
Examples for Specifications	Metrics, OpenAPI

Select DOWNLOAD to download the project.
Unzip the archive file; for example:
```
unzip kumuluzEE-hello-azure.zip
```

Run the application in Local environment

Change directory to the completed project; for example:
```
cd kumuluzEE-hello-azure/
```
Build the project using Maven; for example:
```
mvn clean package
```

Run the Application using following command:

java -jar target/kumuluzEE-hello-azure.jar

Test the web app by browsing to it locally using a web browser. For example, you could use the following command if you have curl available:
```
curl http://localhost:8080/data/hello
```
You should see the following message displayed: Hello World.

Configure Maven Plugin for Azure App Service

In this section, you'll configure the KumuluzEE project pom.xml file so that Maven can deploy the app to Azure App Service on Linux.

Open the pom.xml file in a code editor.

In the <build> section of the pom.xml file, insert the following <plugin> entry inside the <plugins> tag.

<build>
  <finalName>kumuluzEE-hello-azure</finalName>
  <plugins>
    <plugin>
      <groupId>com.microsoft.azure</groupId>
      <artifactId>azure-webapp-maven-plugin</artifactId>
      <version>1.10.0</version>
    </plugin>
  </plugins>
</build>

Then you can configure the deployment. Run the following Maven command:

mvn azure-webapp:config

Select the following options when prompted:

Input Field	Input/Select Value
Define value for OS(Default: Linux):	1. linux
Define value for javaVersion(Default: Java 8):	2. Java 8
Confirm (Y/N)	y

This command produces output similar to the following example:

[INFO] Scanning for projects...
[INFO]
[INFO] ----< com.microsoft.azure.samples.kumuluzee:kumuluzEE-hello-azure >-----
[INFO] Building kumuluzEE-hello-azure 1.0-SNAPSHOT
[INFO] --------------------------------[ jar ]---------------------------------
[INFO]
[INFO] --- azure-webapp-maven-plugin:1.10.0:config (default-cli) @ kumuluzEE-hello-azure ---
1. linux [*]
2. windows
3. docker
Enter index to use: 1
Define value for javaVersion(Default: Java 8):
1. Java 11
2. Java 8 [*]
Enter index to use: 2
Please confirm webapp properties
AppName : kumuluzEE-hello-azure-1601006602397
ResourceGroup : kumuluzEE-hello-azure-1601006602397-rg
Region : westeurope
PricingTier : PremiumV2_P1v2
OS : Linux
RuntimeStack : JAVA 8-jre8
Deploy to slot : false
Confirm (Y/N)? : y
[INFO] Saving configuration to pom.
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time:  44.223 s
[INFO] Finished at: 2020-09-25T13:04:02+09:00
[INFO] ------------------------------------------------------------------------

Add the <appSettings> section to the <configuration> section of PORT, WEBSITES_PORT, and WEBSITES_CONTAINER_START_TIME_LIMIT. Your XML entry for azure-webapp-maven-plugin will look similar to the following example:

<plugin>
  <groupId>com.microsoft.azure</groupId>
  <artifactId>azure-webapp-maven-plugin</artifactId>
  <version>1.10.0</version>
  <configuration>
    <schemaVersion>V2</schemaVersion>
    <resourceGroup>microprofile</resourceGroup>
    <appName>kumuluzEE-hello-azure-1601006602397</appName>
    <pricingTier>P1v2</pricingTier>
    <region>japaneast</region>
    <runtime>
      <os>linux</os>
      <javaVersion>jre8</javaVersion>
      <webContainer>jre8</webContainer>
    </runtime>
    <appSettings>
      <property>
        <name>PORT</name>
        <value>8080</value>
      </property>
      <property>
        <name>WEBSITES_PORT</name>
        <value>8080</value>
      </property>
      <property>
        <name>WEBSITES_CONTAINER_START_TIME_LIMIT</name>
        <value>600</value>
      </property>
    </appSettings>
    <deployment>
      <resources>
        <resource>
          <directory>${project.basedir}/target</directory>
          <includes>
            <include>*.jar</include>
          </includes>
        </resource>
      </resources>
    </deployment>
  </configuration>
</plugin>

Deploy the app to Azure

After you've configured all of the settings in the preceding sections of this article, you're ready to deploy your web app to Azure. To do so, use the following steps:

From the command prompt or terminal window that you were using earlier, rebuild the JAR file using Maven if you made any changes to the pom.xml file; for example:
```
mvn clean package
```
Deploy your web app to Azure by using Maven; for example:
```
mvn azure-webapp:deploy
```

If the deployment succeeded, you'll see the following output.

[INFO] Successfully deployed the artifact to https://kumuluzee-hello-azure-1601006602397.azurewebsites.net
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time:  01:23 min
[INFO] Finished at: 2020-09-25T13:13:14+09:00
[INFO] ------------------------------------------------------------------------

Maven will deploy your web app to Azure. If the web app or web app plan doesn't already exist, it will be created for you. It might take a few minutes before the web app is visible at the URL shown in the output. Navigate to the URL in a Web browser. You should see the following screen.

Screenshot of web browser showing KumuluzEE front page.

When your web has been deployed, you can manage it through the Azure portal.

Your web app will be listed in the microprofile resource group, as shown in the following screenshot:

You can access to your web app by selecting Browse on the Overview page for your web app. Verify that the deployment was successful and Running. You should see the following screen displayed:

Confirm the log stream from the running App Service

You can see (or "tail") the logs from the running App Service. Any calls to console.log in the site code are displayed in the terminal.

az webapp log tail \
    --resource-group microprofile \
    --name kumuluzEE-hello-azure-1601006602397

Clean up resources

When the Azure resources are no longer needed, clean up the resources you deployed by deleting the resource group.

From the Azure portal, select Resource group from the left menu.
Enter microprofile in the Filter by name field, the resource group created in this tutorial should have this prefix.
Select the resource group created in this tutorial.
Select Delete resource group from the top menu.

Next steps

To learn more about MicroProfile and Azure, continue to the MicroProfile on Azure documentation center.

MicroProfile on Azure

Additional resources

For more information about the various technologies discussed in this article, see the following articles:

Deploy a KumuluzEE Web App to Azure App Service with Maven

Prerequisites

Create sample app from MicroProfile Starter

Create Java SE 8 base Project

Run the application in Local environment

Configure Maven Plugin for Azure App Service

Deploy the app to Azure

Confirm the log stream from the running App Service

Clean up resources

Next steps

Additional resources

Feedback

Feedback

Additional resources

Deploy a KumuluzEE Web App to Azure App Service with Maven

Prerequisites

Sign in to Azure CLI

Create sample app from MicroProfile Starter

Create Java SE 8 base Project

Run the application in Local environment

Configure Maven Plugin for Azure App Service

Deploy the app to Azure

Confirm the log stream from the running App Service

Clean up resources

Next steps

Additional resources

Feedback

Feedback

Additional resources