Глава 5. CLI Terraform

Чтобы следовать данной главой вам требуется обладать представлением о написании кода конфигурации Terraform через определение поставщиков, ресурсов, переменных, данных и вывода. Наряду с этим, на протяжении всего курса будут полезны некоторые базовые знания об основных поставщиках услуг, таких как GCP, AWS и Azure. Весь применяемый в этой главе код вы можете отыскать по такой ссылке: https://github.com/PacktPublishing/HashiCorp-Infrastructure-Automation-Certification-Guide/tree/master/chapter5.

Чтобы увидеть видео "Код в действии", перейдите по следующей ссылке: https://bit.ly/36re4es.

CLI Terraform является приложением командной строки с открытым исходным кодом, предоставляемое HashiCorp, которое позволяет вам выполнять различные команды и подкоманды. Основными командами, которые охватывают все рабочие процессы Terraform являются init, plan и apply. После своих основных команд вы можете выполнять флаг subcommands . Чтобы просмотреть полный список поддерживаемых CLI Terraform команд, вы можете просто выполнить terraform из любого терминала и вы обнаружите следующий вывод:

$ terraform
Usage: terraform [global options] <subcommand> [args]
The available commands for execution are listed below.
The primary workflow commands are given first, followed by
less common or more advanced commands.
Main commands:
  init          Prepare your working directory for other commands
  validate      Check whether the configuration is valid
  plan          Show changes required by the current configuration
  apply         Create or update infrastructure
  destroy       Destroy previously-created infrastructure
All other commands:
  console       Try Terraform expressions at an interactive command prompt
  fmt           Reformat your configuration in the standard style
  force-unlock  Release a stuck lock on the current workspace
  get           Install or upgrade remote Terraform modules
  graph         Generate a Graphviz graph of the steps in an operation
  import        Associate existing infrastructure with a Terraform resource
  login         Obtain and save credentials for a remote host
  logout        Remove locally-stored credentials for a remote host
  output        Show output values from your root module
  providers     Show the providers required for this configuration
  refresh       Update the state to match remote systems
  show          Show the current state or a saved plan
  state         Advanced state management
  taint         Mark a resource instance as not fully functional
  untaint       Remove the 'tainted' state from a resource instance
  version       Show the current Terraform version
  workspace     Workspace management
Global options (use these before the subcommand, if any):
  -chdir=DIR    Switch to a different working directory before executing the
                given subcommand.
  -help         Show this help output, or the help for a specified subcommand.
  -version      An alias for the "version" subcommand.
		

Если вы желаете увидеть поддерживаемые подчинённые команды команд, тогда вы можете получить их, добавляя флаг -h к своей основной команде. Это откроет необходимое меню подсказки этой конкретной команды. Например, чтобы увидеть подкоманды для graph Terraform, выполните такую команду:

$ terraform graph -h
Usage: terraform graph [options] [DIR]
  Outputs the visual execution graph of Terraform resources according to configuration files in DIR (or the current directory if omitted).
  The graph is outputted in DOT format. The typical program that can read this format is GraphViz, but many web services are also available to read this format.
  The -type flag can be used to control the type of graph shown. Terraform creates different graphs for different operations. See the options below for the list of types supported. The default type is "plan" if a configuration is given, and "apply" if a plan file is passed as an argument.
Options:
  -draw-cycles     Highlight any cycles in the graph with colored edges. This helps when diagnosing cycle errors.
  -type=plan       Type of graph to output. Can be: plan, plan-destroy, apply, validate, input, refresh.
  -module-depth=n  (deprecated) In prior versions of Terraform, specified the depth of modules to show in the output.
		

Предположим, вы выполняете команды Terraform применяя в качестве оболочки команд bash или zsh и ищете вариант заполнения Tab. В таком случае вы можете установить такую особую функциональную возможность выполнив следующую команду:

$ terraform -install-autocomplete
		

Это окажет вам содействие в плане заполнения ваших команд или подчинённых команд всякий раз когда вы нажимаете клавишу Tab в своей оболочке команд.

Теперь мы разобрались с CLI Terraform и с тем как мы можем применять его для просмотра списка всех поддерживаемых им команд. Давайте теперь попробуем разобраться с тем, как мы можем выполнять аутентификацию CLI Terraform в Azure.

Поскольку вы теперь знакомы с CLI Terraform, двигаясь далее, мы намерены обсудить в этом разделе то, как можно выполнять интеграцию или аутентификацию Terraform в Azure при помощи CLI Terraform. Для снабжения или обновления служб Azure при помощи CLI Terraform, важно чтобы ваша версия CLI Terraform была бы способна общаться с Azure. В Главе 2, Руководство по установке Terraform, мы уже обсуждали как вы можете устанавливать terraform.exe в своей локальной машине. Итак, давайте попробуем разобраться с тем, как CLI Terraform общается с Azure.

Вот методы, посредством которых вы можете выполнять аутентификацию CLI Terraform для Azure:

Все возможные варианты, относящиеся к аутентификации в Azure, достаточно сложно, поскольку их имеется великое множество. Поэтому, для изучения всех возможных вариантов аутентификации вы можете прочесть https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs.

Мы же сейчас намерены обсудить один из известных методов аутентификации: при помощи Главной службы и Секрета клиента.

Для аутентификации CLI Terraform в Azure при помощи Главной службы и Секрета клиента, выполните такие шаги:

Мы уже выполнили аутентификацию Terraform для Azure при помощи Главной службы. Давайте попробуем создать некие службы Azure при помощи Terraform. Мы попробуем создать некую виртуальную машину (ВМ) Azure при помощи кода Terraform. Следующий фрагмент кода содержит дерево блоков, в котором мы поместили код для соответствующей ВМ с хранилищем (vault) ключей в файле main.tf. В своём файле variables.tf мы определили все необходимые входные переменные и мы передаём все значения входных переменных из файла terraform.tfvars:

inmishrar@terraform-vm:~/code# tree
.
├── main.tf
├── providers.tf
├── terraform.tfvars
└── variables.tf
0 directories, 4 files
		

Вы можете получить полный блок кода внутри соответствующего файла main.tf по ссылке на GitHub, представленной в нашем разделе Технические требования. Вот некая выдержка из него:

resource "azurerm_resource_group" "rgname" {
  name     = var.rgname
  location = var.location
  tags     = var.tags
}
resource "azurerm_virtual_network" "vnet" {
  name                = var.vnet_name
  address_space       = var.address_space
  location            = azurerm_resource_group.rgname.location
  resource_group_name = azurerm_resource_group.rgname.name
  tags                = var.tags
}
resource "azurerm_subnet" "subnet" {
  name                 = var.subnet_name
  resource_group_name  = azurerm_resource_group.rgname.name
  virtual_network_name = azurerm_virtual_network.vnet.name
  address_prefixes     = [cidrsubnet(var.address_space[0], 8, 1)]
}
...
		

Весь блок кода внутри файла variables.tf целиком вы можете получить по ссылке на GitHub, представленной в нашем разделе Технические требования. Вы можете получить его непосредственно оттуда, однако вот некая выдержка из него:

variable "rgname" {
  type        = string
  description = "name of resource group"
}
variable "location" {
  type        = string
  description = "location name"
}
variable "vnet_name" {
  type        = string
  description = "vnet name"
}
...
 	   

Блок кода terraform.tfvars выглядит следующим образом:

rgname               = "Terraform-rg"
location             = "West Europe"
tags = {
  Environment = "prod"
  Owner       = "Azure-Terraform"
}
vm_size              = "Standard_F2"
vm_name              = "Terraform-vm"
admin_username       = "azureterraform"
vm_publisher         = "MicrosoftWindowsServer"
vm_offer             = "WindowsServer"
vm_sku               = "2016-Datacenter"
vm_version           = "latest"
sku_name             = "premium"
vnet_name            = "Terraform-vnet"
address_space        = ["10.1.0.0/16"]
subnet_name          = "Terraform-subnet"
nic_name             = "Terraform-nic"
keyvault_name        = "Terraform-keyvault2342"
keyvault_secret_name = "Terraform-vm-password"
 	   

Когда вы исполните terraform init, plan и apply, это создаст затем необходимые службы Azure, как то показано на приводимом далее снимке экрана:

Мы выполнили управление ресурсами Azure при помощи Terraform. Таким образом, вы можете предоставлять в Microsoft Azure новые ресурсы, а также обновлять ресурсы при помощи предоставляемого файла конфигурации Terraform, когда вы установили такие ресурсы в своём файле tfstate.

В данном разделе мы обсудили как вы можете выполнять аутентификацию Terraform в Azure, а затем мы обсудили как написать некий файл конфигурации Terraform для оснастки ресурсов в Azure. При создании файла конфигурации мы упоминали как вы создаёте различные файлы, такие как providers.tf, main.tf и variables.tf, а также пояснили как получать значения входных переменных при помощи terraform.tfvars.

В нашем следующем разделе мы обсудим процесс аутентификации Terraform для AWS и соответствующим образом попробуем предоставить некие ресурсы в AWS аналогично тому, как мы это делали в Azure.

Поскольку мы ранее обсудили как вы можете выполнять аутентификацию Terraforme в Azure, давайте теперь попробуем разобраться с тем, как вы можете выполнять аутентификацию Terraform для AWS. Вот те методы, которые позволяют Terraform получать аутентификацию в AWS:

Для получения подробных сведений относительно того как вы можете выполнять аутентификацию Terraform для AWS, вы можете посетить https://registry.terraform.io/providers/hashicorp/aws/latest/docs. Обсуждение всех этих методов выходит за рамки данной книги, но мы, тем не менее, обсудим один из методов и покажем как вы можете предоставлять службы в AWS.

Для аутентификации при помощи доступа с ключом идентификатора и секретом выполните такие шаги:

Мы в конце концов управились с выгрузкой необходимого поставщика AWS и теперь можем предоставлять или обновлять службы AWS при помощи Terraform. Давайте попробуем разобраться как мы можем писать код конфигурации Terraform для своего поставщика AWS.

Вы уже выполнили управление аутентификацией Terraform к AWS, поэтому давайте посмотрим как мы можем предоставлять службы AWS при помощи Terraform. Нет никакой возможности объяснять все доступные службы AWS, поэтому мы рассмотрим очень простой пример создания виртуального частного облака (VPC, virtual private cloud). Если вы желаете изучить блок кода ресурсов Terraform для поставщика AWS, вы можете воспользоваться справочными сведениями в https://registry.terraform.io/providers/hashicorp/aws/latest/docs.

Следующий блок кода поможет вам с предоставлением VPC в AWS. Для оснастки некого VPC AWS мы создаём такие файлы и помещаем их в своём репозитории GitHub:

inmishrar@terraform-vm:~/code# tree
.
├── main.tf
├── providers.tf
├── terraform.tfvars
└── variables.tf
0 directories, 4 files
		

В своём файле main.tf мы удерживаем такой блок кода:

resource "aws_vpc" "terraform_aws_vpc" {
  cidr_block       = var.cidr_block
  instance_tenancy = "default"
  tags = {
    Name = "terraform_aws_vpc"
  }
}
 	   

Аналогично, в файле variables.tf мы храним такое определение кода:

variable "cidr_block" {
  description = "provide VPC range"
}
variable "aws_region" {
  description = "provide AWS region"
}
 	   

Входные значения для своих переменных мы получаем из terraform.tfvars следующим образом:

cidr_block = "10.0.0.0/16"
aws_region = "ap-southeast-1"
 	   

Когда мы выполним команды terraform plan и apply, это создаст некое новое VPC в AWS, как это показано на приводимом далее снимке экрана:

В конце концов, мы управились с созданием VPC AWS при помощи кода конфигурации Terraform. Допустим завтра вы пожелаете создать помимо этого VPC вы пожелаете создать дополнительные службы. Вам просто потребуется определить такой ресурс или блок кода модуля в своём файле конфигурации Terraform и Terraform снабдит такими конкретными службами или обновит их.

В данном разделе мы обсудили как вы можете выполнять аутентификацию Terraform в AWS и далее мы объяснили как писать файл конфигурации Terraform для снабжения службами AWS воспользовавшись образцом некого VPV AWS. В своём следующем разделе мы обсудим процесс аутентификации Terraform для GCP и, соответствующим образом, мы попытаемся создать в GCP некоторые службы.

Поскольку мы рассмотрели как мы выполняем аутентификацию Terraform в Azure и AWS, мы аналогично попробуем разобраться с тем как Terraform может аутентифицироваться для GCP.

Существует множество методов аутентификации Terraform в GCP, структурируемых так:

Обсуждение всех вышеупомянутых методов это нечто вне пределов данной книги, а потому мы просто рассмотрим один метод аутентификации.

Для аутентификации некой учётной записи службы Google выполните следующие шаги:

Применяя команду terraform init, мы расправляемся с выгрузкой поставщика Google. Теперь мы готовы начать снабжение службами Облачного решения Google или манипулирования ими с применением Terraform.

Мы уже выполнили аутентификацию Terraform для своей учётной записи GCP, поэтому давайте воспользуемся примером развёртывания службы механизма прикладных приложений Google внутри Облачного решения Google с применением Terraform. Следуя нашим рекомендациям, мы сохраняем следующий код в соответствующих файлах:

inmishrar@terraform-vm:~/code# tree
.
├── main.tf
├── providers.tf
├── terraform.tfvars
└── variables.tf
0 directories, 4 files
		

В файле main.tf мы определяем такой код:

data "google_project" "terraform_project" {
  project_id = var.project_id
}
resource "google_app_engine_application" "terraform_app" {
  project     = data.google_project.terraform_project.project_id
  location_id = var.location_id
}
 	   

В файле variables.tf представляется код:

variable "location_id"{
  type        = string
  description = "provide location name"
}
variable "project_id"{
  type        = string
  description = "provide Google Project ID"
}
 	   

В файле terraform.tfvars мы удерживаем такой блок кода:

project_id = "terraform-project-56745"
location_id = "asia-south1"
 	   

Теперь, когда мы исполняем terraform plan и применяем соответствующую команду в своём CLI, она предоставляет службу механизма прикладных приложений в Облачном решении Google, что можно обнаружит на следующем снимке экрана:

В конце концов, мы управились с предоставлением службы приложений Механизма прикладных приложений Google при помощи кода Terraform. Итак, в будущем, когда вы планируете вносить изменения или добавлять новую инфраструктуру в Облачное решение Google, вы можете применять infrastructure as code (IaC) Terraform. В своём следующем разделе мы намерены изучить различные команды CLI Terraform и их применение.

CLI Terraform поддерживает большое число команд и в этом разделе мы попробуем рассмотреть некоторые из основных команд их соответствующий вывод. Мы обсудим рабочие процессы Terraform в своей следующей главе, Главе 6, Рабочие потоки Terraform, однако на данный момент мы обсудим некоторые из базовых команд CLI Terraform, вот они:

Мы изучили различные поддерживаемые CLI Terraform команды. Для получения дополнительных подробностей обо всех поддерживаемых CLI Terraform командах вы можете посетить https://www.terraform.io/docs/commands/index.html

По завершению данной главы вы овладели пониманием CLI Terraform. Мы также обсудили как вы можете осуществлять аутентификацию Terraform в Azure, AWS и GCP. Двигаясь далее, мы также поясняли различные команды и подчинённые команды Terraform, поддерживаемые CLI Terraform. После прочтения этой главы целиком, вы должны быть способны применять CLI Terraform для основных поставщиков облачных решений, таких как AWS, Azure и GCP, что поможет вам предоставлять и обновлять ресурсы таких поставщиков облачных решений.

В своей следующей главе мы обсудим рабочие процессы Terraform, где мы сосредоточимся на основных командах CLI Terraform, то есть init, plan, apply и destroy.

Ответы на данные вопросы можно обнаружить в разделе Аттестация в самом конце этой книги:

Для получения дополнительных сведений по рассматривавшимся в этой главе темам вы можете обратиться к следующим ссылкам: