[IaC] Terraform import를 활용한 openstack 리소스 tfstate 만들기

안녕하세요
오늘은 테라폼을 활용하여 테라폼이 아닌 방식으로 생성된 리소스도 tfstate 파일로 만들어주는 terraform import 기능을 정리해보겠습니다.
 

주절주절

이 기능을 찾기까지 험난한 여정을 펼친 내용을 주절거려보겠습니다.
인프라 리소스를 운영 및 관리하다 보면 과거에 생성된 레거시 리소스와 현재 생성된 리소스가 모두 공존하게 되더랍니다.
레거시란것은... 로컬에서 cli로 생성한 리소스나 호라이즌 콘솔에서 생성한 리소스 같은... 뭐 이것저것 등등이요

이 경우 현황 관리가 참 어렵더라구요 ...

 
그래서 테라폼 이전에 찍어낸 리소스를 어떻게 테라폼이 관리하게 만들 수 있지를 찾아보다가 GCP에서 만든 terraformer라는 방식도 테스트해보았습니다.
https://github.com/GoogleCloudPlatform/terraformer

GitHub - GoogleCloudPlatform/terraformer: CLI tool to generate terraform files from existing infrastructure (reverse Terraform).

 
테라포머의 경우 오픈스택 컴퓨트, 블록스토리지, 네트워킹 3가지 리소스를 변환하는 것을 지원한다고 나와있지만 컴퓨트의 경우 변환이 안됩니다! (panic error를 마주침)
aws로 쓰시는 분들은 잘 될 것 같네요 아마.. 따흐흑
 
고민을 계속하다 terraform에서 import라는 기능을 제공한다는 문서를 읽었습니다.
https://developer.hashicorp.com/terraform/cli/import

Import | Terraform | HashiCorp Developer

 

하지만 곧 난관에 도착합니다.

왜 오픈스택은 terraform import를 아무도 안썼을까요...

 
네 아무튼 사용 방법을 찾아내어 저와 같은 고민을 하시는 분들께 도움이 되면 좋을 것 같아 요리조리 정리해보았습니다.
 

Terraform import가 무엇을 하느냐

 
terraform import는 기존의 인프라 리소스를 Terraform 상태 파일로 가져오는 명령어입니다.
이 기능을 사용하면 이미 프로비저닝된 인프라를 Terraform으로 관리할 수 있게 되는데요 기존 인프라 리소스를 새로 만들지 않고, 현재 상태를 Terraform의 상태 파일(terraform.tfstate)에 기록하여 Terraform이 그 리소스를 관리할 수 있도록 합니다.

Terraform Import의 주요 기능

1. 기존 리소스를 Terraform 상태에 추가: 이미 프로비저닝된 인프라를 건들지 않습니다. Terraform 상태 파일에 해당 리소스를 추가합니다. 이를 통해 기존 리소스가 Terraform 코드로 관리될 수 있도록 합니다.
2. 리소스를 파괴하지 않고 관리 가능: terraform import는 리소스를 파괴하거나 다시 프로비저닝하지 않습니다.(휴) 이미 존재하는 리소스를 Terraform의 관리 하에 두기만 합니다. 이후 terraform plan과 terraform apply를 통해 Terraform이 리소스 상태와 코드 간의 차이를 관리하게 됩니다.
3. 여러 리소스 지원: 저는 오픈스택에 사용하였지만 AWS, Azure, GCP, ncloud 등 여러 클라우드에도 사용이 가능하다고 합니다.

설치

Terraform 1.9.7
terraform import 기능은 테라폼 1.5.0 이상부터 지원합니다. 저는 가장 최신 버전으로 겟했습니다.

wget -O- https://apt.releases.hashicorp.com/gpg | sudo gpg --dearmor -o /usr/share/keyrings/hashicorp-archive-keyring.gpg
  
echo "deb [signed-by=/usr/share/keyrings/hashicorp-archive-keyring.gpg] https://apt.releases.hashicorp.com $(lsb_release -cs) main" | sudo tee /etc/apt/sources.list.d/hashicorp.list
  
sudo apt update && sudo apt install terraform

 
openstack terraform provider v3.0.0
프로바이더는 일주일 전에 최신 버전이 나와서 뜨끈뜨끈해서 겟했습니다.

wget https://github.com/terraform-provider-openstack/terraform-provider-openstack/releases/download/v3.0.0/terraform-provider-openstack_3.0.0_linux_amd64.zip

unzip terraform-provider-openstack_3.0.0_linux_amd64.zip

 

terraform import 파일 구조

파일 구조의 경우 저는 설정 파일, 리소스 파일로 구분했습니다. 리소스의 경우 추후 상황에 맞게 환경별로 논리적으로 나누어 쓰시면 좋을 것 같다고 생각합니다.
 
📁 테라폼 폴더
  ㄴ provider.tf     # 클라우드 설정 제공 파일
  ㄴ resource.tf    # 인스턴스 리소스 정의 파일
 

# provider.tf
terraform {
  required_providers {
    openstack = {
      source = "terraform-provider-openstack/openstack"
      version = ">=3.0.0"
    }
  }
}
 
provider "openstack" {
  auth_url = "http://[openstack controller ip]:5000/v3"
  region = "RegionOne"
  domain_name = "Default"
  user_name = "[user account]"
  password = "[user password]"
  tenant_name = "[project name]"
}

 

# resource.tf

resource "openstack_compute_instance_v2" "test" {}
 
resource "openstack_compute_instance_v2" "test2" {}

 
파일이 다 구성되었다면 이후 아래 단계를 진행합니다.

terraform init

terraform import openstack_compute_instance_v2.test <instance id>

terraform import openstack_compute_instance_v2.test2 <instance id>

 
이후 tfstate 파일로 예쁘게 잘 만들어진 파일을 확인할 수 있습니다.