[Terraform] Terraform 기본 명령어

🌽 Terraform의 작동 방식

terraform-workflow 테라폼의 작동은 기본적으로 코드 작성(Write) > 플래닝(Plan) > 반영(Apply)의 세 단계의 워크플로를 따른다. 확장자는 일반적으로 .tf를 가지며, 하나의 디렉터리 안에 여러개의 구성 파일을 둘 수 있다. 구성 파일을 담고 있는 디렉토리에서 테라폼 초기화 명령(terraform init)을 수행하면 주요 테라폼 명령을 수행할 수 있도록 필요한 설정이 진행된다.

1. 기본 실습 (1)

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

local_file은 테라폼의 local 프로바이더로 파일을 프로비저닝하는 데 사용된다.
${path.module}는 테라폼 모듈의 파일 시스템 경로이며, 여기서는 현재 디렉토리를 가리킨다.

현재 디렉토리에서 main.tf를 생성한 이후에, terraform init을 실행하면, 아래와 같은 디렉토리 구조를 가지게 된다.

1
> root@ubuntu ls -ali
2
total 8
3
239526472 drwxr-xr-x. 3 pxxguin pxxguin   66 Jul 26 22:19 .
4
     5327 drwxr-xr-x. 7 pxxguin pxxguin  106 Jul 26 22:13 ..
5
239526473 -rw-r--r--. 1 pxxguin pxxguin   92 Jul 26 22:14 main.tf
6
 84364313 drwxr-xr-x. 3 pxxguin pxxguin   23 Jul 26 22:19 .terraform
7
239526492 -rw-r--r--. 1 pxxguin pxxguin 1228 Jul 26 22:19 .terraform.lock.hcl

2. 기본 실습 (2)

우리가 작성한 테라폼 파일이 올바르게 잘 작성되어있는지에 대한 확인은 terraform validate를 통해서 확인할 수 있다.

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

위 상태에서 validate를 실행한다면, 코드에 문제가 없기 때문에 아래와 같은 결과를 반환한다.

1
> terraform validate
2
Success! The configuration is valid.

하지만, 기존의 코드에서 filename 부분을 주석 처리를 한다면, 결과는 달라진다.

1
resource "local_file" "abc" {
2
    content = "abc!"
3
    # filename = "${path.module}/abc.txt"
4
}

혹시 내가 작성한 코드가 틀렸는지 맞았는지 궁금하다면, terraform validate를 주기적으로 실행해서 추적하는 것이 좋다.

1
> terraform validate
2
╷
3
│ Error: Missing required argument
4
│
5
│   on main.tf line 1, in resource "local_file" "abc":
6
│    1: resource "local_file" "abc" {
7
│
8
│ The argument "filename" is required, but no definition was found.

3. 기본 실습 (3)

앞에서 테라폼의 기본 동작에 대한 흐름을 설명했다. 기억하는지 모르겠지만, 돌아보면 Write > Plan > Apply이였다는 것을 확인할 수 있다. 앞에서 봤던 두 가지 명령은 terraform init과 terraform validate였다. 이번에는 terraform plan을 확인해보자.

terraform plan 명령은 테라폼으로 적용할 인프라의 변경 사항에 관한 실행 계획을 생성하는 동작이다. 또한 출력되는 결과를 확인하여 어떤 변경이 적용될지 사용자가 미리 검토하고 이해하는데 도움을 준다. 주로 plan 명령은 변경 사항을 실제로 적용하지는 않으므로 적용 전에 예상한 구성이 맞는지 검토하는데 주로 이용된다.

TIP
😆 plan을 사용하는 이유

테라폼 실행 이전의 상태와 비교해 현재 상태가 최신화되었는지 확인한다.

적용하고자 하는 구성을 현재 상태와 비교하고 변경점을 확인한다.

구성이 적용되는 경우 대상이 테라폼 구성에 어떻게 반영되는지 확인한다.

1
> terraform plan
2

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

6
Terraform will perform the following actions:
7

8
  # local_file.abc will be created
9
  + resource "local_file" "abc" {
10
      + content              = "abc!"
11
      + content_base64sha256 = (known after apply)
12
      + content_base64sha512 = (known after apply)
13
      + content_md5          = (known after apply)
14
      + content_sha1         = (known after apply)
15
      + content_sha256       = (known after apply)
16
      + content_sha512       = (known after apply)
17
      + directory_permission = "0777"
18
      + file_permission      = "0777"
19
      + filename             = "./abc.txt"
20
      + id                   = (known after apply)
21
    }
22

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

25
───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────
26

27
Note: You didn't use the -out option to save this plan, so Terraform can't guarantee to take exactly these actions if you run "terraform apply" now.

terraform plan”을 실행하면 처음 출력된 로그에서 심볼이 가진 의미를 설명해준다. 현재는 기존에 생성된 리소스가 없으므로 앞선 구성 파일 내용을 바탕으로 새로 생성해야 하기 때문에 + 기호만 나타난다.

여기서 팁이 있다면, 가끔 terraform plan -detailed-exitcode와 같이 detailed-exitcode를 붙이는 경우가 있다. 이때는 숫자로 된 결과를 반환하는데, 0: 변경 사항이 없는 성공, 1: 오류가 있음, 2: 변경 사항이 있는 성공으로 결과를 나눌 수 있다. 이 부분이 왜 필요하냐면, Github Actions와 같은 CI/CD를 사용할 때, 선행되어있는 .tf코드의 오류 유무에 따라서 CD 흐름에 영향을 줄 수 있기 때문이다. 예를 들면, if 조건을 사용해서 terraform plan -detailed-exitcode를 입력했을 때 2를 반환한다면 CD를 중단하는 로직을 구현할 수도 있다는 것이다.

4. 기본 실습 (4)

마지막으로 terraform apply는 계획을 기반으로 작업을 실행하는데 결과는 아래와 같다.

1
─ terraform apply
2

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

6
Terraform will perform the following actions:
7

8
  # local_file.abc will be created
9
  + resource "local_file" "abc" {
10
      + content              = "abc!"
11
      + content_base64sha256 = (known after apply)
12
      + content_base64sha512 = (known after apply)
13
      + content_md5          = (known after apply)
14
      + content_sha1         = (known after apply)
15
      + content_sha256       = (known after apply)
16
      + content_sha512       = (known after apply)
17
      + directory_permission = "0777"
18
      + file_permission      = "0777"
19
      + filename             = "./abc.txt"
20
      + id                   = (known after apply)
21
    }
22

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

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

29
  Enter a value: yes
30

31
local_file.abc: Creating...
32
local_file.abc: Creation complete after 0s [id=5678fb68a642f3c6c8004c1bdc21e7142087287b]
33

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

Enter a value: 부분에 yes를 입력하면 정상적으로 동작한다. terraform apply가 진행되면 아래와 같은 디렉토리 구조와 abc.txt 파일 안에, 우리가 작성한 abc!이 적어져있는 것을 확인할 수 있다.

1
> ls -ali
2
total 16
3
239526472 drwxr-xr-x. 3 pxxguin pxxguin  106 Jul 26 22:44 .
4
     5327 drwxr-xr-x. 7 pxxguin pxxguin  106 Jul 26 22:13 ..
5
239526476 -rwxr-xr-x. 1 pxxguin pxxguin    4 Jul 26 22:44 abc.txt
6
239526473 -rw-r--r--. 1 pxxguin pxxguin   92 Jul 26 22:33 main.tf
7
 84364313 drwxr-xr-x. 3 pxxguin pxxguin   23 Jul 26 22:19 .terraform
8
239526492 -rw-r--r--. 1 pxxguin pxxguin 1228 Jul 26 22:19 .terraform.lock.hcl
9
239526474 -rw-r--r--. 1 pxxguin pxxguin 1613 Jul 26 22:44 terraform.tfstate

5. 진짜 꿀팁이 있다면..

일반적으로 terraform plan과 terraform apply가 서로 이어지는 경우가 많은데, 이럴때는 plan을 저장하고, 저장된 계획을 apply에 적용시키면 더 정확히 동작하는 것을 확인할 수 있다.

1
> terraform plan -out=tfplan
2
> terraform apply tfplan
3
local_file.abc: Creating...
4
local_file.abc: Creation complete after 0s [id=5678fb68a642f3c6c8004c1bdc21e7142087287b]
5

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

🐤 Terraform의 새로운 규칙

1. Terraform에서의 멱등성

apply 기본 수행에서 plan 이후 변경 내용을 확인하고 적용하려는 동작을 확인했었다. Terraform은 선언적 구성 관리를 제공하는 언어로 멱등성을 갖고 이후에 추가로 설명될 상태를 관리하기 때문에 동일한 구성에 대해서는 다시 실행하거나 변경하는 작업을 수행하지 않는다. 따라서 변경 없는 구성에서는 plan 단계에서 변경 사항이 없기 대문에 출력되는 메시지 내용처럼 프로비저닝 동작이 추가로 발생하지 않는다.

2. 기존 main.tf에 resource를 추가한다면?

1
resource "local_file" "abc" {
2
    content = "abc!"
3
    filename = "${path.module}/abc.txt"
4
}
5

6
resource "local_file" "def" {
7
    content = "def!"
8
    filename = "${path.module}/def.txt"
9
}

위에 대해서 apply를 적용하면, 다음과 같은 결과를 확인할 수 있다.

1
local_file.abc: Refreshing state... [id=5678fb68a642f3c6c8004c1bdc21e7142087287b]
2
...생략...
3
Terraform will perform the following actions:
4

5
  # local_file.def will be created
6
  + resource "local_file" "def" {
7
      + content              = "def!"
8
      + content_base64sha256 = (known after apply)
9
      + content_base64sha512 = (known after apply)
10
      + content_md5          = (known after apply)
11
      + content_sha1         = (known after apply)
12
      + content_sha256       = (known after apply)
13
      + content_sha512       = (known after apply)
14
      + directory_permission = "0777"
15
      + file_permission      = "0777"
16
      + filename             = "./def.txt"
17
      + id                   = (known after apply)
18
    }
19

20
Plan: 1 to add, 0 to change, 0 to destroy.
21
...생략...
22
  Enter a value: yes
23

24
local_file.def: Creating...
25
local_file.def: Creation complete after 0s [id=15f946cb27f0730866cefea4f0923248d9366cb0]
26

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

이미 프로비저닝된 구성인 resource “local_file” “abc”{}에 대해서는 변경이 없지만 새로 추가된 리소스 resource “local_file” “def”{}에 대해서는 새로 생성하겠다는 실행 계획을 보여준다.

1
> tree
2
.
3
├── abc.txt
4
├── def.txt
5
├── main.tf
6
├── terraform.tfstate
7
├── terraform.tfstate.backup
8
└── tfplan

이전에 생성한 tfplan은 abc.txt만을 생성하는 구성이었다. 다시 apply 동작에 tfplan 파일을 적용해 실행해본다.

1
> terraform apply tfplan
2
╷
3
│ Error: Saved plan is stale
4
│
5
│ The given plan file can no longer be applied because the state was changed by another operation after the plan was created.
6
╵

tfplan이 생성된 이후에 변경이 발생했으므로 기존에 작성된 실행 계획은 더는 적용될 수 없다. 추가로 생성한 코드에 대해서 다시 계획을 생성한 이후에 apply를 적용하는게 대다수의 경우이다.

🍽 마무리

이후에는 좀 더 고도화된 terraform 구조를 알아본다.