Sekrety
Ta strona wyjaśnia jedną ideę, czyli to, jak poświadczenie dociera do komponentu, który go potrzebuje, i nie jest uruchamialnym obszarem roboczym. Zaawansowana platforma — platforma Kubernetes z wieloma granicami pokazuje oba modele dostarczania w obszarze roboczym budowanym samodzielnie; można go zapisać we własnym folderze za pomocą:
aggrega scaffold --example advanced-platformNastępnie wypisuje polecenia do uruchomienia w dalszej kolejności:
cd advanced-platformaggrega pull --release release.yamlaggrega build --release release.yamlLista kontrolna dostarczania sekretów
Poświadczenie przechodzi przez sześć miejsc, zanim dotrze do działającego kontenera. Oto punkty styku, które należy sprawdzić przy podłączaniu nowego:
| Krok | Miejsce | Działanie |
|---|---|---|
| 1 | Component featuresSchema: | Zadeklarowanie slotu poświadczenia: jego nazwy, tego, czy jest required, oraz jego listy dozwolonych wartości inject: — mechanizmów dostarczania, które może wskazać załącznik, [env] lub [env, file] dla slotu przezroczystego, [] dla nieprzezroczystego. |
| 2 | Feature poświadczenia schema: | Zdefiniowanie tego, co dostarcza autor: Features poświadczeń z biblioteki standardowej mają etykietę feature.aggrega.ai/kind: secret i przyjmują lokalizator poświadczenia jako origin, a klucz danych jako key. |
| 3 | Aggregate features: | Zażądanie poświadczenia pod tym samym słowem kluczowym features: co każda inna encja Feature: podając jego type, jego values oraz, tylko w przezroczystym slocie, blok inject: określający, jak aplikacja je odczytuje. |
| 4 | FeatureRecipe | Zrealizowanie go dla celu: zapisanie wartości tam, gdzie komponent ją odczytuje, wyrenderowanie zasobu, który ją przechowuje, albo wyrenderowanie zasobu, który pobiera ją z magazynu sekretów. |
| 5 | Manifest mappings.features.type | Powiązanie encji Feature poświadczenia z jej encją FeatureRecipe, w tej samej warstwie co każda inna encja Feature. |
| 6 | Recipe | Odczytanie go w nieprzezroczystym slocie: encja Recipe komponentu odczytuje lokalizator publikowany przez poświadczenie, .features.<slot>.provides.name, i przekazuje go własnemu mechanizmowi produktu, takiemu jak existingSecret chartu. |
Przezroczysty slot wykorzystuje pierwsze pięć z nich; nieprzezroczysty slot wykorzystuje wszystkie sześć, co jest typowym przypadkiem dla spakowanej infrastruktury, takiej jak chart dostawcy.
Sloty przezroczyste i nieprzezroczyste
Slot przezroczysty pozwala programiście określić, jak aplikacja odczytuje poświadczenie. Slot nieprzezroczysty pozostawia dostarczenie encji Recipe, a załącznik zapisujący w nim blok inject: zatrzymuje kompilację. W przykładzie core/datastore/mariadb deklaruje po jednym z każdego rodzaju, a encja Aggregate wypełnia oba, z aggregate.yaml z pominięciem komentarzy:
db: type: core/datastore/mariadb features: root_password: type: core/secret-value values: key: MARIADB_ROOT_PASSWORD origin: dev-root-pw-change-me user_password: type: core/secret-provided values: origin: dev-app-pw-change-me inject: env: - in: MARIADB_PASSWORD from: valueroot_password jest nieprzezroczysty: core/secret-value dostarcza wartość pod kluczem wskazanym przez załącznik, gdzie odczytuje ją encja Recipe bazy danych. user_password jest przezroczysty: core/secret-provided publikuje wartość jako value, a własny blok inject: załącznika dostarcza ją do MARIADB_PASSWORD. Blok inject: wskazujący mechanizm, którego slot nie wymienia, zatrzymuje kompilację, podobnie jak blok wskazujący klucz, którego nic nie publikuje ani nie odczytuje.
W przypadku nieprzezroczystego slotu wypełnionego poświadczeniem, do którego można się odwołać, encja Recipe komponentu odczytuje opublikowany lokalizator zamiast wyprowadzać nazwę, existingSecret: "{{ .features.root_password.provides.name }}", dzięki czemu Secret emitowany przez encję FeatureRecipe i odwołanie do niego są jednym ciągiem znaków. MariaDB (chart Bitnami) — jeden wielokluczowy Secret poświadczeń buduje ten przepływ na charcie dostawcy.
Realizacja poświadczenia: zasób albo dwuetapowy potok
Realizacje Kubernetes z biblioteki standardowej renderują zasób poświadczenia z małego chartu umieszczonego obok encji FeatureRecipe: helm/k8s-secret-from-parameter renderuje Secret przechowujący wartość podaną przez autora, a helm/k8s-external-secret renderuje ExternalSecret, który External Secrets Operator uzgadnia z magazynem sekretów. Features poświadczeń omawia każdą z nich.
Encja FeatureRecipe może zamiast tego zrealizować poświadczenie za pomocą pipeline: złożonego z dwóch kroków, z których każdy jest wtyczką. Pierwszy, moduł pobierający, zapisuje zasób specyficzny dla magazynu — na przykład ExternalSecret — wskazujący wpis magazynu podany w wartościach załącznika. Drugi, moduł wstrzykujący, nakłada łatkę na wyrenderowane obciążenie robocze komponentu, aby zamontować powstały Secret w jego kontenerze, w zmiennych lub plikach wskazanych przez blok inject: załącznika, które krok odczytuje z .inject. Przejście na inny magazyn sekretów zastępuje moduł pobierający; moduł wstrzykujący pozostaje. Krok zwraca dodawane zasoby jako efekty uboczne, a swoje zmiany w wyrenderowanych dokumentach jako łatki; kontrakt wtyczek Wasm określa kształt obu.
Własne poświadczenie encji Feature
Encja Feature może potrzebować własnego poświadczenia: proxy zabezpieczające, które uwierzytelnia się w usłudze nadrzędnej, agent wysyłający logi z tokenem pobierania. Feature deklaruje slot we własnym featuresSchema, dokładnie tak jak Component, a FeatureRecipe z nią powiązana odczytuje to, co wypełnia ten slot, gdy renderuje obciążenie robocze encji Feature.
Załączniki nie są zagnieżdżane. Poświadczenie jest dołączane obok encji Feature, w tym samym komponencie, pod nazwą zadeklarowaną przez slot encji Feature; to nazwa slotu wiąże je ze sobą. Encja Feature strażnika i komponent poniżej są encjami własnymi obszaru roboczego; core/referenced-secret pochodzi z biblioteki standardowej.
# The Feature declares the slotkind: Featuremetadata: name: local/guardspec: appliesTo: "component.aggrega.ai/type in (server, worker)" featuresSchema: guard_api_key: selector: "feature.aggrega.ai/kind=secret" sensitive: true inject: [env]---# The Aggregate fills it beside the Featurespec: components: finance-agent: type: local/compute/guarded-worker features: ai-guard: type: local/guard guard_api_key: type: core/referenced-secret values: origin: dev-guard-key-change-me key: api-keyEncja FeatureRecipe strażnika renderuje obciążenie robocze, którego kontener odwołuje się do slotu, attachments: { GUARD_API_KEY: { from: guard_api_key, as: env } }, dzięki czemu odwołanie trafia do kontenera strażnika i do żadnego innego. Encja Recipe komponentu-hosta nie może odwoływać się do slotu, ponieważ należy on do encji Feature: obciążenie robocze, które po niego sięga, zatrzymuje kompilację, podając nazwę slotu. Wpis obciążenia roboczego wskazujący slot, którego nic nie wypełnia, również zatrzymuje kompilację, ponieważ nie ma opublikowanego lokalizatora do rozwiązania.
To samo dotyczy połączeń, które tworzy Feature: połączenie we własnym bloku uses: encji Feature nie przenosi załączników, więc poświadczenie potrzebne takiemu połączeniu jest slotem deklarowanym przez Feature i wypełnianym obok encji Feature.
Własne poświadczenie połączenia
Brama łącząca się z dwoma modelami może przedstawiać każdemu inny klucz albo jednemu klucz, a drugiemu żaden. Slot na bramie przechowuje jedno poświadczenie dla całego komponentu, dlatego poświadczenie umieszcza się zamiast tego na połączeniu: gniazdo bramy deklaruje slot, który może wypełnić każde przechodzące przez nie połączenie, a każde połączenie wypełnia go albo nie, niezależnie od pozostałych.
spec: components: router: type: core/gateway/litellm uses: models: gpt: target: gpt features: credential: # a slot the models socket declares type: core/referenced-secret values: key: api-keyEncja Recipe bramy odczytuje załącznik ze swojego połączenia, z .context.uses.gpt.features.credential, dzięki czemu brama łącząca się z kilkoma modelami odczytuje własny klucz każdego modelu; core/gateway/litellm dostarcza każdy z nich jako osobną zmienną, którą wskazuje wpis połączenia w jego tablicy routingu. Załącznik pod nazwą, dla której gniazdo nie deklaruje żadnego slotu, zatrzymuje kompilację, podając sloty, które gniazdo deklaruje. Encja Manifest może zrealizować poświadczenie jednego połączenia inaczej niż pozostałych, pod kluczem <connection>.credential w swojej warstwie dla poszczególnych instancji. Poświadczenia na połączeniach — klucz na każde połączenie i jeden klucz na obu końcach buduje ten przypadek; encja Release może też podłączyć takie połączenie i wskazać sekret w infra załącznika, jak opisuje Features poświadczeń.