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.

Schema lockfile theo từng Release của Aggrega

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 của schema: https://aggrega.ai/schemas/lockfile-v1beta1.schema.json

Lockfile do máy sinh ra, ghim mọi URI được phân giải từ một Release để các lần build sau này có tính tất định. Nằm tại <release-stem>.lock bên cạnh <release-stem>.yaml; được tạo bởi aggrega pull --release <release>; được dùng bởi aggrega build --release <release>. Hai dạng nguồn gốc ghi lại hai quan hệ khác nhau trong đồ thị phụ thuộc: referenced_from (danh sách chuỗi) xuất hiện trên entities, dưới dạng các đường dẫn vị trí soạn thảo phân cách bằng dấu chấm ghi lại mỗi URI được kéo vào từ đâu trong Release / Aggregate / Manifest / .aggrega-config.yaml, và trên plugins, dưới dạng tham chiếu của từng thực thể Plugin mà qua đó một artifact được tiếp cận; consumers (danh sách các bản ghi {consumer_uri, fragments}) xuất hiện trên schema_libraries, mapping_libraries, workload_libraries và artifact_libraries để ghi lại thực thể catalog nào tham chiếu những fragment <entry-name> nào của một thư viện — dạng có cấu trúc này giúp truy vết được các diff về consumer bị ảnh hưởng khi nâng phiên bản thư viện mà không cần phân giải lại Release. Nguyên tắc phát triển schema: thêm một phần cấp cao nhất mới là SemVer-MINOR (bổ sung); thêm một trường mới trong một phần hiện có là SemVer-MINOR; xóa một khóa hoặc thắt chặt một ràng buộc là SemVer-MAJOR.

Kiểu cấp cao nhất: object

Thuộc tính

Thuộc tínhLoạiBắt buộcMô tả
entitiesobject[]khôngCác thực thể catalog có thể truy cập được từ Release này: Component, Feature, Recipe, FeatureRecipe, Plugin, Aggregate, Aggregate và Manifest riêng của Release, và Manifest mà Manifest đó mở rộng. Mỗi mục được xác định bởi kind của nó cùng với URI chuẩn của nó, nên hai thực thể khác loại có cùng tên — chẳng hạn một Aggregate và một Manifest đều tên là imported/flow — là hai mục, mỗi mục được đối chiếu với digest riêng của nó. Mỗi mục ghi lại phiên bản đã phân giải, digest của nội dung mà thực thể mang theo, và các nguồn gốc tại vị trí soạn thảo (referenced_from) đã kéo URI vào closure phụ thuộc của Release. Một lockfile có các mục không mang kind nào là đã lỗi thời: aggrega pull --release <release> sẽ ghi lại nó. Mặc định: []
external_inputsExternalInput[]khôngCác đầu vào từ xa được ghim vào kho đầu vào định địa chỉ theo nội dung tại thời điểm thu nhận — nội dung mà quá trình render của một provider plugin sử dụng từ bên ngoài workspace, chẳng hạn các tài liệu schema từ xa hoặc các phụ thuộc chart không được vendor. Mỗi mục ghim một URL vào digest định danh các byte của nó trong kho. Build phục vụ các đầu vào đã ghim từ kho và đọc phần này mà không cần truy cập mạng. Mặc định: []
generated_atstringcóDấu thời gian RFC 3339 của lần pull đã tạo ra lockfile này; mẫu (pattern) buộc giá trị theo đúng định dạng đó khi lockfile được nạp. Nguồn gốc mang tính chẩn đoán — ghi lại thời điểm thực của việc phân giải. Thay đổi có chủ đích giữa các lần pull; không thuộc đảm bảo đồng nhất từng byte của lockfile. Mẫu: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d+)?(Z|[+-]\d{2}:\d{2})$.
mapping_librariesLibraryEntry[]khôngCác mục MappingLibrary mà closure phụ thuộc của Release đi tới qua các vị trí valuesMapping: { $import: ... } của Recipe / FeatureRecipe. Danh sách consumers của mỗi mục ghi lại thực thể catalog nào tham chiếu những fragment <entry-name> nào của thư viện — một bản ghi có cấu trúc giúp truy vết được các diff tác động khi nâng phiên bản thư viện mà không cần phân giải lại Release. Mặc định: []
mutatorsobject[]khôngCác attachment quản trị vai trò transform đã được phân giải, theo thứ tự soạn thảo. Một plugin vai trò transform (label-transform, viết lại nhãn node; hoặc annotation-transform, chèn annotation trước khi mở rộng) định hình các byte đầu ra được render, vì vậy tập attachment — danh sách có thứ tự, cùng với vai trò, tọa độ plugin và hàm export của từng attachment — là một đầu vào quyết định byte được ghim tại đây. Build đọc phần này — không bao giờ đọc .aggrega-config.yaml — để tái dựng tập hợp, thứ tự, vai trò và hàm export, nên đầu ra build không bị ảnh hưởng bởi thay đổi plugins.governance thực hiện sau lần pull (chỉ được áp dụng ở lần pull kế tiếp). Thứ tự mang NGỮ NGHĨA: mỗi runner transform áp dụng các attachment của vai trò mình theo thứ tự danh sách, nên khác với các phần plugins / providers được sắp xếp theo URI, danh sách này không bao giờ bị sắp xếp lại. Digest nội dung của plugin KHÔNG bị lặp lại ở đây: nó chỉ có một nguồn duy nhất trong các phần plugins và entities, mà bản ghi này trỏ tới theo định danh. Mặc định: []
pluginsobject[]khôngCác Wasm plugin có byte định hình đầu ra đã render, mỗi plugin được ghim bằng digest nội dung của .wasm của nó: một governance plugin được gắn ở vai trò transform (label-transform, annotation-transform) dưới .aggrega-config.yaml plugins.governance, cùng mọi URI plugin nhúng từ các Recipes / FeatureRecipes / Providers được tham chiếu. Một governance plugin được gắn ở vai trò verdict (ir-verdict, render-verdict) và một đính kèm plugins.linter trả về một verdict và không định hình byte đầu ra nào, nên cả hai đều không được ghim: cả hai đều không xuất hiện ở đây hay dưới entities, và các tệp quy tắc mà một đính kèm verdict đọc được ghi dưới verdict_inputs. Mặc định: []
providersobject[]khôngCác lựa chọn provider theo từng capability đã được phân giải. Mỗi mục ghim một capability (ví dụ helm) vào định danh OCI không chứa digest của plugin render provider đảm nhận việc render nó, được phân giải lúc pull từ danh sách plugins.providers trong .aggrega-config.yaml (khi capability được nhiều plugin phục vụ, gây mơ hồ) hoặc từ plugin phục vụ duy nhất (khi không mơ hồ). Build đọc phần này — không bao giờ đọc .aggrega-config.yaml — để chọn provider, nên đầu ra build không bị ảnh hưởng bởi các thay đổi cấu hình workspace thực hiện sau lần pull. Digest nội dung của plugin KHÔNG bị lặp lại ở đây: nó chỉ có một nguồn duy nhất trong các phần plugins và entities, mà bản ghi này trỏ tới theo định danh. Việc cùng tồn tại nhiều phiên bản được giữ nguyên: bản ghi này chọn kho plugin theo từng capability; các phiên bản cụ thể nằm trong entities (mỗi phiên bản plugin đã phân giải một mục), và ghim phiên bản spec.capability của mỗi Recipe chọn giữa chúng khi render. Mặc định: []
releasestringcóĐường dẫn tới Release mà lockfile này tương ứng, được phân giải tương đối so với thư mục của chính lockfile (ví dụ ./release-prod.yaml). Quy ước đặt tên theo từng Release đặt <release-stem>.lock cạnh <release-stem>.yaml; đường dẫn tương đối giúp lockfile tự mô tả mà không cần đường dẫn tuyệt đối phụ thuộc máy. Mục này định danh Release; nội dung Release chứa khi được phân giải được ghi lại dưới release_documents.
release_documentsobject[]khôngCác tệp Release mà quá trình phân giải đã đọc, mỗi tệp được ghi lại bằng digest nội dung của các byte của nó: trước tiên là Release mà lockfile này thuộc về, sau đó là từng Release mà nó mở rộng, theo thứ tự duyệt chuỗi extends. Mọi thứ một Release yêu cầu đều được phân giải từ nội dung nó chứa, nên một Release bị chỉnh sửa sau lần pull sẽ không còn khớp với digest đã ghi, và một build — hoặc aggrega pull --verify — sẽ dừng lại và nêu tên tệp, với aggrega pull --release <release> là cách khắc phục, trước khi bất cứ thứ gì được render. Digest bao phủ các byte đúng như hiện trạng, không chuẩn hóa bỏ đi thứ gì, cùng quy tắc mà các ghim Aggregate và Manifest tuân theo: một chỉnh sửa comment hay khoảng trắng cũng được tính là thay đổi. Một lockfile không có phần này không ghi lại tệp Release nào, và một build dùng lockfile đó sẽ báo Release là chưa được ghi lại. Một tệp mà Release nhập qua parameters không được ghi lại ở đây.
schema_librariesLibraryEntry[]khôngCác mục SchemaLibrary mà closure phụ thuộc của Release đi tới qua các vị trí $ref và $import: trong nội dung schema: / usesSchema: / featuresSchema: của thực thể. Danh sách consumers của mỗi mục ghi lại thực thể catalog nào tham chiếu những fragment <entry-name> nào của thư viện — một bản ghi có cấu trúc giúp truy vết được các diff tác động khi nâng phiên bản thư viện mà không cần phân giải lại Release. Mặc định: []
source_artifactsSourceArtifactEntry[]khôngCác artifact nguồn được kéo từ các trường spec.source của Recipe / FeatureRecipe tại thời điểm pull. Mỗi mục xác định một định danh {kind, url, chart, pinned_version} duy nhất cùng digest nội dung, mediatype và các con trỏ ngược có cấu trúc referenced_by: nêu tên mọi thực thể catalog đã phân giải tới artifact này. url là URL định danh được soạn thảo; vị trí artifact đã phân giải đối với một nguồn helm ở gốc repo được ghi riêng dưới resolved_url: như thông tin nguồn gốc. Nhiều Recipes ghim cùng một chart ở cùng phiên bản sẽ được gộp thành một mục duy nhất với nhiều bản ghi referenced_by:. Enum kind bao gồm bốn loại nguồn có thể phân giải, cùng terraform-module-oci, loại mà không source adapter nào phục vụ: một Recipe hoặc FeatureRecipe nêu tên nó bị từ chối ngay khi được đọc, nên không lần pull nào ghi một mục thuộc loại đó. Mặc định: []
toolchainobjectkhôngCác phiên bản của toolchain đã tạo ra lockfile này: phiên bản của chính trình biên dịch, và phiên bản của từng core plugin mà trình biên dịch mang theo. Được ghi lại để về sau lockfile trả lời được trình biên dịch nào và core plugin nào đã phân giải và render một build — câu hỏi mà các phần được ghim không phải lúc nào cũng trả lời được, vì một core provider plugin được phục vụ từ bên trong tệp nhị phân của trình biên dịch không được ghim và do đó không có phiên bản ghi lại của riêng nó. Chỉ gồm phiên bản: dấu này không bao giờ ghi lại nơi xuất xứ các byte của plugin, nên hai máy đã ghim cùng một closure phụ thuộc với cùng trình biên dịch sẽ ghi cùng một dấu. Không có gì so sánh phần này, cảnh báo về nó hay từ chối build vì nó, và việc lockfile thiếu phần này diễn ra im lặng: toolchain không thuộc closure phụ thuộc mà lockfile ghim. Cũng vì lý do đó, phần này được miễn trong phép so sánh đồng nhất từng byte giữa hai lần pull của cùng đầu vào, ngang hàng với generated_at.
verdict_inputsobject[]khôngCác đầu vào quy tắc bên ngoài mà một đính kèm governance vai trò verdict (ir-verdict / render-verdict) đọc tại thời điểm biên dịch — một tệp quy tắc Kyverno / Rego được cung cấp qua with.sources của đính kèm. Được ghi dưới dạng một digest nội dung cho mỗi nguồn, phục vụ kiểm toán và khả năng thấy độ lệch giữa các lần pull: digest đã định hình một verdict có thể so sánh khác biệt giữa các lần pull, nên một tệp quy tắc bị thay đổi sẽ hiện ra như một khác biệt của lockfile. Phần này là NGUỒN GỐC, không phải đầu vào build: khác với mutators.sources, nó không mang content, và build KHÔNG đọc nó — một plugin verdict được cache thay vì được ghim và đọc trực tiếp các đầu vào quy tắc của nó (verdict không định hình byte đầu ra nào, nên không thứ gì mà lockfile ghim cho đầu ra tất định bao gồm nó). Vì một plugin verdict không được ghim, nó vắng mặt trong các phần entities / plugins; do đó bản ghi này xác định đính kèm bằng URI được viết của nó, tự đứng độc lập thay vì trỏ vào các phần đó. Việc ghi digest giúp các đầu vào đã quyết định một quyết định chấp nhận/từ chối có thể kiểm toán và tái lập mà không cần pin chúng vào build. Mặc định: []
versionconst 1cóPhiên bản schema của lockfile: 1. Một thay đổi SemVer-MAJOR đối với schema sẽ tăng giá trị này. Hằng số: 1
workload_librariesLibraryEntry[]khôngCác mục WorkloadLibrary mà closure phụ thuộc của Release đi tới qua các vị trí workload: { $import: ... } của Recipe. Danh sách consumers của mỗi mục ghi lại thực thể catalog nào tham chiếu những fragment <entry-name> nào của thư viện — một bản ghi có cấu trúc giúp truy vết được các diff tác động khi nâng phiên bản thư viện mà không cần phân giải lại Release. Mặc định: []
artifact_librariesLibraryEntry[]khôngCác mục ArtifactLibrary mà closure phụ thuộc của Release đi tới qua các vị trí artifacts.<name>: { $import: ... } của Recipe / FeatureRecipe. Danh sách consumers của mỗi mục ghi lại thực thể catalog nào tham chiếu những bundle <entry-name> nào của thư viện — một bản ghi có cấu trúc giúp truy vết được các diff tác động khi nâng phiên bản thư viện mà không cần phân giải lại Release. Mặc định: []

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

lockfile.entities[]

Thuộc tínhLoạiBắt buộcMô tả
kindstring (enum)cóLoại của thực thể catalog, được đọc từ nơi mà Release, Aggregate của nó hoặc Manifest của nó nêu tên thực thể đó: component và feature cho một kiểu Component hoặc Feature mà Aggregate, Release hoặc một ánh xạ Manifest nêu tên, recipe và feature_recipe cho một hiện thực mà một ánh xạ Manifest liên kết, plugin cho một thực thể Plugin, aggregate cho Aggregate riêng của Release và mọi Aggregate mà nó bao gồm, và manifest cho Manifest riêng của Release và Manifest mà nó mở rộng. Cùng với uri, nó xác định mục: một bản build so sánh mỗi mục với thực thể có cùng loại và URI, nên một chỉnh sửa đối với bất kỳ thực thể nào trong hai thực thể cùng tên khác loại đều được nhận ra. Giá trị cho phép: "aggregate", "component", "feature", "feature_recipe", "manifest", "plugin", "recipe"
uristringcóURI chuẩn của thực thể catalog (ví dụ hub.aggrega.ai/component/core/compute/api-server).
resolved_versionstringcóPhiên bản cụ thể mà bộ phân giải đã chọn tại thời điểm pull — phiên bản riêng của một thực thể catalog (ví dụ 1.2.3), hoặc rỗng đối với một thực thể cấp cao nhất được phân giải theo đường dẫn thay vì theo phiên bản. Được ghi dưới dạng một đoạn đường dẫn duy nhất, vì nó đặt tên cho một đoạn, nên nó không chứa /, không chứa \ và không chứa ..: giá trị này tạo nên ô cache mà build đọc lại thực thể này từ đó, và một giá trị bước ra khỏi thư mục cache sẽ chỉ tới một vị trí nằm ngoài nó. Mẫu: ^([^/\\.]|\.[^/\\.])*\.?$.
digeststringcóDigest của nội dung mà một bản phát hành của thực thể mang theo, ở dạng sha256: theo sau là 64 ký tự hex chữ thường: SHA-256 trên tài liệu của thực thể và mọi tệp mà nó khai báo bên cạnh, được sắp xếp theo đường dẫn, mỗi tệp đóng góp đường dẫn của nó và SHA-256 của các byte của nó. Một thực thể không khai báo tệp nào được tính là một tài liệu duy nhất của nó. Không có gì khác tham gia vào — không phải cách một archive được nén, không phải dấu thời gian, không phải bất kỳ bit quyền nào, kể cả bit thực thi — nên thực thể ghi cùng một digest dù được đọc từ một thư mục catalog hay được tải về từ một registry, và trên bất kỳ bản checkout nào của cùng các tệp, trên bất kỳ hệ thống nào. Mẫu: ^sha256:[a-f0-9]{64}$.
manifest_digeststringkhôngDigest manifest OCI của artifact đã phân giải, ở dạng sha256: theo sau là 64 ký tự hex chữ thường. Chữ ký cam kết với digest này, và manifest nêu tên digest của các byte đã phát hành, mà một lần tải về và một lần đọc từ cache được kiểm tra đối chiếu trước khi thực thể được đối chiếu với digest ở trên. Chỉ có mặt đối với một thực thể được phân giải từ registry. Mẫu: ^sha256:[a-f0-9]{64}$.
referenced_fromstring[]khôngNguồn gốc vị trí soạn thảo — các đường dẫn phân cách bằng dấu chấm vào YAML của Release / Aggregate / Manifest (ví dụ aggregate.spec.components.api.type) ghi lại lý do URI này nằm trong closure phụ thuộc của Release. Mặc định: []
signatureVerifiedSignaturekhôngDữ kiện chữ ký đã xác minh, được ghi khi chữ ký của thực thể này được xác minh tại thời điểm pull, theo chính sách tin cậy của registry phân giải.
deprecationDeprecationRecordkhôngDấu hiệu ngừng hỗ trợ hồi tố đã xác minh, được ghi khi phát hiện một dấu hiệu ngừng hỗ trợ đã ký và đáng tin cậy trên artifact này tại thời điểm pull. Một dấu hiệu là một OCI referrer đã ký của artifact mà nó đánh dấu ngừng hỗ trợ, được đính kèm sau khi phát hành mà không cần phát hành lại artifact. Ghi lại mức độ nghiêm trọng và thông điệp của dấu hiệu cùng với người ký đã xác minh đã tạo ra nó. Build đọc dữ kiện này và áp dụng chính sách ngừng hỗ trợ chỉ từ lockfile; nó không bao giờ phát hiện lại hay xác minh lại dấu hiệu.

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

lockfile.mutators[]

Thuộc tínhLoạiBắt buộcMô tả
pluginstringcóTọa độ plugin đã phân giải của plugin vai trò transform — định danh <pluginType>/<name> của một thực thể Plugin (ví dụ governance/tag-injector). Nối theo định danh vào các phần plugins và entities để lấy digest đã pin và tập phiên bản.
rolestring (enum)cóVai trò transform mà đính kèm này được gắn vào, được ghi nguyên văn từ mục plugins.governance đã viết, nên một build chạy đính kèm đúng ở vai trò đó thay vì suy đoán một vai trò: label-transform viết lại nhãn node khi dựng topology; annotation-transform chèn annotation trước khi mở rộng, trong quá trình phân giải. Giá trị cho phép: "label-transform", "annotation-transform"
functionstringkhôngExport ghi đè mà đính kèm nêu tên. Khi vắng mặt sẽ chọn export mặc định của vai trò (mutate cho label-transform, transform_annotations cho annotation-transform).
settingsobjectkhôngĐối tượng cài đặt dạng tự do mà đính kèm đã khai báo, được pin như đã viết và chuyển nguyên văn cho plugin. Build đọc cài đặt từ đây — không bao giờ từ cấu hình trực tiếp — nên một thay đổi cài đặt sau khi pull không làm thay đổi đầu ra build. Vắng mặt khi đính kèm không khai báo gì.
sourcesobject[]khôngCác pin định địa chỉ theo nội dung của các tệp nguồn mà đính kèm đã khai báo, theo thứ tự tên cơ sở. Build tái dựng nguồn mà plugin đọc từ nội dung đã ghi của mỗi pin thay vì đọc trực tiếp từ host, nên đầu ra build không thay đổi khi tệp nguồn bị thay đổi sau khi pull. Vắng mặt khi đính kèm không khai báo gì.

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

lockfile.mutators[].sources[]
Thuộc tínhLoạiBắt buộcMô tả
contentstringcóNội dung của tệp nguồn, được mang nguyên văn để build tái dựng đầu vào nguồn của plugin từ lockfile.
digeststringcóĐịa chỉ nội dung của nội dung đã ghi, ở dạng sha256: theo sau là 64 ký tự hex chữ thường. Một lần pull lại so sánh tệp gốc với digest này để phát hiện độ lệch. Mẫu: ^sha256:[a-f0-9]{64}$.
pathstringcóTên cơ sở của tệp nguồn — không bao giờ là đường dẫn tuyệt đối trên host, nên pin có tính di động và tất định.

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

lockfile.plugins[]

Thuộc tínhLoạiBắt buộcMô tả
uristringcóĐịnh danh thuần của artifact .wasm của plugin Wasm — đường dẫn <pluginType>/<name> (ví dụ governance/aggrega-security-baseline). Phân đoạn đầu tiên là loại của plugin (provider, linter, pipeline-step, governance, cli, parser, importer); phân đoạn sau đó là tên của plugin. Loại cùng với tên tạo thành định danh của plugin — cùng một tên dưới hai loại là hai plugin. Vị trí tải về vật lý được suy ra từ định danh này cộng với registry đã cấu hình, không bao giờ được lưu trong lockfile.
resolved_versionstringcóDigest nội dung mà artifact Wasm được phân giải thành, ở dạng sha256: theo sau là 64 ký tự hex chữ thường. Một artifact plugin được định địa chỉ theo nội dung thay vì đặt tên theo phiên bản — một tệp .wasm nằm trực tiếp trong manifest plugin của nó và được ghim bằng digest của các byte của nó — nên trường này ghi lại digest đó, cũng chính là digest bên dưới. Nó tạo nên ô cache mà quá trình build đọc lại artifact từ đó, nên nó không chứa /, \ hay .., điều mà dạng sha256: vốn đã loại trừ. Mẫu: ^sha256:[a-f0-9]{64}$.
digeststringcóDigest nội dung của artifact Wasm đã phân giải, ở dạng sha256: theo sau là 64 ký tự hex chữ thường — dạng mà địa chỉ nội dung được viết ở mọi nơi nó được so sánh. Mẫu: ^sha256:[a-f0-9]{64}$.
manifest_digeststringkhôngDigest manifest OCI của artifact Wasm đã phân giải, ở dạng sha256: theo sau là 64 ký tự hex chữ thường. Chữ ký cam kết với digest này; digest nội dung ở trên là định danh di động dùng cho việc ghim cache và kiểm tra tính toàn vẹn. Chỉ có mặt đối với artifact được phân giải từ registry. Mẫu: ^sha256:[a-f0-9]{64}$.
referenced_fromstring[]khôngLý do artifact này nằm trong closure phụ thuộc của Release: tham chiếu của từng thực thể Plugin mà qua đó nó được tiếp cận, theo dạng mà phần entities ghi thực thể đó (ví dụ governance/label-injector:1.0.0). Mặc định: []
signatureVerifiedSignaturekhôngDữ kiện chữ ký đã xác minh, được ghi lại khi chữ ký của plugin này được xác minh tại thời điểm pull, theo cùng chính sách tin cậy theo từng registry như các thực thể catalog.
deprecationDeprecationRecordkhôngDấu hiệu ngừng hỗ trợ hồi tố đã xác minh, được ghi khi phát hiện một dấu hiệu ngừng hỗ trợ đã ký và đáng tin cậy trên artifact này tại thời điểm pull. Một dấu hiệu là một OCI referrer đã ký của artifact mà nó đánh dấu ngừng hỗ trợ, được đính kèm sau khi phát hành mà không cần phát hành lại artifact. Ghi lại mức độ nghiêm trọng và thông điệp của dấu hiệu cùng với người ký đã xác minh đã tạo ra nó. Build đọc dữ kiện này và áp dụng chính sách ngừng hỗ trợ chỉ từ lockfile; nó không bao giờ phát hiện lại hay xác minh lại dấu hiệu.

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

lockfile.providers[]

Thuộc tínhLoạiBắt buộcMô tả
capabilitystringcóCapability mà liên kết này chọn provider cho — tên capability thuần mà một Recipe liên kết qua spec.capability (ví dụ helm, compose).
pluginstringcóĐịnh danh thuần của plugin kết xuất provider đã phân giải (định danh của thực thể Plugin, tức metadata.pluginType và metadata.name của nó nối với nhau bằng dấu gạch chéo, ví dụ provider/helm). Liên kết theo định danh vào các phần plugins và entities để lấy digest đã ghim và tập phiên bản.

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

lockfile.release_documents[]

Thuộc tínhLoạiBắt buộcMô tả
digeststringcóDigest nội dung của các byte trong tệp Release tại thời điểm quá trình phân giải đọc chúng, ở dạng sha256: theo sau là 64 ký tự hex chữ thường. Mẫu: ^sha256:[a-f0-9]{64}$.
pathstringcóĐường dẫn của tệp Release, tương đối với thư mục chứa Release mà lockfile này thuộc về, dùng dấu gạch chéo xuôi (ví dụ release-prod.yaml, ../shared/base-release.yaml) — không bao giờ là đường dẫn tuyệt đối trên máy chủ, nên bản ghi có tính di động và tất định.

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

lockfile.toolchain

Các phiên bản của toolchain đã tạo ra lockfile này: phiên bản của chính trình biên dịch, và phiên bản của từng core plugin mà trình biên dịch mang theo. Được ghi lại để về sau lockfile trả lời được trình biên dịch nào và core plugin nào đã phân giải và render một build — câu hỏi mà các phần được ghim không phải lúc nào cũng trả lời được, vì một core provider plugin được phục vụ từ bên trong tệp nhị phân của trình biên dịch không được ghim và do đó không có phiên bản ghi lại của riêng nó. Chỉ gồm phiên bản: dấu này không bao giờ ghi lại nơi xuất xứ các byte của plugin, nên hai máy đã ghim cùng một closure phụ thuộc với cùng trình biên dịch sẽ ghi cùng một dấu. Không có gì so sánh phần này, cảnh báo về nó hay từ chối build vì nó, và việc lockfile thiếu phần này diễn ra im lặng: toolchain không thuộc closure phụ thuộc mà lockfile ghim. Cũng vì lý do đó, phần này được miễn trong phép so sánh đồng nhất từng byte giữa hai lần pull của cùng đầu vào, ngang hàng với generated_at.

Thuộc tínhLoạiBắt buộcMô tả
compiler_versionstringcóPhiên bản của trình biên dịch đã ghi lockfile này, ở dạng không có chữ v mà mọi bề mặt của Aggrega báo cáo (1.2.0, không phải v1.2.0). Một bản build có đóng dấu phiên bản ghi lại phiên bản đó — một bản build release có gắn tag ghi lại tag của nó — và một bản build không mang dấu phiên bản ghi lại dấu (devel), để lockfile do một trình biên dịch không đóng dấu tạo ra không bị nhầm là đầu ra release. Được ghi dưới dạng một phân đoạn đường dẫn duy nhất, nên nó không chứa /, \ hay ... Mẫu: ^([^/\\.]|\.[^/\\.])*\.?$.
core_pluginsobject[]cóPhiên bản của từng plugin lõi mà trình biên dịch mang theo, mỗi plugin một mục, sắp xếp theo tọa độ plugin. Một plugin lõi được phát hành trên chính tag của trình biên dịch với cùng phiên bản, nên các phiên bản này giống nhau dù trình biên dịch phục vụ plugin từ bên trong chính nó hay tải nó từ một registry — đó là điều giữ cho dấu ghi không chứa chi tiết riêng của máy. Rỗng đối với bản build không mang plugin lõi nào. Mặc định: []

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

lockfile.toolchain.core_plugins[]
Thuộc tínhLoạiBắt buộcMô tả
pluginstringcóTọa độ của plugin lõi — định danh <pluginType>/<name> của một thực thể Plugin (ví dụ provider/helm), cùng định danh mà các phần providers và mutators dùng để gọi tên một plugin.
versionstringcóPhiên bản của plugin lõi này, ở dạng không có chữ v mà mọi bề mặt của Aggrega báo cáo. Được ghi dưới dạng một phân đoạn đường dẫn duy nhất, nên nó không chứa /, \ hay ... Mẫu: ^([^/\\.]|\.[^/\\.])*\.?$.

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

lockfile.verdict_inputs[]

Thuộc tínhLoạiBắt buộcMô tả
pluginstringcóURI plugin được soạn của attachment verdict, như được viết trong .aggrega-config.yaml plugins.governance (ví dụ governance/aggrega-security-baseline:1.0.0). Xác định attachment mà các đầu vào quy tắc đã ghi thuộc về; một plugin verdict được cache thay vì được ghim, nên không có mục nào trong các phần plugins / entities để liên kết tới.
rolestring (enum)cóVai trò verdict mà attachment này được gắn vào — ir-verdict (tại bước phân tích tĩnh, trên đồ thị IR) hoặc render-verdict (tại bước kết xuất, trên các artifact đã kết xuất). Phân biệt cùng một plugin được gắn ở cả hai giai đoạn verdict, mỗi giai đoạn có thể có các đầu vào quy tắc riêng. Giá trị cho phép: "ir-verdict", "render-verdict"
sourcesobject[]khôngCác digest nội dung của các tệp đầu vào quy tắc mà attachment khai báo, theo thứ tự tên cơ sở. Vắng mặt khi attachment không khai báo nguồn nào.

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

lockfile.verdict_inputs[].sources[]
Thuộc tínhLoạiBắt buộcMô tả
digeststringcóĐịa chỉ nội dung của các byte trong tệp đầu vào quy tắc tại thời điểm pull, ở dạng sha256: theo sau là 64 ký tự hex chữ thường. Một lần pull lại sẽ tính lại nó, nên một tệp quy tắc bị thay đổi sẽ hiện ra dưới dạng diff của lockfile. Mẫu: ^sha256:[a-f0-9]{64}$.
pathstringcóTên cơ sở của tệp đầu vào quy tắc — không bao giờ là đường dẫn tuyệt đối trên máy chủ, nên bản ghi có tính di động và tất định.

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

Định nghĩa

DeprecationRecord

Dấu hiệu ngừng hỗ trợ hồi tố đã xác minh, được ghi khi phát hiện một dấu hiệu ngừng hỗ trợ đã ký và đáng tin cậy trên artifact này tại thời điểm pull. Một dấu hiệu là một OCI referrer đã ký của artifact mà nó đánh dấu ngừng hỗ trợ, được đính kèm sau khi phát hành mà không cần phát hành lại artifact. Ghi lại mức độ nghiêm trọng và thông điệp của dấu hiệu cùng với người ký đã xác minh đã tạo ra nó. Build đọc dữ kiện này và áp dụng chính sách ngừng hỗ trợ chỉ từ lockfile; nó không bao giờ phát hiện lại hay xác minh lại dấu hiệu.

Thuộc tínhLoạiBắt buộcMô tả
messagestringcóThông điệp ngừng hỗ trợ dễ đọc do dấu đánh dấu mang theo — thường là một chỉ dẫn di chuyển.
severitystring (enum)cóMức độ nghiêm trọng của dấu đánh dấu, theo thứ tự warning < error < retracted. Bản build dừng lại khi mức độ này đạt hoặc vượt ngưỡng dừng đã cấu hình, và phát ra một cảnh báo tư vấn trong trường hợp ngược lại. Giá trị cho phép: "warning", "error", "retracted"
signerVerifiedSignaturekhôngNgười ký đã được xác minh của dấu đánh dấu, được ghi theo cùng cách với người ký của chữ ký artifact: subject/issuer của chứng chỉ đối với keyless, hoặc fingerprint của khóa được ghim đối với keyed. Một dấu đánh dấu tự nó là một artifact đã ký, nên người ký của nó có cùng dạng với chữ ký artifact — và bundle_digest ở đây chỉ gói chữ ký riêng của dấu đánh dấu chứ không phải của artifact bị ngừng hỗ trợ.

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

ExternalInput

Một đầu vào bên ngoài đã được ghim: URL mà một lần render yêu cầu, ghim SHA-256 đặt tên cho các byte của nó trong kho đầu vào định địa chỉ theo nội dung (sha256/<digest>), kích thước payload, và nguồn gốc của các consumer đã yêu cầu nó. Ghim là có thẩm quyền — một URL đã ghim luôn được phục vụ từ kho, và việc nạp lại kho được xác minh với digest này trước khi các byte đến được một lần render.

Thuộc tínhLoạiBắt buộcMô tả
required_bystring[]cóNguồn gốc — các vị trí render đã yêu cầu đầu vào này. Được sắp xếp và loại bỏ trùng lặp bởi trình ghi lockfile.
sha256stringcóGhim SHA-256 ở dạng hex chữ thường. Với đầu vào https, đây là digest của các byte payload; với đầu vào oci, đây là manifest digest mà tham chiếu được phân giải tới. Đặt tên cho blob trong kho tại sha256/<digest>. Mẫu: ^[0-9a-f]{64}$.
sizeintegercóKích thước tính bằng byte của payload đã ghim. Số byte không bao giờ âm. Tối thiểu: 0.
urlstringcóURL đầu vào như được viết tại vị trí render — khóa tra cứu khớp một yêu cầu lúc render với ghim của nó.

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

LibraryEntry

Dạng chung được dùng bởi các mục schema_libraries, mapping_libraries, workload_libraries và artifact_libraries. Danh sách consumers ghi lại quan hệ trong đồ thị catalog — thực thể catalog nào tham chiếu các fragment <entry-name> nào của thư viện này — hỗ trợ các diff tác động có cấu trúc khi digest của thư viện thay đổi. Một thư viện là một OCI artifact như mọi artifact khác, nên nó ghi lại cùng các dữ kiện đã xác minh như một thực thể catalog: manifest digest mà chữ ký của nó cam kết, bản thân chữ ký đã xác minh, và mọi dấu đánh dấu ngừng hỗ trợ hồi tố đã xác minh được phát hiện lúc pull.

Thuộc tínhLoạiBắt buộcMô tả
uristringcóURI chuẩn của thực thể thư viện.
resolved_versionstringcóPhiên bản cụ thể được phân giải lúc pull (chọn phiên bản tối thiểu trên đồ thị phụ thuộc thư viện) — phiên bản riêng của thư viện. Được ghi dưới dạng một đoạn đường dẫn duy nhất, vì nó tạo nên ô cache mà bản build đọc lại thư viện từ đó, nên nó không chứa /, không chứa \ và không chứa ..: một giá trị thoát ra khỏi thư mục cache sẽ chỉ tới một vị trí bên ngoài nó. Mẫu: ^([^/\\.]|\.[^/\\.])*\.?$.
digeststringcóDigest nội dung của artifact thư viện đã phân giải, ở dạng sha256: theo sau là 64 ký tự hex chữ thường — dạng mà địa chỉ nội dung được viết ở mọi nơi nó được so sánh. Mẫu: ^sha256:[a-f0-9]{64}$.
manifest_digeststringkhôngOCI manifest digest của artifact thư viện đã phân giải, ở dạng sha256: theo sau là 64 ký tự hex chữ thường. Chữ ký cam kết với digest này; digest nội dung ở trên là định danh khả chuyển dùng cho ghim cache và kiểm tra toàn vẹn. Chỉ có mặt đối với thư viện được phân giải từ registry. Mẫu: ^sha256:[a-f0-9]{64}$.
signatureVerifiedSignaturekhôngDữ kiện chữ ký đã xác minh, được ghi khi chữ ký của thư viện này được xác minh lúc pull, theo cùng chính sách tin cậy theo từng registry như các thực thể catalog.
deprecationDeprecationRecordkhôngDấu đánh dấu ngừng hỗ trợ hồi tố đã xác minh được phát hiện trên thư viện này lúc pull. Bản build báo cáo nó và, khi workspace đã cấu hình một ngưỡng dừng mà mức độ nghiêm trọng được ghi đạt tới, sẽ dừng lại — nhờ vậy một thư viện bị rút lại sau khi phiên bản đã được ghim sẽ được thông báo ở mọi bản build thay vì chỉ lúc chọn phiên bản, bước mà một phiên bản được ghim tường minh bỏ qua.
consumersobject[]khôngCác bản ghi về thực thể catalog nào tham chiếu thư viện này và tại các fragment <entry-name> nào. Ghi lại fan-in: nhiều consumer trên mỗi thư viện, mỗi consumer có thể tham chiếu nhiều fragment. Mỗi bản ghi mang URI của consumer cùng tập fragment mà consumer đó kéo vào. Mặc định: []

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

LibraryEntry.consumers[]

Thuộc tínhLoạiBắt buộcMô tả
consumer_uristringcóURI chuẩn của thực thể catalog tham chiếu thư viện này: một Component hoặc Feature đối với thư viện schema, một Recipe hoặc FeatureRecipe đối với thư viện mapping, workload hoặc artifact, hoặc một thư viện khác cùng loại có các mục tham chiếu tới thư viện này.
fragmentsstring[]cóTập các fragment <entry-name> mà consumer này tham chiếu bên trong thư viện (ví dụ ["#/schemas/PortSpec", "#/schemas/EndpointSpec"]). Thứ tự được trình ghi chuẩn hóa theo thứ tự từ điển.

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

SourceArtifactEntry

Một ghim artifact nguồn duy nhất: danh tính {kind, url, chart, module_subdir, pinned_version}, digest nội dung xác minh lần pull, mediatype chuẩn, và các con trỏ ngược có cấu trúc tới mọi thực thể catalog đã phân giải tới artifact này. chart và module_subdir là hai thành phần bộ chọn — mỗi thành phần chỉ định những gì riêng URL không chỉ định được, đối với các kind cần đến nó.

Thuộc tínhLoạiBắt buộcMô tả
kindenumcóKind của nguồn. Xác định adapter nào đã phân giải artifact và mediatype nào được mong đợi. terraform-module-oci thuộc tập này, và không source adapter nào phục vụ nó: một Recipe hoặc FeatureRecipe nêu tên nó bị từ chối ngay khi được đọc. Giá trị cho phép: "helm-oci-chart", "helm-https-chart", "compose-https-fragment", "git-repository", "terraform-module-oci"
urlstringcóURL được viết — URL danh tính như được viết trong spec.source.url của Recipe. Với helm-https-chart, đây là gốc repo (dạng repo-root) hoặc tệp .tgz trực tiếp (dạng direct) đúng như đã viết; build tái tạo chính URL này khi offline, nên đây là danh tính ổn định mà ghim dùng làm khóa. Với git-repository, đó là URL repository có thể clone. Với helm-oci-chart, đó là tham chiếu registry. Với compose-https-fragment, đó là URL HTTPS của fragment. Vị trí artifact đã phân giải cho một nguồn helm dạng repo-root được ghi riêng dưới resolved_url: làm nguồn gốc.
chartstringkhôngTên chart cho một nguồn helm dạng repo-root (spec.source.chart của Recipe), là một phần của danh tính {kind, url, chart, module_subdir, pinned_version} để hai chart được phục vụ từ cùng một gốc repo ở cùng phiên bản được ghim vào các mục riêng biệt. Không có đối với nguồn .tgz trực tiếp, OCI, compose hoặc git, vì không nguồn nào trong số đó chọn một chart bên trong URL.
module_subdirstringkhôngThư mục bên trong một repository lấy từ git là artifact (spec.source.module_subdir của Recipe), là một phần của danh tính {kind, url, chart, module_subdir, pinned_version} để hai thư mục của cùng một repository ở cùng commit được ghim vào các mục riêng biệt. Không có khi toàn bộ repository là artifact, và với mọi kind tiếp cận artifact qua URL thay vì đi vào bên trong một bản clone.
pinned_versionstringcóPhiên bản cụ thể được ghim lúc pull. Với các kind helm-*, đó là phiên bản chart. Với git-repository, đó là commit mà tham chiếu được viết đã phân giải tới (KHÔNG phải ref tag/branch ban đầu — ref đó được ghi dưới requested_ref: trên mỗi mục referenced_by:, bất cứ khi nào Recipe có viết spec.source.ref:). Một build tìm mục này theo những gì Recipe đã viết: ref: được viết nếu có, so khớp với requested_ref: đã ghi, và giá trị đã ghim này trong trường hợp còn lại — nhờ vậy một Recipe nêu tên một tag sẽ phân giải tới commit mà tag đó được ghim, mà commit không bao giờ xuất hiện trong Recipe. Được ghi dưới dạng một đoạn đường dẫn duy nhất, vì nó tạo nên ô cache mà build đọc lại artifact từ đó, nên nó không chứa /, không chứa \ và không chứa ... Mẫu: ^([^/\\.]|\.[^/\\.])*\.?$.
resolved_urlstringkhôngChỉ để ghi nguồn gốc: vị trí artifact cụ thể mà URL được viết đã phân giải tới lúc pull. Với một nguồn helm dạng repo-root, đây là URL .tgz trực tiếp mà index của repository đã phân giải chart+version tới; nó được ghi để chẩn đoán và KHÔNG thuộc danh tính artifact. Không có khi vị trí đã phân giải trùng với URL được viết (nguồn .tgz trực tiếp, OCI, compose hoặc git).
digeststringcóDigest nội dung của archive .tar.gz đã phân giải, ở dạng sha256: theo sau là 64 ký tự hex chữ thường. Bước xác minh lúc build đọc các byte của ô cache, tính lại digest và so sánh nó với trường này; nếu không khớp, build sẽ dừng và báo cáo digest nội dung không khớp. Mẫu: ^sha256:[a-f0-9]{64}$.
manifest_digeststringkhôngDigest manifest OCI của artifact đã phân giải, ở dạng sha256: theo sau là 64 ký tự hex chữ thường. Manifest là gốc tin cậy độc lập để xác minh archive đã cache; digest nội dung ở trên là danh tính khả chuyển dùng cho ghim cache và kiểm tra toàn vẹn. Chỉ có đối với nguồn phân phối qua OCI (một helm-oci-chart). Mẫu: ^sha256:[a-f0-9]{64}$.
mediatypestringcóKiểu media chuẩn mà registry đã công bố (hoặc giá trị mặc định của loại đối với các loại không có siêu dữ liệu registry). Được ghi lại để làm thông tin nguồn gốc cho chẩn đoán.
referenced_bySourceArtifactReference[]cóCác thực thể catalog đã phân giải tới artifact này, được sắp xếp theo (uri, field) để đầu ra mang tính tất định. Một mục chỉ tồn tại vì một Recipe hoặc FeatureRecipe đã pull nó, nên danh sách không bao giờ rỗng. Ít nhất 1 mục.

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

SourceArtifactReference

Một con trỏ ngược duy nhất từ thực thể catalog → artifact nguồn. entity + uri cùng nhau xác định thực thể catalog; field chỉ đường dẫn phía nguồn bên trong spec của thực thể, nơi artifact được khai báo. requested_ref: tùy chọn lưu lại spec.source.ref: mà Recipe đã viết, và được ghi bất cứ khi nào Recipe có viết nó (tag/branch git-repository → SHA của commit).

Thuộc tínhLoạiBắt buộcMô tả
entityenumcóKind của thực thể catalog giữ con trỏ ngược này. Giá trị cho phép: "recipe", "feature_recipe"
uristringcóURI chuẩn của Recipe hoặc FeatureRecipe (ví dụ hub.aggrega.ai/recipe/helm/mariadb-bitnami:1.0.0).
fieldstringcóĐường dẫn phía nguồn bên trong spec của thực thể, nơi artifact được khai báo. Giá trị là spec.source.
requested_refstringkhôngTùy chọn — spec.source.ref: mà Recipe đã viết, được ghi bất cứ khi nào Recipe có viết nó. Với một Recipe git-repository viết ref: v1.0.0, trường này lưu "v1.0.0" trong khi pinned_version: giữ commit mà tham chiếu đó đã phân giải tới. Không có khi Recipe không viết ref:, tức là mọi kind có resolver ghim nguyên văn phiên bản được viết (helm-, compose-). Trường này đảm nhận hai việc cùng lúc, và việc ghi nó vô điều kiện là điều giúp hai việc đó không loại trừ nhau. Một build dựa vào nó để tìm mục này từ một Recipe nêu tên tham chiếu thay vì commit. Và một lần pull không phải là nâng cấp sẽ giữ mỗi tham chiếu đã ghi ở phiên bản đã ghim của nó: một tham chiếu đã thay đổi ở remote sẽ làm dừng lần chạy thay vì được chấp nhận.

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

VerifiedSignature

Dữ kiện chữ ký đã xác minh, được ghi lại khi chữ ký của một artifact được xác minh tại thời điểm pull, theo chính sách tin cậy của registry phân giải. Mọi artifact có thể ký đều ghi lại dữ kiện này theo cùng một cách — một thực thể catalog, một thư viện, một Wasm plugin — vì tất cả đều được xác minh qua một đường duy nhất thay vì mỗi loại một đường. Ghi lại chế độ xác minh, danh tính/bên phát hành keyless đã khớp (khi là keyless), và digest định địa chỉ theo nội dung của gói chữ ký trong bộ nhớ đệm nội dung. Build không chạy lại việc xác minh. Trước khi bất cứ thứ gì được render, build đọc dữ kiện này trên mọi mục mà nó dựng từ đó, trong mọi phần: nó băm lại gói đã lưu trong bộ nhớ đệm và so sánh kết quả với bundle_digest, dừng lại khi blob bị thiếu hoặc khác biệt; và với một mục do bộ nhớ đệm nội dung cung cấp, nó đọc từ gói đó xem chữ ký được tạo cho artifact nào, và dừng lại khi chữ ký được tạo cho một artifact khác với artifact mà build đã đọc cho mục đó — vì vậy một signature được sao chép từ mục này sang mục khác sẽ bị từ chối, bất kể yêu cầu ký nói gì. Một build không xác minh chữ ký nào, nên một gói được ghi thủ công vào bộ nhớ đệm, được lập cho chính artifact của mục, không thể phân biệt với một gói mà pull đã xác minh. Và khi cấu hình tin cậy của workspace yêu cầu chữ ký cho một mục do bộ nhớ đệm nội dung cung cấp — yêu cầu mà pull áp dụng khi nó tải artifact, nên các trường hợp bỏ qua và một registry advisory vốn cho phép pull chấp nhận một artifact không có chữ ký cũng cho phép build chấp nhận mục của nó — thì một mục không mang dữ kiện nào sẽ làm build dừng lại. Một mục được đọc từ một thư mục catalog, từ bản sao bên trong tệp nhị phân của trình biên dịch, hoặc từ bên cạnh Release không bao giờ phải tuân theo yêu cầu đó.

Thuộc tínhLoạiBắt buộcMô tả
bundle_digeststringcóDigest SHA-256 của blob gói chữ ký trong bộ nhớ đệm, ở dạng sha256: theo sau là 64 ký tự hex viết thường. Nó đặt tên cho blob trong bộ nhớ đệm, nên nó dựng nên một đường dẫn và không chứa /, \ hay .. — điều mà dạng sha256: vốn đã loại trừ — và trên một mục thuộc bất kỳ phần nào, đây là giá trị mà build dùng để so sánh khi băm lại blob đó. Mẫu: ^sha256:[a-f0-9]{64}$.
identitystringkhôngBên ký đã được xác minh của chữ ký: subject của chứng chỉ ký đối với chữ ký keyless, hoặc keyed:sha256: theo sau là SHA-256 của văn bản PEM của khóa công khai đã ghim đối với chữ ký keyed.
issuerstringkhôngBên phát hành OIDC đã được xác minh đối với chữ ký keyless. Để trống đối với chữ ký keyed.
modestring (enum)cóChế độ xác minh đã chấp nhận chữ ký. Giá trị cho phép: "keyless", "keyed"

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