Secrets
Cette page explique une seule idée, la façon dont une information d’identification atteint le composant qui en a besoin, et n’est pas un espace de travail exécutable. Plateforme avancée — une plateforme Kubernetes à plusieurs frontières montre les deux modèles de livraison dans un espace de travail que vous construisez ; écrivez-le dans un dossier à vous avec :
aggrega scaffold --example advanced-platformElle affiche ensuite les prochaines commandes à exécuter :
cd advanced-platformaggrega pull --release release.yamlaggrega build --release release.yamlLa liste de contrôle de la livraison des secrets
Une information d’identification passe par six surfaces avant d’atteindre un conteneur en cours d’exécution. Voici les points de contact à vérifier lorsque vous en câblez une nouvelle :
| Étape | Surface | Action |
|---|---|---|
| 1 | featuresSchema: du Component | Déclarer l’emplacement d’informations d’identification : son nom, s’il est required, et sa liste d’autorisation inject: — les mécanismes de livraison qu’un rattachement peut nommer, [env] ou [env, file] pour un emplacement transparent, [] pour un emplacement opaque. |
| 2 | schema: de la Feature d’informations d’identification | Définir ce qu’un auteur fournit : les Features d’informations d’identification de la bibliothèque standard portent l’étiquette feature.aggrega.ai/kind: secret et prennent le localisateur de l’information d’identification comme origin, et la clé de données comme key. |
| 3 | Aggregate features: | Demander l’information d’identification, sous le même mot-clé features: que toute autre Feature : son type, ses values et, sur un emplacement transparent uniquement, un bloc inject: indiquant comment l’application la lit. |
| 4 | FeatureRecipe | La réaliser pour la cible : écrire la valeur là où le composant la lit, effectuer le rendu d’une ressource qui la contient, ou en rendre une qui la récupère depuis un magasin de secrets. |
| 5 | mappings.features.type du Manifest | Lier la Feature d’informations d’identification à sa FeatureRecipe, dans le même niveau que toute autre Feature. |
| 6 | Recipe | La lire, sur un emplacement opaque : la Recipe du composant lit le localisateur que publie l’information d’identification, .features.<slot>.provides.name, et le transmet au mécanisme propre du produit, tel que existingSecret d’un chart. |
Un emplacement transparent utilise les cinq premières ; un emplacement opaque les utilise toutes les six, ce qui est le cas habituel pour une infrastructure empaquetée comme le chart d’un fournisseur.
Emplacements transparents et opaques
Un emplacement transparent permet au développeur d’indiquer comment l’application lit l’information d’identification. Un emplacement opaque laisse la livraison à la Recipe, et un rattachement qui y écrit un bloc inject: arrête le build. Dans l’exemple, core/datastore/mariadb en déclare un de chaque sorte, et l’Aggregate remplit les deux, à partir de aggregate.yaml sans ses commentaires :
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 est opaque : core/secret-value livre la valeur sous la clé que nomme le rattachement, là où la Recipe de la base de données la lit. user_password est transparent : core/secret-provided publie la valeur comme value, et le propre bloc inject: du rattachement la livre dans MARIADB_PASSWORD. Un bloc inject: nommant un mécanisme que l’emplacement ne liste pas arrête le build, tout comme un bloc nommant une clé que rien ne publie ni ne lit.
Pour un emplacement opaque rempli par une information d’identification référençable, la Recipe du composant lit le localisateur publié au lieu de dériver un nom, existingSecret: "{{ .features.root_password.provides.name }}", de sorte que le Secret qu’émet une FeatureRecipe et la référence à celui-ci sont une seule et même chaîne. MariaDB (chart Bitnami) — un seul Secret d’informations d’identification à plusieurs clés construit ce flux avec le chart d’un fournisseur.
Réaliser une information d’identification : une ressource, ou un pipeline en deux étapes
Les réalisations Kubernetes de la bibliothèque standard effectuent le rendu de la ressource de l’information d’identification à partir d’un petit chart placé à côté de la FeatureRecipe : helm/k8s-secret-from-parameter un Secret contenant la valeur fournie par un auteur, et helm/k8s-external-secret un ExternalSecret que l’External Secrets Operator réconcilie à partir d’un magasin de secrets. Features d’informations d’identification les présente l’une après l’autre.
Une FeatureRecipe peut plutôt réaliser une information d’identification avec un pipeline: de deux étapes, chacune étant un plugin. La première, le récupérateur, écrit la ressource propre au magasin — un ExternalSecret, par exemple — en nommant l’entrée du magasin que donnent les valeurs du rattachement. La seconde, l’injecteur, applique un correctif à la charge de travail rendue du composant pour monter le Secret obtenu dans son conteneur, aux variables ou aux fichiers que nomme le bloc inject: du rattachement, que l’étape lit dans .inject. Passer à un autre magasin de secrets remplace le récupérateur ; l’injecteur reste. Une étape renvoie les ressources qu’elle ajoute comme effets de bord et ses modifications des documents rendus comme correctifs ; le contrat des plugins Wasm est la forme des deux.
Les informations d’identification propres à une Feature
Une Feature peut avoir besoin d’informations d’identification qui lui sont propres : un proxy de garde-fous qui s’authentifie auprès d’un service en amont, un expéditeur de journaux avec un jeton d’ingestion. La Feature déclare l’emplacement dans son propre featuresSchema, exactement comme le fait un Component, et la FeatureRecipe liée à elle lit ce qui remplit cet emplacement lorsqu’elle effectue le rendu de la charge de travail de la Feature.
Les rattachements ne s’imbriquent pas. Les informations d’identification sont rattachées à côté de la Feature, sur le même composant, sous le nom que déclare l’emplacement de la Feature ; le nom de l’emplacement est ce qui relie les deux. La Feature de garde et le composant ci-dessous sont des entités propres à l’espace de travail ; core/referenced-secret appartient à la bibliothèque standard.
# 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-keyLa FeatureRecipe de la garde effectue le rendu d’une charge de travail dont le conteneur référence l’emplacement, attachments: { GUARD_API_KEY: { from: guard_api_key, as: env } }, de sorte que la référence aboutit sur le conteneur de la garde et sur aucun autre. La Recipe du composant hôte ne peut pas référencer l’emplacement, car il appartient à la Feature : une charge de travail qui cherche à l’atteindre arrête le build en nommant l’emplacement. Une entrée de charge de travail nommant un emplacement que rien ne remplit arrête aussi le build, puisqu’il n’existe aucun localisateur publié à résoudre.
Il en va de même pour les connexions que trace une Feature : une connexion dans le propre bloc uses: de la Feature ne porte aucun rattachement, donc les informations d’identification dont une telle connexion a besoin sont un emplacement que déclare la Feature, rempli à côté de la Feature.
Les informations d’identification propres à une connexion
Une passerelle qui atteint deux modèles peut présenter une clé différente à chacun, ou une clé à l’un et aucune à l’autre. Un emplacement sur la passerelle contient une seule information d’identification pour tout le composant, de sorte que les informations d’identification vont plutôt sur la connexion : le socket de la passerelle déclare l’emplacement que chaque connexion qui le traverse peut remplir, et chaque connexion le remplit, ou non, de son côté.
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-keyLa Recipe de la passerelle lit le rattachement depuis sa connexion, dans .context.uses.gpt.features.credential, de sorte qu’une passerelle qui atteint plusieurs modèles lit la clé propre à chaque modèle ; core/gateway/litellm livre chacune comme une variable distincte, que nomme l’entrée de la connexion dans sa table de routage. Un rattachement sous un nom pour lequel le socket ne déclare aucun emplacement arrête le build, en nommant les emplacements qu’il déclare. Le Manifest peut réaliser les informations d’identification d’une connexion différemment des autres, sous la clé <connection>.credential dans son niveau par instance. Informations d’identification sur les connexions — une clé par connexion, et une seule clé aux deux extrémités construit cela ; une Release peut aussi câbler une telle connexion et nommer le secret dans l’infra du rattachement, comme le décrit Features d’informations d’identification.