InfoGrab DocsInfoGrab Docs

Terraform 데이터베이스 자동 검색

요약

이 가이드에서는 Terraform을 사용하여 Amazon 데이터베이스를 검색하도록 Teleport를 구성하고, 해당 데이터베이스에 대한 접근을 제공하는 Teleport Database Service를 Amazon Elastic Container Service(EC...

이 가이드에서는 Terraform을 사용하여 Amazon 데이터베이스를 검색하도록 Teleport를 구성하고, 해당 데이터베이스에 대한 접근을 제공하는 Teleport Database Service를 Amazon Elastic Container Service(ECS)에 배포하는 방법을 설명합니다.

Teleport Terraform 모듈은 현재 다음 Amazon 데이터베이스를 지원합니다.

  • RDS Aurora
  • RDS MySQL
  • RDS Postgres

작동 방식#

teleport-discovery-aws Terraform 모듈은 AWS IAM 리소스, AWS OIDC 연동, 그리고 Teleport Discovery Service가 AWS의 데이터베이스를 검색할 때 사용하는 Teleport discovery_config를 생성합니다.

Teleport Cloud에서는 Discovery Service를 대신 실행합니다. 셀프 호스팅 Teleport 클러스터에서는 모듈이 구성한 그룹과 일치하는 discovery_group으로 Discovery Service를 직접 실행해야 합니다.

teleport-agent-aws Terraform 모듈은 Teleport Database Service를 ECS 서비스로 배포합니다. 이 모듈은 ECS 클러스터와 서비스, 작업 IAM 역할, CloudWatch 로그 그룹, 보안 그룹, Teleport IAM 조인 토큰을 생성합니다. 기본적으로 Database Service는 동일한 AWS 계정, 리전, VPC에 있는 검색된 데이터베이스를 선택합니다.

Discovery Service는 Teleport 프록시와 AWS API에만 접근할 수 있으면 되며, 데이터베이스에 대한 네트워크 접근은 필요하지 않습니다.

Database Service는 다음에 접근할 수 있어야 합니다.

  1. Teleport 클러스터의 공개 프록시 엔드포인트
  2. AWS 데이터베이스 엔드포인트

사전 요구사항#

  • 실행 중인 Teleport 클러스터. Teleport를 시작하려면 무료 체험판에 가입하거나 데모 환경을 구성하세요.

  • tctl and tsh clients.

    Installing `tctl` and `tsh` clients
    1. Teleport 클러스터의 버전을 확인합니다. tctl and tsh clients는 Teleport 클러스터 버전보다 최대 한 개의 메이저 버전까지만 뒤처질 수 있습니다. Proxy Service의 /v1/webapi/find로 GET 요청을 보내고 JSON 쿼리 도구를 사용하여 클러스터 버전을 확인합니다. teleport.example.com:443를 Teleport Proxy Service의 웹 주소로 바꿉니다:

      $ TELEPORT_DOMAIN=teleport.example.com:443
      $ TELEPORT_VERSION="$(curl -s https://$TELEPORT_DOMAIN/v1/webapi/find | jq -r '.server_version')"
      
    2. 사용 중인 플랫폼에 대한 지침에 따라 tctl and tsh clients를 설치합니다:

Mac

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

     Finder에서 `pkg` 파일을 더블 클릭하여 설치를 시작합니다.
 
     
Warning
       Homebrew를 사용하여 Teleport를 설치하는 것은 지원되지 않습니다. Homebrew의
       Teleport 패키지는 Teleport에서 유지 관리하지 않으므로 신뢰성이나 보안을
       보장할 수 없습니다.
     

Windows - Powershell

     ```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

     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
     ```
   

 
  • Terraform 1.5.7 이상.
  • RDS 또는 Aurora 데이터베이스가 하나 이상 있는 AWS 계정.
  • Database Service를 배포할 VPC와 인터넷 송신(egress)이 가능한 서브넷 하나 이상. 퍼블릭 서브넷은 AWS 인터넷 게이트웨이를 통하는 기본 경로가 있어야 하고, 프라이빗 서브넷은 AWS NAT 게이트웨이를 통하는 기본 경로가 있어야 합니다.
  • AWS Terraform 프로바이더용 AWS 자격 증명.
  • Teleport Terraform 프로바이더용 Teleport 자격 증명. 로컬에서 Terraform을 실행하는 경우 Teleport Terraform 프로바이더 로컬 데모를 따릅니다.

이 가이드는 Database Service를 데이터베이스와 동일한 AWS 계정, 리전, VPC에 배포합니다. 다른 AWS 계정의 데이터베이스에 접근하려면 모듈의 기본 리소스 매처 대신 database_service.resources와 필요한 교차 계정 IAM 역할을 구성합니다.

1/6단계. Discovery Service 준비#

Teleport Cloud는 cloud-discovery-group 그룹에서 Discovery Service를 실행합니다. Discovery Service를 별도로 설치할 필요가 없습니다.

Teleport 프록시 서비스에 접근할 수 있는 호스트에 Teleport를 설치합니다. 호스트는 AWS API에 대한 네트워크 접근이 필요하지만, 데이터베이스에 대한 네트워크 접근은 필요하지 않습니다.

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

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

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

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

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

Discovery Service용 조인 토큰을 생성합니다.

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

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

호스트에 /etc/teleport.yaml을 생성합니다. teleport.example.com:443에는 Teleport 프록시 서비스의 공개 주소를 지정합니다.

version: v3
teleport:
  join_params:
    token_name: "/tmp/token"
    method: token
  proxy_server: "teleport.example.com:443"
auth_service:
  enabled: false
proxy_service:
  enabled: false
ssh_service:
  enabled: false
discovery_service:
  enabled: true
  discovery_group: "aws-databases"

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

Package Manager

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

$ sudo systemctl enable teleport
$ sudo systemctl start teleport

TAR Archive

the Discovery 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 Discovery Service의 상태를 확인하고 journalctl -fu teleport로 로그를 볼 수 있습니다.

2/6단계. Terraform 프로바이더 구성#

VPC와 데이터베이스가 있는 리전으로 AWS Terraform 프로바이더를 구성합니다.

Terraform 구성에 AWS 및 Teleport 프로바이더를 추가합니다.

terraform {
  required_version = ">= 1.5.7"

  required_providers {
    aws = {
      source = "hashicorp/aws"
      version = "~> 6.0"
    }
    teleport = {
      source = "terraform.releases.teleport.dev/gravitational/teleport"
      version = "~> 18.0"
    }
  }
}

provider "aws" {
  region = "us-east-1"
}

provider "teleport" {}

클러스터의 자격 증명으로 Teleport Terraform 프로바이더를 구성합니다. 로컬에서 Terraform을 실행하는 경우, Terraform을 실행할 동일한 셸에서 Teleport에 로그인하고 프로바이더용 자격 증명을 내보냅니다.

$ tsh login
$ eval "$(tctl terraform env)"

CI/CD 및 기타 원격 실행 환경에서는 Teleport Terraform 프로바이더 사용하기를 따라 Machine ID 또는 워크로드 아이덴티티 자격 증명을 구성합니다.

3/6단계. Terraform 모듈 구성#

Terraform 구성에 두 모듈과 보안 그룹 인그레스 규칙을 추가합니다.

module "aws_discovery" {
  source  = "terraform.releases.teleport.dev/teleport/discovery/aws"
  version = "~> (=cloud.major_version=).0"

  teleport_proxy_public_addr    = "example.teleport.sh:443"
  teleport_discovery_group_name = "cloud-discovery-group"

  aws_matchers = [{
    types   = ["rds"]
    regions = ["us-east-1"]
    tags    = { "*" = ["*"] }
  }]
}

module "teleport_db_agent" {
  source  = "terraform.releases.teleport.dev/teleport/agent/aws"
  version = "~> (=cloud.major_version=).0"

  teleport_proxy_public_addr = "example.teleport.sh:443"
  database_service = {
    allow_database_modification       = true
    database_security_group_ids       = [
      "sg-0123456789abcdef0",
    ]
    default_iam_policy_database_types = ["rds"]
    enabled                           = true
  }
  vpc_id                     = "vpc-0123456789abcdef0"
  private_subnet_ids = [
    "subnet-0123456789abcdef0",
    "subnet-abcdef01234567890",
  ]
}
module "aws_discovery" {
  source  = "terraform.releases.teleport.dev/teleport/discovery/aws"
  version = "~> (=teleport.major_version=).0"

  teleport_proxy_public_addr    = "teleport.example.com:443"
  teleport_discovery_group_name = "aws-databases"

  aws_matchers = [{
    types   = ["rds"]
    regions = ["us-east-1"]
    tags    = { "*" = ["*"] }
  }]
}

module "teleport_db_agent" {
  source  = "terraform.releases.teleport.dev/teleport/agent/aws"
  version = "~> (=teleport.major_version=).0"

  teleport_proxy_public_addr = "teleport.example.com:443"
  database_service = {
    allow_database_modification       = true
    database_security_group_ids       = [
      "sg-0123456789abcdef0",
    ]
    default_iam_policy_database_types = ["rds"]
    enabled                           = true
  }
  vpc_id                     = "vpc-0123456789abcdef0"
  private_subnet_ids = [
    "subnet-0123456789abcdef0",
    "subnet-abcdef01234567890",
  ]
}

VPC, 서브넷, 보안 그룹, 리전 값을 사용자의 AWS 환경에 맞는 값으로 바꿉니다. 각 데이터베이스 보안 그룹 ID를 database_service.database_security_group_ids에 포함합니다. AWS NAT 게이트웨이를 통하는 기본 경로가 있는 서브넷에는 private_subnet_ids를 사용하고, AWS 인터넷 게이트웨이를 통하는 기본 경로가 있는 서브넷에는 이를 public_subnet_ids로 바꿔 사용합니다.

검색 모듈의 aws_matchers 입력은 Teleport에 등록할 데이터베이스를 제어합니다. 이 예시는 구성된 리전의 모든 RDS 및 Aurora 데이터베이스를 검색합니다. 특정 AWS 태그가 있는 데이터베이스로 검색을 제한하려면 와일드카드 tags 셀렉터를 바꿉니다.

에이전트 모듈의 기본 Database Service 리소스 매처는 account-id, region, vpc-id 라벨이 ECS 서비스가 실행되는 AWS 계정, 리전, VPC와 일치하는 등록된 데이터베이스를 선택합니다.

database_service 객체에 default_iam_policy_database_types = ["rds"]를 설정하면 RDS 데이터베이스를 조회하고 IAM 인증으로 연결하는 권한이 추가됩니다. 같은 객체에 allow_database_modification = true를 설정하면 Database Service가 IAM 데이터베이스 인증을 활성화하는 것도 허용됩니다. 기본 정책은 해당하는 모든 리소스에 대해 이러한 RDS 작업을 허용합니다. 프로덕션 배포에서 권한을 제한하려면 ecs_task_role_inline_policy에 정책 문서를 전달합니다. SID가 RDSAutoEnableIAMAuth, RDSConnect, RDSFetchMetadata인 구문은 해당하는 기본 구문을 덮어씁니다.

검색 모듈은 기본적으로 AWS OIDC 연동을 사용합니다. AWS가 OIDC 아이덴티티 공급자로 사용할 수 있도록 셀프 호스팅 클러스터의 공개 프록시 주소는 HTTPS로 접근할 수 있어야 합니다. 프록시에 공개적으로 접근할 수 없다면, 대신 Discovery Service에서 사용할 수 있는 AWS IAM 역할을 사용하도록 discovery_service_iam_credential_source를 구성합니다.

AWS는 계정 내에서 동일한 공급자 URL에 대해 하나의 IAM OIDC 공급자만 허용합니다. 계정에 이 Teleport 클러스터용 IAM OIDC 공급자가 이미 있다면, 검색 모듈에서 create_aws_iam_openid_connect_provider = false를 설정합니다.

4/6단계. Terraform 구성 적용#

Terraform을 초기화하고 계획을 검토합니다.

$ terraform init
$ terraform apply

검색 모듈은 다음 리소스를 계획해야 합니다.

  • RDS 검색을 위한 AWS IAM 역할 및 정책.
  • AWS IAM OIDC 공급자 및 Teleport AWS OIDC 연동.
  • 선택한 RDS 데이터베이스를 위한 Teleport discovery_config.

에이전트 모듈은 다음 리소스를 계획해야 합니다.

  • ECS 클러스터, 작업 정의, 서비스.
  • ECS 작업 및 실행 IAM 역할.
  • CloudWatch 로그 그룹.
  • 아웃바운드 트래픽을 허용하는 보안 그룹.
  • ECS 작업 역할로 제한된 Teleport IAM 조인 토큰.

계획에는 RDS 보안 그룹에 대한 인바운드 규칙도 포함되어야 합니다. 계획을 주의 깊게 검토한 후 승인합니다.

ECS 서비스는 기본적으로 Database Service 작업 두 개를 실행합니다. 작업은 AWS IAM 아이덴티티로 Teleport 클러스터에 조인하므로, 모듈은 ECS 작업 정의에 비밀 조인 토큰을 저장하지 않습니다.

5/6단계. 데이터베이스 검색 확인#

Discovery Service는 일치하는 데이터베이스를 Teleport db 리소스로 등록합니다.

등록된 데이터베이스를 나열합니다.

$ tctl get db

Discovery Service는 등록하는 각 데이터베이스에 teleport.dev/origin: cloud 라벨을 추가합니다. 출력에 구성된 AWS 계정과 리전의 RDS 데이터베이스가 포함되어 있는지 확인합니다.

예상한 데이터베이스가 없다면 Teleport 웹 UI의 Zero Trust Access > Integrations에서 검색 연동을 확인한 다음, Discovery Service 문제 해결 섹션을 참조합니다.

6/6단계. Database Service 확인#

ECS 작업이 시작되어 등록된 데이터베이스와 일치하면, 작업은 수명이 짧은 Teleport db_server 리소스를 생성합니다. Database Service가 제공하는 데이터베이스를 나열합니다.

$ tctl db ls teleport.dev/origin=cloud,teleport.dev/cloud=AWS,region=us-east-1

명령이 예상한 RDS 데이터베이스를 나열하면 자동 검색과 Database Service가 올바르게 구성된 것입니다.

tctl get db에는 데이터베이스가 나열되지만 tctl db ls에는 나열되지 않는다면, Amazon ECS 콘솔을 열고 CloudWatch 로그 그룹의 작업 로그를 확인합니다. 또한 VPC 경로, RDS 보안 그룹 규칙, 리소스 라벨, ECS 작업 IAM 권한을 확인합니다. 추가 확인 사항은 Database Service 문제 해결을 참조합니다.

Note

이 가이드는 RDS 자동 검색을 구성하고 Database Service를 배포합니다. 데이터베이스 사용자를 프로비저닝하거나 해당 사용자에 대한 Teleport RBAC를 구성하지는 않습니다. 데이터베이스에 연결하기 전에 AWS 데이터베이스 등록의 해당 가이드를 따릅니다.

다음 단계#

문제 해결#

Note

이 섹션의 내용은 원문 문서를 참조하세요. (tctl-discovery-status.mdx)

Note

이 섹션의 내용은 원문 문서를 참조하세요. (tctl-discovery-databases.mdx)

Discovery Service 문제 해결#

먼저 database가 검색되었는지 확인합니다. 이를 위해 tctl get db 명령을 사용하여 예상되는 database가 이미 Teleport 클러스터에 등록되었는지 확인할 수 있습니다.

일부 database가 목록에 나타나지 않는다면, Discovery Service 셀렉터 레이블이 누락된 database 태그와 일치하는지 확인하거나 Discovery Service 로그에서 권한 오류를 살펴보십시오.

Discovery Service가 올바른 AWS 계정의 자격 증명으로 실행되고 있는지 확인합니다. 다른 AWS 계정의 리소스를 검색할 수 있지만, 그런 경우에는 해당 다른 AWS 계정에서 역할을 assume하도록 구성되어 있어야 합니다.

둘 이상의 Discovery Service가 실행 중인지 확인합니다:

$ tctl inventory status --connected

여러 Discovery Service를 실행하는 경우, 동일한 클라우드 database를 감시하는 서비스들은 모두 동일한 discovery_group 값으로 구성하고, 서로 다른 클라우드 database를 감시하는 서비스들은 서로 다른 값으로 구성해야 합니다. 이것이 올바르게 구성되지 않으면, 일반적인 증상으로 db 리소스가 Teleport 클러스터의 레지스트리에서 간헐적으로 삭제됩니다.

Database Service 문제 해결#

tctl db ls에 데이터베이스가 나타나지 않음#

tctl get db 명령이 예상한 검색된 데이터베이스를 반환하지만 tctl db ls 명령에는 포함되지 않는 경우, db_service.resources 섹션이 올바르게 설정되어 있는지 확인하세요. 예를 들면 다음과 같습니다:

db_service:
  enabled: true
  resources:
  - labels:
      "env": "prod"

섹션이 올바르게 구성되어 있는데도 데이터베이스가 여전히 나타나지 않는다면, Teleport에서 데이터베이스를 나열할 올바른 권한이 있는지 확인하세요. 데이터베이스 레이블과 일치하고 db 및 db_server 오브젝트에 대해 "read" 및 "list" verb를 허용하는 Teleport 역할이 있어야 합니다. 다음은 클러스터의 모든 데이터베이스에 대해 해당 권한을 부여하는 예시입니다:

kind: role
version: v6
metadata:
  name: view-all-databases
spec:
  allow:
    db_labels:
      '*': '*'
    rules:
      - resources: [db_server, db]
        verbs: [read, list]

데이터베이스에 연결할 때 오류 발생#

Note

이 섹션에서는 Enroll AWS Databases의 특정 가이드를 따라 이미 데이터베이스 사용자를 프로비저닝하고 해당 데이터베이스 사용자에 대한 Teleport RBAC를 구성했다고 가정합니다.

데이터베이스에 연결하려고 할 때 연결 오류가 발생하면, 먼저 대상 데이터베이스에 대해 여러 개의 db_server 하트비트 리소스가 있는지 확인하세요: tctl get db_server/yourDatabaseName. 여러 개가 있다면 여러 Teleport Database Service 인스턴스가 데이터베이스를 프록시하고 있다는 의미이며, 이는 문제 해결을 복잡하게 만드는 HA 구성입니다. Teleport는 연결을 프록시할 Database Service 인스턴스 중 하나를 무작위로 선택하며, 그중 하나가 데이터베이스 엔드포인트에 연결할 수 없거나 권한이 부족한 경우 무작위 연결 오류가 발생합니다.

연결 오류가 일관되게 발생하더라도, 오류를 해결하는 동안에는 대상 db와 일치하는 인스턴스가 하나만 남도록 Teleport Database Service 인스턴스를 축소하거나 재구성해야 합니다. tctl get db_server/yourDatabaseName으로 db_server가 하나만 있는지 확인한 다음 다시 연결을 시도하세요.

DEBUG 레벨 로깅을 활성화한 상태에서 Teleport Database Service 로그를 확인하고 네트워크 또는 권한 오류를 찾아보세요.

보다 일반적인 문제 해결 단계는 Database Service 문제 해결 가이드를 참고하세요.

또한 Enroll AWS Databases에서 데이터베이스 유형에 특화된 가이드에 더 구체적인 문제 해결 정보가 있을 수 있습니다.

Terraform 데이터베이스 자동 검색

Teleport v18.11
원문 보기

요약

이 가이드에서는 Terraform을 사용하여 Amazon 데이터베이스를 검색하도록 Teleport를 구성하고, 해당 데이터베이스에 대한 접근을 제공하는 Teleport Database Service를 Amazon Elastic Container Service(EC...

이 가이드에서는 Terraform을 사용하여 Amazon 데이터베이스를 검색하도록 Teleport를 구성하고, 해당 데이터베이스에 대한 접근을 제공하는 Teleport Database Service를 Amazon Elastic Container Service(ECS)에 배포하는 방법을 설명합니다.

Teleport Terraform 모듈은 현재 다음 Amazon 데이터베이스를 지원합니다.

  • RDS Aurora
  • RDS MySQL
  • RDS Postgres

작동 방식#

teleport-discovery-aws Terraform 모듈은 AWS IAM 리소스, AWS OIDC 연동, 그리고 Teleport Discovery Service가 AWS의 데이터베이스를 검색할 때 사용하는 Teleport discovery_config를 생성합니다.

Teleport Cloud에서는 Discovery Service를 대신 실행합니다. 셀프 호스팅 Teleport 클러스터에서는 모듈이 구성한 그룹과 일치하는 discovery_group으로 Discovery Service를 직접 실행해야 합니다.

teleport-agent-aws Terraform 모듈은 Teleport Database Service를 ECS 서비스로 배포합니다. 이 모듈은 ECS 클러스터와 서비스, 작업 IAM 역할, CloudWatch 로그 그룹, 보안 그룹, Teleport IAM 조인 토큰을 생성합니다. 기본적으로 Database Service는 동일한 AWS 계정, 리전, VPC에 있는 검색된 데이터베이스를 선택합니다.

Discovery Service는 Teleport 프록시와 AWS API에만 접근할 수 있으면 되며, 데이터베이스에 대한 네트워크 접근은 필요하지 않습니다.

Database Service는 다음에 접근할 수 있어야 합니다.

  1. Teleport 클러스터의 공개 프록시 엔드포인트
  2. AWS 데이터베이스 엔드포인트

사전 요구사항#

  • 실행 중인 Teleport 클러스터. Teleport를 시작하려면 무료 체험판에 가입하거나 데모 환경을 구성하세요.

  • tctl and tsh clients.

    Installing `tctl` and `tsh` clients
    1. Teleport 클러스터의 버전을 확인합니다. tctl and tsh clients는 Teleport 클러스터 버전보다 최대 한 개의 메이저 버전까지만 뒤처질 수 있습니다. Proxy Service의 /v1/webapi/find로 GET 요청을 보내고 JSON 쿼리 도구를 사용하여 클러스터 버전을 확인합니다. teleport.example.com:443를 Teleport Proxy Service의 웹 주소로 바꿉니다:

      $ TELEPORT_DOMAIN=teleport.example.com:443
      $ TELEPORT_VERSION="$(curl -s https://$TELEPORT_DOMAIN/v1/webapi/find | jq -r '.server_version')"
      
    2. 사용 중인 플랫폼에 대한 지침에 따라 tctl and tsh clients를 설치합니다:

Mac

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

     Finder에서 `pkg` 파일을 더블 클릭하여 설치를 시작합니다.
 
     
Warning
       Homebrew를 사용하여 Teleport를 설치하는 것은 지원되지 않습니다. Homebrew의
       Teleport 패키지는 Teleport에서 유지 관리하지 않으므로 신뢰성이나 보안을
       보장할 수 없습니다.
     

Windows - Powershell

     ```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

     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
     ```
   

 
  • Terraform 1.5.7 이상.
  • RDS 또는 Aurora 데이터베이스가 하나 이상 있는 AWS 계정.
  • Database Service를 배포할 VPC와 인터넷 송신(egress)이 가능한 서브넷 하나 이상. 퍼블릭 서브넷은 AWS 인터넷 게이트웨이를 통하는 기본 경로가 있어야 하고, 프라이빗 서브넷은 AWS NAT 게이트웨이를 통하는 기본 경로가 있어야 합니다.
  • AWS Terraform 프로바이더용 AWS 자격 증명.
  • Teleport Terraform 프로바이더용 Teleport 자격 증명. 로컬에서 Terraform을 실행하는 경우 Teleport Terraform 프로바이더 로컬 데모를 따릅니다.

이 가이드는 Database Service를 데이터베이스와 동일한 AWS 계정, 리전, VPC에 배포합니다. 다른 AWS 계정의 데이터베이스에 접근하려면 모듈의 기본 리소스 매처 대신 database_service.resources와 필요한 교차 계정 IAM 역할을 구성합니다.

1/6단계. Discovery Service 준비#

Teleport Cloud는 cloud-discovery-group 그룹에서 Discovery Service를 실행합니다. Discovery Service를 별도로 설치할 필요가 없습니다.

Teleport 프록시 서비스에 접근할 수 있는 호스트에 Teleport를 설치합니다. 호스트는 AWS API에 대한 네트워크 접근이 필요하지만, 데이터베이스에 대한 네트워크 접근은 필요하지 않습니다.

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

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

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

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

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

Discovery Service용 조인 토큰을 생성합니다.

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

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

호스트에 /etc/teleport.yaml을 생성합니다. teleport.example.com:443에는 Teleport 프록시 서비스의 공개 주소를 지정합니다.

version: v3
teleport:
  join_params:
    token_name: "/tmp/token"
    method: token
  proxy_server: "teleport.example.com:443"
auth_service:
  enabled: false
proxy_service:
  enabled: false
ssh_service:
  enabled: false
discovery_service:
  enabled: true
  discovery_group: "aws-databases"

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

Package Manager

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

$ sudo systemctl enable teleport
$ sudo systemctl start teleport

TAR Archive

the Discovery 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 Discovery Service의 상태를 확인하고 journalctl -fu teleport로 로그를 볼 수 있습니다.

2/6단계. Terraform 프로바이더 구성#

VPC와 데이터베이스가 있는 리전으로 AWS Terraform 프로바이더를 구성합니다.

Terraform 구성에 AWS 및 Teleport 프로바이더를 추가합니다.

terraform {
  required_version = ">= 1.5.7"

  required_providers {
    aws = {
      source = "hashicorp/aws"
      version = "~> 6.0"
    }
    teleport = {
      source = "terraform.releases.teleport.dev/gravitational/teleport"
      version = "~> 18.0"
    }
  }
}

provider "aws" {
  region = "us-east-1"
}

provider "teleport" {}

클러스터의 자격 증명으로 Teleport Terraform 프로바이더를 구성합니다. 로컬에서 Terraform을 실행하는 경우, Terraform을 실행할 동일한 셸에서 Teleport에 로그인하고 프로바이더용 자격 증명을 내보냅니다.

$ tsh login
$ eval "$(tctl terraform env)"

CI/CD 및 기타 원격 실행 환경에서는 Teleport Terraform 프로바이더 사용하기를 따라 Machine ID 또는 워크로드 아이덴티티 자격 증명을 구성합니다.

3/6단계. Terraform 모듈 구성#

Terraform 구성에 두 모듈과 보안 그룹 인그레스 규칙을 추가합니다.

module "aws_discovery" {
  source  = "terraform.releases.teleport.dev/teleport/discovery/aws"
  version = "~> (=cloud.major_version=).0"

  teleport_proxy_public_addr    = "example.teleport.sh:443"
  teleport_discovery_group_name = "cloud-discovery-group"

  aws_matchers = [{
    types   = ["rds"]
    regions = ["us-east-1"]
    tags    = { "*" = ["*"] }
  }]
}

module "teleport_db_agent" {
  source  = "terraform.releases.teleport.dev/teleport/agent/aws"
  version = "~> (=cloud.major_version=).0"

  teleport_proxy_public_addr = "example.teleport.sh:443"
  database_service = {
    allow_database_modification       = true
    database_security_group_ids       = [
      "sg-0123456789abcdef0",
    ]
    default_iam_policy_database_types = ["rds"]
    enabled                           = true
  }
  vpc_id                     = "vpc-0123456789abcdef0"
  private_subnet_ids = [
    "subnet-0123456789abcdef0",
    "subnet-abcdef01234567890",
  ]
}
module "aws_discovery" {
  source  = "terraform.releases.teleport.dev/teleport/discovery/aws"
  version = "~> (=teleport.major_version=).0"

  teleport_proxy_public_addr    = "teleport.example.com:443"
  teleport_discovery_group_name = "aws-databases"

  aws_matchers = [{
    types   = ["rds"]
    regions = ["us-east-1"]
    tags    = { "*" = ["*"] }
  }]
}

module "teleport_db_agent" {
  source  = "terraform.releases.teleport.dev/teleport/agent/aws"
  version = "~> (=teleport.major_version=).0"

  teleport_proxy_public_addr = "teleport.example.com:443"
  database_service = {
    allow_database_modification       = true
    database_security_group_ids       = [
      "sg-0123456789abcdef0",
    ]
    default_iam_policy_database_types = ["rds"]
    enabled                           = true
  }
  vpc_id                     = "vpc-0123456789abcdef0"
  private_subnet_ids = [
    "subnet-0123456789abcdef0",
    "subnet-abcdef01234567890",
  ]
}

VPC, 서브넷, 보안 그룹, 리전 값을 사용자의 AWS 환경에 맞는 값으로 바꿉니다. 각 데이터베이스 보안 그룹 ID를 database_service.database_security_group_ids에 포함합니다. AWS NAT 게이트웨이를 통하는 기본 경로가 있는 서브넷에는 private_subnet_ids를 사용하고, AWS 인터넷 게이트웨이를 통하는 기본 경로가 있는 서브넷에는 이를 public_subnet_ids로 바꿔 사용합니다.

검색 모듈의 aws_matchers 입력은 Teleport에 등록할 데이터베이스를 제어합니다. 이 예시는 구성된 리전의 모든 RDS 및 Aurora 데이터베이스를 검색합니다. 특정 AWS 태그가 있는 데이터베이스로 검색을 제한하려면 와일드카드 tags 셀렉터를 바꿉니다.

에이전트 모듈의 기본 Database Service 리소스 매처는 account-id, region, vpc-id 라벨이 ECS 서비스가 실행되는 AWS 계정, 리전, VPC와 일치하는 등록된 데이터베이스를 선택합니다.

database_service 객체에 default_iam_policy_database_types = ["rds"]를 설정하면 RDS 데이터베이스를 조회하고 IAM 인증으로 연결하는 권한이 추가됩니다. 같은 객체에 allow_database_modification = true를 설정하면 Database Service가 IAM 데이터베이스 인증을 활성화하는 것도 허용됩니다. 기본 정책은 해당하는 모든 리소스에 대해 이러한 RDS 작업을 허용합니다. 프로덕션 배포에서 권한을 제한하려면 ecs_task_role_inline_policy에 정책 문서를 전달합니다. SID가 RDSAutoEnableIAMAuth, RDSConnect, RDSFetchMetadata인 구문은 해당하는 기본 구문을 덮어씁니다.

검색 모듈은 기본적으로 AWS OIDC 연동을 사용합니다. AWS가 OIDC 아이덴티티 공급자로 사용할 수 있도록 셀프 호스팅 클러스터의 공개 프록시 주소는 HTTPS로 접근할 수 있어야 합니다. 프록시에 공개적으로 접근할 수 없다면, 대신 Discovery Service에서 사용할 수 있는 AWS IAM 역할을 사용하도록 discovery_service_iam_credential_source를 구성합니다.

AWS는 계정 내에서 동일한 공급자 URL에 대해 하나의 IAM OIDC 공급자만 허용합니다. 계정에 이 Teleport 클러스터용 IAM OIDC 공급자가 이미 있다면, 검색 모듈에서 create_aws_iam_openid_connect_provider = false를 설정합니다.

4/6단계. Terraform 구성 적용#

Terraform을 초기화하고 계획을 검토합니다.

$ terraform init
$ terraform apply

검색 모듈은 다음 리소스를 계획해야 합니다.

  • RDS 검색을 위한 AWS IAM 역할 및 정책.
  • AWS IAM OIDC 공급자 및 Teleport AWS OIDC 연동.
  • 선택한 RDS 데이터베이스를 위한 Teleport discovery_config.

에이전트 모듈은 다음 리소스를 계획해야 합니다.

  • ECS 클러스터, 작업 정의, 서비스.
  • ECS 작업 및 실행 IAM 역할.
  • CloudWatch 로그 그룹.
  • 아웃바운드 트래픽을 허용하는 보안 그룹.
  • ECS 작업 역할로 제한된 Teleport IAM 조인 토큰.

계획에는 RDS 보안 그룹에 대한 인바운드 규칙도 포함되어야 합니다. 계획을 주의 깊게 검토한 후 승인합니다.

ECS 서비스는 기본적으로 Database Service 작업 두 개를 실행합니다. 작업은 AWS IAM 아이덴티티로 Teleport 클러스터에 조인하므로, 모듈은 ECS 작업 정의에 비밀 조인 토큰을 저장하지 않습니다.

5/6단계. 데이터베이스 검색 확인#

Discovery Service는 일치하는 데이터베이스를 Teleport db 리소스로 등록합니다.

등록된 데이터베이스를 나열합니다.

$ tctl get db

Discovery Service는 등록하는 각 데이터베이스에 teleport.dev/origin: cloud 라벨을 추가합니다. 출력에 구성된 AWS 계정과 리전의 RDS 데이터베이스가 포함되어 있는지 확인합니다.

예상한 데이터베이스가 없다면 Teleport 웹 UI의 Zero Trust Access > Integrations에서 검색 연동을 확인한 다음, Discovery Service 문제 해결 섹션을 참조합니다.

6/6단계. Database Service 확인#

ECS 작업이 시작되어 등록된 데이터베이스와 일치하면, 작업은 수명이 짧은 Teleport db_server 리소스를 생성합니다. Database Service가 제공하는 데이터베이스를 나열합니다.

$ tctl db ls teleport.dev/origin=cloud,teleport.dev/cloud=AWS,region=us-east-1

명령이 예상한 RDS 데이터베이스를 나열하면 자동 검색과 Database Service가 올바르게 구성된 것입니다.

tctl get db에는 데이터베이스가 나열되지만 tctl db ls에는 나열되지 않는다면, Amazon ECS 콘솔을 열고 CloudWatch 로그 그룹의 작업 로그를 확인합니다. 또한 VPC 경로, RDS 보안 그룹 규칙, 리소스 라벨, ECS 작업 IAM 권한을 확인합니다. 추가 확인 사항은 Database Service 문제 해결을 참조합니다.

Note

이 가이드는 RDS 자동 검색을 구성하고 Database Service를 배포합니다. 데이터베이스 사용자를 프로비저닝하거나 해당 사용자에 대한 Teleport RBAC를 구성하지는 않습니다. 데이터베이스에 연결하기 전에 AWS 데이터베이스 등록의 해당 가이드를 따릅니다.

다음 단계#

문제 해결#

Note

이 섹션의 내용은 원문 문서를 참조하세요. (tctl-discovery-status.mdx)

Note

이 섹션의 내용은 원문 문서를 참조하세요. (tctl-discovery-databases.mdx)

Discovery Service 문제 해결#

먼저 database가 검색되었는지 확인합니다. 이를 위해 tctl get db 명령을 사용하여 예상되는 database가 이미 Teleport 클러스터에 등록되었는지 확인할 수 있습니다.

일부 database가 목록에 나타나지 않는다면, Discovery Service 셀렉터 레이블이 누락된 database 태그와 일치하는지 확인하거나 Discovery Service 로그에서 권한 오류를 살펴보십시오.

Discovery Service가 올바른 AWS 계정의 자격 증명으로 실행되고 있는지 확인합니다. 다른 AWS 계정의 리소스를 검색할 수 있지만, 그런 경우에는 해당 다른 AWS 계정에서 역할을 assume하도록 구성되어 있어야 합니다.

둘 이상의 Discovery Service가 실행 중인지 확인합니다:

$ tctl inventory status --connected

여러 Discovery Service를 실행하는 경우, 동일한 클라우드 database를 감시하는 서비스들은 모두 동일한 discovery_group 값으로 구성하고, 서로 다른 클라우드 database를 감시하는 서비스들은 서로 다른 값으로 구성해야 합니다. 이것이 올바르게 구성되지 않으면, 일반적인 증상으로 db 리소스가 Teleport 클러스터의 레지스트리에서 간헐적으로 삭제됩니다.

Database Service 문제 해결#

tctl db ls에 데이터베이스가 나타나지 않음#

tctl get db 명령이 예상한 검색된 데이터베이스를 반환하지만 tctl db ls 명령에는 포함되지 않는 경우, db_service.resources 섹션이 올바르게 설정되어 있는지 확인하세요. 예를 들면 다음과 같습니다:

db_service:
  enabled: true
  resources:
  - labels:
      "env": "prod"

섹션이 올바르게 구성되어 있는데도 데이터베이스가 여전히 나타나지 않는다면, Teleport에서 데이터베이스를 나열할 올바른 권한이 있는지 확인하세요. 데이터베이스 레이블과 일치하고 db 및 db_server 오브젝트에 대해 "read" 및 "list" verb를 허용하는 Teleport 역할이 있어야 합니다. 다음은 클러스터의 모든 데이터베이스에 대해 해당 권한을 부여하는 예시입니다:

kind: role
version: v6
metadata:
  name: view-all-databases
spec:
  allow:
    db_labels:
      '*': '*'
    rules:
      - resources: [db_server, db]
        verbs: [read, list]

데이터베이스에 연결할 때 오류 발생#

Note

이 섹션에서는 Enroll AWS Databases의 특정 가이드를 따라 이미 데이터베이스 사용자를 프로비저닝하고 해당 데이터베이스 사용자에 대한 Teleport RBAC를 구성했다고 가정합니다.

데이터베이스에 연결하려고 할 때 연결 오류가 발생하면, 먼저 대상 데이터베이스에 대해 여러 개의 db_server 하트비트 리소스가 있는지 확인하세요: tctl get db_server/yourDatabaseName. 여러 개가 있다면 여러 Teleport Database Service 인스턴스가 데이터베이스를 프록시하고 있다는 의미이며, 이는 문제 해결을 복잡하게 만드는 HA 구성입니다. Teleport는 연결을 프록시할 Database Service 인스턴스 중 하나를 무작위로 선택하며, 그중 하나가 데이터베이스 엔드포인트에 연결할 수 없거나 권한이 부족한 경우 무작위 연결 오류가 발생합니다.

연결 오류가 일관되게 발생하더라도, 오류를 해결하는 동안에는 대상 db와 일치하는 인스턴스가 하나만 남도록 Teleport Database Service 인스턴스를 축소하거나 재구성해야 합니다. tctl get db_server/yourDatabaseName으로 db_server가 하나만 있는지 확인한 다음 다시 연결을 시도하세요.

DEBUG 레벨 로깅을 활성화한 상태에서 Teleport Database Service 로그를 확인하고 네트워크 또는 권한 오류를 찾아보세요.

보다 일반적인 문제 해결 단계는 Database Service 문제 해결 가이드를 참고하세요.

또한 Enroll AWS Databases에서 데이터베이스 유형에 특화된 가이드에 더 구체적인 문제 해결 정보가 있을 수 있습니다.