Skip to content

Commit 4b0b2a6

Browse files
committed
edits
1 parent 71506cc commit 4b0b2a6

File tree

1 file changed

+51
-48
lines changed

1 file changed

+51
-48
lines changed

articles/spring-apps/quickstart.md

Lines changed: 51 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@
22
title: "Quickstart - Deploy your first application to Azure Spring Apps"
33
description: Describes how to deploy an application to Azure Spring Apps.
44
author: karlerickson
5+
ms.author: karler
56
ms.service: spring-apps
67
ms.topic: quickstart
7-
ms.date: 08/22/2022
8-
ms.author: karler
8+
ms.date: 03/21/2022
99
ms.custom: devx-track-java, devx-track-azurecli, mode-other, event-tier1-build-2022, engagement-fy23
1010
---
1111

@@ -34,17 +34,18 @@ This quickstart explains how to:
3434
3535
At the end of this quickstart, you'll have a working spring app running on Azure Spring Apps.
3636

37-
### [Azure CLI](#tab/Azure-CLI)
37+
## [Azure CLI](#tab/Azure-CLI)
3838

3939
## Prerequisites
4040

4141
- An Azure subscription. If you don't have a subscription, create a [free account](https://azure.microsoft.com/free/) before you begin.
42+
- [Apache Maven](https://maven.apache.org/download.cgi)
4243
- [Azure CLI](/cli/azure/install-azure-cli). Install the Azure Spring Apps extension with the following command: `az extension add --name spring`
4344
- If you're deploying Azure Spring Apps Enterprise tier for the first time in the target subscription, see the [Prerequisites](./how-to-enterprise-marketplace-offer.md#prerequisites) section of [View Azure Spring Apps Enterprise tier offering in Azure Marketplace](./how-to-enterprise-marketplace-offer.md).
4445

4546
## Provision an instance of Azure Spring Apps
4647

47-
Use the following steps to create a service instance of Azure Spring Apps.
48+
Use the following steps to create an Azure Spring Apps service instance.
4849

4950
1. Select **Open Cloudshell** and sign in to your Azure account in [Azure Cloud Shell](../cloud-shell/overview.md).
5051

@@ -62,21 +63,21 @@ Use the following steps to create a service instance of Azure Spring Apps.
6263
az account list --output table
6364
```
6465

65-
1. Set your default subscription.
66+
1. Use the following command to set your default subscription.
6667

6768
```azurecli-interactive
6869
az account set --subscription <subscription-id>
6970
```
7071

71-
1. Create a resource group.
72+
1. Use the following command to create a resource group.
7273

7374
```azurecli-interactive
7475
az group create \
7576
--resource-group <name-of-resource-group> \
7677
--location eastus
7778
```
7879

79-
1. Create an Azure Spring Apps service instance.
80+
1. Use the following command to create an Azure Spring Apps service instance.
8081

8182
```azurecli-interactive
8283
az spring create \
@@ -88,10 +89,10 @@ Use the following steps to create a service instance of Azure Spring Apps.
8889

8990
## Create an app in your Azure Spring Apps instance
9091

91-
An [**App**](/azure/spring-apps/concept-understand-app-and-deployment) is an abstraction of one business app. Apps run in an Azure Spring Apps Service Instance, or simply service instance, as shown next.
92-
</br>
93-
![Apps and Deployments](./media/spring-cloud-app-and-deployment/app-deployment-rev.png)
94-
</br>
92+
An [*App*](concept-understand-app-and-deployment.md) is an abstraction of one business app. Apps run in an Azure Spring Apps service instance, as shown in the following diagram.
93+
94+
:::image type="content" source="media/spring-cloud-app-and-deployment/app-deployment-rev.png" alt-text="Diagram showing the relationship between apps and an Azure Spring Apps service instance.":::
95+
9596
Use the following command to specify the app name on Azure Spring Apps as *hello spring*.
9697

9798
```azurecli-interactive
@@ -110,19 +111,19 @@ Use the following steps to clone the Spring Boot sample project.
110111

111112
```azurecli-interactive
112113
git clone -b boot-2.7 https://github.com/spring-guides/gs-spring-boot.git
113-
```
114+
```
114115

115-
1. Move to the project folder.
116+
1. Use the following command to move to the project folder.
116117

117-
```azurecli-interactive
118-
cd gs-spring-boot/complete
119-
```
118+
```azurecli-interactive
119+
cd gs-spring-boot/complete
120+
```
120121

121122
1. Use the following [Maven](https://maven.apache.org/what-is-maven.html) command to build the project.
122123

123124
```azurecli-interactive
124-
mvn clean package -DskipTests
125-
```
125+
mvn clean package -DskipTests
126+
```
126127

127128
## Deploy the local app to Azure Spring Apps
128129

@@ -138,18 +139,19 @@ az spring app deploy \
138139

139140
Deploying the application can take a few minutes.
140141

141-
### [Consumption Plan](#tab/Consumption-Plan)
142+
## [Standard consumption plan](#tab/Consumption-Plan)
142143

143144
## Prerequisites
144145

145146
- An Azure subscription. If you don't have a subscription, create a [free account](https://azure.microsoft.com/free/) before you begin.
146-
- [Azure CLI](/cli/azure/install-azure-cli). Install the spring extension for StandardGen2 Azure Spring Apps.
147+
- [Apache Maven](https://maven.apache.org/download.cgi)
148+
- [Azure CLI](/cli/azure/install-azure-cli). Install the spring extension for `StandardGen2` Azure Spring Apps by using the following command.
147149

148150
```shell
149151
az extension add --upgrade --name spring
150152
```
151153

152-
- Install the Azure Container Apps extension for the CLI and register these namespaces: `Microsoft.App`, `Microsoft.OperationalInsights` and `Microsoft.AppPlatform`
154+
- Use the following commands to install the Azure Container Apps extension for the Azure CLI and register these namespaces: `Microsoft.App`, `Microsoft.OperationalInsights`, and `Microsoft.AppPlatform`
153155

154156
```shell
155157
az extension add --name containerapp --upgrade
@@ -160,7 +162,7 @@ Deploying the application can take a few minutes.
160162

161163
## Provision an instance of Azure Spring Apps
162164

163-
Use the following steps to create a service instance of Azure Spring Apps.
165+
Use the following steps to create an Azure Spring Apps service instance.
164166

165167
1. Select **Open Cloudshell** and sign in to your Azure account in [Azure Cloud Shell](../cloud-shell/overview.md).
166168

@@ -188,7 +190,7 @@ Use the following steps to create a service instance of Azure Spring Apps.
188190

189191
```azurecli-interactive
190192
LOCATION="<region>"
191-
RESOURCE_GROUP="<resource group>"
193+
RESOURCE_GROUP="<resource-group-name>"
192194
MANAGED_ENVIRONMENT="<Azure-Container-Apps-environment-name>"
193195
SERVICE_NAME="<Azure-Spring-Apps-instance-name>"
194196
APP_NAME="<Spring-app-name>"
@@ -202,7 +204,7 @@ Use the following steps to create a service instance of Azure Spring Apps.
202204
--location ${LOCATION}
203205
```
204206

205-
1. An Azure Container App environment creates a secure boundary around a group of applications. Apps deployed to the same environment are deployed in the same virtual network and write logs to the same [Log Analytics workspace](/azure/azure-monitor/logs/log-analytics-workspace-overview). To create the environment, run the following command
207+
1. An Azure Container App environment creates a secure boundary around a group of applications. Apps deployed to the same environment are deployed in the same virtual network and write logs to the same [Log Analytics workspace](/azure/azure-monitor/logs/log-analytics-workspace-overview). To create the environment, run the following command:
206208

207209
```azurecli-interactive
208210
az containerapp env create \
@@ -211,16 +213,17 @@ Use the following steps to create a service instance of Azure Spring Apps.
211213
--location ${LOCATION}
212214
```
213215

214-
1. Set the environment variable:
216+
1. Use the following command to create a variable to store the environment resource ID:
215217

216218
```azurecli-interactive
217219
MANAGED_ENV_RESOURCE_ID=$(az containerapp env show \
218220
--name ${MANAGED_ENVIRONMENT} \
219221
--resource-group ${RESOURCE_GROUP} \
220-
--query id -o tsv)
222+
--query id \
223+
--output tsv)
221224
```
222225

223-
1. Use the following command to create an Azure Spring Apps service instance. The StandardGen2 Azure Spring Apps instance is built on top of the Container Environment: Create your Azure Spring Apps instance by specifying the resource ID of the ACA Environment you created:
226+
1. Use the following command to create an Azure Spring Apps service instance. The `StandardGen2` Azure Spring Apps instance is built on top of the Azure Container Apps environment. Create your Azure Spring Apps instance by specifying the resource ID of the environment you created.
224227

225228
```azurecli-interactive
226229
az spring create \
@@ -233,11 +236,11 @@ Use the following steps to create a service instance of Azure Spring Apps.
233236

234237
## Create an app in your Azure Spring Apps instance
235238

236-
An [**App**](/azure/spring-apps/concept-understand-app-and-deployment) is an abstraction of one business app. Apps run in an Azure Spring Apps service instance, or simply service instance, as shown in the following diagram.
237-
</br>
238-
![Apps and Deployments](./media/spring-cloud-app-and-deployment/app-deployment-rev.png)
239-
</br>
240-
Use the following command to specify the app name on Azure Spring Apps and allocate required resources:
239+
An [*App*](/azure/spring-apps/concept-understand-app-and-deployment) is an abstraction of one business app. Apps run in an Azure Spring Apps service instance, or simply service instance, as shown in the following diagram.
240+
241+
:::image type="content" source="media/spring-cloud-app-and-deployment/app-deployment-rev.png" alt-text="Diagram showing the relationship between apps and an Azure Spring Apps service instance.":::
242+
243+
Use the following command to specify the app name on Azure Spring Apps and to allocate required resources:
241244

242245
```azurecli-interactive
243246
az spring app create \
@@ -264,7 +267,7 @@ Use the following steps to clone the Spring Boot sample project.
264267
git clone -b boot-2.7 https://github.com/spring-guides/gs-spring-boot.git
265268
```
266269

267-
1. Move to the project folder.
270+
1. Use the following command to move to the project folder.
268271

269272
```azurecli-interactive
270273
cd gs-spring-boot/complete
@@ -278,22 +281,22 @@ Use the following steps to clone the Spring Boot sample project.
278281

279282
## Deploy the local app to Azure Spring Apps
280283

281-
1. Use the following command to deploy the *.jar* file for the app.
284+
Use the following command to deploy the *.jar* file for the app.
282285

283-
```azurecli-interactive
284-
az spring app deploy \
285-
--resource-group ${RESOURCE_GROUP} \
286-
--service ${SERVICE_NAME} \
287-
--name ${APP_NAME} \
288-
--artifact-path target/spring-boot-complete-0.0.1-SNAPSHOT.jar \
289-
--env testEnvKey=testEnvValue \
290-
--runtime-version Java_11 \
291-
--jvm-options '-Xms1024m -Xmx2048m'
292-
```
286+
```azurecli-interactive
287+
az spring app deploy \
288+
--resource-group ${RESOURCE_GROUP} \
289+
--service ${SERVICE_NAME} \
290+
--name ${APP_NAME} \
291+
--artifact-path target/spring-boot-complete-0.0.1-SNAPSHOT.jar \
292+
--env testEnvKey=testEnvValue \
293+
--runtime-version Java_11 \
294+
--jvm-options '-Xms1024m -Xmx2048m'
295+
```
293296

294297
Deploying the application can take a few minutes.
295298

296-
### [IntelliJ](#tab/IntelliJ)
299+
## [IntelliJ](#tab/IntelliJ)
297300

298301
## Prerequisites
299302

@@ -357,7 +360,7 @@ Use the following steps to create an instance of Azure Spring Apps using the Azu
357360

358361
- **Subscription**: Select the subscription you want to be billed for this resource.
359362
- **Resource group**: Creating new resource groups for new resources is a best practice.
360-
- **Service Name**: Specify the service instance name. You'll use this name later in this article where the *\<Azur-Spring-Apps-instance-name\>* placeholder appears. 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.
363+
- **Service Name**: Specify the service instance name. You'll use this name later in this article where the *\<Azure-Spring-Apps-instance-name\>* placeholder appears. 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.
361364
- **Region**: Select the region for your service instance.
362365

363366
:::image type="content" source="media/quickstart/portal-start.png" alt-text="Screenshot of Azure portal showing Azure Spring Apps Create page." lightbox="media/quickstart/portal-start.png":::
@@ -411,7 +414,7 @@ Use the following steps to build and deploy your app.
411414

412415
1. To start the deployment, select the **Run** button at the bottom of the **Deploy Azure Spring Apps app** dialog box. The plug-in runs the command `mvn package -DskipTests` on the `hellospring` app and deploys the *.jar* file generated by the `package` command.
413416

414-
### [Visual Studio Code](#tab/VS-Code)
417+
## [Visual Studio Code](#tab/VS-Code)
415418

416419
## Prerequisites
417420

@@ -438,7 +441,7 @@ echo "Press [ENTER] to continue ..."
438441

439442
## Next steps
440443

441-
In this quickstart, you learned how to build and deploy a Spring app in a service instance of Azure Spring Apps. You also learned how to deploy an app with a public endpoint, and how to clean up resources.
444+
In this quickstart, you learned how to build and deploy a Spring app in an Azure Spring Apps service instance. You also learned how to deploy an app with a public endpoint, and how to clean up resources.
442445

443446
You have access to powerful logs, metrics, and distributed tracing capability from the Azure portal. For more information, see [Quickstart: Monitoring Azure Spring Apps apps with logs, metrics, and tracing](./quickstart-logs-metrics-tracing.md).
444447

0 commit comments

Comments
 (0)