YAML 도입 배경 및 특징
기존 JSON 형식은 데이터 직렬화에 유용하지만 주석 지원 부재 및 엄격한 구문 규칙으로 인해 설정 파일 작성 시 불편함이 있습니다. 특히 DevOps 환경에서 복잡한 구조를 다룰 때 가독성이 중요한데, YAML 은 이러한 문제를 해결하기 위해 설계되었습니다.
YAML(YAML Ain't Markup Language) 는 JSON 의 슈퍼셋으로 간주되며, Travis CI, Circle CI, AWS CloudFormation 등 다양한 도구에서 채택하고 있습니다. 주석 처리, 다중 행 문자열, 참조 기능 등을 제공하여 중복 코드를 줄이고 유지보수성을 높입니다.
기본 구문 규칙
YAML 파일은 일반적으로 --- 로 시작하여 문서의 시작을 알립니다. 주요 규칙은 다음과 같습니다.
- 대소문자를 구분합니다.
- 들여쓰기로 계층 구조를 표현합니다.
- 탭 (Tab) 을 사용할 수 없으며 공백 (Space) 만 허용됩니다.
- 들여쓰기 공백 수는 중요하지 않으나, 동일 계층은 왼쪽 정렬되어야 합니다.
#기호 이후부터 행 끝까지 주석으로 처리됩니다.
데이터 구조 종류
YAML 은 크게 세 가지 구조를 지원합니다.
- 매핑 (Mapping): 키와 값의 쌍 (Object/Dictionary)
- 시퀀스 (Sequence): 순서가 있는 값의 목록 (Array/List)
- 스칼라 (Scalar): 분할 불가능한 단일 값 (문자열, 숫자 등)
매핑 (Object) 표현
키와 값은 콜론 (:) 으로 구분하며, 콜론 뒤에 공백이 필수입니다.
---
# 서비스 엔드포인트 정의
api_endpoint: https://api.gateway.kr
이는 JavaScript 객체로 변환 시 다음과 같습니다.
{ api_endpoint: 'https://api.gateway.kr' }
중첩된 구조는 인라인 형태로도 작성 가능합니다.
---
server_node: { address: 192.168.0.1, port: 8080 }
변환 결과:
{ server_node: { address: '192.168.0.1', port: 8080 } }
시퀀스 (Array) 표현
목록 항목은 하이픈과 공백 (- ) 으로 시작하며 동일한 들여쓰기를 유지합니다.
---
allowed_cidr:
# 허용된 IP 목록
- 10.0.0.1
- 10.0.0.2
- 10.0.0.3
JavaScript 배열 변환:
allowed_cidr: [ '10.0.0.1', '10.0.0.2', '10.0.0.3' ]
하위 요소가 배열인 경우 추가 들여쓰기를 사용합니다.
-
- input_stream
- output_stream
- middleware
변환 결과:
[ [ 'input_stream', 'output_stream', 'middleware' ] ]
인라인 배열 구문도 지원합니다.
protocols: [HTTP, HTTPS]
organizations: [{id: 101,name: org_alpha,budget: 500M},{id: 102,name: org_beta,budget: 1B}]
변환 결과:
{ protocols: [ 'HTTP', 'HTTPS' ] }
{ organizations:
[ { id: 101, name: 'org_alpha', budget: '500M' },
{ id: 102, name: 'org_beta', budget: '1B' } ] }
복합 데이터 구조
매핑과 시퀀스를 혼합하여 사용할 수 있습니다.
runtime_env:
- NodeJS
- Go
- Rust
portals:
YAML: yaml.org
Go: golang.org
Rust: rust-lang.org
변환 결과:
{ runtime_env: [ 'NodeJS', 'Go', 'Rust' ],
portals: { YAML: 'yaml.org', Go: 'golang.org', Rust: 'rust-lang.org' } }
스칼라 데이터 타입
상수 값에는 문자열, 불리언, 숫자, null, 날짜 등이 포함됩니다.
flags:
- TRUE #true, True 모두 가능
- FALSE #false, False 모두 가능
metrics:
- 2.718
- 1.6180339e+2 #과학적 표기법 지원
counts:
- 42
- 0b1100_1010_0001_1111 #2 진수 표현
empty_value:
serviceName: 'svc_core'
owner: ~ #~ 는 null 을 의미
messages:
- 안녕하세요
- 'Special chars!' #특수 문자는 따옴표로 감쌈
- line break
continued #여러 행은 공백으로 연결됨
schedule:
- 2023-05-20 #ISO 8601 날짜 형식
timestamp:
- 2023-05-20T10:30:00+09:00 #ISO 8601 시간 형식, T 구분자 및 시간대
변환 결과:
{ flags: [ true, false ],
metrics: [ 2.718, 161.80339 ],
counts: [ 42, 51743 ],
empty_value: { serviceName: 'svc_core', owner: null },
messages: [ '안녕하세요', 'Special chars!', 'line break continued' ],
schedule: [ Sat May 20 2023 00:00:00 GMT+0900 ],
timestamp: [ Sat May 20 2023 10:30:00 GMT+0900 ] }
고급 구문 및 특수 기호
1. 타입 강제 변환: !! 를 사용하여 데이터 타입을 명시합니다.
code: !!str 500
status: !!str active
변환 결과:
{ code: '500', status: 'active' }
2. 문서 종료: ... 는 --- 와 함께 사용하여 문서 끝을 알립니다.
---
timestamp: 14:20:10
agent: Agent Smith
event: protocol breach
...
---
timestamp: 14:25:30
agent: Agent Smith
event: system reset
...
3. 문자열 블록: | 는 줄바꿈을 유지하고, > 는 줄바꿈을 공백으로 접습니다.
log_data: |
Error Line 1
Error Line 2
summary: >
Warning Line 1
Warning Line 2
변환 결과:
{ log_data: 'Error Line 1\nError Line 2\n', summary: 'Warning Line 1 Warning Line 2\n' }
4. 앵커 및 별칭: & 로 앵커를 정의하고 * 로 참조하여 중복을 방지합니다.
global_settings: &base_profile
driver: mysql
endpoint: 127.0.0.1
stage:
schema: app_stage
<<: *base_profile
prod:
schema: app_prod
<<: *base_profile
변환 결과:
{ global_settings: { driver: 'mysql', endpoint: '127.0.0.1' },
stage:
{ schema: 'app_stage',
driver: 'mysql',
endpoint: '127.0.0.1' },
prod:
{ schema: 'app_prod',
driver: 'mysql',
endpoint: '127.0.0.1' } }
앵커는 단독으로 정의될 수 없으며 (&Name Value 형태 불가), 복잡한 구조에도 적용 가능합니다.
main_list: &default_items
- Item A
- Item B
copy_list: *default_items
이 경우 copy_list 는 main_list 의 배열 내용을 참조하게 됩니다.