Lược đồ Aggrega Infrastructure Base (Recipe)
Tài liệu tham khảo được sinh tự động. Không chỉnh sửa thủ công — hãy sinh lại từ JSON Schema đã xuất bản.
Id lược đồ: https://aggrega.ai/schemas/recipe-v1beta1.schema.json
Lớp con trỏ và ánh xạ do Ops soạn, kết nối ý định của Dev với một nhà cung cấp hạ tầng cụ thể. Tương ứng nghiêm ngặt 1:1 với một nhà cung cấp vật lý và một component trong catalog.
Xem tài liệu tham khảo về soạn Recipe để có hướng dẫn bằng văn xuôi về việc soạn các thực thể Recipe; trang này mô tả lược đồ cấu trúc mà tài liệu tham khảo đó đề cập.
Kiểu cấp cao nhất: object
Thuộc tính
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
apiVersion | const “aggrega.ai/v1beta1” | có | Hằng số: "aggrega.ai/v1beta1" |
kind | const “Recipe” | có | Hằng số: "Recipe" |
metadata | object | có | |
spec | object | có | Liên kết provider, nguồn, ánh xạ giá trị và pipeline cho một Recipe. Hỗ trợ ba loại đầu vào được kết hợp bằng phép cộng: sourced (source cộng lớp phủ valuesMapping), synthesized (workload) và artifacts (các tệp đầu ra được đặt tên). Tách biệt với những loại đó, một Recipe có thể đóng góp tệp vào đầu ra chung của boundary mà nó được render trong đó, dưới ‘boundary’. |
Không cho phép thuộc tính bổ sung.
recipe.metadata
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
name | string | có | Dài ít nhất 1 ký tự. |
version | string | có | Phiên bản theo Semantic Versioning nghiêm ngặt của recipe triển khai (ví dụ: 2.1.0). Mẫu: ^(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 | không | Thực thể này là gì và dùng để làm gì, được viết cho người đang quyết định có dùng nó hay không. Mở đầu bằng một câu gọi tên nó, sau đó bổ sung những gì người đọc cần để chọn và dùng nó đúng cách — nó mong đợi gì từ Release triển khai nó, và bất cứ điều gì bất ngờ trong cách nó hoạt động. Độ dài thông thường là một đoạn ngắn. |
maintainers | object[] | không | Danh sách những người bảo trì sở hữu thực thể này. |
license | string | không | Mã định danh SPDX cho giấy phép của phần mềm mà thực thể này mô tả, chẳng hạn MIT hoặc AGPL-3.0. Nó ghi lại các điều khoản của phần mềm đó, không phải các điều khoản của tệp này. |
repository | string | không | URL đến kho Git chứa các tệp nguồn. |
home | string | không | URL của trang chủ, wiki hoặc tài liệu của thực thể này. |
keywords | string[] | không | Danh sách các từ khóa mô tả giúp dễ tìm kiếm trên giao diện người dùng. |
Không cho phép thuộc tính bổ sung.
recipe.metadata.maintainers[]
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
name | string | có | |
email | string | không | |
url | string | không |
Không cho phép thuộc tính bổ sung.
recipe.spec
Liên kết provider, nguồn, ánh xạ giá trị và pipeline cho một Recipe. Hỗ trợ ba loại đầu vào được kết hợp bằng phép cộng: sourced (source cộng lớp phủ valuesMapping), synthesized (workload) và artifacts (các tệp đầu ra được đặt tên). Tách biệt với những loại đó, một Recipe có thể đóng góp tệp vào đầu ra chung của boundary mà nó được render trong đó, dưới ‘boundary’.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
capability | string | có | Năng lực provider tường minh mà recipe này liên kết tới (ví dụ: ‘helm’, ‘terraform’, ‘compose’) — loại provider render nó. Chấp nhận một ghim phiên bản tùy chọn, theo cùng ba dạng như ‘implements’: không có phiên bản (‘helm’), chính xác (‘helm:1.0.0’), hoặc khoảng tương thích major (‘helm:^1.0.0’). Tên trần chọn loại provider; ghim, khi có, chọn phiên bản nào của plugin render provider phục vụ năng lực đó sẽ render recipe này — phiên bản cao nhất hiện có khi không ghim, đúng phiên bản với ghim chính xác, cao nhất trong khoảng với dấu mũ. Một ghim mà không phiên bản plugin phục vụ nào thỏa mãn sẽ dừng bản build một cách rõ ràng. Mọi thứ phía sau việc chọn provider — nhóm đầu ra, các đoạn đường dẫn, khả năng tương thích pipeline và lựa chọn codec — đều dựa trên năng lực trần, nên hai recipe ghim các phiên bản plugin khác nhau của cùng một năng lực có thể cùng tồn tại trong một bản build. |
implements | string | có | Khai báo loại component trong catalog mà recipe này có thể triển khai (phiên bản chính xác ‘core/api-server:1.0.0’, khoảng tương thích major ‘core/api-server:^1.0.0’, hoặc không có phiên bản ‘core/api-server’). Trình biên dịch dùng nó để xác minh các ánh xạ Manifest và để gợi ý ứng viên trong chẩn đoán và tính năng tự hoàn thành của trình soạn thảo; nó không bao giờ quyết định một bản build. aggrega lint cũng đọc nó, để tìm Component mà hợp đồng provides đã khai báo của nó được dùng để so sánh với các khóa được công bố của một Recipe. Ánh xạ Manifest là lựa chọn hiện thực tường minh của người dùng, được ghim trong lockfile của Release. |
source | string hoặc object | không | Vị trí của mã hạ tầng. Chấp nhận một chuỗi URI, hoặc một đối tượng có cấu trúc mở mà các khóa do provider định nghĩa được cung cấp cho các template của Recipe dưới dạng ‘.source.*’. |
locals | map của string | không | Trạng thái Ops riêng tư. Các kết quả tính toán nội bộ có sẵn trong các template của Recipe này dưới dạng ‘.locals.*’. Mỗi mục tự nó là một Go template, được đánh giá trên một ngữ cảnh cục bộ của node, tự chứa: ‘.context.instance_id’, ‘.values’, ‘.infra’ và các mục của chính khối này đã được phân giải cho đến lúc đó. Các mục được phân giải theo thứ tự chúng được viết, và một mục CÓ THỂ đọc một mục anh em được định nghĩa PHÍA TRÊN nó, nhận giá trị đã phân giải của mục đó chứ không phải văn bản template của nó. Thứ tự của tác giả là một phần của hợp đồng ở bất cứ đâu một mục đọc mục khác: chuyển một định nghĩa xuống dưới mục đọc nó sẽ làm hỏng bản build, và khối này không bao giờ được sắp xếp lại để một tham chiếu được phân giải. Một tham chiếu ‘.locals. |
provides | map của string hoặc number hoặc boolean | không | API công khai cho nhà phát triển. Các biến đầu ra mang tính hợp đồng có sẵn cho việc phân giải inject của Caller phía sau. Trình biên dịch đánh giá các template provides trên một ngữ cảnh tự chứa, theo thứ tự bất kỳ giữa chúng với nhau — không mục provides nào đọc mục khác. Các locals của node được phân giải trong phần mở đầu locals, trước provides của nó, nên một template provides có thể đọc ‘.locals’ và nhận các giá trị đã phân giải; nêu một khóa mà khối locals không khai báo sẽ dừng lại. Bên gọi phân giải các khóa inject dựa trên các giá trị này khi hydrate inject. Các giá trị là scalar — đường ống mang chúng nguyên văn và chuyển thành chuỗi một cách tất định tại ranh giới inject. |
valuesMapping | string hoặc object | không | Nội dung ánh xạ giá trị với ba chế độ soạn thảo thông qua phân phối theo hình dạng nội dung. Chế độ 1 (nội tuyến): một scalar chuỗi Go template (thường là YAML block-scalar |) tạo ra định dạng giá trị mà provider mong đợi từ ngữ cảnh Aggrega (.values, .features, .infra). Chế độ 2 (nhập tệp): một map YAML có đúng một khóa, $import: ./relative/path.tmpl, trỏ tới một tệp Go template cục bộ. Chế độ 3 (nhập thư viện): một map YAML có đúng một khóa, $import: <Library>#/mappings/<entry>, tham chiếu một mục MappingLibrary theo định danh tên trần (phiên bản do lockfile của từng Release cung cấp; không có registry host nào xuất hiện trong tham chiếu). Trong dạng đối tượng, $import không được khớp với ^oci://; giá trị nào khớp sẽ bị từ chối. |
workload | string hoặc object | không | Bộ tạo YAML Workload với ba chế độ soạn thảo thông qua phân phối theo hình dạng nội dung. Chế độ 1 (nội tuyến): một scalar chuỗi Go template có đầu ra được phân tích thành ‘aggrega.ai/v1beta1 Workload’. Chế độ 2 (nhập tệp): một map YAML có đúng một khóa, $import: ./relative/path.yaml, trỏ tới một tệp Go-template cục bộ. Chế độ 3 (nhập thư viện): một map YAML có đúng một khóa, $import: <Library>#/workloads/<entry>, tham chiếu một mục WorkloadLibrary theo định danh tên trần (phiên bản do lockfile của từng Release cung cấp; không có registry host nào xuất hiện trong tham chiếu). Provider đích phải hỗ trợ tổng hợp workload; catalog thư viện chuẩn khai báo workloadSchema trên các provider như vậy làm hợp đồng được tài liệu hóa. Một Recipe workload: được gắn với một provider không thể tổng hợp sẽ dừng một cách rõ ràng tại thời điểm render. Ở dạng object, $import không được khớp với ^oci://; giá trị nào khớp sẽ bị từ chối. |
artifacts | map của string hoặc object | không | Map từ tên mục tới nội dung artifact được soạn thảo. Giá trị của mỗi mục mang một trong ba chế độ thông qua phân phối theo hình dạng nội dung. Chế độ 1 (nội tuyến): một scalar chuỗi Go template có đầu ra là nội dung artifact. Chế độ 2 (nhập tệp): một map YAML có đúng một khóa, $import: ./relative/path.yaml, trỏ tới một tệp Go-template cục bộ. Chế độ 3 (nhập thư viện): một map YAML có đúng một khóa, $import: <Library>#/artifacts/<entry>, tham chiếu một bundle ArtifactLibrary theo định danh tên trần (phiên bản do lockfile của từng Release cung cấp; không có registry host nào xuất hiện trong tham chiếu). Một bundle mở rộng thành một đầu ra cho mỗi tệp, mỗi đầu ra lồng dưới khóa của mục dưới dạng <key>/<filename>. Khóa đặt tên cho đầu ra của mục: khóa của một mục chế độ 1 hoặc chế độ 2 là tên tệp đầu ra của nó, được dùng đúng như đã viết, và tệp được nhập của một mục chế độ 2 cung cấp nội dung mà không đặt tên cho đầu ra, nên hai mục nhập hai tệp khác nhau có cùng tên là hai đầu ra riêng biệt. Xung đột giữa các mục artifact, các tệp bundle, đầu ra của source và tổng hợp workload sẽ dừng build khi node được render. Khối artifacts được soạn thảo giống hệt nhau trên một Recipe và trên một FeatureRecipe — cùng ba chế độ, cùng quy tắc từ khóa tới đầu ra và cùng hành vi xung đột — đó là lý do phần này của mô tả đọc giống nhau trên cả hai loại; một ví dụ viết cho loại này áp dụng nguyên vẹn cho loại kia. Ở dạng object, $import không được khớp với ^oci://; giá trị nào khớp sẽ bị từ chối. Khóa: Khóa đặt tên cho đầu ra của mục, nên nó bị giới hạn trong một tên tệp duy nhất: bắt đầu bằng một chữ cái hoặc chữ số và tiếp tục bằng chữ cái, chữ số, dấu chấm, dấu gạch nối hoặc dấu gạch dưới. Dấu chấm sau ký tự đầu tiên giữ lại các phần mở rộng mà khóa artifact mang (main.tf, template.yaml, serviceaccount.yaml). Một / sẽ khiến một khóa đặt tên cho một đường dẫn thay vì một tệp, và một . ở đầu sẽ cho phép .., vốn chỉ một vị trí nằm ngoài thư mục đầu ra — lớp ký tự đầu tiên từ chối cả hai. Với nhập thư viện, khóa đặt tên cho thư mục mà các tệp của bundle được lồng bên dưới, nên cùng giới hạn đó được áp dụng. Mẫu: ^[A-Za-z0-9][A-Za-z0-9._-]*$. |
omits | object[] | không | Những gì cần loại bỏ khỏi kết quả mà source của Recipe này render — dành cho một source được dùng nguyên trạng nhưng render ra thứ mà Release không được phát hành: một tài liệu do một chart được tải về render, chẳng hạn một Secret chứa một khóa mà chart tạo mới ở mỗi lần render, một service, một volume hoặc một config mà một tệp compose được tải về đóng gói kèm, hoặc một tài nguyên mà một template CloudFormation được tải về khai báo. Hầu hết các Recipes không bao giờ cần đến nó. Mỗi mục chỉ định một đơn vị mà source render theo kind, tên của nó và, nếu mục có cung cấp, namespace của nó và subchart mà nó đến từ đó, mỗi thứ theo từ vựng của provider đang render source — với một chart, là một tài liệu theo kind và metadata.name của chính nó; với một tệp compose, là một service, một volume hoặc một config theo khóa của nó dưới services:, volumes: hoặc configs:; với một template CloudFormation, là một tài nguyên theo Type và logical ID của nó. Provider đó loại bỏ mọi đơn vị mà một mục khớp, và việc một mục khớp với gì, cũng như những gì provider từ chối vì một mục, là hợp đồng được tài liệu hóa của riêng provider đó. Một provider không thể loại bỏ bất cứ thứ gì sẽ từ chối một Recipe khai báo khóa này trước khi bất cứ thứ gì được render. Chỉ những gì source: render mới được lọc — một mục workload: hoặc artifacts: thì không bao giờ — nên khóa này yêu cầu source. Mọi giá trị đều là một template, được đánh giá dựa trên cùng ngữ cảnh mà valuesMapping được đánh giá. when của một mục được đánh giá trước, và một mục có when render ra giá trị falsy sẽ bị bỏ qua. Mọi mục còn hoạt động đều phải loại bỏ được thứ gì đó: một mục hoạt động không khớp với bất cứ thứ gì source đã render sẽ dừng build, kèm tên của mục đó. Source vẫn được render đầy đủ — mọi template của một chart vẫn chạy, nên một template bị lỗi vẫn làm build thất bại — và chỉ đầu ra của nó bị loại bỏ. Ít nhất 1 mục. |
boundary | object | không | Những gì Recipe này đóng góp vào đầu ra chung của boundary mà nó render trong đó, thay vì vào đầu ra của chính component của nó. Hầu hết các Recipes không bao giờ cần đến nó: nó dành cho một tệp mà đích đọc một lần cho toàn bộ boundary — chẳng hạn một cấu hình provider của Terraform, thứ mà Terraform chỉ chấp nhận trong cấu hình gốc của một boundary và không bao giờ bên trong module của một component. Một provider chỉ chấp nhận các tệp như vậy khi hợp đồng của nó khai báo boundaryArtifacts, và một Recipe khai báo khối này cho một provider không khai báo điều đó sẽ bị từ chối trước khi bất cứ thứ gì được render. Một FeatureRecipe không mang khối nào như vậy. |
outputLabels | map của string | không | Các nhãn do tác giả Recipe khai báo, được gắn lên mọi đối tượng mà đầu ra kết xuất của công thức này tạo ra, và được provider chuyển đổi sang bề mặt nhãn của từng provider (Kubernetes metadata.labels cho tổng hợp helm, source-render và artifacts; nhãn service của Compose; tag theo từng tài nguyên trên thân artifact .tf.json của Terraform). Chúng đi cùng một đường ray với các nhãn nguồn gốc cố định nhưng thuộc sở hữu của tác giả thay vì của trình biên dịch. Các namespace aggrega.ai/ và app.kubernetes.io/ được dành riêng cho thông tin nguồn gốc gốc của nền tảng và bị từ chối khi tải. Một khóa hoặc giá trị không phải là nhãn hợp lệ cho provider đích thuộc trách nhiệm của tác giả công thức; phần lõi không kiểm soát bộ ký tự của nhãn ngoài quy định về namespace dành riêng. |
outputComponentLabels | string[] | không | Các khóa nhãn định danh Component mà công thức này đưa lên đầu ra kết xuất của nó. Mỗi mục nêu tên một khóa nhãn; giá trị được lấy từ các nhãn của thể hiện thành phần mà công thức này kết xuất, nên nhãn được gắn mang giá trị mà thành phần đó khai báo chứ không phải một giá trị lặp lại ở đây. Các nhãn được đưa lên đi tới cùng bề mặt nhãn với outputLabels, vốn mang các cặp khóa-giá trị nguyên văn được viết tại chỗ. Một khóa được khai báo trong cả hai khối bị từ chối khi tải, để mỗi khóa được gắn chỉ có một nguồn duy nhất. Các namespace aggrega.ai/ và app.kubernetes.io/ được dành riêng cho thông tin nguồn gốc gốc của nền tảng và bị từ chối khi tải; một khóa có phạm vi như component.aggrega.ai/hosting nằm ngoài các gốc dành riêng đó và có thể được đưa lên. |
pipeline | object[] | không | Danh sách tuần tự các bước pipeline Wasm chạy sau khi render trên tập tài liệu đã render, mỗi bước trả về các bản vá RFC 6902 và các hiệu ứng phụ. |
assertions | map của string | không | Xác thực chéo giữa các trường tại thời điểm build. Mỗi mục là một khẳng định có tên: khóa là định danh quy tắc ổn định được hiển thị trong thông báo lỗi; giá trị là một chuỗi Go template với ngữ nghĩa dừng {{ fail "message" }}. Nhiều khẳng định có tên trên mỗi thực thể được đánh giá theo từng instance, theo thứ tự tác giả khai báo; khẳng định thất bại đầu tiên sẽ dừng build. Các khẳng định của Recipe được đánh giá sau khi liên kết recipe và sau khi các provides được đánh giá, trước khi render, và biểu đạt các bất biến triển khai của chart hoặc module cụ thể mà Recipe lấy làm nguồn. Ngữ cảnh template: .values / .infra / .uses / .features / .metadata cùng với .provides / .locals / .recipe. Bộ đánh giá dùng missingkey=error: tham chiếu tới các khóa chưa được định nghĩa sẽ dừng với một chẩn đoán no-such-key. Vì tham chiếu trần dừng trước khi bất kỳ giá trị dự phòng nào kịp chạy, một default đơn thuần không cung cấp giá trị dự phòng cho trường tùy chọn trên bề mặt này — hãy chặn tham chiếu bằng hasKey, hoặc dùng helper optional, vốn thực hiện trực tiếp việc kiểm tra sự hiện diện. Đọc khóa qua index cũng không cung cấp giá trị dự phòng: index dừng trên một khóa mà map không chứa, nêu tên khóa đó. |
Không cho phép thuộc tính bổ sung.
recipe.spec.omits[]
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
kind | string | có | Loại của đơn vị cần loại bỏ, theo từ vựng của provider kết xuất nguồn: với một chart, là kind riêng của một tài liệu được kết xuất, chẳng hạn Secret; với một tệp compose, là service, volume hoặc config; với một template CloudFormation, là Type của một tài nguyên, chẳng hạn AWS::S3::Bucket. Nó đặt tên cho một loại mà nguồn kết xuất, và không liên quan đến kind: mà một source: có cấu trúc mang theo. Là một template. |
name | string | có | Tên của đơn vị cần loại bỏ, theo từ vựng của provider kết xuất nguồn: với một chart, là metadata.name riêng của một tài liệu được kết xuất; với một tệp compose, là khóa của đơn vị dưới services:, volumes: hoặc configs:; với một template CloudFormation, là ID logic của tài nguyên, tức khóa của nó dưới Resources. Là một template. |
namespace | string | không | Namespace chứa đơn vị cần loại bỏ, khi mục chỉ nên khớp với một đơn vị trong namespace đó — dành cho một provider có đầu ra có namespace, như các tài liệu được kết xuất của một chart. Khi vắng mặt, hoặc kết xuất thành chuỗi rỗng, mục khớp với một đơn vị có loại và tên của nó bất kể namespace. Một tệp compose và một template CloudFormation không có namespace, và provider của chúng từ chối một mục có nêu namespace. Là một template. |
subchart | string | không | Subchart mà đơn vị cần loại bỏ xuất phát từ đó, khi mục chỉ nên khớp với bản sao do một subchart render — dành cho một source được lắp ráp từ các source lồng nhau, như một chart được lắp ráp từ các subchart của nó. Với một chart, đó là tên riêng của subchart, hoặc bí danh mà dependency của chart cha đặt cho nó, với các tên của một subchart lồng nhau được nối bằng / từ ngoài cùng: operator, hoặc operator/webhooks. Khi đó mục khớp với một tài liệu được render từ templates/ hoặc crds/ riêng của subchart đó, và không khớp với tài liệu do chính chart render hay tài liệu do một subchart lồng bên trong nó render. Nếu vắng mặt, hoặc render ra chuỗi rỗng, mục khớp với một đơn vị có kind và tên của nó bất kể nó xuất phát từ đâu. Một chart không render subchart nào có tên đó sẽ dừng bản build, kèm tên của mục. Một tệp compose và một template CloudFormation không có subchart, và các provider của chúng từ chối một mục đặt tên subchart. Một template. |
when | string | không | Template Go nội tuyến được đánh giá trước các trường khác của mục. Khi nó kết xuất ra một giá trị falsy, mục bị loại bỏ: các trường khác của nó không được đánh giá, không có gì bị loại bỏ vì nó, và nó không bắt buộc phải khớp. Một when rỗng hoặc vắng mặt giữ lại mục. Tính đúng sai tuân theo quy ước chuẩn cho đầu ra template dạng boolean: các chuỗi true/True/TRUE, mọi số khác không, và mọi chuỗi không rỗng khác là đúng, còn false/False/FALSE, chuỗi rỗng và số không là sai. Một when kết xuất thất bại sẽ dừng quá trình build. |
Không cho phép thuộc tính bổ sung.
recipe.spec.boundary
Những gì Recipe này đóng góp vào đầu ra chung của boundary mà nó render trong đó, thay vì vào đầu ra của chính component của nó. Hầu hết các Recipes không bao giờ cần đến nó: nó dành cho một tệp mà đích đọc một lần cho toàn bộ boundary — chẳng hạn một cấu hình provider của Terraform, thứ mà Terraform chỉ chấp nhận trong cấu hình gốc của một boundary và không bao giờ bên trong module của một component. Một provider chỉ chấp nhận các tệp như vậy khi hợp đồng của nó khai báo boundaryArtifacts, và một Recipe khai báo khối này cho một provider không khai báo điều đó sẽ bị từ chối trước khi bất cứ thứ gì được render. Một FeatureRecipe không mang khối nào như vậy.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
artifacts | map của string hoặc object | có | Map từ tên tệp tới phần soạn nội dung tệp, có hình dạng giống hệt artifacts của chính Recipe này: cùng ba chế độ — một chuỗi Go template inline, một $import: của tệp Go-template cục bộ, hoặc một $import: của một bundle ArtifactLibrary, với các tệp được lồng dưới khóa của mục dưới dạng <key>/<filename> — cùng quy tắc từ khóa sang tên tệp, và cùng ngữ cảnh template, nên một mục có thể đọc .values, .infra, .locals và các phần còn lại đúng như một mục artifacts. Điểm khác là nơi mỗi tệp được ghi: một lần, trong thư mục chứa đầu ra đã lắp ráp của boundary, bên cạnh các tệp mà quá trình lắp ráp riêng của provider ghi ở đó, thay vì trong thư mục riêng của component này. Mọi mục được đánh giá cho từng component mà Recipe này render trong boundary, và các tệp do những lần đánh giá đó tạo ra được hợp nhất theo tên: một tên được nhiều component, hoặc nhiều Recipes, đánh giá ra các byte giống hệt nhau là một tệp, còn một tên được đánh giá ra các byte khác nhau sẽ dừng build, nêu tên tệp và mọi bên đóng góp, tương tự với một tên mà quá trình lắp ráp riêng của provider đã ghi. Không có gì được đóng dấu vào tệp như vậy để cho biết component nào đã ghi nó, vì nó thuộc về mọi component đã khai báo nó. Một mục có template render ra rỗng sẽ không ghi tệp nào. Các mục không được chuyển cho provider; provider ghi phần còn lại của đầu ra boundary mà không đọc chúng. Ở dạng object, $import không được khớp với ^oci://; giá trị nào khớp sẽ bị từ chối. Khóa: Khóa đặt tên cho tệp, nên nó bị giới hạn trong một tên tệp duy nhất, theo quy tắc mà một khóa artifacts tuân theo: bắt đầu bằng một chữ cái hoặc chữ số và tiếp tục bằng chữ cái, chữ số, dấu chấm, dấu gạch nối hoặc dấu gạch dưới. Một / sẽ khiến một khóa đặt tên cho một đường dẫn thay vì một tệp, và một . ở đầu sẽ cho phép .., vốn chỉ tới một vị trí bên ngoài thư mục đầu ra của boundary — lớp ký tự đầu tiên từ chối cả hai. Với một library import, khóa đặt tên cho thư mục mà các tệp của bundle được lồng bên dưới, nên cùng giới hạn đó được áp dụng. Mẫu: ^[A-Za-z0-9][A-Za-z0-9._-]*$. Ít nhất 1 mục. |
Không cho phép thuộc tính bổ sung.
recipe.spec.pipeline[]
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
id | string | có | Một định danh lập trình cho bước này, duy nhất giữa các bước của pipeline này: một tài liệu khai báo một id trên hai bước của nó sẽ bị từ chối khi được đọc. Một bước sau trong cùng pipeline đọc đầu ra của bước này dưới dạng .steps.<id>.outputs. Mẫu: ^[a-zA-Z0-9_]+$. |
plugin | string | có | Tham chiếu đến thực thể Plugin mà bước này chạy, luôn được giới hạn phạm vi theo loại socket riêng của plugin: <pluginType>/<name> với một phiên bản tùy chọn, như trong parser/yaml hoặc parser/yaml:1.0.0. Phạm vi là bắt buộc chứ không phải một dạng trong số nhiều dạng — một name:version không có phạm vi sẽ bị từ chối, vì hai socket có thể chứa plugin cùng tên và phạm vi là thứ khiến thực thể có thể được phân giải. Quá trình build phân giải thực thể thành artifact .wasm được định địa chỉ theo nội dung của nó — được định vị từ danh tính của plugin và registry đã cấu hình, với digest được ghim trong lockfile — và tải các byte. Một tham chiếu .wasm hoặc artifact trần không được chấp nhận ở đây. |
function | string | có | Hàm Wasm được export cần gọi. |
with | string | không | Template Go nội tuyến được đánh giá thành một map JSON/YAML thỏa mãn nghiêm ngặt schema đầu vào tường minh của plugin này. |
optional | boolean | không | Khi là true, một lỗi của bước này (một guest trap, một patch nhắm đến tài liệu không có trong tập, một patch sai định dạng, hoặc một chẩn đoán ở mức halt) được hạ xuống thành một cảnh báo rõ ràng: tập tài liệu trước bước được khôi phục, đầu ra của bước này bị loại bỏ, và pipeline tiếp tục. Khi là false hoặc vắng mặt, mọi lỗi của bước sẽ dừng quá trình build sau khi khôi phục tập tài liệu trước bước. |
when | string | không | Template Go nội tuyến được đánh giá vào lúc duyệt pipeline. Khi nó kết xuất ra một giá trị falsy, bước bị bỏ qua — một bước chuyển tiếp: tập tài liệu đi đến bước tiếp theo mà không thay đổi, không đóng góp patch, tác dụng phụ hay bản ghi bước nào. Một when rỗng hoặc vắng mặt luôn chạy bước. Tính đúng sai tuân theo quy ước chuẩn cho đầu ra template dạng boolean: các chuỗi true/True/TRUE, mọi số khác không, và mọi chuỗi không rỗng khác là đúng, còn false/False/FALSE, chuỗi rỗng và số không là sai. when và optional độc lập với nhau: một bước có thể khai báo cả hai. |
Không cho phép thuộc tính bổ sung.