HCP Terraform - 워크스페이스(Workspace) 생성

개요

본문에서는 Version Control Provider 중 깃헙(Github)을 사용하여 워크스페이스(Workspace)를 생성하는 절차 및 방법에 대해 정리하였습니다.

 

HCP Terraform에서 워크스페이스(Workspace)는 Terraform에서 관리하는 인프라 리소스 그룹의 단위로, 프로젝트(Project) 내에서 독립적인 리소스 상태 유지를 목적으로 사용합니다.

Workspace 별로 리소스의 상태(State) 파일이 생성되기 때문에 독립적인 리소스 상태 유지가 가능합니다.

---

 

 

1. Github 리포지토리(Repository) 생성

Github 리포지토리를 생성합니다.이때, 프라이빗(Private)으로 반드시 설정해야 할 필요는 없습니다.

 

README.md 와 같이 리포지토리에 임의의 파일을 생성하고, 기본 브랜치(Branch)를 설정합니다.

리포지토리 내부에 파일이 존재하지 않거나, 브랜치 유형의 VCS Trigger 타입을 사용할 때 브랜치가 존재하지 않을 경우에는 워크스페이스 생성 시 에러가 발생할 수 있습니다.

 

 

2. 워크스페이스 생성 페이지 이동 및 Project 선택

Workspaces → New → Workspace 를 클릭합니다.

 

그리고, 워크스페이스가 위치할 Project를 선택합니다.

 

 

3. Workflow 및 VCS 선택

Github 리포지토리의 변경 사항에 따라 트리거(Trigger) 되는 형태로 구성할 예정이므로 "Version Control Workflow"를 선택합니다.

이외에 Terraform CLI 또는 API 를 이용하여 트리거 할 수 있습니다.

 

VCS로 "Github.com" 을 선택합니다.

 

 

4. Github 인가(Authorization) 및 워크스페이스 리포지토리 선택

Terraform Cloud에서 깃헙(Github) 접근과 설치 및 리포지토리 권한 부여를 위한 작업입니다.

 

앞선 작업에서 워크스페이스 용도로 사용될 깃헙 리포지토리를 선택하여 리포지토리 접근 권한을 부여합니다.

 

접근 권한이 부여된 워크스페이스 용도로 사용될 깃헙 리포지토리를 선택합니다.

 

 

5. 워크스페이스 설정

워크스페이스 이름과 설명 그리고, 필요한 경우 태그를 설정합니다.

 

워크스페이스 생성 단계에서 상세 설정도 가능합니다.

아래와 같이 작업 디렉토리 경로 지정, 트리거 발생 시 Auto-Apply, VCS 트리거 유형 지정이 가능합니다. 필자의 경우에는 협업 용도가 아니므로 VCS 트리거 유형만 브랜치 방식으로 설정하였습니다.

 

그리고, 브랜치 main 로 지정하였으며, Pull Requests 발생 시에는 Auto-Plan 이 발생하도록 하였습니다.

 

 

6. 워크스페이스 생성 확인

생성된 워크스페이스를 확인합니다. 생성 확인 단계에서 Terraform 변수 설정이나 Plan을 진행할 수 있습니다.

 

워크스페이스의 경우, ws-로 시작하는 ID 를 확인할 수 있습니다.

 

 

7. 기타 정보 확인

VCS Provider 연결을 통해 Terraform Cloud 계정 설정 부분의 Tokens 페이지에서는 깃헙 OAuth Token을 확인할 수 있습니다.

 

반대로 깃헙(Github)에서는 계정 설정 부분의 Applications 영역에서 인가(허가) 및 설치된 Terraform Cloud를 확인할 수 있습니다.

 

 

만약 워크스페이스 추가가 필요할 경우에는 아래와 같이 계정 설정 부분의 Applications 영역 → Installed Github Apps → Terraform Cloud Confugure 을 클릭하고, 워크스페이스 리포지토리를 추가합니다.

 

 

 

참고

HCP Terraform workspaces | Terraform | HashiCorp Developer

Manage workspace state in HCP Terraform | Terraform | HashiCorp Developer