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.

Ngăn xếp Kong — một API gateway dựa trên cơ sở dữ liệu được kết hợp thành một module

Ví dụ này biên dịch một ngăn xếp nhỏ, có thật — một API gateway dựa trên cơ sở dữ liệu — thành các manifest Kubernetes được tổng hợp từ một Aggregate do Developer viết.

Gateway 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 gateway kết thúc lưu lượng của client trên cổng proxy của nó và không giữ trạng thái cục bộ nào, và
  • một backend, PostgreSQL, giữ cấu hình của gateway và lưu trữ nó bền vững trên một volume.

Module tự nối cạnh nội bộ của nó từ gateway tới backend và xuất gateway làm endpoint công khai proxy. 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ệpVai trò
aggregate.yamlÝ định của Developer: nhập module API gateway (core/kong).
manifest-helm-synth.yamlÁnh xạ các kiểu gateway và backend tới các Recipes synth helm của chúng.
release-helm-synth.yamlBả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 thành một module. Một năng lực đa workload — một API gateway mà thực chất là một proxy cộng một cơ sở dữ liệu cấu hình — đượ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 gateway.
  • Một cạnh nội bộ bên trong module. Gateway khai báo việc sử dụng backend; host, port, user và database trong provides của Recipe backend được dẫn vào gateway 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 gateway của nó dưới tên proxy, tên công khai ổn định mà bên sử dụng kết 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 (gateway.backend, gateway.gateway) để thiết lập tài nguyên tính toán, mà Aggregate của developer không phải nêu lại việc định cỡ vật lý.
  • Một bước migration chạy trước khi phục vụ. Gateway cung cấp schema cơ sở dữ liệu của nó qua một init container chạy đến khi hoàn tất trước khi container gateway chính khởi động, nên gateway phục vụ trên một schema đã sẵn sàng. Bước khởi tạo có tính lũy đẳng, nên chạy lại trên một cơ sở dữ liệu đã được cung cấp sẽ không làm gì cả.
  • Một thông tin xác thực dùng chung. Gateway xác thực với backend PostgreSQL của nó, nên hai bên 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.
  • Image có thể tái tạo. Cả gateway và backend đều ghim tag image tường minh, nên các manifest được kết xuất tham chiếu 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ó:

Terminal window
aggrega scaffold --example kong-stack

Sau đó 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:

Terminal window
cd kong-stack

Build

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:

Terminal window
aggrega build --release release-helm-synth.yaml --auto-pull

Cá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 `kong-stack`, hãy gọi công cụ `scaffold` một lần với `example` được đặt thành `kong-stack` và không có `dir`: công cụ này ghi ví dụ vào một thư mục `kong-stack` mới. Sau đó gọi công cụ `build` với `workspace_root` được đặt thành `kong-stack`, `release` được đặt thành `release-helm-synth.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 `kong-stack/dist/`.

Ngăn xếp đã kết hợp trông như thế nào

Gateway đượ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 proxy và một ConfigMap mang danh sách cho phép yêu cầu của Status API của nó. Pod của nó mang một init container migration chạy trước container chính; cả hai đều mang kết nối được kết hợp từ cạnh backend — tên Service trong cluster của backend, user và database:

env:
- name: KONG_DATABASE
value: postgres
- name: KONG_PG_HOST
value: gateway-zdbackend-default
- name: KONG_PG_PORT
value: "5432"
- name: KONG_PG_USER
value: kong
- name: KONG_PG_DATABASE
value: kong
[… omitted: the gateway's own proxy, admin and status listen addresses, and
the allowlist file its Status API includes]
- name: KONG_PG_PASSWORD
value: apppass

Các probe readiness và liveness của gateway hỏi Status API của Kong — GET /status/ready và GET /status — trên cổng container status, nên listener đó được gắn trên địa chỉ của Pod. Kong đưa danh sách cho phép từ ConfigMap vào khối server riêng của Status API: từ bất kỳ địa chỉ nào ngoại trừ địa chỉ loopback của Pod, nó trả lời một GET tới /status, /status/ready hoặc /metrics, và từ chối mọi yêu cầu khác bằng 403 — trong đó có POST /status/ready, yêu cầu mà nếu không sẽ đánh dấu gateway đang drain và đưa nó ra khỏi Service của nó cho đến khi nó khởi động lại.

Backend đượ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.