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

Aggrega 카탈로그(Component) 스키마

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

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

원자적 구성 요소의 추상 정의입니다.

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

최상위 타입: object

속성

속성타입필수설명
apiVersionconst “aggrega.ai/v1beta1”예상수: "aggrega.ai/v1beta1"
kindconst “Component”예상수: "Component"
metadataobject예
specobject예개발자의 불투명한 values 페이로드를 규율하는 검증 및 스키마 정의입니다.

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

component.metadata

속성타입필수설명
namestring예최소 1자 이상이어야 합니다.
versionstring예인터페이스의 엄격한 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아니요이 엔터티가 무엇이며 무엇을 위한 것인지를, 사용 여부를 결정하려는 사람을 위해 작성합니다. 대상을 밝히는 문장으로 시작한 뒤, 독자가 이를 선택하고 올바르게 사용하는 데 필요한 내용, 즉 이를 배포하는 Release에 무엇을 기대하는지와 동작에서 예상 밖인 점을 덧붙입니다. 보통 짧은 단락 하나 정도의 길이입니다.
maintainersobject[]아니요이 엔티티를 소유하는 메인테이너 목록입니다.
licensestring아니요이 엔티티가 기술하는 소프트웨어의 라이선스를 나타내는 SPDX 식별자로, MIT 또는 AGPL-3.0 등이 있습니다. 이 파일의 조건이 아니라 해당 소프트웨어의 조건을 기록합니다.
repositorystring아니요소스 파일이 있는 Git 저장소의 URL입니다.
homestring아니요이 엔티티의 홈페이지, 위키 또는 문서의 URL입니다.
keywordsstring[]아니요UI에서 쉽게 찾을 수 있도록 하는 설명 키워드 목록입니다.
labelsobject예특성을 선언하는 덕 타이핑 레이블입니다. 예약된 ‘component.aggrega.ai/type’ 키를 반드시 포함해야 합니다.
annotationsstring 맵아니요Domain 2에서 Platform Architect가 작성하는, 변경 불가능한 고유 컴포넌트 특성입니다. .context.annotations.catalog 버킷으로 전파됩니다.

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

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

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

component.metadata.labels

특성을 선언하는 덕 타이핑 레이블입니다. 예약된 ‘component.aggrega.ai/type’ 키를 반드시 포함해야 합니다.

속성타입필수설명
component.aggrega.ai/typestring (enum)예이 컴포넌트가 어떤 종류인지를 나타내는 예약된 축입니다. Aggrega가 이 키와 허용되는 값을 정의하므로 집합은 닫혀 있습니다. 컴포넌트를 자체 축으로 분류하려면 이 키와 함께 자체 레이블 키를 추가합니다. 허용되는 값: "server", "worker", "task", "function", "stateful-server", "resource"

component.spec

개발자의 불투명한 values 페이로드를 규율하는 검증 및 스키마 정의입니다.

속성타입필수설명
extendsstring아니요이 Component가 확장하는 기본 Component의 URI입니다. 확장은 구조를 합성합니다. 기본 Component의 metadata 레이블과 어노테이션, 연결 슬롯(featuresSchema), 자체 주입 허용 목록(inject), 토폴로지 소켓(usesSchema)이 상속되며, 이 Component는 여기에 항목을 추가하거나 상속된 항목을 키 단위로 대체할 수 있습니다. 기본 Component의 데이터 필러는 합성되지 않습니다. 기본 Component의 schema 블록은 기본 Component가 작성한 그대로 상속되므로, 확장하는 Component는 schema: inherited를 작성하며 자체 필러 내용은 작성하지 않습니다.
featuresSchemaobject 맵아니요선언적 연결 슬롯 정의입니다. 이 엔티티가 Feature가 연결되기를 기대하는 이름 있는 바인딩 지점입니다. 슬롯은 어떤 채움이 바인딩할 수 있는지(selector)와 채움의 자료를 어떻게 전달할 수 있는지(inject)를 제약하며, values와 infra 계약은 채움 자체의 Feature가 소유합니다. 슬롯을 선언해도 연결 블록이 닫히지는 않습니다. 작성자는 어떤 슬롯도 선언하지 않은 이름으로 Feature를 연결할 수 있으므로, 하나의 엔티티가 슬롯을 채우는 연결과 더 넓은 범위에서 공유되는 자격 증명 모두에 쓰일 수 있습니다. 슬롯은 의존성 소켓이 아닌 바인딩 지점이며, 별도의 토폴로지 표면은 usesSchema가 선언합니다.
injectstring[]아니요허용 목록에 포함된 자체 주입 전달 메커니즘입니다(예: [‘env’, ‘file’, ‘arg’]). 이 필드가 있으면 개발자는 Aggregate의 컴포넌트 수준에서 inject: 블록을 사용해 자신의 values 또는 provides 키를 전달 파이프에 직접 주입할 수 있습니다. 생략하면 컴포넌트 수준 자체 주입은 금지됩니다(Black-Box 패턴 — Recipe가 모든 내부 연결을 처리합니다). usesSchema[].inject와 의미는 같지만, 컴포넌트 간 토폴로지가 아니라 컴포넌트 자체의 values를 규율합니다. all을 제외한 어떤 메커니즘 이름이든 나열할 수 있으며, all은 어떤 inject 블록에서도 지정할 수 없습니다.
usesSchemaobject 맵아니요이 엔터티가 선언하는 의존성 소켓으로, 소켓 이름을 키로 합니다. 소켓을 통해 연결되는 각 연결은 해당 소켓의 선언, 즉 셀렉터, 허용하는 inject 메커니즘, 연결별 계약에 대해 검사됩니다. 키: 하나 이상의 문자, 숫자, 밑줄 또는 하이픈. 점은 허용되지 않습니다. 패턴: ^[a-zA-Z0-9_-]+$.
schemaany아니요자유 형식 필러를 다루는 JSON Schema 2020-12 내용입니다. values(Developer의 영역 — Developer가 Aggregate에서 Component 인스턴스별로 구성하는 애플리케이션 형태 매개변수), infra(Operator의 영역 — Release가 제공하는 물리적 크기 조정 값), provides(이 Component가 토폴로지 파이프를 통해 소비자에게 노출하는 다운스트림 컨텍스트 키)로 구성됩니다. 내용 형태 기반 분기를 통해 네 가지 작성 모드를 받습니다. (1) 인라인 내용(간결한 형식, JSON Schema YAML 또는 혼합을 담은 YAML 맵), (2) {$import: }를 통한 파일 대체로, spec.schema에 작성하면 전체 계약을 한 파일에서 제공하고 단일 필러에 작성하면 해당 필러만 제공하며, 상대 경로는 이를 선언한 엔티티가 있는 디렉터리를 기준으로 읽습니다. (3) {$ref: #/schemas/}를 통해 이름만으로 식별되는 SchemaLibrary 항목을 가리키는 문서 간 참조(버전은 Release별 lockfile이 제공하며, 참조에는 레지스트리 호스트가 나타나지 않습니다), (4) 단순 문자열 inherited로, extends를 선언한 Component가 작성할 수 있는 유일한 형식이며 세 필러가 기본 Component가 작성한 그대로 기본 Component에서 온다는 것을 나타냅니다. 모드 1~3은 내용을 작성하며 extends를 선언하지 않은 Component에서만 사용할 수 있습니다. 모드 4는 내용을 작성하지 않으며 extends를 선언한 모든 Component에 필수입니다. 동반 필드인 usesSchema와 featuresSchema는 고정 형태 필러(의존성 소켓, 연결 슬롯)를 다루며, 컴파일러가 이 셋을 인스턴스 검증에 쓰이는 하나의 스키마로 합성합니다.
assertionsstring 맵아니요빌드 시점의 필드 간 검증입니다. 각 항목은 이름 있는 단언입니다. 키는 오류 메시지에 표시되는 안정적인 규칙 식별자이고, 값은 {{ fail "message" }} 중단 의미론을 갖는 Go 템플릿 문자열입니다. 엔티티당 여러 이름 있는 단언은 인스턴스별로 작성자가 선언한 순서대로 평가되며, 처음 실패한 단언이 빌드를 중단합니다. Component 단언은 해석과 정적 분석 이후, 렌더링 이전에 평가되며, 어떤 Recipe가 바인딩되든 유지되는 계약의 아키텍처 불변식을 표현합니다. 템플릿 컨텍스트: .values / .infra / .uses / .features / .metadata. 평가기는 missingkey=error를 사용하므로 정의되지 않은 키에 대한 참조는 no-such-key 진단과 함께 중단됩니다. 단순 참조는 어떤 대체 값도 실행되기 전에 중단되므로, 이 표면에서는 일반 default로 선택적 필드의 대체 값을 제공할 수 없습니다. 참조를 hasKey로 감싸거나, 존재 여부 검사를 직접 수행하는 optional 헬퍼를 사용합니다. index로 키를 읽어도 대체 값이 제공되지 않습니다. index는 맵에 없는 키에서 해당 키를 명시하며 중단됩니다. 상속은 누적됩니다. extends를 선언한 Component는 자체 단언뿐 아니라 상속한 단언에 대해서도 평가되며 상속된 규칙이 먼저 평가되고, 깊이에 관계없이 체인은 루트에서 아래로 누적됩니다. 따라서 둘 이상의 규칙이 실패할 경우 체인에서 가장 위에 선언된 규칙이 보고됩니다. 상속된 이름을 재사용해 다른 규칙을 선언하면 extends 체인이 카탈로그에 대해 해석될 때 두 Components와 공유된 이름을 명시하며 거부됩니다. 따라서 이 오류는 확장하는 문서만으로는 드러나지 않고 기본 Component가 존재할 때 드러납니다. 확장하는 Component는 규칙을 추가할 뿐 대체하지 않습니다. 상속된 규칙을 같은 이름으로 바이트 단위까지 동일하게 다시 작성하면 아무 효과 없는 작업으로 허용됩니다. 두 규칙이 동시에 성립할 수 있는지는 검사하지 않습니다. 서로 충족할 수 없는 규칙 쌍은 작성 오류이며, 사전 경고가 아니라 인스턴스가 먼저 실행되는 쪽을 위반할 때 일반적인 단언 실패로 드러납니다.

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

정의

extending-component-must-declare-schema-inherited

spec.extends가 있을 때 적용됩니다. 확장하는 Component는 기반의 values / infra / provides를 기반이 작성한 그대로 받으므로, spec.schema: inherited를 선언하고 필러 내용을 작성하지 않습니다. 다른 두 결과는 모두 오류이며, 서로 다른 실수입니다. spec.schema를 완전히 생략하면 읽는 사람이 상속된 필러 블록과 빠뜨린 블록을 구별할 수 없게 됩니다. spec.schema 아래에 필러 내용을 작성하면 계약이 기반의 계약인 Component에 두 번째의 상이한 계약을 요구하게 됩니다.

속성타입필수설명
schemaconst “inherited”예상속 표시이며, extends를 선언한 Component에서 spec.schema가 가질 수 있는 유일한 값입니다. 이 값은 필러를 어디에서 가져오는지를 나타내며, 필러 내용 자체는 기반 Component의 것입니다. 상수: "inherited"

non-extending-component-authors-its-own-schema

spec.extends가 없을 때 적용됩니다. 어떤 기반도 확장하지 않는 Component는 spec.schema 아래에 자신의 values / infra / provides 내용을 작성하므로, 이 필드는 inherited 표시가 아니라 작성된 내용을 담습니다. 이 표시는 필러를 기반에서 가져온다는 뜻이며, 이 Component에는 기반이 없습니다.

속성타입필수설명
schemaobject아니요작성된 필러 내용으로, spec.schema가 설명하는 세 가지 내용 작성 모드 중 어느 것으로든 작성한 맵입니다.