[Terraform] Lesson 14 – Terraform Modules

Terraform Modules là một khái niệm quan trọng trong việc quản lý hạ tầng đám mây (cloud infrastructure management) bằng Terraform. Module là một tập hợp các tài nguyên Terraform có thể được sử dụng lại để triển khai hạ tầng đám mây theo cách tiêu chuẩn và tái sử dụng được.

Trong Terraform, các tài nguyên có thể được tạo thành các mô-đun (module), mỗi mô-đun tương đương với một thư mục chứa các tài nguyên Terraform liên quan đến chức năng cụ thể. Tất cả các mô-đun đều có thể được định nghĩa bằng một tập tin có tên là main.tf, và nó cũng có thể chứa các file Terraform khác như variables.tf, outputs.tf, và thư mục modules để chứa các mô-đun con.

Cú pháp khai báo một module trong Terraform sẽ như sau:

module "module_name" {
  source = "module_directory"
  [other arguments...]
}

Trong đó:

• module_name: Tên của module, có thể được sử dụng để tham chiếu đến module trong các file khác của Terraform.
• module_directory: Đường dẫn đến thư mục chứa module, có thể là đường dẫn địa phương hoặc đường dẫn tới một kho lưu trữ từ xa như Git.
• other arguments...: Các đối số khác để định nghĩa các giá trị biến hoặc truyền các đối số khác vào module.

Sau khi định nghĩa một module, bạn có thể sử dụng các tài nguyên bên trong module bằng cách tham chiếu đến chúng trong các file khác của Terraform, ví dụ:

resource "aws_instance" "web" {
  ami           = var.ami
  instance_type = var.instance_type
  subnet_id     = module.network.subnet_id
  [other arguments...]
}

Trong ví dụ trên, ta sử dụng tài nguyên subnet_id bên trong module network bằng cách sử dụng cú pháp module.module_name.resource_name.

2. Một số lưu ý khi sử dụng Terraform Modules.

Dưới đây là một số lưu ý quan trọng khi sử dụng Terraform Modules:

• Định nghĩa các module với phạm vi tái sử dụng rộng: Các module nên được thiết kế để có thể sử dụng lại nhiều lần trong nhiều tình huống khác nhau, và không nên có các yêu cầu đặc biệt quá cụ thể cho một trường hợp sử dụng cụ thể.
• Thực hiện kiểm tra lỗi đầy đủ: Trước khi triển khai module, hãy kiểm tra kỹ càng để đảm bảo rằng module hoạt động đúng và không có lỗi. Điều này giúp tránh các vấn đề không mong muốn khi triển khai hạ tầng đám mây.
• Sử dụng các biến để định cấu hình module: Sử dụng các biến để cấu hình các giá trị cho module, giúp tái sử dụng module dễ dàng hơn.
• Quản lý phiên bản của module: Module nên được quản lý bằng cách sử dụng các công cụ quản lý phiên bản như Git hoặc SVN, và các phiên bản của module nên được theo dõi và xác định rõ ràng trong Terraform.
• Sử dụng các mô-đun con: Module có thể chứa các mô-đun con để phân tách và tái sử dụng các phần của module. Sử dụng các mô-đun con giúp cho việc quản lý module dễ dàng hơn và giảm thiểu lỗi khi triển khai.
• Sử dụng các tham chiếu tương đối: Trong định nghĩa module, sử dụng các tham chiếu tương đối đến các tài nguyên bên trong module để giúp đơn giản hóa định dạng file Terraform.
• Cẩn thận khi sử dụng các module từ nguồn bên ngoài: Sử dụng các module từ các nguồn bên ngoài như Terraform Registry, GitHub, hay GitLab có thể giúp tăng tốc độ phát triển, tuy nhiên cần phải cẩn thận và xác minh độ tin cậy và tính ổn định của các module này trước khi sử dụng.
• Sử dụng Terraform Enterprise hoặc Terraform Cloud để quản lý module: Terraform Enterprise và Terraform Cloud cung cấp các tính năng quản lý phiên bản, kiểm tra lỗi và tự động triển khai module, giúp cho việc quản lý module trở nên dễ dàng và an toàn.
• Tạo các tài khoản riêng để quản lý module: Nên tạo các tài khoản riêng để quản lý các module để tránh nhầm lẫn với các tài khoản khác.
• Tránh sử dụng mã trùng lặp: Sử dụng các mô-đun con và các biến để tránh việc lặp lại mã khi triển khai các tài nguyên giống nhau.
• Quản lý các phụ thuộc: Các module có thể phụ thuộc vào các module khác, cần phải đảm bảo rằng các phiên bản của các module phụ thuộc được định rõ ràng và không bị xung đột.
• Tự động hóa việc triển khai module: Sử dụng các công cụ tự động hóa như Ansible, Chef, hay Puppet để triển khai các module một cách tự động.
• Kiểm tra lỗi khi sử dụng module: Sau khi triển khai module, hãy kiểm tra kỹ càng để đảm bảo rằng các tài nguyên đã được tạo ra và hoạt động như mong đợi. Nếu có lỗi, cần phải xem xét và sửa chữa ngay để đảm bảo tính ổn định của hệ thống.
• Quản lý phiên bản: Đảm bảo rằng các phiên bản của module được quản lý và theo dõi để có thể quay lại phiên bản trước nếu cần thiết.
• Bảo mật module: Đảm bảo rằng module được bảo mật và chỉ có các người được cấp quyền mới có thể truy cập và sử dụng chúng.
• Sử dụng các hệ thống quản lý mã nguồn: Sử dụng các hệ thống quản lý mã nguồn như GitHub, GitLab, hay Bitbucket để quản lý và chia sẻ module.
• Học hỏi từ cộng đồng: Có thể tìm kiếm các module từ cộng đồng và học hỏi cách triển khai các tài nguyên khác nhau trong các module này.
• Tùy chỉnh module: Có thể tùy chỉnh các module để phù hợp với nhu cầu của từng dự án cụ thể.
• Tài liệu hóa module: Viết tài liệu về module để giúp cho việc sử dụng và bảo trì module được dễ dàng hơn.

3. Quy trình thiết kế Terraform Modules.

Thiết kế Terraform Modules là một quá trình quan trọng trong việc triển khai hạ tầng bằng Terraform. Dưới đây là một số lời khuyên để thiết kế Terraform Modules hiệu quả:

• Xác định các tài nguyên: Xác định các tài nguyên cần được triển khai, chẳng hạn như máy chủ, mạng, cơ sở dữ liệu và các tài nguyên khác.
• Phân loại các tài nguyên: Phân loại các tài nguyên thành các module riêng biệt để quản lý và triển khai tài nguyên một cách dễ dàng.
• Sử dụng mô hình tên: Sử dụng mô hình tên cho các tài nguyên và module để giúp dễ dàng quản lý và theo dõi các tài nguyên.
• Xác định các biến: Xác định các biến cần được sử dụng cho các module. Các biến này có thể được sử dụng để cấu hình các tài nguyên khác nhau trong các module.
• Định nghĩa các tài nguyên: Định nghĩa các tài nguyên trong module bằng cách sử dụng các file cấu hình Terraform.
• Tối ưu hóa cấu trúc dự án: Tối ưu hóa cấu trúc dự án bằng cách sử dụng các thư mục và file để lưu trữ các module. Điều này giúp dễ dàng quản lý và triển khai các module khác nhau.
• Tài liệu hóa các module: Viết tài liệu về module để giúp cho việc sử dụng và bảo trì module được dễ dàng hơn.
• Sử dụng các phương tiện kiểm tra và tự động hóa: Sử dụng các công cụ kiểm tra và tự động hóa để đảm bảo tính ổn định và bảo mật của các module. Ví dụ như sử dụng Terraform Cloud để tự động kiểm tra cú pháp và các vấn đề khác liên quan đến module.

4. Ví dụ minh hoạ.

4.1. Ví dụ 1.

Dưới đây là một ví dụ về Terraform Modules cho hệ thống AWS:

Khai báo Module:

module "ec2-instance" {
  source = "./modules/ec2-instance"

  instance_type = var.instance_type
  ami           = var.ami
  key_name      = var.key_name
  subnet_id     = var.subnet_id
  security_group_ids = var.security_group_ids
}

Trong đoạn code trên, chúng ta khai báo một module có tên là “ec2-instance” và sử dụng đường dẫn đến thư mục chứa module này. Để sử dụng module, chúng ta cần khai báo các biến cần thiết, bao gồm instance_type, ami, key_name, subnet_id, và security_group_ids.

Định nghĩa Module:

resource "aws_instance" "this" {
  ami           = var.ami
  instance_type = var.instance_type
  key_name      = var.key_name
  subnet_id     = var.subnet_id
  vpc_security_group_ids = var.security_group_ids

  tags = {
    Name = "EC2 Instance"
  }
}

Trong module “ec2-instance”, chúng ta định nghĩa một tài nguyên EC2 instance của AWS bằng cách sử dụng resource "aws_instance" "this". Tài nguyên này có các thuộc tính như ami, instance_type, key_name, subnet_id, vpc_security_group_ids và tags. Các giá trị này được lấy từ các biến khai báo ở trên.

Khai báo Biến:

variable "instance_type" {
  type    = string
  default = "t2.micro"
}

variable "ami" {
  type    = string
  default = "ami-0c55b159cbfafe1f0"
}

variable "key_name" {
  type    = string
  default = "my-key-pair"
}

variable "subnet_id" {
  type    = string
}

variable "security_group_ids" {
  type    = list(string)
}

Trong đoạn code trên, chúng ta khai báo các biến cần thiết cho module “ec2-instance”. Các biến này bao gồm instance_type, ami, key_name, subnet_id, và security_group_ids. Mỗi biến đều có kiểu và giá trị mặc định khác nhau.

Tổng quan về module này là chúng ta có một module để triển khai một EC2 instance trong hệ thống AWS, sử dụng các biến để cấu hình các thuộc tính của EC2 instance. Bằng cách sử dụng module, chúng ta có thể tái sử dụng mã và dễ dàng triển khai nhiều instance khác nhau mà không cần phải lặp lại các thông tin cấu hình của từng instance.

4.2. Ví dụ 2.

Dưới đây là một ví dụ về Terraform Modules cho hệ thống vSphere:

Khai báo Module:

module "vmware-vm" {
  source = "./modules/vmware-vm"

  name         = var.name
  guest_os    = var.guest_os
  cpu_count    = var.cpu_count
  memory_size_mb = var.memory_size_mb
  datastore    = var.datastore
  network_interface = var.network_interface
}

Chúng ta đang khai báo một module có tên là “vmware-vm” và sử dụng đường dẫn đến thư mục chứa module này. Để sử dụng module, chúng ta cần khai báo các biến cần thiết, bao gồm name, guest_os, cpu_count, memory_size_mb, datastore, và network_interface.

Định nghĩa Module:

resource "vsphere_virtual_machine" "this" {
  name         = var.name
  guest_os    = var.guest_os
  num_cpus    = var.cpu_count
  memory      = var.memory_size_mb
  datastore   = var.datastore

  network_interface {
    network_id = var.network_interface["network_id"]
    adapter_type = var.network_interface["adapter_type"]
  }
}

Trong module “vmware-vm”, chúng ta định nghĩa một tài nguyên máy ảo vSphere bằng cách sử dụng resource "vsphere_virtual_machine" "this". Tài nguyên này có các thuộc tính như name, guest_os, num_cpus, memory, datastore, và network_interface. Các giá trị này được lấy từ các biến khai báo ở trên.

Khai báo Biến:

variable "name" {
  type    = string
}

variable "guest_os" {
  type    = string
}

variable "cpu_count" {
  type    = number
  default = 1
}

variable "memory_size_mb" {
  type    = number
  default = 1024
}

variable "datastore" {
  type    = string
}

variable "network_interface" {
  type    = map
  default = {
    network_id = "dvportgroup-123"
    adapter_type = "vmxnet3"
  }
}

Trong đoạn code trên, chúng ta khai báo các biến cần thiết cho module “vmware-vm”. Các biến này bao gồm name, guest_os, cpu_count, memory_size_mb, datastore, và network_interface. Mỗi biến đều có kiểu và giá trị mặc định khác nhau.

Tổng quan về module này là chúng ta có một module để triển khai một máy ảo vSphere, sử dụng các biến để cấu hình các thuộc tính của máy ảo. Bằng cách sử dụng module, chúng ta có thể tái sử dụng mã và dễ dàng triển khai nhiều máy ảo khác nhau.

4.3. Ví dụ 3.

Dưới đây là một ví dụ về Terraform Modules cho hệ thống KVM:

Khai báo Module:

module "kvm-vm" {
  source = "./modules/kvm-vm"

  name         = var.name
  memory       = var.memory
  vcpu         = var.vcpu
  network_name = var.network_name
  image_path   = var.image_path
}

Chúng ta đang khai báo một module có tên là “kvm-vm” và sử dụng đường dẫn đến thư mục chứa module này. Để sử dụng module, chúng ta cần khai báo các biến cần thiết, bao gồm name, memory, vcpu, network_name, và image_path.

Định nghĩa Module:

resource "libvirt_domain" "this" {
  name   = var.name
  memory = var.memory
  vcpu   = var.vcpu

  network_interface {
    network_name = var.network_name
  }

  disk {
    path = "/var/lib/libvirt/images/${var.name}.qcow2"
    source = var.image_path
    driver_cache = "none"
    driver_discard = "unmap"
    driver_io = "native"
    driver_name = "qemu"
    driver_type = "qcow2"
    bus = "virtio"
  }
}

Trong module “kvm-vm”, chúng ta định nghĩa một tài nguyên máy ảo KVM bằng cách sử dụng resource "libvirt_domain" "this". Tài nguyên này có các thuộc tính như name, memory, vcpu, network_interface, và disk. Các giá trị này được lấy từ các biến khai báo ở trên.

Khai báo Biến:

variable "name" {
  type    = string
}

variable "memory" {
  type    = number
  default = 1024
}

variable "vcpu" {
  type    = number
  default = 1
}

variable "network_name" {
  type    = string
}

variable "image_path" {
  type    = string
}

Trong đoạn code trên, chúng ta khai báo các biến cần thiết cho module “kvm-vm”. Các biến này bao gồm name, memory, vcpu, network_name, và image_path. Mỗi biến đều có kiểu và giá trị mặc định khác nhau.

Tổng quan về module này là chúng ta có một module để triển khai một máy ảo KVM, sử dụng các biến để cấu hình các thuộc tính của máy ảo. Bằng cách sử dụng module, chúng ta có thể tái sử dụng mã và dễ dàng triển khai nhiều máy ảo khác nhau.