Skip to content

java-microservice-get-started.md

Latest commit

 

History

History
387 lines (270 loc) · 18.5 KB

java-microservice-get-started.md

File metadata and controls

387 lines (270 loc) · 18.5 KB
title Launch a Java Microservice Application with Managed Java Components
titleSuffix Azure Container Apps
description Learn how to deploy a Java microservice project in Azure Container Apps with managed Java components.
services container-apps
author KarlErickson
ms.author karler
ms.reviewer yiliu6
ms.service azure-container-apps
ms.topic quickstart
ms.date 03/26/2026
ms.custom
devx-track-java
sfi-image-nochange

Quickstart: Launch a Java microservice application with managed Java components

This article explains how to deploy an application in Azure Container Apps that uses Java components to handle configuration management, service discovery, and health and metrics. The sample application shown in this example is the Java PetClinic, which uses the microservice architecture pattern. The following diagram depicts the architecture of the PetClinic application on Azure Container Apps:

:::image type="complex" source="media/java-microservice-get-started/azure-container-apps-pet-clinic-architecture.png" alt-text="Diagram of the relationship between the Java components and the microservice applications." lightbox="media/java-microservice-get-started/azure-container-apps-pet-clinic-architecture.png"::: Diagram of an Azure Container Apps environment showing the architecture of four microservices-based applications deployed within an Azure resource group. A resource group contains the Azure Container Apps environment. The environment includes three Azure Container Apps managed Java components: a config server, a service registry, and an admin server. The config server fetches configuration data stored as versioned YAML files in a Git repository external to the Azure Container Apps environment. The service registry handles service discovery and registration. The admin server provides a live view of the system. An API gateway routes requests to three microservices: vets service, customers service, and visits service. Each service is linked to its own database for data persistence. The environment supports external interactions through a browser and a mobile app and integrates with monitoring tools via Azure Log Analytics Workspaces for tracking system performance and health. :::image-end:::

The PetClinic application includes the following features:

  • The front end is a standalone Node.js web app hosted on the API gateway app.
  • The API gateway routes requests to back-end service apps.
  • Back-end apps are built with Spring Boot.
  • Each back-end app uses a HyperSQL database as the persistent store.
  • The apps use managed Java components on Azure Container Apps, including a service registry, config server, and admin server.
  • The config server reads data from a Git repository.
  • A Log Analytics workspace logs server data.

In this tutorial, you:

[!div class="checklist"]

  • Create a config server, Eureka server, admin server, and admin components
  • Create a series of microservice apps
  • Bind the server components to your microservices apps
  • Deploy the collection of apps
  • Review the deployed apps

By the end of this article, you deploy one web application and three back-end applications that are configured to work with three different Java components. You can then manage each component via the Azure portal.

Prerequisites

  • An Azure account. If you don't have an Azure account, create one for free. For this quickstart, you need the Contributor or Owner role on the Azure subscription. For more information, see Assign Azure roles using the Azure portal.
  • Install the Azure CLI.
  • Azure Container Apps CLI extension, version 0.3.47 or higher. Use the az extension add --name containerapp --upgrade --allow-preview command to install the latest version.

Setup

To create environment variables, a resource group, and an Azure Container Apps environment, use the following steps:

  1. The environment variables contain your custom values, so replace the placeholder values surrounded by <> with your own values before you run the following commands:

    export RESOURCE_GROUP=<your-resource-group>
export LOCATION=<region>
export CONTAINER_APP_ENVIRONMENT=<container-apps-environment>

  2. Create more environment variables that contain the settings for your microservices app. These values are used to define the names and configurations of the Java components and the Azure Container Apps that you use to deploy the microservices. Create these environment variables by using the following commands:

    export CONFIG_SERVER_COMPONENT=configserver
export ADMIN_SERVER_COMPONENT=admin
export EUREKA_SERVER_COMPONENT=eureka
export CONFIG_SERVER_URI=https://github.com/spring-petclinic/spring-petclinic-microservices-config.git
export CUSTOMERS_SERVICE=customers-service
export VETS_SERVICE=vets-service
export VISITS_SERVICE=visits-service
export API_GATEWAY=api-gateway
export CUSTOMERS_SERVICE_IMAGE=ghcr.io/azure-samples/javaaccelerator/spring-petclinic-customers-service
export VETS_SERVICE_IMAGE=ghcr.io/azure-samples/javaaccelerator/spring-petclinic-vets-service
export VISITS_SERVICE_IMAGE=ghcr.io/azure-samples/javaaccelerator/spring-petclinic-visits-service
export API_GATEWAY_IMAGE=ghcr.io/azure-samples/javaaccelerator/spring-petclinic-api-gateway

  3. Sign in to the Azure CLI and choose your active subscription by using the following command:

    az login

  4. Create a resource group to organize your Azure services by using the following command:

    az group create \
    --name $RESOURCE_GROUP \
    --location $LOCATION

  5. Create your Azure Container Apps environment, which hosts both the Java components and your container apps, using the following command:

    az containerapp env create \
    --resource-group $RESOURCE_GROUP \
    --name $CONTAINER_APP_ENVIRONMENT \
    --location $LOCATION

Create Java components

Now you create the following Java components that support your app:

  • Config server: Manages configuration settings for your microservices apps.
  • Eureka server: Manages service registry and discovery.
  • Admin server: Monitors and manages the health and metrics of your microservices apps.

To create these server components, use the following steps:

Azure CLI

  1. Create the config server for your Java components by using the following command:

    az containerapp env java-component config-server-for-spring create \
    --resource-group $RESOURCE_GROUP \
    --name $CONFIG_SERVER_COMPONENT \
    --environment $CONTAINER_APP_ENVIRONMENT \
    --configuration spring.cloud.config.server.git.uri=$CONFIG_SERVER_URI

  2. Create the Eureka server for your Java components by using the following command:

    az containerapp env java-component eureka-server-for-spring create \
    --resource-group $RESOURCE_GROUP \
    --name $EUREKA_SERVER_COMPONENT
    --environment $CONTAINER_APP_ENVIRONMENT \

  3. Create the admin server for your Java components by using the following command:

    az containerapp env java-component admin-for-spring create \
    --resource-group $RESOURCE_GROUP \
    --name $ADMIN_SERVER_COMPONENT
    --environment $CONTAINER_APP_ENVIRONMENT \

Azure portal

To create the three Java components, use the following steps:

  1. Open your Container Apps environment in the Azure portal.

  2. Under Services in the sidebar menu, select Services.

  3. To create the config server component, use these steps:

    1. Select Configure and choose Java component to create a new Java component.

    2. Use the following table to add the values in the portal window:

      Setting Value Remarks
      Java component type Select Config Server for Spring.
      Java component name Enter configserver. This value matches what you defined for the $CONFIG_SERVER_COMPONENT variable.

    3. In the Git repositories section, select Add.

    4. For the URI field, enter https://github.com/spring-petclinic/spring-petclinic-microservices-config.git. (Don't include the final period.)

    5. Select Add.

    6. Select Next.

    7. Select Configure to finish the configuration.

  4. To create the Eureka server component, use these steps:

    1. Select Configure, and choose Java component to create a new Java component.

    2. Use the following table to add the values in the portal window:

      Setting Value Remarks
      Java component type Select Eureka Server for Spring.
      Java component name Enter eureka. This value matches what you defined for the $EUREKA_SERVER_COMPONENT variable.

    3. Select Next.

    4. Select Configure to finish the configuration.

  5. To create the admin server component, use the following steps:

    1. Select Configure and choose Java component to create a new Java component.

    2. Use the following table to add the values in the portal window:

      Setting Value Remarks
      Java component type Select Admin for Spring.
      Java component name Enter admin. This value matches what you defined for the $ADMIN_SERVER_COMPONENT variable.

    3. Select Next.

    4. Select Configure to finish the configuration.

Deploy the microservice apps

To deploy the Java microservice apps to Azure Container Apps using the prebuilt container images, use the following steps:

Note

In this article, you use a series of built images for the Spring Petclinic microservice apps. You also have the option to customize the sample code and use your own images. For more information, see the azure-container-apps-java-samples GitHub repository.

  1. Create the customer data app by using the following command:

    az containerapp create \
    --resource-group $RESOURCE_GROUP \
    --name $CUSTOMERS_SERVICE \
    --environment $CONTAINER_APP_ENVIRONMENT \
    --image $CUSTOMERS_SERVICE_IMAGE

  2. Create the vet app by using the following command:

    az containerapp create \
    --resource-group $RESOURCE_GROUP \
    --name $VETS_SERVICE \
    --environment $CONTAINER_APP_ENVIRONMENT \
    --image $VETS_SERVICE_IMAGE

  3. Create the visits app by using the following command:

    az containerapp create \
    --resource-group $RESOURCE_GROUP \
    --name $VISITS_SERVICE \
    --environment $CONTAINER_APP_ENVIRONMENT \
    --image $VISITS_SERVICE_IMAGE

  4. Create the API gateway app by using the following command:

    az containerapp create \
    --resource-group $RESOURCE_GROUP \
    --name $API_GATEWAY \
    --environment $CONTAINER_APP_ENVIRONMENT \
    --image $API_GATEWAY_IMAGE \
    --ingress external \
    --target-port 8080 \
    --query properties.configuration.ingress.fqdn

Bind container apps to Java components

Next, bind the Java components to your container apps. The bindings that you create in this section provide the following functionality:

  • Inject configuration data into each app from the managed config server on startup.
  • Register the app with the managed Eureka server for service discovery.
  • Enable the admin server to monitor the app.

Azure CLI

Use the containerapp update command to create bindings for each app by using the following steps:

  1. Add bindings to the customer data app by using the following command:

    az containerapp update \
    --resource-group $RESOURCE_GROUP \
    --name $CUSTOMERS_SERVICE \
    --bind $CONFIG_SERVER_COMPONENT $EUREKA_SERVER_COMPONENT $ADMIN_SERVER_COMPONENT

  2. Add bindings to the vet service by using the following command:

    az containerapp update \
    --resource-group $RESOURCE_GROUP \
    --name $VETS_SERVICE \
    --bind $CONFIG_SERVER_COMPONENT $EUREKA_SERVER_COMPONENT $ADMIN_SERVER_COMPONENT

  3. Add bindings to the visits service by using the following command:

    az containerapp update \
    --resource-group $RESOURCE_GROUP \
    --name $VISITS_SERVICE \
    --bind $CONFIG_SERVER_COMPONENT $EUREKA_SERVER_COMPONENT $ADMIN_SERVER_COMPONENT

  4. Add bindings to the API gateway. Use the following command to return the URL of the front-end application:

    az containerapp update \
    --resource-group $RESOURCE_GROUP \
    --name $API_GATEWAY \
    --bind $CONFIG_SERVER_COMPONENT $EUREKA_SERVER_COMPONENT $ADMIN_SERVER_COMPONENT \
    --query properties.configuration.ingress.fqdn

Azure portal

Use the following steps to create bindings for each app:

  1. Open your Container Apps environment in the Azure portal.

  2. Under Services in the sidebar menu, select Service.

  3. For each of the three components, select the component by name.

  4. In the Bindings section, add the four apps created in this quickstart.

    :::image type="content" source="media/java-microservice-get-started/azure-container-apps-bindings-section.png" alt-text="Screenshot of the Bindings section. Four apps are listed: customers-service, vets-service, visits-service, and API gateway.":::

  5. To find the URL of the front-end application, search for and select Container Apps in the portal, then select api-gateway. In the Overview section, copy the application URL.

Verify app status

Use the following steps to verify the app status:

  1. Using the URL that you found in the previous section, view the front-end application in your browser. The application should resemble the following screenshot:

    :::image type="content" source="media/java-microservice-get-started/azure-container-apps-petclinic-home-page.png" alt-text="Screenshot of the home page of the pet clinic application." lightbox="media/java-microservice-get-started/azure-container-apps-petclinic-home-page.png":::

  2. View the Eureka server dashboard by using the following steps:

    [!IMPORTANT] To view the Eureka Server dashboard and Admin for Spring dashboard, you need to have at least the Microsoft.App/managedEnvironments/write role assigned to your account on the managed environment resource. You can explicitly assign the Owner or Contributor role on the resource. You can also follow the steps to create a custom role definition and assign it to your account.

    1. Run the following command to return the dashboard URL:

      az containerapp env java-component eureka-server-for-spring show \
    --resource-group $RESOURCE_GROUP \
    --name $EUREKA_SERVER_COMPONENT \
    --environment $CONTAINER_APP_ENVIRONMENT \
    --query properties.ingress.fqdn

    2. Open the URL in your browser. You should see an application that resembles the following screenshot:

      :::image type="content" source="media/java-microservice-get-started/azure-container-apps-petclinic-eureka-server.png" alt-text="Screenshot of pet clinic application Eureka Server." lightbox="media/java-microservice-get-started/azure-container-apps-petclinic-eureka-server.png":::

  3. View the Admin for Spring dashboard by using the following steps:

    1. Use the following command to return the dashboard URL:

      az containerapp env java-component admin-for-spring show \
    --resource-group $RESOURCE_GROUP \
    --name $ADMIN_SERVER_COMPONENT \
    --environment $CONTAINER_APP_ENVIRONMENT \
    --query properties.ingress.fqdn

    2. Open the URL in your browser. You should see an application that resembles the following screenshot:

      :::image type="content" source="media/java-microservice-get-started/azure-container-apps-pet-clinic-administration.png" alt-text="Screenshot of the pet clinic admin dashboard showing five services up, along with version information for four of the services." lightbox="media/java-microservice-get-started/azure-container-apps-pet-clinic-administration.png":::

Optional: Configure Java components

You can configure the Java components created in this quickstart through the Azure portal by using the Configurations section.

:::image type="content" source="media/java-microservice-get-started/azure-portal-java-configurations-sections.png" alt-text="Screenshot of the Configurations section, showing Property Name and Value textboxes, and the ability to delete a property." lightbox="media/java-microservice-get-started/azure-portal-java-configurations-sections.png":::

For more information on configuring the three Java components you created in this quickstart, see the following links:

Clean up resources

The resources created in this quickstart have an effect on your Azure bill. If you aren't going to use these services long-term, use the following command to remove everything created in this quickstart:

az group delete --resource-group $RESOURCE_GROUP

Related content