Terraform 是一種非常流行的開源 IaC(基礎設施即代碼)工具,用于定義和提供完整的基礎設施。Terraform 于 2014 年推出,其采用率已在全球范圍內快速增長,越來越多的開發(fā)人員正在學習 Terraform 并嘗試在其組織中部署基礎設施。
?
如果您已經開始使用 Terraform,則必須采用最佳實踐來更好地配置生產基礎設施。本文章將總結10個關于 Terraform 改善基礎架構的最佳實踐。
?
結構化
當您使用 Terraform 處理大型生產基礎設施項目時,需要遵循適當?shù)哪夸浗Y構來應對項目中可能出現(xiàn)的復雜性。建議為不同目的建立單獨的目錄。如果您在開發(fā)、暫存和生產環(huán)境中使用 Terraform,請為每個環(huán)境設置單獨的目錄。
?
Terraform 配置也應該是分開的,因為經過一段時間后,不斷增長的基礎設施的配置將變得更加復雜。
?
geekflare@geekflare:~$ tree terraform_project/
terraform_project/
├── dev
│ ├── main.tf
│ ├── outputs.tf
│ └── variables.tf
├── modules
│ ├── ec2
│ │ ├── ec2.tf
│ │ └── main.tf
│ └── vpc
│ ├── main.tf
│ └── vpc.tf
├── prod
│ ├── main.tf
│ ├── outputs.tf
│ └── variables.tf
└── stg
├── main.tf
├── outputs.tf
└── variables.tf
6 directories, 13 files
?
您可以在文件 main.tf 本身內編寫所有的 Terraform 代碼(模塊、資源、變量、輸出),同時為變量和輸出設置單獨的 Terraform 代碼使其更具可讀性和易于理解。
?
命名規(guī)則
Terraform 中使用命名規(guī)則讓資源易于理解、一目了然。
?
例如,假設您要為項目中的不同環(huán)境創(chuàng)建三個不同的工作區(qū)。與其將環(huán)境命名為env1
、env2
、env3
,不如嘗試使用dev
、stage
、prod
來命名。從名稱本身來看,很明顯每個環(huán)境都代表著不同的工作空間。資源、變量、模塊等的也遵循類似的規(guī)則。
?
Terraform 中的資源名稱應以相關資源名稱開頭,后跟下劃線和其他詳細信息。例如,用于在 AWS 中為 route table 創(chuàng)建 Terraform 對象的資源名稱為 aws_route_table
。
?
所以如果正確地遵循命名規(guī)則,即使是復雜的代碼也會更容易理解。
?
使用共享模塊
強烈建議使用可用的官方 Terraform 模塊。直接使用現(xiàn)有模塊,能夠有效節(jié)省時間和精力。Terraform registry 有很多現(xiàn)成可用的模塊,企業(yè)可以根據(jù)需要對現(xiàn)有模塊進行更改。
?
此外,每個模塊應該只專注于基礎設施的一個方面,比如創(chuàng)建 AWS EC2 實例、設置 MySQL 數(shù)據(jù)庫等。舉個例子,如果您想在 terraform 代碼中使用 AWS VPC,可以直接使用 -simple VPC
。
?
module "vpc_example_simple-vpc" {
source
= "terraform-aws-modules/vpc/aws//examples/simple-vpc"
version = "2.48.0"
}
?
使用最新版本
Terraform 開發(fā)社區(qū)非常活躍,新功能發(fā)布頻繁。建議在發(fā)布新的主要版本時使用最新版本的 Terraform。您可以輕松升級到最新版本。如果跳過多個主要版本,升級將變得非常復雜。
?
運行terraform -v
命令以檢查版本更新。
geekflare@geekflare:~$ terraform -v
Terraform v0.11.14
Your version of Terraform is out of date! The latest version
is 0.12.0. You can update by downloading from www.terraform.io/downloads.html
?
備份系統(tǒng)狀態(tài)
請始終備份 Terraform 的狀態(tài)文件,這些文件跟蹤基礎設施的元數(shù)據(jù)和資源。默認情況下,這些名為terraform.tfstate
的文件本地存儲在工作區(qū)目錄中。
?
如果沒有這些文件,Terraform 將無法確定在基礎設施上部署了哪些資源。因此,必須備份狀態(tài)文件。默認情況下,terraform.tfstate.backup會被創(chuàng)建并用來保存狀態(tài)文件的備份。
?
geekflare@geekflare:~$ tree terraform_demo/
terraform_demo/
├── awsec2.tf
├── terraform.tfstate
└── terraform.tfstate.backup
0 directories, 3 files
如果要將備份狀態(tài)文件存儲到其他位置,在 terraform 命令中使用-backup
標記并提供位置路徑。大部分情況下,一個項目會有多個開發(fā)人員參與。因此為了讓開發(fā)人員方便訪問狀態(tài)文件。應該使用terraform_remote_state
數(shù)據(jù)源將其存儲在遠程位置。
?
以下示例將備份到 S3。
?
data "terraform_remote_state" "vpc" {
backend = "s3"
config = {
bucket = “s3-terraform-bucket”
key = “vpc/terraform.tfstate"
region = “us-east-1”
}
}
?
鎖定狀態(tài)文件
可能有多個場景,其中不止一個開發(fā)人員試圖同時運行 Terraform 配置。這可能導致 terraform 狀態(tài)文件損壞甚至數(shù)據(jù)丟失。鎖定機制能夠有效防止此類情況發(fā)生,確保一次只有一個人在運行 terraform 配置,并且沒有沖突。
?
下面是使用 DynamoDB 鎖定位于遠程位置的狀態(tài)文件的示例。
?
resource “aws_dynamodb_table” “terraform_state_lock” {
name = “terraform-locking”
read_capacity = 3
write_capacity = 3
hash_key = “LockingID”
attribute {
name = “LockingID”
type = “S”
}
}
terraform {
backend “s3” {
bucket = “s3-terraform-bucket”
key = “vpc/terraform.tfstate”
region = “us-east-2”
dynamodb_table = “terraform-locking”
}
}
?
當多個用戶嘗試訪問狀態(tài)文件時,DynamoDB 數(shù)據(jù)庫名稱和主鍵將用于狀態(tài)鎖定并保持一致性。注意:并非所有后端都支持鎖定。
?
使用自變量
self
變量是一種特殊的變量,當您在部署基礎設施之前不知道變量的值時可以使用它。假設您要使用僅在 terraform apply 命令后部署的實例的 IP 地址,也就是在它啟動并運行之前您是不知道 IP 地址的。
?
在這種情況下,您可以使用自變量self.ATTRIBUTE
。在這個例子中,您可以使用self.ipv4_address
作為自變量來獲取實例的 IP 地址。這些變量只允許在 terraform 配置的連接和配置塊上使用。
?
connection {
host = self.ipv4_address
type = "ssh"
user = var.users[2]
private_key = file(var.private_key_path)
}
?
最小化爆炸半徑
爆炸半徑(Blast Radius)是衡量如果流程沒有按計劃進行時可能發(fā)生的損害的量度。
?
例如,如果您在基礎設施上部署了一些 Terraform 配置,但配置沒有得到正確應用,那么對基礎設施造成的損害會有多大。因此,為了盡量減少故障影響范圍,建議每次配置的基礎設施數(shù)量不宜過多。即便出現(xiàn)問題,對基礎設施的損害也能控制在較小范圍,并且可以迅速得到糾正。一次性配置大量基礎設施是非常危險的。
?
使用 var 文件
在 terraform 中,您可以創(chuàng)建一個帶有擴展名的文件<em>.</em>tfvars
,并使用-var-file
此文件傳遞給 terraform apply 命令。這個方式可以幫助您傳遞那些您不想放入 terraform 配置代碼中的變量。
?
始終建議通過-var-file
在本地傳遞密碼、密鑰等變量,而不是將其保存在 terraform 配置或遠程位置版本控制系統(tǒng)中。
?
例如,如果您想使用 terraform 啟動 ec2 實例,您可以使用-var-file
傳遞訪問密鑰和其他機密信息。創(chuàng)建文件 terraform.tfvars 并將密鑰放入此文件中。
?
geekflare@geekflare:~$ gedit terraform.tfvars
access_key = "AKIATYWSDFYU5DUDJI5F"
secret_key = "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"
?
然后在 terraform 命令中使用這個 var 文件。
?
geekflare@geekflare:~$ terraform apply -var-file=/home/geekflare/terraform.tfvars
?
使用 Docker
當您運行 CI/CD 流水線構建作業(yè)時,建議使用 docker 容器。Terraform 提供了可以直接使用的官方 Docker 容器。如果需要更改 CI/CD 服務器,您可以輕松地在容器內傳遞基礎設施。
?
在生產環(huán)境上部署基礎設施之前,您還可以在 docker 容器上測試基礎設施,非常容易部署。通過結合 Terraform 和 Docker,您可以獲得可移植、可重用、可重復的基礎設施。
?文章來源:http://www.zghlxwxcb.cn/news/detail-476673.html
參考鏈接:
https://geekflare.com/terraform-best-practices/文章來源地址http://www.zghlxwxcb.cn/news/detail-476673.html
到了這里,關于Terraform 改善基礎架構的十個最佳實踐的文章就介紹完了。如果您還想了解更多內容,請在右上角搜索TOY模板網以前的文章或繼續(xù)瀏覽下面的相關文章,希望大家以后多多支持TOY模板網!