Quickstart: Deploy microservice applications to Azure Spring Apps

Use the following steps to prepare the sample locally:

1. Clone the sample project by using the following command:

   git clone https://github.com/Azure-Samples/spring-petclinic-microservices.git
   

2. Navigate to the project root directory and then use the following command to run the sample project locally:

   bash ./scripts/run_all_without_infra.sh
   

3. After the script completes successfully, go to http://localhost:8080 in your browser to access the PetClinic application.

Use the following steps to initialize the Pet Clinic application using Azure Developer CLI templates:

1. In the Bash window, create a new, empty folder and then navigate to it.

2. Use the following command to initialize the project:

   azd init --template Azure-Samples/spring-petclinic-microservices
   

   The following list describes the command interaction:

   • Enter a new environment name: Provide an environment name, which is used as a suffix for the resource group that is created to hold all Azure resources. This name should be unique within your Azure subscription.

   The console outputs messages similar to the following example:

   Initializing a new project (azd init)
   
   Downloading template code to: <your-local-path>
   (✓) Done: Initialized git repository
   Enter a new environment name: <your-env-name>
   
   SUCCESS: New project initialized!
   You can view the template code in your directory: <your-local-path>
   Learn more about running 3rd party code on our DevHub: https://aka.ms/azd-third-party-code-notice
   

3.1. Sign in to the Azure portal

Go to the Azure portal, enter your credentials, and sign in to the portal. The default view is your service dashboard.

3.2. Create an Azure Spring Apps instance

Use the following steps to create the service instance:

1. Select Create a resource in the corner of the Azure portal.

2. On the Azure Services tab, select Compute > Azure Spring Apps.

   

3. On the Create Azure Spring Apps page, fill out the form on the Basics tab.

   

   Use the following table as a guide for completing the form. The recommended Plan is Standard.

   Setting	Suggested value	Description
   Subscription	Your subscription name.	The Azure subscription that you want to use for your server. If you have multiple subscriptions, choose the subscription for which you'd like to be billed for the resource.
   Resource group	myresourcegroup	A new resource group name or an existing one from your subscription.
   Name	myasa	A unique name that identifies your Azure Spring Apps instance. The name must be between 4 and 32 characters long and can contain only lowercase letters, numbers, and hyphens. The first character of the service name must be a letter and the last character must be either a letter or a number.
   Plan	Standard	The pricing plan determines the resources and cost associated with your instance.
   Region	The region closest to your users.	The location that is closest to your users.
   Zone Redundant	Unselected	Creates your Azure Spring Apps service in an Azure availability zone. Not currently supported in all regions.

4. Navigate to the Diagnostic settings tab on the Create Azure Spring Apps page and then select Create new to create a new Log Analytics workspaces instance. On the Create new Log Analytics workspace page, update the name of the Log Analytics workspace as needed, and then select OK to confirm the creation.

   

5. Navigate to the Application Insights tab on the Create Azure Spring Apps page and then select Create new to create a new Application Insights instance. On the Create new Application Insights resource page, update the Application insights name as needed, select Workspace-based for Resource mode, and then select OK to confirm the creation.

   

6. Select Review and Create to review your selections. Then, select Create to provision the Azure Spring Apps instance.

7. Select the Notifications icon (a bell) to monitor the deployment process. After the deployment finishes, you can select Pin to dashboard to create a shortcut on your Azure portal dashboard to the service's Overview page.

   

8. Select Go to resource to go to the Azure Spring Apps Overview page.

9. Select Config Server in the navigation pane.

10. On the Config Server page, for URI, enter https://github.com/Azure-Samples/spring-petclinic-microservices-config.git and then select Validate.

    

11. After validation, select Apply to finish the Config Server configuration.

Use the following steps to create the required resources:

1. Use the following command to sign in to Azure with OAuth2. Ignore this step if you already signed in.

   azd auth login
   

   The console outputs messages similar to the following example:

   Logged in to Azure.
   

2. Use the following command to package a deployable copy of your application, provision the template's infrastructure to Azure, and then deploy the application code to those newly provisioned resources:

   azd provision
   

   The following list describes the command interactions:

   • Select an Azure Subscription to use: Use arrows to move, type to filter, then press Enter.
   • Select an Azure location to use: Use arrows to move, type to filter, then press Enter.

   The console outputs messages similar to the following example:

   SUCCESS: Your application was provisioned in Azure in xx minutes xx seconds.
   You can view the resources created under the resource group rg-<your-environment-name> in Azure Portal:
   https://portal.azure.cn/#@/resource/subscriptions/<your-subscription-id>/resourceGroups/rg-<your-environment-name>/overview
   

   Note

   This command may take a while to complete. You're shown a progress indicator as it provisions Azure resources.

Use the following steps to deploy the microservice applications using the Maven plugin for Azure Spring Apps:

1. Navigate to the sample project directory and then use the following command to configure the apps for Azure Spring Apps:

   ./mvnw -P spring-apps com.microsoft.azure:azure-spring-apps-maven-plugin:1.17.0:config
   

2. The following list describes the command interactions:

   • Select child modules to configure(input numbers separated by comma, eg: [1-2,4,6], ENTER to select ALL): Press Enter to select all.
   • OAuth2 login: Authorize the sign in to Azure based on the OAuth2 protocol.
   • Select subscription: Select the subscription list number of the Azure Spring Apps instance you created, which defaults to the first subscription in the list. If you use the default number, press Enter directly.
   • Select Azure Spring Apps for deployment: Select the list number of the Azure Spring Apps instance you created. If you use the default number, press Enter directly.
   • Select apps to expose public access:(input numbers separated by comma, eg: [1-2,4,6], ENTER to select NONE): Enter 1,5 for admin-server and api-gateway.
   • Confirm to save all the above configurations (Y/n): Press y. If you press n, the configuration isn't saved in the POM files.

3. Use the following command to build and deploy each application:

   ./mvnw azure-spring-apps:deploy
   

4. For the OAuth2 login prompt, authorize the login to Azure based on the OAuth2 protocol.

   Note

   Deployment to Azure Spring Apps can take up to 25 minutes.

After the command runs, a log displays output similar to the following example, which indicates that all deployments are successful:

[INFO] Deployment(default) is successfully updated.
[INFO] Deployment Status: Running
[INFO]   InstanceName:admin-server-default-xx-xx-xxx  Status:Running Reason:null       DiscoverStatus:UP
[INFO] Getting public url of app(admin-server)...
[INFO] Application url: https://<your-Azure-Spring-Apps-instance-name>-admin-server.microservices.azure.cn

...

[INFO] Getting public url of app(api-gateway)...
[INFO] Application url: https://<your-Azure-Spring-Apps-instance-name>-api-gateway.microservices.azure.cn

Use the following steps to package the app, provision the Azure resources required by the web application, and then deploy to Azure Spring Apps:

1. Use the following command to package a deployable copy of your application:

   azd package
   

   The console outputs messages similar to the following example:

   SUCCESS: Your application was packaged for Azure in xx minutes xx seconds.
   

2. Use the following command to deploy the application code to those newly provisioned resources:

   azd deploy
   

   The console outputs messages similar to the following example:

   Deploying services (azd deploy)
   
   (✓) Done: Deploying service admin-server
   - Endpoint: https://<your-Azure-Spring-Apps-instance-name>-admin-server.microservices.azure.cn
   
   (✓) Done: Deploying service api-gateway
   - Endpoint: https://<your-Azure-Spring-Apps-instance-name>-api-gateway.microservices.azure.cn
   
   (✓) Done: Deploying service customers-service
   - No endpoints were found
   
   (✓) Done: Deploying service vets-service
   - No endpoints were found
   
   (✓) Done: Deploying service visits-service
   - No endpoints were found
   
   
   SUCCESS: Your application was deployed to Azure in xx minutes xx seconds.
   You can view the resources created under the resource group rg-<your-environment-name> in Azure Portal:
   https://portal.azure.cn/#@/resource/subscriptions/<your-subscription-id>/resourceGroups/rg-<your-environment-name>/overview
   

Use the following steps to delete the entire resource group, including the newly created service instance:

1. Locate your resource group in the Azure portal. On the navigation menu, select Resource groups, and then select the name of your resource group.

2. On the Resource group page, select Delete. Enter the name of your resource group in the text box to confirm deletion, then select Delete.

Use the following command to delete all the Azure resources used in this sample application:

azd down

The following list describes the command interaction:

• Total resources to delete: <resources-total>, are you sure you want to continue?: Press y.

The console outputs messages similar to the following example:

SUCCESS: Your application was removed from Azure in xx minutes xx seconds.