Lewati ke konten
AggregaAggrega
Pilih Bahasa: Bahasa Indonesia
Halaman ini diterjemahkan oleh mesin. Baca versi asli dalam bahasa Inggris.

Satu maksud pengembang, dua bentuk pengiriman kredensial

Cara kredensial mencapai kontainer yang berjalan adalah properti dari tempat Anda melakukan deploy, bukan dari aplikasinya. Satu kluster tidak memiliki penyimpanan rahasia, sehingga deployment mengirimkan materinya sendiri dalam Kubernetes Secret. Kluster lain menjalankan operator penyimpanan rahasia, sehingga deployment hanya mengirimkan penunjuk dan kluster mengambil materinya saat rekonsiliasi.

Workspace ini memuat satu Aggregate dan membangunnya untuk dua target. Aggregate tersebut tidak berubah di antara keduanya. Begitu pula referensi basis data ke kata sandinya. Yang berubah adalah satu baris dalam sebuah Manifest.

Apa yang berubah, dan apa yang tetap

berkastarget lokaltarget penyimpanan
aggregate.yamlberkas yang samaberkas yang sama
Manifestmanifest-local.yamlmanifest-store.yaml
Releaserelease-local.yamlrelease-store.yaml

Kedua Manifests berbeda pada namanya sendiri dan pada satu entri pemetaan:

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

Kedua Releases berbeda pada namanya sendiri dan pada Manifest yang ditunjuknya:

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

Kedua Releases mendeklarasikan environment yang sama. Hal ini disengaja: nama lingkungan dicapkan ke setiap dokumen yang dirender sebagai label, sehingga menahannya tetap menyisakan tepat satu hal yang bebas berubah — FeatureRecipe yang diikat oleh Manifest. Pasangan Releases yang nyata tentu akan menamai lingkungannya masing-masing, dan bentuk kredensialnya akan berbeda dengan cara yang persis sama.

Sisi pengembang, sekali saja

aggregate.yaml mengisi kedua slot kredensial milik Component PostgreSQL dengan Feature kredensial yang dapat dirujuk yang sama:

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 menamai sebuah sumber daya rahasia, yang dibuat oleh keluaran FeatureRecipe-nya atau yang sudah ada, dan menerbitkan locator sumber daya tersebut — yaitu name dan key data di dalamnya — melalui kontrak provides-nya. Recipe yang mengonsumsinya membaca locator itu. Recipe tersebut tidak pernah menurunkan nama sumber daya sendiri, dan tidak pernah menanyakan FeatureRecipe mana yang menghasilkannya.

Apa yang dihasilkan setiap target

Setiap build menulis enam berkas. Empat di antaranya — StatefulSet, kedua Service, dan ConfigMap inisialisasi — keluar identik byte demi byte dari kedua target. Dua lainnya adalah sumber daya kredensial, satu per slot yang terisi, dan di sanalah kedua target berbeda.

Target lokal, dari k8s-secret-from-parameter, di 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 penyimpanan, dari k8s-external-secret, di 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"

Grup API berbeda, kind berbeda, isi berbeda. Pada target lokal, materi kredensial berada dalam dokumen yang dirender, dapat dibaca oleh siapa pun yang dapat membaca deployment — itulah sebabnya bentuk tersebut cocok untuk kluster lokal dan pengembangan, bukan kluster produksi. Pada target penyimpanan, dokumen yang dirender hanya memuat nama entri; materinya tetap berada di penyimpanan dan operator merekonsiliasinya menjadi Secret bernama db-password.

Membandingkan kedua pohon keluaran menunjukkan perbedaannya dan di mana perbedaan itu berhenti (bagian Build di bawah memuat perintah yang menghasilkan local/ dan 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

Empat baris, semuanya dalam satu direktori, karena berkas sebuah lampiran berada di samping berkas komponen itu sendiri pada target ini, bukan di subdirektori. Nama berkaslah yang membawa kedua koordinat: db--password-- adalah lampiran password pada db, dan db--app-zuuser-zupassword-- adalah lampiran app_user_password — garis bawah dikodekan sebagai -zu, karena koordinat dan nama berkas itu sendiri berbagi satu string di sini.

Empat baris, dan tidak ada yang lain: dua sumber daya kredensial yang hanya ada di pohon target lokal, dua yang hanya ada di pohon target penyimpanan. diff -r tidak melaporkan perbedaan konten pada berkas mana pun yang dimiliki bersama oleh kedua pohon, sehingga keempat dokumen bersama benar-benar identik, bukan sekadar mirip.

Referensi yang tidak berubah

Kontainer basis data membaca kedua kredensial sebagai variabel lingkungan yang didukung oleh secretKeyRef. Blok ini identik byte demi byte di kedua 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

Blok ini identik karena Recipe yang mengonsumsinya tidak bercabang. Recipe itu meminta slot untuk name dan key yang diterbitkannya lalu menuliskannya. Kedua FeatureRecipes menerbitkan dua kunci yang sama karena Feature mendeklarasikannya, sehingga salah satunya memenuhi kebutuhan konsumen — dan pada target penyimpanan, referensi tersebut terselesaikan setelah operator merekonsiliasi ExternalSecret menjadi Secret dengan nama tersebut.

Invariansi inilah yang membuat kedua bentuk dapat saling menggantikan. Jika sisi konsumen menurunkan nama Secret sendiri, menukar binding akan membuatnya menunjuk ke sumber daya yang tidak lagi ada dengan nama tersebut.

origin berarti apa yang dikatakan FeatureRecipe

core/referenced-secret mendeklarasikan origin sebagai asal materi, dan menyerahkan interpretasinya kepada FeatureRecipe:

  • k8s-secret-from-parameter menuliskannya ke dalam Secret sebagai materi.
  • k8s-external-secret membacanya sebagai kunci yang diambil dari penyimpanan.

Compiler meneruskan string tersebut tanpa perubahan; compiler agnostik terhadap yang mana dari keduanya suatu string. Itulah yang memungkinkan satu lampiran melayani kedua bentuk tanpa suntingan di sisi pengembang — dan itulah yang perlu diperiksa sebelum menukar binding, karena string yang sama harus bermakna bagi FeatureRecipe mana pun yang membacanya.

Nama yang diterbitkan, dan garis bawah dalam nama slot

Component menamai slot kredensial keduanya app_user_password. Nama objek Kubernetes tidak boleh mengandung garis bawah, sehingga provides.name yang diterbitkan menormalkan garis bawah menjadi tanda hubung, dan sumber daya tersebut menjadi db-app-user-password:

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

Kedua FeatureRecipes melakukan normalisasi secara identik, itulah sebabnya menukar binding tidak menggeser referensi konsumen. Nama tersebut diterbitkan sekali, di sisi penghasil, dan sumber daya yang dihasilkan serta referensi konsumen sama-sama terselesaikan dari satu nilai yang diterbitkan itu.

Apa yang diharapkan target penyimpanan dari kluster

ExternalSecret adalah custom resource. Menerapkan keluaran target penyimpanan ke kluster mengharuskan operator penyimpanan rahasia berjalan di sana, dan ClusterSecretStore bernama platform-secret-store tersedia. Tidak ada apa pun dalam workspace ini yang memasang keduanya: contoh ini merender apa yang dikonsumsi kluster semacam itu, dan mengajarkan bagaimana bentuknya dipilih.

Penyimpanan mana yang dijalankan kluster, dan dengan nama apa, adalah properti dari target, bukan dari aplikasi, sehingga k8s-external-secret tidak memiliki kunci authoring untuk itu. Kluster yang penyimpanannya bernama lain dilayani oleh FeatureRecipe yang menamai penyimpanan tersebut.

Membuat contoh

Anda dapat mem-build contoh ini dengan perintah di bawah, atau meminta asisten AI Anda mem-build-nya untuk Anda.

Tulis contoh ke folder baru yang dinamai sesuai contoh itu:

Terminal window
aggrega scaffold --example credential-shape-per-target

Kemudian ia mencetak perintah yang dijalankan berikutnya. Perintah pertama berpindah ke folder baru:

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 meresolusi katalog ke dalam lockfile di samping Release pada build pertama; build berikutnya dari Release yang sama tidak memerlukan flag.

Kedua target menulis ke dist/, dan aggrega build tidak membersihkannya, jadi simpan keluaran setiap eksekusi secara terpisah untuk membandingkan keduanya:

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 )

Untuk memastikan setiap target merender secara deterministik, tambahkan --verify-determinism: setiap node dirender dua kali dan build berhenti jika dua render dari node mana pun berbeda.

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

Dengan asisten AI

Asisten AI yang disiapkan dengan tool Aggrega dapat melakukan hal yang sama: tempelkan prompt ini ke asisten tersebut.

Gunakan hanya alat Aggrega, dan jangan membuat folder sendiri. Jika folder ruang kerja belum berisi folder `credential-shape-per-target`, panggil alat `scaffold` sekali dengan `example` diatur ke `credential-shape-per-target` dan tanpa `dir`: alat ini menulis contoh ke dalam folder `credential-shape-per-target` yang baru. Lalu panggil alat `build` sekali untuk setiap Release, dengan urutan ini — `release-local.yaml`, `release-store.yaml` — setiap kali dengan `workspace_root` diatur ke `credential-shape-per-target`, `release` diatur ke file tersebut, `auto_pull` diatur ke true, dan `write` diatur ke true. Beri tahu saya file mana yang ditulis oleh setiap build; file tersebut berada di bawah `credential-shape-per-target/dist/`.

Berkas

  • aggregate.yaml — maksud pengembang: satu komponen db bertipe core/datastore/postgres, dengan kedua slot kredensial diisi oleh core/referenced-secret. Digunakan tanpa perubahan oleh kedua Releases.
  • manifest-local.yaml — mengikat core/referenced-secret ke k8s-secret-from-parameter, yang merender Kubernetes Secret dari materi yang ditulis.
  • manifest-store.yaml — mengikat Feature yang sama ke k8s-external-secret, yang merender ExternalSecret yang menamai entri penyimpanan. Identik dengan manifest-local.yaml kecuali namanya sendiri dan satu baris tersebut.
  • release-local.yaml, release-store.yaml — kedua Releases. Identik kecuali namanya masing-masing dan Manifest yang ditunjuk masing-masing.
  • .aggrega-config.yaml — menyebut registri hub tempat entitas katalog di-resolve.

Nilai origin di sini adalah placeholder. Nilai tersebut bukan kredensial untuk layanan nyata apa pun, dan pada target lokal keduanya dirender ke dalam keluaran tanpa enkripsi.