[Terraform] 기본 사용법 #1 (주요 커맨드, HCL)

💡cloudNet@ 팀의 가시다 님이 진행하는 Terraform 101 Study 4기 1주차 내용으로,
[테라폼으로 시작하는 IaC] 도서를 참조하였습니다. 감사합니다..

 

1. 주요 커맨드, HCL

1. 주요 커맨드

지난 포스팅에서 EC2 생성, 수정, 삭제 실습을 통해 기본적인 명령어에 대해 진행했었지만, 테라폼은 기본 사용법이 매우 중요한 부분이므로, 명령어에 대해서 상세하게 다시 정리해보겠다.

테라폼 사용 환경 구성이 완료된 상태라면, terraform 명령을 실행하는 것만으로도 기본적인 도움말이 표시된다.

devcw@woos-dev-server:/mnt/c/Users/chanw/OneDrive/바탕 화면/terraform/t101-1week-ec2$ 
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
  metadata      Metadata related commands
  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
  test          Execute integration tests for Terraform modules
  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.

• terraform 명령어 실행 시 기본 출력 내용

 

1.1 help & init 초기화

terraform 명령 실행 시 보조 명령에 대해 사용 가능한 인수 값을 확인하고 싶다면, 서브 커맨드와 함께 -help를 입력한다.

help 옵션

# 서브커맨드 help 지원
terraform console --help
terraform init --help
등 ...

 

init 초기화

terraform init 명령은 테라폼 작업 디렉터리를 초기화하는데 사용된다.

(테라폼 실행시 필수적인 명령이며, 구성에 필요한 의존성 정의를 읽고, 필요한 아티팩트나 라이브러리를 다운로드하고 준비시키는 역할과 비슷하다.)

# 테라폼 코드 파일이 있는 디렉터리로 이동
cd 03.start/

# 초기화 진행
terraform init

Initializing the backend...

Initializing provider plugins...

Terraform has been successfully initialized!

You may now begin working with Terraform. Try running "terraform plan" to see
any changes that are required for your infrastructure. All Terraform commands
should now work.

If you ever set or change modules or backend configuration for Terraform,
rerun this command to reinitialize your working directory. If you forget, other
commands will detect it and remind you to do so if necessary.

 

1.2 validate 테라폼 구성 파일 유효성 확인

디렉터리에 있는 테라폼 구성 파일의 유효성을 확인한다. 이때 대상이 되는 인프라와 서비스 상태를 확인하기 위해 원격 작업이나 api 작업은 발생하지 않고, 코드적인 유효성만 검사한다.

(즉, api 작업이 발생하는 terraform plan 동작과 차이가 있다.)

 

기존 main.tf 파일의 filename 앞에 주석을 추가해보겠다.

resource "local_file" "abc" {
content = "abc!"
**#**filename = "${path.module}/abc.txt"
}

이후 terraform validate를 실행시켜 보겠다.

사진-1

error 내용을 확인하면, 필수 인수인 filename를 찾을 수 없다는 메시지가 나타난다.

이렇게 유효성 검사를 진행할 수 있으머, 추가로 함께 사용하기에 좋은 추가 옵션도 존재한다.

 

-no-color

대부분의 명령어와 함께 사용할 수 있으며, 로컬이 아닌 외부 실행 환경(젠킨스, Github Action 등)을 사용하는 경우 색상 표기 문자를 없앨 수 있다.

사진-2

• -no-color 옵션을 추가하여 출력값의 색 표기를 제거하였다.

 

-json

실행 결과를 JSON 형식으로 출력해주는 서브 옵션이다.

(-json 옵션을 사용할 수 있는 명령어들이 따로 있음.. 전부 사용 가능하지는 않다.)

프로비저닝 파이프라인을 설계하는 경우 결과에 따른 쿼리가 필요할 수 있는데, JSON 형태로 결과를 출력함으로 프로비저닝 과정의 조건이나 데이터로 사용이 가능하다!

devcw@woos-dev-server:/mnt/c/Users/chanw/OneDrive/바탕 화면/terraform/03.start$
terraform validate -json
{
  "format_version": "1.0",
  "valid": true,
  "error_count": 0,
  "warning_count": 0,
  "diagnostics": []
}

 

1.3 plan 계획 & apply 실행

terraform plan 명령은 테라폼으로 적용할 인프라의 변경 사항과 관한 실행 계획을 생성하는 동작이다. 또한 출력되는 결과를 확인하여 미리 검토가 가능하다.

terraform apply 명령은 저 plan 계획을 기반으로 작업을 실행한다.

두 명령어는 밀접한 연관성이 있어 같이 실습해보겠다.

 

terraform plan 명령어 실행 결과

사진-3

위 결과처럼 plan 명령을 진행하면 첫 출력되는 로그에서 심볼이 가진 의미를 설명해준다.

현재는 구성된 리소스가 없으므로 코드 실행 시 신규로 생성을 진행하게 된다

그래서 + create 기호가 나타난다.

마지막 plan: 1 to add, 0 to change, 0 to destory 결과는 이 구성을 적용할 경우 1개의 리소스가 추가되고 변경 및 삭제되는 대상은 없다는 것이다.

 

참고, -detailed-exitcode

실행 계획 명령과 함께 사용하기에 좋은 추가 옵션이다.

옵션이 없을 때와 결과는 같으나, exitcode가 환경변수로 구성된다.

출력 결과를 직접 확인해보겠다.

사진-4

• ? 아놔… init로 초기화도 해보고 계속 재시도중인데 옵션이 먹히지 않는다… 해당 문제는 나중에 확인되면 수정하도록 하겠다.

 

terraform apply 실행 결과

terraform apply

Terraform used the selected providers to generate the following execution plan. Resource actions are indicated with the following symbols:
  + create

Terraform will perform the following actions:

  # local_file.abc will be created
  + resource "local_file" "abc" {
      + content              = "abc!"
      + content_base64sha256 = (known after apply)
      + content_base64sha512 = (known after apply)
      + content_md5          = (known after apply)
      + content_sha1         = (known after apply)
      + content_sha256       = (known after apply)
      + content_sha512       = (known after apply)
      + directory_permission = "0777"
      + file_permission      = "0777"
      + filename             = "./abc.txt"
      + id                   = (known after apply)
    }

Plan: 1 to add, 0 to change, 0 to destroy.

Do you want to perform these actions?
  Terraform will perform the actions described above.
  Only 'yes' will be accepted to approve.

  Enter a value: no  # no를 입력해서 일단 취소하였다.

Apply cancelled.

apply의 경우 ‘yes’가 아니면 모두 취소하는 것으로 간주한다.

지금은 no롤 입력하여 적용하지 않았고, 이번에는 실행 계획 파일을 생성하여 apply 명령을 실행하도록 하겠다.

 

참고, -out=tfplan

사진-5

사진-6

-out=<파일명> 형식으로 파일 이름이 정해져 플랜 결과가 생성되었다.

(바이너리 형태이기에 내용을 확인할 수 없다.)

다른 파일가 혼동하지 않도록 잘 생각해서 관리하자.

다음은 생성된 파일을 apply 명령에 붙여서 사용해보겠다.

사진-7

이전에 apply 명령으로 실행했을 때는 plan과 동일한 동작을 먼저 실행하고 이후 해당 실행 계획을 적용할 것인지 여부를 확인했었다.

그러나 지금은 실행 계획이 있으므로, 즉시 적용된 것을 확인할 수 있다.

terraform apply
local_file.abc: Refreshing state... [id=5678fb68a642f3c6c8004c1bdc21e7142087287b]

No changes. Your infrastructure matches the configuration.

Terraform has compared your real infrastructure against your configuration and found no differences, so no changes are needed.

Apply complete! Resources: 0 added, 0 changed, 0 destroyed.

다시 apply를 진행하니 실행 계획이 작성되지 않는다.

이는 테라폼은 선언적으로 구성 관리를 제공하기 때문에, *멱등성을 가져 동일한 구성에 대해서는 다시 실행하거나 변경하는 작업을 수행하지 않는다.

• 멱등성 : 일한 연산을 여러 번 수행해도 결과가 달라지지 않는 성질

그럼 main.tf에 새로운 항목을 추가하고 apply를 실행시키면 어떻게 될까?

사진-8

# main.tf 파일에 내용 추가
resource "local_file" "dev" {
  content  = "def!"
  filename = "${path.module}/def.txt"
}

결과를 확인해보면, 이미 프로비저닝된 resource “local_file” “abc”에 대해서는 변경이 없지만, 추가된 resource “local_file” “dev” 에 대해서는 새로 생성하겠다는 계획을 보여준다.

현재 yes를 입력하여 dev 파일이 생성되어 있는 상황에서, 기존에 구성한 tfplan 실행 계획 파일을 동작시켜보겠다.

사진-9

• tfplan 파일이 생성된 후 변경이 발생했으므로, 기존에 작성된 실행 계획은 더이상 적용되지 않는다.

테라폼은 선언적으로 동작하기 때문에 현재의 코드 상태와 적용할 상태를 비교해 일치시키는 동작을 수행한다.

즉, 코드에서 상태 구성이 제거된 정의는 삭제하는 동작을 수행한다.

(쉽게 설명하면 따로 삭제 하는 명령으로 삭제하는 것이 아닌, 코드상에서 리소스를 없애고 실행하면 리소스도 삭제가 진행되는 형식이다.)

 

1.4 destroy 제거 & fmt

destory

기본 사용법 : terraform [global option] destroy [option]]

destroy 명령은 테라폼 구성에서 관리하는 모든 개체를 제거하는 명령으로, 바로 위에서 설명했듯 일부 항목을 삭제하고 싶을 경우 선언적 특성을 이용하여 코드에서 제거한 후 apply 하는 방식으로 진행해야 한다.

(그래서 destory 명령을 따로 한번 더 확인하는 방법이 있는 것으로 알고있는데, 이건 뒤에서 다뤄보겠다.)

한번 destory 명령을 실행해보겠다.

사진-10

사진-11

abc.txt 와 dev.txt 파일이 삭제되었다.

apply와 마찬가지로 yes가 아니면 계획을 취소하는 것으로 간주한다.

• 또한 해당 명령은 terraform plan -destroy 를 실행한 결과와 동일하다. 즉, destory 작업도 이전 ftplan 파일처럼 미리 실행 계획을 생성하여 apply로 계획을 바로 실행할 수 있다.

 

-auto-approve

작업 시마다 yes를 입력하여 계획을 승인하는 것이 번거롭다면, 해당 옵션을 통해 자동 승인 기능을 부여할 수 있다.

# auto-approve 없이 실행
terraform apply
.. 생략
Enter a value : yes (yes입력)

# auto-approve 추가
terraform apply -auto-approve
.. 생략
plan 1 to add, 0 to change, 0 to destory

 

fmt

기본 사용법 : terraform fmt [options] [DIR]

format 또는 reformat의 줄임 표시로, 테라폼 구성 파일을 표준 형식 및 표준 스타일로 적용하는 데 사용한다.

주로 테라폼 코드의 가독성을 높이는데 사용된다.

(작업자별로 코드 작성 시 정렬, 빈칸, 내려쓰기 등 규칙이 다른 경우 유용함)

한번 직접 실행해서 비교해보겠다.

resource "local_file" "abc" {
content = "abc!"
filename = "${path.module}/abc.txt"
}

resource "local_file" "dev" {
  content  = "def!"
  filename = "${path.module}/def.txt"
}

• 적용 전

resource "local_file" "abc" {
  content  = "abc!"
  filename = "${path.module}/abc.txt"
}

resource "local_file" "dev" {
  content  = "def!"
  filename = "${path.module}/def.txt"
}

• 적용 후

 

2. HCL

HCL은 HashiCorp configuration Language의 약자로, 하시코프사에서 IaC와 구성 정보를 명시하기 위해 개발된 오픈소스이다.

공개된 소스 코드는 https//github.com/hashicorp/hcl 에서 확인 가능하다.

테라폼에서 HCL이 코드의 영역을 담당한다.

HCL를 사용하는 이유는, 보통 다수의 프로비저닝 대상 인프라와 서비스는 JSON과 YAML 방식의 기계 친화적인 언어로 소통한다. (예를 들면, ansible, docker-compose 등이 있다.)

그러나 이는 처음 접하는 사용자가 실제로 만들어내고 익숙해지는데 어려움이 있다.

하시코프사에서는 이와 같은 문제를 해결하기 위해 HCL를 만들었다.

HCL을 이용한 테라폼 구성	JSON을 이용한 CloudFormation 구성
resource "local_file" "abc" {   content = "abc!" filename = "${path.module}/abc.txt" }	{   "resource": [   {      "local_file": [       {        "abc": [        {          "content":"abc!",          "filenale":"${path.module}/abc.txt"         }       ]      }     ]    }   ] }

HCL를 사용하면 동일 내용을 JSON으로 표현하는 것 보다 50~70퍼센트 더 간결하고 읽기 쉽게 작성할 수 있다.

• HCL에서 변수와 문자열 값을 함께 사용하는 인터폴레이션 interpolation 표현 방식을, JSON을 사용하는 다른 IaC 도구와 비교

HCL을 이용한 테라폼 구성	JSON을 이용한 CloudFormation 구성
name = “{$var.PilotServerName}-vm”	“name”:”{”Fn::Join”:[”-”,[PilotServerName,vm]]}”

 

2.1 HCL 표현식

HCL로 작성되는 테라폼 코드 표현식은 다음과 같다.

// 한줄 주석 방법1
# 한줄 주석 방법2

/*
라인
주석
*/

locals {
  key1     = "value1"     # = 를 기준으로 키와 값이 구분되며
  myStr    = "TF ♡ UTF-8" # UTF-8 문자를 지원한다.
  multiStr = <<EOF
  Multi
  Line
  String
  with anytext
EOF

  boolean1    = true   # boolean true
  boolean2    = false  # boolean false를 지원한다.
  deciaml     = 123    # 기본적으로 숫자는 10진수,
  octal       = 0123   # 0으로 시작하는 숫자는 8진수,
  hexadecimal = "0xD5" # 0x 값을 포함하는 스트링은 16진수,
  scientific  = 1e10   # 과학표기 법도 지원한다.

  # funtion 호출 예
  myprojectname = format("%s is myproject name", var.project)

  # 3항 연산자 조건문을 지원한다.
  credentials = var.credentials == "" ? file(var.credentials_file) : var.credentials
}

HCL 표현식에서는 코드에서 사용되는 주석 표기부터 변수 정의 등을 포함하고 프로그래밍적인 연산과 구성 편의성을 높이기 위한 function도 제공한다.

테라폼으로 인프라를 구성하기 위한 선언 블록도 다수 존재한다.

• terraform
• resource
• data
• variable
• local
• output