인증된 Cloud Run 서비스를 사용하여 Pub/Sub 이벤트 수신

이 튜토리얼에서는 Pub/Sub를 사용하여 이벤트를 수신하는 인증된 Cloud Run 서비스를 사용하여 컨테이너화된 애플리케이션을 배포하는 방법을 보여줍니다. Pub/Sub는 독립적인 애플리케이션이 서로 메시지를 주고받게 해주는 완전 관리형 실시간 메시징 서비스입니다.

목표

이 튜토리얼에서는 다음 단계를 진행합니다.

인증된 호출이 필요한 Cloud Run에 이벤트 수신자 서비스를 배포합니다.
Pub/Sub 주제를 Cloud Run 서비스에 연결하는 Eventarc 트리거를 만듭니다.
Pub/Sub 주제에 메시지를 게시하여 이벤트를 생성합니다.
Cloud Run 로그에서 이벤트를 확인합니다.

비용

이 문서에서는 비용이 청구될 수 있는 다음과 같은 Google Cloud 구성요소를 사용합니다.

프로젝트 사용량을 기준으로 예상 비용을 산출하려면 가격 계산기를 사용하세요. Google Cloud를 처음 사용하는 사용자는 무료 체험판을 사용할 수 있습니다.

시작하기 전에

조직에서 정의한 보안 제약조건으로 인해 다음 단계를 완료하지 못할 수 있습니다. 문제 해결 정보는 제한된 Google Cloud 환경에서 애플리케이션 개발을 참조하세요.

Sign in to your Google Cloud account. If you're new to Google Cloud, create an account to evaluate how our products perform in real-world scenarios. New customers also get $300 in free credits to run, test, and deploy workloads.

Install the Google Cloud CLI.

To initialize the gcloud CLI, run the following command:

gcloud init

Create or select a Google Cloud project.

Create a Google Cloud project:
```
gcloud projects create PROJECT_ID
```
Replace PROJECT_ID with a name for the Google Cloud project you are creating.
Select the Google Cloud project that you created:
```
gcloud config set project PROJECT_ID
```
Replace PROJECT_ID with your Google Cloud project name.

Make sure that billing is enabled for your Google Cloud project.

Install the Google Cloud CLI.

To initialize the gcloud CLI, run the following command:

gcloud init

Create or select a Google Cloud project.

Create a Google Cloud project:
```
gcloud projects create PROJECT_ID
```
Replace PROJECT_ID with a name for the Google Cloud project you are creating.
Select the Google Cloud project that you created:
```
gcloud config set project PROJECT_ID
```
Replace PROJECT_ID with your Google Cloud project name.

Make sure that billing is enabled for your Google Cloud project.

Google Cloud CLI 구성요소를 업데이트합니다.
```
gcloud components update
```
계정을 사용하여 로그인합니다.
```
gcloud auth login
```

API를 사용 설정합니다.

gcloud services enable artifactregistry.googleapis.com \
    cloudbuild.googleapis.com \
    eventarc.googleapis.com \
    pubsub.googleapis.com \
    run.googleapis.com

이 튜토리얼에서 사용되는 구성 변수를 설정합니다.

export REGION=us-central1
gcloud config set run/region ${REGION}
gcloud config set run/platform managed
gcloud config set eventarc/location ${REGION}
export SERVICE_NAME=trigger-pubsub

프로젝트 생성자에게는 기본 소유자 역할(roles/owner)이 부여됩니다. 기본적으로 Identity and Access Management(IAM) 역할에는 대부분의 Google Cloud 리소스에 대한 전체 액세스에 필요한 권한이 포함되며, 이 단계를 건너뛸 수 있습니다.

프로젝트 생성자가 아니면 프로젝트에서 적합한 주 구성원에 대해 필수 권한을 부여해야 합니다. 예를 들어 주 구성원은 Google 계정(최종 사용자)이거나 서비스 계정(애플리케이션 및 컴퓨팅 워크로드)일 수 있습니다. 자세한 내용은 이벤트 대상의 역할 및 권한 페이지를 참조하세요.

기본적으로 Cloud Build 권한에는 Artifact Registry 아티팩트를 업로드 및 다운로드할 수 있는 권한이 포함됩니다.
필수 권한

튜토리얼을 완료하는 데 필요한 권한을 얻으려면 관리자에게 프로젝트에 대한 다음 IAM 역할을 부여해 달라고 요청하세요.
- Cloud Build 편집자(roles/cloudbuild.builds.editor)
- Cloud Run 관리자(roles/run.admin)
- Eventarc 관리자(roles/eventarc.admin)
- 로그 뷰 접근자 (roles/logging.viewAccessor)
- 프로젝트 IAM 관리자(roles/resourcemanager.projectIamAdmin)
- Pub/Sub 게시자(roles/pubsub.publisher)
- 서비스 계정 관리자(roles/iam.serviceAccountAdmin)
- 서비스 계정 사용자(roles/iam.serviceAccountUser)
- 서비스 사용량 관리자(roles/serviceusage.serviceUsageAdmin)
- 스토리지 관리자(roles/storage.admin)
역할 부여에 대한 자세한 내용은 액세스 관리를 참조하세요.

커스텀 역할이나 다른 사전 정의된 역할을 통해 필요한 권한을 얻을 수도 있습니다.
테스트 목적으로 Eventarc 트리거에 연결할 때 트리거의 ID를 나타내기 위해 Compute Engine 기본 서비스 계정을 기록해 둡니다. 이 서비스 계정은 Compute Engine을 사용하는 Google Cloud 서비스를 사용 설정하거나 사용한 후에 다음 이메일 형식으로 자동 생성됩니다.
```
PROJECT_NUMBER-compute@developer.gserviceaccount.com
```
PROJECT_NUMBER를 Google Cloud 프로젝트 번호로 바꿉니다. Google Cloud 콘솔의 시작 페이지에서 또는 다음 명령어를 실행하여 프로젝트 번호를 찾을 수 있습니다.
```
gcloud projects describe PROJECT_ID --format='value(projectNumber)'
```
프로덕션 환경의 경우 새 서비스 계정을 만들고 필요한 최소한의 권한을 포함하고 최소 권한 원칙을 따르는 하나 이상의 IAM 역할을 부여하는 것이 좋습니다.

참고:
iam.automaticIamGrantsForDefaultServiceAccounts 조직 정책 제약조건은 편집자 역할이 기본 서비스 계정에 자동으로 부여되지 않도록 합니다. 2024년 5월 3일 이후에 조직을 만든 경우 기본적으로 이 제약조건이 적용됩니다.

이 제약조건을 적용하여 자동 역할 부여를 사용 중지하는 것이 좋습니다. 자동 역할 부여를 중지한 경우 기본 서비스 계정에 부여할 역할을 결정한 후 직접 이러한 역할을 부여해야 합니다.

기본 서비스 계정에 이미 편집자 역할이 있으면 편집자 역할을 권한이 더 낮은 역할로 바꾸는 것이 좋습니다. 서비스 계정 역할을 안전하게 수정하려면 정책 시뮬레이터를 사용하여 변경사항의 영향을 확인한 후 적절한 역할을 부여하고 취소합니다.
기본적으로 Cloud Run 서비스는 프로젝트 소유자, 프로젝트 편집자, Cloud Run 관리자 및 호출자만 호출할 수 있습니다. 개발자는 서비스별로 액세스를 제어할 수 있지만, 테스트 목적으로 Compute Engine 서비스 계정에 Google Cloud 프로젝트에서 Cloud Run 호출자 역할(run.invoker)을 부여하세요. 이렇게 하면 프로젝트의 모든 Cloud Run 서비스 및 작업에 대한 역할을 부여하게 됩니다.
```
gcloud projects add-iam-policy-binding PROJECT_ID \
    --member=serviceAccount:PROJECT_NUMBER-compute@developer.gserviceaccount.com \
    --role=roles/run.invoker
```
Cloud Run 호출자 역할을 부여하지 않고 인증된 Cloud Run 서비스에 대한 트리거를 만들어도 트리거가 성공적으로 생성되며 활성화됩니다. 하지만 트리거가 예상한 대로 작동하지 않고 다음과 비슷한 메시지가 로그에 표시됩니다.
The request was not authenticated. Either allow unauthenticated invocations or set the proper Authorization header.
2021년 4월 8일 이전에 Cloud Pub/Sub 서비스 에이전트를 사용 설정하여 인증된 Pub/Sub 푸시 요청을 지원한 경우 서비스 계정 토큰 생성자 역할(roles/iam.serviceAccountTokenCreator)을 서비스 에이전트에 부여합니다. 그렇지 않으면 기본적으로 이 역할이 부여됩니다.
```
gcloud projects add-iam-policy-binding PROJECT_ID \
    --member=serviceAccount:service-PROJECT_NUMBER@gcp-sa-pubsub.iam.gserviceaccount.com \
    --role=roles/iam.serviceAccountTokenCreator
```

Artifact Registry 표준 저장소 만들기

컨테이너 이미지를 저장할 Artifact Registry 표준 저장소를 만듭니다.

gcloud artifacts repositories create REPOSITORY \
    --repository-format=docker \
    --location=$REGION

REPOSITORY를 저장소의 고유한 이름으로 바꿉니다.

Cloud Run에 이벤트 수신자 배포

이벤트 콘텐츠를 로깅하는 Cloud Run 서비스를 배포합니다.

GitHub 저장소를 클론합니다.
Node.js
```
git clone https://github.com/GoogleCloudPlatform/nodejs-docs-samples.git
```
또는 zip 파일로 샘플을 다운로드하고 압축을 풀 수 있습니다.
Python
```
git clone https://github.com/GoogleCloudPlatform/python-docs-samples.git
```
또는 zip 파일로 샘플을 다운로드하고 압축을 풀 수 있습니다.
Go
```
git clone https://github.com/GoogleCloudPlatform/golang-samples.git
```
또는 zip 파일로 샘플을 다운로드하고 압축을 풀 수 있습니다.
자바
```
git clone https://github.com/GoogleCloudPlatform/java-docs-samples.git
```
또는 zip 파일로 샘플을 다운로드하고 압축을 풀 수 있습니다.
Ruby
```
git clone https://github.com/GoogleCloudPlatform/ruby-docs-samples.git
```
또는 zip 파일로 샘플을 다운로드하고 압축을 풀 수 있습니다.
C#
```
git clone https://github.com/GoogleCloudPlatform/dotnet-docs-samples.git
```
또는 zip 파일로 샘플을 다운로드하고 압축을 풀 수 있습니다.

Cloud Run 샘플 코드가 포함된 디렉터리로 변경합니다.

Node.js

cd nodejs-docs-samples/eventarc/pubsub/

Python

cd python-docs-samples/eventarc/pubsub/

Go

cd golang-samples/eventarc/pubsub/

자바

cd java-docs-samples/eventarc/pubsub/

Ruby

cd ruby-docs-samples/eventarc/pubsub/

C#

cd dotnet-docs-samples/eventarc/pubsub/

컨테이너를 빌드하고 Cloud Build에 업로드합니다.

gcloud builds submit --tag $REGION-docker.pkg.dev/PROJECT_ID/REPOSITORY/trigger-pubsub:v1

컨테이너 이미지를 Cloud Run에 배포합니다.

gcloud run deploy ${SERVICE_NAME} \
    --image $REGION-docker.pkg.dev/PROJECT_ID/REPOSITORY/trigger-pubsub:v1

Pub/Sub 트리거에 인증되지 않은 호출 허용(Y/N)? 프롬프트에서 '아니요'의 경우 n으로 응답합니다.

Cloud Run 서비스 URL이 표시되면 배포가 완료된 것입니다.

Eventarc 트리거 만들기

Pub/Sub 주제에 메시지가 게시되면 이벤트가 Cloud Run 서비스를 트리거합니다.

Pub/Sub 메시지를 리슨하는 트리거를 만듭니다.

새 Pub/Sub 주제

  gcloud eventarc triggers create ${SERVICE_NAME} \
      --destination-run-service=${SERVICE_NAME} \
      --destination-run-region=${REGION} \
      --location=${REGION} \
      --event-filters="type=google.cloud.pubsub.topic.v1.messagePublished" \
      --service-account=PROJECT_NUMBER-compute@developer.gserviceaccount.com

이렇게 하면 새 Pub/Sub 주제와 trigger-pubsub라는 트리거가 생성됩니다.

기존 Pub/Sub 주제

  gcloud eventarc triggers create ${SERVICE_NAME} \
      --destination-run-service=${SERVICE_NAME} \
      --destination-run-region=${REGION} \
      --location=${REGION} \
      --event-filters="type=google.cloud.pubsub.topic.v1.messagePublished" \
      --transport-topic=projects/PROJECT_ID/topics/TOPIC_ID \
      --service-account=PROJECT_NUMBER-compute@developer.gserviceaccount.com

다음을 바꿉니다.

PROJECT_ID: Google Cloud 프로젝트 ID입니다.
TOPIC_ID: 기존 Pub/Sub 주제의 ID입니다.

기존 Pub/Sub 주제에 대한 trigger-pubsub라는 이름의 트리거를 만듭니다.

Google Cloud 프로젝트에서 처음으로 Eventarc 트리거를 만들 때는 Eventarc 서비스 에이전트를 프로비저닝하는 데 시간이 지연될 수 있습니다. 이 문제는 일반적으로 트리거를 다시 만들면 해결할 수 있습니다. 자세한 내용은 권한 거부 오류를 참조하세요.

트리거가 성공적으로 생성되었는지 확인하세요. 트리거가 즉시 생성되더라도 트리거가 완전히 작동하려면 최대 2분까지 걸릴 수 있습니다.
```
gcloud eventarc triggers list --location=${REGION}
```
반환된 트리거 상태는 ACTIVE: Yes여야 합니다.

이벤트 생성 및 확인

이벤트를 생성하고 Cloud Run 서비스를 트리거하도록 Pub/Sub 주제에 메시지를 게시합니다. Cloud Run 서비스가 서비스 로그에 메시지를 로깅합니다.

Pub/Sub 주제를 환경 변수로 찾아서 설정합니다.

export TOPIC_ID=$(gcloud eventarc triggers describe ${SERVICE_NAME} \
    --format='value(transport.pubsub.topic)')

Pub/Sub 주제에 메시지를 보내 이벤트를 생성합니다.
```
gcloud pubsub topics publish $TOPIC_ID --message "Hello there"
```
이벤트는 Cloud Run 서비스로 전송되어 이벤트 메시지를 로깅합니다.
서비스에서 만든 이벤트 관련 로그 항목을 확인합니다.
```
gcloud logging read 'textPayload: "Hello there!"'
```
로그 항목은 다음과 비슷하게 표시됩니다.
```
textPayload: 'Hello, Hello there!'
```

로그가 나타나려면 시간이 약간 걸릴 수 있습니다. 즉시 표시되지 않으면 1분 후에 다시 확인하세요.

삭제

Artifact Registry에 컨테이너 이미지를 저장하거나, Cloud Storage 버킷에 파일을 저장하고, Eventarc를 트리거하는 등의 비용을 발생시키지 않으려면, 이 튜토리얼을 위해 만든 리소스를 삭제할 수 있습니다:

또는 Google Cloud 프로젝트를 삭제할 수 있습니다. Google Cloud 프로젝트를 삭제하면 프로젝트 내에서 사용되는 모든 리소스에 대한 비용 청구가 중지됩니다.

Delete a Google Cloud project:

gcloud projects delete PROJECT_ID

인증된 Cloud Run 서비스를 사용하여 Pub/Sub 이벤트 수신

목표

비용

시작하기 전에

필수 권한

Artifact Registry 표준 저장소 만들기

Cloud Run에 이벤트 수신자 배포

Node.js

Python

Go

자바

Ruby

C#

Node.js

Python

Go

자바

Ruby

C#

Eventarc 트리거 만들기

새 Pub/Sub 주제

기존 Pub/Sub 주제

이벤트 생성 및 확인

삭제

다음 단계