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

Aggrega Entity Lock 스키마

자동 생성된 레퍼런스입니다. 직접 편집하지 말고 게시된 JSON Schema에서 다시 생성하십시오.

스키마 id: https://aggrega.ai/schemas/entity-lock-v1beta1.schema.json

entity.lock 파일은 엔터티 옆에 위치하며, 해당 엔터티가 자신의 문서 밖에서 참조하는 입력의 콘텐츠 고정값(pin)을 기록합니다. 대상은 아티팩트가 가져오는 파일, 로컬 소스의 파일, 그리고 엔터티가 식별 정보를 완전히 기술하는 원격 소스이며, 디렉터리인 로컬 소스의 경우 그 파일 중 어느 것이 엔터티에 속하는지를 결정한 규칙도 기록합니다. 이 파일은 하나의 단계가 작성합니다. 바로 aggrega pin으로, 엔터티 작성자가 실행하며 Release가 필요하지 않습니다. aggrega pull과 aggrega push도 요청을 받으면 같은 단계를 실행하여 같은 바이트를 작성합니다. 요청은 --pin-sources로 하거나 워크스페이스의 pin_sources_at_pull 또는 pin_sources_at_push로 합니다. 고정을 요청받지 않은 pull은 여기에 아무것도 쓰지 않습니다. 워크스페이스 자체 카탈로그 디렉터리에 있는 엔터티에 대해서는 해당 단계가 기록할 내용과 파일에 있는 내용을 비교하고, 고정값이 없거나 더 이상 입력과 일치하지 않으면 aggrega pin을 지목하며 중단합니다. 로컬 소스의 경우 고정 이후 추가, 변경 또는 제거된 파일은 다른 오래된 고정값과 마찬가지로 pull을 중단시킵니다. aggrega build는 이 파일을 다시 읽고, 디스크에 있는 내용의 다이제스트가 기록된 값과 더 이상 일치하지 않으면 중단합니다. 이 파일의 범위는 그것이 위치한 디렉터리로 정해집니다. 즉 해당 디렉터리에 있는 엔터티의 입력을 고정합니다. 따라서 종류마다 고유한 파일 이름을 두지 않고 하나의 파일 이름이 모든 종류에 쓰입니다. 이 단계는 그러한 입력을 읽지 않는 엔터티의 lock을 빈 파일로 남기지 않고 제거합니다. 엔터티 문서 자체는 결코 기계가 작성하지 않습니다. 작성자가 입력한 내용은 입력한 그대로 유지되고, 기계가 도출한 내용은 여기에 있습니다. 이러한 분리 덕분에 lock은 안전하게 커밋할 수 있고 diff로 읽을 수 있습니다. 각 행이 하나의 입력을 지목하고, 바뀐 다이제스트가 바뀐 입력을 지목하기 때문입니다. 이 파일에는 타임스탬프도 해석 메타데이터도 없으므로, 변경되지 않은 입력에 대해 단계를 다시 실행하면 파일이 바이트 단위로 동일하게 유지됩니다. 고정값을 기록할 수 있는 모든 종류에 하나의 행 형태가 쓰이므로, 고정값은 어느 종류에 속하든 동일하게 읽힙니다. 와이어 형태는 닫혀 있습니다(additionalProperties: false). 스키마 발전 원칙: 새로운 선택적 필드를 추가하는 것은 SemVer-MINOR(추가적 변경)이며, 필드를 제거하거나 제약을 강화하는 것은 SemVer-MAJOR입니다.

최상위 타입: object

속성

속성타입필수설명
versionconst 1예엔티티 잠금 스키마 버전: 1. 스키마의 SemVer-MAJOR 변경이 이 값을 증가시킵니다. 상수: 1
sourceDigestsobject[]아니요이 엔티티가 참조하며 그 식별 정보를 엔티티가 전부 기술하는 원격 소스의 콘텐츠 고정값으로, 해석 시 가져온 바이트로부터 고정되고 빌드 시 다시 읽어 캐시된 소스가 달라지지 않았는지 검증합니다. 각 항목은 해석된 소스 식별 정보 {kind, url, chart, moduleSubdir, version}과 콘텐츠 다이제스트(그리고 OCI로 배포되는 소스의 경우 매니페스트 다이제스트)를 그대로 담습니다. 식별 정보가 템플릿으로 채워지는 소스(예: Release의 인프라 값에서 읽는 버전)는 여기에 항목을 두지 않습니다. 그 소스가 가리키는 아티팩트는 엔티티를 사용하는 각 Release가 결정하므로, 해석되는 각 식별 정보는 대신 해당 Release의 잠금 파일에 고정됩니다. 로컬(파일 시스템 상대) 소스도 여기에 항목을 두지 않습니다. 가져오는 대상이 아니라 경로를 가리키므로 고정할 획득 아카이브가 없으며, 대신 그 파일들이 localSourceDigests에 하나씩 고정됩니다.
artifactDigestsobject[]아니요이 엔티티의 아티팩트가 $import로 가져오는 파일(Recipe의 경우 boundary.artifacts 항목이 가져오는 파일 포함)의 콘텐츠 고정값으로, 해석 시 고정되고 빌드 시 다시 읽어 가져온 파일이 달라지지 않았는지 검증합니다. 값이 파일 가져오기인 아티팩트마다 항목이 하나씩 있습니다. 인라인(리터럴) 아티팩트는 이미 엔티티의 일부이므로 별도 고정값이 없으며, 라이브러리에서 가져온 아티팩트는 그 라이브러리가 해석된 버전으로 고정됩니다. 빌드는 어느 블록의 항목이든 같은 방식으로 고정값과 비교하며, 같은 조건에서 더 이상 일치하지 않는 파일을 거부합니다.
localSourceDigestsobject[]아니요이 엔티티의 로컬 소스(가져오는 대신 엔티티 옆의 경로로 작성된 소스) 파일의 콘텐츠 고정값으로, 엔티티를 고정할 때 기록되고 빌드 시 다시 읽어 파일이 달라지지 않았는지 검증합니다. 소스가 엔티티의 게시물에 포함시키는 파일마다 항목이 하나씩 있습니다. 즉 소스가 가리키는 디렉터리 아래에서 ignore에 기록된 규칙이 유지하는 모든 파일, 또는 소스가 가리키는 단일 파일입니다. 템플릿으로 작성된 로컬 소스는 Release가 템플릿을 채운 뒤에야 디렉터리를 가리키므로, 기록된 규칙이 유지하는 엔티티 자체 디렉터리의 모든 파일을 포함하며 그 각각이 고정됩니다. 엔티티 문서, 그 옆에 있는 작성자의 .aggregaignore, 그리고 이 파일은 항목이 되지 않습니다. 문서는 엔티티 자체이고, ignore 파일의 규칙은 ignore 아래에 기록되며, 잠금 파일은 자기 자신의 다이제스트를 기록할 수 없기 때문입니다. 잠금 파일이 여기에 항목을 하나라도 기록하면, 빌드는 항목이 없는 파일을 담은 소스, 콘텐츠의 다이제스트가 더 이상 항목과 일치하지 않는 파일을 담은 소스, 또는 항목이 가리키는 파일이 없는 소스를 거부합니다.
ignoreobject아니요이 엔티티의 로컬 소스 디렉터리 아래 어떤 파일이 엔티티에 속하는지 결정하는 규칙으로, 엔티티를 고정할 때 기록됩니다. 이후 그 디렉터리를 읽는 모든 작업은 이 규칙만을 적용합니다. 엔티티의 게시, pull이나 게시가 잠금 파일과 대조하는 비교, 작성자의 엔티티 행, 빌드의 비교와 렌더링, 그리고 검증 pull이 이에 해당합니다. 따라서 작성자의 .aggregaignore, 워크스페이스의 provider 바인딩, aggrega 바이너리가 바뀌어도 엔티티를 다시 고정하기 전까지는 어떤 다이제스트도 바뀌지 않으며, 다시 고정하면 그 변경이 여기에 diff로 나타납니다. 엔티티가 디렉터리인 로컬 소스나 템플릿으로 작성된 로컬 소스를 선언한 경우에만 존재합니다. 규칙을 기록하지 않은 잠금 파일은 그 디렉터리 아래의 모든 파일을 유지합니다. 그 아래 어디에 있든 심볼릭 링크는 따라가지 않고 거부됩니다.

추가 속성은 허용되지 않습니다.

entity-lock.sourceDigests[]

속성타입필수설명
kindenum예해석된 소스 종류입니다. 닫힌 집합 중 하나로, 잠금 파일의 소스 아티팩트 kind와 캐시 메타데이터의 kind가 갖는 것과 같은 집합입니다. 세 곳 모두 같은 해석된 소스 식별 정보를 기록하며, 빌드는 이 종류를 읽어 로더를 선택하기 때문입니다. terraform-module-oci는 이 집합에 속하지만 이를 처리하는 소스 어댑터는 없습니다. 이를 지정하는 Recipe나 FeatureRecipe는 읽는 시점에 거부됩니다. 허용되는 값: "helm-oci-chart", "helm-https-chart", "compose-https-fragment", "git-repository", "terraform-module-oci"
urlstring예다이제스트가 고정하는 작성된 소스 URL로, spec.source.url에 작성된 그대로의 식별 URL(저장소 루트 또는 helm-https-chart의 경우 직접 .tgz)입니다. 빌드는 오프라인에서 이 URL을 그대로 재구성하므로, 이는 해석된 아티팩트 위치가 아니라 고정값의 키가 되는 안정적인 식별 정보입니다.
chartstring아니요저장소 루트 helm 소스의 차트 이름(spec.source.chart)으로, 해석된 소스 식별 정보의 일부이므로 하나의 저장소 루트에서 같은 버전으로 제공되는 두 차트가 별도로 고정됩니다. 직접 .tgz, OCI, compose, git 소스에는 없으며, 이들은 모두 URL 안에서 차트를 선택하지 않습니다.
moduleSubdirstring아니요git 소스 저장소 안에서 아티팩트가 되는 디렉터리(spec.source.module_subdir)로, 해석된 소스 식별 정보의 일부이므로 하나의 저장소에서 같은 커밋의 두 디렉터리가 별도로 고정됩니다. 저장소 전체가 아티팩트인 경우와, 클론 안으로 내려가는 대신 URL로 아티팩트에 도달하는 모든 종류에는 없습니다.
versionstring예소스가 해석된 구체적인 고정 버전으로, helm-* 종류에서는 차트 버전, git-repository에서는 참조가 해석된 커밋입니다. 빌드가 소스를 다시 읽어 오는 캐시 슬롯을 구성하므로 단일 경로 세그먼트로 기록되며, /, \, ..를 포함하지 않습니다. 패턴: ^([^/\\.]|\.[^/\\.])*\.?$.
digeststring예가져온 소스 아카이브의 콘텐츠 다이제스트로, sha256: 뒤에 소문자 16진수 64자가 오는 형식이며 빌드 시 캐시된 바이트와 대조하여 검증됩니다. 패턴: ^sha256:[a-f0-9]{64}$.
manifestDigeststring아니요OCI로 배포되는 소스의 OCI 매니페스트 다이제스트로, 독립적인 신뢰 루트이며 sha256: 뒤에 소문자 16진수 64자가 오는 형식입니다. OCI 소스(helm-oci-chart)에만 존재하며, 구조상 매니페스트가 없는 https 또는 git 소스에는 없습니다. 패턴: ^sha256:[a-f0-9]{64}$.

추가 속성은 허용되지 않습니다.

entity-lock.artifactDigests[]

속성타입필수설명
namestring예이 항목이 어떤 아티팩트의 $import 파일을 고정하는지 나타냅니다. artifacts 항목이면 artifacts: 맵 키이고, Recipe의 boundary.artifacts 항목이면 boundary/ 뒤에 키가 붙습니다. 따라서 각 블록에서 같은 키로 작성된 항목은 별도로 고정됩니다.
digeststring예가져온 파일 바이트의 콘텐츠 다이제스트로, sha256: 뒤에 소문자 16진수 64자가 오는 형식이며 빌드 시 검증됩니다. 패턴: ^sha256:[a-f0-9]{64}$.

추가 속성은 허용되지 않습니다.

entity-lock.localSourceDigests[]

속성타입필수설명
pathstring예엔티티 문서가 있는 디렉터리를 기준으로 한 파일의 상대 경로로, 슬래시(/)로 작성합니다. 예: charts/app/templates/deployment.yaml.
digeststring예파일 바이트의 콘텐츠 다이제스트로, sha256: 뒤에 소문자 16진수 64자가 오는 형식이며 빌드 시 검증됩니다. 패턴: ^sha256:[a-f0-9]{64}$.

추가 속성은 허용되지 않습니다.

entity-lock.ignore

이 엔티티의 로컬 소스 디렉터리 아래 어떤 파일이 엔티티에 속하는지 결정하는 규칙으로, 엔티티를 고정할 때 기록됩니다. 이후 그 디렉터리를 읽는 모든 작업은 이 규칙만을 적용합니다. 엔티티의 게시, pull이나 게시가 잠금 파일과 대조하는 비교, 작성자의 엔티티 행, 빌드의 비교와 렌더링, 그리고 검증 pull이 이에 해당합니다. 따라서 작성자의 .aggregaignore, 워크스페이스의 provider 바인딩, aggrega 바이너리가 바뀌어도 엔티티를 다시 고정하기 전까지는 어떤 다이제스트도 바뀌지 않으며, 다시 고정하면 그 변경이 여기에 diff로 나타납니다. 엔티티가 디렉터리인 로컬 소스나 템플릿으로 작성된 로컬 소스를 선언한 경우에만 존재합니다. 규칙을 기록하지 않은 잠금 파일은 그 디렉터리 아래의 모든 파일을 유지합니다. 그 아래 어디에 있든 심볼릭 링크는 따라가지 않고 거부됩니다.

속성타입필수설명
pluginobject아니요엔터티가 고정될 때 작성자의 워크스페이스에서 해당 엔터티의 기능을 제공한 플러그인(그 기능에 대한 워크스페이스의 provider 바인딩, 또는 그것이 없으면 aggrega 바이너리에 내장된 플러그인)을 버전 없이 명명한 것과 그 플러그인이 선언한 ignore 규칙입니다. 플러그인의 버전과 다이제스트는 기록되지 않습니다. 모든 읽기에서 적용되는 것은 규칙이므로, 같은 플러그인의 다른 릴리스로 다시 고정해도 규칙이 바뀌지 않는 한 잠금은 변하지 않습니다. 해당 기능에 대한 자체 플러그인이 다른 규칙을 선언하는 pull은 두 플러그인과 그 차이를 명시하는 권고로 이를 알리며, 이 때문에 중단되지는 않습니다. 기능을 제공한 플러그인이 없으면 존재하지 않습니다.
rulesobject[]아니요적용되는 순서대로 정확하게 구성된 규칙입니다. 먼저 플러그인의 패턴, 다음으로 플러그인이 지정하고 탐색 중에 발견된 모든 ignore 파일의 줄(한 디렉터리 자체의 파일이 그 아래 파일보다 먼저), 마지막으로 엔터티 옆에 있는 작성자의 .aggregaignore의 줄입니다. 나중의 일치가 이전의 일치를 재정의하므로, 작성자의 파일이 자신이 지정하는 모든 경로에 대해 최종 결정권을 가지며, !로 시작하는 줄은 이전 규칙이 제외한 것을 다시 포함합니다. 규칙이 제외한 디렉터리에는 들어가지 않으므로, 그 아래의 파일은 해당 디렉터리가 다시 포함된 경우에만 다시 포함됩니다.

추가 속성은 허용되지 않습니다.

entity-lock.ignore.plugin

엔터티가 고정될 때 작성자의 워크스페이스에서 해당 엔터티의 기능을 제공한 플러그인(그 기능에 대한 워크스페이스의 provider 바인딩, 또는 그것이 없으면 aggrega 바이너리에 내장된 플러그인)을 버전 없이 명명한 것과 그 플러그인이 선언한 ignore 규칙입니다. 플러그인의 버전과 다이제스트는 기록되지 않습니다. 모든 읽기에서 적용되는 것은 규칙이므로, 같은 플러그인의 다른 릴리스로 다시 고정해도 규칙이 바뀌지 않는 한 잠금은 변하지 않습니다. 해당 기능에 대한 자체 플러그인이 다른 규칙을 선언하는 pull은 두 플러그인과 그 차이를 명시하는 권고로 이를 알리며, 이 때문에 중단되지는 않습니다. 기능을 제공한 플러그인이 없으면 존재하지 않습니다.

속성타입필수설명
namestring예엔터티가 고정될 때 그 기능을 제공한 플러그인으로, 버전 없이 <pluginType>/<name> 형태로 기록됩니다. 읽기에서 적용되는 것은 아래 규칙이며, 이 이름은 그 규칙이 누구의 것이었는지 알려 줍니다. 최소 1자 이상입니다.
patternsstring[]아니요플러그인이 선언한 ignore 패턴으로, 선언된 그대로입니다.
filesstring[]아니요플러그인이 선언한, 해당 생태계가 소스 내부에서 따르는 ignore 파일의 이름입니다.

추가 속성은 허용되지 않습니다.

entity-lock.ignore.rules[]
속성타입필수설명
patternstring예gitignore 구문으로 작성된 ignore 패턴 하나입니다.
withinstring예패턴의 범위가 되는 디렉터리로, 엔터티 문서가 있는 디렉터리를 기준으로 한 상대 경로이며 슬래시(/)로 작성합니다. .은 그 디렉터리 자체를 가리킵니다. 플러그인이 선언한 패턴은 로컬 소스 디렉터리를, ignore 파일의 줄은 그 파일이 있는 디렉터리를, 작성자의 .aggregaignore의 줄은 엔터티의 디렉터리를 범위로 합니다.
fromstring예패턴이 선언된 위치입니다. 플러그인이 선언한 패턴이면 plugin이고, 그렇지 않으면 패턴을 읽어 온 ignore 파일의 경로로, 엔터티 문서가 있는 디렉터리를 기준으로 한 상대 경로입니다.

추가 속성은 허용되지 않습니다.