Consul Template 개요

이 주제에서는 Consul KV 스토어를 포함한 다양한 위치에서 설정 파일을 프로그래밍 방식으로 렌더링할 수 있게 해주는 Consul Template 도구를 소개해요. 복잡한 API 쿼리를 대체하는 효과적인 워크플로우 옵션이랍니다.

출처: 문서

본문

이 주제에서는 Consul KV 스토어를 포함한 다양한 위치에서 설정 파일을 렌더링하는 프로그래밍 방식의 방법을 제공하는 Consul Template 도구에 대한 개요를 설명합니다. 종종 사용자 지정 포맷이 필요한 복잡한 API 쿼리를 대체하는 효과적인 워크플로우 옵션입니다.

KV 스토어와 이를 사용해 애플리케이션 배포를 자동 구성하는 방법에 대한 자세한 내용은 Consul key/value (KV) store 개요를 참조하세요.

소개 (Introduction)

Consul Template 도구는 Consul 바이너리의 일부가 아닙니다. 전용 GitHub 리포지토리가 있으며, 명령줄에서 실행하기 전에 Consul Template을 설치해야 합니다.

Consul 템플릿은 Go 템플릿을 기반으로 하며 많은 속성을 공유합니다. 시작되면 Consul Template은 하나 이상의 템플릿 파일을 읽고 Consul에 데이터를 쿼리하여 전체 구성을 렌더링합니다.

일반적인 시나리오에서는 Consul Template을 데몬으로 실행하여 초기 값을 가져온 다음 계속해서 업데이트를 감시합니다. 데이터센터에 관련 변경이 있을 때마다 템플릿이 다시 렌더링됩니다. 템플릿은 업데이트 프로세스가 완료된 후 임의의 명령을 실행할 수도 있습니다. 예를 들어 설정 변경 후 로드 밸런서 서비스에 HUP 신호를 보낼 수 있습니다.

Consul Template 도구는 유연하여 다양한 환경과 워크플로우에 맞출 수 있습니다. 사용 사례에 따라 소수의 호스트에 단일 Consul Template 인스턴스를 두거나, 모든 호스트에 여러 인스턴스를 실행해야 할 수도 있습니다. 각 Consul Template 프로세스는 여러 개의 관련 없는 파일을 관리할 수 있으며, 파일이 데이터 종속성을 공유할 때 필요에 따라 중복 정보를 제거합니다.

Consul Template은 다음 상황에서 사용하세요.

설정 파일 업데이트. Consul Template 도구는 서비스 설정 파일을 업데이트하는 데 사용할 수 있습니다. 일반적인 사용 사례는 동적 인프라에서 정기적으로 업데이트해야 하는 로드 밸런서 설정 파일을 관리하는 것입니다.
구성 시크릿 업데이트. Consul Template이 Vault 시크릿 엔진을 사용하여 암호화 키, TLS 인증서, 비밀번호를 포함한 애플리케이션 구성용 시크릿을 생성하도록 구성할 수 있습니다. Consul Template은 이러한 시크릿을 파일이나 환경 변수로 렌더링하여 애플리케이션이 안전하게 사용하도록 합니다.
Consul 데이터센터 및 서비스에 대한 데이터 발견. Consul 데이터센터의 서비스에 대한 정보를 수집할 수 있습니다. 예를 들어 데이터센터에서 실행되는 모든 서비스 목록을 수집하거나 Redis 서비스의 모든 서비스 주소를 발견할 수 있습니다. 이 사용 사례는 프로덕션에서 범위가 제한적이라는 점에 유의하세요.

워크플로우 (Workflow)

데이터센터에 Consul Template을 추가하는 일반적인 워크플로우는 다음 단계로 구성됩니다.

데이터센터의 노드에 Consul Template 설치.
데이터센터의 노드에서 Consul Template 구성.
검색해야 하는 데이터에 대한 템플릿 생성. 복잡성 순서에 따라 다양한 옵션이 있습니다.
- contents 매개변수를 사용한 인라인 템플릿으로 간단한 요청 처리.
- 사용 가능한 함수를 사용한 템플릿 파일 생성.
- 사용자 지정 플러그인 정의로 사용자 지정 데이터 조작 실행.
템플릿 렌더링 후 데이터센터에 적용.
실행을 모니터링하고 문제를 디버깅하려면 Consul Template 로그 보기.

사용 사례: Consul KV

이 예시에서는 Consul KV에서 HashiCorp 주소를 가져오는 템플릿을 렌더링합니다. 이를 위해 HashiCorp 주소가 포함된 템플릿을 만들고 consul-template 명령을 실행하고 HashiCorp 주소에 대한 값을 Consul KV에 추가한 다음 마지막으로 렌더링된 파일을 확인합니다.

먼저 Consul의 KV 스토어를 쿼리하는 템플릿 파일 find_address.tpl을 만듭니다.

find_address.tpl

{{ key "/hashicorp/street_address" }}

다음으로 사용할 템플릿과 업데이트할 파일을 모두 지정하여 consul-template을 실행합니다.

$ consul-template -template "find_address.tpl:hashicorp_address.txt"

consul-template 프로세스는 CTRL+C로 종료할 때까지 계속 실행됩니다. 지금은 실행을 유지하세요.

마지막으로 새 터미널을 열어 명령줄 인터페이스를 사용해 Consul의 KV 스토어에 데이터를 씁니다.

$ consul kv put hashicorp/street_address "101 2nd St"

Success! Data written to: hashicorp/street_address

hashicorp_address.txt 파일을 확인하여 데이터가 기록되었는지 검증합니다. 이 파일은 Consul Template이 실행 중인 동일한 디렉터리에 있습니다.

$ cat hashicorp_address.txt

101 2nd St

hashicorp/street_address 키를 업데이트하면 파일의 변경 사항을 즉시 관찰할 수 있습니다.

Consul의 키 내용을 변경하여 프로세스를 관찰하세요.

$ consul kv put hashicorp/street_address "22b Baker ST"

Success! Data written to: hashicorp/street_address

새 값이 기록되었는지 hashicorp_address.txt 파일을 확인합니다.

$ cat hashicorp_address.txt

22b Baker ST

이제 CTRL+c로 consul-template 프로세스를 종료할 수 있습니다.

사용 사례: 모든 서비스 찾기 (discover all services)

이 예시에서는 Consul Template을 사용하여 Consul 데이터센터에서 실행 중인 모든 서비스를 검색합니다.

먼저 모든 서비스를 쿼리하는 새 템플릿 all-services.tpl을 만듭니다.

all-services.tpl

{{ range services -}}
# {{ .Name }}
{{- range service .Name }}
{{ .Address }}
{{- end }}

{{ end -}}

다음으로 방금 만든 템플릿과 -once 플래그를 지정하여 Consul Template을 실행합니다. -once 플래그는 프로세스가 한 번 실행된 후 종료하도록 지시합니다.

$ consul-template -template="all-services.tpl:all-services.txt" -once

로컬 개발 에이전트로 이 명령을 완료하면 all-services.txt를 볼 때 답변에 기본 consul 서비스만 포함됩니다.

# consul
127.0.0.1

개발 또는 프로덕션 데이터센터에서는 모든 서비스 목록을 얻을 수 있습니다.

예를 들어:

# consul
104.131.121.232

# redis
104.131.86.92
104.131.109.224
104.131.59.59

# web
104.131.86.92
104.131.109.224
104.131.59.59

프로덕션 시나리오 (Production scenarios)

앞의 예시는 Consul Template을 사용하여 Consul KV 스토어 또는 Consul 카탈로그의 데이터로 파일을 동적으로 렌더링하는 방법을 보여줍니다.

이 프로세스를 확장하여 복잡한 구성을 실현할 수 있습니다.

예를 들어 Consul Template을 사용하여 NGINX 리버스 프록시 구성을 자동화할 수 있습니다. 이 프로세스는 업스트림 IP의 소스로 Consul 카탈로그를 사용합니다.

또한 Vault를 시크릿 관리로 사용하여 Consul Template으로 Consul 운영을 자동화할 수도 있습니다. 예를 들어 다음을 수행할 수 있습니다.

추가 Consul Template 예시는 consul-template GitHub 리포지토리의 examples 폴더를 참조하세요.

템플릿에서 사용 가능한 함수를 살펴보려면 Consul Template Go 언어 참조를 참조하세요.

Consul Template 개요