将 Quarkus 应用程序部署到 Azure 容器应用

已完成

在本单元中,你将打包 Quarkus 应用程序并将其部署到 Azure 容器应用,其数据库密码以运行时机密的形式提供。

在生成的 todo 项目目录中,从上一单元的本地 Bash shell 继续。 在该 shell 中保留所有导出的资源和数据库变量。 在打包之前使用 Ctrl+C 停止前台 Quarkus 开发模式,并且不要重新运行随机名称和密码块。

为 Quarkus 应用程序设置 Dockerfile

Container Apps 用于部署容器化应用程序。 因此,首先需要将 Quarkus 应用程序容器化为 Docker 镜像。 此过程很简单,因为 Quarkus Maven 插件已在 src/main/docker下生成了一些 Dockerfiles。

使用此命令将其中一个 Dockerfiles、Dockerfile.jvm 重命名为 Dockerfile 并将其移动到根文件夹:

mv src/main/docker/Dockerfile.jvm ./Dockerfile

将 Dockerfile 中长注释后的内容替换为以下内容:

FROM registry.access.redhat.com/ubi8/openjdk-17:1.18

ENV LANGUAGE='en_US:en'


# We make four distinct layers so if there are application changes the library layers can be re-used
COPY --chown=185 target/quarkus-app/lib/ /deployments/lib/
COPY --chown=185 target/quarkus-app/*.jar /deployments/
COPY --chown=185 target/quarkus-app/app/ /deployments/app/
COPY --chown=185 target/quarkus-app/quarkus/ /deployments/quarkus/

EXPOSE 8080
USER 185
ENV JAVA_OPTS_APPEND="-Dquarkus.http.host=0.0.0.0 -Djava.util.logging.manager=org.jboss.logmanager.LogManager"
ENV JAVA_APP_JAR="/deployments/quarkus-run.jar"

ENTRYPOINT [ "/opt/jboss/container/java/run/run-java.sh" ]

Important

不要将数据库凭据放入源文件、Docker 生成参数或映像中,也不要打印或跟踪其值。 应用程序机密将凭据与镜像分开,但授权的机密读取主体仍可以检索它。 对于生产,请遵循无密码身份验证指南并密钥保管库 机密相关指南,并应用适当的权限。

此 Dockerfile 需要打包在 target/quarkus-app 文件夹中的 Quarkus 应用程序,包括 quarkus-run.jar 启动器及其支持目录。 将上一单元中字面量、按配置文件作用域限定的表达式保留在 application.properties 中。 在 Docker 已运行且可从此 Bash 环境访问的情况下,请运行清理包:

./mvnw clean package

此命令针对单独的 PostgreSQL 开发服务运行自动测试,并将应用程序打包到 target/quarkus-app 中。 test配置不得使用 Azure 数据库。 不要跳过测试;在继续之前解决任何生成或测试失败。 清理包还可避免复用可能包含明文凭据的旧应用程序生成输出。

重新生成当前映像不会从旧映像或源副本中删除凭据。 如果你此前分发或公开过含凭据的工件,请轮换该凭据,并通过你获授权的清理流程移除过时的工件。 以下部署步骤不执行该轮换或删除旧构件。

创建容器应用环境并部署容器

分三个阶段进行部署,以便 Quarkus 在其数据库密钥和运行时设置可用之前不会启动。 仅使用位于 AZ_RESOURCE_GROUP 中、归本练习所有的新应用,该应用的名称由 AZ_CONTAINERAPP 指定。 不要针对不相关的或生产应用运行 bootstrap 步骤。 请先成功执行完每个命令,然后再继续。

首先,使用Microsoft的公共快速入门映像创建应用和环境。 此临时映像侦听端口 80,不需要数据库凭据:

az containerapp up \
    --name "$AZ_CONTAINERAPP" \
    --environment "$AZ_CONTAINERAPP_ENV" \
    --location "$AZ_LOCATION" \
    --resource-group "$AZ_RESOURCE_GROUP" \
    --image mcr.microsoft.com/k8se/quickstart:latest \
    --ingress external \
    --target-port 80

此调用在练习资源组中建立应用、环境和默认Log Analytics工作区。 尚未部署 Quarkus 应用程序。

接下来,先在现有应用中将数据库密码存储为机密,然后再引用它:

az containerapp secret set \
    --name "$AZ_CONTAINERAPP" \
    --resource-group "$AZ_RESOURCE_GROUP" \
    --secrets "postgres-password=$AZ_POSTGRES_PASSWORD" \
    --output none

最后,从 todo 项目根目录将干净的 Quarkus 应用程序部署到同一应用、环境和资源组。 目标端口更改为 8080。 前两个运行时值来自当前 shell;密码通过 Secret 引用提供:

az containerapp up \
    --name "$AZ_CONTAINERAPP" \
    --environment "$AZ_CONTAINERAPP_ENV" \
    --location "$AZ_LOCATION" \
    --resource-group "$AZ_RESOURCE_GROUP" \
    --ingress external \
    --target-port 8080 \
    --source . \
    --env-vars \
        "AZ_POSTGRES_JDBC_URL=$AZ_POSTGRES_JDBC_URL" \
        "AZ_POSTGRES_USERNAME=$AZ_POSTGRES_USERNAME" \
        "AZ_POSTGRES_PASSWORD=secretref:postgres-password"

此本地源部署根据需要创建Azure容器注册表,从根 Dockerfile 生成 Docker 映像,将其推送到注册表,并使用 Quarkus 映像和运行时配置更新现有应用。 它在配置注册表访问权限的同时,保留数据库机密。 命令可能需要几分钟才能完成。

此练习创建的所有资源都保留在 AZ_RESOURCE_GROUP其中,因此,模块末尾的资源组清理仍适用。 此基于密码的练习保留了默认注册表身份验证流 az containerapp up;这不是完整的生产安全体系结构。

验证部署

首先,通过在 Azure 门户中搜索资源组来确认是否已创建资源。 应会看到如下所示的资源:生成的名称将有所不同:

列出已部署容器应用及其支持资源的Azure门户资源组的屏幕截图。

还可以列出练习资源组中的资源,包括 PostgreSQL 和由 az containerapp up 创建的资源:

az resource list \
    --location "$AZ_LOCATION" \
    --resource-group "$AZ_RESOURCE_GROUP" \
    --output table

此时应会看到如下例所示的输出:

Name                               ResourceGroup        Location    Type                                       Status
---------------------------------  -------------------  ----------  -----------------------------------------  --------
caea3a6e0afeacr                     rgquarkus-12345678   eastus      Microsoft.ContainerRegistry/registries
psqlquarkus-12345678                rgquarkus-12345678   eastus      Microsoft.DBforPostgreSQL/flexibleServers
caquarkus-12345678                  rgquarkus-12345678   eastus      Microsoft.App/containerApps
caequarkus-12345678                 rgquarkus-12345678   eastus      Microsoft.App/managedEnvironments
workspace-rgquarkus12345678abcd     rgquarkus-12345678   eastus      Microsoft.OperationalInsights/workspaces

单独创建资源并不能证明应用程序已就绪。 在Azure门户中,打开容器应用并检查其活动修订。 验证它是否使用新生成的 Quarkus 映像,而不是 mcr.microsoft.com/k8se/quickstart:latest,并成功启动。 在继续执行 POST 和 GET 检查之前解决启动错误。 一个可用的临时快速入门页面并不能证明 Quarkus 部署成功。

验证已部署的应用程序

在运行 Quarkus 修订版本之后,请验证应用程序的 API。 首先,在同一 Bash shell 中获取完整的入口 FQDN:

export AZ_APP_URL=$(
    az containerapp show \
        --name "$AZ_CONTAINERAPP" \
        --resource-group "$AZ_RESOURCE_GROUP" \
        --query "properties.configuration.ingress.fqdn" \
        --output tsv \
)

echo "AZ_APP_URL=$AZ_APP_URL"

使用返回 AZ_APP_URL 的完整 FQDN;其中包含该环境的 DNS 后缀。 应用程序的 to-do 终结点为 https://<the AZ_APP_URL value>/api/todos. 容器应用为此默认终结点提供 HTTPS/TLS 终止。

使用 cURL 创建 to-do。 该 --include 选项显示响应标头,以便可以检查 HTTP 201 和创建的项的 JSON 正文:

curl --include --header "Content-Type: application/json" \
    --request POST \
    --data '{"description":"Configuration","details":"Congratulations, you have set up your Quarkus application correctly!","done": "true"}' \
    "https://$AZ_APP_URL/api/todos"

使用新的 cURL 请求检索数据。 检查 HTTP 200 以及在此单元和上一单元中创建的项:

curl --include "https://$AZ_APP_URL/api/todos"

响应正文是一个 JSON 数组,其中包含在Azure数据库中创建的项。 标识符、时间戳和顺序可能会有所不同。 重复 POST 将创建另一项;此示例是说明性的,而不是确切的响应断言:

[
   {
      "description" : "Take Quarkus MS Learn",
      "details" : "Take the MS Learn on deploying Quarkus to Azure Container Apps",
      "done" : true,
      "id" : 1,
      "createdAt" : "2025-02-26T08:03:28.390854Z"
   },
   {
      "description" : "Take Azure Container Apps MS Learn",
      "details" : "Take the ACA Learn module",
      "done" : false,
      "id" : 2,
      "createdAt" : "2025-02-26T08:03:34.142249Z"
   },
   {
      "description" : "Configuration",
      "details" : "Congratulations, you have set up your Quarkus application correctly!",
      "done" : true,
      "id" : 3,
      "createdAt" : "2025-02-26T08:05:00.000000Z"
   }
]

来自 Quarkus 修订版的成功 POST 和 GET 响应以及符合预期的描述,确认了应用程序检查通过。 不要将引导页或资源列表单独用作成功条件。

若要流式传输容器日志,请在包含资源变量的 Bash shell 中运行以下命令:

az containerapp logs show \
    --name "$AZ_CONTAINERAPP" \
    --resource-group "$AZ_RESOURCE_GROUP" \
    --follow

在第二个本地 Bash 终端中,用前面显示的完整 FQDN 替换 <returned-fqdn>,并在跟踪日志时发送更多请求。 此终端只需要应用程序地址,而不需要数据库密码:

export AZ_APP_URL="<returned-fqdn>"
curl --include "https://$AZ_APP_URL/api/todos"

结束日志跟踪后,在原始终端中按 Ctrl+C。 保持该 shell 处于打开状态,以便在下一单元中使用其中的资源变量。

注释

若要在浏览器中查看 JSON 列表,请打开 https://<the AZ_APP_URL value>/api/todos,将占位符替换为返回的 FQDN。 该模块未在 / 处实现待办事项网页。