Consul-Terraform-Sync
Consul-Terraform-Sync (CTS) CLI
Consul-Terraform-Sync(CTS)는 사용하기 쉬운 명령줄 인터페이스(CLI)로 제어돼요. CTS는 consul-terraform-sync라는 단일 명령줄 애플리케이션뿐이에요. 데몬으로 실행해 CLI 명령을 실행할 수도 있어요.
출처: 문서
본문
Consul-Terraform-Sync(CTS)는 사용하기 쉬운 명령줄 인터페이스(CLI)로 제어됩니다. CTS는 consul-terraform-sync라는 단일 명령줄 애플리케이션뿐입니다. CTS는 데몬으로 실행되고 CLI 명령을 실행할 수 있습니다. CTS를 데몬으로 실행하면 CLI 명령에 대한 서버 역할을 합니다. 사용자는 명령을 사용해 실행 중인 데몬과 상호작용하고 수정할 수 있습니다. 명령의 전체 목록은 왼쪽 탐색에 있습니다. 데몬과 명령 모두 오류가 발생하면 0이 아닌 종료 상태를 반환합니다.
데몬 (Daemon)
참고
명령 없이 CTS를 데몬으로 실행하는 것은 CTS 0.6.0에서 더 이상 사용되지 않으며(deprecated) 훨씬 나중의 메이저 릴리스에서 제거될 예정입니다. CTS를 데몬으로 실행하는 권장 방법에 대한 정보는 start command docs를 검토하세요.
CTS가 데몬으로 실행될 때 CTS를 시작할 기본 구성은 없습니다. -config-file 또는 -config-dir 구성 플래그를 설정해야 합니다. 예:
$ consul-terraform-sync start -config-file=config.hcl
사용 가능한 플래그 목록을 검토하려면 -help 또는 -h 플래그를 사용하세요.
명령 (Commands)
데몬 실행 외에도 CTS에는 데몬 서버에 대한 클라이언트 역할을 하는 명령 집합이 있습니다. 명령은 데몬과 상호작용하는 사용자 친화적인 경험을 제공합니다. 명령은 CTS API를 사용하지만 일대일로 대응하지는 않습니다. 자세한 내용은 왼쪽 탐색의 개별 명령을 검토하세요.
명령에 대한 도움말을 얻으려면 consul-terraform-sync <command> -h를 실행하세요.
CLI 구조
CTS 명령은 아래 구조를 따릅니다.
$ consul-terraform-sync <command> [options] [args]
예:
$ consul-terraform-sync task disable -http-addr=http://localhost:2000 task_a
자동 완성 (Autocompletion)
consul-terraform-sync 명령은 플래그, 하위 명령, 인자(지원되는 경우)에 대한 옵트인 자동 완성을 제공합니다.
자동 완성을 활성화하려면 다음을 실행하세요.
$ consul-terraform-sync -autocomplete-install
자동 완성을 설치한 후 변경 사항을 적용하려면 셸을 다시 시작해야 합니다.
CTS 명령 입력을 시작하면 <tab> 키를 눌러 사용 가능한 완성 목록을 표시할 수 있습니다. 사용 가능한 플래그 완성을 표시하려면 -<tab>을 입력하세요.
자동 완성은 실행 중인 CTS 서버를 쿼리하여 유용한 인자 제안을 반환합니다. 예를 들어 task disable 명령의 경우 자동 완성은 비활성화할 수 있는 모든 활성화된 태스크의 이름을 반환합니다.
자동 완성이 실행 중인 CTS 서버에 쿼리할 때 CTS 서버에 설정된 CTS_* 환경 변수(예: CTS_ADDRESS)도 사용합니다.
예시: 자동 완성을 사용해 태스크를 비활성화하는 방법 찾기
각 프롬프트 줄 끝에 탭이 입력되었다고 가정합니다.
$ consul-terraform-sync
start task
$ consul-terraform-sync task
create delete disable enable
$ consul task disable
task_name_a task_name_b task_name_c
일반 옵션 (General Options)
아래는 모든 명령에서 사용할 수 있는 옵션입니다.
| 옵션 | 필수 | 유형 | 설명 | 기본값 |
| -port | 선택 | integer | Consul-Terraform-Sync 0.5.0에서 더 이상 사용되지 않으며 이후 버전에서 제거될 예정입니다. Consul-Terraform-Sync API의 주소와 포트를 지정하려면 대신 -http-addr 옵션을 사용하세요.
|
| CTS 데몬이 API를 제공하는 포트.
| 값은 http://localhost:로 접두사가 붙지만, 필요하면 -http-addr로 다른 스킴이나 주소를 지정할 수 있습니다. | 8558 |
| -http-addr | 선택 | string | CTS API의 주소와 포트. IP 또는 DNS 주소를 지정할 수 있습니다.
|
| 또는 CTS_ADDRESS 환경 변수를 사용해 값을 지정할 수 있습니다. | http://localhost:8558 |
| -ssl-verify | 선택 | boolean | true로 설정하면 API에 대한 TLS/SSL 연결 검증을 활성화합니다. 이는 안전하지 않은 HTTP 연결에는 영향을 주지 않습니다.
|
| 또는 CTS_SSL_VERIFY 환경 변수를 사용해 값을 지정할 수 있습니다. | true |
| -ca-cert | 선택 | string | TLS/SSL 연결을 검증하는 데 사용되는 PEM 인코딩 인증 기관 파일의 경로. 둘 다 제공되면 -ca-path보다 우선합니다.
|
| 또는 CTS_CACERT 환경 변수를 사용해 값을 지정할 수 있습니다. | 없음 |
| -ca-path | 선택 | string | TLS/SSL 연결을 검증하는 데 사용되는 PEM 인코딩 인증 기관 파일이 포함된 디렉터리의 경로.
|
| 또는 CTS_CAPATH 환경 변수를 사용해 값을 지정할 수 있습니다. | 없음 |
| -client-cert | 선택 | string | API에서 verify_incoming이 true로 설정될 때 CTS API가 요구하는 PEM 인코딩 클라이언트 인증서의 경로.
|
| 또는 CTS_CLIENT_CERT 환경 변수를 사용해 값을 지정할 수 있습니다. | 없음 |
| -client-key | 선택 | string | -client-cert 옵션으로 구성된 인증서에 대한 PEM 인코딩 클라이언트 키의 경로. -client-cert가 설정되고 CTS API에서 verify_incoming이 true로 설정된 경우 필요합니다.
|
| 또는 CTS_CLIENT_KEY 환경 변수를 사용해 값을 지정할 수 있습니다. | 없음 |