[Ansible] Jinja2와 Ansible 문법에서의 >-와 \

Ansible을 사용하면서 줄바꿈을 처리 방식에서 갑자기 오류가 나 이를 해결하며 알게된 것들을 정리했다.

 

에러 & 원인

잘 동작하던 Ansible 코드에 갑자기 이런 오류가 떴다. 

코드가 변경된 것은 없고 VSC 내에서 YAML Extension을 설치한 게 전부였는데 ..
setting.json에서 YAML Extension과 관련된 설정을 확인했는데 유효성 검사가 true로 되어있었다.

해당 설정을 true로 해놓으면 YAML 파일의 구조와 구문을 검사하여 오류를 찾아준다. 나의 경우처럼 Jinja2 템플릿이 포함된 YAML 파일에서, 이를 표준 구문으로 인식하지 못하고 오류를 표시할 수 있다.
개인적으로 이렇게 규칙이 빡빡한걸 선호하기 때문에 true로 설정해놓고 개발하기로 결정 ..

 

>- 와 \ 차이

YAML에서 >- 는 줄바꿈을 없애고 텍스트를 논리적으로 한 줄로 이어주는 역할을 한다. (|-도 마찬가지)
줄바꿈은 제거되지만 각 줄 사이에 공백이 추가된다는 특징이 있다.

example: >-
  This is line 1
  This is line 2
  This is line 3

위와 같은 코드를 출력해본다면 각 줄 사이에 아래와 같이 공백이 들어간다.

This is line 1 This is line 2 This is line 3

 

백슬래시(\)는 YAML 문법에서 줄바꿈을 위해 사용되지 않는다. 그러나 Ansible과 Jinja2를 사용하는 경우 \는 Jinja2 표현식 내부에서만 사용된다. Jinja2에서 백슬래시는 줄바꿈 연속 기호로 해석되기 때문이다.

host_info: "{{ host_info | default({}) | combine({ \
  'id': item.id, \
  'name': item.name \
}) }}"

 

YAML Extension을 사용하는 경우 YAML 파서는 이를 인지하지 못하고 오류를 뱉어내기 때문에, >- 를 활용하는 것으로 코드를 변경했다.