워크플로가 외부 프로세스를 기다려야 할 수 있습니다. HTTP 콜백을 사용하여 다른 서비스가 콜백 엔드포인트를 요청할 때까지 기다릴 수 있습니다. 이 요청은 워크플로 실행을 재개합니다. 폴링 사용을 대기할 수도 있습니다.
이 튜토리얼에서는 폴링을 사용하는 대신 HTTP 콜백 및 Eventarc 트리거를 사용하여 이벤트 또는 Pub/Sub 메시지를 대기하는 방법을 보여줍니다. 이벤트 또는 Pub/Sub 메시지로 이벤트를 트리거할 수 있지만 계속하기 전 다른 이벤트를 기다리도록 실행을 중지해야 할 수 있습니다. 예를 들어 이벤트가 프로세스를 시작하는 워크플로를 트리거하지만 워크플로는 프로세스가 완료되었음을 알리는 다른 이벤트를 대기해야 합니다. 이를 구현하려면 한 워크플로가 다른 워크플로를 콜백하도록 지정하면 됩니다.
목표
이 튜토리얼에서는 다음 작업이 수행됩니다.
이벤트를 대기해야 하는 기본 워크플로가 배포되고 실행됩니다. 이벤트가 발생할 때까지 기다려야 하므로 보조 워크플로가 세부정보를 검색할 수 있도록 콜백 세부정보를 Firestore 데이터베이스에 저장합니다. 그런 후 기본 워크플로가 HTTP 호출을 기다립니다.
보조 워크플로가 이벤트로 트리거되고 이벤트가 생성되면 Firestore 데이터베이스에서 콜백 세부정보를 검색합니다. 그런 후 보조 워크플로가 실행을 재개하도록 기본 워크플로를 콜백합니다.
다음은 전체 프로세스의 개요입니다.
기본 워크플로:
callback-event-sample
워크플로가 Pub/Sub 주제 및 Cloud Storage 버킷의 두 이벤트 소스에 대해 콜백 엔드포인트를 만듭니다.- 이 워크플로는 Firestore 문서에 두 콜백 엔드포인트를 저장합니다.
- 이 워크플로가 실행을 중지하고 콜백 엔드포인트에 HTTP 요청이 도달하기를 기다립니다.
이벤트:
- 이벤트 발생: 메시지가 Pub/Sub 주제에 게시되고 파일이 Cloud Storage 버킷에 업로드됩니다.
보조 워크플로:
- Eventarc가 이벤트를
callback-event-listener
워크플로로 라우팅하고 실행을 트리거합니다. - 이 워크플로는 Firestore 문서에서 적절한 콜백 엔드포인트 URL을 검색합니다.
- 이 워크플로는 샘플 워크플로에서 적절한 엔드포인트에 대해 콜백을 수행합니다.
기본 워크플로:
callback-event-sample
워크플로는 콜백 엔드포인트에서 이벤트를 검색하고 실행을 재개합니다.- 이 워크플로는 Firestore 문서에서 콜백 URL을 삭제하고 실행을 완료합니다.
비용
이 문서에서는 비용이 청구될 수 있는 다음과 같은 Google Cloud 구성요소를 사용합니다.
프로젝트 사용량을 기준으로 예상 비용을 산출하려면 가격 계산기를 사용하세요.
시작하기 전에
Google Cloud 콘솔에서 또는 터미널이나 Cloud Shell에서 Google Cloud CLI를 사용하여 다음 명령어를 실행할 수 있습니다.
조직에서 정의한 보안 제약조건으로 인해 다음 단계를 완료하지 못할 수 있습니다. 문제 해결 정보는 제한된 Google Cloud 환경에서 애플리케이션 개발을 참조하세요.
콘솔
Google Cloud 콘솔의 프로젝트 선택기 페이지에서 Google Cloud 프로젝트를 만들거나 선택합니다.
Google Cloud 프로젝트에 결제가 사용 설정되어 있는지 확인합니다. 프로젝트에 결제가 사용 설정되어 있는지 확인하는 방법을 알아보세요.
App Engine, Eventarc, Firestore, Pub/Sub, Workflows API를 사용 설정합니다.
다른 Google Cloud 서비스 인증에 사용할 워크플로의 서비스 계정을 만들고 적절한 역할을 부여합니다.
Google Cloud 콘솔에서 서비스 계정 페이지로 이동합니다.
서비스 계정 만들기 페이지로 이동하고 프로젝트를 선택합니다.
서비스 계정 이름 필드에 이름을 입력합니다. Google Cloud 콘솔은 이 이름을 기반으로 서비스 계정 ID 필드를 채웁니다.
서비스 계정 설명 필드에 설명을 입력합니다. 예를 들면
Service account for tutorial
입니다.만들고 계속하기를 클릭합니다.
역할 선택 목록에서 다음 역할을 필터링하여 이전 단계에서 만든 사용자 관리 서비스 계정에 부여합니다.
- Cloud Datastore 사용자: Datastore 모드의 Firestore(Datastore) 데이터에 액세스합니다.
- Eventarc 이벤트 수신자: 이벤트 제공자로부터 이벤트를 수신합니다.
- 로그 작성자: 로그를 작성합니다.
- Workflows 호출자: 워크플로를 실행하고 실행을 관리합니다.
역할을 추가하려면
다른 역할 추가를 클릭하고 각 역할을 추가합니다.계속을 클릭합니다.
계정 만들기를 마치려면 완료를 클릭합니다.
Cloud Storage에서 이벤트를 라우팅하는 Eventarc 트리거를 만들기 위해 Cloud Storage 서비스 에이전트에 Pub/Sub 게시자 역할을 부여합니다. 일반적으로는
service-PROJECT_NUMBER@gs-project-accounts.iam.gserviceaccount.com
입니다. Cloud Storage 서비스 에이전트의 이메일 주소를 가져올 수 있습니다.Google Cloud 콘솔에서 IAM 페이지로 이동합니다.
Cloud Storage 서비스 에이전트 행에서
주 구성원 수정을 클릭합니다. 서비스 에이전트가 나열되지 않는 경우 다음 단계를 진행합니다. 액세스 권한 수정 창이 열립니다.- add다른 역할 추가를 클릭한 다음 Pub/Sub 게시자 역할을 검색합니다.
- 역할을 선택합니다.
- 저장을 클릭합니다.
서비스 에이전트가 나열되지 않으면
액세스 권한 부여를 클릭합니다. 액세스 권한 부여 창이 열립니다.- 새 주 구성원 필드에 서비스 에이전트의 이메일 주소를 입력합니다.
- 역할 선택 목록에서 Pub/Sub 게시자 역할을 검색합니다.
- 역할을 선택합니다.
- 저장을 클릭합니다.
gcloud
In the Google Cloud console, activate Cloud Shell.
At the bottom of the Google Cloud console, a Cloud Shell session starts and displays a command-line prompt. Cloud Shell is a shell environment with the Google Cloud CLI already installed and with values already set for your current project. It can take a few seconds for the session to initialize.
Google Cloud 프로젝트에 결제가 사용 설정되어 있는지 확인합니다. 프로젝트에 결제가 사용 설정되어 있는지 확인하는 방법을 알아보세요.
App Engine, Eventarc, Firestore, Pub/Sub, Workflows API를 사용 설정합니다.
gcloud services enable \ appengine.googleapis.com \ eventarc.googleapis.com \ firestore.googleapis.com \ pubsub.googleapis.com \ workflows.googleapis.com
다른 Google Cloud 서비스 인증에 사용할 워크플로의 서비스 계정을 만들고 적절한 역할을 부여합니다.
서비스 계정을 만듭니다.
gcloud iam service-accounts create SERVICE_ACCOUNT_NAME
SERVICE_ACCOUNT_NAME
을 서비스 계정 이름으로 바꿉니다.이전 단계에서 만든 사용자 관리 서비스 계정에 역할을 부여합니다. 다음 IAM 역할마다 다음 명령어를 1회 실행합니다.
roles/datastore.user
: Datastore 모드의 Firestore(Datastore) 데이터에 액세스합니다.roles/eventarc.eventReceiver
: 이벤트 제공자에서 이벤트를 수신합니다.roles/logging.logWriter
: 로그를 작성합니다.roles/workflows.invoker
: 워크플로를 실행하고 실행을 관리합니다.
gcloud projects add-iam-policy-binding PROJECT_ID \ --member=serviceAccount:SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com \ --role=ROLE
다음을 바꿉니다.
PROJECT_ID
: 서비스 계정을 만든 프로젝트 ID입니다.ROLE
: 부여할 역할입니다.
Cloud Storage에서 이벤트를 라우팅하는 Eventarc 트리거를 만들기 위해 Cloud Storage 서비스 에이전트에 Pub/Sub 게시자 역할을 부여합니다. 일반적으로는
service-PROJECT_NUMBER@gs-project-accounts.iam.gserviceaccount.com
입니다.gcloud storage service-agent
를 사용하여 먼저 Cloud Storage 서비스 에이전트를 검색합니다.SERVICE_ACCOUNT_STORAGE="$(gcloud storage service-agent --project=PROJECT_ID)" gcloud projects add-iam-policy-binding PROJECT_ID \ --member=serviceAccount:$SERVICE_ACCOUNT_STORAGE \ --role=roles/pubsub.publisher
Firestore 데이터베이스 만들기
Firestore는 값에 대한 필드 매핑이 포함된 문서에 데이터를 저장합니다. 이러한 문서는 데이터 정리와 쿼리 빌드에 사용할 수 있는 문서 컨테이너인 컬렉션에 저장됩니다. Firestore 자세히 알아보기
각 Google Cloud 프로젝트는 하나의 Firestore 데이터베이스로 제한됩니다. 새 데이터베이스를 만들어야 하면 다음 단계를 수행합니다.
콘솔
Google Cloud 콘솔에서 Firestore 시작하기 페이지로 이동합니다.
기본 모드 선택을 클릭합니다.
데이터베이스 모드 선택 및 기능별 비교에 대한 자세한 내용은 기본 모드와 Datastore 모드 중 선택을 참조하세요.
위치 선택 목록에서 nam5(미국)를 선택합니다.
이 위치는 Firestore 데이터베이스와 Google Cloud 프로젝트의 App Engine 애플리케이션에 모두 적용됩니다. 데이터베이스를 만든 후에는 위치를 변경할 수 없습니다.
데이터베이스 만들기를 클릭합니다.
gcloud
Firestore 데이터베이스를 만들려면 먼저 App Engine 애플리케이션을 만든 후 gcloud firestore databases create
명령어를 실행해야 합니다.
gcloud app create --region=us-central gcloud firestore databases create --region=us-central
us-central is not a valid Firestore location
경고는 무시해도 됩니다.
App Engine과 Firestore는 동일한 위치를 지원하지만 App Engine us-central
(아이오와) 리전은 Firestore nam5
(미국) 멀티 리전에 매핑됩니다.
Pub/Sub 주제 만들기
이 튜토리얼에서는 Pub/Sub를 이벤트 소스로 사용합니다. 메시지를 게시할 수 있도록 Pub/Sub 주제를 만듭니다. 주제 만들기 및 관리에 대해 자세히 알아봅니다.
콘솔
Google Cloud 콘솔에서 Pub/Sub 주제 페이지로 이동합니다.
주제 만들기를 클릭합니다.
주제 ID 입력란에
topic-callback
을 입력합니다.다른 기본값을 수락합니다.
주제 만들기를 클릭합니다.
gcloud
주제를 만들려면 gcloud pubsub topics create
명령어를 실행합니다.
gcloud pubsub topics create topic-callback
Cloud Storage 버킷 만들기
이 튜토리얼에서는 Cloud Storage를 이벤트 소스로 사용합니다. 파일을 업로드할 수 있도록 Cloud Storage 버킷을 만듭니다. 스토리지 버킷 만들기에 대해 자세히 알아보세요.
콘솔
Google Cloud 콘솔에서 Cloud Storage 버킷 페이지로 이동합니다.
만들기를 클릭합니다.
버킷 이름에
PROJECT_ID-bucket-callback
을 입력합니다.프로젝트 ID는
callback-event-sample
워크플로에서 버킷을 식별하기 위해 사용됩니다.계속을 클릭합니다.
위치 유형에 대해 리전을 선택한 다음 us-central1(아이오와)을 선택합니다.
다른 기본값을 수락합니다.
만들기를 클릭합니다.
gcloud
버킷을 만들려면 gcloud storage buckets create
명령어를 실행합니다.
gcloud storage buckets create gs://PROJECT_ID-bucket-callback \ --location=us-central1
프로젝트 ID는 callback-event-sample
워크플로에서 버킷을 식별하기 위해 사용됩니다.
이벤트 소스가 생성된 후 이벤트 수신자 워크플로를 배포할 수 있습니다.
이벤트를 대기하는 워크플로 배포
callback-event-listener
워크플로는 메시지가 Pub/Sub 주제에 게시되거나 파일이 Cloud Storage 버킷에 업로드될 때 트리거됩니다. 이 워크플로는 이벤트를 수신하고, Firestore 데이터베이스에서 적절한 콜백 세부정보를 검색한 후 HTTP 요청을 콜백 엔드포인트로 전송합니다.
콘솔
Google Cloud 콘솔에서 Workflows 페이지로 이동합니다.
만들기를 클릭합니다.
새 워크플로의 이름
callback-event-listener
를 입력합니다.리전 목록에서 us-central1을 선택합니다.
이전에 만든 서비스 계정을 선택합니다.
다음을 클릭합니다.
워크플로 편집기에서 다음 워크플로 정의를 입력합니다.
배포를 클릭합니다.
gcloud
워크플로의 소스 코드 파일을 만듭니다.
touch callback-event-listener.yaml
텍스트 편집기에서 다음 워크플로를 소스 코드 파일에 복사합니다.
다음 명령어를 입력하여 워크플로를 배포합니다.
gcloud workflows deploy callback-event-listener \ --source=callback-event-listener.yaml \ --location=us-central1 \ --service-account=SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com
SERVICE_ACCOUNT_NAME
을 이전에 만든 서비스 계정 이름으로 바꿉니다.
이벤트를 대기하는 워크플로 배포
callback-event-sample
워크플로는 콜백 세부정보를 Firestore 데이터베이스에 저장하고 실행을 중지한 다음 특정 이벤트가 발생할 때까지 대기합니다.
콘솔
Google Cloud 콘솔에서 Workflows 페이지로 이동합니다.
만들기를 클릭합니다.
새 워크플로의 이름
callback-event-sample
를 입력합니다.리전 목록에서 us-central1을 선택합니다.
이전에 만든 서비스 계정을 선택합니다.
다음을 클릭합니다.
워크플로 편집기에서 다음 워크플로 정의를 입력합니다.
배포를 클릭합니다.
gcloud
워크플로의 소스 코드 파일을 만듭니다.
touch callback-event-sample.yaml
텍스트 편집기에서 다음 워크플로를 소스 코드 파일에 복사합니다.
다음 명령어를 입력하여 워크플로를 배포합니다.
gcloud workflows deploy callback-event-sample \ --source=callback-event-sample.yaml \ --location=us-central1 \ --service-account=SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com
SERVICE_ACCOUNT_NAME
을 이전에 만든 서비스 계정 이름으로 바꿉니다.
Pub/Sub 이벤트를 라우팅하는 Eventarc 트리거 만들기
Eventarc 트리거를 사용하면 이벤트 소스 및 대상 워크플로를 포함하여 트리거 필터를 지정하여 이벤트를 라우팅할 수 있습니다.
메시지를 Pub/Sub 주제로 게시한 결과로 callback-event-listener
워크플로를 실행하는 Eventarc 트리거를 만듭니다.
워크플로 트리거에 대해 자세히 알아보세요.
콘솔
Google Cloud 콘솔에서 Eventarc 페이지로 이동합니다.
트리거 만들기를 클릭합니다.
트리거 이름을 입력합니다.
예를 들면
trigger-pubsub-events-listener
입니다.이벤트 제공자 목록에서 Cloud Pub/Sub를 선택합니다.
이벤트 목록의 커스텀 아래에서 google.cloud.pubsub.topic.v1.messagePublished를 선택합니다.
Cloud Pub/Sub 주제 선택 목록에서 이전에 만든 주제를 선택합니다.
리전 목록에서 us-central1(아이오와)을 선택합니다.
프롬프트가 표시되면
iam.serviceAccountTokenCreator
역할을 Pub/Sub 서비스 계정에 부여합니다.이전에 만든 서비스 계정을 선택합니다.
이벤트 대상 목록에서 워크플로를 선택합니다.
워크플로 선택 목록에서 callback-event-listener 워크플로를 선택합니다.
만들기를 클릭합니다.
gcloud
트리거를 만들려면 gcloud eventarc triggers create
명령어를 실행합니다.
gcloud eventarc triggers create trigger-pubsub-events-listener \ --location=us-central1 \ --destination-workflow=callback-event-listener \ --destination-workflow-location=us-central1 \ --event-filters="type=google.cloud.pubsub.topic.v1.messagePublished" \ --transport-topic=topic-callback \ --service-account=SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com
이벤트는 변환되어 워크플로 실행에 런타임 인수로 전달됩니다. 새 트리거가 활성화되려면 최대 2분이 걸릴 수 있습니다.
Cloud Storage 이벤트를 라우팅하는 Eventarc 트리거 만들기
Eventarc 트리거를 사용하면 이벤트 소스 및 대상 워크플로를 포함하여 트리거 필터를 지정하여 이벤트를 라우팅할 수 있습니다.
Cloud Storage 버킷에 파일을 업로드한 결과로 callback-event-listener
워크플로를 실행하는 Eventarc 트리거를 만듭니다.
워크플로 트리거에 대해 자세히 알아보세요.
콘솔
Google Cloud 콘솔에서 Eventarc 페이지로 이동합니다.
트리거 만들기를 클릭합니다.
트리거 이름을 입력합니다.
예를 들면
trigger-storage-events-listener
입니다.이벤트 제공자 목록에서 Cloud Storage를 선택합니다.
이벤트 목록의 직접 아래에서 google.cloud.storage.object.v1.finalized를 선택합니다.
버킷 목록에서 이전에 만든 버킷을 찾아서 선택합니다.
Cloud Storage 버킷을 기준으로 리전 목록에서 기본값 us-central1(아이오와)을 허용합니다.
프롬프트가 표시되면
iam.serviceAccountTokenCreator
역할을 Pub/Sub 서비스 계정에 부여합니다.이전에 만든 서비스 계정을 선택합니다.
이벤트 대상 목록에서 워크플로를 선택합니다.
워크플로 선택 목록에서 callback-event-listener 워크플로를 선택합니다.
만들기를 클릭합니다.
gcloud
트리거를 만들려면 gcloud eventarc triggers create
명령어를 실행합니다.
gcloud eventarc triggers create trigger-storage-events-listener \ --location=us-central1 \ --destination-workflow=callback-event-listener \ --destination-workflow-location=us-central1 \ --event-filters="type=google.cloud.storage.object.v1.finalized" \ --event-filters="bucket=PROJECT_ID-bucket-callback" \ --service-account=SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com
이벤트는 변환되어 워크플로 실행에 런타임 인수로 전달됩니다. 새 트리거가 활성화되려면 최대 2분이 걸릴 수 있습니다.
기본 워크플로 실행
워크플로를 실행하면 워크플로와 연결된 현재 워크플로 정의가 실행됩니다. callback-event-sample
워크플로를 실행합니다. 이는 기본 워크플로이며 특정 이벤트가 발생할 때까지 기다립니다. 보조 워크플로에서 적절한 콜백 요청을 실행할 때만 실행을 재개합니다.
콘솔
Google Cloud 콘솔에서 Workflows 페이지로 이동합니다.
워크플로 페이지에서 callback-event-sample 워크플로를 클릭하여 세부정보 페이지로 이동합니다.
워크플로 세부정보 페이지에서 play_arrow 실행을 클릭합니다.
실행을 다시 클릭합니다.
워크플로 실행이 시작됩니다. 실행 중에
Running
의 실행 상태와 다음과 비슷한 로그 항목이 표시됩니다.Started waiting 1hr for an event from source topic-callback
gcloud
워크플로를 실행하려면 gcloud workflows run
명령어를 실행합니다.
gcloud workflows run callback-event-sample \ --location=us-central1
워크플로 실행이 시작됩니다. 실행 중에 다음과 비슷한 실행 상태가 표시됩니다.
Waiting for execution [a848a164-268a-449c-b2fe-396f32f2ed66] to complete...working...
이벤트 생성 및 실행 상태 확인
이벤트를 생성하고, 로그 항목을 보고, 워크플로 실행 상태를 확인하여 결과가 예상한 대로 발생하는지 확인할 수 있습니다.
메시지 게시
이전에 만든 Pub/Sub 주제에 메시지를 게시합니다.
콘솔
Google Cloud 콘솔에서 Pub/Sub 주제 페이지로 이동합니다.
topic-callback을 클릭합니다.
메시지 탭을 클릭합니다.
메시지 게시를 클릭합니다.
메시지 본문 필드에서
Hello World
를 입력합니다.게시를 클릭합니다.
gcloud
메시지를 게시하려면 gcloud pubsub topics publish 명령어를 사용합니다.
gcloud pubsub topics publish topic-callback \ --message="Hello World"
객체 업로드
이전에 만든 Cloud Storage 버킷에 파일을 업로드합니다.
콘솔
- Google Cloud 콘솔에서 Cloud Storage 버킷 페이지로 이동합니다.
이전에 만든 버킷의 이름을 클릭합니다.
객체 탭에서 다음 중 하나를 수행합니다.
원하는 파일을 바탕화면이나 파일 관리자에서 Google Cloud 콘솔의 기본 창으로 드래그 앤 드롭합니다.
파일 업로드를 클릭하고 업로드할 파일을 선택한 후 열기를 클릭합니다.
gcloud
파일을 업로드하기 위해 gcloud storage cp
명령어를 실행합니다.
gcloud storage cp OBJECT_LOCATION gs://PROJECT_ID-bucket-callback/
OBJECT_LOCATION
을 객체의 로컬 경로로 바꿉니다. 예를 들면 random.txt
입니다.
로그 항목 및 실행 상태 보기
callback-event-sample
워크플로가 성공적으로 완료되었는지 확인합니다.
콘솔
Google Cloud 콘솔에서 Workflows 페이지로 이동합니다.
워크플로 페이지에서 callback-event-sample 워크플로를 클릭하여 세부정보 페이지로 이동합니다.
워크플로 세부정보 페이지에서 특정 실행의 세부정보를 검색하려면 해당하는 실행 ID를 클릭합니다.
실행 상태가 성공으로 표시되고 출력 창에는 수신된 Pub/Sub 및 Cloud Storage 이벤트가 표시됩니다.
gcloud
로그 항목을 필터링하고 JSON 형식으로 출력을 반환합니다.
gcloud logging read "resource.type=workflows.googleapis.com/Workflow AND textPayload:calling OR textPayload:waiting" \ --format=json
다음과 비슷한 로그 항목을 찾습니다.
"textPayload": "Stopped waiting for an event from source..." "textPayload": "Calling back url https://workflowexecutions.googleapis.com/v1/projects/..." "textPayload": "Started waiting 1hr for an event from source..."
마지막 실행 시도의 상태를 확인합니다.
gcloud workflows executions wait-last
결과는 다음과 비슷하게 표시됩니다.
Using cached execution name: projects/1085953646031/locations/us-central1/workflows/callback-event-sample/executions/79929e4e-82c1-4da1-b068-f828034c01b7 Waiting for execution [79929e4e-82c1-4da1-b068-f828034c01b7] to complete...done. [...] state: SUCCEEDED
삭제
이 튜토리얼용으로 새 프로젝트를 만든 경우 이 프로젝트를 삭제합니다. 기존 프로젝트를 사용한 경우 이 튜토리얼에 추가된 변경사항은 제외하고 보존하려면 튜토리얼용으로 만든 리소스를 삭제합니다.
프로젝트 삭제
비용이 청구되지 않도록 하는 가장 쉬운 방법은 튜토리얼에서 만든 프로젝트를 삭제하는 것입니다.
프로젝트를 삭제하는 방법은 다음과 같습니다.
- In the Google Cloud console, go to the Manage resources page.
- In the project list, select the project that you want to delete, and then click Delete.
- In the dialog, type the project ID, and then click Shut down to delete the project.