The Admin for Spring managed component offers an administrative interface for Spring Boot web applications that expose actuator endpoints. As a managed component in Azure Container Apps, you can easily bind your container app to Admin for Spring for seamless integration and management.

This tutorial shows you how to create an Admin for Spring Java component and bind it to your container app so that you can monitor and manage your Spring applications with ease.

:::image type="content" source="media/java-components/spring-boot-admin-overview.png" alt-text="Screenshot that shows an overview of the Admin for Spring insights dashboard." lightbox="media/java-components/spring-boot-admin-overview.png":::

In this tutorial, you learn how to:

[!div class="checklist"]

• Create an Admin for Spring Java component.
• Bind your container app to an Admin for Spring Java component.

If you want to integrate Admin for Spring with Eureka Server for Spring, see Integrate Admin for Spring with Eureka Server for Spring in Container Apps instead.

• An Azure account with an active subscription. If you don't already have one, you can can create one for free.
• Azure CLI.

When you run the Admin for Spring component in Container Apps, be aware of the following details:

[!INCLUDE container-apps/component-considerations.md]

Before you begin to work with the Admin for Spring component, you first need to create the required resources.

The following commands help you create your resource group and container app environment.

1. Create variables to support your application configuration. These values are provided for you for the purposes of this lesson.

   export LOCATION=eastus
   export RESOURCE_GROUP=my-resource-group
   export ENVIRONMENT=my-environment
   export JAVA_COMPONENT_NAME=admin
   export APP_NAME=sample-admin-client
   export IMAGE="mcr.microsoft.com/javacomponents/samples/sample-admin-for-spring-client:latest"

   Variable	Description
   LOCATION	The Azure region location where you create your container app and Java component.
   ENVIRONMENT	The container app environment name for your demo application.
   RESOURCE_GROUP	The Azure resource group name for your demo application.
   JAVA_COMPONENT_NAME	The name of the Java component created for your container app. In this case, you create an Admin for Spring Java component.
   IMAGE	The container image used in your container app.

2. Sign in to Azure with the Azure CLI.

   az login
   

3. Create a resource group.

   az group create \
       --name $RESOURCE_GROUP \
       --location $LOCATION \
       --query "properties.provisioningState"
   

   When you use the --query parameter, the response filters down to a simple success or failure message.

4. Create your container app environment.

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

To create each of the resources necessary to create a container app, follow these steps:

1. Search for Container Apps in the Azure portal and select Create.

2. On the Basics tab, enter the following values:

   Property	Value
   Subscription	Select your Azure subscription.
   Resource group	Select Create new to create a new resource group named my-resource-group.
   Container app name	Enter sample-admin-client.
   Deployment source	Select Container image.
   Region	Select the region nearest you.
   Container app environment	Select Create new to create a new environment.

3. On the Create Container Apps environment window, enter the following values:

   Property	Value
   Environment name	Enter my-environment.
   Zone redundancy	Select Disabled.

4. Select Create, and then select the Container tab.

5. On the Container tab, enter the following values:

   Property	Value
   Name	Enter sample-admin-client.
   Image source	Select Docker Hub or other registries.
   Image type	Select Public.
   Registry sign-in server	Enter mcr.microsoft.com.
   Image and tag	Enter javacomponents/samples/sample-admin-for-spring-client:latest.

6. Select the Ingress tab.

7. On the Ingress tab, enter the following values and leave the rest of the form filled in with the default values.

   Property	Value
   Ingress	Select Enabled.
   Ingress traffic	Select Accept traffic from anywhere.
   Ingress type	Select HTTP.
   Target port	Enter 8080.

8. Select Review + create.

9. After the validation checks pass, select Create to create your container app.

Now that you have an existing environment, you can create your container app and bind it to a Java component instance of an Admin for Spring component.

1. Create the Admin for Spring Java component.

   az containerapp env java-component admin-for-spring create \
       --environment $ENVIRONMENT \
       --resource-group $RESOURCE_GROUP \
       --name $JAVA_COMPONENT_NAME \
       --min-replicas 1 \
       --max-replicas 1
   

2. Update the Admin for Spring Java component.

   az containerapp env java-component admin-for-spring update \
       --environment $ENVIRONMENT \
       --resource-group $RESOURCE_GROUP \
       --name $JAVA_COMPONENT_NAME \
       --min-replicas 2 \
       --max-replicas 2
   

Now that you have an existing environment and admin client container app, you can create a Java component instance of Admin for Spring.

1. Go to your container app's environment in the portal.

2. On the service menu, under Services, select Services.

3. Select the Configure dropdown, then select Java component.

4. On the Configure Java component pane, enter the following values:

   Property	Value
   Java component type	Select Admin for Spring.
   Java component name	Enter admin.

5. Select Next.

6. On the Review tab, select Configure.

1. Create the container app and bind it to the Admin for Spring component.

   az containerapp create \
       --name $APP_NAME \
       --resource-group $RESOURCE_GROUP \
       --environment $ENVIRONMENT \
       --image $IMAGE \
       --min-replicas 1 \
       --max-replicas 1 \
       --ingress external \
       --target-port 8080 \
       --bind $JAVA_COMPONENT_NAME
   

1. Go to your Container App environment in the portal.

2. On the service menu, under Services, select Services.

3. From the list, select admin.

4. Under Bindings, select the App name dropdown, then select sample-admin-client.

5. Select the Review tab.

6. Select Configure.

7. Return to your container app in the portal. Copy the URL of your app to a text editor so that you can use it in an upcoming step.

The bind operation binds the container app to the Admin for Spring Java component. The container app can now read the configuration values from environment variables, primarily the SPRING_BOOT_ADMIN_CLIENT_URL property, and connect to the Admin for Spring component.

The binding also injects the following property:

"SPRING_BOOT_ADMIN_CLIENT_INSTANCE_PREFER-IP": "true",

This property indicates that the Admin for Spring component client should prefer the IP address of the container app instance when you connect to the Admin for Spring server.

To remove a binding from a container app, use the --unbind option.

az containerapp update \
    --name $APP_NAME \
    --unbind $JAVA_COMPONENT_NAME \
    --resource-group $RESOURCE_GROUP

1. Go to your container app environment in the portal.

2. On the service menu, under Services, select Services.

3. From the list, select admin.

4. Under Bindings, find the line for sample-admin-client, select it, and then select Delete.

5. Select Next.

6. Select the Review tab.

7. Select Configure.

1. Create the custom role definition.

   az role definition create --role-definition '{
       "Name": "<ROLE_NAME>",
       "IsCustom": true,
       "Description": "Can access managed Java Component dashboards in managed environments",
       "Actions": [
           "Microsoft.App/managedEnvironments/write"
       ],
       "AssignableScopes": ["/subscriptions/<SUBSCRIPTION_ID>"]
   }'
   

   Make sure to replace the placeholders in between the <> brackets with your values.

2. Assign the custom role to your account on the managed environment resource.

   Get the resource ID of the managed environment:

   export ENVIRONMENT_ID=$(az containerapp env show \
       --name $ENVIRONMENT --resource-group $RESOURCE_GROUP \ 
       --query id \
       --output tsv)
   

3. Assign the role to your account.

   Before you run this command, replace the placeholder - as indicated by the <> brackets - with your user or service principal ID or role name.

   az role assignment create \
       --assignee <USER_OR_SERVICE_PRINCIPAL_ID> \
       --role "<ROLE_NAME>" \
       --scope $ENVIRONMENT_ID
   

   [!NOTE] The <USER_OR_SERVICE_PRINCIPAL_ID> value should be the identity that you use to access the Azure portal. The <ROLE_NAME> value is the name that you assigned in step 1.

4. Get the URL of the Admin for Spring dashboard.

   az containerapp env java-component admin-for-spring show \
       --environment $ENVIRONMENT \
       --resource-group $RESOURCE_GROUP \
       --name $JAVA_COMPONENT_NAME \
       --query properties.ingress.fqdn \
       --output tsv
   

   This command returns the URL that you can use to access the Admin for Spring dashboard. With the dashboard, you can also see your container app, as shown in the following screenshot.

   :::image type="content" source="media/java-components/spring-boot-admin-alone.png" alt-text="Screenshot that shows the overview of the Admin for Spring dashboard." lightbox="media/java-components/spring-boot-admin-alone.png":::

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

az group delete --resource-group $RESOURCE_GROUP

When you use the admin component in your own container app, you need to add the following dependency in your pom.xml file. Replace the version number with the latest version available on the Maven Repository.

<dependency>
    <groupId>de.codecentric</groupId>
    <version>3.3.2</version>
    <artifactId>spring-boot-admin-starter-client</artifactId>
</dependency>

az containerapp update --enable-java-agent \
--resource-group $RESOURCE_GROUP \
--name $APP_NAME

Starting with Spring Boot 2, endpoints other than health and info aren't exposed by default. You can expose them by adding the following configuration in your application.properties file.

management.endpoints.web.exposure.include=*
management.endpoint.health.show-details=always

The following list details the admin component properties you can configure for your app. For more information, see Spring Boot Admin.

• Logging related configurations:
  • logging.level.*
  • logging.group.*
  • Any other configurations under logging.* namespace should be forbidden. For example, writing log files by using logging.file should be forbidden.

• The Spring Boot Admin Dashboard isn't available in Azure China 21Vianet.

Integrate the managed Admin for Spring with Eureka Server for Spring