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.

Một ý định của nhà phát triển, hai dạng cung cấp thông tin xác thực

Cách một thông tin xác thực đến được một container đang chạy là thuộc tính của nơi bạn triển khai, chứ không phải của ứng dụng. Một cluster không có kho bí mật, nên bản triển khai tự mang theo dữ liệu trong một Kubernetes Secret. Một cluster khác chạy một operator kho bí mật, nên bản triển khai chỉ mang theo một con trỏ và cluster lấy dữ liệu vào thời điểm reconcile.

Workspace này chứa một Aggregate và build nó cho hai target. Aggregate không thay đổi giữa hai target. Tham chiếu của cơ sở dữ liệu đến mật khẩu của nó cũng vậy. Thứ thay đổi là một dòng trong một Manifest.

Những gì thay đổi và những gì được giữ nguyên

tệptarget localtarget store
aggregate.yamlcùng một tệpcùng một tệp
Manifestmanifest-local.yamlmanifest-store.yaml
Releaserelease-local.yamlrelease-store.yaml

Hai Manifests khác nhau ở tên của chính chúng và ở một mục ánh xạ:

Terminal window
$ diff manifest-local.yaml manifest-store.yaml
7c7
< name: credential-shape-local-manifest
---
> name: credential-shape-store-manifest
16c16
< core/referenced-secret:1.0.0: helm/k8s-secret-from-parameter:1.0.0
---
> core/referenced-secret:1.0.0: helm/k8s-external-secret:1.0.0

Hai Releases khác nhau ở tên của chính chúng và ở Manifest mà chúng trỏ tới:

Terminal window
$ diff release-local.yaml release-store.yaml
7c7
< name: credential-shape-local
---
> name: credential-shape-store
12c12
< manifest: credential-shape-local-manifest
---
> manifest: credential-shape-store-manifest

Cả hai Releases khai báo cùng một environment. Đó là có chủ ý: tên môi trường được gắn vào mọi tài liệu được render dưới dạng một nhãn, nên giữ nguyên nó thì chỉ còn đúng một thứ được phép thay đổi — FeatureRecipe mà Manifest ràng buộc. Một cặp Releases thực tế dĩ nhiên sẽ đặt tên môi trường riêng, và các dạng thông tin xác thực sẽ khác nhau theo đúng cách như vậy.

Phía nhà phát triển, một lần duy nhất

aggregate.yaml điền cả hai slot thông tin xác thực của Component PostgreSQL bằng cùng một Feature thông tin xác thực có thể tham chiếu:

features:
password:
type: core/referenced-secret
values:
key: POSTGRES_PASSWORD
origin: postgres-superuser-password
app_user_password:
type: core/referenced-secret
values:
key: APP_USER_PASSWORD
origin: postgres-app-password

core/referenced-secret đặt tên cho một tài nguyên bí mật, hoặc do đầu ra của FeatureRecipe của nó tạo ra, hoặc đã tồn tại sẵn, và công bố bộ định vị của tài nguyên đó — name của nó và key dữ liệu bên trong — thông qua hợp đồng provides của nó. Recipe tiêu thụ đọc bộ định vị đó. Nó không bao giờ tự suy ra tên tài nguyên, và không bao giờ hỏi FeatureRecipe nào đã tạo ra nó.

Mỗi target xuất ra những gì

Mỗi lần build ghi ra sáu tệp. Bốn trong số đó — StatefulSet, cả hai Service và ConfigMap khởi tạo — giống hệt nhau từng byte ở cả hai target. Hai tệp còn lại là các tài nguyên thông tin xác thực, mỗi slot được điền một tệp, và đó là chỗ các target khác nhau.

Target local, từ k8s-secret-from-parameter, tại dist/helm/helm/db--password--db-secret-db-password.yaml:

apiVersion: v1
kind: Secret
metadata:
name: db-password
[… omitted: the labels and annotations naming the aggregate, component, environment, compiler and provider versions, boundary and Recipe — the same set every rendered document carries]
stringData:
POSTGRES_PASSWORD: "postgres-superuser-password"

Target store, từ k8s-external-secret, tại dist/helm/helm/db--password--db-externalsecret-db-password.yaml:

apiVersion: external-secrets.io/v1
kind: ExternalSecret
metadata:
name: db-password
[… omitted: the same label and annotation set as above]
spec:
refreshInterval: "1h"
secretStoreRef:
name: platform-secret-store
kind: ClusterSecretStore
target:
name: db-password
creationPolicy: Owner
data:
- secretKey: POSTGRES_PASSWORD
remoteRef:
key: "postgres-superuser-password"

Khác API group, khác kind, khác nội dung. Ở target local, dữ liệu thông tin xác thực nằm trong tài liệu được render, ai đọc được bản triển khai đều đọc được — đó là lý do dạng này phù hợp với cluster local và phát triển hơn là cluster production. Ở target store, tài liệu được render chỉ mang tên mục; dữ liệu vẫn nằm trong kho và operator reconcile nó thành một Secret tên là db-password.

So sánh hai cây đầu ra cho thấy sự khác biệt và cho thấy nó dừng ở đâu (mục Build bên dưới có các lệnh tạo ra local/ và store/):

Terminal window
$ diff -r local store
Only in store/helm/helm: db--app-zuuser-zupassword--db-externalsecret-db-app-user-password.yaml
Only in local/helm/helm: db--app-zuuser-zupassword--db-secret-db-app-user-password.yaml
Only in store/helm/helm: db--password--db-externalsecret-db-password.yaml
Only in local/helm/helm: db--password--db-secret-db-password.yaml

Bốn dòng, tất cả trong một thư mục, vì ở target này các tệp của một attachment nằm cạnh tệp của chính component thay vì trong một thư mục con. Tên tệp là thứ mang hai tọa độ: db--password-- là attachment password trên db, và db--app-zuuser-zupassword-- là attachment app_user_password — dấu gạch dưới được mã hóa thành -zu, vì ở đây tọa độ và tên riêng của tệp dùng chung một chuỗi.

Bốn dòng, và không gì khác: hai tài nguyên thông tin xác thực chỉ có trong cây của target local, hai chỉ có trong cây của target store. diff -r không báo cáo khác biệt nội dung nào ở bất kỳ tệp nào hai cây có chung, nên bốn tài liệu chung là giống hệt nhau chứ không chỉ tương tự.

Tham chiếu không thay đổi

Container cơ sở dữ liệu đọc cả hai thông tin xác thực dưới dạng biến môi trường dựa trên một secretKeyRef. Khối này giống hệt từng byte ở cả hai target:

- name: POSTGRES_PASSWORD
valueFrom:
secretKeyRef:
name: db-password
key: POSTGRES_PASSWORD
- name: APP_USER_PASSWORD
valueFrom:
secretKeyRef:
name: db-app-user-password
key: APP_USER_PASSWORD

Nó giống hệt vì Recipe tiêu thụ không rẽ nhánh. Nó hỏi slot name và key đã công bố và ghi chúng ra. Cả hai FeatureRecipes công bố cùng hai khóa vì Feature khai báo chúng, nên bên nào cũng thỏa mãn bên tiêu thụ — và ở target store, tham chiếu được phân giải khi operator đã reconcile ExternalSecret thành một Secret dưới tên đó.

Chính tính bất biến này khiến hai dạng có thể thay thế cho nhau. Nếu phía tiêu thụ tự suy ra tên Secret, việc hoán đổi ràng buộc sẽ khiến nó trỏ tới một tài nguyên không còn tồn tại dưới tên đó.

origin có nghĩa là những gì FeatureRecipe nói nó có nghĩa

core/referenced-secret khai báo origin là nơi dữ liệu đến từ đó, và để việc diễn giải nó cho FeatureRecipe:

  • k8s-secret-from-parameter ghi nó vào Secret làm dữ liệu.
  • k8s-external-secret đọc nó như khóa cần lấy từ kho.

Trình biên dịch chuyển chuỗi đi qua mà không thay đổi; nó không phụ thuộc vào việc một chuỗi cụ thể là loại nào trong số đó. Đó là điều cho phép một attachment phục vụ cả hai dạng mà không cần sửa gì ở phía nhà phát triển — và đó là điều cần kiểm tra trước khi hoán đổi một ràng buộc, vì cùng một chuỗi được viết ra phải có nghĩa với bất kỳ FeatureRecipe nào đọc nó.

Tên được công bố, và dấu gạch dưới trong tên slot

Component đặt tên slot thông tin xác thực thứ hai là app_user_password. Tên đối tượng Kubernetes không được chứa dấu gạch dưới, nên provides.name được công bố chuẩn hóa dấu gạch dưới thành dấu gạch nối, và tài nguyên có tên db-app-user-password:

- name: APP_USER_PASSWORD
valueFrom:
secretKeyRef:
name: db-app-user-password

Cả hai FeatureRecipes chuẩn hóa giống hệt nhau, đó là lý do hoán đổi ràng buộc không làm thay đổi tham chiếu của bên tiêu thụ. Tên được công bố một lần, ở phía tạo ra, và cả tài nguyên được xuất ra lẫn tham chiếu của bên tiêu thụ đều được phân giải từ giá trị được công bố duy nhất đó.

Target store yêu cầu gì ở cluster

ExternalSecret là một custom resource. Áp dụng đầu ra của target store lên một cluster đòi hỏi một operator kho bí mật đang chạy ở đó, và một ClusterSecretStore tên là platform-secret-store tồn tại. Không có gì trong workspace này cài đặt chúng: ví dụ render những gì một cluster như vậy tiêu thụ, và hướng dẫn cách chọn dạng.

Cluster chạy kho nào, và dưới tên gì, là thuộc tính của target chứ không phải của ứng dụng, nên k8s-external-secret không có khóa authoring nào cho nó. Một cluster có kho được đặt tên khác được phục vụ bởi một FeatureRecipe đặt tên kho đó.

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 credential-shape-per-target

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 credential-shape-per-target

Build

Terminal window
aggrega build --release release-local.yaml --auto-pull
aggrega build --release release-store.yaml --auto-pull

--auto-pull phân giải catalog thành một lockfile bên cạnh Release ở lần build đầu tiên; các lần build sau của cùng Release không cần flag.

Cả hai target đều ghi vào dist/, và aggrega build không xóa nó, nên hãy giữ riêng đầu ra của mỗi lần chạy để so sánh hai bên:

Terminal window
out=$(mktemp -d)
rm -rf dist && aggrega build --release release-local.yaml --auto-pull && cp -r dist "$out/local"
rm -rf dist && aggrega build --release release-store.yaml --auto-pull && cp -r dist "$out/store"
( cd "$out" && diff -r local store )

Để xác nhận mỗi target render một cách tất định, thêm --verify-determinism: mỗi node được render hai lần và quá trình build dừng lại nếu hai lần render của bất kỳ node nào khác nhau.

Terminal window
aggrega build --release release-local.yaml --verify-determinism
aggrega build --release release-store.yaml --verify-determinism

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 `credential-shape-per-target`, hãy gọi công cụ `scaffold` một lần với `example` đặt thành `credential-shape-per-target` và không có `dir`: công cụ này ghi ví dụ vào một thư mục `credential-shape-per-target` mới. Sau đó gọi công cụ `build` một lần cho mỗi Release, theo thứ tự này — `release-local.yaml`, `release-store.yaml` — mỗi lần với `workspace_root` đặt thành `credential-shape-per-target`, `release` đặt thành tệp đó, `auto_pull` đặt thành true và `write` đặt thành true. Hãy cho tôi biết mỗi lần build đã ghi những tệp nào; chúng nằm trong `credential-shape-per-target/dist/`.

Các tệp

  • aggregate.yaml — ý định của nhà phát triển: một component db kiểu core/datastore/postgres, với cả hai slot thông tin xác thực được điền bởi core/referenced-secret. Được cả hai Releases dùng nguyên vẹn.
  • manifest-local.yaml — ràng buộc core/referenced-secret với k8s-secret-from-parameter, thứ render một Kubernetes Secret từ dữ liệu được viết ra.
  • manifest-store.yaml — ràng buộc cùng Feature đó với k8s-external-secret, thứ render một ExternalSecret đặt tên mục trong kho. Giống hệt manifest-local.yaml ngoại trừ tên của chính nó và một dòng đó.
  • release-local.yaml, release-store.yaml — hai Releases. Giống hệt nhau ngoại trừ tên của chính chúng và Manifest mà mỗi cái trỏ tới.
  • .aggrega-config.yaml — chỉ định registry của hub mà các thực thể catalog được phân giải từ đó.

Các giá trị origin ở đây là placeholder. Chúng không phải thông tin xác thực cho bất kỳ dịch vụ thực nào, và ở target local cả hai đều được render vào đầu ra dưới dạng văn bản rõ.