Amazon DocumentDB를 이용한 데이터베이스 접근

     `tctl` and `tsh` clients가 포함된, 서명된 Teleport macOS .pkg 설치 프로그램을 다운로드합니다:
 
     ```code
     $ curl -O https://cdn.teleport.dev/teleport-${TELEPORT_VERSION?}.pkg
     ```

     Finder에서 `pkg` 파일을 더블 클릭하여 설치를 시작합니다.
 
     

       Homebrew를 사용하여 Teleport를 설치하는 것은 지원되지 않습니다. Homebrew의
       Teleport 패키지는 Teleport에서 유지 관리하지 않으므로 신뢰성이나 보안을
       보장할 수 없습니다.
     

     ```code
     $ curl.exe -O https://cdn.teleport.dev/teleport-v${TELEPORT_VERSION?}-windows-amd64-bin.zip
     # Unzip the archive and move the `tctl` and `tsh` clients to your %PATH%
     # NOTE: Do not place the `tctl` and `tsh` clients in the System32 directory, as this can cause issues when using WinSCP.
     # Use %SystemRoot% (C:\Windows) or %USERPROFILE% (C:\Users\<username>) instead.
     ```
 
   

 
   

     Linux 설치판의 모든 Teleport 바이너리에는 `tctl` and `tsh` clients가 포함되어 있습니다.  RPM/DEB
     패키지 및 i386/ARM/ARM64용 다운로드를 포함한 더 많은 옵션은
     [설치 페이지](../installation/installation.mdx)를 참조하세요.
 
     ```code
     $ curl -O https://cdn.teleport.dev/teleport-v${TELEPORT_VERSION?}-linux-amd64-bin.tar.gz
     $ tar -xzf teleport-v${TELEPORT_VERSION?}-linux-amd64-bin.tar.gz
     $ cd teleport
     $ sudo ./install
     # Teleport binaries have been copied to /usr/local/bin
     ```
   

 

• 명령줄 클라이언트 mongosh 또는 mongo가 설치되어 있고 시스템의 PATH 환경 변수에 추가되어 있어야 합니다.
• Teleport 데이터베이스 서비스를 실행할 호스트(예: EC2 인스턴스).

Teleport cluster에 연결할 수 있는지 확인하려면 tsh login으로 로그인한 다음, 현재 자격 증명으로 tctl 명령을 실행할 수 있는지 확인합니다.

예를 들어, teleport.example.com에 cluster 내 Teleport Proxy Service의 도메인 이름을, email@example.com에 Teleport 사용자 이름을 지정하여 다음 명령을 실행합니다:

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

cluster에 연결하여 tctl status 명령을 실행할 수 있다면, 현재 자격 증명을 사용하여 워크스테이션에서 이후의 tctl 명령을 실행할 수 있습니다. 자체 Teleport cluster를 호스팅하는 경우, 전체 권한을 얻기 위해 Teleport Auth Service를 호스팅하는 컴퓨터에서 tctl 명령을 실행할 수도 있습니다.

1/6단계. Teleport 사용자 생성#

Teleport Community Edition

내장 access 역할을 가진 로컬 Teleport 사용자를 생성합니다:

$ tctl users add \
  --roles=access \
  --db-users="*" \
  --db-names="*" \
  alice

Teleport Enterprise/Enterprise Cloud

내장 access 및 requester 역할을 가진 로컬 Teleport 사용자를 생성합니다:

$ tctl users add \
  --roles=access,requester \
  --db-users="*" \
  --db-names="*" \
  alice

데이터베이스 접근 제어 및 접근 제한 방법에 대한 자세한 정보는 RBAC 문서를 참조하십시오.

2/6단계. 데이터베이스 서비스 구성 생성#

Database Service가 Teleport 클러스터에 조인하려면 유효한 조인 토큰이 필요합니다. 다음 tctl 명령을 실행하고 Database Service를 실행할 서버에서 토큰 출력을 /tmp/token에 저장합니다:

$ tctl tokens add --type=db --format=text
(=presets.tokens.first=)

Linux 서버에 Teleport Agent를 설치하려면:

권장 설치 방법은 클러스터 설치 스크립트입니다. 이 스크립트는 클러스터에 맞는 올바른 버전, 에디션, 설치 모드를 선택합니다.

1. teleport.example.com:443에 Teleport 클러스터의 호스트명과 포트를 할당하되, 스킴(https://)은 포함하지 마십시오.

2. 클러스터의 설치 스크립트를 실행하십시오:

   $ curl "https://teleport.example.com:443/scripts/install.sh" | sudo bash
   

데이터베이스 서비스를 실행 중인 노드에서 구성 파일을 생성합니다. DocumentDB 클러스터 엔드포인트와 포트를 URI로 사용하여 my-docdb.cluster-abcdefghijklm.us-east-1.docdb.amazonaws.com:27017를 교체합니다:

$ sudo teleport db configure create \
   -o file \
   --name="my-docdb" \
   --proxy=example.teleport.sh:443 \
   --protocol=mongodb \
   --token=/tmp/token \
   --uri="my-docdb.cluster-abcdefghijklm.us-east-1.docdb.amazonaws.com:27017"

이 명령은 AWS DocumentDB 클러스터를 프록시하는 데이터베이스 서비스 구성을 생성하고 구성을 /etc/teleport.yaml에 저장합니다.

3/6단계. 데이터베이스 서비스용 IAM 역할 생성#

먼저 AWS 콘솔의 IAM > Policies 페이지를 방문한 다음 "Create policy"를 클릭합니다.

Policy editor에서 JSON 옵션을 사용하여 다음 정책을 붙여넣습니다:

{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Effect": "Allow",
            "Action": [
                "rds:DescribeDBClusters"
            ],
            "Resource": "*"
        },
        {
            "Effect": "Allow",
            "Action": [
                "sts:AssumeRole"
            ],
            "Resource": "*",
            "Condition": {
                "StringEquals": {"iam:ResourceTag/TeleportDatabaseService": "Allowed"}
            }
        }
    ]
}

이 정책은 Teleport 데이터베이스 서비스가 DocumentDB 클러스터 메타데이터를 가져오고 DocumentDB 사용자로 인증하기 위해 IAM 역할을 위임(assume)할 수 있도록 허용합니다. sts:AssumeRole에는 Teleport 데이터베이스 서비스가 위임할 수 있는 IAM 역할을 제한하기 위한 리소스 태그 조건이 포함되어 있다는 점에 유의하세요.

Next를 클릭하고 정책 이름을 지정합니다. 이 가이드에서는 예시 이름으로 TeleportDatabaseAccessDocumentDB를 사용합니다.

이제 AWS 콘솔의 IAM > Roles 페이지를 방문한 다음 "Create Role"을 클릭합니다. Trusted entity type에서 "AWS service"를 선택합니다. Use case에서 "EC2" 또는 원하는 용도를 선택한 다음 Next를 클릭합니다.

"Add Permissions" 페이지에서 이전 단계에서 생성한 TeleportDatabaseAccessDocumentDB 정책을 찾아 선택합니다.

"Next"를 클릭하고 역할 이름을 지정합니다. 이 가이드에서는 이 역할에 대해 예시 이름으로 TeleportDatabaseService를 사용합니다. 이름을 선택한 후 Create Role을 클릭하여 과정을 완료합니다.

4/6단계. 데이터베이스 서비스 시작#

systemd 서비스를 생성하여 호스트가 부팅될 때 the Database Service이 자동으로 시작되도록 구성합니다. 지침은 the Database Service을 어떻게 설치했는지에 따라 다릅니다.

Package Manager

the Database Service을 실행할 호스트에서 Teleport를 활성화하고 시작합니다:

$ sudo systemctl enable teleport
$ sudo systemctl start teleport

TAR Archive

the Database Service을 실행할 호스트에서 Teleport용 systemd 서비스 구성을 생성하고, Teleport 서비스를 활성화한 후 Teleport를 시작합니다:

$ sudo teleport install systemd -o /etc/systemd/system/teleport.service
$ sudo systemctl enable teleport
$ sudo systemctl start teleport

systemctl status teleport로 the Database Service의 상태를 확인하고 journalctl -fu teleport로 로그를 볼 수 있습니다.

데이터베이스 서비스는 앞서 지정한 URI로 Amazon DocumentDB 클러스터를 프록시합니다. AWS IAM 변경 사항이 즉시 전파되지 않고 적용되기까지 몇 분 정도 걸릴 수 있다는 점에 유의하세요.

5/6단계. DocumentDB 사용자를 위한 IAM 역할 생성#

이 단계에서는 Teleport 데이터베이스 서비스가 Teleport 사용자를 대신하여 DocumentDB에 인증하기 위해 위임할 수 있는 IAM 역할을 생성합니다.

IAM 역할 생성#

AWS 웹 콘솔의 Roles 페이지로 돌아가서 새 역할을 생성합니다. "AWS account" 옵션을 선택하면 이 계정 내 다른 엔터티가 이 역할을 위임할 수 있도록 허용하는 기본 신뢰 정책이 생성됩니다:

"Next"를 클릭하여 "Add Permissions" 페이지를 건너뛰고 역할 이름을 지정합니다. 이 가이드에서는 이 역할에 대해 예시로 "teleport-docdb-user"를 사용합니다.

이제 3단계에서 Add new tag를 클릭하고 키에 TeleportDatabaseService를, 값에 Allowed를 사용합니다. 그런 다음 Create Role을 클릭하여 과정을 완료합니다.

DocumentDB 사용자 생성#

DocumentDB 클러스터에 네트워크로 접근할 수 있는 머신에서 마스터 사용자 이름과 비밀번호로 DocumentDB 클러스터에 로그인합니다. IAM 역할 ARN을 사용자 이름으로 사용하고 인증 메커니즘에 MONGODB-AWS를 지정하여 DocumentDB 사용자를 생성합니다. [aws.aws_account_id]:role/teleport-docdb-user"/>를 DocumentDB 사용자의 ARN으로 교체합니다:

use $external;
db.createUser(
    {
        user: "arn:aws:iam::(=aws.aws_account_id=):role/teleport-docdb-user",
        mechanisms: ["MONGODB-AWS"],
        roles: [ { role: "root", db: "admin" },  ]
    }
);

이 예시는 root 권한을 가진 DocumentDB IAM 사용자를 생성합니다. 필요에 따라 권한을 조정할 수 있습니다.

6/6단계 연결#

데이터베이스 서비스가 시작되어 클러스터에 참여하면 로그인하여 등록된 데이터베이스를 확인합니다:

$ tsh login --proxy=example.teleport.sh:443 --user=alice
$ tsh db ls
# Name     Description Labels
# -------- ----------- --------
# my-docdb             env=dev

데이터베이스의 자격 증명을 가져와서 teleport-docdb-user 사용자로 연결합니다:

$ tsh db connect --db-user=teleport-docdb-user --db-name=test my-docdb

데이터베이스에서 로그아웃하고 자격 증명을 제거합니다:

$ tsh db logout my-docdb

문제 해결#

Certificate error#

tsh db connect 오류에 다음 텍스트가 포함되어 있다면, 2020년 7월 28일 이전에 생성된 RDS 또는 DocumentDB 데이터베이스일 가능성이 높으며, 이 경우 Teleport와 호환되지 않는 X.509 인증서를 제공합니다.

x509: certificate relies on legacy Common Name field, use SANs instead

AWS는 SSL/TLS 인증서를 교체하는 방법에 대한 지침을 제공합니다.

No credential providers error#

Database Service 로그에서 NoCredentialProviders: no valid providers in chain 오류가 보인다면, Teleport가 AWS IAM 권한을 통해 연결하는 데 필요한 자격 증명을 감지하지 못하는 것입니다. Teleport Database Service를 실행하는 머신에 자격 증명 또는 보안 역할이 적용되었는지 확인합니다.

EKS에서 실행할 때, 워커 노드 인스턴스의 PUT 요청 홉 한도가 1로 설정되어 있어 Teleport Database Service가 IMDSv2에 접근할 수 없는 경우 이 오류가 발생할 수 있습니다. 다음 명령을 사용하여 홉 한도를 확인할 수 있습니다:

$ aws ec2 describe-instances --instance-ids <node-instance-id> | grep HttpPutResponseHopLimit
                        "HttpPutResponseHopLimit": 1,

자세한 내용은 EKS의 IMDSv2 지원과 EKS 모범 사례를 참조하십시오.

Timeout errors#

Teleport Database Service는 데이터베이스 엔드포인트로의 연결이 필요합니다.

방화벽 규칙(예: AWS 보안 그룹)이 Teleport Database Service와 데이터베이스 엔드포인트 간의 연결을 허용하는지 확인하세요.

• 데이터베이스에 대한 인바운드 방화벽 규칙은 Teleport Database Service로부터의 연결을 허용해야 합니다.
• Teleport Database Service에 대한 아웃바운드 방화벽 규칙은 데이터베이스 엔드포인트로의 연결을 허용해야 합니다.

$ nc -zv database-host database-port
# Connection to postgres-instance-1.sadas.us-east-1.rds.amazonaws.com (172.31.24.172) 5432 port [tcp/postgresql] succeeded!

데이터베이스가 동적으로 또는 자동 검색을 통해 등록된 경우, 이 데이터베이스를 프록시하는 모든* Teleport Database Service 인스턴스에 대해 위의 연결 테스트를 반복하세요. 주어진 데이터베이스와 연결된 모든 Teleport Database Service 인스턴스를 나열하려면 tctl get db_server/<db_name> 명령을 실행하세요. 예를 들어:

$ tctl get db_server/postgres-instance-1 --format json | jq '.[] | {hostname: .spec.hostname, host_id: .spec.host_id, version: .spec.version, target_health: .status.target_health}'
{
  "hostname": "ip-10-0-0-111.ca-central-1.compute.internal",
  "host_id": "e5e670ac-a7b8-44ef-b373-6296d87f50e8",
  "version": "18.3.0",
  "target_health": {
    "status": "unhealthy",
    ...
  }
}
{
  "hostname": "ip-10-0-0-222.ca-central-1.compute.internal",
  ...
}

여기에 나열된 Database Service 인스턴스 중 데이터베이스를 프록시해서는 안 되는 인스턴스가 있는 경우(예: 연결이 되지 않는 다른 VPC 또는 AWS 리전에 있는 Database Service 인스턴스), 해당 구성을 찾아 도달할 수 있는 데이터베이스만 수신하거나 검색하도록 업데이트하세요. 대부분의 경우 vpc-id 레이블을 추가하는 등 태그 필터를 세분화하여 이를 달성할 수 있습니다.

Not authorized to perform sts:AssumeRole#

Database Service는 다음 상황 중 하나에서 IAM 역할을 맡습니다.

• Teleport 사용자가 IAM 역할을 데이터베이스 사용자로 요구하는 AWS 서비스에 접근할 때, 사용하려는 데이터베이스 사용자로 IAM 역할을 지정하는 경우. IAM 역할을 데이터베이스 사용자로 사용할 수 있는 데이터베이스에는 DynamoDB, Keyspaces, Opensearch, Redshift, Redshift Serverless가 있습니다.
• 데이터베이스 리소스 또는 동적 리소스 매처에 assume_role_arn 필드가 지정된 경우.

IAM 역할 간의 신뢰 관계가 올바르게 구성되지 않은 경우 다음과 같은 오류가 발생할 수 있습니다.

AccessDenied: User: arn:aws:sts::111111111111:assumed-role/teleport-db-service-role/i-* is not authorized to perform: sts:AssumeRole on resource: arn:aws:iam::111111111111:role/db-user-role

{
  "Version": "2012-10-17",
  "Statement": [
    {
      "Effect": "Allow",
      "Principal": {
        "AWS": "arn:aws:iam::aws-account-id:role/teleport-db-service-role"
      },
      "Action": "sts:AssumeRole"
    }
  ]
}

{
  "Version": "2012-10-17",
  "Statement": [
    {
      "Effect": "Allow",
      "Principal": {
        "AWS": "arn:aws:iam::aws-account-id:root"
      },
      "Action": "sts:AssumeRole"
    }
  ]
}

{
  "Version": "2012-10-17",
  "Statement": [
    {
      "Effect": "Allow",
      "Principal": {
        "AWS": "arn:aws:iam::external-aws-account-id:role/teleport-db-service-role"
      },
      "Action": "sts:AssumeRole",
      "Condition": {
        "StringEquals": {
          "sts:ExternalId": "example-external-id"
        }
      }
    }
  ]
}

{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Action": "sts:AssumeRole",
            "Effect": "Allow",
            "Resource": "arn:aws:iam::aws-account-id:role/db-user-role"
        }
    ]
}

{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Action": "sts:AssumeRole",
            "Effect": "Allow",
            "Resource": "*"
        }
    ]
}

teleport-db-service-role로 다음 AWS CLI 명령을 실행하여 신뢰 관계를 테스트할 수 있습니다.

$ aws sts assume-role --role-arn arn:aws:iam::111111111111:role/db-user-role --role-session-name test-trust-relationship

IAM 역할에서 신뢰 정책을 사용하는 방법에 대해 자세히 알아보세요.

"MONGODB-AWS" 메커니즘을 사용하여 인증할 수 없음 오류#

IAM 인증이 실패하면 다음과 같은 오류가 발생할 수 있습니다:

$ tsh db connect --db-user=teleport-docdb-user --db-name=test my-docdb
...
MongoServerSelectionError: error connecting to the database
	connection() error occurred during connection handshake: auth error: sasl conversation error: unable to authenticate using mechanism "MONGODB-AWS":  Authentication failed.
ERROR: exit status 1

대상 DocumentDB 클러스터의 "$external" 데이터베이스에 IAM 역할이 DocumentDB 사용자로 존재하는지, 그리고 DocumentDB 사용자가 인증 메커니즘으로 MONGODB-AWS로 구성되어 있는지 확인하세요.

자세한 내용은 IAM 아이덴티티를 이용한 인증을 참조하세요.

다음 단계#

• 특정 사용자 및 데이터베이스에 대한 접근을 제한하는 방법을 알아보십시오.

• 고가용성 (HA) 가이드를 확인하십시오.

• YAML 구성 레퍼런스를 살펴보십시오.

• 전체 CLI 레퍼런스를 참조하십시오.

• 자세한 내용은 DocumentDB용 IAM 아이덴티티를 이용한 인증에 대해 자세히 알아보세요.