Merge pull request #260122 from moarychan/moary/microservice/support-asae-portal-and-maven

Add portal + maven plugin option for microservice apps deployment

Author: PMEds28

articles/spring-apps/includes/quickstart-deploy-microservice-apps/clean-up-resources.md

@@ -6,10 +6,10 @@ ms.topic: include
 ms.date: 05/24/2022
 ---
 
-<!-- 
+<!--
 For clarity of structure, a separate markdown file is used to describe how to clean up resources using Azure Portal or AZD.
 
-[!INCLUDE [clean-up-resources-portal-or-azd](includes/quickstart-deploy-microservice-apps/clean-up-resources.md)]
+[!INCLUDE [clean-up-resources](includes/quickstart-deploy-microservice-apps/clean-up-resources.md)]
 
 -->
 
@@ -41,4 +41,4 @@ The console outputs messages similar to the following example:
 SUCCESS: Your application was removed from Azure in xx minutes xx seconds.
 ```
 
----
+---

articles/spring-apps/includes/quickstart-deploy-microservice-apps/deploy-microservice-apps-with-basic-standard-plan.md

@@ -3,10 +3,10 @@ author: KarlErickson
 ms.author: v-shilichen
 ms.service: spring-apps
 ms.topic: include
-ms.date: 06/9/2023
+ms.date: 01/10/2024
 ---
 
-<!-- 
+<!--
 For clarity of structure, a separate markdown file is used to describe how to deploy to Azure Spring Apps with Basic/Standard plan.
 
 [!INCLUDE [deploy-microservice-apps-with-basic-standard-plan](includes/quickstart-deploy-microservice-apps/deploy-microservice-apps-with-basic-standard-plan.md)]
@@ -17,27 +17,13 @@ For clarity of structure, a separate markdown file is used to describe how to de
 
 ### [Azure portal + Maven plugin](#tab/Azure-portal-maven-plugin)
 
-Use the following steps to prepare the sample locally.
-
-1. Use the following command to clone the sample GitHub project:
-
-   ```bash
-   git clone https://github.com/Azure-Samples/spring-petclinic-microservices.git
-   ```
-
-1. Use the following command to change to the sample root path and execute the shell script to run the sample project locally:
-
-   ```bash
-   bash ./scripts/run_all_without_infra.sh
-   ```
-
-1. After the script executes successfully, go to `http://localhost:8080` in your browser to access the PetClinic app.
+[!INCLUDE [prepare-spring-project](prepare-spring-project.md)]
 
 ### [Azure Developer CLI](#tab/Azure-Developer-CLI)
 
 Use the following steps to initialize the Pet Clinic application using Azure Developer CLI templates:
 
-1. Open a terminal, create a new, empty folder, and then navigate to it.
+1. In the Bash window, create a new, empty folder and then navigate to it.
 
 1. Use the following command to initialize the project:
 
@@ -53,11 +39,11 @@ Use the following steps to initialize the Pet Clinic application using Azure Dev
 
    ```output
    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
@@ -98,7 +84,7 @@ Use the following steps to create the service instance:
    | **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** | Unchecked                         | Creates your Azure Spring Apps service in an Azure availability zone. Not currently supported in all regions.                                                                                                                                                                                       |
+   | **Zone Redundant** | Unselected                        | Creates your Azure Spring Apps service in an Azure availability zone. Not currently supported in all regions.                                                                                                                                                                                       |
 
 1. 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.
 
@@ -118,7 +104,7 @@ Use the following steps to create the service instance:
 
 1. Select **Config Server** in the navigation pane.
 
-1. On the **Config Server** page, for **URI**, enter *`https://github.com/Azure-Samples/spring-petclinic-microservices-config.git`*, and then select **Validate**.
+1. On the **Config Server** page, for **URI**, enter *https://github.com/Azure-Samples/spring-petclinic-microservices-config.git* and then select **Validate**.
 
    :::image type="content" source="../../media/quickstart-deploy-microservice-apps/validate-config-server.png" alt-text="Screenshot of the Azure portal that shows the Config Server page with the Default URI and the Validate button highlighted and the Apply button disabled." lightbox="../../media/quickstart-deploy-microservice-apps/validate-config-server.png":::
 
@@ -128,15 +114,15 @@ Use the following steps to create the service instance:
 
 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've already signed in.
+1. Use the following command to sign in to Azure with OAuth2. Ignore this step if you already signed in.
 
    ```bash
    azd auth login
    ```
 
    The console outputs messages similar to the following example:
 
-   ```text
+   ```output
    Logged in to Azure.
    ```
 
@@ -172,7 +158,7 @@ You can now deploy the app to Azure Spring Apps.
 
 Use the following steps to deploy the microservice applications using the [Maven plugin for Azure Spring Apps](https://github.com/microsoft/azure-maven-plugins/wiki/Azure-Spring-Apps):
 
-1. Navigate to the sample project directory and use the following command to configure the apps 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:
 
    ```bash
    ./mvnw -P spring-apps com.microsoft.azure:azure-spring-apps-maven-plugin:1.17.0:config
@@ -198,7 +184,7 @@ Use the following steps to deploy the microservice applications using the [Maven
    > [!NOTE]
    > Deployment to Azure Spring Apps can take up to 25 minutes.
 
-After the command is executed, a log displays output similar to the following example, which indicates that all deployments are successful:
+After the command runs, a log displays output similar to the following example, which indicates that all deployments are successful:
 
 ```output
 [INFO] Deployment(default) is successfully updated.
@@ -239,23 +225,23 @@ Use the following steps to package the app, provision the Azure resources requir
 
    ```output
    Deploying services (azd deploy)
-   
+
    (✓) Done: Deploying service admin-server
    - Endpoint: https://<your-Azure-Spring-Apps-instance-name>-admin-server.azuremicroservices.io
-   
+
    (✓) Done: Deploying service api-gateway
    - Endpoint: https://<your-Azure-Spring-Apps-instance-name>-api-gateway.azuremicroservices.io
-   
+
    (✓) 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.com/#@/resource/subscriptions/<your-subscription-id>/resourceGroups/rg-<your-environment-name>/overview

articles/spring-apps/includes/quickstart-deploy-microservice-apps/deploy-microservice-apps-with-enterprise-plan.md

@@ -3,10 +3,10 @@ author: KarlErickson
 ms.author: v-shilichen
 ms.service: spring-apps
 ms.topic: include
-ms.date: 9/15/2023
+ms.date: 01/10/2024
 ---
 
-<!-- 
+<!--
 For clarity of structure, a separate markdown file is used to describe how to deploy to Azure Spring Apps with Enterprise plan.
 
 [!INCLUDE [deploy-microservice-apps-with-enterprise-plan](includes/quickstart-deploy-microservice-apps/deploy-microservice-apps-with-enterprise-plan.md)]
@@ -15,12 +15,67 @@ For clarity of structure, a separate markdown file is used to describe how to de
 
 ## 2. Prepare the Spring project
 
+### [Azure portal](#tab/Azure-portal-ent)
+
 The **Deploy to Azure** button in the next section launches an Azure portal experience that downloads a JAR package from the [ASA-Samples-Web-Application releases](https://github.com/Azure-Samples/ASA-Samples-Web-Application/releases) page on GitHub. No local preparation steps are needed.
 
+### [Azure portal + Maven plugin](#tab/Azure-portal-maven-plugin-ent)
+
+Use the following steps to prepare the project and run the sample locally:
+
+1. Use the following command to clone the [Pet Clinic application](https://github.com/Azure-Samples/spring-petclinic-microservices.git) from GitHub:
+
+   ```bash
+   git clone https://github.com/Azure-Samples/spring-petclinic-microservices.git
+   ```
+
+1. Navigate to the project root directory and then use the following command to build the project:
+
+   ```bash
+   ./mvnw clean package -DskipTests
+   ```
+
+Use the following steps if you want to run the application locally. Otherwise, you can skip these steps.
+
+1. Open a new Bash window and then use the following command to start Config Server:
+
+   ```bash
+   ./mvnw spring-boot:run -pl spring-petclinic-config-server
+   ```
+
+1. Open a new Bash window and then use the following command to start Discovery Server:
+
+   ```bash
+   ./mvnw spring-boot:run -pl spring-petclinic-discovery-server
+   ```
+
+1. For the Customers, Vets, Visits, and Spring Cloud Gateway services, open a new Bash window and use the following commands to start the services:
+
+   ```bash
+   ./mvnw spring-boot:run -pl spring-petclinic-customers-service
+   ./mvnw spring-boot:run -pl spring-petclinic-vets-service
+   ./mvnw spring-boot:run -pl spring-petclinic-visits-service
+   ./mvnw spring-boot:run -Dspring-boot.run.profiles=default,development \
+       -pl spring-petclinic-api-gateway
+   ```
+
+1. Open a new Bash window and navigate to the project `spring-petclinic-frontend` directory. Use the following commands to install dependencies and run the frontend application:
+
+   ```bash
+   npm install
+   npm run start
+   ````
+
+1. After the script completes successfully, go to `http://localhost:8080` in your browser to access the PetClinic application.
+
+---
+
 ## 3. Prepare the cloud environment
 
 The main resource you need to run this sample is an Azure Spring Apps instance. This section describes how to create this resource.
 
+### [Azure portal](#tab/Azure-portal-ent)
+
 This section uses a **Deploy to Azure** button to launch a deployment experience in the Azure portal. This experience uses an [ARM template](../../../azure-resource-manager/templates/overview.md) to create Azure resources.
 
 ### 3.1. Sign in to the Azure portal
@@ -43,14 +98,78 @@ Use the following steps to create all the Azure resources that the app depends o
    | **Resource group** | *myresourcegroup*                 | A new resource group name or an existing one from your subscription.                                                                                                        |
    | **Region**         | The region closest to your users. | The region is used to create the resource group.                                                                                                                            |
 
-   :::image type="content" source="../../media/quickstart-deploy-microservice-apps/custom-deployment-microservice.png" alt-text="Screenshot of the Azure portal that shows the custom deployment for microservice." lightbox="../../media/quickstart-deploy-microservice-apps/custom-deployment-microservice.png":::
+   :::image type="content" source="../../media/quickstart-deploy-microservice-apps/custom-deployment-microservice.png" alt-text="Screenshot of the Azure portal that shows the Custom deployment page." lightbox="../../media/quickstart-deploy-microservice-apps/custom-deployment-microservice.png":::
 
 1. Select **Review and Create** to review your selections. Then, select **Create** to deploy the app to Azure Spring Apps.
 
 1. On the toolbar, select the **Notifications** icon (a bell) to monitor the deployment process. After the deployment finishes, you can select **Pin to dashboard**, which creates a tile for this service on your Azure portal dashboard as a shortcut to the service's **Overview** page. Select **Go to resource** to open the service's **Overview** page.
 
    :::image type="content" source="../../media/quickstart-deploy-microservice-apps/custom-deployment-notifications.png" alt-text="Screenshot of the Azure portal that shows the Overview page with the custom deployment notifications pane open." lightbox="../../media/quickstart-deploy-microservice-apps/custom-deployment-notifications.png":::
 
+### [Azure portal + Maven plugin](#tab/Azure-portal-maven-plugin-ent)
+
+[!INCLUDE [provision-enterprise-azure-spring-apps](provision-enterprise-azure-spring-apps.md)]
+
+---
+
 ## 4. Deploy the apps to Azure Spring Apps
 
+### [Azure portal](#tab/Azure-portal-ent)
+
 The **Deploy to Azure** button in the previous section launches an Azure portal experience that includes application deployment, so nothing else is needed.
+
+### [Azure portal + Maven plugin](#tab/Azure-portal-maven-plugin-ent)
+
+[!INCLUDE [microservice-spring-apps-maven-plugin](microservice-spring-apps-maven-plugin.md)]
+
+2. Use the following command to deploy the backend applications:
+
+   ```bash
+   ./mvnw azure-spring-apps:deploy
+   ```
+
+   After the command runs, you can see from the following log messages that the deployment was successful:
+
+   ```output
+   [INFO] Start deploying artifact(customers-service-3.0.1.jar) to deployment(default) of app(customers-service)...
+   [INFO] Artifact(customers-service-3.0.1.jar) is successfully deployed to deployment(default) of app(customers-service).
+   [INFO] Starting Spring App after deploying artifacts...
+   [INFO] Deployment Status: Running
+
+   ...
+
+   [INFO] Start deploying artifact(vets-service-3.0.1.jar) to deployment(default) of app(vets-service)...
+   [INFO] Artifact(vets-service-3.0.1.jar) is successfully deployed to deployment(default) of app(vets-service).
+   [INFO] Starting Spring App after deploying artifacts...
+   [INFO] Deployment Status: Running
+
+   ...
+
+   [INFO] Start deploying artifact(visits-service-3.0.1.jar) to deployment(default) of app(visits-service)...
+   [INFO] Artifact(visits-service-3.0.1.jar) is successfully deployed to deployment(default) of app(visits-service).
+   [INFO] Starting Spring App after deploying artifacts...
+   [INFO] Deployment Status: Running
+   ```
+
+1. The Azure portal doesn't support deploying the frontend applications, so use the following Azure CLI command to deploy the frontend application:
+
+   ```azurecli
+   az spring app deploy \
+       --resource-group ${RESOURCE_GROUP} \
+       --service ${SPRING_APPS_NAME} \
+       --name ${APP_FRONTEND} \
+       --source-path spring-petclinic-frontend \
+       --build-env BP_WEB_SERVER=nginx \
+       --builder ${APP_FRONTEND}
+   ```
+
+   After the command runs, you can see from the following log messages that the deployment was successful:
+
+   ```output
+   [5/5] Updating deployment in app "frontend" (this operation can take a while to complete)
+   Azure Spring Apps will use rolling upgrade to update your deployment, you have 1 instance, Azure Spring Apps will update the deployment in 1 round.
+   The deployment is in round 1, 1 old instance is deleted/deleting and 1 new instance is started/starting
+   Your application is successfully deployed.
+   ```
+
+---

articles/spring-apps/includes/quickstart-deploy-microservice-apps/microservice-spring-apps-maven-plugin.md

@@ -0,0 +1,29 @@
+---
+author: karlerickson
+ms.author: v-shilichen
+ms.service: spring-apps
+ms.topic: include
+ms.date: 01/10/2024
+---
+
+<!--
+Use the following line at the end of the heading Prerequisites, with blank lines before and after. App deployments with Spring Apps Maven plugin.
+
+[!INCLUDE [microservice-spring-apps-maven-plugin](includes/quickstart-deploy-microservice-apps/microservice-spring-apps-maven-plugin.md)]
+-->
+
+Use the following steps to deploy using the [Maven plugin for Azure Spring Apps](https://github.com/microsoft/azure-maven-plugins/wiki/Azure-Spring-Apps):
+
+1. Navigate to the project root directory and then run the following command to configure the apps in Azure Spring Apps:
+
+   ```bash
+   ./mvnw -P spring-apps-enterprise com.microsoft.azure:azure-spring-apps-maven-plugin:1.19.0:config
+   ```
+
+   The following list describes the command interactions:
+
+   - **Select child modules to configure**: Press <kbd>Enter</kbd> to select all.
+   - **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 <kbd>Enter</kbd> directly.
+   - **Use existing Azure Spring Apps in Azure**: Press <kbd>y</kbd> to use the existing Azure Spring Apps instance.
+   - **Select apps to expose public access**: Press <kbd>Enter</kbd> to select none.
+   - **Confirm to save all the above configurations**: Press <kbd>y</kbd>. If you press <kbd>n</kbd>, the configuration isn't saved in the POM files.

articles/spring-apps/includes/quickstart-deploy-microservice-apps/prepare-spring-project.md

@@ -0,0 +1,30 @@
+---
+author: KarlErickson
+ms.author: v-shilichen
+ms.service: spring-apps
+ms.topic: include
+ms.date: 01/10/2024
+---
+
+<!--
+For clarity of structure, a separate markdown file is used to describe how to prepare project locally.
+
+[!INCLUDE [prepare-spring-project](includes/quickstart-deploy-microservice-apps/prepare-spring-project.md)]
+
+-->
+
+Use the following steps to prepare the sample locally:
+
+1. Clone the sample project by using the following command:
+
+   ```bash
+   git clone https://github.com/Azure-Samples/spring-petclinic-microservices.git
+   ```
+
+1. Navigate to the project root directory and then use the following command to run the sample project locally:
+
+   ```bash
+   bash ./scripts/run_all_without_infra.sh
+   ```
+
+1. After the script completes successfully, go to `http://localhost:8080` in your browser to access the PetClinic application.