Pub/Sub 메시지를 사용하여 워크플로 트리거(gcloud CLI)

표준

이 빠른 시작에서는 Pub/Sub를 사용하여 이벤트를 수신하는 Eventarc 트리거를 사용해서 워크플로를 실행하는 방법을 보여줍니다. 트리거는 Pub/Sub를 통해 런타임 인수로 제공되는 이벤트를 대상 워크플로에 전달하여 워크플로를 실행합니다.

이 빠른 시작에서는 다음을 수행합니다.

Workflows를 사용해서 Pub/Sub 메시지를 디코딩하고 반환하는 워크플로를 만들고 배포합니다.
Pub/Sub 주제를 Workflows 이벤트 수신자에 연결하는 Eventarc 트리거를 만듭니다.
Pub/Sub 주제에 메시지를 게시하여 이벤트를 생성합니다. 이 이벤트는 대상 워크플로에 런타임 인수로 전달됩니다.
Pub/Sub 메시지를 워크플로 실행 결과로 확인합니다.

시작하기 전에

Google Cloud Workflows의 비공개 프리뷰에 프로젝트를 추가하도록 요청하여 이 기능에 대한 액세스 권한을 확보해야 합니다.

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.

If you're using an external identity provider (IdP), you must first sign in to the gcloud CLI with your federated identity.

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.

Verify that billing is enabled for your Google Cloud project.

Install the Google Cloud CLI.

If you're using an external identity provider (IdP), you must first sign in to the gcloud CLI with your federated identity.

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.

Verify that billing is enabled for your Google Cloud project.

gcloud 구성요소를 업데이트합니다.
```
gcloud components update
```

Compute Engine, Eventarc, Pub/Sub, Workflows API를 사용 설정합니다.

gcloud services enable \
compute.googleapis.com \
eventarc.googleapis.com \
pubsub.googleapis.com \
workflows.googleapis.com \
workflowexecutions.googleapis.com

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

export WORKFLOW_LOCATION=us-central1
export TRIGGER_LOCATION=us-central1
export PROJECT_ID=PROJECT_ID
gcloud config set project ${PROJECT_ID}
gcloud config set workflows/location ${WORKFLOW_LOCATION}
gcloud config set eventarc/location ${TRIGGER_LOCATION}

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

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

빠른 시작을 완료하는 데 필요한 권한을 얻으려면 관리자에게 프로젝트에 대한 다음 IAM 역할을 부여해 달라고 요청하세요.
- 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)
- Workflows 관리자(roles/workflows.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일 이후에 조직을 만든 경우 기본적으로 이 제약조건이 적용됩니다.

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

기본 서비스 계정에 이미 편집자 역할이 있으면 편집자 역할을 권한이 더 낮은 역할로 바꾸는 것이 좋습니다.서비스 계정 역할을 안전하게 수정하려면 정책 시뮬레이터를 사용하여 변경사항의 영향을 확인한 후 적절한 역할을 부여하고 취소합니다.
Compute Engine 기본 서비스 계정에 프로젝트에 대한 Workflows 호출자 역할(roles/workflows.invoker)을 부여하여 계정에 워크플로 실행을 트리거할 권한을 부여합니다.
```
gcloud projects add-iam-policy-binding PROJECT_ID \
    --member=serviceAccount:PROJECT_NUMBER-compute@developer.gserviceaccount.com \
    --role=roles/workflows.invoker
```
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
```

워크플로 생성 및 배포

Pub/Sub 주제에 게시된 메시지가 HTTP 요청으로 워크플로를 트리거할 때 실행되는 워크플로를 만들고 배포합니다.

터미널 또는 Cloud Shell을 엽니다.
홈 디렉터리에 myFirstWorkflow.yaml 또는 myFirstWorkflow.json이라는 이름의 새 파일을 만듭니다.

다음을 복사하여 새 파일에 붙여넣은 후 저장합니다.

YAML

main:
  params: [event]
  steps:
    - decode_pubsub_message:
        assign:
           - base64: ${base64.decode(event.data.message.data)}
           - message: ${text.decode(base64)}
    - return_pubsub_message:
        return: ${message}

JSON

{
  "main": {
    "params": [
      "event"
    ],
    "steps": [
      {
        "decode_pubsub_message": {
          "assign": [
            {
              "base64": "${base64.decode(event.data.message.data)}"
            },
            {
              "message": "${text.decode(base64)}"
            }
          ]
        }
      },
      {
        "return_pubsub_message": {
          "return": "${message}"
        }
      }
    ]
  }
}

워크플로를 배포합니다.
```
export MY_WORKFLOW=myFirstWorkflow
gcloud workflows deploy ${MY_WORKFLOW} --source=myFirstWorkflow.yaml
```
예시 워크플로의 JSON 버전을 복사한 경우 .yaml을 .json으로 바꿉니다.

Eventarc 트리거 만들기

메시지가 Pub/Sub 주제에 게시되었으면 이벤트가 워크플로를 트리거합니다.

Pub/Sub 메시지를 리슨하는 트리거를 만듭니다.
새 Pub/Sub 주제
gcloud eventarc triggers create events-pubsub-trigger \ --destination-workflow=${MY_WORKFLOW} \ --destination-workflow-location=${WORKFLOW_LOCATION} \ --event-filters="type=google.cloud.pubsub.topic.v1.messagePublished" \ --service-account="PROJECT_NUMBER-compute@developer.gserviceaccount.com"
이렇게 하면 새 Pub/Sub 주제와 events-pubsub-trigger라는 트리거가 생성됩니다.
기존 Pub/Sub 주제
gcloud eventarc triggers create events-pubsub-trigger \ --destination-workflow=${MY_WORKFLOW} \ --destination-workflow-location=${WORKFLOW_LOCATION} \ --event-filters="type=google.cloud.pubsub.topic.v1.messagePublished" \ --service-account="PROJECT_NUMBER-compute@developer.gserviceaccount.com" \ --transport-topic=TOPIC_ID
TOPIC_ID를 기존 Pub/Sub 주제의 ID로 바꿉니다.

기존 Pub/Sub 주제에 대한 events-pubsub-trigger라는 이름의 트리거를 만듭니다.
참고: 기본적으로 Eventarc용으로 생성된 Pub/Sub 구독은 활동과 관계없이 유지되며 만료되지 않습니다. 비활성 기간을 변경하려면 구독 속성을 참조하세요.

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

트리거가 성공적으로 생성되었는지 확인하세요.

gcloud eventarc triggers describe events-pubsub-trigger --location=${TRIGGER_LOCATION}

출력은 생성 시간 및 트리거 위치가 나열된 다음 목록과 비슷하게 표시됩니다.

createTime: '2021-10-14T15:15:43.872360951Z'
[...]
name: projects/PROJECT_ID/locations/us-central1/triggers/events-pubsub-trigger

이벤트 생성 및 확인

Pub/Sub 주제에 메시지를 게시하여 이벤트를 생성하고 워크플로를 트리거합니다. 생성된 이벤트가 워크플로에 런타임 인수로 전달되고, 이는 Pub/Sub 메시지를 워크플로 실행 결과로 반환합니다. 워크플로에 전달하는 이벤트 크기가 512KB를 초과하지 않도록 해야 합니다.

새 Pub/Sub 주제에 대해 트리거를 만들었으면 생성된 Pub/Sub 주제를 찾아서 환경 변수로 설정합니다.

export TOPIC_ID=$(basename $(gcloud eventarc triggers describe events-pubsub-trigger --format='value(transport.pubsub.topic)'))

워크플로를 트리거하기 위해 메시지를 Pub/Sub 주제에 전송합니다.
```
gcloud pubsub topics publish $TOPIC_ID --message "Hello there"
```
생성된 이벤트가 워크플로에 런타임 인수로 전달되고 "Hello there" 메시지가 반환됩니다.

워크플로 실행이 트리거되었는지 확인하려면 마지막의 5개 실행을 나열합니다.

gcloud workflows executions list ${MY_WORKFLOW} --limit=5

출력은 다음과 유사해야 하며, 각 워크플로 실행에서 SUCCEEDED와 동일한 NAME 및 STATE를 나열해야 합니다.

NAME: projects/606789101455/locations/us-central1/workflows/myFirstWorkflow/executions/8c02b8f1-8836-4a6d-99d9-fc321eb9668f
STATE: SUCCEEDED
START_TIME: 2021-09-13T19:15:10.275677049Z
END_TIME: 2021-09-13T19:15:10.963136883Z
NAME: projects/606789101455/locations/us-central1/workflows/myFirstWorkflow/executions/a6319d9d-36a6-4117-904e-3d1118bdc90a
STATE: SUCCEEDED
START_TIME: 2021-09-13T17:28:51.492864252Z
END_TIME: 2021-09-13T17:28:52.227212414Z

위의 예시에서 NAME 필드의 a6319d9d-36a6-4117-904e-3d1118bdc90a는 워크플로 실행의 ID입니다. 다음 단계에서 사용할 실행 ID를 복사합니다.

실행 상태를 보려면 다음 명령어를 실행합니다.

gcloud workflows executions describe WORKFLOW_EXECUTION_ID --workflow=${MY_WORKFLOW}

WORKFLOW_EXECUTION_ID를 Pub/Sub 주제의 게시 시간과 일치하는 워크플로 실행 ID로 바꿉니다. 출력은 다음과 비슷합니다.

argument: [...]
endTime: '2021-09-13T17:28:47.301012152Z'
name: projects/1234567/locations/us-central1/workflows/myFirstWorkflow/executions/f72bc6d4-5ea0-4dfb-bb14-2dae82303120
result: 'Hello there'
startTime: '2021-09-13T17:28:51.492864252Z'
state: SUCCEEDED

Pub/Sub 메시지가 게시된 publish_time과 워크플로 실행 startTime이 서로 일치하는지 확인합니다.

수고하셨습니다. Eventarc를 사용하여 Workflows 이벤트 수신자를 트리거한 Pub/Sub 주제를 사용해서 성공적으로 이벤트를 생성했습니다.

삭제

만든 워크플로를 삭제합니다.
```
gcloud workflows delete ${MY_WORKFLOW}
```
계속 진행할지 묻는 메시지가 표시되면 y를 입력합니다.

만든 트리거를 삭제합니다.

gcloud eventarc triggers delete events-pubsub-trigger

또는 Google Cloud 프로젝트를 삭제하여 비용 청구를 방지할 수 있습니다. Google Cloud 프로젝트를 삭제하면 프로젝트 내에서 사용되는 모든 리소스에 대한 비용 청구가 중지됩니다.
주의: 프로젝트를 삭제하면 다음과 같은 효과가 발생합니다.
- 프로젝트의 모든 항목이 삭제됩니다. 이 문서의 태스크에 기존 프로젝트를 사용한 경우 프로젝트를 삭제하면 프로젝트에서 수행한 다른 작업도 삭제됩니다.
- 커스텀 프로젝트 ID가 손실됩니다. 이 프로젝트를 만들 때 앞으로 사용할 커스텀 프로젝트 ID를 만들었을 수 있습니다. appspot.com URL과 같이 프로젝트 ID를 사용하는 URL을 보존하려면 전체 프로젝트를 삭제하는 대신 프로젝트 내에서 선택한 리소스만 삭제합니다.
Delete a Google Cloud project:
```
gcloud projects delete PROJECT_ID
```

Pub/Sub 메시지를 사용하여 워크플로 트리거(gcloud CLI)

시작하기 전에

필수 권한

워크플로 생성 및 배포

YAML

JSON

Eventarc 트리거 만들기

새 Pub/Sub 주제

기존 Pub/Sub 주제

이벤트 생성 및 확인

삭제

다음 단계