콘텐츠로 이동
AggregaAggrega
언어 선택: 한국어
이 페이지는 기계 번역되었습니다. 영어 원문 읽기.

하나의 계약, 세 가지 구현

PostgreSQL 데이터베이스와 이를 읽는 애플리케이션을 변경되지 않은 하나의 Aggregate로부터 세 가지 방식으로 배포합니다. 클러스터에서 실행되는 PostgreSQL, 관리형 클라우드 인스턴스로서의 PostgreSQL, 그리고 이 Release가 배포되기 전부터 존재하던 PostgreSQL 서버입니다.

핵심은 바뀌지 않는 것입니다. 애플리케이션은 데이터베이스에서 원하는 키와 그 이름을 한 번만 지정합니다. 세 가지 중 어느 것이 응답했는지는 결코 알지 못합니다. 컴파일러도 마찬가지로 알지 못합니다. 컴파일러는 선택된 Recipe가 게시한 키를 읽고 문자열을 라우팅할 뿐입니다.

달라지는 단 한 가지

.-- helm/postgres ---------- a StatefulSet in the cluster
/
core/datastore/postgres --- terraform/postgres-rds -- an RDS instance in Terraform
one Component \
one contract '- helm/postgres-external -- a server that already exists

세 개의 Recipes가 같은 Component를 구현합니다. 각각은 같은 provides 키를 게시합니다. host, port, user, database, protocol, 그리고 스크레이퍼가 데이터베이스의 메트릭을 어디에서 찾는지 알려 주는 키로, 이 키들은 세 가지 모두에서 비어 있습니다. 어느 것이 실행되는지는 Manifest의 한 줄로 정해집니다.

파일

  • aggregate.yaml — 개발자의 의도이며, 세 배포 모두에 동일한 문서입니다. core/datastore/postgres 유형의 db component, 이를 uses하는 app, 그리고 애플리케이션이 요청하는 다섯 개의 키로 구성됩니다. 여기에는 대상, 클라우드, Recipe를 지정하는 내용이 전혀 없습니다.
  • manifest-selfhosted.yaml, manifest-managed.yaml, manifest-external.yaml — Ops 매핑입니다. 각각 한 줄로 구현 방식을 선택합니다. 바로 PostgreSQL component 유형이 어떤 Recipe에 바인딩되는지입니다. 관리형 매핑은 해당 Releases가 연결하는 백업 Feature도 바인딩합니다.
  • release-selfhosted.yaml, release-managed.yaml, release-external.yaml — 각 Release에서의 운영자 규모 설정입니다. 클러스터 내 배포에는 스토리지와 엔진 버전, 관리형 배포에는 스토리지, HA, core/backup 연결, 참조형 배포에는 기존 서버의 주소를 지정합니다.
  • release-managed-dns.yaml — 관리형 Release를 한 번 더 작성한 것으로, 운영자가 인스턴스에 부여하는 DNS 이름을 포함하여 애플리케이션이 확인할 수 있는 이름을 전달받도록 합니다.
  • catalog/ — 애플리케이션 자체의 Component와 이를 렌더링하는 하나의 Recipe입니다. 데이터베이스 쪽의 모든 것은 표준 라이브러리를 수정 없이 그대로 사용합니다.

예제 생성하기

아래 명령으로 이 예제를 빌드하거나, AI 어시스턴트에게 대신 빌드하게 할 수 있습니다.

예제 이름을 딴 새 폴더에 예제를 씁니다:

Terminal window
aggrega scaffold --example postgres-three-realizations

그런 다음 이어서 실행할 명령을 출력합니다. 첫 번째 명령은 새 폴더로 이동합니다:

Terminal window
cd postgres-three-realizations

빌드

Terminal window
aggrega build --release release-selfhosted.yaml --auto-pull
aggrega build --release release-managed.yaml --auto-pull
aggrega build --release release-managed-dns.yaml --auto-pull
aggrega build --release release-external.yaml --auto-pull

--auto-pull은 각 Release의 첫 빌드에서 그 잠금 파일을 기록하며, 이후 빌드에는 플래그가 필요하지 않습니다. 각 빌드는 dist/에 기록하며, 이전 빌드가 남긴 것을 지우지 않고 자신의 파일을 추가합니다. 한 구현의 출력만 따로 보려면 실행 사이에 dist/를 삭제하십시오.

Terminal window
rm -rf dist && aggrega build --release release-managed.yaml

AI 어시스턴트 사용

Aggrega 도구로 설정한 AI 어시스턴트도 같은 작업을 할 수 있습니다. 다음 프롬프트를 붙여 넣으십시오.

Aggrega 도구만 사용하고 폴더를 직접 만들지 마십시오. Workspace 폴더에 아직 `postgres-three-realizations` 폴더가 없으면 `example`을 `postgres-three-realizations`로 설정하고 `dir` 없이 `scaffold` 도구를 한 번 호출하십시오. 그러면 새 `postgres-three-realizations` 폴더에 예제가 작성됩니다. 그런 다음 각 Release마다 `release-selfhosted.yaml`, `release-managed.yaml`, `release-managed-dns.yaml`, `release-external.yaml` 순서로 `build` 도구를 한 번씩 호출하되, 매번 `workspace_root`를 `postgres-three-realizations`로, `release`를 해당 파일로, `auto_pull`을 true로, `write`를 true로 설정하십시오. 각 빌드가 작성한 파일을 알려 주십시오. 파일은 `postgres-three-realizations/dist/` 아래에 있습니다.

각각이 렌더링하는 것

셀프 호스팅 — 배포가 서버를 실행합니다

helm/postgres는 클러스터 안에 데이터베이스를 합성합니다. StatefulSet 하나, ClusterIP Service 하나, headless Service 하나입니다. provides.host는 그 Service의 이름 그대로이므로, 애플리케이션은 클러스터 내부 DNS로 데이터베이스에 접근합니다.

dist/stack/helm/app-deployment.yaml
- name: DB_HOST
value: db-default

관리형 — 클라우드 제공자가 서버를 실행합니다

terraform/postgres-rds는 aws_db_instance를 Terraform HCL로 내보내며, 운영자가 정한 ha 크기 설정과 core/backup 연결은 인스턴스의 네이티브 설정으로 매핑됩니다. 연결의 retention_days: 14는 인스턴스의 backup_retention_period = 14가 됩니다. 애플리케이션은 여전히 Kubernetes로 렌더링됩니다. 이 배포의 두 쪽은 공유 대상이 아니라 데이터베이스가 게시한 계약에서 만납니다.

dist/stack/helm/app-deployment.yaml
- name: DB_HOST
value: ${module.db.address}

그 값은 호스트 이름이 아니며, 이 빌드의 어떤 것도 그것을 호스트 이름으로 바꾸지 않습니다. RDS 인스턴스의 주소는 인스턴스가 생성되기 전에는 존재하지 않으므로, 사전에 실행되는 컴파일러가 조회할 것이 없습니다. Recipe가 게시하는 것은 데이터베이스 자체 모듈의 출력을 가리키는 Terraform 참조입니다. 컴파일러는 이를 손대지 않고 엣지 너머로 전달하고, 애플리케이션의 Recipe는 이를 그대로 받으며, 이는 위에 보인 문자 그대로 Kubernetes manifest에 렌더링됩니다. 컨테이너에는 그 텍스트가 전달됩니다.

DB_PORT는 다릅니다. 이는 "5432"로 렌더링되는데, Recipe가 인스턴스의 포트를 Release에서 설정하고 그와 같은 값을 게시하기 때문이며, 이 값은 아무것도 존재하기 전에 알려져 있습니다.

두 구성 요소 사이의 네이티브 연결은 대상이 자신의 출력 안에서 하는 일이므로, 여기서는 할 것이 없습니다. 이 엣지의 두 끝은 서로 다른 대상을 통해 렌더링되며 — 데이터베이스는 Terraform HCL로, 애플리케이션은 Kubernetes manifest로 — Terraform 참조는 Terraform 구성 안에서만 의미를 가집니다. 그 경계를 넘으면 게시된 값은 다른 문자열과 마찬가지로 텍스트로 전달됩니다. 데이터베이스와 같은 루트 구성 안에서 source: Recipe로서 Terraform에 렌더링되는 소비자는 같은 참조를 자기 모듈의 인수 하나로 받으며, 그곳에서 Terraform이 이를 해석합니다.

이것은 RDS를 위한 특수한 경우가 아니라 일반적인 규칙입니다. 실행 중인 시스템의 상태에 의존하는 것은 무엇이든 런타임이 해석하는 결정적인 포인터로 표현되며, 컴파일러가 가져오는 값으로 표현되지 않습니다. 컴파일러의 몫은 포인터를 바꾸지 않고 전달하는 것입니다. 포인터가 도착한 곳에서 해석되게 하는 것은 Recipe 작성자의 몫입니다. 소비하는 쪽이 사용할 수 있는 주소를 게시하거나, 두 구성 요소 모두에 같은 대상으로 렌더링되는 Recipes를 주십시오.

애플리케이션이 해석할 수 있는 이름을 인스턴스에 부여하기

terraform/postgres-rds는 그중 첫 번째 방법을 운영자가 설정하는 옵션으로 받습니다. release-managed-dns.yaml은 관리형 Release에 한 가지, 즉 운영자가 인스턴스에 부여하는 DNS 이름을 추가한 것입니다:

db:
infra:
overrides:
host: db.internal.example.net

Recipe는 Terraform 참조 대신 그 이름을 host로 게시하며, 애플리케이션은 이를 받습니다:

dist/stack/helm/app-deployment.yaml
- name: DB_HOST
value: db.internal.example.net
변수release-managed.yamlrelease-managed-dns.yaml
DB_HOST${module.db.address}db.internal.example.net
DB_PORT54325432

출력에서 바뀌는 줄은 이것뿐입니다. Recipe는 그 이름에 대한 DNS 레코드도 별칭도 내보내지 않으며, 빌드는 이를 조회하지 않습니다. 컴파일러는 참조를 전달했던 것과 똑같이 이를 전달합니다. 인스턴스가 존재하게 된 뒤 db.internal.example.net이 인스턴스를 가리키게 하는 것 — 운영자 자신의 DNS 영역에 인스턴스 주소를 향하는 레코드를 두는 것 — 은 Release 밖에 있는 운영자의 몫입니다. 이 키는 아래의 참조형 구현이 같은 주소를 위해 읽는 키와 같습니다. 이 Recipe는 이를 이름 그대로나 IP 리터럴로 받으며, 스킴, 경로, 사용자 또는 포트를 담은 값은 빌드를 중단시킵니다. 포트는 Release의 infra.port이고 소비자는 이 둘로 연결을 구성하기 때문입니다.

데이터베이스와 같은 Terraform 구성으로 렌더링되는 소비자도 그 이름을 받으며, 그와 함께 참조가 주던 순서를 잃습니다. Terraform은 어떤 모듈이 참조하는 모듈 다음에 그 모듈을 처리하는데, 이름은 아무것도 참조하지 않습니다. 그 소비자를 데이터베이스의 directory:를 공유하고 더 늦은 syncWave:를 가진 자체 경계에 두면 순서가 복원됩니다.

외부 — 이 배포의 누구도 서버를 실행하지 않습니다

helm/postgres-external은 아무것도 프로비저닝하지 않습니다. 그 출력 전체는 클러스터 내부 이름을 Release가 제공하는 주소로 매핑하는 Service 하나입니다:

dist/stack/helm/db-service.yaml
[… omitted: the Service's apiVersion, kind and metadata — its name, db, and the labels and annotations every rendered document carries]
spec:
type: ExternalName
externalName: postgres.data.example.net
ports:
- port: 5432

StatefulSet도, 볼륨도, 컨테이너도 없습니다 — 서버의 수명 주기는 전적으로 이 배포 밖에 있습니다. 주소는 Release에서 옵니다:

db:
infra:
overrides:
host: postgres.data.example.net
dist/stack/helm/app-deployment.yaml
- name: DB_HOST
value: postgres.data.example.net

서버를 참조하는 것은 서버를 인수하는 것과 같지 않습니다. 이 Recipe는 계속 외부에서 소유하는 서버에 접근합니다. 여기의 어떤 것도 그 서버를 배포의 관리 아래로 가져오지 않으며, 여기의 어떤 것도 그 서버를 변경하지 않습니다.

주소를 빼면 빌드가 중단되고 그렇다고 알립니다. 참조되는 서버는 주소가 있거나 아무것도 없으므로, Recipe는 빈 이름의 별칭이 되는 Service를 내보내지 않고 거부합니다:

[… omitted: what resolving the lockfile prints, the same halt among it, then [CATALOG_ERROR E0033], the Recipe's assertion external_host_supplied, its template position and source, and "error calling fail:"]
assertion failed: the Manifest selects the referenced realization of
PostgreSQL, which addresses a server it does not provision, but no address was
supplied: set infra.overrides.host on this component in the Release to the DNS
name or IP literal the existing server answers on

핵심이 되는 비교

애플리케이션의 렌더링된 환경을 세 가지 모두 나란히 놓으면 다음과 같습니다.

변수자체 호스팅관리형외부
POOL_SIZE101010
DB_HOSTdb-default${module.db.address}postgres.data.example.net
DB_NAMEappdbappdbappdb
DB_PORT543254325432
DB_PROTOCOLpostgrespostgrespostgres
DB_USERappuserappuserappuser

매번 같은 변수, 같은 순서입니다. 그중 하나 뒤에 있는 문자열만 바뀝니다. 애플리케이션의 Recipe는 DB_ 변수 중 어느 것도 이름으로 지정하지 않습니다. uses 에지가 해석한 것을 그대로 내보낼 뿐이며, 그래서 하나의 Recipe가 세 데이터베이스 모두에 대해 변경 없이 렌더링됩니다.

그리고 컴파일러는 그 문자열들이 무엇인지 알지 못합니다. db-default는 Kubernetes Service 이름이고, ${module.db.address}는 Terraform 참조이며, postgres.data.example.net은 DNS 이름입니다. 하지만 컴파일러에게 이들은 Recipe가 키 host 아래에 게시하고 에지가 DB_HOST로 전달해 달라고 요청한 세 개의 문자열일 뿐입니다. 컴파일러는 그중 어느 것이 라우팅 가능한지, 포트가 숫자인지, db라는 컴포넌트가 데이터베이스인지 검사하지 않습니다. Component가 가진 레이블로 에지를 매칭하고, 계약이 선언하는 키를 읽고, 텍스트를 옮겼을 뿐입니다.

경계가 있는 곳

세 가지 배포는 각각 Ops 매핑으로 선택되었으며, 개발자 문서는 그 선택의 영향을 받지 않았습니다. 이것이 이 예제 전체가 구체적으로 보여 주려는 분리입니다:

  • 개발자는 애플리케이션이 데이터베이스에 무엇을 필요로 하는지를 말합니다.
  • Ops는 데이터베이스가 무엇으로 구성되는지를 정합니다 — 구현 방식마다 Recipe 하나씩;
  • 운영자는 이 배포가 어느 것을 받을지를 정하고, 그 규모를 정합니다.

내일 네 번째 구현 방식을 추가하더라도 — 다른 클라우드, 다른 운영자, 로컬 작업용 Compose 서비스 — 같은 키를 게시하는 Recipe 하나와 Manifest 한 줄이 더해질 뿐입니다. 이 디렉터리의 aggregate.yaml은 바뀌지 않습니다.