Jedna intencja programisty, dwa kształty dostarczania poświadczeń
Sposób, w jaki poświadczenie trafia do działającego kontenera, jest właściwością miejsca wdrożenia, a nie aplikacji. Jeden klaster nie ma magazynu sekretów, więc wdrożenie samo dostarcza materiał w obiekcie Kubernetes Secret. Inny uruchamia operator magazynu sekretów, więc wdrożenie dostarcza tylko wskaźnik, a klaster pobiera materiał w czasie uzgadniania.
Ten obszar roboczy zawiera jedną encję Aggregate i buduje ją dla dwóch celów. Encja Aggregate nie zmienia się między nimi. Nie zmienia się też odwołanie bazy danych do jej hasła. Zmienia się jeden wiersz w encji Manifest.
Co się zmienia, a co pozostaje stałe
| plik | cel lokalny | cel z magazynem |
|---|---|---|
aggregate.yaml | ten sam plik | ten sam plik |
| Manifest | manifest-local.yaml | manifest-store.yaml |
| Release | release-local.yaml | release-store.yaml |
Dwie encje Manifests różnią się własną nazwą i jednym wpisem mapowania:
$ diff manifest-local.yaml manifest-store.yaml7c7< name: credential-shape-local-manifest---> name: credential-shape-store-manifest16c16< 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.0Dwie encje Releases różnią się własną nazwą i tym, na którą encję Manifest wskazują:
$ diff release-local.yaml release-store.yaml7c7< name: credential-shape-local---> name: credential-shape-store12c12< manifest: credential-shape-local-manifest---> manifest: credential-shape-store-manifestObie encje Releases deklarują to samo environment. Jest to celowe: nazwa środowiska jest umieszczana na każdym renderowanym dokumencie jako etykieta, więc jej ustalenie pozostawia swobodę zmiany dokładnie jednej rzeczy — encji FeatureRecipe, którą wiąże Manifest. Rzeczywista para encji Releases nazwałaby oczywiście własne środowiska, a kształty poświadczeń różniłyby się dokładnie w ten sam sposób.
Strona programisty, jednorazowo
aggregate.yaml wypełnia oba sloty poświadczeń encji Component PostgreSQL
tą samą encją Feature poświadczenia, do którego można się odwołać:
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-passwordcore/referenced-secret nazywa zasób sekretu — taki, który tworzy wynik jej encji FeatureRecipe, albo taki, który już istnieje — i publikuje lokalizator tego zasobu — jego
name oraz key danych w nim — przez swój kontrakt provides. Konsumująca
encja Recipe odczytuje ten lokalizator. Nigdy nie wyprowadza własnej nazwy zasobu
i nigdy nie pyta, która encja FeatureRecipe go wytworzyła.
Co emituje każdy cel
Każda kompilacja zapisuje sześć plików. Cztery z nich — StatefulSet, obie usługi Service i ConfigMap inicjalizacji — są bajtowo identyczne dla obu celów. Pozostałe dwa to zasoby poświadczeń, po jednym na wypełniony slot, i to w nich cele się różnią.
Cel lokalny, z k8s-secret-from-parameter, w
dist/helm/helm/db--password--db-secret-db-password.yaml:
apiVersion: v1kind: Secretmetadata: 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"Cel z magazynem, z k8s-external-secret, w
dist/helm/helm/db--password--db-externalsecret-db-password.yaml:
apiVersion: external-secrets.io/v1kind: ExternalSecretmetadata: 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"Inna grupa API, inny rodzaj, inna treść. W celu lokalnym
materiał poświadczenia znajduje się w renderowanym dokumencie, czytelny dla każdego, kto może odczytać
wdrożenie — dlatego ten kształt pasuje do klastrów lokalnych i deweloperskich,
a nie produkcyjnych. W celu z magazynem renderowany dokument zawiera
tylko nazwę wpisu; materiał pozostaje w magazynie, a operator uzgadnia
go w obiekt Secret o nazwie db-password.
Porównanie obu drzew wyjściowych pokazuje różnicę i to, gdzie się ona kończy
(sekcja Kompilacja poniżej zawiera polecenia, które tworzą local/ i store/):
$ diff -r local storeOnly in store/helm/helm: db--app-zuuser-zupassword--db-externalsecret-db-app-user-password.yamlOnly in local/helm/helm: db--app-zuuser-zupassword--db-secret-db-app-user-password.yamlOnly in store/helm/helm: db--password--db-externalsecret-db-password.yamlOnly in local/helm/helm: db--password--db-secret-db-password.yamlCztery wiersze, wszystkie w jednym katalogu, ponieważ w tym celu pliki załącznika leżą obok
własnych plików komponentu, a nie w podkatalogu. To nazwa pliku
niesie obie współrzędne: db--password-- to załącznik password
na db, a db--app-zuuser-zupassword-- to załącznik app_user_password —
podkreślenie zakodowane jako -zu, ponieważ współrzędna i własna nazwa pliku dzielą
tu jeden ciąg znaków.
Cztery wiersze i nic więcej: dwa zasoby poświadczeń obecne tylko w drzewie celu
lokalnego, dwa obecne tylko w drzewie celu z magazynem. diff -r nie zgłasza żadnej
różnicy treści w żadnym pliku wspólnym dla obu drzew, więc cztery wspólne dokumenty
są identyczne, a nie tylko podobne.
Odwołanie, które się nie zmienia
Kontener bazy danych odczytuje oba poświadczenia jako zmienne środowiskowe oparte na
secretKeyRef. Ten blok jest bajtowo identyczny w obu celach:
- 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_PASSWORDJest identyczny, ponieważ konsumująca encja Recipe nie rozgałęzia się. Pyta slot
o opublikowane name i key i je wypisuje. Obie encje FeatureRecipes
publikują te same dwa klucze, ponieważ deklaruje je encja Feature, więc każda z nich
zaspokaja konsumenta — a w celu z magazynem odwołanie rozwiązuje się, gdy
operator uzgodni ExternalSecret w obiekt Secret o tej nazwie.
To właśnie ta niezmienność sprawia, że oba kształty są wymienne. Gdyby strona konsumująca sama wyprowadzała nazwę obiektu Secret, zamiana powiązania pozostawiłaby ją wskazującą na zasób, który pod tą nazwą już nie istnieje.
origin oznacza to, co mówi encja FeatureRecipe
core/referenced-secret deklaruje origin jako źródło materiału i
pozostawia jego interpretację encji FeatureRecipe:
k8s-secret-from-parameterzapisuje go w obiekcie Secret jako materiał.k8s-external-secretodczytuje go jako klucz do pobrania z magazynu.
Kompilator przekazuje ciąg znaków bez zmian; jest agnostyczny wobec tego, którym z nich jest dany ciąg. To pozwala jednemu załącznikowi obsłużyć oba kształty bez edycji po stronie programisty — i to właśnie należy sprawdzić przed zamianą powiązania, ponieważ ten sam napisany ciąg musi mieć sens dla tej encji FeatureRecipe, która go odczytuje.
Opublikowana nazwa i podkreślenie w nazwie slotu
Encja Component nazywa swój drugi slot poświadczenia app_user_password. Nazwa obiektu
Kubernetes nie może zawierać podkreślenia, więc opublikowane provides.name
zamienia podkreślenia na łączniki, a zasób otrzymuje nazwę
db-app-user-password:
- name: APP_USER_PASSWORD valueFrom: secretKeyRef: name: db-app-user-passwordObie encje FeatureRecipes normalizują identycznie, dlatego zamiana powiązania nie przesuwa odwołania konsumenta. Nazwa jest publikowana raz, po stronie produkującej, a emitowany zasób i odwołanie konsumenta rozwiązują się z tej jednej opublikowanej wartości.
Czego cel z magazynem oczekuje od klastra
ExternalSecret to zasób niestandardowy. Zastosowanie wyniku celu z magazynem w
klastrze wymaga, by działał w nim operator magazynu sekretów i by istniał
ClusterSecretStore o nazwie platform-secret-store. Nic w tym
obszarze roboczym nie instaluje żadnego z nich: przykład renderuje to, co taki klaster konsumuje, i
pokazuje, jak wybierany jest kształt.
To, jaki magazyn działa w klastrze i pod jaką nazwą, jest właściwością celu,
a nie aplikacji, więc k8s-external-secret nie ma dla niego klucza
autorskiego. Klaster, którego magazyn nazywa się inaczej, obsługuje encja FeatureRecipe,
która nazywa ten magazyn.
Generowanie przykładu
Ten przykład można zbudować za pomocą poniższych poleceń albo zlecić jego zbudowanie asystentowi AI.
Należy zapisać przykład w nowym folderze nazwanym tak jak on:
aggrega scaffold --example credential-shape-per-targetNastępnie wypisuje polecenia do uruchomienia w dalszej kolejności. Pierwsze przechodzi do nowego folderu:
cd credential-shape-per-targetKompilacja
aggrega build --release release-local.yaml --auto-pullaggrega build --release release-store.yaml --auto-pull--auto-pull rozwiązuje katalog do pliku blokady obok encji Release przy
pierwszej kompilacji; kolejne kompilacje tej samej encji Release nie wymagają flagi.
Oba cele zapisują do dist/, a aggrega build go nie czyści, więc aby porównać oba,
należy odłożyć wynik każdego uruchomienia:
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 )Aby potwierdzić, że każdy cel renderuje deterministycznie, należy dodać --verify-determinism:
każdy węzeł jest renderowany dwukrotnie, a kompilacja zatrzymuje się, jeśli dwa rendery któregoś węzła
się różnią.
aggrega build --release release-local.yaml --verify-determinismaggrega build --release release-store.yaml --verify-determinismZ asystentem AI
Asystent AI skonfigurowany z narzędziami Aggrega może zrobić to samo: wystarczy wkleić mu ten prompt.
Używaj wyłącznie narzędzi Aggrega i nie twórz samodzielnie żadnego folderu. Jeśli folder obszaru roboczego nie zawiera jeszcze folderu `credential-shape-per-target`, wywołaj raz narzędzie `scaffold` z `example` ustawionym na `credential-shape-per-target` i bez `dir`: zapisuje ono przykład w nowym folderze `credential-shape-per-target`. Następnie wywołaj narzędzie `build` raz dla każdej encji Release, w tej kolejności — `release-local.yaml`, `release-store.yaml` — za każdym razem z `workspace_root` ustawionym na `credential-shape-per-target`, `release` ustawionym na ten plik, `auto_pull` ustawionym na true i `write` ustawionym na true. Podaj mi, które pliki zapisała każda kompilacja; znajdują się w `credential-shape-per-target/dist/`.Pliki
aggregate.yaml— intencja programisty: jeden komponentdbtypucore/datastore/postgres, z oboma slotami poświadczeń wypełnionymi przezcore/referenced-secret. Używany bez zmian przez obie encje Releases.manifest-local.yaml— wiążecore/referenced-secretzk8s-secret-from-parameter, który renderuje obiekt Kubernetes Secret z napisanego materiału.manifest-store.yaml— wiąże tę samą encję Feature zk8s-external-secret, który renderuje ExternalSecret nazywający wpis w magazynie. Identyczny zmanifest-local.yamlpoza własną nazwą i tym jednym wierszem.release-local.yaml,release-store.yaml— dwie encje Releases. Identyczne poza własnymi nazwami i tym, na którą encję Manifest każda wskazuje..aggrega-config.yaml— wskazuje rejestr hub, z którego rozwiązywane są encje katalogu.
Wartości origin są tu symbolami zastępczymi. Nie są poświadczeniami do żadnej rzeczywistej
usługi, a w celu lokalnym obie są renderowane do wyniku jawnym tekstem.