King of Back-end

테라폼을 처음 시작하면 헷갈리는 명령어 옵션이 있습니다.
 
바로 terraform init 명령어의 -migrate-state 와 -reconfigure 죠.
 
보통 backend 구성을 변경하면 해당 옵션을 사용하라는 명령어를 볼 수 있습니다.
 
로그에서 -migrate-state 와 -reconfigure 에 대한 설명이 나와있지만 딱히 와닿지는 않습니다.
tfstate 의 방향성을 좌지우지 하는 옵션이기 때문에 잘못 썼다간 인프라가 꼬일 수도 있습니다.
 
예를 들어, 분명 변경(0 to change)하는 건데 새롭게(1 to add) 생성한다는 문구를 볼 수 있죠.
 
이런 경우는 보통 backend 구성을 변경하고, -reconfigure 를 사용했을 때 발생합니다.
 
예제여서 딱 하나의 state 만 존재하지만 실제 인프라 환경이라면 상당히 귀찮아지는 일이 발생할 수 있죠. (import block 같은..)
 
 
그럼 이제 각 옵션에 대해 알아보고, 언제 어떤 옵션을 사용하는지 알아보도록 하겠습니다!
 
렛츠두더코드~
 
 
-reconfigure
 
다시 한번 말씀드리면 아래와 같이 backend 구성을 변경하면 -migrate-state 와 -reconfigure 관련 로그를 볼 수 있습니다.
terraform {
  required_version = ">= 1.5.0"
  backend "local" {
    path = "./tfstates/random-pet.tfstate" #-- 이 값을 변경했을 경우 발생
  }
  required_providers {
    random = {
      source  = "hashicorp/random"
      version = "3.6.0"
    }
  }
}
terraform block 의 backend 구성을 바꾸면 아래와 같은 메시지를 볼 수 있습니다.
 
 
 
번역해보자면 "state(tfstate 파일) 에 대한 변경 없이 현재의 설정 값을 저장하고 싶으면 -reconfigure 를 사용해라" 입니다.
 
무슨 말인지 느낌은 오나 확실히 모르겠습니다.. (저만 그런 거일 수도 ㅜㅜ)
 
한번 실습으로 자세히 이해해보죠!
 
코드는 간단한 terraform block 과 random 모듈을 사용합니다. 
terraform {
  required_version = ">= 1.5.0"
  backend "local" {
    path = "./tfstates/random-pet.tfstate"
  }
  required_providers {
    random = {
      source  = "hashicorp/random"
      version = "3.6.0"
    }
  }
}
resource "random_pet" "server" {}
 
 
terraform init 을 통해 백엔드 구성과 모듈 등을 세팅해줍니다.
 
terraform init 을 진행하게 되면 .terraform/terraform.tfstate 에 백엔드와 모듈 관련된 정보를 담고 있는 파일이 생성됩니다.
파일 내용을 보면 backend 구성이 되어 있는데, 현재 ./tfstates/random-pet.tfstate 를 바라보고 있습니다.
{
    "version": 3,
    "serial": 1,
    "lineage": "ab7ad77f-6b5b-a79a-496e-7d244bc1085a",
    "backend": {
        "type": "local",
        "config": {
            "path": "./tfstates/random-pet.tfstate", #-- 여기
            "workspace_dir": null
        },
        "hash": 3115818295
    },
    "modules": [
        {
            "path": [
                "root"
            ],
            "outputs": {},
            "resources": {},
            "depends_on": []
        }
    ]
}
 
이후 백엔드 구성을 변경해보겠습니다.
terraform {
  required_version = ">= 1.5.0"
  backend "local" {
    path = "./tfstates/change-pet.tfstate" #-- 변경
  }
  required_providers {
    random = {
      source  = "hashicorp/random"
      version = "3.6.0"
    }
  }
}
resource "random_pet" "server" {}
 
기존 백엔드 구성을 변경했으므로 다음과 같은 문구가 나올 것이고, 해결하기 위해 -reconfigure 를 사용해줍니다.
 
하게 되면 백엔드 구성이 ./tfstates/change-pet.tfstate 로 변경된 것을 확인할 수 있습니다.
{
    "version": 3,
    "serial": 2,
    "lineage": "ab7ad77f-6b5b-a79a-496e-7d244bc1085a",
    "backend": {
        "type": "local",
        "config": {
            "path": "./tfstates/change-pet.tfstate", #-- 변경됨
            "workspace_dir": null
        },
        "hash": 1312397314
    },
    "modules": [
        {
            "path": [
                "root"
            ],
            "outputs": {},
            "resources": {},
            "depends_on": []
        }
    ]
}
 
그럼 이번엔 terraform apply 까지 진행해보겠습니다.
terraform {
  required_version = ">= 1.5.0"
  backend "local" {
    path = "./tfstates/random-pet.tfstate" #-- 원래 백엔드 구성
  }
  required_providers {
    random = {
      source  = "hashicorp/random"
      version = "3.6.0"
    }
  }
}
resource "random_pet" "server" {}
 
백엔드 구성에 명시한 경로에 state 를 담고 있는 tfstate 가 생성된 것을 확인할 수 있습니다.
 
이후 다시 변경해보고 terraform apply 를 진행하겠습니다.
terraform {
  required_version = ">= 1.5.0"
  backend "local" {
    path = "./tfstates/change-pet.tfstate"
  }
  required_providers {
    random = {
      source  = "hashicorp/random"
      version = "3.6.0"
    }
  }
}
resource "random_pet" "server" {}
 
terraform init, apply 둘 다 에러가 발생하는데, 바라보고 있는 tfstate 가 변경되서 그렇습니다.
 
.terraform/terraform.tfstate 에 명시되어 있는 백엔드 구성 경로에 변경된 change-pet.tfstate 가 없어서 그렇죠.
 
이때 -reconfigure 옵션을 통해 .terraform/terraform.tfstate 에 명시되어 있는 백엔드 구성 경로를 변경해서 변경된 tfstate 를 바라보게 합니다.
 
-reconfigure 를 사용해보면 문제 없이 잘 동작하는 것처럼 보입니다.
 
하지만 주의할 점이 있습니다. terraform apply 를 진행하게 되면, 새롭게 리소스를 생성한다는 문구가 나옵니다.
아까 분명 생성했는데... 왜 그럴까요?
 
이유는 간단합니다. 백엔드 구성 변경으로 인해 바라보고 있는 tfstate 파일이 변경되서 그렇습니다.
 
기존 리소스 상태(state) 를 가지고 있는 파일은 random-pet.tfstate 였는데, 백엔드 구성이 바뀌면서 더 이상 random-pet.tfstate 가 아닌 chagne-pet.tfstate 를 가르키게 된 것이고, 당연히 change-pet.tfstate 에는 아무런 정보가 없습니다.
 
terraform apply 를 통해 리소스를 생성한 적이 없기 때문이죠.
 
백엔드 구성을 다시 "./tfstates/random-pet.tfstate" 로 변경한 후 terraform init -reconfigure 를 진행하면 이전 리소스 상태를 유지할 수 있습니다.
 
정리해보면, -reconfigure 은 현재 백엔드 구성을 새롭게 재설정 합니다.
 
저는 보통 -reconfigure 옵션 같은 경우는 workspace 를 통해 dev 와 prod 를 구분하고, dev 는 AWS Dev Account S3 백엔드, prod 는 AWS Prod Account S3 백엔드를 사용했을 때 바라보는 백엔드 구성을 변경할 때 주로 사용합니다.
workspace 와 Multi S3 Backend with AWS Cross-Account 에 대해선 다음 글에서 다루도록 하겠습니다!
 
terraform 을 처음 사용했을 때 -reconfigure 옵션을 잘 알지 못하는 상태에서 사용했다가 리소스를 새롭게 생성한다는 문구가 떠서 많이 당황했던 적이 있었는데, 여러분을 그런 일이 없으시길 바랍니다!
 
 
-migrate-state
 
이번에 -migrate-state 입니다. 
 
번역해보자면 "state(tfstate 파일) 를 자동으로 이전하고 싶으면 -migrate-state 를 사용해라" 입니다.
-reconfigure 와 다르게 직관적이라고 봅니다. 이름 그대로 tfstate 를 이전할 때 사용합니다.
 
실습 코드는 아까와 동일합니다.
terraform {
  required_version = ">= 1.5.0"
  backend "local" {
    path = "./tfstates/random-pet.tfstate"
  }
  required_providers {
    random = {
      source  = "hashicorp/random"
      version = "3.6.0"
    }
  }
}
resource "random_pet" "server" {}
 
현재 테라폼 리소스를 tfstates/random-pet.tfstate 에 state(상태) 를 저장하고 있죠.
 
그치만 tfstates 디렉터리가 아닌, rocket 디렉터리로 변경하고 싶고 이참에 random-pet.tfstate 가 아닌 rocket.tfstate 로 파일 이름도 변경하고 싶습니다.
terraform {
  required_version = ">= 1.5.0"
  backend "local" {
    path = "./rocket/rocket.tfstate" #-- 변경
  }
  required_providers {
    random = {
      source  = "hashicorp/random"
      version = "3.6.0"
    }
  }
}
resource "random_pet" "server" {}
 
변경한 후, terraform init -migrate-state 를 사용하게 되면, 아래와 같은 문구가 나옵니다.
 
핵심은 "새로운 백엔드로 현재 state 를 복사하고 싶냐?" 입니다.
yes 를 해줍니다.
 
그럼 rocket/rocket.tfstate 에 기존 tfstates/random-pet.tfstate 가 복사된 것을 확인할 수 있습니다.
 
-reconfigure 때와 다르게 새로운 리소스가 생성되지 않습니다.
 
-migrate-state 같은 경우 비록 백엔드 구성이 변경되긴 했지만 변경과 동시에 기존 상태도 같이 복사(이전) 되었기 때문이죠!
 
저는 보통 state(상태)를 담고 있는 tfstate 의 이름은 변경하거나, workspace 를 사용하지 않았던 테라폼 리소스를 workspace 로 이전할 때 -migrate-state 를 사용합니다.
 
마찬가지로 workspace 와 Multi S3 Backend with AWS Cross-Account 글에서 다루긴 할 거지만, 맛보기 해보면 아래와 같이 진행됩니다.
# (backend 구성 변경하지 않고, 기존 그대로) 기존 디렉터리에서
$ terraform state pull > dev.tfstate
# 중요!!!!!! -> 진행하기 전에 백엔드 구성 바꿔주기
# init 을 통해 백엔드 바꿔주기
$ terraform init -backend-config=backend-configs/dev.hcl -migrate-state
# pull 한 tfstate 이름 변경 후 워크스페이스 생성
$ terraform workspace new -state="dev.tfstate" dev
# push 하기 
$ terraform state push dev.tfstate
# 확인하기
$ terraform state list
 
 
오늘은 terraform 을 처음 공부했을 때 헷갈렸던 부분 중 하나였던 -reconfigure 와 -migrate-state 에 대해 알아봤습니다!
잘못된 사용으로 인해 고생했던 기억이 있네요..
 
하지만 잘만 사용한다면 정말 유용하게 사용할 수 있는 옵션이라고 생각합니다. (Muli S3 Backend with AWS Cross-Account)
 
그럼 오늘은 여기까지!

[Terraform] -migrate-state vs. -reconfigure

댓글