카카오클라우드 기술문서 레퍼런스 메뉴 개편 안내
코드로 클라우드 리소스를 다룰 때는 리소스 개념뿐 아니라 호출할 엔드포인트, 요청 호스트, 인증 정보와 파라미터까지 확인해야 합니다. Terraform을 사용한다면 Provider의 리소스와 데이터 소스, 인수와 예제도 찾아야 합니다.
카카오클라우드는 이러한 개발 흐름에 맞춰 기술문서의 레퍼런스 메뉴와 문서 탐색 구조를 개편했습니다. API 명세와 사용 가이드, Terraform Provider 문서와 튜토리얼 등 개발에 필요한 다양한 정보를 한곳에서 탐색할 수 있도록 구성했습니다.
API와 Terraform 문서를 한곳에서
이번에 새로 구성된 레퍼런스 메뉴에서는 서로 다른 경로에서 확인해야 했던 카카오클라우드 API와 Terraform 관련 문서를 한곳에서 확인하고 탐색할 수 있습니다. 기존 API 문서 중심의 메뉴를 확장해 각 문서의 시작점과 상세 가이드, 튜토리얼까지 연계했습니다. API 문서의 메뉴 명칭은 기존 OpenAPI에서 API로 변경했습니다.
새로 구성한 레퍼런스 메뉴
서비스별 API에서 엔드포인트 중심 API로
기존 API 문서는 서비스를 기준으로 카테고리를 나누고, 서비스별로 API를 찾아가는 방식이었습니다. 이번 개편에서는 실제 API 호출 호스트인 엔드포인트를 기준으로 API를 묶어 같은 엔드포인트에서 제공하는 API 명세를 한 흐름으로 탐색할 수 있도록 구조를 변경했습니다.
사이드바에서는 엔드포인트별 API를 펼쳐 볼 수 있는 상세 탐색 영역과 API 검색창을 함께 제공합니다. 인스턴스나 volume처럼 국문 또는 영문으로 API 이름과 리소스 이름을 검색하면 관련 문서로 바로 이동할 수 있습니다.
레퍼런스 메뉴의 API 검색창 사용
전체 API 구성이나 엔드포인트별 주요 작업을 먼저 확인하고 싶다면 API 인덱스를 참고하세요. API 인덱스에서는 기본 URL 구성 방법과 작업에 따른 호출 엔드포인트를 확인할 수 있습니다. 예를 들어 인스턴스 상태 변경은 bcs 엔드포인트에서, 볼륨이나 스냅샷 관리는 volume 엔드포인트에서 확인하면 됩니다.
API를 운영 스크립트나 배포 파이프라인에서 사용한다면 API 변경 사항도 함께 확인해야 합니다. API의 추가, 변경, 지원 종료 내역을 정기적으로 점검하면 연동 과정의 호환성 문제를 사전에 확인할 수 있습니다.
Terraform Provider 문서부터 튜토리얼까지
KakaoCloud Terraform Provider 공식 문서는 기존과 같이 리소스와 데이터 소스별 인수, 버전별 설정, 사용 예제를 확인하는 기준 문서입니다. 이번 개편에서는 여기에 카카오클라우드 기술문서의 Terraform 사용 가이드와 튜토리얼을 연결해, Provider 문서를 확인하는 단계에서 실제 환경을 구성하고 실행하는 단계까지 이어지도록 했습니다.
Terraform의 기본 개념과 인증, 실행 흐름은 Terraform 사용 가이드에서 확인할 수 있습니다. 리소스와 데이터 소스별 인수와 예제는 KakaoCloud Terraform Provider 공식 문서에서, Provider의 구현과 변경 사항은 소스 코드 저장소에서 확인할 수 있습니다.
KakaoCloud Terraform Provider
최근에는 Terraform을 처음 사용하는 개발자가 기본 명령과 리소스 변경 흐름을 익힐 수 있도록 튜토리얼도 추가했습니다. Terraform으로 VM 프로비저닝 및 변경에서는 기존 서브넷을 활용해 VM을 생성하고, terraform plan과 terraform apply로 변경·삭제하는 기본 흐름을 실습합니다.
기본 흐름을 익혔다면 Terraform으로 MySQL 기반 3-Tier 웹 서비스 구축을 진행해 보세요. VPC, 웹·애플리케이션 서버, 로드 밸런서와 MySQL을 구성하고, 여러 리소스가 연결된 웹 서비스의 배포 결과까지 확인할 수 있습니다.
마치며
API 연동을 시작한다면 API 사용 가이드에서 인증과 요청 구성을 확인한 뒤, API 인덱스에서 필요한 엔드포인트를 찾아보세요. Terraform으로 인프라를 구성한다면 Terraform 사용 가이드에서 기본 흐름을 익히고, 튜토리얼을 따라 실제 환경을 구성해 볼 수 있습니다.
카카오클라우드는 앞으로도 개발자가 문서를 찾고 이해한 내용을 실제 구현으로 이어 갈 수 있도록 개발자 레퍼런스를 계속 개선하겠습니다.
관련하여 궁금하신 점이나 지원이 필요한 경우 언제든지 헬프데스크를 통해 문의해 주시기 바랍니다.
감사합니다.