Skip to content

Commit 5a122a0

Browse files
committed
misc edits
1 parent 0239cee commit 5a122a0

File tree

1 file changed

+33
-33
lines changed

1 file changed

+33
-33
lines changed

articles/spring-apps/quickstart-deploy-web-app.md

Lines changed: 33 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -19,11 +19,11 @@ ms.custom: devx-track-java, devx-track-azurecli, mode-other, event-tier1-build-2
1919
2020
**This article applies to:** ✔️ Basic/Standard tier
2121

22-
This quickstart shows how to deploy a Spring Boot web application to Azure Spring Apps. The sample project is a typical three layers web application:
22+
This quickstart shows how to deploy a Spring Boot web application to Azure Spring Apps. The sample project is a typical three-layers web application:
2323

24-
1. A frontend bounded [React](https://reactjs.org/) application.
25-
2. A backend Spring web application that uses Spring Data JPA to access a relational database.
26-
3. A relational database. [H2 Database Engine](https://www.h2database.com/html/main.html) is used in localhost. [Azure Database for PostgreSQL](/azure/postgresql/flexible-server/) is used when deploy to Azure Spring Apps.
24+
- A frontend bounded [React](https://reactjs.org/) application.
25+
- A backend Spring web application that uses Spring Data JPA to access a relational database.
26+
- A relational database. [H2 Database Engine](https://www.h2database.com/html/main.html) is used in localhost. [Azure Database for PostgreSQL](/azure/postgresql/flexible-server/) is used when deploy to Azure Spring Apps.
2727

2828
The following diagram shows the architecture of the system:
2929

@@ -32,28 +32,28 @@ The following diagram shows the architecture of the system:
3232
## Prerequisites
3333

3434
- [Git](https://git-scm.com/downloads).
35-
- [Java Development Kit (JDK)](/java/azure/jdk/). Version = 17.
35+
- [Java Development Kit (JDK)](/java/azure/jdk/). Version 17.
3636
- An Azure subscription. If you don't have a subscription, create a [free account](https://azure.microsoft.com/free/) before you begin.
37-
- [Azure CLI](/cli/azure/install-azure-cli). Version >= 2.45.0.
37+
- [Azure CLI](/cli/azure/install-azure-cli). Version 2.45.0 or greater.
3838

3939
## Clone and run the sample project locally
4040

4141
1. The sample project is available on GitHub. Use the following command to clone the sample project:
4242

43-
```shell
43+
```bash
4444
git clone https://github.com/Azure-Samples/ASA-Samples-Web-Application.git
45-
```
45+
```
4646

4747
1. Use the following command to build the sample project:
4848

49-
```shell
49+
```bash
5050
cd ASA-Samples-Web-Application
5151
./mvnw clean package -DskipTests
5252
```
5353

54-
1. Use the following command to run the sample application by Maven:
54+
1. Use the following Maven command to run the sample application:
5555

56-
```shell
56+
```bash
5757
java -jar web/target/simple-todo-web-0.0.1-SNAPSHOT.jar
5858
```
5959

@@ -63,9 +63,9 @@ The following diagram shows the architecture of the system:
6363

6464
## Prepare the cloud environment
6565

66-
The main resources needed to run this sample is an Azure Spring Apps instance and an Azure Database for PostgreSQL instance. This section provides the steps to create these resources.
66+
The main resources required to run this sample are an Azure Spring Apps instance and an Azure Database for PostgreSQL instance. This section provides the steps to create these resources.
6767

68-
### 1. Set name for each resource
68+
### Step 1 - Provide names for each resource
6969

7070
Specify the following suggested names for the resources.
7171

@@ -79,7 +79,7 @@ APP_NAME=webapp
7979
CONNECTION=WebAppConnection
8080
```
8181

82-
### 2. Create a new resource group
82+
### Step 2 - Create a new resource group
8383

8484
Use the following steps to create a new resource group.
8585

@@ -95,16 +95,16 @@ Use the following steps to create a new resource group.
9595
az configure --defaults location=${LOCATION}
9696
```
9797

98-
1. Set the default subscription. Firstly, list all available subscriptions:
98+
1. Set the default subscription. Firstly, use the following command to list all available subscriptions:
9999

100100
```azurecli-interactive
101101
az account list --output table
102102
```
103103

104-
Then choose one subscription and set it as default subscription with the following command:
104+
Choose one subscription and set it as the default subscription with the following command:
105105

106106
```azurecli-interactive
107-
az account set --subscription <SubscriptionId>
107+
az account set --subscription <subscription-ID>
108108
```
109109

110110
1. Create a resource group.
@@ -113,13 +113,13 @@ Use the following steps to create a new resource group.
113113
az group create --resource-group ${RESOURCE_GROUP}
114114
```
115115

116-
1. Set the new created resource group as default resource group.
116+
1. Set the newly created resource group as the default resource group.
117117

118118
```azurecli-interactive
119119
az configure --defaults group=${RESOURCE_GROUP}
120120
```
121121

122-
### 3. Create Azure Spring Apps instance
122+
### Step 3 - Create an Azure Spring Apps instance
123123

124124
Azure Spring Apps is used to host the spring web app. Create an Azure Spring Apps instance and create an app inside it.
125125

@@ -129,7 +129,7 @@ Azure Spring Apps is used to host the spring web app. Create an Azure Spring App
129129
az spring create --name ${AZURE_SPRING_APPS_NAME}
130130
```
131131

132-
1. Create an app in the created Azure Spring Apps instance.
132+
1. Create an app in the Azure Spring Apps instance.
133133

134134
```azurecli-interactive
135135
az spring app create \
@@ -139,9 +139,9 @@ Azure Spring Apps is used to host the spring web app. Create an Azure Spring App
139139
--assign-endpoint true
140140
```
141141

142-
### 4. Prepare PostgreSQL instance
142+
### Step 4 - Prepare the PostgreSQL instance
143143

144-
The Spring web app in localhost uses H2 for the database, Azure uses [Azure Database for PostgreSQL - Flexible Server](/azure/postgresql/flexible-server/) instead. Use the following command to create a PostgreSQL instance:
144+
The Spring web app uses H2 for the database in localhost, and [Azure Database for PostgreSQL - Flexible Server](/azure/postgresql/flexible-server/) for the database in Azure. Use the following command to create a PostgreSQL instance:
145145

146146
```azurecli-interactive
147147
az postgres flexible-server create \
@@ -152,28 +152,28 @@ az postgres flexible-server create \
152152

153153
So that the app is accessible only by PostgreSQL in Azure Spring Apps, enter `n` to the prompts to enable access to a specific IP address and to enable access for all IP addresses.
154154

155-
```text
155+
```bash
156156
Do you want to enable access to client xxx.xxx.xxx.xxx (y/n) (y/n): n
157157
Do you want to enable access for all IPs (y/n): n
158158
```
159159

160-
### 5. Connect app instance to PostgreSQL instance
160+
### Step 5 - Connect app instance to PostgreSQL instance
161161

162-
After the app instance and the PostgreSQL instance have been created, the app instance can't access the PostgreSQL instance directly. Some network settings and connection information should be configured. To do these tasks, use [Service Connector](/azure/service-connector/overview).
162+
After the app instance and the PostgreSQL instance have been created, the app instance can't access the PostgreSQL instance directly. Use [Service Connector](/azure/service-connector/overview) to configure the needed network settings and connection information.
163163

164-
1. If you're using Service Connector for the first time, first register the Service Connector resource provider.
164+
1. If you're using Service Connector for the first time, register the Service Connector resource provider.
165165

166166
```azurecli-interactive
167167
az provider register --namespace Microsoft.ServiceLinker
168168
```
169169

170-
1. To achieve passwordless connection in Service Connector. Add `serviceconnector-passwordless` extension by using the following command:
170+
1. To achieve passwordless connection in Service Connector, use the following command:
171171

172172
```azurecli-interactive
173173
az extension add --name serviceconnector-passwordless --upgrade
174174
```
175175

176-
1. Create a service connection between the app and the PostgreSQL by this command:
176+
1. Use the following command to create a service connection between the app and the PostgreSQL:
177177

178178
```azurecli-interactive
179179
az spring connection create postgres-flexible \
@@ -188,9 +188,9 @@ After the app instance and the PostgreSQL instance have been created, the app in
188188
--connection ${CONNECTION}
189189
```
190190

191-
The `--system-identity` parameter is necessary for passwrodless connection. For more information, see [Bind an Azure Database for PostgreSQL to your application in Azure Spring Apps](/azure/spring-apps/how-to-bind-postgres?tabs=Passwordlessflex).
191+
The `--system-identity` parameter is required for the passwrodless connection. For more information, see [Bind an Azure Database for PostgreSQL to your application in Azure Spring Apps](/azure/spring-apps/how-to-bind-postgres?tabs=Passwordlessflex).
192192

193-
1. After connection created, use the following command to validate the connection:
193+
1. After the connection is created, use the following command to validate the connection:
194194

195195
```azurecli-interactive
196196
az spring connection validate \
@@ -241,7 +241,7 @@ After the app instance and the PostgreSQL instance have been created, the app in
241241

242242
## Deploy the app to Azure Spring Apps
243243

244-
1. Now the cloud environment is ready, use the following command to deploy the app:
244+
1. With the cloud environment prepared, use the following command to deploy the app:
245245

246246
```azurecli-interactive
247247
az spring app deploy \
@@ -250,7 +250,7 @@ After the app instance and the PostgreSQL instance have been created, the app in
250250
--artifact-path web/target/simple-todo-web-0.0.1-SNAPSHOT.jar
251251
```
252252

253-
1. After the deployment has completed, you can access the app at `https://${AZURE_SPRING_APPS_NAME}-${APP_NAME}.azuremicroservices.io/`. The page should appear as you saw in localhost.
253+
1. After the deployment has completed, you can access the app with this URL: `https://${AZURE_SPRING_APPS_NAME}-${APP_NAME}.azuremicroservices.io/`. The page should appear as you saw in localhost.
254254

255255
1. If there's a problem when you deploy the app, check the app's log to investigate by using the following command:
256256

@@ -262,7 +262,7 @@ After the app instance and the PostgreSQL instance have been created, the app in
262262

263263
## Clean up resources
264264

265-
1. To avoid unnecessary cost, use the following commands to delete the resource group.
265+
1. To avoid unnecessary costs, use the following command to delete the resource group.
266266

267267
```azurecli-interactive
268268
az group delete --name ${RESOURCE_GROUP}

0 commit comments

Comments
 (0)