Przejdź do głównej zawartości
AggregaAggrega
Wybierz język: Polski
Ta strona została przetłumaczona maszynowo. Przeczytaj oryginał w języku angielskim.

Dostarczanie poświadczeń — `secretKeyRef` od początku do końca

Pojedyncza baza danych PostgreSQL, której hasło dostarcza podsystem poświadczeń, pokazana dla każdego dostawcy. To samo gniazdo password w core/datastore/postgres przyjmuje dowolną rodzinę poświadczeń; rodzina, którą programista dołączy, decyduje o sposobie dostarczenia hasła, a encja Recipe bazy danych odczytuje gniazdo w sposób obsługiwany przez jej dostawcę.

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:

Terminal window
aggrega scaffold --example credential-secretkeyref

Następnie wypisuje polecenia do uruchomienia w dalszej kolejności. Pierwsze przechodzi do nowego folderu:

Terminal window
cd credential-secretkeyref

Kompilacja

Ten przykład zawiera trzy wydania. W jednym uruchomieniu buduje się jedno:

Terminal window
aggrega build --release release-helm.yaml --auto-pull
aggrega build --release release-compose.yaml --auto-pull
aggrega build --release release-negative.yaml --auto-pull # expected to fail (see below)

Każde wydanie rozwiązuje encje swojego katalogu przez .aggrega-config.yaml tej przestrzeni roboczej, z rejestru hub, który ten plik wskazuje jako domyślny, więc flaga --catalog nie jest potrzebna, a --auto-pull zapisuje w trakcie kompilacji plik blokady, którego brakuje w świeżym klonie.

Z 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-secretkeyref`, wywołaj raz narzędzie `scaffold` z `example` ustawionym na `credential-secretkeyref` i bez `dir`: zapisuje ono przykład w nowym folderze `credential-secretkeyref`. Następnie wywołaj narzędzie `build` raz dla każdej encji Release, w tej kolejności — `release-helm.yaml`, `release-compose.yaml` — za każdym razem z `workspace_root` ustawionym na `credential-secretkeyref`, `release` ustawionym na ten plik, `auto_pull` ustawionym na true i `write` ustawionym na true. Następnie wywołaj narzędzie `build` w ten sam sposób z `release` ustawionym na `release-negative.yaml`: ta kompilacja ma zostać odrzucona, więc przeczytaj mi komunikat odrzucenia. Podaj mi, które pliki zapisała każda kompilacja; znajdują się w `credential-secretkeyref/dist/`.

Helm — referencjonowalny Secret + secretKeyRef

aggregate-helm.yaml dołącza core/referenced-secret do gniazda password. Encja Manifest mapuje to na k8s-secret-from-parameter, który materializuje Secret Kubernetes i publikuje tożsamość tego Secretu jako provides {name, key}. Encja Recipe postgres dla helm odwołuje się do gniazda przez containers.attachments, które syntezator renderuje jako secretKeyRef w zmiennej środowiskowej.

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

Wygenerowany Secret (dist/helm/helm/db--password--db-secret-db-password.yaml) oraz secretKeyRef bazy danych (dist/helm/helm/db-statefulset.yaml) wskazują ten sam zasób, ponieważ oba odczytują .features.password.provides.name — nie ma ponownego wyprowadzania ani konwencji, co do której obie strony musiałyby się zgodzić:

db--password--db-secret-db-password.yaml
[… omitted: the apiVersion and the Secret kind]
metadata:
name: db-password
[… omitted: the labels and annotations every rendered document carries]
stringData:
POSTGRES_PASSWORD: "dev-pw-change-me"
# db-statefulset.yaml (container env)
- name: POSTGRES_PASSWORD
valueFrom:
secretKeyRef:
name: db-password # == the Secret's metadata.name
key: POSTGRES_PASSWORD # == the Secret's data key

Compose — poświadczenie typu inject-value

aggregate-compose.yaml dołącza core/secret-value. Compose nie ma prymitywu zasobu Secret ani secretKeyRef, więc encja Manifest mapuje poświadczenie na dotenv-secret, który dostarcza wartość kanałem inject pod kluczem wskazanym przez dołączenie w values.key, tutaj POSTGRES_PASSWORD, a encja Recipe postgres dla compose odczytuje ją pod tym kluczem.

Terminal window
aggrega build --release release-compose.yaml --auto-pull
# dist/compose/compose/docker-compose.yaml → POSTGRES_PASSWORD: dev-pw-change-me

Przypadek negatywny — niereferencjonowalne wypełnienie odrzucone przez referencję

aggregate-negative.yaml dołącza poświadczenie inject-value core/secret-value do gniazda password, a następnie buduje dla helm, gdzie encja Recipe postgres odwołuje się do gniazda przez containers.attachments (secretKeyRef). secretKeyRef wymaga zasobu Secret, na który może wskazywać, ale poświadczenie inject-value żadnego nie publikuje — więc budowanie zatrzymuje się z wyraźnym błędem:

Terminal window
aggrega build --release release-negative.yaml --auto-pull
# [… omitted: the pull's lines, which carry the same halt, and two lint notices]
# [CATALOG_ERROR E0212] instance db
# rendering node "db"
# [… omitted: the cause, "workload attachment slot is not referenceable", naming the Recipe and its path in your catalog, then one line each for the "name" and the "key" the slot's provides does not expose]

To wydanie ma zakończyć się niepowodzeniem — zatrzymanie jest tu lekcją. Kompilacja kończy się kodem 1 zamiast zgłaszać sukces, dzięki czemu zabezpieczenie jest widoczne dla czytelnika i dla każdego skryptu, który ją uruchamia.

Są dwa rozwiązania. Można dołączyć referencjonowalne poświadczenie (core/referenced-secret), jak w aggregate-helm.yaml; albo zachować załącznik core/secret-value i zmapować go w encji Manifest na k8s-secret-from-value, realizację Helm dla core/secret-value, która zapisuje wartość w emitowanym przez siebie obiekcie Secret i publikuje nazwę i klucz tego obiektu Secret, dzięki czemu referencja ma zasób, na który może wskazywać. Powiązane z env-secret poświadczenie inject-value trafia do kontenera kanałem inject, nigdy przez referencję containers.attachments.