XML 기반 settings profiles 및 설정 파일은 ClickHouse Cloud에서 지원되지 않습니다. 따라서 ClickHouse Cloud에서는
config.xml 파일을 찾을 수 없습니다. 대신 SQL 명령을 사용해 settings profiles를 통해 설정을 관리해야 합니다.자세한 내용은 “설정 구성”을 참조하십시오./etc/clickhouse-server/config.xml을 기본 설정 파일로 사용해 실행되지만, 서버 시작 시 명령줄 옵션 --config-file 또는 -C를 사용하여 설정 파일 위치를 수동으로 지정할 수도 있습니다.
두 옵션 중 어느 것도 지정하지 않으면 서버는 현재 작업 디렉터리에서 config.xml, config.yaml, config.yml을 이 순서대로 찾아 가장 먼저 발견된 파일을 사용합니다.
이 중 어느 파일도 없으면 서버는 바이너리에 내장된 구성으로 시작합니다.
--config-file로 지정한 파일은 그대로 사용됩니다. 해당 파일이 없으면 서버는 다른 확장자의 파일을 찾지 않고 오류를 보고합니다.
clickhouse-keeper도 keeper_config.xml, keeper_config.yaml, keeper_config.yml에 대해 동일한 규칙을 따릅니다.
추가 설정 파일은 기본 설정 파일을 기준으로 하는 config.d/ 디렉터리(예: /etc/clickhouse-server/config.d/)에 둘 수 있습니다.
이 디렉터리의 파일과 기본 설정은 ClickHouse 서버에 구성이 적용되기 전에 전처리 단계에서 병합됩니다.
구성 조각은 전체 경로의 사전식 순서로 병합됩니다. 표준 config.d/ 디렉터리의 파일은 파일명순 정렬과 동일합니다. 기존 conf.d/ 디렉터리도 병합됩니다. conf.d는 config.d보다 먼저 정렬되므로 두 디렉터리가 모두 있으면 해당 조각이 먼저 처리됩니다.
업데이트를 단순화하고 모듈화를 개선하려면 기본 config.xml 파일은 수정하지 않고, 추가 사용자 지정은 config.d/에 두는 것이 모범 사례입니다.
ClickHouse Keeper 구성은 /etc/clickhouse-keeper/keeper_config.xml에 있습니다.
마찬가지로 Keeper용 추가 설정 파일은 /etc/clickhouse-keeper/keeper_config.d/에 두어야 합니다.
XML과 YAML 설정 파일은 함께 사용할 수 있습니다. 예를 들어 기본 설정 파일로 config.xml을 두고, 추가 설정 파일로 config.d/network.xml, config.d/timezone.yaml, config.d/keeper.yaml을 둘 수 있습니다.
단일 설정 파일 안에서 XML과 YAML을 혼합하는 것은 지원되지 않습니다.
XML 설정 파일은 최상위 태그로 <clickhouse>...</clickhouse>를 사용해야 합니다.
YAML 설정 파일에서는 clickhouse:가 선택 사항이며, 없으면 파서가 이를 자동으로 삽입합니다.
구성 병합
config.d/의 다른 설정 파일)은 다음과 같이 병합됩니다:
- 노드(즉, 요소로 이어지는 경로)가 두 파일에 모두 존재하고
replace또는remove속성이 없으면, 해당 노드는 병합된 설정 파일에 포함되며 두 노드의 자식 요소가 모두 포함되어 재귀적으로 병합됩니다. - 두 노드 중 하나에
replace속성이 있으면, 해당 노드는 병합된 설정 파일에 포함되지만replace속성이 있는 노드의 자식 요소만 포함됩니다. - 두 노드 중 하나에
remove속성이 있으면, 해당 노드는 병합된 설정 파일에 포함되지 않습니다(이미 존재하는 경우 삭제됩니다).
config.xml
config.d/other_config.xml
환경 변수 및 ZooKeeper 노드를 사용한 치환
from_env 속성을 사용할 수 있습니다.
예를 들어, 환경 변수 $MAX_QUERY_SIZE = 150000이 설정되어 있으면:
from_zk(ZooKeeper 노드)를 사용해도 동일하게 할 수 있습니다:
값의 해석 방식
from_env와 from_zk는 치환된 값을 해석하는 방식이 다릅니다.
from_env로 직접 치환한 값은 리터럴 텍스트로 취급됩니다.&,<,>같은 XML 특수 문자는 자동으로 이스케이프되므로 환경 변수에a&b<c>d처럼 XML로 표현할 수 있는 값을 넣어도 구성이 손상되지 않습니다(아래의 XML에서 허용되지 않는 제어 문자 관련 설명을 참고하세요). 직접 치환한 값은 XML 조각처럼 보여도 XML로 해석되지 않습니다. 예를 들어<a>1</a>는 리터럴 텍스트<a>1</a>로 치환됩니다.<profiles from_env="…"/>처럼 일반 컨테이너에 속성을 직접 지정해도 마찬가지입니다. 기존에 XML 하위 트리를 치환하던 구성은<profiles><include from_env="…"/></profiles>로 변경해야 합니다. 반면<include from_env="…"/>는 이전 버전과의 호환성을 위해 다르게 동작합니다. 환경 변수의 값을 XML 조각으로 파싱한 뒤 그 자식 요소를 부모 요소에 삽입합니다.from_zk로 치환한 값은<로 시작하는지에 따라 해석 방식이 달라집니다.<로 시작하는 값은 항상 XML 조각으로 파싱됩니다. 구조적 요소인<include from_zk="…"/>와<profiles from_zk="…"/>같은 일반 컨테이너 모두에서 이 방식으로 하위 트리를 삽입합니다. 이전 버전에서는from_zk값을 항상 XML로 해석했으므로, 이전 버전과의 호환성을 위해 이 동작을 유지합니다.<로 시작하지 않는 값은<include from_zk="…" yaml="true"/>형식을 명시적으로 사용한 경우에만 YAML 하위 트리로 파싱됩니다. 이때 YAML 형식이 잘못되면 구성이 거부됩니다.yaml="true"속성은 리프 요소 내부를 포함해 일반적인<include>형식을 사용하는 모든 곳에서 YAML 파싱을 활성화하므로, 리터럴 설정값이나 시크릿에는 사용하지 마세요.yaml="true"가 없으면<로 시작하지 않는 값은<password><include from_zk="/secret"/></password>같은 일반적인 리프 대체 형식으로 사용해도 리터럴 텍스트로 취급됩니다. 따라서abc # rotated나[1처럼 YAML 구문이 포함되어 있거나 올바른 YAML이 아닌 값도 그대로 유지됩니다. 이 형식에서는<include>주변에 공백 텍스트 노드가 없이 인라인으로 배치된 경우에만 바이트가 정확히 보존됩니다. 바이트를 정확히 보존해야 하는 시크릿과 리프 설정에는<password from_zk="…"/>처럼 직접 지정하는 형식을 사용하는 것이 좋습니다. 그 밖의 요소에서도<some_setting from_zk="…"/>나<password from_zk="…"/>같은 리프 치환이든<profiles from_zk="…"/>같은 일반 컨테이너든,<로 시작하지 않는 값은 원래 바이트 그대로 리터럴 텍스트로 유지됩니다(XML 특수 문자는from_env와 마찬가지로 자동으로 이스케이프됩니다). 따라서abc: def는<abc>def</abc>하위 요소로 바뀌지 않고 리터럴 텍스트abc: def로 유지됩니다. 구조적 요소인<include>가 아닌 일반 요소에 하위 트리를 삽입하려면<로 시작하는 XML 조각으로 제공하세요.
리터럴 값은 유효한 XML 1.0 텍스트여야 합니다리터럴 치환(
from_env 또는 <로 시작하지 않는 리프 from_zk 값)은 XML 1.0에서 텍스트로 표현할 수 있는 모든 문자를 원래 바이트 그대로 보존합니다. XML 1.0에서 허용되지 않는 제어 문자(0x00–0x08, 0x0B, 0x0C, 0x0E–0x1F)는 XML 구성을 통해 전달할 수 없습니다(XML 명세에서는  같은 숫자 문자 참조 형태로도 사용할 수 없도록 금지합니다). 이러한 문자가 포함된 값은 치환 처리 시 거부됩니다. 탭(\t), 줄 바꿈(\n), 캐리지 리턴(\r)은 허용되며, 값을 기록한 뒤 다시 읽어도 바이트 단위로 보존됩니다.엔터티 인코딩된 리프 값의 업그레이드 동작이전 버전에서는 모든 직접
from_env 값을 XML로 다시 파싱했기 때문에, 원시 &, <, >는 올바른 형식(well-formed)이 아니라는 이유로 거부되었습니다. 따라서 이러한 문자를 포함하려면 XML 엔터티로 인코딩하는 방법밖에 없었습니다. 예를 들어 a&b로 설정된 환경 변수는 a&b로, <a>1</a>는 <a>1</a>로, 는 캐리지 리턴으로 디코딩되었습니다. 이제 직접 from_env 값은 리터럴 텍스트로 처리되므로, 같은 환경 값이 각각 리터럴 a&b, <a>1</a>, 로 해석됩니다. 즉, 일반 텍스트 값만 기존 의미가 그대로 유지됩니다. 이전 XML 경로에 맞춰 엔터티 인코딩했던 환경 값은 원시 형태로 설정해야 합니다(예를 들어 a&b로 설정하십시오. 이 값은 이전 경로에서는 거부되었지만 새 경로에서는 리터럴 텍스트 a&b로 허용됩니다).이전 버전에서는 모든 리프 from_zk 값을 XML로 다시 파싱했기 때문에, 원시 &, <, >는 올바른 형식이 아니라는 이유로 거부되었습니다. 따라서 이러한 문자를 포함하려면 XML 엔터티로 인코딩하는 방법밖에 없었습니다. 예를 들어 a&b로 저장된 값은 a&b로, <a>1</a>는 <a>1</a>로, 는 캐리지 리턴으로 디코딩되었습니다. 이제 <로 시작하지 않는 리프 값은 원래 바이트 그대로 유지되므로, 같은 노드가 각각 리터럴 a&b, <a>1</a>, 로 해석됩니다. 즉, 일반 텍스트 스칼라만 기존 의미가 그대로 유지됩니다. 이전 XML 경로에 맞춰 엔터티 인코딩했던 리프 값은 원시 형태로 저장해야 합니다(예를 들어 a&b로 저장하십시오. 이 값은 이전 경로에서는 거부되었지만 새 경로에서는 리터럴 텍스트 a&b로 허용됩니다).리프 설정이나 시크릿 안에서 인라인 <include from_zk="…"/>로 치환되는 일반 스칼라에도 같은 변경 사항이 적용됩니다. 예를 들어 <password><include from_zk="/secret"/></password>에서도 이제 스칼라는 원래 바이트 그대로 유지됩니다. 따라서 /secret = a&b(이전에는 a&b로 디코딩됨)는 이제 리터럴 a&b로 해석되므로, 원시 형태인 a&b로 저장해야 합니다. 이 형식에서는 앞뒤에 공백을 두지 마십시오. 해당 공백도 최종 설정 값에 포함되기 때문입니다. 정확한 바이트가 중요하다면 직접 <password from_zk="…"/> 형식을 사용하는 것이 좋습니다. (<로 시작하는 from_zk 값이나 <include from_zk="…" yaml="true"/>로 참조하는 YAML 하위 트리는 영향을 받지 않습니다. 별도 표시가 없고 <로 시작하지 않는 값만 리터럴로 유지됩니다.)기본값
from_env 또는 from_zk 속성이 있는 요소에는 replace="1" 속성을 추가로 지정할 수 있습니다(replace="1"은 from_env/from_zk보다 앞에 와야 합니다).
이 경우 요소에 기본값을 정의할 수 있습니다.
값이 설정되어 있으면 요소는 환경 변수 또는 ZooKeeper 노드의 값을 사용하고, 그렇지 않으면 기본값을 사용합니다.
앞선 예시를 다시 살펴보되, MAX_QUERY_SIZE가 설정되지 않았다고 가정합니다:
파일 내용으로 치환
- 값 치환: 요소에
incl속성이 있으면 해당 값이 참조된 파일의 내용으로 대체됩니다. 치환 값을 담은 파일의 경로는 서버 구성의include_from요소에서 설정합니다. 기본 경로는 없으므로, 지정한 경우에만 치환 값을 읽습니다. 치환 값은 이 파일의/clickhouse/substitution_name요소에 지정합니다.incl에 지정된 치환이 존재하지 않으면 로그에 기록됩니다. 누락된 치환에 대해 ClickHouse가 로그를 남기지 않도록 하려면optional="true"속성을 지정하십시오(예: macros 설정). - 요소 치환: 전체 요소를 치환 값으로 바꾸려면 요소 이름으로
include를 사용하십시오. 요소 이름include는from_zk = "/path/to/node"속성과 함께 사용할 수 있습니다. 이 경우 요소 값은/path/to/node에 있는 ZooKeeper 노드의 내용으로 대체됩니다. 전체 XML 하위 트리를 ZooKeeper 노드에 저장한 경우에도 동일하게 작동하며, 해당 트리가 원본 요소에 완전히 삽입됩니다.
버전 26.8부터 변경됨: 이전 버전에서는
include_from을 지정하지 않았더라도 파일 /etc/metrika.xml이 존재하면 암묵적으로 사용되었습니다. 해당 파일에 의존하는 경우 include_from에 해당 경로를 명시적으로 지정하십시오. include_from은 각 구성 파일에서 개별적으로 읽힙니다. 즉, 기본 서버 구성과 별도로 로드되는 파일인 사용자’ 구성(예: 기본 파일에 포함되지 않은 경우의 users.xml) 및 XML 딕셔너리 구성에는 각각 자체 include_from 요소가 필요하며, 기본 서버 구성에만 지정해도 적용되지 않습니다.merge="true"를 사용할 수 있습니다. 예시: <include from_zk="/some_path" merge="true">. 이 경우 기존 구성은 치환 콘텐츠와 병합되며, 기존 구성의 설정은 치환 콘텐츠의 값으로 대체됩니다.
구성 암호화 및 숨기기
encrypted_by 속성을 추가하고 그 값으로 암호화 코덱 이름을 지정합니다.
속성 from_zk, from_env, incl 또는 요소 include와 달리, 전처리된 파일에서는 치환(즉, 암호화된 값의 복호화)이 수행되지 않습니다.
복호화는 서버 프로세스의 런타임에서만 수행됩니다.
예시:
from_env와 from_zk는 encryption_codecs에도 적용할 수 있습니다:
config.xml은 다음과 같습니다:
users.xml의 예시입니다:
encrypt_decrypt를 사용할 수 있습니다:
hide_in_preprocessed를 사용하십시오.
예시:
사용자 설정
config.xml 파일에서 사용자 설정, 프로필, 쿼터에 대한 별도의 구성을 지정할 수 있습니다. 이 구성의 상대 경로는 users_config 요소에서 설정합니다. 기본값은 users.xml입니다. users_config를 생략하면 사용자 설정, 프로필, 쿼터를 config.xml에 직접 지정합니다.
사용자 구성은 config.xml 및 config.d/와 마찬가지로 별도의 파일로 분리할 수 있습니다.
디렉터리 이름은 .xml 접미사를 제거한 users_config 설정값에 .d를 덧붙여 정의합니다.
기본적으로 users_config의 기본값이 users.xml이므로 users.d 디렉터리를 사용합니다.
사용자 구성 조각은 전체 경로의 사전순으로 병합됩니다. 표준 users.d/ 디렉터리의 파일에서는 파일 이름순으로 정렬하는 것과 동일합니다. 기존 conf.d/ 디렉터리도 병합되며, conf.d가 users.d보다 앞에 정렬되므로 두 디렉터리가 모두 존재할 때는 해당 조각이 모두 먼저 처리됩니다.
설정 파일은 먼저 설정을 고려하여 병합되며, 그 이후에 include가 처리된다는 점에 유의하십시오.
XML 예시
YAML 예시
여기에서 YAML로 작성된 기본 구성을 확인할 수 있습니다:config.yaml.example.
ClickHouse 구성에서는 YAML 포맷과 XML 포맷 사이에 몇 가지 차이점이 있습니다.
아래에는 YAML 포맷으로 구성을 작성할 때 유용한 팁을 정리했습니다.
텍스트 값을 가진 XML 태그는 YAML의 키-값 쌍으로 표현됩니다.
@ 접두사가 붙은 속성 키를 사용할 수 있습니다. @는 YAML 표준에서 예약된 문자이므로 큰따옴표로 감싸야 합니다:
#text 속성 키를 사용하면 됩니다:
구현 세부 사항
file-preprocessed.xml 파일도 생성합니다. 이 파일에는 적용이 완료된 모든 치환과 재정의가 포함되며, 참고용으로 제공됩니다. 구성 파일에서 ZooKeeper 치환을 사용했지만 서버 시작 시 ZooKeeper를 사용할 수 없는 경우, 서버는 전처리된 파일에서 구성을 로드합니다.
서버는 구성 파일의 변경 사항뿐 아니라 치환과 재정의를 수행할 때 사용된 파일 및 ZooKeeper 노드의 변경 사항도 추적하고, 사용자와 클러스터의 설정을 즉시 다시 로드합니다. 즉, 서버를 재시작하지 않고도 클러스터, 사용자 및 해당 설정을 수정할 수 있습니다.