Visual Studio Code를 활용하여 Kubernetes Yaml 파일을 오류 없이 작성해 보자

Kubernetes 환경의 Deployment, Replicaset, ConfigMap 등의 리소스를 생성하기 위해 Yaml 파일을 작성하는데 띄어쓰기에 의해서 문법을 검사하다 보니 띄어쓰기 하나로 에러가 발생하는 경우가 종종 생긴다.

 

Yaml 파일을 작성하면서 이러한 오류를 사전에 검증할 수 있도록 Visual Studio Code에서는 Yaml에 대한 확장 플러그인을 제공한다. 이 플러그인을 활용하면 작성 과정에서 어느 부분에 오류가 나는지를 확인할 수 있어 유용하다.

 

YAML 플러그인 설치하기

Visual Studio Code를 실행하고 좌측의 확장 메뉴를 클릭하여 상단 검색 창에 yaml을 입력하면 제일 첫 번째로 나오는 플러그인을 설치한다.

yaml 확장 플러그인을 선택하여 설치한다.

 

YAML 플러그인 설정하기

설치가 완료되면 플러그인 옆 우측 하단의 톱니바퀴를 클릭하여 서브 메뉴가 나오면 아래의 확장 설정을 클릭한다.

YAML 플러그인을 설정한다.

 

그럼 우측 편집창에 YAML 플러그인을 설정할 수 있는 설정 값 들이 나오는데 조금 내리면 Schemas 항목이 있는데 그 아래 Settings.json에서 편집을 클릭한다.

Settings.json에 설정을 입력한다.

 

그럼 아래처럼 편집창에 Settings.json 파일을 불러온다. 여기에 yaml.schemas 항목이 추가되어 있고 내용은 비어 있다. 

settings.json의 yaml.schemas 설정 부분

 

비어 있는 큰 괄호 안에 아래처럼 "Kubernetes":"*.yaml"을 입력하고 저장한다. 이제 설정은 완료되었으니 Visual Studio Code를 종료했다가 다시 시작하면 YAML 파일을 인식하게 된다.

설정값을 입력한다.

 

오류 있는 YAML 테스트

아래는 띄어쓰기가 잘 못 되어 있어서 오류가 나는 예이다. 단순히 띄어쓰기 오류로 인해 배포할 수 없는 상황이 생기는데 Visual Studio Code의 플러그인을 활용하면 오류를 사전에 막을 수 있다.

오류가 있는 부분을 표시해 주는 고마운 플러그인