Quickstart: Set up Spring Cloud Config Server for Azure Spring Apps

Note

The Basic, Standard, and Enterprise plans will be deprecated starting from mid-March, 2025, with a 3 year retirement period. We recommend transitioning to Azure Container Apps. For more information, see the Azure Spring Apps retirement announcement.

The Standard consumption and dedicated plan will be deprecated starting September 30, 2024, with a complete shutdown after six months. We recommend transitioning to Azure Container Apps. For more information, see Migrate Azure Spring Apps Standard consumption and dedicated plan to Azure Container Apps.

This article applies to: ✅ Basic/Standard ❎ Enterprise

Config Server is a centralized configuration service for distributed systems. It uses a pluggable repository layer that currently supports local storage, Git, and Subversion. In this quickstart, you set up the Config Server to get data from a Git repository.

Prerequisites

• Completion of the previous quickstart in this series: Provision Azure Spring Apps service.
• Azure Spring Apps Config Server is only applicable to the Basic or Standard plan.

Config Server procedures

Set up your Config Server with the location of the Git repository for the project by running the following command. Replace <service-instance-name> with the name of the service you created earlier. The default value for service instance name that you set in the preceding quickstart doesn't work with this command.

az spring config-server git set \
    --name <service-instance-name> \
    --uri https://github.com/Azure-Samples/azure-spring-apps-samples \
    --search-paths steeltoe-sample/config

This command tells Config Server to find the configuration data in the steeltoe-sample/config folder of the sample app repository. Since the name of the app that gets the configuration data is planet-weather-provider, the file that's used is planet-weather-provider.yml.

Prerequisites

• JDK 17
• An Azure subscription. If you don't have a subscription, create a free account before you begin.
• Optionally, Azure CLI version 2.45.0 or higher. Install the Azure Spring Apps extension with the following command: az extension add --upgrade --name spring
• Optionally, the Azure Toolkit for IntelliJ.

Config Server procedures

Azure portal

The following procedure sets up the Config Server using the Azure portal to deploy the PetClinic sample.

1. Go to the service Overview page and select Config Server.

2. In the Default repository section, set URI to https://github.com/azure-samples/spring-petclinic-microservices-config.

3. Select Validate. Validation checks the schema and accessibility of your git repo to make sure it's correct.

   

4. When validation is complete, select Apply to save your changes.

   

Updating the configuration can take a few minutes. You should get a notification when the configuration is complete.

Azure CLI

The following procedure uses the Azure CLI to set up Config Server to deploy the Pet Clinic sample.

Run the following command to set the Default repository.

az spring config-server git set \
    --name <service-instance-name> \
    --uri https://github.com/azure-samples/spring-petclinic-microservices-config

Tip

For information on using a private repository for Config Server, see Configure a managed Spring Cloud Config Server in Azure Spring Apps.

Troubleshooting of Azure Spring Apps Config Server

The following procedure explains how to troubleshoot Config Server settings.

1. In the Azure portal, go to the service Overview page and select Logs.

2. In the Queries pane under Show the application logs that contain the "error" or "exception" terms, select Run.

   

   The following error in the logs indicates that the Spring Apps service can't locate properties from Config Server: java.lang.illegalStateException

3. Go to the service Overview page.

4. Select Diagnose and solve problems.

5. Under Availability and Performance, select Troubleshoot.

   

   Azure portal displays the Availability and Performance page, which provides various information about Config Server health status.

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 it, delete the resource group, which deletes the resources in the resource group. To delete the resource group, enter the following commands in the Azure CLI:

echo "Enter the Resource Group name:" &&
read resourceGroupName &&
az group delete --name $resourceGroupName &&
echo "Press [ENTER] to continue ..."

Next steps

Quickstart: Build and deploy apps to Azure Spring Apps