Schema Template Context 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/template-context-v1beta1.schema.json
Khung nhìn mà trình biên dịch lắp ráp và truyền cho các template của Recipe và FeatureRecipe trong quá trình kết xuất. Khi kết xuất một FeatureRecipe đính kèm, trình biên dịch còn điền thêm .attachment_name và .inject bằng ngữ cảnh trong phạm vi phần đính kèm, .context.render_facts bằng những gì provider của host đã báo cáo về lần kết xuất của host, và, trên các template tạo ra tài nguyên riêng của phần đính kèm, .context.used_by bằng các component sử dụng host của nó. Đối với một FeatureRecipe có phạm vi boundary (spec.executionScope: boundary), các template mà nó chạy một lần cho boundary — trong đó có locals, provides, source, valuesMapping, artifacts và các bước pipeline của nó — thấy các trụ .context, .workload, .attachment_name, .inject và .inject_raw không có mặt, và thay vào đó một trụ .boundary.* được điền — xem khối boundary ở cuối phần thuộc tính; injectMapping của nó chạy một lần cho mỗi component mà phần đính kèm vươn tới, trong ngữ cảnh của component đó, nên nó đọc .context.* và .attachment_name, và .boundary không được đặt ở đó. Ngữ cảnh này KHÔNG được lưu xuống đĩa; nó chỉ tồn tại trong bộ nhớ của trình biên dịch trong quá trình kết xuất. Schema này mô tả hợp đồng giữa trình biên dịch và những người viết template Ops.
Khả dụng theo giai đoạn của base-rendering, theo thứ tự các giai đoạn chạy:
- Provides evaluation (đánh giá provides; locals preamble, sau đó provides): chỉ các pillar cục bộ của node. Một mục locals đọc các mục phía trên nó trong chính khối của nó; một template provides đọc toàn bộ .locals đã được phân giải của node. Cấm tự tham chiếu (không mục provides nào đọc mục khác).
- Source resolution (phân giải source; công bố locals + đánh giá source): tất cả các pillar; không có .source và .workload. Các locals đó được công bố lên .locals tại đây, sau đó source: được đánh giá dựa trên chúng.
- Values mapping (ánh xạ giá trị; valuesMapping): tất cả các pillar + .source; không có .workload.
- Workload synthesis (tổng hợp Workload; đánh giá workload): tất cả các pillar + .source; .workload đang được đánh giá (không có để tự tham chiếu).
- Artifact evaluation (đánh giá artifact; artifacts): tất cả các pillar + .source + .workload (ngữ cảnh đầy đủ nhất).
Kiểu cấp cao nhất: object
Thuộc tính
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
context | object | có | Ngữ cảnh thực thi do trình biên dịch tập hợp, cung cấp dữ liệu về định danh, cấu trúc liên kết và phân phối. |
values | object | có | Payload nhận thức không trong suốt của nút này, đã được trình xác thực schema kiểm tra khi phân giải. Được chuyển qua nguyên vẹn. |
infra | object | có | Payload định cỡ vật lý được tiêm từ Release cho nút này. Hoàn toàn bỏ qua Developer. |
locals | map của string | có | Trạng thái riêng tư của chính Recipe (ví dụ: primary_compute, volumes_path). Được đánh giá trong phần mở đầu locals — trước provides của nút đó — và được công bố lên trụ cột này khi phân giải source. Mỗi mục là một Go template được đánh giá dựa trên một ngữ cảnh cục bộ của nút, tự chứa, mang các mục của cùng khối đã được phân giải tới thời điểm đó, vì vậy một mục CÓ THỂ đọc một mục cùng cấp được định nghĩa PHÍA TRÊN nó và nhận giá trị đã phân giải của mục đó. Thứ tự do tác giả viết là một phần của hợp đồng ở bất cứ nơi nào một mục đọc mục khác: di chuyển một định nghĩa xuống dưới nơi đọc nó sẽ làm hỏng bản build. Một tham chiếu ‘.locals. |
provides | map của string | không | Hợp đồng API công khai của Recipe. Được điền từ việc đánh giá provides. Có sẵn trong valuesMapping của bước render cơ sở để tự tham chiếu (ví dụ: {{ .provides.host }}). KHÔNG có sẵn bên trong chính template provides (bất biến tự chứa của provides). Bên gọi phân giải các khóa inject dựa trên các giá trị này. |
features | map của template_attachment | không | Mọi attachment trên nút này, được đánh khóa theo tên instance mà tác giả đặt cho nó. Một trụ cột mang tất cả chúng bất kể chúng tạo ra gì — một Feature vận hành, một Feature thông tin xác thực, một Feature định danh — vì điều khác nhau giữa các attachment là thứ chúng tạo ra, không phải cách một template đọc chúng. Một Recipe đọc chúng để điều chỉnh việc render theo các khả năng được gắn kèm và để sử dụng những gì một attachment công bố. Một attachment được viết trên một kết nối của nút thì không nằm trong số đó: nó được đọc dưới kết nối đó, tại .context.uses. |
metadata | object | không | Metadata của Release và quá trình biên dịch, cung cấp định danh toàn cục để đặt tên một cách tất định. Có sẵn trong mọi khối template (valuesMapping, injectMapping, pipeline with). |
attachment_name | string | không | Chỉ được điền khi render một FeatureRecipe của attachment. Chứa tên instance của attachment — slot mà nó lấp trong featuresSchema của thực thể sở hữu, hoặc tên tự do mà tác giả đặt cho nó (ví dụ: ‘admin_password’, ‘db_credentials’). Được dùng để tạo tên tài nguyên tất định khác nhau theo từng attachment, ghép sau tên của component chủ: ’{{ .context.rendered_name }}-{{ .attachment_name | replace ”_” ”-” }}’ khi provider của chủ báo cáo một tên đã render, như helm làm — tên của chủ được viết bằng các ký tự mà tên Kubernetes cho phép, với dấu gạch dưới trong tên attachment được chuyển thành dấu gạch nối — và ’{{ .context.instance_id }}-{{ .attachment_name }}’ khi provider của chủ không báo cáo tên nào. |
inject | object | không | Chỉ được điền khi render một FeatureRecipe của attachment có mang khối inject do tác giả viết (ví dụ: { env: [ { in: ‘OPENAI_API_KEY’, from: ‘api_token’ } ] }). Khác với .context.inject, vốn là đường ống phân phối đã được hydrate trước của component cơ sở từ các cạnh uses. Có giá trị null/không tồn tại đối với các attachment không có inject do tác giả viết và đối với các Recipe cơ sở. |
inject_raw | object hoặc null | không | Ý định bất biến, chưa bị biến đổi của Developer cho khối inject. Mỗi cơ chế mà khối nêu tên — env, file, arg, hoặc một cơ chế tùy chỉnh như ssm_param — nằm dưới tên riêng của nó, chứa các mục đúng như đã viết (in, với from hoặc value), theo thứ tự đã viết, nên .inject_raw.ssm_param đọc một cơ chế tùy chỉnh theo cách .inject_raw.env đọc một cơ chế lõi. Có giá trị null nếu Developer bỏ hoàn toàn khối inject. Được Ops dùng cho các kiểm tra logic (ví dụ: {{ if not .inject_raw }}) để phát hiện việc bỏ sót trước các biến đổi của inject mapping. Việc mỗi mục chuyển giao values hoặc provides nào của chính thành phần được đọc tại .context.self_inject chứ không phải từ văn bản của các mục. |
steps | map của object | không | Giao tiếp giữa các bước của pipeline. Chỉ có sẵn bên trong các khối ‘with:’ của Wasm pipeline. Mỗi khóa là ID của một bước pipeline, chứa các đầu ra mà bước đó xuất ra. |
source | string hoặc object hoặc null | không | Nội dung trường source đã được phân giải. Trên các template của một Recipe: được điền khi phân giải source từ trường source: của Recipe sau khi đánh giá Go template, có sẵn từ values mapping trở đi (valuesMapping, workload, artifacts), và là null khi Recipe không có source:. Trên các template của một FeatureRecipe: là trường source: của chính FeatureRecipe sau khi đánh giá Go template, được đánh giá trước valuesMapping của nó và được đọc ở đó cũng như trên mọi template được đánh giá sau nó (omits, workload, artifacts, các bước pipeline), không bao giờ là của component chủ; là null khi FeatureRecipe không có source:. injectMapping của một FeatureRecipe được đánh giá trước source của nó và đọc source của component chủ. Dạng string = đường dẫn URI; dạng object = source có cấu trúc (ví dụ: OCI descriptor với phiên bản đã phân giải). |
workload | workload-v1beta1.schema.json hoặc null | không | Đặc tả Workload đã được phân tích cú pháp cho nút này. Được điền khi tổng hợp workload từ trường workload: của Recipe sau khi đánh giá Go template + xác thực JSON-schema của Workload (theo workload-v1beta1.schema.json). Có sẵn từ bước đánh giá artifact trở đi (artifacts) để các artifact có thể tham chiếu các trường của workload mà không cần lặp lại (ví dụ: một ServiceMonitor đọc .workload.services.metrics.ports.prom). Có giá trị null khi Recipe không có khối workload:. Các template cố gắng truy cập .workload.* trên một giá trị null sẽ thất bại với một lỗi rõ ràng tại thời điểm đánh giá template. |
boundary | object | không | Ngữ cảnh phạm vi boundary — chỉ được điền khi đánh giá một template mà một FeatureRecipe có spec.executionScope là ‘boundary’ chạy một lần cho boundary. Các FeatureRecipes phạm vi Component không nhận pillar này; context.instance_id, context.inject, context.uses và pillar .workload của chúng mang dữ liệu theo từng component thay vào đó. Các template của một FeatureRecipe phạm vi boundary chạy cho boundary nhận .boundary.* thay cho các pillar theo từng component đó; injectMapping của nó chạy trong ngữ cảnh của từng component mà attachment vươn tới, đọc các pillar theo từng component đó và không nhận pillar này. |
Không cho phép thuộc tính bổ sung.
template-context.context
Ngữ cảnh thực thi do trình biên dịch tập hợp, cung cấp dữ liệu về định danh, cấu trúc liên kết và phân phối.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
instance_id | string | có | ID phẳng tuyệt đối của node hiện tại (ví dụ: ‘backend’, hoặc ‘data-layer-zdmain-db’ cho component main-db của instance module data-layer), được viết bằng bảng chữ cái mà mọi tên component do tác giả viết đều thỏa mãn. Có tính xác định và ổn định qua các lần biên dịch cho cùng một Aggregate. Đây là tên của các tài nguyên được xây dựng cho node này mà không provider nào suy ra tên — một tập artifact được đặt từ Recipe, và một workload được tổng hợp bởi một provider đặt tên nó theo định danh — vì vậy một địa chỉ được công bố cho một trong số đó được xây dựng từ giá trị này. |
rendered_name | string | không | Tên mà provider được gắn với node này đặt cho các tài nguyên nó render cho node — với source do tác giả cung cấp, đó là tên mà chính các template được cung cấp render theo, chẳng hạn tên release mà một chart đọc; với một workload mà nó tổng hợp, đó là tên nó đặt cho các tài nguyên của workload đó khi nó suy ra một tên thay vì ghi định danh của node, như provider helm làm với cùng tên release đó. Hãy đọc nó ở bất cứ đâu Recipe này đặt tên cho một tài nguyên mà một chart hoặc module được cung cấp đã khai báo hoặc một provider như vậy đã tổng hợp, dù trong một mục provides, một valuesMapping, một workload, một mục artifacts hay with hoặc when của một bước pipeline, vì provider có thể viết tên đó bằng một bảng chữ cái hạn chế hơn bảng chữ cái dùng để viết tên component do tác giả đặt, và khi đó hai tên khác nhau. Rỗng khi provider được gắn không suy ra tên nào như vậy: các tài nguyên của một tập artifact được đặt, và của một workload được tổng hợp bởi một provider đặt tên nó theo định danh, mang định danh của node, vì vậy hãy đọc ’{{ .context.instance_id }}’ cho những trường hợp đó, còn một Recipe tự viết tên tài nguyên của mình thì đã biết các tên đó. Đọc khóa này ở nơi provider được gắn không báo cáo tên nào sẽ dừng bản build và cho biết nên viết gì thay thế. Sự từ chối này áp dụng cho các template mà Recipe viết inline; một valuesMapping, một workload hoặc một mục artifacts được cung cấp qua ‘$import’ chỉ được phân giải khi quá trình render đến nó, vì vậy một tham chiếu bên trong một trong số đó được render thành giá trị rỗng thay vì dừng lại. Trên các template của một FeatureRecipe được gắn với một attachment của component, đây là tên của component CHỦ theo cách provider của chính chủ đó báo cáo — giá trị mà Recipe của chính chủ đó đọc, cũng như instance_id ở đó là định danh của chủ — vì vậy một attachment dùng nó để đặt tên tài nguyên theo chủ của mình và nhận được một tên mà nền tảng của chủ chấp nhận. Khi provider của chủ không báo cáo tên nào, giá trị này rỗng, và việc đọc nó từ một template inline của attachment ngoài injectMapping của nó sẽ dừng bản build; khi đó hãy đọc ’{{ .context.instance_id }}’ thay thế. |
labels | map của string | không | Các nhãn duck-typing và ontology của node hiện tại, bao gồm mọi thay đổi mà một plugin quản trị được gắn ở vai trò label-transform đã thực hiện khi xây dựng topology. |
annotations | object | không | Ba nhóm annotation xếp tầng của node hiện tại, được phân tách theo nguồn gốc. |
inject | object | có | Đường ống phân phối đã được hydrate trước và bị chặn. Ban đầu là một map do compiler sinh ra, phân giải các khóa inject của Developer thành các giá trị provides của Target. Được biến đổi tại chỗ bởi các deep-merge của injectMapping. Đến khi Base Recipe render, nó chứa các chuỗi vật lý đã được phân giải đầy đủ. |
uses | map của enriched_edge | có | Map cạnh topology đã được làm giàu. Có khóa là alias của Developer (ví dụ: ‘my_db’, ‘my_api’). Mỗi mục là một khung nhìn do compiler lắp ráp về định danh của node đích, các provides đã phân giải, ánh xạ injection và các annotation đã xếp tầng, cùng các attachment được viết trên kết nối đó — và, với một FeatureRecipe khai báo readsTargetRenderFacts, về những gì các lần render của đích đã báo cáo. Đây KHÔNG phải là cạnh IR thô — đây là một phép chiếu đã làm giàu được compiler xây dựng riêng cho việc sử dụng trong template. Một template duyệt map này sẽ thấy các kết nối theo thứ tự khóa — sắp xếp theo alias — chứ không theo thứ tự chúng được viết. |
self_inject | object | có | Những values và provides nào của chính thành phần đã được nhà phát triển đặt tên chuyển giao, được đọc từ khối inject: viết trên chính thành phần đó — khối mà .inject_raw giữ đúng như đã viết, và .context.inject giữ ở dạng đã phân giải. Mỗi cơ chế mà khối nêu tên (env, file, arg, hoặc một cơ chế tùy chỉnh như ssm_param) ánh xạ mỗi tên mà nhà phát triển đã viết tới khóa riêng mà mục đó chuyển giao, giống như cách .context.uses. |
used_by | inbound_edge[] | không | Các component sử dụng component này: một mục cho mỗi kết nối uses mà một component khác tạo tới nó, theo thứ tự các component kết nối được viết và sau đó theo thứ tự các mục uses của từng component. Một component kết nối hai lần sẽ xuất hiện hai lần. Chỉ được đọc bởi một FeatureRecipe gắn với component, và chỉ trong các template tạo ra tài nguyên riêng của attachment — valuesMapping, workload và artifacts của nó. Nó không có trong các template Recipe của chính component, trong injectMapping và trong with và when của một bước pipeline, vì đầu ra của mỗi thứ đó có thể nằm trong đầu ra đã render của chính component, vốn giữ nguyên bất kể ai kết nối tới nó. Mỗi mục là một phần tử danh sách chứ không phải một khóa, vì vậy một template duyệt nó sẽ gặp các bên gọi theo thứ tự đó. |
render_facts | render_facts | không | Những gì provider đã render component này báo cáo về đầu ra nó phát ra — các render fact mà nó báo cáo — có khóa là tên fact. Provider báo cáo những tên nào, và mỗi mục chứa gì, là hợp đồng được tài liệu hóa của chính provider đó. Mọi giá trị đều là một danh sách, kể cả khi chỉ có một mục, để template luôn duyệt qua nó; khi việc render component cần nhiều lần gọi provider và một tên được nhiều lần gọi báo cáo, các danh sách của nó được nối thành một theo thứ tự các lần gọi chạy. Có mặt trên mọi template của một FeatureRecipe gắn với component — valuesMapping, workload, artifacts và with và when của các bước pipeline — khi component đã render xong, và rỗng khi provider của nó không báo cáo gì, vì vậy một tên không ai báo cáo sẽ được đọc là một danh sách rỗng. Không có trong các template Recipe của chính component và trong injectMapping, vốn chạy trước khi component được render. |
Không cho phép thuộc tính bổ sung.
template-context.context.annotations
Ba nhóm annotation xếp tầng của node hiện tại, được phân tách theo nguồn gốc.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
release | map của string | không | Các chuỗi topology vật lý xếp tầng từ các ranh giới Release. |
catalog | map của string | không | Các đặc tính nội tại bất biến do Platform Architect viết trong Domain 2. |
aggregate | map của string | không | Metadata nhận thức xếp tầng từ các hệ thống con Aggregate. |
Không cho phép thuộc tính bổ sung.
template-context.context.inject
Đường ống phân phối đã được hydrate trước và bị chặn. Ban đầu là một map do compiler sinh ra, phân giải các khóa inject của Developer thành các giá trị provides của Target. Được biến đổi tại chỗ bởi các deep-merge của injectMapping. Đến khi Base Recipe render, nó chứa các chuỗi vật lý đã được phân giải đầy đủ.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
env | map của string | không | Phân phối qua biến môi trường. Khóa là tên biến cục bộ của Developer, giá trị là các chuỗi đích đã phân giải. |
file | map của string | không | Phân phối qua mount tệp. Khóa là đường dẫn tệp cục bộ, giá trị là các chuỗi đích đã phân giải. |
arg | map của string | không | Phân phối qua đối số dòng lệnh. Khóa là tiền tố flag, giá trị là các chuỗi đích đã phân giải. |
all | map của string | không | Bản hợp nhất phẳng được tính trước của các cơ chế env + file + arg + tùy chỉnh. Được điền sau khi phân giải uses-inject và được tính lại sau inject mapping. Các template dùng {{ toJson .context.inject.all }} để tuần tự hóa phổ quát. |
template-context.context.self_inject
Những values và provides nào của chính thành phần đã được nhà phát triển đặt tên chuyển giao, được đọc từ khối inject: viết trên chính thành phần đó — khối mà .inject_raw giữ đúng như đã viết, và .context.inject giữ ở dạng đã phân giải. Mỗi cơ chế mà khối nêu tên (env, file, arg, hoặc một cơ chế tùy chỉnh như ssm_param) ánh xạ mỗi tên mà nhà phát triển đã viết tới khóa riêng mà mục đó chuyển giao, giống như cách .context.uses.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
env | map của string | không | Chuyển giao qua biến môi trường: khóa là tên biến của nhà phát triển, giá trị là khóa riêng mà mỗi mục chuyển giao. |
file | map của string | không | Chuyển giao qua gắn kết tệp: khóa là đường dẫn tệp của nhà phát triển, giá trị là khóa riêng mà mỗi mục chuyển giao. |
arg | map của string | không | Chuyển giao qua đối số dòng lệnh: khóa là tiền tố cờ của nhà phát triển, giá trị là khóa riêng mà mỗi mục chuyển giao. |
template-context.metadata
Metadata của Release và quá trình biên dịch, cung cấp định danh toàn cục để đặt tên một cách tất định. Có sẵn trong mọi khối template (valuesMapping, injectMapping, pipeline with).
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
release_name | string | không | Tên của Release đang được build (ví dụ: ‘prod-billing’). Được Ops dùng để xây dựng tên tài nguyên cloud duy nhất toàn cục (S3 bucket, IAM role). Kết hợp với .context.instance_id để đảm bảo tính duy nhất giữa các môi trường. |
release_version | string | không | Phiên bản ngữ nghĩa của Release. |
environment | string | không | Chuỗi môi trường từ metadata của Release (ví dụ: ‘production’, ‘local’). |
aggregate_name | string | không | Tên của Aggregate gốc đang được biên dịch. |
Không cho phép thuộc tính bổ sung.
template-context.inject
Chỉ được điền khi render một FeatureRecipe của attachment có mang khối inject do tác giả viết (ví dụ: { env: [ { in: ‘OPENAI_API_KEY’, from: ‘api_token’ } ] }). Khác với .context.inject, vốn là đường ống phân phối đã được hydrate trước của component cơ sở từ các cạnh uses. Có giá trị null/không tồn tại đối với các attachment không có inject do tác giả viết và đối với các Recipe cơ sở.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
env | map của string | không | Phân phối biến môi trường trong phạm vi attachment. |
file | map của string | không | Phân phối gắn kết tệp trong phạm vi attachment. |
arg | map của string | không | Phân phối đối số trong phạm vi attachment. |
all | map của string | không | Bản hợp nhất tiện lợi do trình biên dịch tạo ra, gộp mọi kiểu inject của attachment. |
template-context.boundary
Ngữ cảnh phạm vi boundary — chỉ được điền khi đánh giá một template mà một FeatureRecipe có spec.executionScope là ‘boundary’ chạy một lần cho boundary. Các FeatureRecipes phạm vi Component không nhận pillar này; context.instance_id, context.inject, context.uses và pillar .workload của chúng mang dữ liệu theo từng component thay vào đó. Các template của một FeatureRecipe phạm vi boundary chạy cho boundary nhận .boundary.* thay cho các pillar theo từng component đó; injectMapping của nó chạy trong ngữ cảnh của từng component mà attachment vươn tới, đọc các pillar theo từng component đó và không nhận pillar này.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
path | string | không | Đường dẫn của boundary Release mà FeatureRecipe được gắn vào: tên các boundary từ ngoài cùng vào trong, nối bằng ’/’ (ví dụ ‘bridge’, ‘bridge/frontend’). Nó chỉ định boundary, không phải thư mục mà đầu ra của nó được ghi vào; thư mục đó do directory: của boundary đặt. |
assembly_path | string | không | Thư mục, tương đối so với thư mục đầu ra của bản build, mà đầu ra riêng của attachment này được lắp ráp vào: directory: và subDirectory: đã đánh giá của boundary của nó, tức thư mục mà bản build định tuyến đầu ra đó tới (ví dụ ‘bridge/compose’). Nó bằng đúng source_assembly_path hoặc target_assembly_path của một điểm cuối kết nối khi và chỉ khi điểm cuối đó được kết xuất vào cùng một tệp đã lắp ráp, nên một FeatureRecipe so sánh chúng để phân biệt một kết nối bên trong tệp của chính nó với một kết nối ở tệp khác. Dữ liệu không trong suốt; lõi không diễn giải nó. |
boundary_name | string | không | Tên của boundary (khóa map trong release.spec.boundaries). |
components | object | không | Map từ instance_id tới một mục cho mọi component trong cây con của boundary (đệ quy, bao gồm các component thuộc boundary lồng nhau). Mỗi mục mang URI loại đã phân giải, instance ID của component, và các giá trị được cung cấp từ việc đánh giá provides theo từng component. |
internal_uses_edges | object[] | không | Các cạnh uses mà cả nguồn VÀ đích đều nằm trong cây con của boundary này. |
outgoing_cross_boundary_uses_edges | object[] | không | Các cạnh uses có nguồn nằm trong cây con của boundary này và đích nằm ngoài nó. |
incoming_cross_boundary_uses_edges | object[] | không | Các cạnh uses có đích nằm trong cây con và nguồn nằm bên ngoài. Được các bộ tổng hợp kiểu ingress sử dụng khi cần biết ai đang gọi vào. |
cross_boundary_uses_edges | object[] | không | Hợp tiện lợi của các cạnh xuyên boundary đi ra và đi vào. |
labels | map của string | không | Hợp các nhãn của các component trong cây con, giữ nguyên thứ tự do tác giả viết. |
annotations | map của string | không | Các annotation riêng của boundary sau khi cascade được phân giải. |
feature_attachments | template_attachment[] | không | Các attachment được gắn trực tiếp vào boundary này (để tham chiếu chéo giữa các attachment trong phạm vi boundary), có cùng dạng attachment mà .features mang. |
Không cho phép thuộc tính bổ sung.
Định nghĩa
inbound_edge
Một kết nối mà một component khác tạo tới component mà một FeatureRecipe được gắn kèm render cho nó: ai kết nối, qua socket nào, component kết nối công bố những gì, cùng namespace và boundary mà nó được đặt vào. Mọi giá trị đều là một string mà trình biên dịch mang theo mà không diễn giải.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
component_id | string | có | ID instance đã làm phẳng của component kết nối (ví dụ: ‘frontend’ hoặc ‘data-layer.etl’) — giá trị mà một template đường dẫn subDirectory đọc dưới dạng .component_id, được viết theo cùng cách mà .context.uses. |
socket | string | có | Danh mục usesSchema mà component kết nối dùng để tạo kết nối này (ví dụ: ‘databases’, ‘apis’). |
provides | map của string | có | Các provides đã được phân giải của component kết nối, thu hẹp về các khóa mà Component của nó khai báo — cũng chính là các giá trị mà một bên tiêu thụ component đó đọc tại .context.uses. |
source_namespace | string | không | Namespace mà component kết nối được đặt vào: annotation aggrega.ai/namespace mà lần render của chính nó nhận được — các annotation của các boundary chứa nó, với các annotation trong mục Release của chính nó được áp dụng sau cùng, nên một component có mục đặt hoặc xóa namespace sẽ mang thiết lập của chính nó thay vì của boundary. Đây là giá trị mà một FeatureRecipe phạm vi boundary đọc dưới dạng source_namespace trên mục của cùng kết nối đó trong các danh sách uses-edge của .boundary. Vắng mặt khi không có namespace nào áp dụng cho component kết nối; hãy kiểm tra bằng if hoặc with trước khi in nó. |
source_boundary_path | string | không | Đường dẫn phân tách bằng dấu gạch chéo của boundary trong Release chứa component kết nối (ví dụ: ‘edge’ hoặc ‘aws-prod/payments’) — giá trị mà một FeatureRecipe phạm vi boundary đọc dưới dạng source_boundary_path trên mục của cùng kết nối đó trong các danh sách uses-edge của .boundary. |
render_facts | render_facts | không | Những gì các lần render của component kết nối đã báo cáo về đầu ra mà chúng tạo ra, theo khóa là tên fact: các fact mà các lời gọi provider của chính nó báo cáo, rồi đến các fact của từng Feature gắn vào nó đã render cùng nó, theo thứ tự chúng render; các danh sách mà một tên nhận được từ nhiều nguồn được gộp thành một theo thứ tự đó. Mọi giá trị đều là một danh sách, kể cả khi chỉ có một mục, nên template luôn duyệt (range) qua nó. Chỉ có mặt đối với một FeatureRecipe khai báo readsCallerRenderFacts — các attachment của nó render sau khi mọi component đã render, nên lần render của mọi bên gọi đều đã hoàn tất — và khi đó có trên mọi mục, rỗng đối với bên gọi mà các provider không báo cáo gì. Vắng mặt đối với mọi FeatureRecipe khác. |
Không cho phép thuộc tính bổ sung.
render_facts
Các render fact theo khóa là tên: những gì các provider đã render một component báo cáo về đầu ra mà chúng tạo ra. Một provider báo cáo những tên nào, và mỗi mục chứa gì, là hợp đồng được tài liệu hóa của riêng provider đó; trình biên dịch không biết gì về cả hai ngoài việc mỗi giá trị là một danh sách. Một danh sách giữ nguyên thứ tự các mục của nó. Một mục dạng object được mang theo với các khóa theo thứ tự provider đã viết, và một template duyệt qua nó sẽ gặp chúng theo thứ tự khóa, như với mọi map có khóa trên context này.
Object dạng tự do; các giá trị là any[].
template_attachment
Một attachment theo cách một template đọc nó: góc nhìn theo từng instance của một Feature được gắn kèm. Mọi attachment đều cung cấp cùng các trường bất kể nó tạo ra gì, nên .features.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
type | string | không | URI Feature trong Catalog của Feature được gắn kèm. |
resolved_version | string | không | Phiên bản của Feature được gắn kèm sau khi phân giải Manifest — phiên bản thực sự được ràng buộc cho bản build này, đọc dưới dạng .features. |
labels | map của string | không | Các label trong Catalog của Feature được gắn kèm, được mang theo nguyên văn theo thứ tự Feature khai báo chúng — không có gì bị lọc, đổi tên hay cắt tiền tố, nên template đọc đúng những gì tác giả của Feature đã viết. Cho phép template rẽ nhánh dựa trên bản chất của Feature được gắn kèm thay vì dựa trên tên hay URI của nó. Tương ứng với .context.uses.if hoặc duyệt qua map trước khi truy cập một label riêng lẻ. |
values | object | không | Trụ cột ý định của nhà phát triển (developer-intent) của riêng attachment, được mang theo nguyên văn từ khai báo attachment. |
infra | object | không | Trụ cột định cỡ vận hành (operational-sizing) của riêng attachment, được mang theo nguyên văn từ khai báo attachment. |
provides | map của string | không | Hợp đồng công khai đã được phân giải của FeatureRecipe được ràng buộc với attachment này — tên của tài nguyên được tạo ra, khóa của nó, một định danh và mọi khóa được tạo bổ sung — được cung cấp cho bên tiêu thụ dưới dạng .features. |
Không cho phép thuộc tính bổ sung.
enriched_edge
Một cạnh tô-pô đã được làm giàu do trình biên dịch lắp ráp. Chứa danh tính đã phân giải của đích, provides và các annotation được kế thừa theo tầng.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
target | string | có | ID tuyệt đối đã làm phẳng của nút đích (ví dụ: ‘data-layer.main-db’). |
socket | string | có | Danh mục usesSchema mà cạnh này thuộc về (ví dụ: ‘databases’, ‘apis’). |
source | string | không | ID tuyệt đối đã làm phẳng của nút nguồn (bên tiêu thụ). Được điền cho các view phạm vi boundary dùng nút tiêu thụ làm khóa cho các đầu ra theo từng bên tiêu thụ. |
source_namespace | string | không | Annotation aggrega.ai/namespace thô của điểm cuối nguồn (rỗng khi không có). Chỉ được điền cho các view phạm vi boundary, giống như source; mục .context.uses của chính một component mang giá trị rỗng. Là dữ liệu mờ dành cho việc phân giải danh tính mạng của provider; phần lõi không diễn giải nó. |
source_boundary_path | string | không | Đường dẫn boundary của điểm cuối nguồn: đường dẫn phân tách bằng dấu gạch chéo của boundary Release chứa nó (ví dụ ‘bridge/frontend’). Chỉ được điền cho các view phạm vi boundary, giống như source; mục .context.uses của chính một component mang giá trị rỗng. |
source_assembly_path | string | không | Đường dẫn lắp ráp của điểm cuối nguồn: thư mục, tương đối so với thư mục đầu ra của bản build, mà đầu ra của nó được lắp ráp vào, được tạo từ directory: và subDirectory: đã đánh giá của boundary của nó (ví dụ ‘bridge/compose’). Hai điểm cuối có cùng một đường dẫn lắp ráp được kết xuất vào một tệp đã lắp ráp, và một điểm cuối có đường dẫn lắp ráp bằng .boundary.assembly_path được kết xuất vào tệp mà đầu ra riêng của FeatureRecipe đang đọc được lắp ráp vào. Một FeatureRecipe phạm vi boundary đặt các điểm cuối lên mạng có thể đọc nó như mạng của điểm cuối nguồn khi không có aggrega.ai/namespace nào áp dụng. Chỉ được điền cho các view phạm vi boundary, giống như source; mục .context.uses của chính một component mang giá trị rỗng. Dữ liệu không trong suốt; lõi không diễn giải nó. |
target_namespace | string | không | Annotation aggrega.ai/namespace thô của điểm cuối đích (rỗng khi không có). Chỉ được điền cho các view phạm vi boundary, giống như source; mục .context.uses của chính một component mang giá trị rỗng. Là dữ liệu mờ dành cho việc phân giải danh tính mạng của provider. |
target_boundary_path | string | không | Đường dẫn boundary của điểm cuối đích: đường dẫn phân tách bằng dấu gạch chéo của boundary Release chứa nó (ví dụ ‘bridge/backend’). Chỉ được điền cho các view phạm vi boundary, giống như source; mục .context.uses của chính một component mang giá trị rỗng. |
target_assembly_path | string | không | Đường dẫn lắp ráp của điểm cuối đích: thư mục, tương đối so với thư mục đầu ra của bản build, mà đầu ra của nó được lắp ráp vào, được tạo từ directory: và subDirectory: đã đánh giá của boundary của nó (ví dụ ‘bridge/compose’). Một điểm cuối có đường dẫn lắp ráp bằng .boundary.assembly_path được kết xuất vào tệp mà đầu ra riêng của FeatureRecipe đang đọc được lắp ráp vào. Một FeatureRecipe phạm vi boundary đặt các điểm cuối lên mạng có thể đọc nó như mạng của điểm cuối đích khi không có aggrega.ai/namespace nào áp dụng. Chỉ được điền cho các view phạm vi boundary, giống như source; mục .context.uses của chính một component mang giá trị rỗng. Dữ liệu không trong suốt; lõi không diễn giải nó. |
provides | map của string | có | Từ điển provides đã được phân giải đầy đủ của nút đích. Được đánh giá ở bước đánh giá provides, trước khi hydrate inject. |
inject | object | có | Ánh xạ inject gốc của Developer cho cạnh này (khóa = tên biến cục bộ, giá trị = khóa provides của đích). Đây là ánh xạ THÔ, không phải các giá trị đã phân giải. |
labels | map của string | không | Các nhãn duck-typing và ontology của nút đích (sau khi biến đổi từ bước xây dựng tô-pô). |
annotations | object | không | Ba nhóm annotation kế thừa theo tầng của nút đích. |
component | string | không | URI loại component trong Catalog của nút đích (ví dụ: ‘core/postgres’). |
resolved_version | string | không | SemVer đã phân giải của nút đích. |
boundary_path | string | không | Phân cấp không gian vật lý của nút đích lấy từ Release (ví dụ: ‘aws-eks-cluster/backend-ns’). |
origin_feature | string | không | Nếu cạnh này được một Feature tự động khai báo (bao gồm các Features thông tin xác thực được gắn nhãn feature.aggrega.ai/kind: secret), đây là tên instance của Feature. Null/không có đối với các cạnh do Developer khai báo. |
origin_release | boolean | không | True khi Release nối kết nối này thay vì Aggregate khai báo nó. Không có đối với kết nối do Aggregate khai báo. |
values | object | không | Cấu hình developer theo từng kết nối được viết trên mục uses của Aggregate cho kết nối này, được giữ nguyên văn. Không có khi kết nối không mang cấu hình nào. Nó chỉ đến được context của nút tiêu thụ, không bao giờ đến context của đích. |
infra | object | không | Cấu hình vận hành theo từng kết nối được viết trên mục uses của Release cho kết nối này, được giữ nguyên văn. Không có khi kết nối không mang cấu hình nào. Nó chỉ đến được context của nút tiêu thụ, không bao giờ đến context của đích. |
features | map của template_attachment | không | Các attachment được viết trên kết nối này, với khóa là tên slot mà socket của kết nối khai báo cho từng attachment, mỗi attachment có dạng như .features mang: type, phiên bản đã phân giải, labels, values, infra và provides đã phân giải của FeatureRecipe gắn với nó. Một Recipe đọc thông tin xác thực của một kết nối dưới dạng .context.uses. |
render_facts | render_facts | không | Những gì các lần render của đích báo cáo về đầu ra mà chúng tạo ra, với khóa là tên fact, theo dạng mà mục của một bên gọi trên .context.used_by mang: các fact mà các lần gọi provider của chính nó báo cáo, sau đó là các fact của từng Feature gắn với nó đã render cùng nó, theo thứ tự đã render; các danh sách mà một tên nhận được từ nhiều nguồn được nối thành một theo thứ tự đó. Mọi giá trị đều là một danh sách, kể cả khi chỉ có một mục, nên template luôn duyệt qua nó. Chỉ có mặt trên .context.uses đối với một FeatureRecipe khai báo readsTargetRenderFacts — các attachment của nó render sau khi mọi component đã render, nên lần render của mọi đích đều đã hoàn tất — và khi đó có trên mọi mục, rỗng đối với đích mà các provider không báo cáo gì. Không có đối với mọi FeatureRecipe khác, trong with và when của một bước pipeline, trong các template Recipe của chính component, và trong các danh sách cạnh mà một FeatureRecipe phạm vi boundary đọc. |
Không cho phép thuộc tính bổ sung.
enriched_edge.inject
Ánh xạ inject gốc của Developer cho cạnh này (khóa = tên biến cục bộ, giá trị = khóa provides của đích). Đây là ánh xạ THÔ, không phải các giá trị đã phân giải.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
env | map của string | không | Phân phối qua biến môi trường: khóa là tên biến cục bộ của bên tiêu thụ, giá trị là khóa provides của đích. |
file | map của string | không | Phân phối qua gắn kết tệp: khóa là đường dẫn tệp cục bộ của bên tiêu thụ, giá trị là khóa provides của đích. |
arg | map của string | không | Phân phối qua đối số dòng lệnh: khóa là tiền tố cờ của bên tiêu thụ, giá trị là khóa provides của đích. |
enriched_edge.annotations
Ba nhóm annotation kế thừa theo tầng của nút đích.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
release | map của string | không | Các chuỗi tô-pô vật lý từ các boundary Release của nút đích. |
catalog | map của string | không | Các đặc điểm bất biến từ thực thể Catalog của nút đích. |
aggregate | map của string | không | Siêu dữ liệu nhận thức từ các hệ thống con Aggregate của nút đích. |
Không cho phép thuộc tính bổ sung.