导入 Compose 项目 — 一个使用 PostgreSQL 和 Redis 的笔记 API
一个 Compose 文件,运行一个 API、该 API 存放笔记的 PostgreSQL 数据库和一个 Redis 缓存,由 aggrega import 起草为 Aggrega 文件 — 连接、数据库设置、作为变量引用的密码以及每个镜像的标签均被沿用 — 并为 Docker Compose 构建。
导入 Compose 项目 逐步讲解了这一过程:命令、它写入的文件以及每一行存在的原因、构建,以及运行中的栈。此文件夹保存了该演练的每个阶段:
| 文件夹或文件 | 内容 |
|---|---|
source/ | Compose 项目 compose.yaml、使该文件夹成为工作区的 .aggrega-config.yaml,以及 import-answers.yaml,即面向 Kubernetes 的构建所需、而任何 Compose 文件都不包含的那一个值 |
draft/ | aggrega import compose.yaml --target compose 写入的文件(未经修改,包括 release.lock),以及它打印的内容:stdout.txt 为标准输出,import.txt 为标准错误 |
在文档仓库的检出副本中,check.sh 会重新运行导入,将其写入和打印的内容与 draft/ 比较,将演练引用的代码块与这些文件比较,并验证和构建导入所写入的内容。它需要将标准库目录(获取途径)检出在此仓库旁边,或在 AGGREGA_CATALOG_DIRS 中指定其目录。
生成示例
你可以使用下面的命令运行本示例的导入,或者让你的 AI 助手替你运行。
将示例写入一个以其命名的新文件夹:
aggrega scaffold --example import-compose然后它会打印接下来要运行的命令。第一条命令进入新文件夹:
cd import-compose构建
导入会在项目旁边的 source/ 中起草 Aggrega 文件。它根据标准库目录评估该项目,该目录由工作区的默认注册表以签名快照的形式发布:首次导入会获取它、验证它、将其保存在工作区的内容缓存中,并在写在草稿旁边的记录中以其摘要标识它。如果工作区指定了自己的目录文件夹 — 在 AGGREGA_CATALOG_DIRS 中,或在 workspace.catalog_dirs 下 — 则改为根据这些文件夹进行导入。导入随后拉取所起草的 Release 所依赖的内容,因此可以立即进行构建:
cd sourceaggrega import compose.yaml --target composeaggrega build --release release.yaml构建会写入 dist/compose/docker-compose.yaml;如何运行它,请参阅上方链接的演练。
借助 AI 助手
已配置 Aggrega 工具的 AI 助手也能完成同样的操作:把下面这条提示粘贴给它。
只使用 Aggrega 工具,不要自行创建任何文件夹。如果工作区文件夹中还没有 `import-compose` 文件夹,调用一次 `scaffold` 工具,将 `example` 设为 `import-compose`,且不设置 `dir`:它会把示例写入新的 `import-compose` 文件夹,其中的 `source` 文件夹存放本示例要导入的内容。然后调用 `import` 工具,将 `workspace_root` 设为 `import-compose/source`,`source` 设为 `compose.yaml`,`target` 设为 `compose`:它从 `compose.yaml` 旁边的 `import-answers.yaml` 读取所需的答案,把草稿写入 `import-compose/source`,并拉取这些草稿所需的内容。然后调用 `validate` 工具,将 `workspace_root` 设为 `import-compose/source`,`release` 设为 `release.yaml`;再调用 `build` 工具,将 `workspace_root` 设为 `import-compose/source`,`release` 设为 `release.yaml`,`write` 设为 true。告诉我这次构建写入了哪些文件;它们位于 `import-compose/source/dist/` 下。测试
按照分步指南的方式运行该栈,并为该 API 指定一个在 8080 端口应答 HTTP 的镜像,然后在 Release 发布的端口上请求该 API:
curl -sS http://127.0.0.1:8080/notes分步指南中的替身程序会以它所收到请求的描述作为应答:
{ "path": "/notes", "headers": { "host": "127.0.0.1:8080", [… omitted: the user agent and the media types the client sent] }, "method": "GET", [… omitted: the rest of the request as the stand-in received it, the client's address and the container's host name]}如分步指南所示,使用 --target helm 导入并应用到 Kubernetes 后,只要将一个本地端口转发到它的 Service,该 API 就会在同一地址应答同样的请求;在那里它还收不到其数据库密码,因为该 Secret 只送达数据库:
kubectl port-forward -n <namespace> svc/api-default 8080:8080