Aller au contenu
AggregaAggrega
Selectionner la langue: Français
Cette page a été traduite automatiquement. Lire l’original en anglais.

Sensibilité déclarée, rendue comme le `sensitive` propre à Terraform

La déclaration qu’une valeur porte du matériel secret est écrite une seule fois, sur le schéma d’un Component. Là où la cible de rendu offre une primitive correspondante qui lui est propre, cette déclaration est rendue dans celle-ci. Cet exemple est le cas Terraform : le build ajoute un fichier d’override qui ajoute sensitive = true à l’entrée du module dans laquelle circule la valeur déclarée, et le moteur masque alors cette valeur partout où il l’afficherait autrement.

L’exemple est délibérément petit et chacune de ses parties est inspectable : un composant, trois entrées de module et un marquage rendu qui en nomme exactement une.

Ce qu’émet le build

Sous dist/infra/terraform/, la configuration racine de la frontière :

  • aggrega.modules.tf — déclarant store comme un bloc module dont le source est ./modules/store et dont les arguments sont les variables d’entrée résolues du module, dans un ordre de clés déterministe. Chaque frontière terraform en reçoit un.

Sous dist/infra/terraform/modules/store/, les fichiers propres du composant store :

  • les fichiers du module copiés octet pour octet — variables.tf et main.tf, exactement tels que l’auteur du module les a écrits ;
  • aggrega_override.tf.json — le marquage de sensibilité, décrit plus bas. Il se trouve à côté des fichiers propres du module parce que Terraform fusionne un override dans la configuration de son propre répertoire ;
  • aggrega.provenance.tf — un fichier de commentaires # identifiant le build (le fichier JSON ne peut pas porter de commentaire, si bien que la provenance voyage dans son propre fichier).

Le marquage, et les deux entrées qu’il ne nomme pas

example/storage/external-object-store déclare trois feuilles values. Deux portent des identifiants publics ; une porte l’information d’identification et déclare sensitive: true :

values:
bucket: { type: string, required: true }
access_key_id: { type: string, required: true }
secret_access_key: { type: string, required: true, sensitive: true }

Le bloc module lie les trois entrées du module :

module "store" {
source = "./modules/store"
access_key_id = "AKIAEXAMPLE0001"
bucket = "app-artifacts"
secret_access_key = "example-placeholder-not-a-real-credential"
}

et l’override ajouté en nomme exactement une :

{
"variable": {
"secret_access_key": {
"sensitive": true
}
}
}

Terraform fusionne un fichier nommé override ou se terminant par _override dans la configuration du même répertoire, si bien que ce fichier ajoute l’attribut à la déclaration secret_access_key existante du module et laisse son type, sa description et sa valeur par défaut tels que le module les a écrits. Chaque octet embarqué reste tel qu’il a été écrit.

Les deux entrées que l’override ne nomme pas sont le cœur de l’exemple. Le marquage suit la déclaration et rien d’autre — ni le nom d’une variable, ni la forme de sa valeur. access_key_id est un identifiant d’information d’identification plutôt que du matériel d’identification, si bien qu’il n’est pas déclaré sensible et n’est pas marqué, même s’il se trouve à côté du secret et que son nom y ressemble. Retirez sensitive: true de l’unique feuille et reconstruisez : le fichier d’override n’est pas émis du tout.

Le voir fonctionner

main.tf garde les coordonnées publiques et l’information d’identification dans des attributs distincts d’une même ressource, si bien qu’un plan montre les deux sens à la fois. Planifiez la configuration racine de la frontière — le répertoire contenant aggrega.modules.tf, là où se trouvent les valeurs de cette Release :

Terminal window
cd dist/infra/terraform
tofu init && tofu plan # or: terraform init && terraform plan
# module.store.terraform_data.reference will be created
+ resource "terraform_data" "reference" {
[… omitted: an id attribute, reported as known only after apply]
+ input = (sensitive value)
[… omitted: an output attribute, reported as known only after apply]
+ triggers_replace = [
+ "app-artifacts",
+ "AKIAEXAMPLE0001",
]
}

Votre propre plan comporte ces deux attributs entre les lignes affichées. Ils sont marqués comme omis plutôt que manquants, si bien qu’une ligne dont vous ne pouvez pas rendre compte est une vraie différence et non quelque chose que cette page a retiré.

L’information d’identification est masquée ; les deux valeurs publiques à côté ne le sont pas. Supprimez aggrega_override.tf.json et relancez le plan pour voir l’information d’identification affichée en entier — cette différence est tout ce que fait le marquage. Le marquage se trouve sur le bloc variable propre du module, si bien qu’il voyage avec le module et s’applique partout où ce module est utilisé.

Exécutez-le à la racine et non dans modules/store/. Les entrées d’un composant sont les arguments de son bloc module, qui se trouve un niveau plus haut, si bien que le répertoire propre du composant n’est pas une configuration que vous pouvez planifier telle que déployée. Ce que le moteur y fait dépend des blocs variable propres du module, et une seule des deux réponses est visible :

  • Ce module déclare ses trois entrées sans default, si bien qu’un plan dans modules/store/ échoue — No value for required variable, une fois par entrée, chacune nommant sa ligne et proposant le remède -var / -var-file.
  • Un module dont les entrées portent toutes des valeurs par défaut serait au contraire planifié avec succès à cet endroit, à partir de ces valeurs par défaut plutôt que des valeurs que fournit la configuration racine. Rien n’avertit. C’est le cas à connaître, car un plan qui semble correct décrit une configuration que personne n’a demandée.

Ce que le marquage ne fait pas

sensitive régit l’affichage. Il empêche qu’une valeur soit affichée dans la sortie de plan et d’apply, et il empêche Terraform de placer cette valeur dans une sortie qui n’est pas elle-même marquée comme sensible. Il ne chiffre pas la valeur et ne change pas la façon dont la valeur est stockée : après un apply, la valeur est présente en clair dans l’état. Traitez l’état comme portant l’information d’identification, quoi que dise le marquage.

Le marquage n’atteint en outre une entrée rendue que lorsque l’identité de l’entrée provient d’une déclaration. Cette Recipe déclare un source: et aucun valuesMapping:, si bien que les noms des arguments sont les chemins des feuilles de valeur que le Component a déclarées et que la jointure est exacte. Une Recipe qui déclare un valuesMapping: invente ses noms de sortie dans un modèle, qu’aucune déclaration ne nomme, si bien qu’une telle Recipe rend les mêmes valeurs sans marquage — le fichier d’override est absent plutôt qu’approché. Marquer un nom qu’aucune déclaration n’atteint affirmerait quelque chose de faux sur une entrée publique, et l’outillage propre du moteur masquerait alors une valeur qui n’a jamais été secrète.

Pourquoi l’information d’identification est ici une entrée du module

Une base de données cloud managée est généralement l’autre cas : le fournisseur génère et fait tourner lui-même le mot de passe principal, si bien que le module n’a besoin d’aucune entrée d’information d’identification et qu’il n’y a rien à marquer. Ce bucket est exploité en dehors de la Release, si bien qu’il n’existe aucun fournisseur de ce type à qui déléguer — la Release détient une clé d’accès et doit la transmettre. C’est pourquoi ce module déclare une variable d’information d’identification et que les modules de bases de données managées de la bibliothèque standard ne le font pas.

Le module déclare cette variable sans l’attribut sensitive de Terraform, ce qui rend l’exemple lisible : l’attribut qu’un lecteur voit appliqué au moment du rendu provient de la déclaration du Component, non du module.

Fichiers

  • aggregate.yaml — intention du développeur : un composant store de type example/storage/external-object-store, avec le bucket nommé directement et les deux moitiés de la clé d’accès exposées comme parameters typés.
  • release.yaml — satisfait ces paramètres pour cet environnement et définit l’endpoint de l’opérateur. Les valeurs ici sont des espaces réservés, et non des informations d’identification pour un service réel.
  • manifest.yaml — lie le type de composant à la Recipe Terraform terraform/external-object-store, qui tire son module d’une source locale.
  • .aggrega-config.yaml — nomme le registre du hub depuis lequel se résolvent les entités du catalogue.

Les deux moitiés de l’information d’identification sont des parameters plutôt que des valeurs écrites par l’auteur parce que ce sont des valeurs qu’un opérateur fournit et qui diffèrent selon l’environnement. Une Release ne peut pas déclarer values:, si bien qu’un paramètre typé est précisément la surface prévue pour cela : le développeur déclare le point de variation, la Release le satisfait.

Générer l’exemple

Vous pouvez construire cet exemple avec les commandes ci-dessous, ou le faire construire pour vous par votre assistant IA.

Écrivez l’exemple dans un nouveau dossier qui porte son nom :

Terminal window
aggrega scaffold --example terraform-declared-sensitivity

Elle affiche ensuite les prochaines commandes à exécuter. La première vous place dans le nouveau dossier :

Terminal window
cd terraform-declared-sensitivity

Build

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

--auto-pull écrit pendant le build le fichier de verrouillage qui manque à un clone récent.

Avec un assistant IA

Un assistant IA configuré avec les outils d’Aggrega peut faire de même : collez-lui ce prompt.

Utilisez uniquement les outils Aggrega et ne créez vous-même aucun dossier. Si le dossier de l’espace de travail ne contient pas encore de dossier `terraform-declared-sensitivity`, appelez une fois l’outil `scaffold` avec `example` défini sur `terraform-declared-sensitivity` et sans `dir` : il écrit l’exemple dans un nouveau dossier `terraform-declared-sensitivity`. Appelez ensuite l’outil `build` avec `workspace_root` défini sur `terraform-declared-sensitivity`, `release` défini sur `release.yaml`, `auto_pull` défini sur true et `write` défini sur true. Indiquez-moi quels fichiers le build a écrits ; ils se trouvent sous `terraform-declared-sensitivity/dist/`.