教程:在 Azure 容器应用中连接到适用于 Spring 的管理控制台
适用于 Spring 的控制台托管组件为公开执行器终结点的 Spring Boot Web 应用程序提供了一个管理界面。 作为 Azure 容器应用中的托管组件,可以轻松地将容器应用绑定到适用于 Spring 的控制台,以便无缝集成和管理。
本教程介绍如何创建适用于 Spring 的控制台 Java 组件并将其绑定到容器应用,以便轻松监视和管理 Spring 应用程序。
在本教程中,学习:
- 创建适用于 Spring 的控制台 Java 组件
- 将容器应用绑定到适用于 Spring 的控制台 Java 组件
注意
若要将适用于 Spring 的控制台与适用于 Spring 的 Eureka 服务器集成,请参阅在 Azure 容器应用中将适用于 Spring 的控制台与适用于 Spring 的 Eureka 服务器集成。
重要
本教程使用的服务可能会影响 Azure 帐单。 如果你决定按部就班,请确保删除本文中特别推荐的资源,以避免意外计费。
先决条件
若要完成此项目,需要满足以下条件:
要求 | 说明 |
---|---|
Azure 帐户 | 需要一个有效的订阅。 如果没有帐户,可以免费创建一个帐户。 |
Azure CLI | 安装 Azure CLI。 |
注意事项
在 Azure 容器应用中运行适用于 Spring 的控制台时,请注意以下详细信息:
项 | 说明 |
---|---|
范围 | 组件与连接的容器应用在同一环境中运行。 |
缩放 | 组件无法缩放。 缩放属性 minReplicas 和 maxReplicas 都设置为 1 。 |
资源 | 为组件分配的容器资源是固定的。 CPU 核心数为 0.5,内存大小为 1Gi。 |
定价 | 组件计费低于基于消耗量的定价。 托管组件消耗的资源按活动/空闲费率计费。 可以删除不再使用的组件以停止计费。 |
Binding | 容器应用通过绑定连接到组件。 绑定将配置注入容器应用环境变量。 建立绑定后,容器应用可以从环境变量读取配置值并连接到该组件。 |
安装
在开始使用适用于 Spring 的控制台之前,首先需要创建所需的资源。
以下命令可帮助你创建资源组和容器应用环境。
创建变量来支持应用程序配置。 这些值是为了本课程的目的而向你提供的。
export LOCATION=chinaeast export RESOURCE_GROUP=my-resource-group export ENVIRONMENT=my-environment export JAVA_COMPONENT_NAME=admin export APP_NAME=sample-admin-client export IMAGE="mcr.microsoft.com/javacomponents/samples/sample-admin-for-spring-client:latest"
变量 说明 LOCATION
创建容器应用和 Java 组件的 Azure 区域位置。 ENVIRONMENT
演示应用程序的 Azure 容器应用环境名称。 RESOURCE_GROUP
演示应用程序的 Azure 资源组名称。 JAVA_COMPONENT_NAME
为容器应用创建的 Java 组件的名称。 在本例中,你将创建适用于 Spring 的控制台 Java 组件。 IMAGE
容器应用中使用的容器映像。 使用 Azure CLI 登录 Azure。
az cloud set -n AzureChinaCloud az login # az cloud set -n AzureCloud //means return to Public Azure.
创建资源组。
az group create \ --name $RESOURCE_GROUP \ --location $LOCATION \ --query "properties.provisioningState"
使用
--query
参数可筛选响应,找到仅包含成功或仅包含失败的消息。创建容器应用环境。
az containerapp env create \ --name $ENVIRONMENT \ --resource-group $RESOURCE_GROUP \ --location $LOCATION
使用组件
有了现有环境后,可以创建容器应用并将其绑定到适用于 Spring 的控制台组件的 Java 组件实例。
创建适用于 Spring 的控制台 Java 组件。
az containerapp env java-component admin-for-spring create \ --environment $ENVIRONMENT \ --resource-group $RESOURCE_GROUP \ --name $JAVA_COMPONENT_NAME \ --min-replicas 1 \ --max-replicas 1
更新适用于 Spring 的控制台 Java 组件。
az containerapp env java-component admin-for-spring create \ --environment $ENVIRONMENT \ --resource-group $RESOURCE_GROUP \ --name $JAVA_COMPONENT_NAME \ --min-replicas 2 \ --max-replicas 2
将容器应用绑定到适用于 Spring 的控制台 Java 组件
创建容器应用并绑定到适用于 Spring 的控制台。
az containerapp create \ --name $APP_NAME \ --resource-group $RESOURCE_GROUP \ --environment $ENVIRONMENT \ --image $IMAGE \ --min-replicas 1 \ --max-replicas 1 \ --ingress external \ --target-port 8080 \ --bind $JAVA_COMPONENT_NAME
绑定操作将容器应用绑定到适用于 Spring 的控制台 Java 组件。 容器应用现在可以从环境变量(主要是 SPRING_BOOT_ADMIN_CLIENT_URL
属性)读取配置值并连接到适用于 Spring 的控制台。
绑定还会注入以下属性:
"SPRING_BOOT_ADMIN_CLIENT_INSTANCE_PREFER-IP": "true",
此属性指示连接到适用于 Spring 的控制台服务器时,适用于 Spring 的控制台组件客户端应首选容器应用实例的 IP 地址。
(可选)从适用于 Spring 的控制台 Java 组件取消绑定容器应用
若要从容器应用中移除绑定,请使用 --unbind
选项。
az containerapp update \
--name $APP_NAME \
--unbind $JAVA_COMPONENT_NAME \
--resource-group $RESOURCE_GROUP
查看仪表板
重要
要查看仪表板,至少需要在托管环境资源上向你的帐户分配 Microsoft.App/managedEnvironments/write
角色。 可在资源上显式分配 Owner
或 Contributor
角色,也可按照以下步骤创建自定义角色定义,并将其分配给你的帐户。
创建自定义角色定义。
az role definition create --role-definition '{ "Name": "<ROLE_NAME>", "IsCustom": true, "Description": "Can access managed Java Component dashboards in managed environments", "Actions": [ "Microsoft.App/managedEnvironments/write" ], "AssignableScopes": ["/subscriptions/<SUBSCRIPTION_ID>"] }'
确保将
<>
括号中的占位符替换为你的值。将自定义角色分配给托管环境资源上的帐户。
获取托管环境的资源 ID:
export ENVIRONMENT_ID=$(az containerapp env show \ --name $ENVIRONMENT --resource-group $RESOURCE_GROUP \ --query id -o tsv)
将角色分配给帐户。
运行此命令之前,请将
<>
括号之间的占位符替换为用户或服务主体 ID。az role assignment create \ --assignee <USER_OR_SERVICE_PRINCIPAL_ID> \ --role "<ROLE_NAME>" \ --scope $ENVIRONMENT_ID
注意
USER_OR_SERVICE_PRINCIPAL_ID 通常是用于访问 Azure 门户的标识。<> ROLE_NAME 是在第 1 步中分配的名称。<>
获取适用于 Spring 的控制台仪表板的 URL。
az containerapp env java-component admin-for-spring show \ --environment $ENVIRONMENT \ --resource-group $RESOURCE_GROUP \ --name $JAVA_COMPONENT_NAME \ --query properties.ingress.fqdn -o tsv
此命令会返回可用来访问适用于 Spring 的控制台仪表板的 URL。 通过该仪表板,还可查看容器应用,如以下屏幕截图所示。
清理资源
本教程中创建的资源会影响 Azure 帐单。 如果不打算长期使用这些服务,请运行以下命令来删除本教程中创建的所有内容。
az group delete \
--resource-group $RESOURCE_GROUP