Sensibilidad declarada, renderizada como el `sensitive` propio de Terraform
La declaración de que un valor lleva material secreto se escribe una sola vez, en el esquema de un Component. Donde el destino de renderizado ofrece una primitiva propia equivalente, esa declaración se renderiza en ella. Este ejemplo es el caso de Terraform: la compilación añade un archivo de override que agrega sensitive = true a la entrada del módulo a la que fluye el valor declarado, y el motor oculta entonces ese valor dondequiera que de otro modo lo mostraría.
El ejemplo es deliberadamente pequeño y cada parte de él se puede inspeccionar: un componente, tres entradas de módulo y un marcado renderizado que nombra exactamente una de ellas.
Qué emite la compilación
Bajo dist/infra/terraform/, la configuración raíz del límite:
aggrega.modules.tf— declarastorecomo un bloquemodulecuyosourcees./modules/storey cuyos argumentos son las variables de entrada resueltas del módulo, en un orden de claves determinista. Cada límite terraform recibe uno.
Bajo dist/infra/terraform/modules/store/, los archivos propios del componente store:
- los archivos del módulo copiados byte a byte —
variables.tfymain.tf, exactamente como los escribió el autor del módulo; aggrega_override.tf.json— el marcado de sensibilidad, descrito más abajo. Se encuentra junto a los archivos propios del módulo porque Terraform fusiona un override con la configuración de su propio directorio;aggrega.provenance.tf— un archivo de comentarios#que identifica la compilación (el archivo JSON no puede llevar un comentario, así que la procedencia viaja en su propio archivo).
El marcado, y las dos entradas que no nombra
example/storage/external-object-store declara tres hojas de values. Dos llevan identificadores públicos; una lleva la credencial y declara sensitive: true:
values: bucket: { type: string, required: true } access_key_id: { type: string, required: true } secret_access_key: { type: string, required: true, sensitive: true }El bloque module enlaza las tres entradas del módulo:
module "store" { source = "./modules/store"
access_key_id = "AKIAEXAMPLE0001" bucket = "app-artifacts" secret_access_key = "example-placeholder-not-a-real-credential"}y el override añadido nombra exactamente una:
{ "variable": { "secret_access_key": { "sensitive": true } }}Terraform fusiona un archivo llamado override o que termina en _override con la configuración del mismo directorio, así que este archivo añade el atributo a la declaración secret_access_key existente del módulo y deja su tipo, su descripción y su valor predeterminado tal como los escribió el módulo. Cada byte incorporado queda tal como se escribió.
Las dos entradas que el override no nombra son el sentido del ejemplo. El marcado sigue a la declaración y a nada más — ni al nombre de una variable, ni a la forma de su valor. access_key_id es un identificador de credencial y no material de credencial, así que no está declarado como sensible y no se marca, aunque esté junto al secreto y su nombre lo parezca. Quita sensitive: true de esa única hoja y vuelve a compilar: el archivo de override no se emite en absoluto.
Verlo funcionar
main.tf mantiene las coordenadas públicas y la credencial en atributos separados de un mismo recurso, así que un plan muestra ambas direcciones a la vez. Planifica la configuración raíz del límite — el directorio que contiene aggrega.modules.tf, que es donde están los valores de esta Release:
cd dist/infra/terraformtofu 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", ] }Tu propio plan lleva esos dos atributos entre las líneas mostradas. Están marcados como omitidos en lugar de faltar, así que una línea que no puedes explicar es una diferencia real y no algo que esta página quitó.
La credencial queda oculta; los dos valores públicos junto a ella no. Elimina aggrega_override.tf.json y vuelve a ejecutar el plan para ver la credencial impresa completa — esa diferencia es todo lo que hace el marcado. El marcado está en el bloque variable propio del módulo, así que viaja con el módulo y se aplica dondequiera que se use ese módulo.
Ejecútalo en la raíz y no dentro de modules/store/. Las entradas de un componente son los argumentos de su bloque module, que está un nivel más arriba, así que el directorio propio del componente no es una configuración que puedas planificar tal como se despliega. Lo que el motor hace allí depende de los bloques variable propios del módulo, y solo una de las dos respuestas es visible:
- Este módulo declara sus tres entradas sin
default, así que un plan enmodules/store/falla —No value for required variable, una vez por entrada, cada una nombrando su línea y ofreciendo el remedio-var/-var-file. - Un módulo cuyas entradas lleven todas valores predeterminados se planificaría en cambio correctamente allí, a partir de esos valores predeterminados en lugar de los valores que proporciona la configuración raíz. Nada avisa. Ese es el caso que hay que conocer, porque un plan que parece correcto está describiendo una configuración que nadie pidió.
Lo que no hace el marcado
sensitive rige la visualización. Impide que un valor se imprima en la salida de plan y apply, e impide que Terraform coloque ese valor en una salida que no esté marcada a su vez como sensible. No cifra el valor y no cambia cómo se almacena: después de un apply el valor está presente en el estado en claro. Trata el estado como portador de la credencial, diga lo que diga el marcado.
El marcado además solo alcanza una entrada renderizada cuando la identidad de la entrada proviene de una declaración. Esta Recipe declara un source: y ningún valuesMapping:, así que los nombres de los argumentos son las rutas de las hojas de valor que declaró el Component y la correspondencia es exacta. Una Recipe que declara un valuesMapping: inventa sus nombres de salida dentro de una plantilla, que ninguna declaración nombra, así que tal Recipe renderiza los mismos valores sin marcado — el archivo de override está ausente en lugar de aproximado. Marcar un nombre al que no llega ninguna declaración afirmaría algo falso sobre una entrada pública, y las propias herramientas del motor ocultarían entonces un valor que nunca fue secreto.
Por qué la credencial es aquí una entrada del módulo
Una base de datos gestionada en la nube suele ser el otro caso: el proveedor genera y rota él mismo la contraseña maestra, así que el módulo no necesita ninguna entrada de credencial y no hay nada que marcar. Este bucket se opera fuera de la Release, así que no hay tal proveedor en quien delegar — la Release tiene una clave de acceso y debe pasarla. Por eso este módulo declara una variable de credencial y los módulos de bases de datos gestionadas de la biblioteca estándar no.
El módulo declara esa variable sin el atributo sensitive de Terraform, y eso es lo que hace legible el ejemplo: el atributo que un lector ve aplicado en el momento del renderizado proviene de la declaración del Component, no del módulo.
Archivos
aggregate.yaml— intención del desarrollador: un componentestorede tipoexample/storage/external-object-store, con el bucket nombrado directamente y las dos mitades de la clave de acceso expuestas comoparameterstipados.release.yaml— satisface esos parámetros para este entorno y establece elendpointdel operador. Los valores de aquí son marcadores de posición, no credenciales para ningún servicio real.manifest.yaml— enlaza el tipo de componente con la Recipe de Terraformterraform/external-object-store, que obtiene su módulo de una fuente local..aggrega-config.yaml— nombra el registro del hub desde el que se resuelven las entidades del catálogo.
Las dos mitades de la credencial son parameters y no valores escritos por el autor porque son valores que proporciona un operador y que difieren según el entorno. Una Release no puede declarar values:, así que un parámetro tipado es la superficie precisamente para esto: el desarrollador declara el punto de variación, la Release lo satisface.
Generar el ejemplo
Puedes compilar este ejemplo con los comandos de abajo, o hacer que tu asistente de IA lo compile por ti.
Escribe el ejemplo en una carpeta nueva con su nombre:
aggrega scaffold --example terraform-declared-sensitivityDespués imprime los comandos que hay que ejecutar a continuación. El primero entra en la carpeta nueva:
cd terraform-declared-sensitivityCompilación
aggrega build --release release.yaml --auto-pull--auto-pull escribe durante la compilación el archivo de bloqueo que le falta a un clon nuevo.
Con un asistente de IA
Un asistente de IA configurado con las herramientas de Aggrega puede hacer lo mismo: pégale este prompt.
Usa solo las herramientas de Aggrega y no crees ninguna carpeta por tu cuenta. Si la carpeta del espacio de trabajo aún no contiene una carpeta `terraform-declared-sensitivity`, llama una vez a la herramienta `scaffold` con `example` establecido en `terraform-declared-sensitivity` y sin `dir`: escribe el ejemplo en una nueva carpeta `terraform-declared-sensitivity`. Luego llama a la herramienta `build` con `workspace_root` establecido en `terraform-declared-sensitivity`, `release` establecido en `release.yaml`, `auto_pull` establecido en true y `write` establecido en true. Dime qué archivos escribió la compilación; están en `terraform-declared-sensitivity/dist/`.