Terraform으로 Google Cloud Pub/Sub 로그 소스 관리하기(Beta)

Terraform에서 Google Cloud Pub/Sub 로그 소스를 코드로 관리하기

개요

Terraform로 Google Cloud Pub/Sub 로그 소스를 관리하는 기능은 Panther 버전 1.121부터 오픈 베타이며, 모든 고객이 사용할 수 있습니다. 버그 보고 및 기능 요청이 있으면 Panther 지원팀에 공유해 주세요.

Panther를 사용하여 Terraform에서 Google Cloud Pub/Sub 로그 소스를 정의할 수 있습니다. Terraform provider.

Pub/Sub 로그 소스를 만드는 다른 방법으로는 다음을 사용하는 방법이 있습니다. Panther API 직접 생성하는 방법과 Panther Console에서 수동으로 생성하는 방법이 있습니다.

Terraform에서 Panther Pub/Sub 로그 소스를 정의하는 방법

다음 섹션에서는 HashiCorp Configuration Language(HCL)에서 Pub/Sub 로그 소스를 정의하는 방법을 설명합니다.

필수 조건

• 시작하기 전에 API URL과 로그 소스 관리 권한. 이는 3단계를 완료하는 데 필요합니다.

  • 필요한 경우, Panther Console에서 API 토큰을 생성하는 방법에 대한 이 지침을 따르세요.

1단계: 인증 방법 선택

• 나열된 옵션에서 Pub/Sub 소스에 대한 인증 방법을 선택하세요. Pub/Sub 소스.

선택한 인증 방법에 따라 아래 2단계에서 정의할 변수가 결정됩니다.

2단계: 변수 정의

• 다음이 포함된 variables.tf 파일을 Panther 변수와 함께 아래 코드 블록에 표시된 대로 정의합니다.

variable "panther_api_token" {
  description = "Panther API 토큰"
  type        = string
}

variable "panther_api_url" {
  description = "Panther API URL"
  type        = string
}

variable "integration_label" {
  description = "통합의 이름입니다."
  type        = string
}

variable "credentials_type" {
  description = "사용된 인증 방법입니다."
  type        = string
}

variable "subscription_id" {
  description = "Google Cloud Pub/Sub 구독 ID"
  type        = string
}

// 인증 변수는 credentials_type에 따라 다릅니다. 아래 표를 참조하세요
variable "credentials" {
  description = "서비스 계정 JSON 키 또는 WIF 자격 증명 구성 파일의 내용"
  type        = string
  sensitive   = true
}

variable "project_id" {
  description = "Google Cloud 프로젝트 ID(WIF의 경우 필수, 서비스 계정의 경우 선택 사항)"
  type        = string
}

// (선택 사항) 지역 엔드포인트
variable "regional_endpoint" {
  description = "Pub/Sub용 지역 엔드포인트"
  type        = string
}

// (선택 사항) log_stream_type = "JsonArray"인 경우에만 관련됨
variable "json_array_envelope_field" {
  description = "json 배열 스트림의 봉투 필드"
  type        = string
}

// (선택 사항) log_stream_type = "XML"인 경우에만 관련됨
variable "xml_root_element" {
  description = "XML 로그 스트림의 루트 요소 이름"
  type        = string
}

인증 방법별 변수

귀하의 variables.tf 파일에 추가 변수 열 아래에서 1단계에서 선택한 인증 방법에 해당하는 값을 포함하세요.

인증 방법	credentials_type 값	추가 변수
서비스 계정 인증	service_account	credentials (JSON 키파일 내용)
워크로드 아이덴티티 연합 인증	wif	credentials (자격 증명 구성 파일 내용), project_id

3단계: 정의한 변수의 값 제공

• 다음이 포함된 *.tfvars 파일에서 2단계에서 정의한 변수에 값을 할당합니다. 이 섹션을 완료하려면 필수 조건 섹션에 설명된 API URL과 토큰이 필요합니다.

  • 귀하의 panther_api_url 값은 루트 API URL이어야 합니다. 이는 다음 중 하나입니다:

    • A GraphQL API URL 다음이 없는 /public/graphql 접미사

    • A REST API URL 그대로 사용합니다(REST URL에는 루트 URL 뒤에 접미사가 없습니다)

panther_api_token         = "XXXXXXXXXX"
panther_api_url           = "https://your-panther-url/v1"
integration_label         = "test-pubsub-integration"
credentials_type          = "service_account" // service_account 또는 wif
subscription_id           = "my-subscription"
credentials               = "{ ... }" // JSON 키파일 또는 자격 증명 구성 내용
project_id                = "my-gcp-project" // WIF에는 필수, service_account에는 선택 사항
regional_endpoint         = "us-central1-pubsub.googleapis.com" // 선택 사항
json_array_envelope_field = "records"
xml_root_element          = "" // 선택 사항, log_stream_type = "XML"인 경우에만 관련됨

4단계: Terraform 프로바이더 정의

• 다음을 추가하세요. Panther Terraform 프로바이더.

terraform {
  required_providers {
    panther = {
      source = "panther-labs/panther"
      version = "~> 0.2.10"
    }
  }
}

5단계: Panther Pub/Sub 로그 소스 정의

다음 HCL 구성은 Panther에서 Pub/Sub 로그 소스를 정의합니다.

provider "panther" {
  token = var.panther_api_token
  url   = var.panther_api_url
}

resource "panther_pubsubsource" "demo_pubsub_source" {
  integration_label   = var.integration_label
  log_stream_type     = "JSON" // 옵션: JSON, JsonArray, Auto, Lines, XML
  log_types           = ["GCP.AuditLog"]
  credentials_type    = var.credentials_type
  subscription_id     = var.subscription_id
  credentials         = var.credentials
  project_id          = var.project_id
  regional_endpoint   = var.regional_endpoint // 선택 사항
  // (선택 사항) log_stream_type에 따라 구성
  log_stream_type_options = {
    json_array_envelope_field = var.json_array_envelope_field // "JsonArray"에 해당
    xml_root_element          = var.xml_root_element          // "XML"에 해당
  }
}