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

Terraform 자체의 `sensitive`로 렌더링되는 선언된 민감성

값이 비밀 자료를 담고 있다는 선언은 Component의 스키마에서 한 번만 작성합니다. 렌더링 대상이 그에 맞는 자체 기본 요소를 제공하는 경우, 그 선언은 해당 요소로 렌더링됩니다. 이 예제는 Terraform의 경우입니다. 빌드는 선언된 값이 흘러 들어가는 모듈 입력에 sensitive = true를 추가하는 override 파일을 덧붙이고, 엔진은 그 값을 표시하게 될 모든 곳에서 해당 값을 가립니다.

이 예제는 의도적으로 작게 만들어졌으며 모든 부분을 직접 살펴볼 수 있습니다. 하나의 컴포넌트, 세 개의 모듈 입력, 그리고 그중 정확히 하나만을 지정하는 렌더링된 표시가 있습니다.

빌드가 생성하는 것

dist/infra/terraform/ 아래에는 경계의 루트 구성이 있습니다.

  • aggrega.modules.tf — store를 module 블록으로 선언하며, 이 블록의 source는 ./modules/store이고 인수는 모듈의 해석된 입력 변수이며 결정적인 키 순서를 따릅니다. 모든 terraform 경계에 하나씩 생성됩니다.

dist/infra/terraform/modules/store/ 아래에는 store 컴포넌트 자체의 파일이 있습니다.

  • 바이트 단위로 그대로 복사된 모듈 파일 — variables.tf와 main.tf로, 모듈 작성자가 작성한 그대로입니다.
  • aggrega_override.tf.json — 아래에서 설명하는 민감성 표시입니다. Terraform은 override를 자신이 위치한 디렉터리의 구성에 병합하므로 이 파일은 모듈 자체의 파일 옆에 위치합니다.
  • aggrega.provenance.tf — 빌드를 식별하는 # 주석 파일입니다(JSON 파일에는 주석을 넣을 수 없으므로 출처 정보는 별도 파일에 담깁니다).

표시, 그리고 표시가 지정하지 않는 두 입력

example/storage/external-object-store는 세 개의 values 리프를 선언합니다. 두 개는 공개 식별자를 담고, 하나는 자격 증명을 담으며 sensitive: true를 선언합니다.

values:
bucket: { type: string, required: true }
access_key_id: { type: string, required: true }
secret_access_key: { type: string, required: true, sensitive: true }

module 블록은 세 모듈 입력을 모두 바인딩합니다.

module "store" {
source = "./modules/store"
access_key_id = "AKIAEXAMPLE0001"
bucket = "app-artifacts"
secret_access_key = "example-placeholder-not-a-real-credential"
}

그리고 덧붙여진 override는 정확히 하나만 지정합니다.

{
"variable": {
"secret_access_key": {
"sensitive": true
}
}
}

Terraform은 이름이 override이거나 _override로 끝나는 파일을 같은 디렉터리의 구성에 병합합니다. 따라서 이 파일은 모듈의 기존 secret_access_key 선언에 속성을 추가하고, 타입, 설명, 기본값은 모듈이 작성한 그대로 둡니다. 벤더링된 모든 바이트는 작성된 그대로 유지됩니다.

override가 지정하지 않는 두 입력이 이 예제의 핵심입니다. 표시는 선언만을 따르며 다른 어떤 것도 따르지 않습니다. 변수의 이름도, 값의 형태도 따르지 않습니다. access_key_id는 자격 증명 자료가 아니라 자격 증명 식별자이므로, 비밀 옆에 있고 이름이 비밀처럼 보이더라도 민감하다고 선언되지 않으며 표시되지도 않습니다. 그 한 리프에서 sensitive: true를 제거하고 다시 빌드하면 override 파일은 아예 생성되지 않습니다.

동작 확인하기

main.tf는 공개 좌표와 자격 증명을 한 리소스의 별도 속성에 두므로, plan 하나로 두 방향을 동시에 볼 수 있습니다. 경계의 루트 구성, 즉 이 배포의 값이 있는 aggrega.modules.tf를 담은 디렉터리에서 plan을 실행합니다.

Terminal window
cd dist/infra/terraform
tofu init && tofu plan # or: terraform init && terraform plan
# module.store.terraform_data.reference will be created
+ resource "terraform_data" "reference" {
[… omitted: an id attribute, reported as known only after apply]
+ input = (sensitive value)
[… omitted: an output attribute, reported as known only after apply]
+ triggers_replace = [
+ "app-artifacts",
+ "AKIAEXAMPLE0001",
]
}

직접 실행한 plan에는 표시된 줄 사이에 그 두 속성이 들어 있습니다. 이들은 누락된 것이 아니라 생략된 것으로 표시되어 있으므로, 설명할 수 없는 줄은 이 페이지가 빠뜨린 것이 아니라 실제 차이입니다.

자격 증명은 가려지고, 그 옆의 두 공개 값은 가려지지 않습니다. aggrega_override.tf.json을 삭제하고 plan을 다시 실행하면 자격 증명이 그대로 출력됩니다. 그 차이가 표시가 하는 일의 전부입니다. 표시는 모듈 자체의 variable 블록에 있으므로 모듈과 함께 이동하며 그 모듈이 사용되는 모든 곳에 적용됩니다.

modules/store/ 안이 아니라 루트에서 실행하십시오. 컴포넌트의 입력은 한 단계 위에 있는 module 블록의 인수이므로, 컴포넌트 자체의 디렉터리는 배포된 상태로 plan할 수 있는 구성이 아닙니다. 그곳에서 엔진이 하는 동작은 모듈 자체의 variable 블록에 따라 달라지며, 두 결과 중 하나만 눈에 띕니다.

  • 이 모듈은 세 입력을 모두 default 없이 선언하므로 modules/store/에서의 plan은 실패합니다. 입력마다 한 번씩 No value for required variable이 출력되며, 각각 해당 줄을 지정하고 -var / -var-file 해결 방법을 제시합니다.
  • 반대로 입력이 모두 기본값을 가진 모듈은 그곳에서 루트 구성이 제공하는 값이 아니라 그 기본값으로 plan이 성공합니다. 아무런 경고도 없습니다. 바로 이 경우를 알아 두어야 합니다. 올바르게 보이는 plan이 아무도 요청하지 않은 구성을 설명하고 있기 때문입니다.

표시가 하지 않는 일

sensitive는 표시를 제어합니다. 값이 plan 및 apply 출력에 인쇄되지 않도록 하고, Terraform이 그 값을 민감하다고 표시되지 않은 출력에 넣지 못하게 합니다. 값을 암호화하지 않으며 값이 저장되는 방식도 바꾸지 않습니다. apply 후 값은 state에 평문으로 존재합니다. 표시가 무엇이든 state에 자격 증명이 담겨 있다고 간주하십시오.

또한 표시는 입력의 정체성이 선언에서 비롯될 때에만 렌더링된 입력에 도달합니다. 이 Recipe는 source:를 선언하고 valuesMapping:은 선언하지 않으므로, 인수 이름은 Component가 선언한 값 리프 경로이며 결합이 정확합니다. valuesMapping:을 선언하는 Recipe는 어떤 선언도 지정하지 않는 템플릿 안에서 출력 이름을 만들어 내므로, 그런 Recipe는 같은 값을 표시 없이 렌더링합니다. override 파일은 근사되는 것이 아니라 생성되지 않습니다. 어떤 선언도 도달하지 않는 이름을 표시하면 공개 입력에 대해 사실이 아닌 주장을 하게 되고, 엔진 자체의 도구가 한 번도 비밀이 아니었던 값을 숨기게 됩니다.

여기서 자격 증명이 모듈 입력인 이유

관리형 클라우드 데이터베이스는 보통 반대의 경우입니다. 프로바이더가 마스터 암호를 직접 생성하고 교체하므로 모듈에는 자격 증명 입력이 필요 없고 표시할 것도 없습니다. 이 버킷은 배포 외부에서 운영되므로 위임할 그런 프로바이더가 없습니다. 배포가 액세스 키를 보유하고 이를 전달해야 합니다. 이것이 이 모듈은 자격 증명 변수를 선언하고 표준 라이브러리의 관리형 데이터베이스 모듈은 선언하지 않는 이유입니다.

모듈은 그 변수를 Terraform의 sensitive 속성 없이 선언하며, 이것이 예제를 이해하기 쉽게 만듭니다. 독자가 렌더링 시점에 적용된 것으로 보는 속성은 모듈이 아니라 Component의 선언에서 온 것입니다.

파일

  • aggregate.yaml — 개발자 의도: example/storage/external-object-store 타입의 store 컴포넌트 하나로, 버킷 이름을 직접 지정하고 액세스 키의 두 부분을 모두 타입이 지정된 parameters로 노출합니다.
  • release.yaml — 이 환경에 대해 해당 파라미터를 채우고 운영자의 endpoint를 설정합니다. 여기의 값은 자리 표시자이며 실제 서비스의 자격 증명이 아닙니다.
  • manifest.yaml — 컴포넌트 타입을 모듈을 로컬에서 가져오는 Terraform Recipe terraform/external-object-store에 바인딩합니다.
  • .aggrega-config.yaml — 카탈로그 엔터티를 해석해 오는 허브 레지스트리를 지정합니다.

두 자격 증명 부분은 운영자가 제공하며 환경마다 달라지는 값이므로 작성된 값이 아니라 parameters입니다. Release는 values:를 선언할 수 없으므로, 타입이 지정된 파라미터가 바로 이를 위한 표면입니다. 개발자는 변화 지점을 선언하고 Release가 이를 채웁니다.

예제 생성하기

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

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

Terminal window
aggrega scaffold --example terraform-declared-sensitivity

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

Terminal window
cd terraform-declared-sensitivity

빌드

Terminal window
aggrega build --release release.yaml --auto-pull

--auto-pull은 새로 클론한 저장소에 없는 lockfile을 빌드 중에 기록합니다.

AI 어시스턴트 사용

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

Aggrega 도구만 사용하고, 폴더를 직접 만들지 마십시오. 작업 영역 폴더에 아직 `terraform-declared-sensitivity` 폴더가 없으면 `example`을 `terraform-declared-sensitivity` 값으로 설정하고 `dir` 없이 `scaffold` 도구를 한 번 호출하십시오. 그러면 새 `terraform-declared-sensitivity` 폴더에 예제가 작성됩니다. 그런 다음 `workspace_root`를 `terraform-declared-sensitivity` 값으로, `release`를 `release.yaml` 값으로, `auto_pull`을 true로, `write`를 true로 설정하여 `build` 도구를 호출하십시오. 빌드가 작성한 파일을 알려 주십시오. 파일은 `terraform-declared-sensitivity/dist/` 아래에 있습니다.