Tìm hiểu Code Style trong Terraform

26

Tìm hiểu Code Style trong TerraformCuongquach.com | Cùng tìm hiểu một số Code Stylesyntax được Terraform khuyến nghị các lập trình viên/quản trị viên sử dụng khi code ngôn ngữ HCL cho Terraform nhé.

code-style-terraform

1. Indent Spacing (khoảng trắng)

Thay vì sử dụng 4 khoảng trắng thường thấy cho các thụt đầu dòng thì Terraform khuyến nghị bạn chỉ sử dụng 2 khoảng trắng để thụt đầu dòng trong ngôn ngữ HCL.

2. Comment

Bạn có thể comment nội dung chú thích với 3 cú pháp :

  • #
  • //
  • /* xxx /*

3. Resource Block Alignment

Các parameter trong một resource block nên được canh thẳng hàng ở phần =. Bạn có thể chạy lệnh terraform fmt để format lại file cấu hình cho mục tiêu này.

4. Variables config

  • Một số lưu ý khi cấu hình phần variable trong Terraform .
  • Nên chỉ định loại dữ liệu biến nếu có sử dụng giá trị default tương ứng loại dữ liệu đó. Ví dụ: type = "list" cho default = [] , type = "map" cho default = {} .
  • Khi định nghĩa thông tin biến variable nên để thứ tự các nội dung description, typedefault như dưới.
  • Nên luôn để thông tin description nhằm giúp người đọc hiểu ý nghĩa của biến đó.

5. Output config

  • Khuyến nghị đặt tên output có ý nghĩa với cú pháp như sau : {name}_{attribute}. Trong đó {name} là tên resource (bỏ phần provider prefix) ví dụ aws_subnet thì {name} là subnet, {attribute} thuộc tính trả về của output của bạn.

Ví dụ:

  • Nên đặt thêm thông tin description cho output.
  • Nếu output là một list thì nên đặt tên tiếng anh ở dạng số nhiều (plural name).

6. Quy hoạch tên file

Chúng ta nên quy hoạch các nội dung resource cấu hình theo loại resource đó, để tìm kiếm và nhận diện dễ hơn.

Ví dụ:

7. Các lưu ý khác

  • Dùng kí tự “_” thay vì “” khi đặt tên cho biến (variable), resource, output.

  • Chỉ nên sử dụng chữ thường, không sử dụng chữ in hoa.
  • Nếu bạn có sử dụng #meta-argument như count, thì nên để trên đầu và cách 1 khoảng trắng với các cấu hình còn lại.

Code đẹp:

Code xấu :

  • Nếu bạn sử dụng count để làm điều kiện if/else khởi tạo resource, thì khuyến khích nên sử dụng biến thông tin thể hiện rõ mục đích if/else

Ví dụ:

  • Không nên lặp tên loại resource trong resource name .

Code đẹp:

Code xấu:

Các bạn có những ý kiến đóng góp gì thì đại ngại comment bên dưới nhé.

Nguồn: https://cuongquach.com/

LEAVE A REPLY

Please enter your comment!
Please enter your name here