Aggrega Wasm Importer Socket 스키마
자동 생성된 레퍼런스입니다. 직접 편집하지 말고 게시된 JSON Schema에서 다시 생성하십시오.
스키마 id: https://aggrega.ai/schemas/wasm-import-v1beta1.schema.json
임포터 플러그인 소켓이 소비하는(ImportInput) 와이어 형태와 내보내는(ImportOutput) 와이어 형태입니다. 임포터는 외부 인프라 기술을 Aggrega 엔터티로 변환합니다. 즉, 지정된 형식의 소스 바이트를 읽고, 각 소스 노드를 카탈로그 엔터티에 매핑한 다음, 내보낸 엔터티, 내린 매핑 결정, 발생시킨 진단, 생성한 스캐폴드 파일을 반환합니다. 임포터는 처리하는 형식을 디스크립터에 import:
다음 형태 중 하나
ImportInputImportOutput
정의
ImportInput
임포터 게스트가 받는 페이로드입니다. 바이트를 읽는 방식을 선택하는 소스 형식, 기본 소스 바이트와 그 바이트를 읽어 온 파일의 이름, 다중 파일 임포트를 위한 이름 있는 소스, 소비자가 임포터별 동작을 위해 제공하는 선택적 불투명 옵션 문서, 워크스페이스의 카탈로그가 보유한 Components의 뷰, 그리고 임포트가 초안을 작성하는 대상 타깃으로 구성됩니다.
| 속성 | 타입 | 필수 | 설명 |
|---|---|---|---|
format | string | 예 | 임포트할 소스 형식의 이름으로, 임포터가 알리는 import: |
bytes | string | 예 | 임포트할 기본 소스 바이트로, 임포터가 지정된 형식으로 읽습니다. 임포트의 소스가 하나의 파일이면 파일 전체이고, 디렉터리이면 비어 있으며 그 파일들은 대신 이름 있는 소스로 전달됩니다. 각 키트는 이를 자체 필드 타입으로 담습니다. 그 타입이 바이트 타입이면 원시 상태로, 문자열이면 임포터가 디코딩하여 복원하는 base64 인코딩 형태로 담으며, 생성된 인코더가 필드와 와이어가 바이트를 전달하는 형태 사이를 변환합니다. |
name | string | 아니요 | 임포트 소스의 이름으로, 앞에 디렉터리가 붙지 않습니다. 이를 통해 임포터는 보고하는 내용과 초안으로 작성하는 내용에서 소스를 지칭할 수 있습니다. 소스가 파일 하나이면 그 파일의 기본 이름입니다. 기본 바이트는 이름 있는 소스로 도착하지 않으므로 이것이 기본 바이트가 가진 유일한 이름입니다. 소스가 디렉터리이면 디렉터리의 기본 이름이며, 디렉터리의 파일은 여전히 각자 자신의 이름으로 이름 있는 소스로 도착하고 기본 바이트는 비어 있습니다. 소스에 줄 이름이 없으면 없습니다. |
sources | ImportSource[] | 아니요 | 각각 자체 바이트를 담는 이름 있는 소스로, 이름순으로 정렬된 하나의 목록입니다. 임포트의 소스가 디렉터리이면, 임포터가 선언한 파일 패턴이 선택하는 디렉터리의 파일마다 하나씩 있으며, 디렉터리 내부의 슬래시로 구분된 경로로 이름이 지정됩니다. 임포터를 구성하는 연결이 with.sources 아래에 선언한 파일도 각각 기본 이름으로 여기에 담기며, 디렉터리에서 읽은 파일과 이들 중 하나가 같은 이름을 가지면 호스트는 해당 임포트를 거부합니다. 어느 쪽도 제공하지 않으면 없습니다. |
settings | any | 아니요 | 소비자가 임포터별 동작을 위해 제공하는 불투명한 임포트 옵션 문서입니다. 호스트는 이를 해석하지 않고 그대로 전달하며, 임포터는 자신이 문서화한 형태대로 읽습니다. 소비자가 옵션을 제공하지 않으면 없습니다. |
catalog | CatalogProjection | 아니요 | 워크스페이스 자체 카탈로그(임포터 자신이 선택된 카탈로그)가 보유한 Components의 뷰로, 임포터가 소스 노드를 카탈로그 엔터티에 매핑할 때 이들을 후보로 평가할 수 있게 합니다. 호스트는 해당 로컬 카탈로그만으로 이를 구성하며, 이름, 버전, 레이블, 선언된 구조만 담습니다. 값, 기본값, 시크릿은 절대 담지 않습니다. 순서가 고정되어 있으므로 하나의 카탈로그는 하나의 바이트 시퀀스를 생성합니다. 카탈로그에 Component가 없으면 없습니다. |
target | string | 아니요 | 임포트가 초안을 작성하는 대상 프로바이더 기능으로, compose 또는 helm 등입니다. 임포트에 지정된 타깃이거나, 타깃을 지정하지 않고 이전 임포트를 갱신하는 임포트의 경우 그 이전 임포트가 기록한 타깃입니다. 임포터는 해당 타깃만 필요로 하는 내용을 선언으로 초안에 기록하고, 다른 타깃만 필요로 하는 내용은 생략합니다. 호스트는 워크스페이스 카탈로그의 Recipe가 이 타깃에 바인딩되는지 확인한 후 주어진 그대로 전달합니다. 임포트가 타깃을 지정하지 않으면 없습니다. |
추가 속성은 허용되지 않습니다.
CatalogProjection
임포터가 보는 워크스페이스의 카탈로그입니다. 카탈로그가 보유한 Component마다 하나의 항목이 있으며, 각 항목은 임포터가 후보를 채점할 때 평가하는 메타데이터를 담습니다.
| 속성 | 타입 | 필수 | 설명 |
|---|---|---|---|
components | CatalogComponent[] | 예 | 카탈로그가 보유한 Component 이름마다 하나의 항목이며, 이름순으로 정렬됩니다. 카탈로그가 한 Component의 여러 버전을 보유하면, 그 항목은 버전 없이 Component를 지정하는 참조가 해석되는 버전을 기술합니다. |
추가 속성은 허용되지 않습니다.
CatalogComponent
워크스페이스 카탈로그의 Component 하나입니다. 이름과 버전, 레이블, values와 provides가 선언하는 키 이름, 그리고 의존성을 위해 선언하는 소켓으로 구성됩니다. 다른 Component를 확장하는 Component는 자신이 선언한 것뿐 아니라 상속한 것도 담습니다.
| 속성 | 타입 | 필수 | 설명 |
|---|---|---|---|
name | string | 예 | metadata.name이 선언한 Component의 이름으로, Aggregate가 이를 참조할 때 사용하는 이름입니다. |
version | string | 예 | metadata.version이 선언한 Component의 버전입니다. |
labels | string 맵 | 아니요 | 문자열 대 문자열 맵 형태의 Component 레이블입니다. 레이블이 없으면 없습니다. |
values | string[] | 아니요 | Component의 values가 선언하는 최상위 키 이름으로, 정렬되어 있습니다. 이름만의 목록이며 값이나 기본값은 절대 담지 않습니다. values가 키를 선언하지 않으면 없습니다. |
provides | string[] | 아니요 | Component의 provides가 선언하는 최상위 키 이름으로, 정렬되어 있습니다. 이름만의 목록이며 값은 절대 담지 않습니다. provides가 키를 선언하지 않으면 없습니다. |
sockets | CatalogSocket[] | 아니요 | Component가 의존성을 위해 선언하는 소켓으로, 선언 순서를 따릅니다. 다른 Component를 확장하는 Component의 경우, 상속한 소켓이 확장된 Component가 선언한 순서대로 먼저 오고, 그 뒤에 추가한 소켓이 옵니다. 선언한 소켓이 없으면 없습니다. |
추가 속성은 허용되지 않습니다.
CatalogSocket
카탈로그 Component가 의존성을 위해 선언하는 소켓 하나입니다. 소켓의 이름과, 이 소켓을 통해 연결되는 의존성이 충족해야 하는 레이블 셀렉터로 구성됩니다.
| 속성 | 타입 | 필수 | 설명 |
|---|---|---|---|
name | string | 예 | Component의 usesSchema가 선언한 소켓의 이름입니다. |
selector | string | 예 | Component가 작성한 Kubernetes 스타일 문법 그대로의 소켓 레이블 셀렉터로, 이 소켓을 통해 연결되는 의존성이 지녀야 하는 레이블입니다. |
추가 속성은 허용되지 않습니다.
ImportSource
다중 파일 또는 디렉터리 임포트 내의 이름 있는 소스 하나로, 소스를 찾는 이름과 자체 바이트로 구성됩니다.
| 속성 | 타입 | 필수 | 설명 |
|---|---|---|---|
name | string | 예 | 임포트 내에서 이 소스의 이름으로, 예를 들어 상대 파일 경로입니다. |
bytes | string | 예 | 이 소스의 바이트입니다. 각 키트는 이를 자체 필드 타입으로 담습니다. 그 타입이 바이트 타입이면 원시 상태로, 문자열이면 임포터가 디코딩하여 복원하는 base64 인코딩 형태로 담으며, 생성된 인코더가 필드와 와이어가 바이트를 전달하는 형태 사이를 변환합니다. |
추가 속성은 허용되지 않습니다.
ImportOutput
임포터 게스트가 반환하는 페이로드입니다. 임포트가 생성한 엔터티, 그 배후의 매핑 결정, 임포트가 발생시킨 진단, 그리고 생성한 스캐폴드 파일로 구성됩니다. 모든 필드는 선택 사항이므로, 아무것도 해석하지 못한 임포트는 진단만 반환할 수 있습니다.
| 속성 | 타입 | 필수 | 설명 |
|---|---|---|---|
entities | EmittedEntity[] | 아니요 | 임포트가 생성한 엔터티로, 각각 기존 카탈로그 엔터티에 대한 참조이거나 초안 엔터티 본문입니다. 임포트가 엔터티를 내보내지 않았으면 없습니다. |
decisions | ImportDecision[] | 아니요 | 임포트가 내린 매핑 결정으로, 해석한 소스 노드마다 하나씩 있으며 평가한 후보와 내린 선택을 기록합니다. 임포트가 결정을 기록하지 않았으면 없습니다. |
diagnostics | Diagnostic[] | 아니요 | 임포트가 발생시킨 진단으로, 예를 들어 해석되지 않은 소스 노드나 모호한 매핑입니다. 임포트가 진단을 생성하지 않았으면 없습니다. |
files | ScaffoldFile[] | 아니요 | 임포트가 엔터티와 함께 생성한 스캐폴드 파일로, 예를 들어 시작용 aggregate나 readme입니다. 임포트가 파일을 생성하지 않았으면 없습니다. |
error | string | 아니요 | 게스트가 실행되었지만 작업을 완료하지 못했을 때 설정되는 실패 메시지이며, 성공 시에는 없습니다. 출력이 담는 진단과는 구별됩니다. 진단은 결과를 생성한 실행 중에 발견된 문제를 보고하는 반면, error는 작업 자체가 완료되지 않았음을 보고합니다. 호스트는 error가 있으면 플러그인 호출 실패로 표시합니다. |
추가 속성은 허용되지 않습니다.
EmittedEntity
임포트가 생성한 엔터티 하나입니다. 종류, 이름, 그리고 내보내지는 방식(기존 카탈로그 엔터티에 대한 참조 또는 새로 작성된 초안 엔터티 본문)으로 구성됩니다.
| 속성 | 타입 | 필수 | 설명 |
|---|---|---|---|
kind | string | 예 | 내보낸 엔터티의 종류입니다. 코어 임포터는 Component, Aggregate, Release를 내보냅니다. 읽는 쪽은 그 밖의 어떤 종류도 허용합니다. |
name | string | 예 | 내보낸 엔터티의 이름입니다. |
mode | string (enum) | 예 | 엔터티를 내보내는 방식입니다. reference는 이름으로 기존 카탈로그 엔터티를 가리키고, draft는 새로 작성된 초안 엔터티 본문을 담습니다. 허용되는 값: "reference", "draft" |
body | string | 아니요 | 초안 엔터티의 원시 YAML 본문입니다. 순수 참조의 경우 비어 있으며, 순수 참조는 엔터티를 작성하는 대신 기존 엔터티를 지정합니다. |
labels | string 맵 | 아니요 | 내보낸 엔터티에 붙일 레이블로, 문자열 대 문자열 맵입니다. 코어 임포터는 이를 비워 둡니다. |
annotations | string 맵 | 아니요 | 내보낸 엔터티에 붙일 어노테이션으로, 문자열 대 문자열 맵입니다. 코어 임포터는 이를 비워 둡니다. |
sourceRef | string | 아니요 | 이 엔터티를 내보낸 소스 노드에 대한 참조로, 읽는 쪽이 엔터티를 임포트된 소스의 원래 위치까지 추적할 수 있게 합니다. |
decisionRef | string | 아니요 | 이 엔터티를 생성한 매핑 결정에 대한 참조로, 엔터티를 평가된 후보 및 내려진 선택과 연결합니다. |
추가 속성은 허용되지 않습니다.
ImportDecision
하나의 매핑 결정입니다. 임포터가 해석한 소스 노드, 임포터가 검토한 후보 카탈로그 엔터티, 임포터가 선택한 후보, 그리고 그 선택의 근거로 구성됩니다.
| 속성 | 타입 | 필수 | 설명 |
|---|---|---|---|
sourceNode | DecisionSourceNode | 예 | 이 결정이 해석한 소스 노드입니다. 임포터가 소스에서 읽어 카탈로그 엔터티에 매핑한 노드입니다. |
candidates | ImportCandidate[] | 아니요 | 임포터가 이 소스 노드에 대해 검토한 후보 카탈로그 엔터티이며, 각각 점수와 그 점수의 신호별 내역을 담습니다. 임포터가 검토한 후보가 없으면 생략됩니다. |
chosen | DecisionChoice | 아니요 | 임포터가 이 소스 노드에 대해 선택한 후보와 그 후보를 내보낸 방식입니다. 임포터가 선택하지 않았으면 생략됩니다. |
rationale | string | 아니요 | 임포터가 이 선택을 한 이유를 사람이 읽을 수 있게 설명한 내용입니다. |
swapHint | string | 아니요 | 선택된 매핑을 다른 대안으로 바꾸는 방법을 설명하는 힌트로, 이를 통해 결정을 수정할 수 있습니다. |
추가 속성은 허용되지 않습니다.
DecisionSourceNode
매핑 결정이 해석한 소스 노드입니다. 식별자, 소스가 지정한 타입, 그리고 매개변수를 사람이 읽을 수 있게 요약한 내용으로 구성됩니다.
| 속성 | 타입 | 필수 | 설명 |
|---|---|---|---|
id | string | 예 | 가져온 소스 내에서 소스 노드의 식별자입니다. |
type | string | 예 | 소스가 지정한 소스 노드의 타입입니다. |
paramsSummary | string | 예 | 결정과 함께 표시하기 위해 소스 노드의 매개변수를 사람이 읽을 수 있게 요약한 내용입니다. |
추가 속성은 허용되지 않습니다.
ImportCandidate
임포터가 소스 노드에 대해 검토한 하나의 후보 카탈로그 엔터티입니다. 후보 컴포넌트, 전체 점수, 점수가 속하는 일치 등급, 그리고 점수의 신호별 내역으로 구성됩니다.
| 속성 | 타입 | 필수 | 설명 |
|---|---|---|---|
componentName | string | 예 | 후보 카탈로그 컴포넌트의 이름입니다. |
score | number | 예 | 신호별 내역을 집계한 후보의 전체 일치 점수입니다. |
tier | string | 예 | 후보가 속하는 일치 등급으로, 점수를 대략적으로 나눈 구간입니다. |
signals | CandidateSignals | 예 | 후보 점수의 신호별 내역입니다. |
추가 속성은 허용되지 않습니다.
CandidateSignals
후보 점수의 신호별 내역으로, 일치하는 신호마다 하나의 기여도를 담습니다. 필드가 고정된 객체이므로 신호 집합이 안정적이고 와이어 표현이 결정적입니다.
| 속성 | 타입 | 필수 | 설명 |
|---|---|---|---|
table | number | 예 | 매핑 테이블 신호의 점수 기여도입니다. |
category | number | 예 | 카테고리 신호의 점수 기여도입니다. |
domainLabels | number | 예 | 도메인 레이블 신호의 점수 기여도입니다. |
shape | number | 예 | 형태 신호의 점수 기여도입니다. |
name | number | 예 | 이름 신호의 점수 기여도입니다. |
추가 속성은 허용되지 않습니다.
DecisionChoice
매핑 결정이 선택한 후보입니다. 대상 카탈로그 엔터티, 내보내는 방식, 그리고 선택의 일치 등급으로 구성됩니다.
| 속성 | 타입 | 필수 | 설명 |
|---|---|---|---|
target | string | 예 | 선택된 대상 카탈로그 엔터티의 이름입니다. |
mode | string | 예 | 선택된 대상을 내보내는 방식으로, 내보낸 엔터티의 모드와 같습니다. 기존 엔터티에 대한 참조이거나 새로 작성한 본문입니다. |
tier | string | 예 | 선택된 대상의 일치 등급입니다. |
추가 속성은 허용되지 않습니다.
ScaffoldFile
가져오기가 생성한 하나의 스캐폴드 파일입니다. 가져오기 출력 루트에 대한 상대 경로와 파일 내용으로 구성됩니다.
| 속성 | 타입 | 필수 | 설명 |
|---|---|---|---|
path | string | 예 | 가져오기 출력 루트에 대한 스캐폴드 파일의 상대 경로입니다. |
content | string | 예 | 스캐폴드 파일의 내용입니다. |
추가 속성은 허용되지 않습니다.