Bỏ qua để đến nội dung
AggregaAggrega
Chọn ngôn ngữ: Tiếng Việt
Trang này được dịch bằng máy. Đọc bản gốc tiếng Anh.

Lược đồ Aggrega Dependency Lockfile (Manifest)

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/manifest-v1beta1.schema.json

Một lockfile toàn cục duy nhất ánh xạ các kiểu component và Feature trừu tượng tới các triển khai Recipe và FeatureRecipe cụ thể, theo kiểu, với khả năng ghi đè theo từng instance bằng tên.

Xem tài liệu tham khảo về cách viết Manifest để có hướng dẫn bằng văn xuôi về cách viết các thực thể Manifest; 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ínhLoạiBắt buộcMô tả
apiVersionconst “aggrega.ai/v1beta1”cóHằng số: "aggrega.ai/v1beta1"
kindconst “Manifest”cóHằng số: "Manifest"
metadataobjectcó
defsstring[]khôngKhối tùy chọn dành cho các anchor YAML tiêu chuẩn (& và *) để giữ cho Manifest theo nguyên tắc DRY trong khi vẫn duy trì một từ điển O(1) phẳng cho trình biên dịch.
specobjectcóCác khai báo ánh xạ của Manifest cùng với khả năng kế thừa từ cơ sở (tùy chọn): mappings kết nối các loại component và feature trừu tượng với các triển khai Recipe và FeatureRecipe cụ thể; extends kế thừa các ánh xạ từ một Manifest cơ sở.

Không cho phép thuộc tính bổ sung.

manifest.metadata

Thuộc tínhLoạiBắt buộcMô tả
namestringcóDài ít nhất 1 ký tự.
versionstringcóPhiên bản theo Semantic Versioning nghiêm ngặt của lockfile manifest (ví dụ: 1.0.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-]+)*))?$.
descriptionstringkhôngThực thể này là gì và dùng để làm gì, viết cho người đang cân nhắc có nên 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ó kỳ vọng gì từ Release sử dụng 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 văn ngắn.
maintainersobject[]khôngDanh sách những người bảo trì sở hữu thực thể này.
licensestringkhôngMã đị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.
repositorystringkhôngURL đến kho Git chứa các tệp nguồn.
homestringkhôngURL của trang chủ, wiki hoặc tài liệu của thực thể này.
keywordsstring[]khôngDanh 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.

manifest.metadata.maintainers[]
Thuộc tínhLoạiBắt buộcMô tả
namestringcó
emailstringkhông
urlstringkhông

Không cho phép thuộc tính bổ sung.

manifest.spec

Các khai báo ánh xạ của Manifest cùng với khả năng kế thừa từ cơ sở (tùy chọn): mappings kết nối các loại component và feature trừu tượng với các triển khai Recipe và FeatureRecipe cụ thể; extends kế thừa các ánh xạ từ một Manifest cơ sở.

Thuộc tínhLoạiBắt buộcMô tả
extendsstringkhôngURI của một Manifest cơ sở để kế thừa ánh xạ. Với cùng một khóa, ánh xạ của con sẽ thay thế ánh xạ của cơ sở.
mappingsobjectcóÁnh xạ các giao diện trừu tượng tới các triển khai cụ thể. Khai báo ánh xạ dưới các khóa cấp cao nhất ‘components’ và ‘features’, mỗi khóa ánh xạ trực tiếp các URI loại component / loại feature tới các URI Recipe / FeatureRecipe. Hai khóa này là toàn bộ bề mặt; không chấp nhận khóa nào khác ở đây. Ánh xạ không phụ thuộc vào capability ở tầng Manifest — việc xác định capability đến từ spec.capability của mỗi Recipe đã được phân giải khi Aggrega build Release. Khóa: Một trong "components", "features".

Không cho phép thuộc tính bổ sung.

manifest.spec.mappings

Ánh xạ các giao diện trừu tượng tới các triển khai cụ thể. Khai báo ánh xạ dưới các khóa cấp cao nhất ‘components’ và ‘features’, mỗi khóa ánh xạ trực tiếp các URI loại component / loại feature tới các URI Recipe / FeatureRecipe. Hai khóa này là toàn bộ bề mặt; không chấp nhận khóa nào khác ở đây. Ánh xạ không phụ thuộc vào capability ở tầng Manifest — việc xác định capability đến từ spec.capability của mỗi Recipe đã được phân giải khi Aggrega build Release.

Thuộc tínhLoạiBắt buộcMô tả
componentsmapping_tierkhôngÁnh xạ từ Component-type sang URI của Recipe. Một URI của Recipe có tối đa hai phân đoạn — một capability tùy chọn ở đầu, sau đó là tên recipe — cộng với một phiên bản tùy chọn; một tham chiếu có phân đoạn thứ ba sẽ không khớp với recipe nào. Các dạng phiên bản: chính xác (‘postgres-bitnami:1.2.0’), khoảng (‘postgres-bitnami:^1.2.0’), hoặc không có phiên bản (‘postgres-bitnami’); bộ phân giải ghim phiên bản đã phân giải vào lockfile ở lần phân giải đầu tiên. Ngoài ra, một tham chiếu có thể được định danh theo capability (‘terraform/mariadb-rds:1.0.0’, phân đoạn trước dấu ’/’ đầu tiên là spec.capability của recipe) — điều này là bắt buộc khi có nhiều hơn một recipe cùng tên; một tham chiếu trần không rõ ràng sẽ dừng việc phân giải kèm thông báo rõ ràng thay vì âm thầm chọn một recipe.
featuresmapping_tierkhôngÁnh xạ từ loại feature tới URI FeatureRecipe. Bao gồm cả các Features vận hành và các Features thông tin xác thực (được gắn nhãn feature.aggrega.ai/kind: secret).

Khóa: Một trong "components", "features".

Không cho phép thuộc tính bổ sung.

Định nghĩa

mapping_tier

Phân giải hai tầng: ‘type’ ánh xạ theo loại trong catalog (hàng loạt, DRY), ‘name’ ánh xạ theo tên thể hiện (ghi đè chi tiết). Cả hai đều tùy chọn nhưng phải có ít nhất một. Khi phân giải, name được ưu tiên hơn type. Các khóa type có phiên bản được ưu tiên hơn khóa không có phiên bản.

Thuộc tínhLoạiBắt buộcMô tả
typemap của stringkhôngÁnh xạ các URI loại trong catalog tới các URI Recipe. Hỗ trợ khóa có phiên bản (‘core/api-server:1.0.0’) để khớp chính xác, khóa khoảng (‘core/api-server:^1.0.0’) để khớp tương thích theo phiên bản chính, hoặc khóa không có phiên bản (‘core/api-server’) để khớp với mọi phiên bản.
namemap của stringkhôngÁnh xạ các tên thể hiện cụ thể tới các URI Recipe. Được ưu tiên hơn ánh xạ dựa trên loại.
annotationsmap của objectkhôngCác lối tắt Feature dựa trên annotation. Ánh xạ các khóa annotation tới một URI của Feature cùng một bảng định tuyến được nhóm theo pillar, từ subkey dạng đường dẫn có dấu chấm tới pillar của Feature (values hoặc infra). Việc xác thực dựa trên khai báo spec.schema.. của Feature đích; binding chỉ khai báo việc định tuyến. URI của Feature được tham chiếu bởi ‘feature’ CŨNG PHẢI xuất hiện trong phần ‘type’ (đó là nơi chứa binding phiên bản của FeatureRecipe).

Không cho phép thuộc tính bổ sung.