하나의 개발자 의도, 두 가지 자격 증명 전달 형태
자격 증명이 실행 중인 컨테이너에 도달하는 방식은 애플리케이션이 아니라 배포 위치의 속성입니다. 한 클러스터에는 시크릿 저장소가 없으므로 배포가 Kubernetes Secret에 자료 자체를 담아 전달합니다. 다른 클러스터는 시크릿 저장소 오퍼레이터를 실행하므로 배포는 포인터만 전달하고 클러스터가 조정(reconcile) 시점에 자료를 가져옵니다.
이 워크스페이스는 하나의 Aggregate를 담고 있으며 이를 두 개의 대상에 대해 빌드합니다. Aggregate는 두 대상 사이에서 바뀌지 않습니다. 데이터베이스가 자신의 비밀번호를 참조하는 방식도 바뀌지 않습니다. 바뀌는 것은 Manifest의 한 줄입니다.
바뀌는 것과 고정되는 것
| 파일 | local 대상 | store 대상 |
|---|---|---|
aggregate.yaml | 같은 파일 | 같은 파일 |
| Manifest | manifest-local.yaml | manifest-store.yaml |
| Release | release-local.yaml | release-store.yaml |
두 Manifests는 자신의 이름과 하나의 매핑 항목만 다릅니다.
$ diff manifest-local.yaml manifest-store.yaml7c7< name: credential-shape-local-manifest---> name: credential-shape-store-manifest16c16< core/referenced-secret:1.0.0: helm/k8s-secret-from-parameter:1.0.0---> core/referenced-secret:1.0.0: helm/k8s-external-secret:1.0.0두 Releases는 자신의 이름과 가리키는 Manifest만 다릅니다.
$ diff release-local.yaml release-store.yaml7c7< name: credential-shape-local---> name: credential-shape-store12c12< manifest: credential-shape-local-manifest---> manifest: credential-shape-store-manifest두 Releases는 같은 environment를 선언합니다. 이는 의도된 것입니다. 환경 이름은 렌더링된 모든 문서에 레이블로 찍히므로, 이를 고정하면 바뀔 수 있는 것은 정확히 하나, 즉 Manifest가 바인딩하는 FeatureRecipe만 남습니다. 실제 Releases 한 쌍이라면 물론 각자의 환경 이름을 붙이겠지만, 자격 증명 형태는 정확히 같은 방식으로 달라집니다.
개발자 측, 한 번만
aggregate.yaml은 PostgreSQL Component의 두 자격 증명 슬롯을 모두
같은 참조 가능한 자격 증명 Feature로 채웁니다.
features: password: type: core/referenced-secret values: key: POSTGRES_PASSWORD origin: postgres-superuser-password app_user_password: type: core/referenced-secret values: key: APP_USER_PASSWORD origin: postgres-app-passwordcore/referenced-secret은 시크릿 리소스, 즉 해당 FeatureRecipe의 출력이
생성하는 리소스나 이미 존재하는 리소스의 이름을 지정하고, 그 리소스의 위치 정보, 즉
name과 그 안의 데이터 key를 provides 계약을 통해 게시합니다.
소비하는 Recipe는 그 위치 정보를 읽습니다. 자체적으로 리소스 이름을 도출하지 않으며,
어떤 FeatureRecipe가 그것을 생성했는지 묻지도 않습니다.
각 대상이 내보내는 것
각 빌드는 여섯 개의 파일을 씁니다. 그중 네 개, 즉 StatefulSet, 두 Service, 초기화 ConfigMap은 두 대상에서 바이트 단위로 동일하게 나옵니다. 나머지 두 개는 채워진 슬롯마다 하나씩인 자격 증명 리소스이며, 대상 간 차이가 나타나는 곳입니다.
local 대상, k8s-secret-from-parameter에서 생성,
dist/helm/helm/db--password--db-secret-db-password.yaml 위치:
apiVersion: v1kind: Secretmetadata: name: db-password [… omitted: the labels and annotations naming the aggregate, component, environment, compiler and provider versions, boundary and Recipe — the same set every rendered document carries]stringData: POSTGRES_PASSWORD: "postgres-superuser-password"store 대상, k8s-external-secret에서 생성,
dist/helm/helm/db--password--db-externalsecret-db-password.yaml 위치:
apiVersion: external-secrets.io/v1kind: ExternalSecretmetadata: name: db-password [… omitted: the same label and annotation set as above]spec: refreshInterval: "1h" secretStoreRef: name: platform-secret-store kind: ClusterSecretStore target: name: db-password creationPolicy: Owner data: - secretKey: POSTGRES_PASSWORD remoteRef: key: "postgres-superuser-password"API 그룹도, kind도, 본문도 다릅니다. local 대상에서는
자격 증명 자료가 렌더링된 문서 안에 있어 배포를 읽을 수 있는 누구나
읽을 수 있습니다. 그래서 이 형태는 프로덕션 클러스터보다는 로컬 및 개발 클러스터에
적합합니다. store 대상에서 렌더링된 문서는 항목 이름만 담습니다.
자료는 저장소에 남고, 오퍼레이터가 이를 db-password라는 이름의 Secret으로 조정합니다.
두 출력 트리를 비교하면 차이가 무엇이고 어디서 끝나는지 알 수 있습니다
(local/과 store/를 생성하는 명령은 아래 빌드 절에 있습니다).
$ diff -r local storeOnly in store/helm/helm: db--app-zuuser-zupassword--db-externalsecret-db-app-user-password.yamlOnly in local/helm/helm: db--app-zuuser-zupassword--db-secret-db-app-user-password.yamlOnly in store/helm/helm: db--password--db-externalsecret-db-password.yamlOnly in local/helm/helm: db--password--db-secret-db-password.yaml네 줄이며 모두 한 디렉터리에 있습니다. 이 대상에서는 첨부(attachment)의 파일이
하위 디렉터리가 아니라 component 자체의 파일 옆에 놓이기 때문입니다. 두 좌표를 담는 것은
파일 이름입니다. db--password--는 db의 password 첨부이고,
db--app-zuuser-zupassword--는 app_user_password 첨부입니다.
여기서는 좌표와 파일 자체의 이름이 하나의 문자열을 공유하므로 밑줄이 -zu로
인코딩됩니다.
네 줄뿐이며 그 밖에는 없습니다. 두 자격 증명 리소스는 local
대상의 트리에만, 두 개는 store 대상의 트리에만 있습니다. diff -r은 두 트리가 공유하는
어떤 파일에서도 내용 차이를 보고하지 않으므로, 공통된 네 문서는 단지 비슷한 것이 아니라
동일합니다.
바뀌지 않는 참조
데이터베이스 컨테이너는 두 자격 증명을 secretKeyRef로 뒷받침되는
환경 변수로 읽습니다. 이 블록은 두 대상에서 바이트 단위로 동일합니다.
- name: POSTGRES_PASSWORD valueFrom: secretKeyRef: name: db-password key: POSTGRES_PASSWORD- name: APP_USER_PASSWORD valueFrom: secretKeyRef: name: db-app-user-password key: APP_USER_PASSWORD동일한 이유는 소비하는 Recipe가 분기하지 않기 때문입니다. 슬롯에
게시된 name과 key를 요청하고 그대로 씁니다. Feature가 두 키를 선언하므로
두 FeatureRecipes 모두 같은 두 키를 게시하고, 따라서 어느 쪽이든
소비자를 충족합니다. store 대상에서는 오퍼레이터가 ExternalSecret을 그 이름의
Secret으로 조정하면 참조가 해석됩니다.
이 불변성이 두 형태를 서로 대체 가능하게 만듭니다. 소비하는 쪽이 Secret 이름을 직접 도출했다면, 바인딩을 바꿨을 때 그 이름으로는 더 이상 존재하지 않는 리소스를 가리키게 되었을 것입니다.
origin의 의미는 FeatureRecipe가 정합니다
core/referenced-secret은 origin을 자료의 출처로 선언하고,
그 해석은 FeatureRecipe에 맡깁니다.
k8s-secret-from-parameter는 이를 자료로서 Secret에 씁니다.k8s-external-secret은 이를 저장소에서 가져올 키로 읽습니다.
컴파일러는 문자열을 변경 없이 전달하며, 주어진 문자열이 그중 어느 것인지에 구애받지 않습니다. 이 덕분에 개발자 측의 수정 없이 하나의 첨부가 두 형태 모두에 쓰일 수 있습니다. 또한 바인딩을 바꾸기 전에 확인해야 할 점이기도 합니다. 같은 작성 문자열이 그것을 읽는 FeatureRecipe가 무엇이든 의미가 있어야 하기 때문입니다.
게시된 이름과 슬롯 이름의 밑줄
Component는 두 번째 자격 증명 슬롯의 이름을 app_user_password로 지정합니다. Kubernetes
객체 이름에는 밑줄을 쓸 수 없으므로, 게시되는 provides.name은
밑줄을 하이픈으로 정규화하고 리소스는
db-app-user-password로 생성됩니다.
- name: APP_USER_PASSWORD valueFrom: secretKeyRef: name: db-app-user-password두 FeatureRecipes는 동일하게 정규화하므로 바인딩을 바꿔도 소비자의 참조는 바뀌지 않습니다. 이름은 생성하는 쪽에서 한 번 게시되며, 내보낸 리소스와 소비자의 참조는 모두 그 하나의 게시된 값에서 해석됩니다.
store 대상이 클러스터에 기대하는 것
ExternalSecret은 커스텀 리소스입니다. store 대상의 출력을
클러스터에 적용하려면 그곳에서 시크릿 저장소 오퍼레이터가 실행 중이어야 하고,
platform-secret-store라는 이름의 ClusterSecretStore가 존재해야 합니다. 이
워크스페이스의 어떤 것도 둘 중 어느 것도 설치하지 않습니다. 이 예제는 그러한 클러스터가 소비하는 것을 렌더링하고,
형태가 어떻게 선택되는지를 설명합니다.
클러스터가 어떤 저장소를 어떤 이름으로 실행하는지는 애플리케이션이 아니라
대상의 속성이므로, k8s-external-secret에는 이를 위한 작성 키가 없습니다.
저장소 이름이 다른 클러스터는 그 저장소를 지정하는 FeatureRecipe가
담당합니다.
예제 생성하기
아래 명령으로 이 예제를 빌드하거나, AI 어시스턴트에게 대신 빌드하게 할 수 있습니다.
예제 이름을 딴 새 폴더에 예제를 씁니다:
aggrega scaffold --example credential-shape-per-target그런 다음 이어서 실행할 명령을 출력합니다. 첫 번째 명령은 새 폴더로 이동합니다:
cd credential-shape-per-target빌드
aggrega build --release release-local.yaml --auto-pullaggrega build --release release-store.yaml --auto-pull--auto-pull은 첫 빌드에서 카탈로그를 Release 옆의 lockfile로
해석합니다. 같은 Release의 이후 빌드에는 플래그가 필요 없습니다.
두 대상 모두 dist/에 쓰고 aggrega build는 이를 비우지 않으므로,
두 결과를 비교하려면 각 실행의 출력을 따로 보관하십시오.
out=$(mktemp -d)rm -rf dist && aggrega build --release release-local.yaml --auto-pull && cp -r dist "$out/local"rm -rf dist && aggrega build --release release-store.yaml --auto-pull && cp -r dist "$out/store"( cd "$out" && diff -r local store )각 대상이 결정적으로 렌더링되는지 확인하려면 --verify-determinism을 추가하십시오.
모든 노드가 두 번 렌더링되며, 어느 노드든 두 렌더링 결과가 다르면 빌드가
중단됩니다.
aggrega build --release release-local.yaml --verify-determinismaggrega build --release release-store.yaml --verify-determinismAI 어시스턴트 사용
Aggrega 도구로 설정한 AI 어시스턴트도 같은 작업을 할 수 있습니다. 다음 프롬프트를 붙여 넣으십시오.
Aggrega 도구만 사용하고, 폴더는 직접 만들지 마십시오. 작업 영역 폴더에 아직 `credential-shape-per-target` 폴더가 없으면 `example`을 `credential-shape-per-target`으로 설정하고 `dir`은 지정하지 않은 채 `scaffold` 도구를 한 번 호출하십시오. 이 도구는 예제를 새 `credential-shape-per-target` 폴더에 씁니다. 그런 다음 각 Release마다 `build` 도구를 `release-local.yaml`, `release-store.yaml` 순서로 한 번씩 호출하십시오. 매번 `workspace_root`를 `credential-shape-per-target`으로, `release`를 해당 파일로, `auto_pull`을 true로, `write`를 true로 설정합니다. 각 빌드가 쓴 파일을 알려 주십시오. 파일은 `credential-shape-per-target/dist/` 아래에 있습니다.파일
aggregate.yaml— 개발자 의도:core/datastore/postgres유형의dbcomponent 하나이며, 두 자격 증명 슬롯이 모두core/referenced-secret으로 채워져 있습니다. 두 Releases가 변경 없이 사용합니다.manifest-local.yaml—core/referenced-secret을k8s-secret-from-parameter에 바인딩하며, 이는 작성된 자료로부터 Kubernetes Secret을 렌더링합니다.manifest-store.yaml— 같은 Feature를k8s-external-secret에 바인딩하며, 이는 저장소 항목을 지정하는 ExternalSecret을 렌더링합니다. 자신의 이름과 그 한 줄을 제외하면manifest-local.yaml과 동일합니다.release-local.yaml,release-store.yaml— 두 Releases입니다. 자신의 이름과 각자가 가리키는 Manifest를 제외하면 동일합니다..aggrega-config.yaml— 카탈로그 엔터티를 해석해 오는 허브 레지스트리를 지정합니다.
여기의 origin 값은 자리 표시자입니다. 실제 서비스의 자격 증명이 아니며,
local 대상에서는 둘 다 출력에 평문으로 렌더링됩니다.