You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/container-apps/java-admin.md
+71-72Lines changed: 71 additions & 72 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
---
2
2
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.
4
4
services: container-apps
5
5
author: craigshoemaker
6
6
ms.service: azure-container-apps
@@ -14,25 +14,24 @@ ms.author: cshoe
14
14
15
15
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.
16
16
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.
18
18
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":::
20
20
21
-
In this tutorial, you learn to:
21
+
In this tutorial, you learn how to:
22
22
23
23
> [!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.
26
26
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.
29
28
30
29
> [!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.
32
31
33
32
## Prerequisites
34
33
35
-
To complete this project, you need the following items:
34
+
To finish this project, you need the following items:
36
35
37
36
| Requirement | Instructions |
38
37
|--|--|
@@ -41,17 +40,17 @@ To complete this project, you need the following items:
41
40
42
41
## Considerations
43
42
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:
| Container app environment | Select **Create new** to create a new environment. |
117
116
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:
119
118
120
119
| Property | Value |
121
120
|---|---|
122
-
|**Environment name**| Enter **my-environment**. |
123
-
|**Zone redundancy**| Select **Disabled**. |
121
+
| Environment name | Enter **my-environment**. |
122
+
| Zone redundancy | Select **Disabled**. |
124
123
125
-
Select the **Create** button, and thenselectthe**Container** tab.
124
+
1. Select **Create**, and thenselectthe**Container** tab.
126
125
127
-
1. In *Container* tab, enter the following values.
126
+
1. On the **Container** tab, enter the following values:
128
127
129
128
| Property | Value |
130
129
|---|---|
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**. |
136
135
137
-
Select the **Ingress** tab.
136
+
1. Select the **Ingress** tab.
138
137
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 inwith the default values.
140
139
141
140
| Property | Value |
142
141
|---|---|
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**. |
147
146
148
-
Select **Review + create**.
147
+
1. Select **Review + create**.
149
148
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.
151
150
152
151
---
153
152
154
153
## Use the component
155
154
156
155
### [Azure CLI](#tab/azure-cli)
157
156
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.
159
158
160
159
1. Create the Admin for Spring Java component.
161
160
@@ -185,28 +184,28 @@ Now that you have an existing environment and admin client container app, you ca
185
184
186
185
1. Go to your container app's environment in the portal.
187
186
188
-
1. From the left menu, under *Services* category, select **Services**.
187
+
1. On the service menu, under **Services**, select **Services**.
189
188
190
-
1. Select **+ Configure** drop down, and select **Java component**.
189
+
1. Select the **+ Configure** dropdown, and select **Java component**.
191
190
192
-
1. In the *Configure Java component* panel, enter the following values.
191
+
1. On the **Configure Java component** pane, enter the following values:
193
192
194
193
| Property | Value |
195
194
|---|---|
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**. |
198
197
199
198
1. Select **Next**.
200
199
201
-
1. On the *Review* tab, select **Configure**.
200
+
1. On the **Review** tab, select **Configure**.
202
201
203
202
---
204
203
205
204
## Bind your container app to the Admin for Spring Java component
206
205
207
206
### [Azure CLI](#tab/azure-cli)
208
207
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.
210
209
211
210
```azurecli
212
211
az containerapp create \
@@ -223,33 +222,33 @@ Now that you have an existing environment and admin client container app, you ca
223
222
224
223
### [Azure portal](#tab/azure-portal)
225
224
226
-
1. Go to your container app environment in the portal.
225
+
1. Go to your Container App environment in the portal.
227
226
228
-
1. From the left menu, under *Services* category, select **Services**.
227
+
1. On the service menu, under **Services**, select **Services**.
229
228
230
229
1. From the list, select **admin**.
231
230
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**.
233
232
234
233
1. Select the **Review** tab.
235
234
236
-
1. Select the **Configure** button.
235
+
1. Select **Configure**.
237
236
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.
239
238
240
239
---
241
240
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.
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.
251
250
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
253
252
254
253
### [Azure CLI](#tab/azure-cli)
255
254
@@ -266,24 +265,24 @@ To remove a binding from a container app, use the `--unbind` option.
266
265
267
266
1. Go to your container app environment in the portal.
268
267
269
-
1. From the left menu, under *Services* category, select **Services**.
268
+
1. On the service menu, under **Services**, select **Services**.
270
269
271
270
1. From the list, select **admin**.
272
271
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**.
274
273
275
274
1. Select **Next**.
276
275
277
276
1. Select the **Review** tab.
278
277
279
-
1. Select the **Configure** button.
278
+
1. Select **Configure**.
280
279
281
280
---
282
281
283
282
## View the dashboard
284
283
285
284
> [!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.
287
286
288
287
1. Create the custom role definition.
289
288
@@ -301,9 +300,9 @@ To remove a binding from a container app, use the `--unbind` option.
301
300
302
301
Make sure to replace the placeholders in between the `<>` brackets with your values.
303
302
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.
305
304
306
-
Get the resource id of the managed environment:
305
+
Get the resource ID of the managed environment:
307
306
308
307
```azurecli
309
308
export ENVIRONMENT_ID=$(az containerapp env show \
@@ -313,7 +312,7 @@ To remove a binding from a container app, use the `--unbind` option.
313
312
314
313
1. Assign the role to your account.
315
314
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.
317
316
318
317
```azurecli
319
318
az role assignment create \
@@ -323,7 +322,7 @@ To remove a binding from a container app, use the `--unbind` option.
323
322
```
324
323
325
324
> [!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.
327
326
328
327
1. Get the URL of the Admin for Spring dashboard.
329
328
@@ -335,24 +334,24 @@ To remove a binding from a container app, use the `--unbind` option.
335
334
--query properties.ingress.fqdn -o tsv
336
335
```
337
336
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.
339
338
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":::
341
340
342
341
## Clean up resources
343
342
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 longterm, run the following command to remove everything you created in this tutorial.
345
344
346
345
```azurecli
347
346
az group delete \
348
347
--resource-group $RESOURCE_GROUP
349
348
```
350
349
351
-
## Next steps
350
+
## Next step
352
351
353
352
> [!div class="nextstepaction"]
354
353
> [Configure Admin for Spring settings](java-admin-for-spring-usage.md)
355
354
356
355
## Related content
357
356
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