Định tuyến ranh giới module — đặt toàn bộ sub-module vào các ranh giới
Ví dụ này biên dịch hai năng lực — một tầng đọc metrics Thanos trên
object storage và một cơ sở dữ liệu tài liệu dùng giao thức wire của MongoDB —
từ một Aggregate do Developer viết, và đặt mỗi năng lực vào một ranh giới
riêng từ Release.
Cả hai năng lực đều là module: các sub-aggregate tái sử dụng được, mỗi cái kết hợp
nhiều component đơn workload và tự nối các cạnh nội bộ của mình.
Aggregate chỉ nêu tên hai module và không nói gì về nơi chúng chạy. Release
đặt toàn bộ mỗi module bằng một mục aggregates: cho mỗi ranh giới — người vận hành
quyết định nơi một năng lực chạy mà không cần theo dõi hay nhắc lại những gì bên trong
nó.
Các tệp
| Tệp | Vai trò |
|---|---|
aggregate.yaml | Ý định của Developer: import module metrics (core/thanos) và module cơ sở dữ liệu tài liệu (core/ferretdb). |
manifest.yaml | Ánh xạ mọi kiểu component mà hai module đóng góp tới Recipe synth helm của nó, Feature thông tin xác thực mà module metrics gắn vào tới realization phát ra một Secret từ mỗi tham số khóa trong hai tham số khóa của module, và Feature scrape tới FeatureRecipe của nó. |
release.yaml | Bản ghi của người vận hành: định tuyến mỗi module vào ranh giới riêng, định kích thước một component của một module, và gắn Feature scrape vào component đó. |
Ví dụ này minh họa điều gì
- Định tuyến toàn bộ một module vào một ranh giới. Mục
aggregates:của một ranh giới được khóa theo tên của module trong Aggregate. Nó đặt mọi component mà module chứa, nên các artifact được phát ra cho cả ba component metrics nằm dưới ranh giớiobservabilityvà cả hai component cơ sở dữ liệu tài liệu nằm dướidata. - Không nêu tên component nào là dạng chính. Ranh giới
datađịnh tuyến module cơ sở dữ liệu tài liệu chỉ bằngdocuments: {}. Mọi component trong đó đều được đặt và nhận giá trị mặc định schema của riêng nó; Release chỉ cần tên của module và không cần gì khác về nó. - Cấu hình một component được định tuyến theo tên cục bộ của nó. Một mục định tuyến cũng có thể
cấu hình từng component của module mà nó định tuyến, được gọi theo tên
cục bộ mà mỗi component mang bên trong module đó —
query, không phảimetrics.query, vì bên trong module đó là tên duy nhất nó có. Nêu tên một component không nói gì về các component khác: ở đâyqueryđược định kích thước và có một đích scrape, còn object store và store gateway được định tuyến vào với giá trị mặc định. - Một component được định tuyến là một component của ranh giới đó. Nó kế thừa
chuỗi annotation của ranh giới như mọi component khác, và chính điều đó cho mọi
tài nguyên của một module được định tuyến giá trị
aggrega.ai/namespacecủa ranh giới — kể cả các component mà mục định tuyến không hề nhắc đến. - Định tuyến là việc đặt chỗ, không phải một kiểu thành viên khác. Một component được định tuyến vào mà không nói gì thêm về nó sẽ kết xuất giống hệt cùng component đó được nêu tên trực tiếp trong ranh giới ấy với phần thân rỗng. Hai cách viết là hai cách nói một component thuộc về đâu, không phải hai hành vi.
Tạo ví dụ
Bạn có thể build ví dụ này bằng các lệnh bên dưới, hoặc để trợ lý AI của bạn build giúp bạn.
Ghi ví dụ vào một thư mục mới đặt theo tên của nó:
aggrega scaffold --example module-boundary-routingSau đó nó in ra các lệnh cần chạy tiếp theo. Lệnh đầu tiên chuyển vào thư mục mới:
cd module-boundary-routingBuild
Workspace này không có .aggrega-config.yaml, nên các thực thể thư viện chuẩn được phân giải từ registry hub, hub.aggrega.ai, và không cần cờ catalog; --auto-pull ghi trong lúc build lockfile mà một bản clone mới còn thiếu:
aggrega build --release release.yaml --auto-pullCác artifact được kết xuất nằm trong dist/. Đích Kubernetes kết xuất manifest
thuần ở chế độ ngoại tuyến — không cần kéo chart.
Với trợ lý AI
Một trợ lý AI được thiết lập với các công cụ của Aggrega cũng có thể làm như vậy: hãy dán prompt này vào trợ lý.
Chỉ sử dụng các công cụ của Aggrega và không tự tạo thư mục nào. Nếu thư mục không gian làm việc chưa chứa thư mục `module-boundary-routing`, hãy gọi công cụ `scaffold` một lần với `example` được đặt thành `module-boundary-routing` và không có `dir`: công cụ này ghi ví dụ vào một thư mục `module-boundary-routing` mới. Sau đó gọi công cụ `build` với `workspace_root` được đặt thành `module-boundary-routing`, `release` được đặt thành `release.yaml`, `auto_pull` được đặt thành true và `write` được đặt thành true. Hãy cho tôi biết bản build đã ghi những tệp nào; chúng nằm trong `module-boundary-routing/dist/`.Các stack được đặt trông như thế nào
directory của mỗi ranh giới là thư mục gốc artifact cho mọi thứ được đặt trong nó, nên
các component của hai module tách biệt trên đĩa theo ranh giới đã định tuyến chúng:
dist/observability/helm/ metrics-zdobjstore, metrics-zdstore, metrics-zdquerydist/data/helm/ documents-zdproxy, documents-zdbackendTên tệp mang định danh của mỗi component với dấu phân cách module được viết
ra, vì dấu chấm không phải ký tự mà mọi tên tài nguyên đều chứa được — metrics.store
trong Aggregate là metrics-zdstore trong cluster. Kết hợp một module là
điều duy nhất đặt dấu phân cách vào một định danh, nên một component bạn nêu tên trực tiếp
được viết giống nhau ở cả hai nơi.
Mọi tài nguyên đều mang namespace của ranh giới định tuyến và ghi lại ranh giới nào đã đặt nó. Store gateway không hề được nêu tên trong mục định tuyến nhưng vẫn kế thừa cả hai:
metadata: name: metrics-zdstore namespace: observability [… omitted: the labels every rendered document carries] annotations: aggrega.ai/boundary-path: observability [… omitted: the annotation naming the Recipe that rendered it]Điều tương tự áp dụng cho bốn Secret mà Feature thông tin xác thực của module metrics phát ra cho cặp khóa của object store và cặp khóa mà store gateway xuất trình cho nó: mỗi Secret nằm dưới observability với namespace đó, bên cạnh workload đọc nó.
Feature scrape gắn vào component query được định tuyến kết xuất artifact
riêng của nó dưới cùng ranh giới đó, mang các thiết lập scrape của người vận hành:
apiVersion: monitoring.coreos.com/v1kind: ServiceMonitormetadata: name: metrics-zdquery-scrape [… omitted: the namespace, labels and annotations every rendered document carries]spec: selector: matchLabels: app.kubernetes.io/name: metrics-zdquery endpoints: - port: http interval: 30s path: /metrics