알림 구성 자동화

Cloud Build 알리미를 사용하여 Slack, Google Chat, SMTP 서버, HTTP 엔드포인트 또는 BigQuery 인스턴스로 빌드 알림을 보내도록 Cloud Build를 구성할 수 있습니다. 이 페이지에서는 원하는 알리미에 대한 구성 프로세스를 자동화하는 방법을 설명합니다.

알림 구성 자동화

Cloud Build는 알림 구성을 자동화하는 데 사용할 수 있는 설정 스크립트를 제공합니다. 설정 스크립트를 사용하여 알림을 구성하려면 다음 안내를 따르세요.

Slack

설정

다음 섹션에서는 알리미의 알림 구성을 자동화하기 전에 완료해야 하는 단계를 설명합니다.

API 사용 설정 중

Enable the Cloud Build, Compute Engine, Cloud Run, Pub/Sub, and Secret Manager APIs.

Enable the APIs

사용자 인증 정보 가져오기 및 저장

알림을 보낼 Slack 작업공간의 Slack 앱을 만듭니다.
수신 웹훅을 활성화하여 Cloud Build의 메시지를 Slack에 게시합니다.
Slack 앱으로 이동하여 수신 웹훅의 URL을 찾습니다. URL은 다음과 비슷하게 표시됩니다.
```
http://hooks.slack.com/services/...
```
수신 웹훅 URL을 Secret Manager에 저장합니다.
1. Google Cloud Console에서 보안 비밀 관리자 페이지를 엽니다.
  
  보안 비밀 페이지 열기
2. 보안 비밀 만들기를 클릭합니다.
3. 보안 비밀의 이름을 입력합니다.
4. 보안 비밀 값 아래에서 Slack 앱의 수신 웹훅 URL을 추가합니다.
5. 보안 비밀을 저장하려면 보안 비밀 만들기를 클릭합니다.

알리미 구성 파일 작성

알리미 구성 파일을 작성하여 Slack 알리미를 구성하고 빌드 이벤트로 필터링합니다.

다음 알리미 구성 파일 예시에서 filter 필드는 사용 가능한 변수 build와 함께 Common Expression Language를 사용하여 SUCCESS 상태의 빌드 이벤트를 필터링합니다.

  apiVersion: cloud-build-notifiers/v1
  kind: SlackNotifier
  metadata:
    name: example-slack-notifier
  spec:
    notification:
      filter: build.status == Build.Status.SUCCESS
      delivery:
        webhookUrl:
          secretRef: webhook-url
      template:
        type: golang
        uri: gs://example-gcs-bucket/slack.json
    secrets:
    - name: webhook-url
      value: projects/project-id/secrets/secret-name/versions/latest

각 항목의 의미는 다음과 같습니다.

webhook-url은 Secret Manager에 저장된 Slack 웹훅 URL 경로를 참조하기 위해 이 예시에 사용된 구성 변수입니다. 여기에서 지정하는 변수 이름은 secrets 아래의 name 필드와 일치해야 합니다.
project-id는 Google Cloud 프로젝트의 ID입니다.
secret-name은 Slack 웹훅 URL이 포함된 보안 비밀의 이름입니다.
uri 필드는 slack.json 파일을 참조합니다. 이 파일은 Cloud Storage에서 호스팅되는 JSON 템플릿을 포함하며 Slack 공간에 대한 알림 메시지를 나타냅니다.

예시를 보려면 Slack 알리미의 알리미 구성 파일을 참조하세요.

자동화 스크립트 실행

알리미의 알림 구성을 자동화하려면 다음 안내를 따르세요.

cloud-build-notifiers 저장소를 클론합니다.
프로젝트 ID 및 리전으로 Google Cloud CLI를 구성합니다.
```
gcloud config set project project-id
gcloud config set run/region region
```
각 항목의 의미는 다음과 같습니다.
- project-id는 Google Cloud 프로젝트 ID입니다.
- region은 알리미를 배포할 리전입니다.
저장소 루트에서 다음 명령어를 실행합니다.

    ./setup.sh slack config-path -t template-path -s secret-name

각 항목의 의미는 다음과 같습니다.

config-path는 알리미 구성 파일의 경로입니다.
template-path는 알리미 템플릿 파일의 경로입니다. 알리미 템플릿 파일은 Cloud Storage에서 호스팅되는 JSON 템플릿을 포함하며 알림 메시지를 나타냅니다. 이 변수를 사용하는 경로로 또는 알리미 구성 파일의 uri 필드 내에서 알리미 템플릿 파일을 포함할 수 있습니다.
secret-name은 Secret Manager에 저장된 보안 비밀의 이름입니다.

스크립트를 실행한 후 다음 메시지가 표시됩니다.

** NOTIFIER SETUP COMPLETE **

알리미가 설정되었습니다. cloud-build-notifiers 저장소에서 전체 스크립트를 확인하거나 스크립트와 관련된 사용 안내를 보려면 ./setup.sh --help를 실행할 수 있습니다.

SMTP

설정

다음 섹션에서는 알리미의 알림 구성을 자동화하기 전에 완료해야 하는 단계를 설명합니다.

API 사용 설정 중

Enable the Cloud Build, Compute Engine, Cloud Run, Pub/Sub, and Secret Manager APIs.

Enable the APIs

사용자 인증 정보 저장

보내는 사람의 이메일 계정 비밀번호를 Secret Manager에 저장합니다.
Google Cloud Console에서 보안 비밀 관리자 페이지를 엽니다.

보안 비밀 페이지 열기
보안 비밀 만들기를 클릭합니다.
보안 비밀의 이름을 입력합니다.
보안 비밀 값 아래에서 보내는 사람의 이메일 계정 비밀번호를 추가합니다.
보안 비밀을 저장하려면 보안 비밀 만들기를 클릭합니다.

알리미 구성 파일 작성

SMTP 알리미를 구성하고 빌드 이벤트로 필터링하도록 알리미 구성 파일을 작성합니다.

 apiVersion: cloud-build-notifiers/v1
 kind: SMTPNotifier
 metadata:
   name: example-smtp-notifier
 spec:
   notification:
     filter: build.status == Build.Status.SUCCESS
     delivery:
       server: server-host-name
       port: "port"
       sender: sender-email
       from: from-email
       recipients:
         - recipient-email
         # optional: more emails here
       password:
         secretRef: smtp-password
      template:
        type: golang
        uri: gs:example-gcs-bucket/smtp.html
   secrets:
   - name: smtp-password
     value: projects/project-id/secrets/secret-name/versions/latest

각 항목의 의미는 다음과 같습니다.

server-host-name은 SMTP 서버의 주소입니다.
port는 SMTP 요청을 처리할 포트입니다. 이 값은 문자열로 지정해야 합니다.
sender-email은 지정된 server-host-name에 표시되는 발신자 계정의 이메일 주소입니다.
from-email은 수신자에게 표시되는 이메일 주소입니다.
recipient-email은 발신자의 메시지를 받기 위한 하나 이상의 이메일 주소 목록입니다.
smtp-password는 Secret Manager에 저장된 보내는 사람의 이메일 계정 비밀번호를 참조하기 위해 이 예시에서 사용되는 구성 변수입니다. 여기에서 지정하는 변수 이름은 secrets 아래의 name 필드와 일치해야 합니다.
project-id는 Google Cloud 프로젝트의 ID입니다.
secret-name은 발신자의 이메일 계정에 대한 암호가 포함된 보안 비밀의 이름입니다.
uri 필드는 smtp.html 파일을 참조합니다. 이 파일은 Cloud Storage에서 호스팅되는 HTML 템플릿을 참조하며 알림 이메일을 나타냅니다.

예시를 보려면 SMTP 알리미에 대한 알리미 구성 파일을 참조하세요.

자동화 스크립트 실행

알리미의 알림 구성을 자동화하려면 다음 안내를 따르세요.

cloud-build-notifiers 저장소를 클론합니다.
프로젝트 ID 및 리전으로 Google Cloud CLI를 구성합니다.
```
gcloud config set project project-id
gcloud config set run/region region
```
각 항목의 의미는 다음과 같습니다.
- project-id는 Google Cloud 프로젝트 ID입니다.
- region은 알리미를 배포할 리전입니다.
저장소 루트에서 다음 명령어를 실행합니다.

    ./setup.sh smtp config-path -t template-path -s secret-name

각 항목의 의미는 다음과 같습니다.

config-path는 알리미 구성 파일의 경로입니다.
template-path는 알리미 템플릿 파일의 경로입니다. 알리미 템플릿 파일은 Cloud Storage에서 호스팅되는 JSON 템플릿을 포함하며 알림 메시지를 나타냅니다. 이 변수를 사용하는 경로로 또는 알리미 구성 파일의 uri 필드 내에서 알리미 템플릿 파일을 포함할 수 있습니다.
secret-name은 Secret Manager에 저장된 보안 비밀의 이름입니다.

스크립트를 실행한 후 다음 메시지가 표시됩니다.

** NOTIFIER SETUP COMPLETE **

BigQuery

설정

다음 섹션에서는 알리미의 알림 구성을 자동화하기 전에 완료해야 하는 단계를 설명합니다.

API 사용 설정 중

Enable the Cloud Build, Cloud Run, Pub/Sub, and BigQuery APIs.

Enable the APIs

권한 부여

Cloud Run 서비스 계정에 BigQuery 테이블을 만들고 쓰는 권한과 빌드와 관련된 Artifact Registry 데이터를 가져올 수 있는 권한을 부여합니다.

Google Cloud Console의 IAM 페이지로 이동합니다.

IAM 페이지 열기
프로젝트와 연결된 Compute Engine 기본 서비스 계정을 찾습니다.

Compute Engine 기본 서비스 계정은 다음과 비슷하게 표시되는데, 여기서 project-number는 프로젝트 번호입니다.
```
    project-number-compute@developer.gserviceaccount.com
```
Compute Engine 기본 서비스 계정이 있는 행에서 연필 아이콘을 클릭합니다.

수정 액세스 탭이 표시됩니다.
1. 다른 역할 추가를 클릭합니다.
2. 다음 역할을 추가합니다.
  - Artifact Registry 리더
  - BigQuery 데이터 편집자
    
    Artifact Registry 리더 역할을 사용하면 이미지의 데이터를 가져올 수 있습니다. BigQuery 데이터 편집자는 데이터에 대한 읽기 및 쓰기 액세스 권한을 제공합니다.
3. 저장을 클릭합니다.

알리미 구성 파일 작성

알리미 구성 파일을 작성하여 BigQuery 알리미를 구성하고 빌드 이벤트로 필터링합니다.

다음 알리미 알림 구성 파일 예시에서 filter 필드는 build인 변수와 함께 Common Expression Language를 사용하여 지정된 트리거 ID로 빌드 이벤트를 필터링합니다.

 apiVersion: cloud-build-notifiers/v1
 kind: BigQueryNotifier
 metadata:
   name: example-bigquery-notifier
 spec:
   notification:
     filter: build.build_trigger_id == "123e4567-e89b-12d3-a456-426614174000"
     delivery:
       table: projects/project-id/datasets/dataset-name/tables/table-name
     template:
       type: golang
       uri: gs://example-gcs-bucket/bq.json

각 항목의 의미는 다음과 같습니다.

project-id는 Google Cloud 프로젝트의 ID입니다.
dataset-name은 데이터 세트에 지정할 이름입니다.
table-name은 테이블에 지정할 이름입니다.

알리미 구성 파일의 table-name은 다음을 참조할 수 있습니다.

존재하지 않는 테이블
스키마가 없는 빈 테이블
BigQuery 알리미의 스키마 사양과 일치하는 스키마가 포함된 기존 테이블
참고: BigQuery 알리미와 스키마 사양이 일치하지 않는 기존 테이블을 참조하면 오류가 발생합니다.
uri 필드는 bq.json 파일을 참조합니다. 이 파일은 Cloud Storage에서 호스팅되는 JSON 템플릿을 참조하며 BigQuery 테이블에 삽입할 정보를 나타냅니다.

예시를 보려면 BigQuery 알리미에 대한 알리미 구성 파일을 참조하세요.

자동화 스크립트 실행

알리미의 알림 구성을 자동화하려면 다음 안내를 따르세요.

cloud-build-notifiers 저장소를 클론합니다.
프로젝트 ID 및 리전으로 Google Cloud CLI를 구성합니다.
```
gcloud config set project project-id
gcloud config set run/region region
```
각 항목의 의미는 다음과 같습니다.
- project-id는 Google Cloud 프로젝트 ID입니다.
- region은 알리미를 배포할 리전입니다.
저장소 루트에서 다음 명령어를 실행합니다.
```
 ./setup.sh bigquery -t config-path -t template-path
```
각 항목의 의미는 다음과 같습니다.
- config-path는 알리미 구성 파일의 경로입니다.
- template-path는 알리미 템플릿 파일의 경로입니다. 알리미 템플릿 파일은 Cloud Storage에서 호스팅되는 JSON 템플릿을 포함하며 알림 메시지를 나타냅니다. 이 변수를 사용하는 경로로 또는 알리미 구성 파일의 uri 필드 내에서 알리미 템플릿 파일을 포함할 수 있습니다.
스크립트를 실행한 후 다음 메시지가 표시됩니다.
```
** NOTIFIER SETUP COMPLETE **
```
알리미가 설정되었습니다. cloud-build-notifiers 저장소에서 전체 스크립트를 확인하거나 스크립트와 관련된 사용 안내를 보려면 ./setup.sh --help를 실행할 수 있습니다.

HTTP

설정

다음 섹션에서는 알리미의 알림 구성을 자동화하기 전에 완료해야 하는 단계를 설명합니다.

API 사용 설정 중

Enable the Cloud Build, Cloud Run, and Pub/Sub APIs.

Enable the APIs

알리미 구성 파일 작성

알리미 구성 파일을 작성하여 HTTP 알리미를 구성하고 빌드 이벤트로 필터링합니다.

    apiVersion: cloud-build-notifiers/v1
    kind: HTTPNotifier
    metadata:
      name: example-http-notifier
    spec:
      notification:
        filter: build.status == Build.Status.SUCCESS
        delivery:
          # The `http(s)://` protocol prefix is required.
          url: url
        template:
          type: golang
          uri: gs://example-gcs-bucket/http.json

각 항목의 의미는 다음과 같습니다.

url은 요청의 URL을 지정하기 위해 이 예시에서 사용되는 구성 변수입니다.
url은 수신자 서버로 지정할 URL입니다.
uri 필드는 http.json 파일을 참조합니다. 이 파일은 Cloud Storage에서 호스팅되는 JSON 템플릿을 참조하며 웹훅 엔드포인트에 대한 JSON 페이로드를 나타냅니다.

예시를 보려면 HTTP 알리미의 알리미 구성 파일을 참조하세요.

자동화 스크립트 실행

알리미의 알림 구성을 자동화하려면 다음 안내를 따르세요.

cloud-build-notifiers 저장소를 클론합니다.
프로젝트 ID 및 리전으로 Google Cloud CLI를 구성합니다.
```
gcloud config set project project-id
gcloud config set run/region region
```
각 항목의 의미는 다음과 같습니다.
- project-id는 Google Cloud 프로젝트 ID입니다.
- region은 알리미를 배포할 리전입니다.
저장소 루트에서 다음 명령어를 실행합니다.
```
 ./setup.sh http -t config-path
```
각 항목의 의미는 다음과 같습니다.
- config-path는 알리미 구성 파일의 경로입니다.

스크립트를 실행한 후 다음 메시지가 표시됩니다.

** NOTIFIER SETUP COMPLETE **

Google Chat

설정

다음 섹션에서는 알리미의 알림 구성을 자동화하기 전에 완료해야 하는 단계를 설명합니다.

API 사용 설정 중

Enable the Cloud Build, Compute Engine, Cloud Run, Pub/Sub, and Secret Manager APIs.

Enable the APIs

사용자 인증 정보 가져오기 및 저장

Google Chat에서 공간을 만듭니다.
생성된 공간 내에서 Cloud Build의 메시지를 Google Chat에 게시하도록 수신 웹훅을 만듭니다. URL은 다음과 비슷하게 표시됩니다.

https://chat.googleapis.com/v1/spaces/...
수신 웹훅 URL을 Secret Manager에 저장합니다.
1. Google Cloud Console에서 보안 비밀 관리자 페이지를 엽니다.
  
  보안 비밀 페이지 열기
2. 보안 비밀 만들기를 클릭합니다.
3. 보안 비밀의 이름을 입력합니다.
4. 보안 비밀 값 아래에서 Google Chat 공간의 수신 웹훅 URL을 추가합니다.
5. 보안 비밀을 저장하려면 보안 비밀 만들기를 클릭합니다.

알리미 구성 파일 작성

알리미 구성 파일을 작성하여 Google Chat 알리미를 구성하고 빌드 이벤트로 필터링합니다.

  apiVersion: cloud-build-notifiers/v1
  kind: GoogleChatNotifier
  metadata:
    name: example-googlechat-notifier
  spec:
    notification:
      filter: build.status == Build.Status.SUCCESS
      delivery:
        webhookUrl:
          secretRef: webhook-url
    secrets:
    - name: webhook-url
      value: projects/project-id/secrets/secret-name/versions/latest

각 항목의 의미는 다음과 같습니다.

webhook-url은 Secret Manager에 저장된 Google Chat 웹훅 URL 경로를 참조하기 위해 이 예시에 사용된 구성 변수입니다. 여기에서 지정하는 변수 이름은 secrets 아래의 name 필드와 일치해야 합니다.
project-id는 Google Cloud 프로젝트의 ID입니다.
secret-name은 Google Chat 웹훅 URL이 포함된 보안 비밀의 이름입니다.

예시를 보려면 Google Chat 알리미에 대한 알리미 구성 파일을 참조하세요.

자동화 스크립트 실행

알리미의 알림 구성을 자동화하려면 다음 안내를 따르세요.

cloud-build-notifiers 저장소를 클론합니다.
프로젝트 ID 및 리전으로 Google Cloud CLI를 구성합니다.
```
gcloud config set project project-id
gcloud config set run/region region
```
각 항목의 의미는 다음과 같습니다.
- project-id는 Google Cloud 프로젝트 ID입니다.
- region은 알리미를 배포할 리전입니다.
저장소 루트에서 다음 명령어를 실행합니다.

./setup.sh googlechat config-path -s secret-name

각 항목의 의미는 다음과 같습니다.

config-path는 알리미 구성 파일의 경로입니다.
secret-name은 Secret Manager에 저장된 보안 비밀의 이름입니다.

스크립트를 실행한 후 다음 메시지가 표시됩니다.

** NOTIFIER SETUP COMPLETE **

GitHub 문제

설정

다음 섹션에서는 알리미의 알림 구성을 자동화하기 전에 완료해야 하는 단계를 설명합니다.

API 사용 설정 중

Enable the Cloud Build, Compute Engine, Cloud Run, Pub/Sub, and Secret Manager APIs.

Enable the APIs

사용자 인증 정보 가져오기 및 저장

GitHub 개인 액세스 토큰을 만듭니다.
1. GitHub 설정으로 이동하여 새 토큰을 만듭니다.
2. repo 범위를 선택합니다.
  
  참고: 이렇게 하면 비공개 저장소를 포함한 저장소에 대한 전체 액세스 권한이 부여됩니다.
3. 토큰 생성을 클릭합니다.
Secret Manager에 토큰을 저장합니다.
1. Google Cloud 콘솔에서 Secret Manager 페이지를 엽니다.
  
  보안 비밀 페이지 열기
2. 보안 비밀 만들기를 클릭합니다.
3. 보안 비밀의 이름을 입력합니다.
4. 보안 비밀 값에 GitHub 토큰을 추가합니다.
5. 보안 비밀을 저장하려면 보안 비밀 만들기를 클릭합니다.

템플릿 구성 파일 작성

생성된 GitHub 문제가 취해야 할 형식을 설명하는 템플릿 구성 파일을 작성합니다.

다음 템플릿 구성 파일 예시에서 title 및 body 필드는 빌드의 대체 변수를 사용합니다.

{
    "title": "Build {{.Build.BuildTriggerId}}: {{.Build.Status}}",
    "body": "[{{.Build.ProjectId}}] {{.Build.BuildTriggerId}} status: **{{.Build.Status}}**\n\n[View Logs]({{.Build.LogUrl}})"
}

예시를 보려면 GitHub 문제 알리미에 대한 템플릿 구성 파일을 참조하세요.

문제 생성을 위한 GitHub API 엔드포인트의 사용 가능한 본문 매개변수에서 추가 필드를 설정할 수 있습니다.

알리미 구성 파일 작성

알리미 구성 파일을 작성하여 Google Chat 알리미를 구성하고 빌드 이벤트로 필터링합니다.

apiVersion: cloud-build-notifiers/v1
kind: GitHubIssuesNotifier
metadata:
  name: example-githubissues-notifier
spec:
  notification:
    filter: build.status == Build.Status.FAILURE
    template: 
      type: golang
      uri: gs://project-id-notifiers-config/template-file-name
    delivery:
      githubToken:
        secretRef: github-token
      githubRepo: myuser/myrepo
  secrets:
  - name: github-token
    value: projects/project-id/secrets/secret-name/versions/latest

각 항목의 의미는 다음과 같습니다.

githubToken은 Secret Manager에 저장된 GitHub 토큰을 참조하기 위해 이 예시에서 사용되는 구성 변수입니다. 여기에서 지정하는 변수 이름은 secrets 아래의 name 필드와 일치해야 합니다.
project-id-notifiers-config는 템플릿을 업로드할 위치이며 버킷이 아직 없으면 생성됩니다.
template-file-name은 템플릿 파일의 이름입니다.
myuser/myrepo는 문제가 생성될 저장소의 이름입니다.
project-id는 Google Cloud 프로젝트의 ID입니다.
secret-name은 GitHub 토큰이 포함된 보안 비밀의 이름입니다.

예시를 보려면 Google Chat 알리미에 대한 알리미 구성 파일을 참조하세요.

필터링할 수 있는 추가 필드는 빌드 리소스를 참조하세요. 추가적인 필터링 예시에 대해서는 CEL을 사용하여 빌드 이벤트 필터링을 참조하세요.

자동화 스크립트 실행

알리미의 알림 구성을 자동화하려면 다음 안내를 따르세요.

cloud-build-notifiers 저장소를 클론합니다.
프로젝트 ID 및 리전으로 Google Cloud CLI를 구성합니다.
```
gcloud config set project project-id
gcloud config set run/region region
```
각 항목의 의미는 다음과 같습니다.
- project-id는 Google Cloud 프로젝트 ID입니다.
- region은 알리미를 배포할 리전입니다.
저장소 루트에서 다음 명령어를 실행합니다.

    ./setup.sh githubissues config-path -t template-path -s secret-name

각 항목의 의미는 다음과 같습니다.

config-path는 알리미 구성 파일의 경로입니다.
template-path는 알리미 템플릿 파일의 경로입니다. 알리미 템플릿 파일은 Cloud Storage에서 호스팅되는 JSON 템플릿을 포함하며 알림 메시지를 나타냅니다. 이 변수를 사용하는 경로로 또는 알리미 구성 파일의 uri 필드 내에서 알리미 템플릿 파일을 포함할 수 있습니다.
secret-name은 Secret Manager에 저장된 보안 비밀의 이름입니다.

스크립트를 실행한 후 다음 메시지가 표시됩니다.

** NOTIFIER SETUP COMPLETE **

다음 단계

Cloud Build 알리미 알아보기
빌드 알림 구독하는 방법 알아보기
Cloud Build 빌드 구성 파일 작성 방법을 알아보세요.