Оголошена чутливість, відтворена як власний `sensitive` у Terraform
Оголошення про те, що значення містить секретні дані, пишеться один раз, у схемі
сутності Component. Якщо ціль рендерингу має власний відповідний примітив, це
оголошення відтворюється в ньому. Цей приклад показує випадок Terraform: збирання
додає файл перевизначення, який додає sensitive = true до вхідної змінної модуля,
у яку потрапляє оголошене значення, і рушій потім приховує це значення всюди, де
інакше показав би його.
Приклад навмисно невеликий, і кожну його частину можна перевірити: один компонент, три вхідні змінні модуля і відтворена позначка, що називає рівно одну з них.
Що генерує збирання
У dist/infra/terraform/ — коренева конфігурація межі:
aggrega.modules.tf— оголошуєstoreяк блокmodule, чиєsource—./modules/store, а аргументи — розв’язані вхідні змінні модуля в детермінованому порядку ключів. Кожна межа terraform отримує такий файл.
У dist/infra/terraform/modules/store/ — власні файли компонента store:
- файли модуля, скопійовані байт у байт —
variables.tfіmain.tf, точно так, як їх написав автор модуля; aggrega_override.tf.json— позначка чутливості, описана нижче. Він лежить поруч із власними файлами модуля, бо Terraform зливає перевизначення з конфігурацією у власному каталозі;aggrega.provenance.tf— файл із коментарями#, що ідентифікує збирання (файл JSON не може містити коментар, тому відомості про походження містяться в окремому файлі).
Позначка і дві вхідні змінні, яких вона не називає
example/storage/external-object-store оголошує три листки values. Два містять
публічні ідентифікатори; один містить облікові дані й оголошує sensitive: true:
values: bucket: { type: string, required: true } access_key_id: { type: string, required: true } secret_access_key: { type: string, required: true, sensitive: true }Блок module прив’язує всі три вхідні змінні модуля:
module "store" { source = "./modules/store"
access_key_id = "AKIAEXAMPLE0001" bucket = "app-artifacts" secret_access_key = "example-placeholder-not-a-real-credential"}а додане перевизначення називає рівно одну:
{ "variable": { "secret_access_key": { "sensitive": true } }}Terraform зливає файл з іменем override або із закінченням _override з
конфігурацією в тому самому каталозі, тож цей файл додає атрибут до наявного
оголошення secret_access_key у модулі й залишає його тип, опис і значення за
замовчуванням такими, як їх написав модуль. Кожен вендорований байт лишається
таким, як його написано.
Дві вхідні змінні, яких перевизначення не називає, — і є суть прикладу.
Позначка йде за оголошенням і ні за чим іншим — ні за іменем змінної, ні за
формою її значення. access_key_id — це ідентифікатор облікових даних, а не
секретні дані, тому його не оголошено чутливим і не позначено, хоча він лежить
поруч із секретом і його ім’я схоже на секрет. Видаліть
sensitive: true з того одного листка й зберіть знову: файл перевизначення
взагалі не буде згенеровано.
Як це працює
main.tf тримає публічні координати й облікові дані в окремих атрибутах
одного ресурсу, тож план показує обидва напрями одночасно. Плануйте кореневу
конфігурацію межі — каталог, що містить aggrega.modules.tf, де й містяться
значення цього розгортання:
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", ] }Ваш власний план містить ці два атрибути між показаними рядками. Їх позначено як пропущені, а не відсутні, тож рядок, який ви не можете пояснити, — це справжня відмінність, а не щось, що ця сторінка відкинула.
Облікові дані приховано; два публічні значення поруч — ні. Видаліть
aggrega_override.tf.json і знову запустіть план, щоб побачити облікові дані
повністю, — ця різниця і є все, що робить позначка. Позначка міститься
у власному блоці variable модуля, тож вона мандрує разом із модулем і діє
всюди, де цей модуль використано.
Запускайте його в корені, а не всередині modules/store/. Вхідні змінні
компонента — це аргументи його блоку module, що лежить на рівень вище, тож
власний каталог компонента — не конфігурація, яку можна планувати як розгорнуту.
Що рушій робить там, залежить від власних блоків variable модуля, і лише одна
з двох відповідей помітна:
- Цей модуль оголошує всі три вхідні змінні без
default, тож план уmodules/store/завершується помилкою —No value for required variable(Немає значення для обов’язкової змінної), по одному разу на змінну, кожна з номером рядка і пропозицією виправлення через-var/-var-file. - Модуль, у якого всі вхідні змінні мають значення за замовчуванням, натомість успішно спланувався б там, зі значень за замовчуванням, а не зі значень, які надає коренева конфігурація. Жодного попередження. Саме про цей випадок слід знати, бо план, що виглядає правильно, описує конфігурацію, якої ніхто не просив.
Чого позначка не робить
sensitive керує відображенням. Він не дає вивести значення у виводі plan і apply
і не дає Terraform помістити це значення у вихідне значення, яке саме не
позначене як чутливе. Він не шифрує значення і не змінює способу його
зберігання: після apply значення присутнє у стані у відкритому вигляді. Вважайте,
що стан містить облікові дані, хоч би що казала позначка.
Також позначка доходить до відтвореної вхідної змінної, лише коли ідентичність
змінної походить з оголошення. Цей Recipe оголошує source: і не оголошує valuesMapping:, тож
імена аргументів — це шляхи листків значень, які оголосив Component, і зіставлення
точне. Recipe, що оголошує valuesMapping:, вигадує свої вихідні імена
всередині шаблону, яких не називає жодне оголошення, тож такий Recipe відтворює ті самі
значення без позначки — файл перевизначення відсутній, а не наближений.
Позначення імені, до якого не доходить жодне оголошення, стверджувало б щось
хибне про публічну вхідну змінну, і власні інструменти рушія тоді приховували б
значення, яке ніколи не було секретним.
Чому облікові дані тут є вхідною змінною модуля
Керована хмарна база даних зазвичай є іншим випадком: провайдер сам генерує й ротує головний пароль, тож модулю не потрібна вхідна змінна з обліковими даними і немає чого позначати. Цей бакет обслуговується поза розгортанням, тож немає такого провайдера, якому можна це делегувати, — розгортання тримає ключ доступу й має передати його. Тому цей модуль оголошує змінну з обліковими даними, а модулі керованих баз даних у стандартній бібліотеці — ні.
Модуль оголошує цю змінну без атрибута sensitive з Terraform,
і саме це робить приклад наочним: атрибут, який читач бачить застосованим під час
рендерингу, походить з оголошення сутності Component, а не з модуля.
Файли
aggregate.yaml— намір розробника: один компонентstoreтипуexample/storage/external-object-store, з прямо названим бакетом і обома половинами ключа доступу, виставленими як типізованіparameters.release.yaml— заповнює ці параметри для цього середовища й задаєendpointоператора. Значення тут — заповнювачі, а не облікові дані для будь-якого реального сервісу.manifest.yaml— прив’язує тип компонента до Recipe для Terraformterraform/external-object-store, який бере свій модуль локально..aggrega-config.yaml— називає реєстр hub, з якого розв’язуються сутності каталогу.
Обидві половини облікових даних є parameters, а не написаними значеннями, бо
їх надає оператор і вони різняться для кожного середовища. Release не може
оголошувати values:, тож типізований параметр — саме та поверхня для цього:
розробник оголошує точку варіації, а Release її заповнює.
Створення прикладу
Цей приклад можна зібрати командами нижче або доручити збирання вашому ШІ-асистенту.
Запишіть приклад у нову теку, названу за ним:
aggrega scaffold --example terraform-declared-sensitivityПотім вона виводить команди, які слід виконати далі. Перша переходить у нову теку:
cd terraform-declared-sensitivityЗбирання
aggrega build --release release.yaml --auto-pull--auto-pull під час збирання записує lockfile, якого бракує свіжому клону.
З ШІ-асистентом
ШІ-асистент, налаштований з інструментами Aggrega, може зробити те саме: вставте йому цей промпт.
Використовуйте лише інструменти Aggrega і не створюйте жодної папки самостійно. Якщо папка робочої області ще не містить папки `terraform-declared-sensitivity`, викличте один раз інструмент `scaffold` з параметром `example` зі значенням `terraform-declared-sensitivity` і без `dir`: він запише приклад у нову папку `terraform-declared-sensitivity`. Потім викличте інструмент `build` з параметрами `workspace_root` — `terraform-declared-sensitivity`, `release` — `release.yaml`, `auto_pull` — true і `write` — true. Скажіть мені, які файли записала збірка; вони розташовані в `terraform-declared-sensitivity/dist/`.