커넥터 Admin CLI

커넥터 Admin CLI (Connector Admin CLI)

pulsar-admin 도구는 Pulsar 커넥터를 관리하는 데 사용돼요. 이 페이지는 sources와 sinks 두 가지 하위 명령어 인터페이스를 정리한 레퍼런스 문서인데요, 각 커넥터의 생성, 업데이트, 삭제, 상태 확인 같은 작업을 커맨드라인에서 처리할 수 있어요.

팁

이 페이지는 더 이상 갱신되지 않는(deprecated) 문서예요. Pulsar-admin의 명령어, 플래그, 설명 등 최신의 완전한 정보는 Pulsar admin 문서를 참고하세요.

출처: 문서

본문

sources

Pulsar IO 소스(외부에서 Pulsar로 들어오는 데이터)를 관리하는 인터페이스예요.

pulsar-admin sources subcommands

하위 명령어는 다음과 같아요.

  • create
  • update
  • delete
  • get
  • status
  • list
  • stop
  • start
  • restart
  • localrun
  • available-sources
  • reload

create

Pulsar 클러스터에서 실행할 Pulsar IO 소스 커넥터를 제출해요.

Usage
pulsar-admin sources create options
Options
Flag 설명
-a, --archive 소스용 NAR 아카이브의 절대 경로예요. 워커가 패키지를 다운로드할 수 있는 URL 경로(http/https/file [file 프로토콜은 파일이 이미 워커 호스트에 존재한다고 가정])도 지원해요.
--classname 소스의 클래스 이름이에요.
--cpu 소스 인스턴스 하나당 할당할 CPU(코어 수)예요. (Docker 런타임에서만 적용돼요.)
--deserialization-classname 소스의 SerDe 클래스 이름이에요.
--destination-topic-name 데이터가 전송되는 Pulsar 토픽이에요.
--disk 소스 인스턴스 하나당 할당할 디스크(바이트)예요. (Docker 런타임에서만 적용돼요.)
--name 소스의 이름이에요.
--namespace 소스의 네임스페이스예요.
--parallelism 소스의 병렬 처리 계수, 즉 실행할 소스 인스턴스 수예요.
--processing-guarantees 소스에 적용되는 처리 보장(전달 의미라고도 불러요)이에요. 소스 커넥터는 외부 시스템에서 메시지를 받아 Pulsar 토픽에 써 넣어요. --processing-guarantees는 Pulsar 토픽에 메시지를 쓸 때의 처리 보장을 확보하기 위한 값이에요. 사용 가능한 값은 ATLEAST_ONCE, ATMOST_ONCE, EFFECTIVELY_ONCE예요.
--ram 소스 인스턴스 하나당 할당할 RAM(바이트)이에요. (process와 Docker 런타임에서 적용돼요.)
-st, --schema-type 스키마 타입이에요. 내장 스키마(예: AVRO, JSON) 또는 소스에서 발행되는 메시지를 인코딩하는 데 쓸 커스텀 스키마 클래스 이름이에요.
--source-config 소스 구성 키/값이에요.
--source-config-file 소스의 구성을 지정하는 YAML 구성 파일의 절대 경로예요.
-t, --source-type 소스의 커넥터 프로바이더예요.
--tenant 소스의 테넌트예요.
--producer-config 커스텀 프로듀서 구성(JSON 문자열)이에요.

update

이미 제출된 Pulsar IO 소스 커넥터를 업데이트해요.

Usage
pulsar-admin sources update options
Options
Flag 설명
-a, --archive 소스용 NAR 아카이브의 절대 경로예요. 워커가 패키지를 다운로드할 수 있는 URL 경로(http/https/file [file 프로토콜은 파일이 이미 워커 호스트에 존재한다고 가정])도 지원해요.
--classname 소스의 클래스 이름이에요.
--cpu 소스 인스턴스 하나당 할당할 CPU(코어 수)예요. (Docker 런타임에서만 적용돼요.)
--deserialization-classname 소스의 SerDe 클래스 이름이에요.
--destination-topic-name 데이터가 전송되는 Pulsar 토픽이에요.
--disk 소스 인스턴스 하나당 할당할 디스크(바이트)예요. (Docker 런타임에서만 적용돼요.)
--name 소스의 이름이에요.
--namespace 소스의 네임스페이스예요.
--parallelism 소스의 병렬 처리 계수, 즉 실행할 소스 인스턴스 수예요.
--processing-guarantees 소스에 적용되는 처리 보장(전달 의미라고도 불러요)이에요. 소스 커넥터는 외부 시스템에서 메시지를 받아 Pulsar 토픽에 써 넣어요. --processing-guarantees는 Pulsar 토픽에 메시지를 쓸 때의 처리 보장을 확보하기 위한 값이에요. 사용 가능한 값은 ATLEAST_ONCE, ATMOST_ONCE, EFFECTIVELY_ONCE예요.
--ram 소스 인스턴스 하나당 할당할 RAM(바이트)이에요. (process와 Docker 런타임에서 적용돼요.)
-st, --schema-type 스키마 타입이에요. 내장 스키마(예: AVRO, JSON) 또는 소스에서 발행되는 메시지를 인코딩하는 데 쓸 커스텀 스키마 클래스 이름이에요.
--source-config 소스 구성 키/값이에요.
--source-config-file 소스의 구성을 지정하는 YAML 구성 파일의 절대 경로예요.
-t, --source-type 소스의 커넥터 프로바이더예요. 현재 내장 커넥터의 source-type 파라미터는 pulsar-io.yaml 파일에 지정된 name 파라미터 설정에 따라 결정돼요.
--tenant 소스의 테넌트예요.
--update-auth-data 인증 데이터(auth data)를 업데이트할지 여부예요. 기본값: false.

delete

Pulsar IO 소스 커넥터를 삭제해요.

Usage
pulsar-admin sources delete options
Option
Flag 설명
--name 소스의 이름이에요.
--namespace 소스의 네임스페이스예요.
--tenant 소스의 테넌트예요.

get

Pulsar IO 소스 커넥터의 정보를 가져와요.

Usage
pulsar-admin sources get options
Options
Flag 설명
--name 소스의 이름이에요.
--namespace 소스의 네임스페이스예요.
--tenant 소스의 테넌트예요.

status

Pulsar 소스의 현재 상태를 확인해요.

Usage
pulsar-admin sources status options
Options
Flag 설명
--instance-id 소스 ID예요. instance-id를 지정하지 않으면 Pulsar가 모든 인스턴스의 상태를 가져와요.
--name 소스의 이름이에요.
--namespace 소스의 네임스페이스예요.
--tenant 소스의 테넌트예요.

list

실행 중인 모든 Pulsar IO 소스 커넥터를 나열해요.

Usage
pulsar-admin sources list options
Options
Flag 설명
--namespace 소스의 네임스페이스예요.
--tenant 소스의 테넌트예요.

stop

소스 인스턴스를 중지해요.

Usage
pulsar-admin sources stop options
Options
Flag 설명
--instance-id 소스 instanceID예요. instance-id를 지정하지 않으면 Pulsar가 모든 인스턴스를 중지해요.
--name 소스의 이름이에요.
--namespace 소스의 네임스페이스예요.
--tenant 소스의 테넌트예요.

start

소스 인스턴스를 시작해요.

Usage
pulsar-admin sources start options
Options
Flag 설명
--instance-id 소스 instanceID예요. instance-id를 지정하지 않으면 Pulsar가 모든 인스턴스를 시작해요.
--name 소스의 이름이에요.
--namespace 소스의 네임스페이스예요.
--tenant 소스의 테넌트예요.

restart

소스 인스턴스를 재시작해요.

Usage
pulsar-admin sources restart options
Options
Flag 설명
--instance-id 소스 instanceID예요. instance-id를 지정하지 않으면 Pulsar가 모든 인스턴스를 재시작해요.
--name 소스의 이름이에요.
--namespace 소스의 네임스페이스예요.
--tenant 소스의 테넌트예요.

localrun

Pulsar IO 소스 커넥터를 Pulsar 클러스터에 배포하지 않고 로컬에서 실행해요.

Usage
pulsar-admin sources localrun options
Options
Flag 설명
-a, --archive 소스용 NAR 아카이브의 절대 경로예요. 워커가 패키지를 다운로드할 수 있는 URL 경로(http/https/file [file 프로토콜은 파일이 이미 워커 호스트에 존재한다고 가정])도 지원해요.
--broker-service-url Pulsar 브로커의 URL이에요.
--classname 소스의 클래스 이름이에요.
--client-auth-params 클라이언트 인증 파라미터예요.
--client-auth-plugin function-process가 브로커에 연결하는 데 사용하는 클라이언트 인증 플러그인이에요.
--cpu 소스 인스턴스 하나당 할당할 CPU(코어 수)예요. (Docker 런타임에서만 적용돼요.)
--deserialization-classname 소스의 SerDe 클래스 이름이에요.
--destination-topic-name 데이터가 전송되는 Pulsar 토픽이에요.
--disk 소스 인스턴스 하나당 할당할 디스크(바이트)예요. (Docker 런타임에서만 적용돼요.)
--hostname-verification-enabled 호스트네임 검증을 활성화할지 여부예요. 기본값: false.
--name 소스의 이름이에요.
--namespace 소스의 네임스페이스예요.
--parallelism 소스의 병렬 처리 계수, 즉 실행할 소스 인스턴스 수예요.
--processing-guarantees 소스에 적용되는 처리 보장(전달 의미라고도 불러요)이에요. 소스 커넥터는 외부 시스템에서 메시지를 받아 Pulsar 토픽에 써 넣어요. --processing-guarantees는 Pulsar 토픽에 메시지를 쓸 때의 처리 보장을 확보하기 위한 값이에요. 사용 가능한 값은 ATLEAST_ONCE, ATMOST_ONCE, EFFECTIVELY_ONCE예요.
--ram 소스 인스턴스 하나당 할당할 RAM(바이트)이에요. (Docker 런타임에서만 적용돼요.)
-st, --schema-type 스키마 타입이에요. 내장 스키마(예: AVRO, JSON) 또는 소스에서 발행되는 메시지를 인코딩하는 데 쓸 커스텀 스키마 클래스 이름이에요.
--source-config 소스 구성 키/값이에요.
--source-config-file 소스의 구성을 지정하는 YAML 구성 파일의 절대 경로예요.
--source-type 소스의 커넥터 프로바이더예요.
--tenant 소스의 테넌트예요.
--tls-allow-insecure 안전하지 않은 TLS 연결을 허용할지 여부예요. 기본값: false.
--tls-trust-cert-path TLS 신뢰 인증서 파일 경로예요.
--use-tls TLS 연결을 사용할지 여부예요. 기본값: false.
--producer-config 커스텀 프로듀서 구성(JSON 문자열)이에요.

available-sources

Pulsar 클러스터가 지원하는 Pulsar IO 커넥터 소스 목록을 가져와요.

Usage
pulsar-admin sources available-sources

reload

사용 가능한 내장 커넥터를 다시 로드해요.

Usage
pulsar-admin sources reload

sinks

Pulsar IO 싱크(Pulsar에서 외부로 나가는 데이터)를 관리하는 인터페이스예요.

pulsar-admin sinks subcommands

하위 명령어는 다음과 같아요.

  • create
  • update
  • delete
  • get
  • status
  • list
  • stop
  • start
  • restart
  • localrun
  • available-sinks
  • reload

create

Pulsar 클러스터에서 실행할 Pulsar IO 싱크 커넥터를 제출해요.

Usage
pulsar-admin sinks create options
Options
Flag 설명
-a, --archive 싱크용 아카이브 파일의 절대 경로예요. 워커가 패키지를 다운로드할 수 있는 URL 경로(http/https/file [file 프로토콜은 파일이 이미 워커 호스트에 존재한다고 가정])도 지원해요.
--auto-ack 프레임워크가 메시지를 자동으로 acknowledge할지 여부예요.
--classname 싱크의 클래스 이름이에요.
--cpu 싱크 인스턴스 하나당 할당할 CPU(코어 수)예요. (Docker 런타임에서만 적용돼요.)
--custom-schema-inputs 입력 토픽과 스키마 타입 또는 클래스 이름의 맵(JSON 문자열)이에요.
--custom-serde-inputs 입력 토픽과 SerDe 클래스 이름의 맵(JSON 문자열)이에요.
--disk 싱크 인스턴스 하나당 할당할 디스크(바이트)예요. (Docker 런타임에서만 적용돼요.)
-i, --inputs 싱크의 입력 토픽(들)이에요. (여러 토픽은 쉼표로 구분해 지정할 수 있어요.)
--name 싱크의 이름이에요.
--namespace 싱크의 네임스페이스예요.
--parallelism 싱크의 병렬 처리 계수, 즉 실행할 싱크 인스턴스 수예요.
--processing-guarantees 싱크에 적용되는 처리 보장(전달 의미라고도 불러요)이에요. Pulsar의 --processing-guarantees 구현은 싱크 구현에도 의존해요. 사용 가능한 값은 ATLEAST_ONCE, ATMOST_ONCE, EFFECTIVELY_ONCE예요.
--ram 싱크 인스턴스 하나당 할당할 RAM(바이트)이에요. (process와 Docker 런타임에서 적용돼요.)
--retain-ordering 싱크가 메시지를 순서대로 소비하고 sink 처리할지 여부예요.
--sink-config 싱크 구성 키/값이에요.
--sink-config-file 싱크의 구성을 지정하는 YAML 구성 파일의 절대 경로예요.
-t, --sink-type 싱크의 커넥터 프로바이더예요. 현재 내장 커넥터의 sink-type 파라미터는 pulsar-io.yaml 파일에 지정된 name 파라미터 설정에 따라 결정돼요.
--subs-name 입력 토픽 컨슈머에 특정 구독 이름을 쓰고 싶을 때의 Pulsar 소스 구독 이름이에요.
--tenant 싱크의 테넌트예요.
--timeout-ms 메시지 타임아웃(밀리초)이에요.
--topics-pattern 네임스페이스 아래에서 패턴과 일치하는 토픽 목록 중 소비할 토픽 패턴이에요. --input과 --topics-pattern은 상호 배타적이에요. 패턴에 대한 SerDe 클래스 이름은 --custom-serde-inputs에 추가하세요.

update

Pulsar IO 싱크 커넥터를 업데이트해요.

Usage
pulsar-admin sinks update options
Options
Flag 설명
-a, --archive 싱크용 아카이브 파일의 절대 경로예요. 워커가 패키지를 다운로드할 수 있는 URL 경로(http/https/file [file 프로토콜은 파일이 이미 워커 호스트에 존재한다고 가정])도 지원해요.
--auto-ack 프레임워크가 메시지를 자동으로 acknowledge할지 여부예요.
--classname 싱크의 클래스 이름이에요.
--cpu 싱크 인스턴스 하나당 할당할 CPU(코어 수)예요. (Docker 런타임에서만 적용돼요.)
--custom-schema-inputs 입력 토픽과 스키마 타입 또는 클래스 이름의 맵(JSON 문자열)이에요.
--custom-serde-inputs 입력 토픽과 SerDe 클래스 이름의 맵(JSON 문자열)이에요.
--disk 싱크 인스턴스 하나당 할당할 디스크(바이트)예요. (Docker 런타임에서만 적용돼요.)
-i, --inputs 싱크의 입력 토픽(들)이에요. (여러 토픽은 쉼표로 구분해 지정할 수 있어요.)
--name 싱크의 이름이에요.
--namespace 싱크의 네임스페이스예요.
--parallelism 싱크의 병렬 처리 계수, 즉 실행할 싱크 인스턴스 수예요.
--processing-guarantees 싱크에 적용되는 처리 보장(전달 의미라고도 불러요)이에요. Pulsar의 --processing-guarantees 구현은 싱크 구현에도 의존해요. 사용 가능한 값은 ATLEAST_ONCE, ATMOST_ONCE, EFFECTIVELY_ONCE예요.
--ram 싱크 인스턴스 하나당 할당할 RAM(바이트)이에요. (process와 Docker 런타임에서 적용돼요.)
--retain-ordering 싱크가 메시지를 순서대로 소비하고 sink 처리할지 여부예요.
--sink-config 싱크 구성 키/값이에요.
--sink-config-file 싱크의 구성을 지정하는 YAML 구성 파일의 절대 경로예요.
-t, --sink-type 싱크의 커넥터 프로바이더예요.
--subs-name 입력 토픽 컨슈머에 특정 구독 이름을 쓰고 싶을 때의 Pulsar 소스 구독 이름이에요.
--tenant 싱크의 테넌트예요.
--timeout-ms 메시지 타임아웃(밀리초)이에요.
--topics-pattern 네임스페이스 아래에서 패턴과 일치하는 토픽 목록 중 소비할 토픽 패턴이에요. --input과 --topics-pattern은 상호 배타적이에요. 패턴에 대한 SerDe 클래스 이름은 --custom-serde-inputs에 추가하세요.
--update-auth-data 인증 데이터(auth data)를 업데이트할지 여부예요. 기본값: false.

delete

Pulsar IO 싱크 커넥터를 삭제해요.

Usage
pulsar-admin sinks delete options
Option
Flag 설명
--name 싱크의 이름이에요.
--namespace 싱크의 네임스페이스예요.
--tenant 싱크의 테넌트예요.

get

Pulsar IO 싱크 커넥터의 정보를 가져와요.

Usage
pulsar-admin sinks get options
Options
Flag 설명
--name 싱크의 이름이에요.
--namespace 싱크의 네임스페이스예요.
--tenant 싱크의 테넌트예요.

status

Pulsar 싱크의 현재 상태를 확인해요.

Usage
pulsar-admin sinks status options
Options
Flag 설명
--instance-id 싱크 ID예요. instance-id를 지정하지 않으면 Pulsar가 모든 인스턴스의 상태를 가져와요.
--name 싱크의 이름이에요.
--namespace 싱크의 네임스페이스예요.
--tenant 싱크의 테넌트예요.

list

실행 중인 모든 Pulsar IO 싱크 커넥터를 나열해요.

Usage
pulsar-admin sinks list options
Options
Flag 설명
--namespace 싱크의 네임스페이스예요.
--tenant 싱크의 테넌트예요.

stop

싱크 인스턴스를 중지해요.

Usage
pulsar-admin sinks stop options
Options
Flag 설명
--instance-id 싱크 instanceID예요. instance-id를 지정하지 않으면 Pulsar가 모든 인스턴스를 중지해요.
--name 싱크의 이름이에요.
--namespace 싱크의 네임스페이스예요.
--tenant 싱크의 테넌트예요.

start

싱크 인스턴스를 시작해요.

Usage
pulsar-admin sinks start options
Options
Flag 설명
--instance-id 싱크 instanceID예요. instance-id를 지정하지 않으면 Pulsar가 모든 인스턴스를 시작해요.
--name 싱크의 이름이에요.
--namespace 싱크의 네임스페이스예요.
--tenant 싱크의 테넌트예요.

restart

싱크 인스턴스를 재시작해요.

Usage
pulsar-admin sinks restart options
Options
Flag 설명
--instance-id 싱크 instanceID예요. instance-id를 지정하지 않으면 Pulsar가 모든 인스턴스를 재시작해요.
--name 싱크의 이름이에요.
--namespace 싱크의 네임스페이스예요.
--tenant 싱크의 테넌트예요.

localrun

Pulsar IO 싱크 커넥터를 Pulsar 클러스터에 배포하지 않고 로컬에서 실행해요.

Usage
pulsar-admin sinks localrun options
Options
Flag 설명
-a, --archive 싱크용 아카이브 파일의 절대 경로예요. 워커가 패키지를 다운로드할 수 있는 URL 경로(http/https/file [file 프로토콜은 파일이 이미 워커 호스트에 존재한다고 가정])도 지원해요.
--auto-ack 프레임워크가 메시지를 자동으로 acknowledge할지 여부예요.
--broker-service-url Pulsar 브로커의 URL이에요.
--classname 싱크의 클래스 이름이에요.
--client-auth-params 클라이언트 인증 파라미터예요.
--client-auth-plugin function-process가 브로커에 연결하는 데 사용하는 클라이언트 인증 플러그인이에요.
--cpu 싱크 인스턴스 하나당 할당할 CPU(코어 수)예요. (Docker 런타임에서만 적용돼요.)
--custom-schema-inputs 입력 토픽과 스키마 타입 또는 클래스 이름의 맵(JSON 문자열)이에요.
--max-redeliver-count 메시지가 데드 레터 큐로 보내지기 전에 재전달되는 최대 횟수예요.
--dead-letter-topic 실패한 메시지가 전송되는 데드 레터 토픽의 이름이에요.
--custom-serde-inputs 입력 토픽과 SerDe 클래스 이름의 맵(JSON 문자열)이에요.
--disk 싱크 인스턴스 하나당 할당할 디스크(바이트)예요. (Docker 런타임에서만 적용돼요.)
--hostname-verification-enabled 호스트네임 검증을 활성화할지 여부예요. 기본값: false.
-i, --inputs 싱크의 입력 토픽(들)이에요. (여러 토픽은 쉼표로 구분해 지정할 수 있어요.)
--name 싱크의 이름이에요.
--namespace 싱크의 네임스페이스예요.
--parallelism 싱크의 병렬 처리 계수, 즉 실행할 싱크 인스턴스 수예요.
--processing-guarantees 싱크에 적용되는 처리 보장(전달 의미라고도 불러요)이에요. Pulsar의 --processing-guarantees 구현은 싱크 구현에도 의존해요. 사용 가능한 값은 ATLEAST_ONCE, ATMOST_ONCE, EFFECTIVELY_ONCE예요.
--ram 싱크 인스턴스 하나당 할당할 RAM(바이트)이에요. (Docker 런타임에서만 적용돼요.)
--retain-ordering 싱크가 메시지를 순서대로 소비하고 sink 처리할지 여부예요.
--sink-config 싱크 구성 키/값이에요.
--sink-config-file 싱크의 구성을 지정하는 YAML 구성 파일의 절대 경로예요.
--sink-type 싱크의 커넥터 프로바이더예요.
--subs-name 입력 토픽 컨슈머에 특정 구독 이름을 쓰고 싶을 때의 Pulsar 소스 구독 이름이에요.
--tenant 싱크의 테넌트예요.
--timeout-ms 메시지 타임아웃(밀리초)이에요.
--negative-ack-redelivery-delay-ms 부정 acknowledge된 메시지의 재전달 지연(밀리초)이에요.
--tls-allow-insecure 안전하지 않은 TLS 연결을 허용할지 여부예요. 기본값: false.
--tls-trust-cert-path TLS 신뢰 인증서 파일 경로예요.
--topics-pattern 네임스페이스 아래에서 패턴과 일치하는 토픽 목록 중 소비할 토픽 패턴이에요. --input과 --topics-pattern은 상호 배타적이에요. 패턴에 대한 SerDe 클래스 이름은 --custom-serde-inputs에 추가하세요.
--use-tls TLS 연결을 사용할지 여부예요. 기본값: false.

available-sinks

Pulsar 클러스터가 지원하는 Pulsar IO 커넥터 싱크 목록을 가져와요.

Usage
pulsar-admin sinks available-sinks

reload

사용 가능한 내장 커넥터를 다시 로드해요.

Usage
pulsar-admin sinks reload

더 알아보기 (Learn more)