[Terraform] Lesson 10 – Fmt, Validate, Console

1. Fmt, Validate và Console là gì?

Trong Terraform, các câu lệnh fmt, validate và console được sử dụng để định dạng mã, xác thực cấu hình và hiển thị đầu ra.

fmt: Là câu lệnh định dạng lại mã của file cấu hình. Nó sẽ tự động sắp xếp lại mã và đảm bảo cấu trúc hợp lý. Câu lệnh này không có tham số đầu vào và được sử dụng như sau:

terraform fmt

validate: Là câu lệnh xác thực cấu hình để kiểm tra xem nó có hợp lệ hay không. Câu lệnh này được sử dụng để kiểm tra xem file cấu hình của bạn có các lỗi cú pháp hoặc lỗi logic không. Câu lệnh này không có tham số đầu vào và được sử dụng như sau:

terraform validate

console: Là câu lệnh hiển thị giá trị của một biểu thức Terraform. Câu lệnh này có thể được sử dụng để kiểm tra giá trị của biến hoặc hàm trong cấu hình. Câu lệnh này có thể có một tham số đầu vào là biểu thức cần được hiển thị và được sử dụng như sau:

terraform console
terraform console <expression>

Các câu lệnh này có thể được sử dụng từ command line hoặc trong các công cụ tích hợp với Terraform như IDE hoặc trong các pipeline CI/CD.

Cú pháp khai báo không khác gì khai báo các command khác trong Terraform. Ví dụ:

resource "aws_instance" "example" {
  ami           = "ami-0c55b159cbfafe1f0"
  instance_type = "t2.micro"
}

# Định dạng lại mã của file cấu hình
terraform fmt

# Kiểm tra tính hợp lệ của file cấu hình
terraform validate

# Hiển thị giá trị của biểu thức
terraform console aws_instance.example.ami

2. Một số lưu ý khi sử dụng Fmt, Validate, Console.

Có một số lưu ý khi sử dụng các lệnh Fmt, Validate và Console trong Terraform:

• Lệnh Fmt sẽ tự động sắp xếp lại mã nguồn Terraform của bạn theo một chuẩn định sẵn. Tuy nhiên, điều này không đảm bảo rằng mã nguồn của bạn hoàn toàn đúng cú pháp. Do đó, bạn nên luôn sử dụng lệnh Validate để đảm bảo rằng mã nguồn của bạn không có lỗi cú pháp.
• Lệnh Validate sẽ kiểm tra các file cấu hình Terraform của bạn để xác định xem chúng có đúng cú pháp hay không. Nếu có bất kỳ lỗi nào trong file cấu hình của bạn, Validate sẽ thông báo lỗi và chỉ ra vị trí của chúng. Nếu Validate trả về thông báo “Success”, điều đó có nghĩa là mã nguồn của bạn đúng cú pháp.
• Lệnh Console sẽ truy xuất đến các giá trị trong mã Terraform của bạn để kiểm tra xem chúng có đúng hay không. Bạn có thể sử dụng lệnh này để thử các biểu thức và chức năng trong mã của mình mà không cần triển khai tài nguyên.
• Nên sử dụng các lệnh này trước khi triển khai mã nguồn của bạn để đảm bảo rằng mã của bạn đúng cú pháp và hoạt động như mong đợi.

3. Các ví dụ minh hoạ.

Terraform cung cấp các lệnh fmt, validate và console để hỗ trợ quá trình phát triển hạ tầng đám mây của bạn với Terraform.

• fmt: dùng để định dạng lại file cấu hình Terraform theo một chuẩn định sẵn, giúp đảm bảo tính nhất quán và đồng bộ giữa các thành viên trong nhóm và giữa các dự án khác nhau.

Ví dụ:

provider "aws" {
  region = "us-east-1"
}

resource "aws_instance" "example" {
  ami           = "ami-0c55b159cbfafe1f0"
  instance_type = "t2.micro"
}

Sử dụng lệnh terraform fmt sẽ định dạng lại code thành:

provider "aws" {
  region = "us-east-1"
}

resource "aws_instance" "example" {
  ami           = "ami-0c55b159cbfafe1f0"
  instance_type = "t2.micro"
}

• validate: dùng để kiểm tra cấu hình Terraform có lỗi cú pháp hay không.

Ví dụ:

provider "aws" {
  region = "us-east-1"
}

resource "aws_instance" "example" {
  ami           = "ami-0c55b159cbfafe1f0"
  instance_type = "t2.micro"
  nonexistent_property = "value" # Lỗi tại đây
}

Sử dụng lệnh terraform validate sẽ trả về thông báo lỗi cú pháp:

Error: Unsupported block type

  on example.tf line 6:
   6:   nonexistent_property = "value"

This block type is not expected. Did you mean to define a nested block
of some kind?

• console: dùng để tạo ra một command prompt trên terminal để kiểm tra giá trị của biến hoặc expression.

Ví dụ:

locals {
  subnet_cidr = "10.0.1.0/24"
}

output "subnet_last_octet" {
  value = split(".", local.subnet_cidr)[3]
}

Sử dụng lệnh terraform console sẽ mở ra một command prompt để kiểm tra giá trị của biến:

> local.subnet_cidr
"10.0.1.0/24"
> split(".", local.subnet_cidr)
[
  "10",
  "0",
  "1",
  "0/24",
]
> split(".", local.subnet_cidr)[3]
"0/24"
> output.subnet_last_octet
"0/24"

Như vậy, với các lệnh fmt, validate và console sẽ giúp bạn kiểm tra và quản lý cấu hình Terraform một cách dễ dàng và hiệu quả hơn.