Aggrega 인프라 기반(Recipe) 스키마
자동 생성된 레퍼런스입니다. 직접 편집하지 말고 게시된 JSON Schema에서 다시 생성하십시오.
스키마 id: https://aggrega.ai/schemas/recipe-v1beta1.schema.json
Dev의 의도를 특정 인프라 provider에 연결하는, Ops가 작성하는 포인터 및 매핑 계층입니다. 물리적 provider 및 카탈로그 component와 엄격하게 1:1로 대응합니다.
Recipe 엔티티 작성에 관한 설명은 Recipe 작성 레퍼런스를 참조하십시오. 이 페이지는 해당 레퍼런스가 설명하는 구조적 스키마를 문서화합니다.
최상위 타입: object
속성
| 속성 | 타입 | 필수 | 설명 |
|---|---|---|---|
apiVersion | const “aggrega.ai/v1beta1” | 예 | 상수: "aggrega.ai/v1beta1" |
kind | const “Recipe” | 예 | 상수: "Recipe" |
metadata | object | 예 | |
spec | object | 예 | Recipe의 provider 바인딩, 소스, 값 매핑, 파이프라인입니다. 더하기 방식으로 조합되는 세 가지 입력 종류를 지원합니다: sourced(source와 valuesMapping 오버레이), synthesized(workload), artifacts(이름이 지정된 출력 파일). 이와 별개로 Recipe는 ‘boundary’ 아래에서, 자신이 렌더링되는 boundary의 공유 출력에 파일을 기여할 수 있습니다. |
추가 속성은 허용되지 않습니다.
recipe.metadata
| 속성 | 타입 | 필수 | 설명 |
|---|---|---|---|
name | string | 예 | 최소 1자 이상이어야 합니다. |
version | string | 예 | 구현 recipe의 엄격한 Semantic Versioning 버전입니다(예: 2.1.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-]+)*))?$. |
description | string | 아니요 | 이 엔터티가 무엇이며 무엇을 위한 것인지를, 사용 여부를 결정하려는 사람을 위해 작성합니다. 대상을 밝히는 문장으로 시작한 뒤, 독자가 이를 선택하고 올바르게 사용하는 데 필요한 내용, 즉 이를 배포하는 Release에 무엇을 기대하는지와 동작에서 예상 밖인 점을 덧붙입니다. 보통 짧은 단락 하나 정도의 길이입니다. |
maintainers | object[] | 아니요 | 이 엔티티를 소유하는 메인테이너 목록입니다. |
license | string | 아니요 | 이 엔티티가 기술하는 소프트웨어의 라이선스를 나타내는 SPDX 식별자로, MIT 또는 AGPL-3.0 등이 있습니다. 이 파일의 조건이 아니라 해당 소프트웨어의 조건을 기록합니다. |
repository | string | 아니요 | 소스 파일이 있는 Git 저장소의 URL입니다. |
home | string | 아니요 | 이 엔티티의 홈페이지, 위키 또는 문서의 URL입니다. |
keywords | string[] | 아니요 | UI에서 쉽게 찾을 수 있도록 하는 설명 키워드 목록입니다. |
추가 속성은 허용되지 않습니다.
recipe.metadata.maintainers[]
| 속성 | 타입 | 필수 | 설명 |
|---|---|---|---|
name | string | 예 | |
email | string | 아니요 | |
url | string | 아니요 |
추가 속성은 허용되지 않습니다.
recipe.spec
Recipe의 provider 바인딩, 소스, 값 매핑, 파이프라인입니다. 더하기 방식으로 조합되는 세 가지 입력 종류를 지원합니다: sourced(source와 valuesMapping 오버레이), synthesized(workload), artifacts(이름이 지정된 출력 파일). 이와 별개로 Recipe는 ‘boundary’ 아래에서, 자신이 렌더링되는 boundary의 공유 출력에 파일을 기여할 수 있습니다.
| 속성 | 타입 | 필수 | 설명 |
|---|---|---|---|
capability | string | 예 | 이 recipe가 바인딩되는 명시적인 provider 기능(예: ‘helm’, ‘terraform’, ‘compose’)으로, 이 recipe를 렌더링하는 provider 종류입니다. ‘implements’와 같은 세 가지 형식의 선택적 버전 고정을 받습니다: 버전 없음(‘helm’), 정확한 버전(‘helm:1.0.0’), 메이저 호환 범위(‘helm:^1.0.0’). 이름만 있는 부분은 provider 종류를 선택하고, 고정이 있으면 해당 기능을 제공하는 provider 렌더링 플러그인 중 어느 버전이 이 recipe를 렌더링할지 선택합니다. 고정이 없으면 사용 가능한 가장 높은 버전, 정확한 고정이면 그 버전, 캐럿이면 범위 내 가장 높은 버전입니다. 이를 만족하는 플러그인 버전이 없는 고정은 빌드를 명시적으로 중단시킵니다. provider 선택 이후의 모든 것, 즉 출력 그룹화, 경로 세그먼트, 파이프라인 호환성, 코덱 선택은 이름만 있는 기능을 기준으로 하므로, 같은 기능의 서로 다른 플러그인 버전을 고정한 두 recipe가 한 빌드에 공존할 수 있습니다. |
implements | string | 예 | 이 recipe가 구현할 수 있는 카탈로그 component 타입을 선언합니다(정확한 버전 ‘core/api-server:1.0.0’, 메이저 호환 범위 ‘core/api-server:^1.0.0’, 또는 버전 없음 ‘core/api-server’). 컴파일러는 이를 사용해 Manifest 매핑을 검증하고 진단과 에디터 자동 완성에서 후보를 제안하지만, 빌드를 결정하는 데는 사용하지 않습니다. aggrega lint도 이를 읽어, Recipe가 공개하는 키와 비교할 provides 계약을 선언한 Component를 찾습니다. Manifest 매핑은 Release의 lockfile에 고정되는 사용자의 명시적인 구현 선택입니다. |
source | string 또는 object | 아니요 | 인프라 코드의 위치입니다. URI 문자열을 받거나, provider가 정의한 키가 Recipe의 템플릿에 ‘.source.*‘로 노출되는 개방형 구조 객체를 받습니다. |
locals | string 맵 | 아니요 | Private Ops State입니다. 이 Recipe의 템플릿 안에서 ‘.locals.*‘로 사용할 수 있는 내부 계산 결과입니다. 각 항목은 그 자체로 Go 템플릿이며, 독립적인 노드 로컬 컨텍스트, 즉 ‘.context.instance_id’, ‘.values’, ‘.infra’, 그리고 지금까지 해석된 같은 블록의 항목들을 대상으로 평가됩니다. 항목은 작성된 순서대로 해석되며, 항목은 자신보다 위에 정의된 형제 항목을 읽을 수 있고(MAY), 이때 그 형제의 템플릿 텍스트가 아닌 해석된 값을 받습니다. 한 항목이 다른 항목을 읽는 곳에서는 작성 순서가 계약의 일부입니다. 정의를 그것을 읽는 항목 아래로 옮기면 빌드가 깨지며, 참조를 해석하기 위해 블록이 재정렬되는 일은 없습니다. 이 블록이 나중에 정의하는 항목에 대한 ‘.locals. |
provides | string, number 또는 boolean의 맵 | 아니요 | Public Developer API입니다. 다운스트림 Caller의 inject 해석에 사용할 수 있는 계약상의 출력 변수입니다. 컴파일러는 provides 템플릿을 독립적인 컨텍스트를 대상으로, 서로 간에 임의의 순서로 평가하며, 어떤 provides 항목도 다른 항목을 읽지 않습니다. 노드의 locals는 provides보다 앞선 locals 전처리 단계에서 해석되므로, provides 템플릿은 ‘.locals’를 읽어 해석된 값을 받을 수 있고, locals 블록이 선언하지 않은 키를 가리키면 중단됩니다. Caller는 inject 하이드레이션 시점에 이 값들을 대상으로 inject 키를 해석합니다. 값은 스칼라이며, 파이프는 이를 그대로 전달하고 주입 경계에서 결정론적으로 문자열로 변환합니다. |
valuesMapping | string 또는 object | 아니요 | 내용 형태에 따른 분기로 세 가지 작성 모드를 지원하는 값 매핑 내용입니다. 모드 1(인라인): Aggrega 컨텍스트(.values, .features, .infra)로부터 provider가 기대하는 값 형식을 생성하는 Go 템플릿 문자열 스칼라(일반적으로 블록 스칼라 YAML |)입니다. 모드 2(파일 가져오기): 로컬 Go 템플릿 파일을 가리키는, 정확히 하나의 키 $import: ./relative/path.tmpl를 가진 YAML 맵입니다. 모드 3(라이브러리 가져오기): 이름만으로 된 식별자로 MappingLibrary 항목을 참조하는, 정확히 하나의 키 $import: <Library>#/mappings/<entry>를 가진 YAML 맵입니다(버전은 Release별 lockfile이 제공하며, 참조에는 레지스트리 호스트가 나타나지 않습니다). 객체 형식에서 $import는 ^oci://와 일치해서는 안 되며, 일치하는 값은 거부됩니다. |
workload | string 또는 object | 아니요 | 콘텐츠 형태에 따른 디스패치로 세 가지 작성 모드를 지원하는 Workload YAML 생성기입니다. 모드 1(인라인): 출력이 ‘aggrega.ai/v1beta1 Workload’로 파싱되는 Go 템플릿 문자열 스칼라입니다. 모드 2(파일 가져오기): 로컬 Go 템플릿 파일을 가리키는, 정확히 하나의 키 $import: ./relative/path.yaml로 된 YAML 맵입니다. 모드 3(라이브러리 가져오기): WorkloadLibrary 항목을 이름만으로 된 식별자로 참조하는, 정확히 하나의 키 $import: <Library>#/workloads/<entry>로 된 YAML 맵입니다(버전은 Release별 lockfile이 제공하며, 참조에는 레지스트리 호스트가 나타나지 않습니다). 대상 Provider는 workload 합성을 지원해야 합니다. 표준 라이브러리 카탈로그는 그러한 provider에 문서화된 계약으로 workloadSchema를 선언합니다. 합성할 수 없는 provider에 바인딩된 workload: Recipe는 렌더링 시점에 명시적으로 중단됩니다. 객체 형식에서 $import는 ^oci://와 일치해서는 안 되며, 일치하는 값은 거부됩니다. |
artifacts | string 또는 object의 맵 | 아니요 | 항목 이름에서 아티팩트 콘텐츠 작성으로의 맵입니다. 각 항목의 값은 콘텐츠 형태에 따른 디스패치로 세 가지 모드 중 하나를 가집니다. 모드 1(인라인): 출력이 아티팩트 본문이 되는 Go 템플릿 문자열 스칼라입니다. 모드 2(파일 가져오기): 로컬 Go 템플릿 파일을 가리키는, 정확히 하나의 키 $import: ./relative/path.yaml로 된 YAML 맵입니다. 모드 3(라이브러리 가져오기): ArtifactLibrary 번들을 이름만으로 된 식별자로 참조하는, 정확히 하나의 키 $import: <Library>#/artifacts/<entry>로 된 YAML 맵입니다(버전은 Release별 lockfile이 제공하며, 참조에는 레지스트리 호스트가 나타나지 않습니다). 번들은 파일마다 하나의 출력으로 확장되며, 각 출력은 항목의 키 아래에 <key>/<filename>으로 중첩됩니다. 키는 항목의 출력 이름을 정합니다. 모드 1 또는 모드 2 항목의 키는 작성된 그대로 사용되는 출력 파일 이름이며, 모드 2 항목에서 가져온 파일은 출력 이름을 정하지 않고 콘텐츠만 제공하므로, 이름이 같은 서로 다른 파일을 가져오는 두 항목은 서로 다른 두 출력입니다. 아티팩트 항목, 번들 파일, source 출력, workload 합성 사이의 충돌은 노드가 렌더링될 때 빌드를 중단시킵니다. artifacts 블록은 Recipe와 FeatureRecipe에서 동일하게 작성됩니다. 같은 세 가지 모드, 같은 키-출력 규칙, 같은 충돌 동작을 가지므로 이 설명의 해당 부분은 두 종류에서 똑같이 읽히며, 한쪽을 위해 작성한 예제는 수정 없이 다른 쪽에 옮겨 쓸 수 있습니다. 객체 형식에서 $import는 ^oci://와 일치해서는 안 되며, 일치하는 값은 거부됩니다. 키: 키는 항목의 출력 이름을 정하므로 단일 파일 이름으로 제한됩니다. 문자 또는 숫자로 시작하고, 문자, 숫자, 점, 하이픈, 밑줄로 이어집니다. 첫 문자 이후의 점은 아티팩트 키가 갖는 확장자(main.tf, template.yaml, serviceaccount.yaml)를 유지하기 위한 것입니다. /는 하나의 키가 파일이 아닌 경로를 가리키게 만들고, 선행 .는 출력 디렉터리 바깥 위치를 가리키는 ..를 허용하게 되므로, 첫 번째 문자 클래스가 둘 다 거부합니다. 라이브러리 가져오기의 경우 키는 번들 파일이 중첩되는 디렉터리 이름을 정하므로 같은 제한이 적용됩니다. 패턴: ^[A-Za-z0-9][A-Za-z0-9._-]*$. |
omits | object[] | 아니요 | 이 Recipe의 source가 렌더링하는 것 중 제외할 대상입니다. 그대로 가져온 source가 Release가 배포해서는 안 되는 것을 렌더링할 때 사용합니다. 예를 들어 가져온 chart가 렌더링하는 문서(렌더링할 때마다 chart가 새로 생성하는 키를 담은 Secret 등), 가져온 compose 파일에 포함된 service, volume 또는 config, 가져온 CloudFormation 템플릿이 선언하는 리소스가 있습니다. 대부분의 Recipes에는 필요하지 않습니다. 각 항목은 source가 렌더링하는 하나의 단위를 kind, 이름, 그리고 항목이 지정한 경우 namespace와 그 단위가 나온 subchart로 지정하며, 각각은 source를 렌더링하는 provider의 용어를 따릅니다. chart의 경우 문서 자체의 kind와 metadata.name으로, compose 파일의 경우 services:, volumes: 또는 configs: 아래의 키로 service, volume 또는 config를, CloudFormation 템플릿의 경우 Type과 논리적 ID로 리소스를 지정합니다. 해당 provider는 항목과 일치하는 모든 단위를 제외하며, 항목이 무엇과 일치하는지, 그리고 provider가 항목을 이유로 무엇을 거부하는지는 해당 provider 자체의 문서화된 계약입니다. 아무것도 제외할 수 없는 provider는 이 키를 선언한 Recipe를 렌더링 전에 거부합니다. source:가 렌더링하는 것만 필터링되며 workload: 또는 artifacts: 항목은 필터링되지 않습니다. 따라서 이 키는 source를 필요로 합니다. 모든 값은 템플릿이며, valuesMapping이 평가되는 것과 같은 컨텍스트에서 평가됩니다. 항목의 when이 먼저 평가되며, when이 falsy 값으로 렌더링되는 항목은 제외됩니다. 활성 상태로 남은 모든 항목은 무언가를 제외해야 합니다. source가 렌더링한 어떤 것과도 일치하지 않는 활성 항목은 해당 항목을 명시하며 빌드를 중단시킵니다. source는 여전히 전체가 렌더링되므로(chart의 모든 템플릿이 여전히 실행되어, 실패하는 템플릿은 여전히 빌드를 실패시킵니다) 그 출력만 제외됩니다. 최소 1개 항목. |
boundary | object | 아니요 | 이 Recipe가 자신의 component 출력이 아니라, 자신이 렌더링되는 boundary의 공유 출력에 기여하는 내용입니다. 대부분의 Recipes에는 필요하지 않습니다. 이는 대상이 boundary 전체에 대해 한 번만 읽는 파일을 위한 것입니다. 예를 들어 Terraform provider 구성은 Terraform이 boundary의 루트 구성에서만 받아들이며 개별 component의 모듈 안에서는 받아들이지 않습니다. provider는 자신의 계약이 boundaryArtifacts를 선언하는 경우에만 이러한 파일을 받아들이며, 이를 선언하지 않은 provider에 대해 이 블록을 선언한 Recipe는 렌더링 전에 거부됩니다. FeatureRecipe에는 이러한 블록이 없습니다. |
outputLabels | string 맵 | 아니요 | Recipe 작성자가 선언한 레이블로, 이 레시피의 렌더링된 출력이 생성하는 모든 객체에 부착되며 프로바이더가 각 프로바이더의 레이블 표면으로 변환합니다(helm 합성, source-render, artifacts에는 Kubernetes metadata.labels, Compose에는 서비스 레이블, Terraform .tf.json 아티팩트 본문에는 리소스별 태그). 고정된 출처(provenance) 레이블과 같은 경로를 따르지만, 컴파일러가 아니라 작성자가 소유합니다. aggrega.ai/ 및 app.kubernetes.io/ 네임스페이스는 플랫폼 고유의 출처 정보용으로 예약되어 있으며 로드 시 거부됩니다. 대상 프로바이더에 유효한 레이블이 아닌 키나 값은 레시피 작성자의 책임이며, 코어는 예약 네임스페이스 규칙 외에는 레이블 문자 집합을 검사하지 않습니다. |
outputComponentLabels | string[] | 아니요 | 이 레시피가 렌더링된 출력으로 승격하는 Component 식별 레이블 키입니다. 각 항목은 레이블 키 하나를 지정하며, 값은 이 레시피가 렌더링하는 컴포넌트 인스턴스의 레이블에서 가져오므로, 부착되는 레이블은 여기서 반복 기재한 값이 아니라 해당 컴포넌트가 선언한 값을 갖습니다. 승격된 레이블은 outputLabels와 같은 레이블 표면에 도달하며, outputLabels는 그 자리에서 작성한 리터럴 키-값 쌍을 담는다는 점이 다릅니다. 두 블록 모두에 선언된 키는 로드 시 거부되므로, 부착되는 각 키의 출처는 하나뿐입니다. aggrega.ai/ 및 app.kubernetes.io/ 네임스페이스는 플랫폼 고유의 출처 정보용으로 예약되어 있으며 로드 시 거부됩니다. component.aggrega.ai/hosting과 같은 범위 지정 키는 이 예약된 루트 밖에 있으므로 승격할 수 있습니다. |
pipeline | object[] | 아니요 | 렌더링 후 렌더링된 문서 집합에 대해 순서대로 실행되는 Wasm 파이프라인 단계 목록으로, 각 단계는 RFC 6902 패치와 부수 효과를 반환합니다. |
assertions | string 맵 | 아니요 | 빌드 시점의 필드 간 검증입니다. 각 항목은 이름이 있는 어서션입니다. 키는 오류 메시지에 표시되는 안정적인 규칙 식별자이고, 값은 {{ fail "message" }} 중단 의미론을 갖는 Go 템플릿 문자열입니다. 엔티티당 여러 개의 이름 있는 어서션은 인스턴스별로 작성자가 선언한 순서대로 평가되며, 처음 실패한 어서션이 빌드를 중단합니다. Recipe 어서션은 recipe 바인딩 이후, provides 평가 이후, 렌더링 이전에 평가되며, Recipe가 소스로 삼는 특정 차트나 모듈의 구현 불변 조건을 표현합니다. 템플릿 컨텍스트: .values / .infra / .uses / .features / .metadata 및 .provides / .locals / .recipe. 평가기는 missingkey=error를 사용하므로, 정의되지 않은 키를 참조하면 no-such-key 진단과 함께 중단됩니다. 단순 참조는 대체값이 실행되기 전에 중단되므로, 이 영역에서 일반 default는 선택적 필드의 대체값을 제공하지 않습니다. 참조를 hasKey로 보호하거나, 존재 여부를 직접 검사하는 optional 헬퍼를 사용하십시오. index를 통해 키를 읽어도 대체값이 제공되지 않습니다. index는 맵에 없는 맵 키에서 해당 키를 명시하며 중단됩니다. |
추가 속성은 허용되지 않습니다.
recipe.spec.omits[]
| 속성 | 타입 | 필수 | 설명 |
|---|---|---|---|
kind | string | 예 | 제외할 단위의 kind로, 소스를 렌더링하는 provider의 어휘로 표현합니다. chart의 경우 렌더링된 문서 자체의 kind(예: Secret), compose 파일의 경우 service, volume 또는 config, CloudFormation 템플릿의 경우 리소스의 Type(예: AWS::S3::Bucket)입니다. 소스가 렌더링하는 kind를 지정하며, 구조화된 source:가 갖는 kind:와는 관계가 없습니다. 템플릿입니다. |
name | string | 예 | 제외할 단위의 이름으로, 소스를 렌더링하는 provider의 어휘로 표현합니다. chart의 경우 렌더링된 문서 자체의 metadata.name, compose 파일의 경우 services:, volumes: 또는 configs: 아래에 있는 해당 단위의 키, CloudFormation 템플릿의 경우 리소스의 논리적 ID, 즉 Resources 아래의 키입니다. 템플릿입니다. |
namespace | string | 아니요 | 항목이 특정 네임스페이스의 단위만 일치해야 할 때, 제외할 단위가 속한 네임스페이스입니다. chart의 렌더링된 문서처럼 출력에 네임스페이스가 있는 provider에 사용합니다. 없거나 빈 문자열로 렌더링되면 항목은 네임스페이스와 관계없이 해당 kind와 이름의 단위와 일치합니다. compose 파일과 CloudFormation 템플릿에는 네임스페이스가 없으며, 해당 provider는 네임스페이스를 지정한 항목을 거부합니다. 템플릿입니다. |
subchart | string | 아니요 | 제외할 단위가 유래한 서브차트로, 항목이 하나의 서브차트가 렌더링하는 사본에만 일치해야 할 때 사용합니다. 차트가 서브차트로 조립되듯이 중첩된 source로 조립되는 source를 위한 것입니다. 차트의 경우 서브차트 자체의 이름 또는 부모의 의존성이 부여한 별칭이며, 중첩된 서브차트의 이름은 가장 바깥쪽부터 /로 연결합니다: operator 또는 operator/webhooks. 이때 항목은 해당 서브차트 자체의 templates/ 또는 crds/에서 렌더링된 문서와 일치하며, 차트 자체가 렌더링하는 문서나 그 안에 중첩된 서브차트가 렌더링하는 문서와는 일치하지 않습니다. 없거나 빈 문자열로 렌더링되면, 항목은 유래와 관계없이 해당 종류와 이름의 단위와 일치합니다. 그 이름의 서브차트를 렌더링하지 않는 차트는 해당 항목을 지목하며 빌드를 중단시킵니다. compose 파일과 CloudFormation 템플릿에는 서브차트가 없으며, 해당 provider는 서브차트를 지정하는 항목을 거부합니다. 템플릿입니다. |
when | string | 아니요 | 항목의 다른 필드보다 먼저 평가되는 인라인 Go 템플릿입니다. falsy 값으로 렌더링되면 항목은 제외됩니다. 즉 다른 필드는 평가되지 않고, 이 항목으로 인해 제외되는 것이 없으며, 일치해야 할 필요도 없습니다. 비어 있거나 없는 when은 항목을 유지합니다. 참 여부는 불리언 형태의 템플릿 출력에 대한 표준 관례를 따릅니다. 문자열 true/True/TRUE, 0이 아닌 모든 숫자, 그 밖의 비어 있지 않은 모든 문자열은 참이고, false/False/FALSE, 빈 문자열, 0은 거짓입니다. 렌더링에 실패한 when은 빌드를 중단합니다. |
추가 속성은 허용되지 않습니다.
recipe.spec.boundary
이 Recipe가 자신의 component 출력이 아니라, 자신이 렌더링되는 boundary의 공유 출력에 기여하는 내용입니다. 대부분의 Recipes에는 필요하지 않습니다. 이는 대상이 boundary 전체에 대해 한 번만 읽는 파일을 위한 것입니다. 예를 들어 Terraform provider 구성은 Terraform이 boundary의 루트 구성에서만 받아들이며 개별 component의 모듈 안에서는 받아들이지 않습니다. provider는 자신의 계약이 boundaryArtifacts를 선언하는 경우에만 이러한 파일을 받아들이며, 이를 선언하지 않은 provider에 대해 이 블록을 선언한 Recipe는 렌더링 전에 거부됩니다. FeatureRecipe에는 이러한 블록이 없습니다.
| 속성 | 타입 | 필수 | 설명 |
|---|---|---|---|
artifacts | string 또는 object의 맵 | 예 | 파일 이름에서 파일 내용 작성으로의 맵이며, 이 Recipe 자체의 artifacts와 정확히 같은 형태입니다. 같은 세 가지 모드(인라인 Go 템플릿 문자열, 로컬 Go 템플릿 파일의 $import:, 또는 파일이 항목의 키 아래 <key>/<filename>으로 중첩되는 ArtifactLibrary 번들의 $import:), 같은 키-파일 이름 규칙, 같은 템플릿 컨텍스트를 가지므로, 항목은 artifacts 항목과 똑같이 .values, .infra, .locals 등을 읽을 수 있습니다. 다른 점은 각 파일이 기록되는 위치입니다. 이 컴포넌트 자체의 디렉터리가 아니라, 경계의 조립된 출력을 담는 디렉터리에, 프로바이더 자체의 조립이 기록하는 파일들 옆에 한 번 기록됩니다. 모든 항목은 이 Recipe가 경계에서 렌더링하는 각 컴포넌트마다 평가되며, 그 평가로 생성된 파일은 이름으로 병합됩니다. 여러 컴포넌트나 여러 Recipes가 동일한 바이트로 평가한 하나의 이름은 하나의 파일이 되지만, 하나의 이름이 서로 다른 바이트로 평가되면 파일과 모든 기여자를 명시하며 빌드가 중단되고, 프로바이더 자체의 조립이 이미 기록하는 이름도 마찬가지입니다. 이러한 파일에는 어느 컴포넌트가 기록했는지 나타내는 내용이 찍히지 않습니다. 파일을 선언한 모든 컴포넌트에 속하기 때문입니다. 템플릿이 아무것도 렌더링하지 않는 항목은 파일을 기록하지 않습니다. 항목은 프로바이더에 전달되지 않으며, 프로바이더는 항목을 읽지 않고 경계 출력의 나머지를 기록합니다. 객체 형식에서 $import는 ^oci://와 일치해서는 안 되며, 일치하는 값은 거부됩니다. 키: 키는 파일의 이름을 지정하므로, artifacts 키가 따르는 규칙에 따라 단일 파일 이름으로 제한됩니다. 문자나 숫자로 시작하고 문자, 숫자, 점, 하이픈 또는 밑줄로 이어집니다. /는 하나의 키가 파일이 아닌 경로를 지정하게 만들고, 선행 .는 경계의 출력 디렉터리 바깥 위치를 가리키는 ..를 허용하게 됩니다. 첫 번째 문자 클래스가 둘 다 거부합니다. 라이브러리 가져오기의 경우 키는 번들의 파일이 중첩되는 디렉터리의 이름을 지정하므로 같은 제한이 적용됩니다. 패턴: ^[A-Za-z0-9][A-Za-z0-9._-]*$. 최소 1개 항목. |
추가 속성은 허용되지 않습니다.
recipe.spec.pipeline[]
| 속성 | 타입 | 필수 | 설명 |
|---|---|---|---|
id | string | 예 | 이 단계의 프로그래밍용 식별자로, 이 파이프라인의 단계 사이에서 고유합니다. 두 단계에 같은 id를 선언하는 문서는 읽을 때 거부됩니다. 같은 파이프라인의 이후 단계는 이 단계의 출력을 .steps.<id>.outputs로 읽습니다. 패턴: ^[a-zA-Z0-9_]+$. |
plugin | string | 예 | 이 단계가 실행하는 Plugin 엔터티에 대한 참조로, 항상 플러그인 자체의 소켓 타입으로 범위가 지정됩니다. parser/yaml 또는 parser/yaml:1.0.0처럼 선택적 버전을 포함한 <pluginType>/<name> 형식입니다. 범위는 여러 형식 중 하나가 아니라 필수입니다. 범위가 없는 name:version은 거부되는데, 두 소켓이 같은 이름의 플러그인을 가질 수 있으며 범위가 있어야 엔터티를 확인할 수 있기 때문입니다. 빌드는 엔터티를 콘텐츠 주소 지정 방식의 .wasm 아티팩트(플러그인의 식별 정보와 구성된 레지스트리로 위치를 찾고, 다이제스트는 lockfile에 고정됨)로 확인한 뒤 바이트를 로드합니다. 단순 .wasm 또는 아티팩트 참조는 여기서 허용되지 않습니다. |
function | string | 예 | 호출할, 내보낸 Wasm 함수입니다. |
with | string | 아니요 | 이 플러그인의 명시적 입력 스키마를 엄격하게 충족하는 JSON/YAML 맵으로 평가되는 인라인 Go 템플릿입니다. |
optional | 불리언 | 아니요 | true이면 이 단계의 실패(게스트 트랩, 집합에 없는 문서를 대상으로 하는 패치, 잘못된 형식의 패치, 또는 중단 심각도의 진단)가 눈에 띄는 경고로 격하됩니다. 단계 이전의 문서 집합이 복원되고, 이 단계의 출력은 폐기되며, 파이프라인은 계속 진행됩니다. false이거나 없으면 단계가 실패할 경우 단계 이전의 문서 집합을 복원한 뒤 빌드를 중단합니다. |
when | string | 아니요 | 파이프라인 순회 시점에 평가되는 인라인 Go 템플릿입니다. falsy 값으로 렌더링되면 단계는 건너뛰어지며 통과 처리됩니다. 즉 문서 집합이 변경 없이 다음 단계로 전달되고, 패치, 부수 효과, 단계 기록을 남기지 않습니다. 비어 있거나 없는 when은 항상 단계를 실행합니다. 참 여부는 불리언 형태의 템플릿 출력에 대한 표준 관례를 따릅니다. 문자열 true/True/TRUE, 0이 아닌 모든 숫자, 그 밖의 비어 있지 않은 모든 문자열은 참이고, false/False/FALSE, 빈 문자열, 0은 거짓입니다. when과 optional은 서로 독립적이며, 한 단계에 둘 다 선언할 수 있습니다. |
추가 속성은 허용되지 않습니다.