Compose 프로젝트 가져오기 — PostgreSQL과 Redis를 사용하는 노트 API
API, 그 API가 노트를 보관하는 PostgreSQL 데이터베이스, Redis 캐시를 실행하는 Compose 파일을 aggrega import로 Aggrega 파일 초안으로 작성하고 — 연결, 데이터베이스 설정, 변수 참조로서의 비밀번호, 각 이미지의 태그를 그대로 옮겨 — Docker Compose용으로 빌드합니다.
Compose 프로젝트 가져오기에서는 명령, 그 명령이 작성하는 파일과 각 줄이 있는 이유, 빌드, 그리고 실행 중인 스택을 단계별로 안내합니다. 이 폴더에는 그 안내의 각 단계가 들어 있습니다:
| 폴더 또는 파일 | 내용 |
|---|---|
source/ | Compose 프로젝트 compose.yaml, 폴더를 워크스페이스로 만드는 .aggrega-config.yaml, 그리고 Kubernetes용 빌드에 필요하지만 어떤 Compose 파일에도 없는 값 하나를 담은 import-answers.yaml |
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` 폴더가 없으면 `example`을 `import-compose`로 설정하고 `dir`은 지정하지 않은 채 `scaffold` 도구를 한 번 호출하십시오. 이 도구는 예제를 새 `import-compose` 폴더에 쓰며, 그 안의 `source` 폴더에 이 예제가 가져오는 내용이 들어 있습니다. 그런 다음 `workspace_root`를 `import-compose/source`로, `source`를 `compose.yaml`로, `target`을 `compose`로 설정하여 `import` 도구를 호출하십시오. 이 도구는 필요한 답변을 `compose.yaml` 옆의 `import-answers.yaml`에서 읽고, 초안을 `import-compose/source`에 쓰며, 초안에 필요한 것을 풀합니다. 그런 다음 `workspace_root`를 `import-compose/source`로, `release`를 `release.yaml`로 설정하여 `validate` 도구를 호출하고, `workspace_root`를 `import-compose/source`로, `release`를 `release.yaml`로, `write`를 true로 설정하여 `build` 도구를 호출하십시오. 빌드가 쓴 파일을 알려 주십시오. 파일은 `import-compose/source/dist/` 아래에 있습니다.테스트하기
연습 가이드에서 실행하는 방식대로 스택을 실행하고, 포트 8080에서 HTTP에 응답하는 이미지를 API용으로 지정한 상태에서, 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은 데이터베이스에만 전달되므로 그곳에서 API는 아직 데이터베이스 비밀번호를 받지 못합니다:
kubectl port-forward -n <namespace> svc/api-default 8080:8080