Skip to content

Latest commit

 

History

History
160 lines (108 loc) · 7.58 KB

quickstart-deploy-java-native-image-app.md

File metadata and controls

160 lines (108 loc) · 7.58 KB
Raw
title description author ms.service ms.topic ms.date ms.custom ms.author
Quickstart - Deploy your first Java Native Image application to Azure Spring Apps
Describes how to deploy a Java Native Image application to Azure Spring Apps.
KarlErickson
azure-spring-apps
quickstart
08/28/2024
devx-track-java, devx-track-extended-java, devx-track-azurecli, mode-other, engagement-fy23, references_regions
yili7

Quickstart: Deploy your first Java Native Image application to Azure Spring Apps

Note

The first 50 vCPU hours and 100 GB hours of memory are free each month. For more information, see Price Reduction - Azure Spring Apps does more, costs less! on the Apps on Azure Blog.

Note

Azure Spring Apps is the new name for the Azure Spring Cloud service. Although the service has a new name, you'll see the old name in some places for a while as we work to update assets such as screenshots, videos, and diagrams.

This article applies to: ❌ Basic/Standard ✔️ Enterprise

This quickstart shows how to deploy a Spring Boot application to Azure Spring Apps as a Native Image.

Native Image capability enables you to compile Java applications to standalone executables, known as Native Images. These executables can provide significant benefits, including faster startup times and lower runtime memory overhead compared to a traditional JVM (Java Virtual Machine).

The sample project is the Spring Petclinic application. The following screenshot shows the application:

:::image type="content" source="./media/quickstart-deploy-java-native-image-app/spring-petclinic-app.png" alt-text="Screenshot of a Spring Petclinic application in Azure Spring Apps." lightbox="./media/quickstart-deploy-java-native-image-app/spring-petclinic-app.png":::

1. Prerequisites

[!INCLUDE deploy-to-azure-spring-apps-enterprise-plan]

5. Validate Native Image App

Now you can access the deployed Native Image app to see whether it works. Use the following steps to validate:

  1. After the deployment has completed, you can run the following command to get the app URL:

    az spring app show \
    --service ${AZURE_SPRING_APPS_NAME} \
    --name ${NATIVE_APP_NAME} \
    --output table

    You can access the app with the URL shown in the output as Public Url. The page should appear as you saw it o localhost.

  2. Use the following command to check the app's log to investigate any deployment issue:

    az spring app logs \
    --service ${AZURE_SPRING_APPS_NAME} \
    --name ${NATIVE_APP_NAME}

6. Compare performance for JAR and Native Image

The following sections describe how to compare the performance between JAR and Native Image deployment.

Server startup time

Use the following command to check the app's log Started PetClinicApplication in XXX seconds to get the server startup time for a JAR app:

az spring app logs \
    --service ${AZURE_SPRING_APPS_NAME} \
    --name ${JAR_APP_NAME}

The server startup time is around 25 s for a JAR app.

Use the following command to check the app's log to get the server startup time for a Native Image app:

az spring app logs \
    --service ${AZURE_SPRING_APPS_NAME} \
    --name ${NATIVE_APP_NAME}

The server startup time is less than 0.5 s for a Native Image app.

Memory usage

Use the following command to scale down the memory size to 512 Mi for a Native Image app:

az spring app scale \
    --service ${AZURE_SPRING_APPS_NAME} \
    --name ${NATIVE_APP_NAME} \
    --memory 512Mi

The command output should show that the Native Image app started successfully.

Use the following command to scale down the memory size to 512 Mi for the JAR app:

az spring app scale \
    --service ${AZURE_SPRING_APPS_NAME} \
    --name ${JAR_APP_NAME} \
    --memory 512Mi

The command output should show that the JAR app failed to start due to insufficient memory. The output message should be similar to the following example: Terminating due to java.lang.OutOfMemoryError: Java heap space.

The following figure shows the optimized memory usage for the Native Image deployment for a constant workload of 400 requests per second into the Petclinic application. The memory usage is about 1/5th of the memory consumed by its equivalent JAR deployment.

:::image type="content" source="./media/quickstart-deploy-java-native-image-app/optimized-memory-usage.png" alt-text="Screenshot of the optimized memory usage of a Native Image deployment in Azure Spring Apps." lightbox="./media/quickstart-deploy-java-native-image-app/optimized-memory-usage.png":::

Native Images offer quicker startup times and reduced runtime memory overhead when compared to the conventional Java Virtual Machine (JVM).

7. Clean up resources

If you plan to continue working with subsequent quickstarts and tutorials, you might want to leave these resources in place. When you no longer need the resources, delete them by deleting the resource group. Use the following command to delete the resource group:

az group delete --name ${RESOURCE_GROUP}

8. Next steps

[!div class="nextstepaction"] How to deploy Java Native Image apps in the Azure Spring Apps Enterprise plan

[!div class="nextstepaction"] Structured application log for Azure Spring Apps

[!div class="nextstepaction"] Map an existing custom domain to Azure Spring Apps

[!div class="nextstepaction"] Set up Azure Spring Apps CI/CD with GitHub Actions

[!div class="nextstepaction"] Set up Azure Spring Apps CI/CD with Azure DevOps

[!div class="nextstepaction"] Use managed identities for applications in Azure Spring Apps

[!div class="nextstepaction"] Create a service connection in Azure Spring Apps with the Azure CLI

[!div class="nextstepaction"] Run the polyglot ACME fitness store apps on Azure Spring Apps

[!div class="nextstepaction"] Monitor your Spring Boot Native Image application

For more information, see the following articles: