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

Aggrega Release 스키마

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

스키마 ID: https://aggrega.ai/schemas/release-v1beta1.schema.json

Release 엔터티 작성에 관한 설명은 Release 작성 레퍼런스를 참조하십시오. 이 페이지는 해당 레퍼런스가 설명하는 구조적 스키마를 문서화합니다.

최상위 타입: object

속성

속성타입필수설명
apiVersionconst “aggrega.ai/v1beta1”예상수: "aggrega.ai/v1beta1"
kindconst “Release”예상수: "Release"
metadataobject예
specobject예Release가 바인딩하고 라우팅하는 대상: Release가 배포하는 Aggregate와 Manifest(또는 extends 기반), 환경별 파라미터 충족, 그리고 그 컴포넌트가 라우팅되어 들어가는 경계입니다.

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

release.metadata

속성타입필수설명
namestring예최소 1자 이상이어야 합니다.
environmentstring예
versionstring예release의 엄격한 Semantic Versioning 버전입니다(예: 1.0.0). 패턴: ^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$.
descriptionstring아니요이 엔티티가 무엇이며 무엇을 위한 것인지를, 사용 여부를 결정하려는 사람을 위해 작성합니다. 대상을 지칭하는 문장으로 시작한 뒤, 독자가 이를 선택하고 올바르게 사용하는 데 필요한 내용, 즉 배포 대상 플랫폼에 무엇을 기대하는지와 동작 방식에서 예상하기 어려운 점을 덧붙입니다. 보통 짧은 문단 하나 정도의 분량입니다.
maintainersobject[]아니요이 엔티티를 소유하는 메인테이너 목록입니다.
licensestring아니요이 엔티티가 기술하는 소프트웨어의 라이선스를 나타내는 SPDX 식별자로, MIT 또는 AGPL-3.0 등이 있습니다. 이 파일의 조건이 아니라 해당 소프트웨어의 조건을 기록합니다.
repositorystring아니요소스 파일이 있는 Git 저장소의 URL입니다.
homestring아니요이 엔티티의 홈페이지, 위키 또는 문서의 URL입니다.
keywordsstring[]아니요UI에서 쉽게 찾을 수 있도록 하는 설명 키워드 목록입니다.

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

release.metadata.maintainers[]
속성타입필수설명
namestring예
emailstring아니요
urlstring아니요

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

release.spec

Release가 바인딩하고 라우팅하는 대상: Release가 배포하는 Aggregate와 Manifest(또는 extends 기반), 환경별 파라미터 충족, 그리고 그 컴포넌트가 라우팅되어 들어가는 경계입니다.

속성타입필수설명
aggregatestring아니요이 release가 배포하는 Aggregate(Developer Intent)에 대한 참조입니다. 단순 토큰은 식별자로 해석됩니다. 즉 참조되는 Aggregate의 metadata.name으로, Release 자신의 디렉터리에서 먼저 찾고 그다음 카탈로그에서 찾습니다. ’./’ 또는 ’../‘로 시작하는 값은 Release를 기준으로 한 상대 경로로 해석되는 명시적 로컬 파일입니다(예: 하위 디렉터리의 release 변형들이 하나의 Aggregate를 공유하기 위한 ’../shared/app.yaml’).
manifeststring아니요이 release가 배포 기준으로 삼는 추상 인터페이스를 해석하는 Manifest에 대한 참조입니다. 단순 토큰은 식별자로 해석됩니다. 즉 참조되는 Manifest의 metadata.name으로, Release 자신의 디렉터리에서 찾습니다. ’./’ 또는 ’../‘로 시작하는 값은 Release를 기준으로 한 상대 경로로 해석되는 명시적 로컬 파일입니다. Manifest는 배포 측 엔터티이며 카탈로그에 색인되지 않으므로, Release 디렉터리 또는 명시적 경로에서만 해석됩니다.
extendsstring아니요이 Release가 작성 표면을 상속하는 기반 Release에 대한 참조입니다. 상속되는 것은 경계 트리와 그 아래의 컴포넌트별 infra 및 Feature 연결, 파라미터, 어노테이션, Manifest 포인터입니다. 값은 이 Release 옆에 있는 파일의 경로이며 ’./’ 또는 ’../‘로 시작해야 합니다. Release는 배포 측 엔터티이며 카탈로그에 색인되지 않으므로, 단순 이름과 레지스트리 좌표는 모두 거부됩니다. 상속된 내용은 키 단위로 교체할 수 있으며, 첫 번째 분할 불가능한 값(스칼라, 리스트, 템플릿)까지 내려가 그 값은 통째로 교체됩니다. null로 작성된 키는 상속된 내용을 제거합니다. metadata 필드는 전달되지 않으므로 자식은 자체 이름, 버전, 환경을 가집니다. ‘extends’와 함께 ‘aggregate’를 선언하면 이 스키마가 거부하므로, 자식은 기반과 동일한 Developer Intent를 배포합니다. ‘manifest’는 선택 사항으로 남으며 의존성 잠금 파일을 바꾸기 위해 재정의할 수 있습니다.
parametersobject아니요내용 형태에 따른 분기를 통해 두 가지 작성 모드를 제공하는 환경별 변수 충족 계약입니다. 모드 1(인라인): 구조화된 중첩 파라미터 값을 직접 담는 YAML 맵입니다. 모드 2(파일 가져오기): 정확히 하나의 키 $import: ./relative/path.yaml을 가진 YAML 맵으로, 파라미터 값을 제공하는 단일 로컬 파일을 가리킵니다. 이 위치에서는 단일 소스만 허용됩니다. 다중 파일 계층화는 Release extends: 체인의 영역입니다(부모 Release가 기본 파라미터를 제공하고, 자식이 확장하고 재정의합니다).
boundariesboundary의 맵아니요Aggregate의 컴포넌트가 라우팅되는 최상위 논리 상자입니다. 키: 하나 이상의 문자, 숫자, 밑줄 또는 하이픈입니다. 점은 허용되지 않습니다. 패턴: ^[a-zA-Z0-9_-]+$.
componentsboundary_component의 맵아니요이름 있는 경계가 없는 단일 범위 Release를 위해, 컴포넌트별 운영자 infra를 담는 최상위 컴포넌트 인스턴스입니다. boundaries와 상호 배타적입니다. 평면 Release에는 components를, 다중 대상 라우팅에는 boundaries를 선언하며, 둘을 함께 선언하지 않습니다. components를 사용하면 컴파일러가 이를 담는 default 경계를 합성하고 해당 아티팩트를 dist/에 평면으로 출력합니다. 키: 하나 이상의 문자, 숫자, 밑줄 또는 하이픈입니다. 점은 허용되지 않습니다. 패턴: ^[a-zA-Z0-9_-]+$.

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

정의

boundary_component

boundary로 라우팅되는 component 인스턴스로, 선택적으로 물리적 크기 설정과 feature 연결을 가집니다.

속성타입필수설명
descriptionstring아니요Release의 이 boundary에서 이 component가 맡는 역할을 설명하는 선택적 문서입니다.
subDirectorystring아니요Component 수준의 하위 경로 재정의로, 상위 boundary의 디렉터리 뒤에 덧붙습니다. boundary와 component 양쪽에서 모두 생략되거나 비어 있으면 기본값은 ’{{ .capability }}‘이며, 여기에 쓴 빈 문자열은 생략한 것으로 해석됩니다. 하위 디렉터리 생성을 비활성화하려면 ’.’으로 설정하거나 빈 문자열로 평가되는 템플릿으로 설정합니다.
annotationsstring 또는 object 또는 null의 맵아니요Component별 Operator 어노테이션으로, 이 component에 대해 boundary 수준 어노테이션을 재정의합니다. boundary 어노테이션 위에 딥 머지됩니다(키가 충돌하면 component가 우선하며, 구조화된 값은 구조화된 상위 값과 하위 키 단위로 병합됩니다). 값은 문자열, 구조화된 객체 또는 null입니다. component별 provider 공통 어노테이션 재정의에 사용됩니다(예: helm provider의 aggrega.ai/namespace). 상위 boundary에서 상속된 키에 명시적으로 null을 지정하면 이 component에서 상속된 바인딩이 제거되며(어노테이션 기반 Feature 옵트아웃), 형제 component는 상속된 바인딩을 유지합니다.
infraobject아니요이 component에만 엄격히 국한된 물리적 크기 설정입니다(예: replicas, 디스크 IOPS).
featuresobject 맵아니요Release를 통해 이 component에 연결되는 Features입니다. Aggregate에도 선언된 feature에는 infra만 제공됩니다(values는 Aggregate에서 옵니다). Release에만 있는 feature(Operator가 주입한 것)에는 type이 필수입니다. 키는 feature 인스턴스 이름이며 전체 feature type URI를 담을 수 있습니다(점과 슬래시 허용). Release는 feature의 values를 제공해서는 안 됩니다(MUST NOT). 이는 Developer의 영역입니다. 키: 하나 이상의 문자, 숫자, 밑줄, 점, 슬래시 또는 하이픈. 패턴: ^[a-zA-Z0-9_./-]+$.
usesrelease_uses_block아니요Operator 엣지 표면입니다. Architect가 선언한 socket 안에서 Release는 선언되었지만 바인딩되지 않은 socket을 기존 component(target)에 연결하거나 엣지별 infra를 제공하거나 둘 다 할 수 있습니다. values는 허용되지 않으며(Release values: 금지가 적용됩니다) compute 생성도 없습니다. 개발자가 선언한 엣지의 대상을 바꾸면 빌드 시 중단됩니다.

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

release_uses_block

Release가 작성하는 엣지별 uses 표면으로, socket을 키로 한 다음 alias를 키로 합니다(Aggregate uses 토폴로지 형태를 반영합니다). 각 connection은 target(선언되었지만 바인딩되지 않은 socket으로 기존 component를 가리키는 엣지를 만듭니다), infra(엣지별 operator 구성으로, Release가 해석될 때 socket의 infraSchema에 대해 검증됩니다), features(socket이 선언한 슬롯을 채우는 연결)를 어떤 조합으로든 설정할 수 있습니다. values는 금지되며(Release values: 금지), 개발자가 선언한 엣지의 대상을 바꾸는 것은 빌드 시 명시적인 가드레일에 걸립니다.

키: 하나 이상의 문자, 숫자, 밑줄 또는 하이픈입니다. 점은 허용되지 않습니다. 패턴: ^[a-zA-Z0-9_-]+$.

값은 map of object입니다.

그 밖의 키는 허용되지 않습니다.

release_connection_attachment

Release connection 항목이 담는 하나의 연결입니다. connection의 socket이 선언한 슬롯을 채우는 Feature와 그에 대한 operator의 크기 설정으로 이루어집니다.

속성타입필수설명
typestring아니요Feature의 URI입니다. Release만 만드는 연결에는 필수입니다. 양쪽 모두 선언하면 Aggregate의 type과 일치해야 합니다.
descriptionstring아니요Operator가 이 feature를 connection에 연결한 이유를 설명하는 선택적 문서입니다.
infraobject아니요이 연결의 운영 크기 설정으로, Feature의 schema 선언으로 검증됩니다.

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

aggregate_routing

중첩된 Aggregate 하위 모듈의 내부 component를 이 boundary로 라우팅합니다. 재귀적 구성을 위해 boundary의 component/aggregate 구조를 반영합니다.

속성타입필수설명
componentsboundary_component의 맵아니요이 boundary로 라우팅할, 중첩된 aggregate 안의 Component 인스턴스입니다. 키는 각 component가 해당 하위 모듈 안에서 갖는 로컬 이름입니다. 예를 들어 boundary 자신의 components 맵이 ‘data.main-db’로 지칭하는 component의 키는 ‘main-db’인데, 그곳에서는 그것이 그 component의 유일한 이름이기 때문입니다. 키: 하나 이상의 문자, 숫자, 밑줄 또는 하이픈. 점은 허용되지 않습니다. 패턴: ^[a-zA-Z0-9_-]+$.
aggregatesmap of aggregate_routing아니요이 하위 aggregate 안에 더 중첩된 aggregate입니다(깊이 중첩된 모듈 구성용). 키: 하나 이상의 문자, 숫자, 밑줄 또는 하이픈. 점은 허용되지 않습니다. 패턴: ^[a-zA-Z0-9_-]+$.

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

boundary

속성타입필수설명
descriptionstring아니요이 boundary의 목적과 물리적 대상을 설명하는 선택적 문서입니다(예: ‘Primary production EKS cluster in us-east-1, PCI-DSS compliant’).
directorystring아니요GitOps 아티팩트 생성을 위한 물리적 출력 경로입니다. Go 템플릿 변수({{ .capability }}, {{ .boundary_name }}, {{ .parameters.X }})를 지원합니다. subDirectory와 경로 결합으로 합쳐져 최종 아티팩트 경로를 만듭니다.
subDirectorystring아니요directory에 덧붙는 boundary 수준의 하위 경로입니다. boundary와 component 양쪽에서 생략되거나 비어 있으면 CI/CD 자동 분할을 위해 기본값 ’{{ .capability }}‘가 됩니다. 여기에 쓴 빈 문자열은 생략한 것으로 읽힙니다. 비활성화하려면 ’.’ 또는 빈 문자열로 평가되는 템플릿으로 설정합니다.
syncWaveinteger아니요선택적인 boundary별 배포 웨이브입니다(부호 있는 정수, 기본값 0). 이 boundary의 모든 component는 boundary의 웨이브를 자신의 노드로 상속합니다. 음수 값도 허용되며(다른 모든 것보다 먼저 실행), 큰 값은 작은 값보다 나중에 실행됩니다. K8s와 Helm에서는 웨이브가 배포 순서를 정합니다. 웨이브는 argocd.argoproj.io/sync-wave 어노테이션이 되고, 차트가 이미 Helm 훅으로 표시한 리소스에서는 그 훅의 helm.sh/hook-weight도 됩니다. compose에서는 웨이브가 서비스 레이블로 기록되는 동시에, 렌더링되는 파일의 서비스들 사이에 depends_on을 통해 순서를 정합니다. 따라서 그 하나의 파일에 있는 모든 서비스에 적용되고 파일 밖에는 적용되지 않습니다. cloudformation에서는 웨이브가 boundary가 조립되는 스택의 프로비저닝 순서를 정합니다. 한 웨이브의 모든 리소스는 이전 웨이브의 리소스에 의존하도록 선언되며, 이로써 리소스가 생성되는 순서와 그 역순인 삭제 순서가 고정됩니다. 이는 생성 및 삭제 순서일 뿐입니다. 스택 템플릿은 리소스가 준비되었다는 개념을 표현하지 않으므로, 리소스가 서비스 가능해질 때까지 기다리는 것은 없습니다. terraform에서는 웨이브가 boundary가 조립되는 루트 구성의 module 블록 순서를 정합니다. 한 웨이브의 모든 module은 이전 웨이브의 module에 의존하도록 선언되며, 이로써 엔진이 작업을 수행하는 순서가 고정됩니다. 이는 작업 순서일 뿐이며(구성은 리소스가 준비되었다는 개념을 표현하지 않으므로, 리소스가 서비스 가능해질 때까지 기다리는 것은 없습니다), 값은 노드의 빌드 출처 정보에도 기록됩니다. 컴파일러는 같은 값을 boundary의 모든 노드에 해당 노드의 sync_wave로 전달하며, 대상별 동작은 그곳에서 노드 관점으로 다시 설명됩니다. 중첩된 boundary는 암묵적으로 상속하지 않으며, 각각 자체 웨이브를 선언합니다.
annotationsstring 또는 object 또는 null의 맵아니요.context.annotations.release 버킷으로 계단식으로 전달되는 boundary 전체 Operator 어노테이션입니다. 값은 문자열, 구조화된 객체 또는 null입니다. 구조화된 값은 구조화된 부모와 깊은 병합되는(하위 키별, 자식 우선) 하위 키별 구성을 담으며, 어노테이션 기반 Feature 확장을 거쳐 전달됩니다. 렌더 컨텍스트에는 스칼라 값만 노출됩니다. 부모 boundary에서 상속된 키에 명시적 null을 지정하면 이 boundary의 유효 어노테이션 집합에서 상속된 바인딩이 제거되며(어노테이션 기반 Feature 옵트아웃), 더 깊은 재정의가 바인딩을 다시 도입하지 않는 한 이 boundary로 라우팅된 모든 component에 전파됩니다.
featuresobject 맵아니요중첩된 모든 component에 적용되는 boundary 전체 feature입니다(예: 기본 보안 메시). feature의 uses 블록은 boundary의 모든 component에 투영되므로, 공유 의존성을 각 component에 반복하지 않고 boundary에서 한 번 선언합니다. 키는 feature 인스턴스 이름이며 전체 feature 타입 URI를 포함할 수 있습니다(점과 슬래시 허용). 키: 하나 이상의 문자, 숫자, 밑줄, 점, 슬래시 또는 하이픈. 패턴: ^[a-zA-Z0-9_./-]+$.
boundariesboundary의 맵아니요중첩된 논리적 boundary입니다(예: 클러스터 내의 네임스페이스). 키: 하나 이상의 문자, 숫자, 밑줄 또는 하이픈. 점은 허용되지 않습니다. 패턴: ^[a-zA-Z0-9_-]+$.
componentsboundary_component의 맵아니요Aggregate의 어떤 component를 이 boundary에 배치할지 지정합니다. 키는 component 인스턴스 이름이며, 하위 aggregate의 component는 점으로 구분된 정규 경로로 지정합니다(예: ‘data.main-db’ — aggregate 인스턴스 이름, 점, component 이름). 키: 하나 이상의 문자, 숫자, 밑줄, 점 또는 하이픈. 패턴: ^[a-zA-Z0-9_.-]+$.
aggregatesmap of aggregate_routing아니요중첩된 Aggregate 하위 모듈의 component를 이 boundary로 라우팅합니다. 키는 Aggregate의 spec.aggregates 맵과 일치하는 aggregate 인스턴스 이름입니다. boundary가 정의된 경우 모든 aggregate 인스턴스는 정확히 하나의 boundary에 배치되어야 합니다. 키: 하나 이상의 문자, 숫자, 밑줄 또는 하이픈. 점은 허용되지 않습니다. 패턴: ^[a-zA-Z0-9_-]+$.

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

uses_block

구조적 토폴로지 - Developer 소유. 논리적 네트워크 엣지와 의존성을 선언합니다.

키: 하나 이상의 문자, 숫자, 밑줄 또는 하이픈입니다. 점은 허용되지 않습니다. 패턴: ^[a-zA-Z0-9_-]+$.

값은 string[] or map of object입니다.

그 밖의 키는 허용되지 않습니다.

inject_block

연결에서의 독립적인 주입 라우팅입니다. 로컬 변수를 대상의 provides 키에 매핑합니다. 각 전달 메커니즘(env, file, arg 또는 custom)은 {in, from} 항목의 배열로 작성되며, provides 참조에는 명시적인 ‘from’을 사용합니다. 사용자 정의 메커니즘에는 all을 제외한 어떤 이름이든 붙일 수 있습니다. 템플릿은 모든 메커니즘을 하나의 뷰로 병합한 것을 .context.inject.all에서 읽으므로, 그 이름의 메커니즘은 이 뷰에 가려지게 되며, 그런 이름을 지정하면 빌드가 중단됩니다.

속성타입필수설명
envinject_delivery아니요항목의 배열로 작성되는 단일 전달 메커니즘입니다. 각 항목은 ‘in’(로컬 식별자: 환경 변수 이름, 파일 경로, 인수 플래그 또는 사용자 지정 메커니즘별 키)과 함께 ‘from’(해석할 provides 키) 또는 ‘value’ 중 정확히 하나를 가집니다. Release에서는 모든 항목이 연결에 있으므로 ‘from’은 대상의 provides에 대해 해석되고, ‘value’를 가진 항목은 거부됩니다.
fileinject_delivery아니요항목의 배열로 작성되는 단일 전달 메커니즘입니다. 각 항목은 ‘in’(로컬 식별자: 환경 변수 이름, 파일 경로, 인수 플래그 또는 사용자 지정 메커니즘별 키)과 함께 ‘from’(해석할 provides 키) 또는 ‘value’ 중 정확히 하나를 가집니다. Release에서는 모든 항목이 연결에 있으므로 ‘from’은 대상의 provides에 대해 해석되고, ‘value’를 가진 항목은 거부됩니다.
arginject_delivery아니요항목의 배열로 작성되는 단일 전달 메커니즘입니다. 각 항목은 ‘in’(로컬 식별자: 환경 변수 이름, 파일 경로, 인수 플래그 또는 사용자 지정 메커니즘별 키)과 함께 ‘from’(해석할 provides 키) 또는 ‘value’ 중 정확히 하나를 가집니다. Release에서는 모든 항목이 연결에 있으므로 ‘from’은 대상의 provides에 대해 해석되고, ‘value’를 가진 항목은 거부됩니다.

inject_delivery

항목의 배열로 작성되는 단일 전달 메커니즘입니다. 각 항목은 ‘in’(로컬 식별자: 환경 변수 이름, 파일 경로, 인수 플래그 또는 사용자 지정 메커니즘별 키)과 함께 ‘from’(해석할 provides 키) 또는 ‘value’ 중 정확히 하나를 가집니다. Release에서는 모든 항목이 연결에 있으므로 ‘from’은 대상의 provides에 대해 해석되고, ‘value’를 가진 항목은 거부됩니다.

타입: object[]