Salta ai contenuti
AggregaAggrega
Seleziona lingua: Italiano
Questa pagina è stata tradotta automaticamente. Leggi l’originale in inglese.

Sensibilità dichiarata, renderizzata come il `sensitive` proprio di Terraform

La dichiarazione che un valore porta materiale segreto viene scritta una sola volta, sullo schema di un Component. Dove il target di rendering offre una primitiva propria corrispondente, quella dichiarazione viene renderizzata in essa. Questo esempio è il caso Terraform: la build aggiunge un file di override che aggiunge sensitive = true all’input del modulo in cui confluisce il valore dichiarato, e il motore poi oscura quel valore ovunque altrimenti lo mostrerebbe.

L’esempio è volutamente piccolo e ogni sua parte è ispezionabile: un componente, tre input del modulo e una marcatura renderizzata che ne nomina esattamente uno.

Che cosa emette la build

Sotto dist/infra/terraform/, la configurazione radice del confine:

  • aggrega.modules.tf — che dichiara store come blocco module il cui source è ./modules/store e i cui argomenti sono le variabili di input risolte del modulo, in ordine deterministico delle chiavi. Ogni confine terraform ne riceve uno.

Sotto dist/infra/terraform/modules/store/, i file propri del componente store:

  • i file del modulo copiati byte per byte — variables.tf e main.tf, esattamente come li ha scritti l’autore del modulo;
  • aggrega_override.tf.json — la marcatura di sensibilità, descritta più avanti. Si trova accanto ai file propri del modulo perché Terraform unisce un override alla configurazione nella propria directory;
  • aggrega.provenance.tf — un file di commenti con # che identifica la build (il file JSON non può contenere un commento, quindi la provenienza viaggia in un file proprio).

La marcatura, e i due input che non nomina

example/storage/external-object-store dichiara tre foglie values. Due portano identificatori pubblici; una porta la credenziale e dichiara sensitive: true:

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

Il blocco module lega tutti e tre gli input del modulo:

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

e l’override aggiunto ne nomina esattamente uno:

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

Terraform unisce un file chiamato override o che termina in _override alla configurazione nella stessa directory, quindi questo file aggiunge l’attributo alla dichiarazione secret_access_key esistente del modulo e ne lascia tipo, descrizione e valore predefinito come li ha scritti il modulo. Ogni byte incorporato resta così come è stato scritto.

I due input che l’override non nomina sono il punto dell’esempio. La marcatura segue la dichiarazione e nient’altro — non il nome di una variabile, non la forma del suo valore. access_key_id è un identificatore di credenziale anziché materiale di credenziale, quindi non è dichiarato sensibile e non è marcato, anche se si trova accanto al segreto e il suo nome sembra quello di un segreto. Rimuovi sensitive: true dall’unica foglia e riesegui la build: il file di override non viene emesso affatto.

Vederlo in funzione

main.tf tiene le coordinate pubbliche e la credenziale in attributi separati di un’unica risorsa, così un piano mostra entrambe le direzioni insieme. Pianifica la configurazione radice del confine — la directory che contiene aggrega.modules.tf, dove si trovano i valori di questa 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",
]
}

Il tuo piano contiene quei due attributi tra le righe mostrate. Sono segnati come omessi anziché mancanti, quindi una riga di cui non sai rendere conto è una differenza reale e non qualcosa che questa pagina ha tolto.

La credenziale è oscurata; i due valori pubblici accanto a essa no. Elimina aggrega_override.tf.json e riesegui il piano per vedere la credenziale stampata per intero — quella differenza è tutto ciò che fa la marcatura. La marcatura si trova nel blocco variable proprio del modulo, quindi viaggia con il modulo e si applica ovunque quel modulo venga usato.

Eseguilo alla radice e non dentro modules/store/. Gli input di un componente sono gli argomenti del suo blocco module, che si trova un livello più su, quindi la directory propria del componente non è una configurazione che si possa pianificare così come viene distribuita. Ciò che il motore fa lì dipende dai blocchi variable propri del modulo, e solo una delle due risposte è evidente:

  • Questo modulo dichiara tutti e tre i suoi input senza default, quindi un piano in modules/store/ fallisce — No value for required variable, una volta per input, ciascuno con l’indicazione della propria riga e del rimedio -var / -var-file.
  • Un modulo i cui input portano tutti valori predefiniti verrebbe invece pianificato con successo lì, a partire da quei valori predefiniti anziché dai valori che fornisce la configurazione radice. Nulla avvisa. È il caso da conoscere, perché un piano che sembra corretto sta descrivendo una configurazione che nessuno ha chiesto.

Che cosa non fa la marcatura

sensitive governa la visualizzazione. Impedisce che un valore venga stampato nell’output di plan e apply, e impedisce a Terraform di inserire quel valore in un output che non sia a sua volta marcato come sensibile. Non cifra il valore e non cambia il modo in cui il valore è archiviato: dopo un apply il valore è presente in chiaro nello state. Considera lo state come portatore della credenziale, qualunque cosa dica la marcatura.

La marcatura raggiunge inoltre un input renderizzato solo quando l’identità dell’input deriva da una dichiarazione. Questa Recipe dichiara un source: e nessun valuesMapping:, quindi i nomi degli argomenti sono i percorsi delle foglie di valore che il Component ha dichiarato e la corrispondenza è esatta. Una Recipe che dichiara un valuesMapping: inventa i nomi del proprio output all’interno di un template, che nessuna dichiarazione nomina, quindi una tale Recipe renderizza gli stessi valori senza alcuna marcatura — il file di override è assente anziché approssimato. Marcare un nome che nessuna dichiarazione raggiunge affermerebbe qualcosa di falso su un input pubblico, e gli strumenti propri del motore nasconderebbero allora un valore che non è mai stato segreto.

Perché qui la credenziale è un input del modulo

Un database cloud gestito è di solito l’altro caso: il provider genera e ruota da sé la password master, quindi il modulo non ha bisogno di alcun input di credenziale e non c’è nulla da marcare. Questo bucket è gestito al di fuori della Release, quindi non c’è un tale provider a cui delegare — la Release detiene una chiave di accesso e deve passarla. Ecco perché questo modulo dichiara una variabile di credenziale e i moduli di database gestiti nella libreria standard no.

Il modulo dichiara quella variabile senza l’attributo sensitive di Terraform, ed è ciò che rende l’esempio leggibile: l’attributo che un lettore vede applicato al momento del rendering proviene dalla dichiarazione del Component, non dal modulo.

File

  • aggregate.yaml — intento dello sviluppatore: un componente store di tipo example/storage/external-object-store, con il bucket nominato direttamente ed entrambe le metà della chiave di accesso esposte come parameters tipizzati.
  • release.yaml — soddisfa quei parametri per questo ambiente e imposta l’endpoint dell’operatore. I valori qui sono segnaposto, non credenziali per alcun servizio reale.
  • manifest.yaml — lega il tipo di componente alla Recipe Terraform terraform/external-object-store, che prende il proprio modulo da una sorgente locale.
  • .aggrega-config.yaml — nomina il registry dell’hub da cui si risolvono le entità del catalogo.

Entrambe le metà della credenziale sono parameters anziché valori scritti dall’autore perché sono valori che un operatore fornisce e che differiscono per ambiente. Una Release non può dichiarare values:, quindi un parametro tipizzato è la superficie proprio per questo: lo sviluppatore dichiara il punto di variazione, la Release lo soddisfa.

Generare l’esempio

Puoi eseguire la build di questo esempio con i comandi qui sotto, oppure farla eseguire al tuo assistente IA.

Scrivi l’esempio in una nuova cartella che porta il suo nome:

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

Poi stampa i prossimi comandi da eseguire. Il primo ti porta nella nuova cartella:

Terminal window
cd terraform-declared-sensitivity

Build

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

--auto-pull scrive durante il build il lockfile che manca a un clone appena creato.

Con un assistente AI

Un assistente IA configurato con gli strumenti di Aggrega può fare lo stesso: incolla questo prompt nell’assistente.

Usa solo gli strumenti di Aggrega e non creare tu alcuna cartella. Se la cartella dell’area di lavoro non contiene ancora una cartella `terraform-declared-sensitivity`, chiama una volta lo strumento `scaffold` con `example` impostato su `terraform-declared-sensitivity` e senza `dir`: scrive l’esempio in una nuova cartella `terraform-declared-sensitivity`. Poi chiama lo strumento `build` con `workspace_root` impostato su `terraform-declared-sensitivity`, `release` impostato su `release.yaml`, `auto_pull` impostato su true e `write` impostato su true. Dimmi quali file ha scritto la build; si trovano sotto `terraform-declared-sensitivity/dist/`.