Skip to content

Commit dae9271

Browse files
authored
Merge pull request #287917 from paulth1/container-apps-tutorials
[AQ] edit pass: container-apps-tutorials
2 parents ca46127 + 04ccc24 commit dae9271

File tree

3 files changed

+163
-164
lines changed

3 files changed

+163
-164
lines changed

articles/container-apps/java-admin.md

Lines changed: 71 additions & 72 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: "Tutorial: Connect to a managed Admin for Spring in Azure Container Apps"
3-
description: Learn to use a managed Admin for Spring in Azure Container Apps.
3+
description: Learn how to use a managed Admin for Spring in Azure Container Apps.
44
services: container-apps
55
author: craigshoemaker
66
ms.service: azure-container-apps
@@ -14,25 +14,24 @@ ms.author: cshoe
1414

1515
The Admin for Spring managed component offers an administrative interface for Spring Boot web applications that expose actuator endpoints. As a managed component in Azure Container Apps, you can easily bind your container app to Admin for Spring for seamless integration and management.
1616

17-
This tutorial shows you how to create an Admin for Spring Java component and bind it to your container app so you can monitor and manage your Spring applications with ease.
17+
This tutorial shows you how to create an Admin for Spring Java component and bind it to your container app so that you can monitor and manage your Spring applications with ease.
1818

19-
:::image type="content" source="media/java-components/spring-boot-admin-overview.png" alt-text="Screenshot of overview of the Admin for Spring insights dashboard." lightbox="media/java-components/spring-boot-admin-overview.png":::
19+
:::image type="content" source="media/java-components/spring-boot-admin-overview.png" alt-text="Screenshot that shows an overview of the Admin for Spring insights dashboard." lightbox="media/java-components/spring-boot-admin-overview.png":::
2020

21-
In this tutorial, you learn to:
21+
In this tutorial, you learn how to:
2222

2323
> [!div class="checklist"]
24-
> * Create an Admin for Spring Java component
25-
> * Bind your container app to Admin for Spring Java component
24+
> * Create an Admin for Spring Java component.
25+
> * Bind your container app to an Admin for Spring Java component.
2626
27-
> [!NOTE]
28-
> If you want to integrate Admin for Spring with Eureka Server for Spring, see [Integrate Admin for Spring with Eureka Server for Spring in Azure Container Apps](java-admin-eureka-integration.md) instead.
27+
If you want to integrate Admin for Spring with Eureka Server for Spring, see [Integrate Admin for Spring with Eureka Server for Spring in Container Apps](java-admin-eureka-integration.md) instead.
2928

3029
> [!IMPORTANT]
31-
> This tutorial uses services that can affect your Azure bill. If you decide to follow along step-by-step, make sure you delete the resources featured in this article to avoid unexpected billing.
30+
> This tutorial uses services that can affect your Azure bill. If you decide to follow along, make sure you delete the resources featured in this article to avoid unexpected billing.
3231
3332
## Prerequisites
3433

35-
To complete this project, you need the following items:
34+
To finish this project, you need the following items:
3635

3736
| Requirement | Instructions |
3837
|--|--|
@@ -41,17 +40,17 @@ To complete this project, you need the following items:
4140

4241
## Considerations
4342

44-
When running Admin for Spring in Azure Container Apps, be aware of the following details:
43+
When you run the Admin for Spring component in Container Apps, be aware of the following details:
4544

4645
[!INCLUDE [container-apps/component-considerations.md](../../includes/container-apps/component-considerations.md)]
4746

4847
## Setup
4948

50-
Before you begin to work with the Admin for Spring, you first need to create the required resources.
49+
Before you begin to work with the Admin for Spring component, you first need to create the required resources.
5150

5251
### [Azure CLI](#tab/azure-cli)
5352

54-
The following commands help you create your resource group and Container Apps environment.
53+
The following commands help you create your resource group and container app environment.
5554

5655
1. Create variables to support your application configuration. These values are provided for you for the purposes of this lesson.
5756

@@ -67,12 +66,12 @@ The following commands help you create your resource group and Container Apps en
6766
| Variable | Description |
6867
|---|---|
6968
| `LOCATION` | The Azure region location where you create your container app and Java component. |
70-
| `ENVIRONMENT` | The Azure Container Apps environment name for your demo application. |
69+
| `ENVIRONMENT` | The container app environment name for your demo application. |
7170
| `RESOURCE_GROUP` | The Azure resource group name for your demo application. |
7271
| `JAVA_COMPONENT_NAME` | The name of the Java component created for your container app. In this case, you create an Admin for Spring Java component. |
7372
| `IMAGE` | The container image used in your container app. |
7473

75-
1. Log in to Azure with the Azure CLI.
74+
1. Sign in to Azure with the Azure CLI.
7675

7776
```azurecli
7877
az login
@@ -87,9 +86,9 @@ The following commands help you create your resource group and Container Apps en
8786
--query "properties.provisioningState"
8887
```
8988

90-
Using the `--query` parameter filters the response down to a simple success or failure message.
89+
When you use the `--query` parameter, the response filters down to a simple success or failure message.
9190

92-
1. Create your container apps environment.
91+
1. Create your container app environment.
9392

9493
```azurecli
9594
az containerapp env create \
@@ -100,62 +99,62 @@ The following commands help you create your resource group and Container Apps en
10099

101100
### [Azure portal](#tab/azure-portal)
102101

103-
Use the following steps to create each of the resources necessary to create a container app.
102+
To create each of the resources necessary to create a container app, follow these steps:
104103

105104
1. Search for **Container Apps** in the Azure portal and select **Create**.
106105

107-
1. Enter the following values to *Basics* tab.
106+
1. On the **Basics** tab, enter the following values:
108107

109108
| Property | Value |
110109
|---|---|
111-
| **Subscription** | Select your Azure subscription. |
112-
| **Resource group** | Select **Create new** link to create a new resource group named **my-resource-group**. |
113-
| **Container app name** | Enter **sample-admin-client**. |
114-
| **Deployment source** | Select **Container image**. |
115-
| **Region** | Select the region nearest you. |
116-
| **Container Apps environment** | Select the **Create new** link to create a new environment. |
110+
| Subscription | Select your Azure subscription. |
111+
| Resource group | Select **Create new** to create a new resource group named **my-resource-group**. |
112+
| Container app name | Enter **sample-admin-client**. |
113+
| Deployment source | Select **Container image**. |
114+
| Region | Select the region nearest you. |
115+
| Container app environment | Select **Create new** to create a new environment. |
117116

118-
1. In the *Create Container Apps environment* window, enter the following values.
117+
1. On the **Create Container Apps environment** window, enter the following values:
119118

120119
| Property | Value |
121120
|---|---|
122-
| **Environment name** | Enter **my-environment**. |
123-
| **Zone redundancy** | Select **Disabled**. |
121+
| Environment name | Enter **my-environment**. |
122+
| Zone redundancy | Select **Disabled**. |
124123

125-
Select the **Create** button, and then select the **Container** tab.
124+
1. Select **Create**, and then select the **Container** tab.
126125

127-
1. In *Container* tab, enter the following values.
126+
1. On the **Container** tab, enter the following values:
128127

129128
| Property | Value |
130129
|---|---|
131-
| **Name** | Enter **sample-admin-client**. |
132-
| **Image source** | Select **Docker Hub or other registries**. |
133-
| **Image type** | Select **Public**. |
134-
| **Registry login server** | Enter **mcr.microsoft.com**. |
135-
| **Image and tag** | Enter **javacomponents/samples/sample-admin-for-spring-client:latest**. |
130+
| Name | Enter **sample-admin-client**. |
131+
| Image source | Select **Docker Hub or other registries**. |
132+
| Image type | Select **Public**. |
133+
| Registry sign-in server | Enter **mcr.microsoft.com**. |
134+
| Image and tag | Enter **javacomponents/samples/sample-admin-for-spring-client:latest**. |
136135

137-
Select the **Ingress** tab.
136+
1. Select the **Ingress** tab.
138137

139-
1. In *Ingress* tab, enter the following and leave the rest of the form with their default values.
138+
1. On the **Ingress** tab, enter the following values and leave the rest of the form filled in with the default values.
140139

141140
| Property | Value |
142141
|---|---|
143-
| **Ingress** | Select **Enabled**. |
144-
| **Ingress traffic** | Select **Accept traffic from anywhere**. |
145-
| **Ingress type** | Select **HTTP**. |
146-
| **Target port** | Enter **8080**. |
142+
| Ingress | Select **Enabled**. |
143+
| Ingress traffic | Select **Accept traffic from anywhere**. |
144+
| Ingress type | Select **HTTP**. |
145+
| Target port | Enter **8080**. |
147146

148-
Select **Review + create**.
147+
1. Select **Review + create**.
149148

150-
1. Once the validation checks pass, select **Create** to create your container app.
149+
1. After the validation checks pass, select **Create** to create your container app.
151150

152151
---
153152

154153
## Use the component
155154

156155
### [Azure CLI](#tab/azure-cli)
157156

158-
Now that you have an existing environment, you can create your container app and bind it to a Java component instance of Admin for Spring component.
157+
Now that you have an existing environment, you can create your container app and bind it to a Java component instance of an Admin for Spring component.
159158

160159
1. Create the Admin for Spring Java component.
161160

@@ -185,28 +184,28 @@ Now that you have an existing environment and admin client container app, you ca
185184

186185
1. Go to your container app's environment in the portal.
187186
188-
1. From the left menu, under *Services* category, select **Services**.
187+
1. On the service menu, under **Services**, select **Services**.
189188
190-
1. Select **+ Configure** drop down, and select **Java component**.
189+
1. Select the **+ Configure** dropdown, and select **Java component**.
191190
192-
1. In the *Configure Java component* panel, enter the following values.
191+
1. On the **Configure Java component** pane, enter the following values:
193192
194193
| Property | Value |
195194
|---|---|
196-
| **Java component type** | Select **Admin for Spring**. |
197-
| **Java component name** | Enter **admin**. |
195+
| Java component type | Select **Admin for Spring**. |
196+
| Java component name | Enter **admin**. |
198197
199198
1. Select **Next**.
200199
201-
1. On the *Review* tab, select **Configure**.
200+
1. On the **Review** tab, select **Configure**.
202201
203202
---
204203
205204
## Bind your container app to the Admin for Spring Java component
206205
207206
### [Azure CLI](#tab/azure-cli)
208207
209-
1. Create the container app and bind to the Admin for Spring.
208+
1. Create the container app and bind it to the Admin for Spring component.
210209
211210
```azurecli
212211
az containerapp create \
@@ -223,33 +222,33 @@ Now that you have an existing environment and admin client container app, you ca
223222
224223
### [Azure portal](#tab/azure-portal)
225224
226-
1. Go to your container app environment in the portal.
225+
1. Go to your Container App environment in the portal.
227226
228-
1. From the left menu, under *Services* category, select **Services**.
227+
1. On the service menu, under **Services**, select **Services**.
229228
230229
1. From the list, select **admin**.
231230
232-
1. Under *Bindings*, select the *App name* drop-down and select **sample-admin-client**.
231+
1. Under **Bindings**, select the **App name** dropdown, and select **sample-admin-client**.
233232
234233
1. Select the **Review** tab.
235234
236-
1. Select the **Configure** button.
235+
1. Select **Configure**.
237236
238-
1. Return to your container app in the portal and copy the URL of your app to a text editor so you can use it in a coming step.
237+
1. Return to your container app in the portal. Copy the URL of your app to a text editor so that you can use it in an upcoming step.
239238
240239
---
241240
242-
The bind operation binds the container app to the Admin for Spring Java component. The container app can now read the configuration values from environment variables, primarily the `SPRING_BOOT_ADMIN_CLIENT_URL` property and connect to the Admin for Spring.
241+
The bind operation binds the container app to the Admin for Spring Java component. The container app can now read the configuration values from environment variables, primarily the `SPRING_BOOT_ADMIN_CLIENT_URL` property, and connect to the Admin for Spring component.
243242
244243
The binding also injects the following property:
245244
246245
```bash
247246
"SPRING_BOOT_ADMIN_CLIENT_INSTANCE_PREFER-IP": "true",
248247
```
249248
250-
This property indicates that the Admin for Spring component client should prefer the IP address of the container app instance when connecting to the Admin for Spring server.
249+
This property indicates that the Admin for Spring component client should prefer the IP address of the container app instance when you connect to the Admin for Spring server.
251250
252-
## (Optional) Unbind your container app from the Admin for Spring Java component
251+
## Optional: Unbind your container app from the Admin for Spring Java component
253252
254253
### [Azure CLI](#tab/azure-cli)
255254
@@ -266,24 +265,24 @@ To remove a binding from a container app, use the `--unbind` option.
266265
267266
1. Go to your container app environment in the portal.
268267
269-
1. From the left menu, under *Services* category, select **Services**.
268+
1. On the service menu, under **Services**, select **Services**.
270269
271270
1. From the list, select **admin**.
272271
273-
1. Under *Bindings*, find the line for *sample-admin-client* select and select **Delete**.
272+
1. Under **Bindings**, find the line for **sample-admin-client**, select it, and select **Delete**.
274273
275274
1. Select **Next**.
276275
277276
1. Select the **Review** tab.
278277
279-
1. Select the **Configure** button.
278+
1. Select **Configure**.
280279
281280
---
282281
283282
## View the dashboard
284283
285284
> [!IMPORTANT]
286-
> To view the dashboard, you need to have at least the `Microsoft.App/managedEnvironments/write` role assigned to your account on the managed environment resource. You can either explicitly assign `Owner` or `Contributor` role on the resource or follow the steps to create a custom role definition and assign it to your account.
285+
> To view the dashboard, you need to have at least the `Microsoft.App/managedEnvironments/write` role assigned to your account on the managed environment resource. You can explicitly assign the `Owner` or `Contributor` role on the resource. You can also follow the steps to create a custom role definition and assign it to your account.
287286
288287
1. Create the custom role definition.
289288
@@ -301,9 +300,9 @@ To remove a binding from a container app, use the `--unbind` option.
301300
302301
Make sure to replace the placeholders in between the `<>` brackets with your values.
303302
304-
1. Assign the custom role to your account on managed environment resource.
303+
1. Assign the custom role to your account on the managed environment resource.
305304
306-
Get the resource id of the managed environment:
305+
Get the resource ID of the managed environment:
307306
308307
```azurecli
309308
export ENVIRONMENT_ID=$(az containerapp env show \
@@ -313,7 +312,7 @@ To remove a binding from a container app, use the `--unbind` option.
313312
314313
1. Assign the role to your account.
315314
316-
Before running this command, replace the placeholder in between the `<>` brackets with your user or service principal ID.
315+
Before you run this command, replace the placeholder in between the `<>` brackets with your user or service principal ID.
317316
318317
```azurecli
319318
az role assignment create \
@@ -323,7 +322,7 @@ To remove a binding from a container app, use the `--unbind` option.
323322
```
324323
325324
> [!NOTE]
326-
> <USER_OR_SERVICE_PRINCIPAL_ID> usually should be the identity that you use to access Azure Portal. <ROLE_NAME> is the name you assigned in step 1.
325+
> The <USER_OR_SERVICE_PRINCIPAL_ID> property usually should be the identity that you use to access the Azure portal. The <ROLE_NAME> property is the name that you assigned in step 1.
327326
328327
1. Get the URL of the Admin for Spring dashboard.
329328
@@ -335,24 +334,24 @@ To remove a binding from a container app, use the `--unbind` option.
335334
--query properties.ingress.fqdn -o tsv
336335
```
337336
338-
This command returns the URL you can use to access the Admin for Spring dashboard. Through the dashboard, your container app is also to you as shown in the following screenshot.
337+
This command returns the URL that you can use to access the Admin for Spring dashboard. With the dashboard, you can also see your container app, as shown in the following screenshot.
339338
340-
:::image type="content" source="media/java-components/spring-boot-admin-alone.png" alt-text="Screenshot of the overview the Admin for Spring dashboard." lightbox="media/java-components/spring-boot-admin-alone.png":::
339+
:::image type="content" source="media/java-components/spring-boot-admin-alone.png" alt-text="Screenshot that shows the overview of the Admin for Spring dashboard." lightbox="media/java-components/spring-boot-admin-alone.png":::
341340
342341
## Clean up resources
343342
344-
The resources created in this tutorial have an effect on your Azure bill. If you aren't going to use these services long-term, run the following command to remove everything created in this tutorial.
343+
The resources created in this tutorial have an effect on your Azure bill. If you aren't going to use these services long term, run the following command to remove everything you created in this tutorial.
345344

346345
```azurecli
347346
az group delete \
348347
--resource-group $RESOURCE_GROUP
349348
```
350349

351-
## Next steps
350+
## Next step
352351

353352
> [!div class="nextstepaction"]
354353
> [Configure Admin for Spring settings](java-admin-for-spring-usage.md)
355354

356355
## Related content
357356

358-
- [Integrate the managed Admin for Spring with Eureka Server for Spring](java-admin-eureka-integration.md)
357+
[Integrate the managed Admin for Spring with Eureka Server for Spring](java-admin-eureka-integration.md)

0 commit comments

Comments
 (0)