Ngăn xếp FerretDB — một cơ sở dữ liệu tài liệu được kết hợp dưới dạng module
Ví dụ này biên dịch một ngăn xếp nhỏ, có thật — một cơ sở dữ liệu tài liệu cung cấp
giao thức wire của MongoDB — thành các manifest Kubernetes được tổng hợp từ một
Aggregate do Developer viết.
Cơ sở dữ liệu tài liệu không phải là một component đơn lẻ. Nó là một module: một aggregate con có thể tái sử dụng, kết hợp hai component đơn workload —
- một proxy nói giao thức wire của MongoDB và không giữ trạng thái cục bộ nào, và
- một backend, PostgreSQL 17 với tiện ích mở rộng DocumentDB, lưu trữ lâu dài dữ liệu trên một volume.
Module tự nối cạnh nội bộ của nó từ proxy đến backend và xuất
proxy làm endpoint công khai mongo. Aggregate cấp cao nhất nhập
module theo tên và kết xuất ngăn xếp đã kết hợp; operator định cỡ các
component nội bộ của module trong Release.
Các tệp
| Tệp | Vai trò |
|---|---|
aggregate.yaml | Ý định của Developer: nhập module cơ sở dữ liệu tài liệu (core/ferretdb). |
manifest-helm-synth.yaml | Ánh xạ các kiểu proxy và backend tới các Recipes synth helm tương ứng. |
release-helm-synth.yaml | Bản ghi của operator cho đích Kubernetes. Định cỡ các component nội bộ của module theo ID trong phạm vi module của chúng; mọi thứ để theo giá trị mặc định của schema sẽ được kết xuất tự chứa. |
Ví dụ này minh họa điều gì
- Kết hợp dưới dạng module. Một năng lực nhiều workload — một cơ sở dữ liệu tài liệu thực chất là một proxy cộng một backend lưu trữ — được đóng gói thành một aggregate con kết hợp hai component đơn workload, chứ không phải một component nguyên khối. Module được nhập theo tên và tái sử dụng ở bất cứ đâu cần một cơ sở dữ liệu tài liệu.
- Một cạnh nội bộ bên trong module. Proxy khai báo việc sử dụng backend;
host, port, user và database trong
providescủa Recipe backend được truyền vào proxy và kết hợp thành kết nối PostgreSQL của nó. Trình biên dịch định tuyến các chuỗi mà không diễn giải chúng. - Một endpoint công khai. Module xuất proxy của nó dưới tên
mongo, tên công khai ổn định mà bên sử dụng cơ sở dữ liệu tài liệu nối tới — tách biệt khỏi tên các component nội bộ của module. - Operator định cỡ các component nội bộ. Release tham chiếu các component nội bộ của module theo ID trong phạm vi module của chúng (
database.backend,database.proxy) để thiết lập tài nguyên tính toán, mà Aggregate của developer không cần khai báo lại kích thước vật lý. - Một thông tin xác thực dùng chung. Proxy ủy thác việc xác thực cho backend PostgreSQL của nó, nên cả hai dùng chung một mật khẩu. Ví dụ này dùng một giá trị mặc định phát triển nội tuyến dùng chung, nên ngăn xếp chạy tự chứa mà không cần secret bên ngoài.
- Một chuỗi kết nối không chứa mật khẩu. URL kết nối PostgreSQL của proxy được
kết xuất mà không nhúng mật khẩu; mật khẩu được cung cấp riêng qua biến môi trường
libpq tiêu chuẩn
PGPASSWORD, được driver hợp nhất vào kết nối. Nhờ đó thông tin xác thực không nằm trong chuỗi kết nối của manifest được kết xuất. - Image có thể tái lập. Cả proxy và backend đều ghim tag image cụ thể, nên các manifest được kết xuất tham chiếu tới các image ổn định.
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 ferretdb-stackSau đó 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 ferretdb-stackBuild
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-helm-synth.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 `ferretdb-stack`, hãy gọi công cụ `scaffold` một lần với `example` đặt thành `ferretdb-stack` và không có `dir`: công cụ này ghi ví dụ vào một thư mục `ferretdb-stack` mới. Sau đó gọi công cụ `build` với `workspace_root` đặt thành `ferretdb-stack`, `release` đặt thành `release-helm-synth.yaml`, `auto_pull` đặt thành true và `write` đặt thành true. Hãy cho tôi biết lần build đã ghi những tệp nào; chúng nằm trong `ferretdb-stack/dist/`.Ngăn xếp đã kết hợp trông như thế nào
Proxy được kết xuất thành một Deployment không trạng thái cộng một Service ClusterIP trên cổng wire. Môi trường container của nó mang kết nối được kết hợp từ cạnh backend — tên Service trong cụm, user và database của backend, không có mật khẩu trong URL — và giữ listener debug của FerretDB trên địa chỉ loopback của pod, nơi không pod nào khác truy cập được:
env: - name: FERRETDB_LISTEN_ADDR value: :27017 - name: FERRETDB_DEBUG_ADDR value: 127.0.0.1:8088 - name: FERRETDB_POSTGRESQL_URL value: postgres://postgres@database-zdbackend-default:5432/postgres - name: PGPASSWORD value: apppassKhông probe nào cần listener đó. Readiness probe chạy ferretdb ping
bên trong container, lệnh này ping cổng wire và do đó cũng chứng minh kết nối
backend; liveness probe chỉ kiểm tra rằng cổng wire chấp nhận
kết nối, nên khi backend gặp sự cố, proxy bị đưa ra khỏi Service của nó mà
không bị khởi động lại:
livenessProbe: tcpSocket: port: 27017readinessProbe: exec: command: - /ferretdb - pingBackend được kết xuất thành một StatefulSet với một persistent volume được gắn tại
/var/lib/postgresql/data, cộng một Service ClusterIP và một headless Service.