Bỏ qua để đến nội dung
AggregaAggrega
Chọn ngôn ngữ: Tiếng Việt
Trang này được dịch bằng máy. Đọc bản gốc tiếng Anh.

Độ nhạy cảm được khai báo, render thành `sensitive` của chính Terraform

Một khai báo rằng một giá trị mang tài liệu bí mật được viết một lần, trên schema của một Component. Ở nơi đích render cung cấp một primitive tương ứng của riêng nó, khai báo đó được render vào primitive ấy. Ví dụ này là trường hợp Terraform: bản build nối thêm một tệp override thêm sensitive = true vào input của module mà giá trị được khai báo chảy vào, và engine sau đó che giá trị đó ở mọi nơi mà lẽ ra nó sẽ hiển thị.

Ví dụ này được cố ý giữ nhỏ và mọi phần của nó đều có thể kiểm tra: một component, ba input của module, và một đánh dấu được render chỉ nêu tên đúng một trong số đó.

Những gì bản build xuất ra

Trong dist/infra/terraform/, cấu hình gốc của boundary:

  • aggrega.modules.tf — khai báo store dưới dạng một khối module có source là ./modules/store và có các đối số là các biến input đã được phân giải của module, theo thứ tự khóa xác định. Mọi boundary terraform đều có một tệp này.

Trong dist/infra/terraform/modules/store/, các tệp riêng của component store:

  • các tệp module được sao chép nguyên từng byte — variables.tf và main.tf, đúng như tác giả module đã viết;
  • aggrega_override.tf.json — đánh dấu độ nhạy cảm, được mô tả bên dưới. Tệp này nằm cạnh các tệp riêng của module vì Terraform hợp nhất một override vào cấu hình trong chính thư mục của nó;
  • aggrega.provenance.tf — một tệp chú thích # nhận diện bản build (tệp JSON không thể chứa chú thích, nên thông tin nguồn gốc nằm trong tệp riêng).

Đánh dấu, và hai input mà nó không nêu tên

example/storage/external-object-store khai báo ba lá values. Hai lá mang các định danh công khai; một lá mang thông tin xác thực và khai báo sensitive: true:

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

Khối module gắn cả ba input của module:

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

và override được nối thêm chỉ nêu tên đúng một:

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

Terraform hợp nhất một tệp có tên override hoặc kết thúc bằng _override vào cấu hình trong cùng thư mục, nên tệp này thêm thuộc tính vào khai báo secret_access_key sẵn có của module và giữ nguyên kiểu, mô tả và giá trị mặc định như module đã viết. Mọi byte được vendor đều giữ nguyên như lúc được viết.

Hai input mà override không nêu tên chính là điểm mấu chốt của ví dụ. Đánh dấu chỉ đi theo khai báo và không gì khác — không theo tên của một biến, không theo hình dạng giá trị của nó. access_key_id là một định danh thông tin xác thực chứ không phải tài liệu xác thực, nên nó không được khai báo là nhạy cảm và không được đánh dấu, dù nó nằm cạnh bí mật và tên của nó nghe giống một bí mật. Hãy xóa sensitive: true khỏi lá đó và build lại: tệp override hoàn toàn không được xuất ra.

Xem nó hoạt động

main.tf giữ các tọa độ công khai và thông tin xác thực trong các thuộc tính riêng của một resource, nên một plan cho thấy cả hai chiều cùng lúc. Hãy chạy plan trên cấu hình gốc của boundary — thư mục chứa aggrega.modules.tf, nơi chứa các giá trị của lần triển khai này:

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",
]
}

Plan của bạn có hai thuộc tính đó giữa các dòng được hiển thị. Chúng được đánh dấu là bị lược bỏ chứ không phải bị thiếu, nên một dòng bạn không giải thích được là một khác biệt thực sự chứ không phải thứ mà trang này đã bỏ đi.

Thông tin xác thực bị che; hai giá trị công khai bên cạnh thì không. Hãy xóa aggrega_override.tf.json và chạy lại plan để thấy thông tin xác thực được in ra đầy đủ — sự khác biệt đó là toàn bộ những gì đánh dấu làm. Đánh dấu nằm trên khối variable của chính module, nên nó đi cùng module và áp dụng ở mọi nơi module đó được sử dụng.

Hãy chạy ở gốc chứ không phải bên trong modules/store/. Các input của một component là các đối số của khối module của nó, vốn nằm ở một cấp phía trên, nên thư mục riêng của component không phải là một cấu hình bạn có thể plan như khi được triển khai. Những gì engine làm ở đó phụ thuộc vào các khối variable của chính module, và chỉ một trong hai kết quả là ồn ào:

  • Module này khai báo cả ba input mà không có default, nên một plan trong modules/store/ thất bại — No value for required variable, một lần cho mỗi input, mỗi lần nêu dòng của nó và gợi ý cách khắc phục bằng -var / -var-file.
  • Ngược lại, một module mà tất cả input đều có giá trị mặc định sẽ plan thành công ở đó, từ các giá trị mặc định đó chứ không phải từ các giá trị mà cấu hình gốc cung cấp. Không có cảnh báo nào. Đó là trường hợp cần biết, vì một plan trông có vẻ đúng lại đang mô tả một cấu hình mà không ai yêu cầu.

Những gì đánh dấu không làm

sensitive chi phối việc hiển thị. Nó ngăn một giá trị bị in ra trong output của plan và apply, và ngăn Terraform đưa giá trị đó vào một output không được đánh dấu nhạy cảm. Nó không mã hóa giá trị và không thay đổi cách giá trị được lưu trữ: sau một lần apply, giá trị có mặt trong state ở dạng rõ. Hãy coi state là nơi chứa thông tin xác thực, bất kể đánh dấu nói gì.

Đánh dấu cũng chỉ đến được một input được render khi danh tính của input đến từ một khai báo. Recipe này khai báo một source: và không có valuesMapping:, nên tên đối số là các đường dẫn lá giá trị mà Component đã khai báo và phép nối là chính xác. Một Recipe khai báo valuesMapping: tự tạo tên output bên trong một template, nơi không khai báo nào nêu tên, nên một Recipe như vậy render cùng các giá trị với không có đánh dấu — tệp override vắng mặt chứ không bị suy đoán gần đúng. Đánh dấu một tên mà không khai báo nào đến được sẽ khẳng định điều sai sự thật về một input công khai, và công cụ của chính engine khi đó sẽ che một giá trị chưa bao giờ là bí mật.

Vì sao thông tin xác thực là một input của module ở đây

Một cơ sở dữ liệu đám mây được quản lý thường là trường hợp ngược lại: provider tự tạo và xoay vòng mật khẩu chính, nên module không cần input thông tin xác thực nào và không có gì để đánh dấu. Bucket này được vận hành bên ngoài lần triển khai, nên không có provider nào như vậy để ủy thác — lần triển khai giữ một access key và phải truyền nó vào. Đó là lý do module này khai báo một biến thông tin xác thực còn các module cơ sở dữ liệu được quản lý trong thư viện chuẩn thì không.

Module khai báo biến đó không có thuộc tính sensitive của Terraform, điều làm cho ví dụ dễ hiểu: thuộc tính mà người đọc thấy được áp dụng lúc render đến từ khai báo của Component, không phải từ module.

Các tệp

  • aggregate.yaml — ý định của nhà phát triển: một component store có kiểu example/storage/external-object-store, với bucket được đặt tên trực tiếp và cả hai nửa của access key được phơi ra dưới dạng parameters có kiểu.
  • release.yaml — đáp ứng các tham số đó cho môi trường này và đặt endpoint của người vận hành. Các giá trị ở đây là giá trị giữ chỗ, không phải thông tin xác thực cho bất kỳ dịch vụ thực nào.
  • manifest.yaml — gắn kiểu component với Recipe Terraform terraform/external-object-store, vốn lấy module của nó từ cục bộ.
  • .aggrega-config.yaml — chỉ định registry của hub mà các thực thể catalog được phân giải từ đó.

Cả hai nửa thông tin xác thực là parameters thay vì giá trị được viết sẵn vì chúng là các giá trị do người vận hành cung cấp và khác nhau theo từng môi trường. Một Release không thể khai báo values:, nên một tham số có kiểu chính là bề mặt dành cho đúng việc này: nhà phát triển khai báo điểm biến thiên, Release đáp ứng nó.

Tạo ví dụ

Bạn có thể build ví dụ này bằng các lệnh bên dưới, hoặc để trợ lý AI của bạn build giúp bạn.

Ghi ví dụ vào một thư mục mới đặt theo tên của nó:

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

Sau đó nó in ra các lệnh cần chạy tiếp theo. Lệnh đầu tiên chuyển vào thư mục mới:

Terminal window
cd terraform-declared-sensitivity

Build

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

--auto-pull ghi lockfile mà một bản clone mới còn thiếu trong quá trình build.

Với trợ lý AI

Một trợ lý AI được thiết lập với các công cụ của Aggrega cũng có thể làm như vậy: hãy dán prompt này vào trợ lý.

Chỉ dùng các công cụ của Aggrega và không tự tạo thư mục nào. Nếu thư mục không gian làm việc chưa có thư mục `terraform-declared-sensitivity`, hãy gọi công cụ `scaffold` một lần với `example` đặt thành `terraform-declared-sensitivity` và không có `dir`: công cụ này ghi ví dụ vào một thư mục `terraform-declared-sensitivity` mới. Sau đó gọi công cụ `build` với `workspace_root` đặt thành `terraform-declared-sensitivity`, `release` đặt thành `release.yaml`, `auto_pull` đặt thành true và `write` đặt thành true. Hãy cho tôi biết lần build đã ghi những tệp nào; chúng nằm dưới `terraform-declared-sensitivity/dist/`.