이 참조는 Database Service 관리를 위한 일반적인 명령을 실행하는 방법을 보여줍니다:

• Teleport Database Service를 실행할 호스트에서 실행되는 teleport 데몬 명령.

• Teleport 클러스터에 알려진 데이터베이스를 나타내는 db 리소스를 관리하는 데 사용하는 tctl 관리 도구.

To check that you can connect to your Teleport cluster, sign in with tsh login, then verify that you can run tctl commands using your current credentials.

For example, run the following command, assigning to the domain name of the Teleport Proxy Service in your cluster and to your Teleport username:

$ tsh login --proxy= --user=
$ tctl status
# Cluster  (=teleport.url=)
# Version  (=teleport.version=)
# CA pin   (=presets.ca_pin=)

If you can connect to the cluster and run the tctl status command, you can use your current credentials to run subsequent tctl commands from your workstation. If you host your own Teleport cluster, you can also run tctl commands on the computer that hosts the Teleport Auth Service for full permissions.

• 클러스터의 데이터베이스에 접근하기 위해 최종 사용자가 실행하는 tsh 클라이언트 도구.

teleport db start#

Teleport Database Service를 시작합니다.

$ teleport db start \
    --token=/path/to/token \
    --auth-server=proxy.example.com:443 \
    --name=example \
    --protocol=postgres \
    --uri=postgres.example.com:5432

$ teleport db start \
    --token=/path/to/token \
    --auth-server=mytenant.teleport.sh:443 \
    --name=example \
    --protocol=postgres \
    --uri=postgres.mytenant.teleport.sh:5432

teleport db configure create#

샘플 Database Service 구성을 만듭니다.

$ teleport db configure create --rds-discovery=us-west-1 --rds-discovery=us-west-2
$ teleport db configure create \
  --token=/tmp/token \
  --proxy=proxy.example.com:443 \
  --name=example \
  --protocol=postgres \
  --uri=postgres://postgres.example.com:5432 \
  --labels=env=prod

$ teleport db configure create --rds-discovery=us-west-1 --rds-discovery=us-west-2
$ teleport db configure create \
  --token=/tmp/token \
  --proxy=mytenant.teleport.sh:443 \
  --name=example \
  --protocol=postgres \
  --uri=postgres://postgres.mytenant.teleport.sh:5432 \
  --labels=env=prod

teleport db configure bootstrap#

Database Service에 필요한 구성을 부트스트랩합니다. 제공된 구성을 읽어 부트스트랩할 내용을 결정합니다.

$ teleport db configure bootstrap -c /etc/teleport.yaml --attach-to-user TeleportUser
$ teleport db configure bootstrap -c /etc/teleport.yaml --attach-to-role TeleportRole
$ teleport db configure bootstrap -c /etc/teleport.yaml --manual

teleport db configure aws print-iam#

제공된 데이터베이스 유형을 기반으로 Database Service에 필요한 IAM 권한을 출력합니다.

$ teleport db configure aws print-iam --types rds
$ teleport db configure aws print-iam --types rds,redshift --role my-db-service-role
$ teleport db configure aws print-iam --types redshift-serverless --assumes-roles my-access-role --policy

tctl auth sign#

--format=db(MongoDB의 경우 --format=mongodb) 플래그와 함께 호출될 때 셀프 호스팅 데이터베이스 인스턴스로 Database Service를 구성하는 데 사용되는 CA 인증서, 클라이언트 인증서 및 개인 키 파일을 생성합니다.

$ tctl auth sign --format=db --host=db.example.com --out=db --ttl=2190h
$ tctl auth sign --format=db --host=host1,localhost,127.0.0.1 --out=db --ttl=2190h

이 예에서 db.example.com은 Teleport Database Service가 데이터베이스 서버에 도달할 수 있는 호스트명입니다. 두 번째 예는 Teleport와 동일한 호스트에서 실행되는 데이터베이스를 가정합니다.

kind: role
version: v5
metadata:
  name: db-impersonator
spec:
  options:
  allow:
    impersonate:
      users: ['Db']
      roles: ['Db']

$ tctl create -f db-impersonator.yaml

$ TELEPORT_USER=<your user>
$ tctl edit user/${TELEPORT_USER?}

spec:
   - access
   - auditor
   - editor
+  - db-impersonator
   status:
     is_locked: false

tctl db ls#

클러스터에 등록된 모든 데이터베이스를 나열하는 관리 명령.

$ tctl db ls
$ tctl db ls --format=yaml

tctl get db#

구성된 모든 데이터베이스 리소스 목록을 출력합니다.

tctl get db/database-resource-name#

database-resource-name 데이터베이스 리소스에 대한 세부 정보를 출력합니다.

tctl rm db/database-resource-name#

database-resource-name이라는 데이터베이스 리소스를 제거합니다.

tsh db ls#

RBAC 및 연결 정보를 기반으로 사용자가 사용 가능한 데이터베이스를 나열합니다.

# 모든 데이터베이스 나열.
$ tsh db ls
# 키워드로 데이터베이스 검색.
$ tsh db ls --search foo,bar
# 레이블로 데이터베이스 필터링.
$ tsh db ls key1=value1,key2=value2
# 추가 필드와 함께 모든 클러스터의 데이터베이스 나열.
$ tsh db ls --all -v
# "jq"를 사용하여 데이터베이스 이름 가져오기.
$ tsh db ls --format json  | jq -r '.[].metadata.name'

tsh db login#

데이터베이스 자격 증명을 검색합니다.

$ tsh db login example
$ tsh db login --db-user=postgres --db-name=postgres example

If --db-user or --db-name are required, then default settings are chosen from either an active database certificate obtained via a prior use of tsh db login or from the user's allowed db_users or db_names.

The database user is always required. The database name is required for PostgreSQL, MongoDB, and Oracle databases.

tsh db logout#

데이터베이스 자격 증명을 제거합니다.

$ tsh db logout example
$ tsh db logout

tsh db connect#

CLI 클라이언트를 사용하여 데이터베이스에 연결합니다.

# 단일 데이터베이스에만 로그인된 경우 단축 구문.
$ tsh db connect
# 연결할 데이터베이스 서비스를 명시적으로 지정합니다.
$ tsh db connect example
# 연결할 데이터베이스 사용자 및 이름을 제공합니다.
$ tsh db connect --db-user=alice --db-name=db example
# 허용된 데이터베이스 역할의 하위 집합을 선택합니다.
$ tsh db connect --db-user=alice --db-name=db --db-roles reader example

If --db-user or --db-name are required, then default settings are chosen from either an active database certificate obtained via a prior use of tsh db login or from the user's allowed db_users or db_names.

The database user is always required. The database name is required for PostgreSQL, MongoDB, and Oracle databases.

tsh db exec#

대상 데이터베이스 서비스에서 데이터베이스 명령을 실행합니다.

# 레이블로 데이터베이스 검색.
$ tsh db exec "source my_script.sql" --db-user mysql --labels key1=value1,key2=value2
# 키워드로 데이터베이스 검색.
$ tsh db exec "select 1" --db-user mysql --db-name mysql --search foo,bar
# 확인 없이 지정된 대상 데이터베이스에서 명령 실행.
$ tsh db exec "select @@hostname" --db-user mysql --dbs mydb1,mydb2,mydb3 --no-confirm
# 병렬로 명령을 실행하고 출력을 파일에 저장합니다.
$ tsh db exec "select 1" --db-user mysql --labels env=dev --parallel=5 --output-dir=exec-outputs

tsh db env#

특정 데이터베이스에 대한 환경 변수를 출력합니다.

$ tsh db env
$ tsh db env example
$ eval $(tsh db env)

tsh db config#

데이터베이스 연결 정보를 출력합니다. GUI 클라이언트 구성 시 유용합니다.

$ tsh db config
$ tsh db config example
$ tsh db config --format=cmd example