このページは Cloud Translation API によって翻訳されました。

独自の Notifier の作成

Cloud Build は、選択したチャネルに通知を送信することで、ビルドステータスの更新を通知します。Cloud Build によって管理される通知機能（Slack や SMTP など）に加え、提供されたライブラリを cloud-build-notifiers リポジトリで使用して、独自の Notifier を作成することもできます。

このページでは、独自の Notifier の作成方法について説明します。

始める前に

Enable the Cloud Build, Cloud Run, Pub/Sub, and Secret Manager APIs.
Roles required to enable APIs
To enable APIs, you need the Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains the serviceusage.services.enable permission. Learn how to grant roles.
Enable the APIs

Go プログラミング言語をインストールします。

注: Cloud Build Notifier は Go で記述されています。cloud-build-notifiers リポジトリで提供されるライブラリを使用して独自の Notifier を作成するには、マシンに Go をインストールする必要があります。
Google Cloud CLI をインストールする

設定

マシンでターミナルウィンドウを開きます。

cloud-build-notifiers リポジトリのクローンを作成し、そのリポジトリに移動します。

  git clone https://github.com/GoogleCloudPlatform/cloud-build-notifiers.git && cd cloud-build-notifiers

独自の Notifier 用のディレクトリを追加して、そのディレクトリに移動します。DIRECTORY_NAME はディレクトリの名前です。
```
  mkdir DIRECTORY_NAME && cd DIRECTORY_NAME
```
新しいディレクトリで Go モジュールを初期化します。DIRECTORY_NAME は新しいディレクトリの名前です。
```
  go mod init github.com/GoogleCloudPlatform/cloud-build-notifiers/DIRECTORY_NAME
```
これで、ディレクトリに go.mod ファイルが表示されます。
次の行を go.mod ファイルに追加して、最新バージョンの Notifier を使用していることを確認します。
```
 replace github.com/GoogleCloudPlatform/cloud-build-notifiers/lib/notifiers => ../
```

これで依存関係がセットアップされ、独自の Notifier を作成する準備ができました。

独自の Notifier の作成

cloud-build-notifiers には lib/notifiers ディレクトリが含まれています。lib/notifiers ディレクトリには notifier.go という名前のファイルがあります。このファイルには、独自の Notifier を作成するために使用できるフレームワークが含まれています。

メインファイル内に Notifier を作成するには、2 つのメソッドを定義する必要があります。

新しいディレクトリに、main.go という名前のファイルを作成します。

main.go で、Notifier ライブラリフレームワークとその他の依存関係をインポートします。

package main

import (
	"context"
	"fmt"

	cbpb "cloud.google.com/go/cloudbuild/apiv1/v2/cloudbuildpb"
	"github.com/GoogleCloudPlatform/cloud-build-notifiers/lib/notifiers"
	log "github.com/golang/glog"
	"google.golang.org/protobuf/encoding/prototext"
)

Notifier のメインメソッドを定義します。この例では、logger は Notifier の名前です。
```
func main() {
	if err := notifiers.Main(new(logger)); err != nil {
		log.Fatalf("fatal error: %v", err)
	}
}
```
main メソッドは、notifier.go ファイルで定義された Main メソッドを使用します。これは、Notifier バイナリの設定に使用されます。
インターフェースの変数を定義する Notifier の構造体を定義します。この例では、logger は Notifier の名前です。
```
type logger struct {
	filter notifiers.EventFilter
}
```

Notifier 機能を追加します。この Notifier インターフェースは、以下の 2 つのメソッドで定義されます。

SetUp: SetUp メソッドは構成を受け入れ、シークレットを取得して、指定されたフィルタを構成から pull し、通知の送信に使用できる Common Expression Language 述語として格納します。CEL の詳細については、cel-spec リポジトリをご覧ください。

SendNotification: SendNotification メソッドは、選択したチャンネルまたはサービスに通知を送信するために使用されます。

Notifier の定義は、notifier.go と Go のドキュメントで確認できます。

以下の例では、Notifier インターフェースが、ビルドログを出力するための SetUp と SendNotification メソッドを使用して定義されています。logger は Notifier の名前です。

func (h *logger) SetUp(_ context.Context, cfg *notifiers.Config, _ notifiers.SecretGetter, _ notifiers.BindingResolver) error {
	prd, err := notifiers.MakeCELPredicate(cfg.Spec.Notification.Filter)
	if err != nil {
		return fmt.Errorf("failed to create CELPredicate: %w", err)
	}
	h.filter = prd
	return nil
}

func (h *logger) SendNotification(ctx context.Context, build *cbpb.Build) error {
	// Include custom functionality here.
	// This example logs the build.
	if h.filter.Apply(ctx, build) {
		log.V(1).Infof("printing build\n%s", prototext.Format(build))
	} else {
		log.V(1).Infof("build (%q, %q) did NOT match CEL filter", build.ProjectId, build.Id)
	}

	return nil
}

最終的な main.go ファイルは以下のようになります。この例では、logger が Notifier の名前として使用されます。

package main

import (
	"context"
	"fmt"

	cbpb "cloud.google.com/go/cloudbuild/apiv1/v2/cloudbuildpb"
	"github.com/GoogleCloudPlatform/cloud-build-notifiers/lib/notifiers"
	log "github.com/golang/glog"
	"google.golang.org/protobuf/encoding/prototext"
)


func main() {
	if err := notifiers.Main(new(logger)); err != nil {
		log.Fatalf("fatal error: %v", err)
	}
}


type logger struct {
	filter notifiers.EventFilter
}


func (h *logger) SetUp(_ context.Context, cfg *notifiers.Config, _ notifiers.SecretGetter, _ notifiers.BindingResolver) error {
	prd, err := notifiers.MakeCELPredicate(cfg.Spec.Notification.Filter)
	if err != nil {
		return fmt.Errorf("failed to create CELPredicate: %w", err)
	}
	h.filter = prd
	return nil
}

func (h *logger) SendNotification(ctx context.Context, build *cbpb.Build) error {
	// Include custom functionality here.
	// This example logs the build.
	if h.filter.Apply(ctx, build) {
		log.V(1).Infof("printing build\n%s", prototext.Format(build))
	} else {
		log.V(1).Infof("build (%q, %q) did NOT match CEL filter", build.ProjectId, build.Id)
	}

	return nil
}

次に、Notifier を構成します。

通知の構成

Notifier 構成ファイルを作成し、ビルドイベントに Notifier とフィルタを構成します。

次の Notifier 構成ファイルの例では、filter フィールドで CEL と使用可能な変数 build を使用して、SUCCESS ステータスのビルドイベントをフィルタリングしています。
```
apiVersion: cloud-build-notifiers/v1
kind: YourNotifier
metadata:
  name: logging-sample
spec:
  notification:
    filter: build.status == Build.Status.SUCCESS
```
ここで
- logging-sample は、Notifier の名前です。
フィルタに使用できるその他のフィールドについては、ビルドリソースをご覧ください。フィルタリングに関するその他の例については、CEL を使用してビルドイベントをフィルタリングするをご覧ください。
通知機能構成ファイルを Cloud Storage バケットにアップロードします。
1. Cloud Storage バケットがない場合は、次のコマンドを実行してバケットを作成します。ここで、BUCKET_NAME は命名要件に従って、バケットに付ける名前です。
```
gcloud storage buckets create gs://BUCKET_NAME/
```
2. Notifier 構成ファイルをバケットにアップロードします。
```
gcloud storage cp CONFIG_FILE_NAME gs://BUCKET_NAME/CONFIG_FILE_NAME
```
  ここで
  - BUCKET_NAME はバケットの名前です。
  - CONFIG_FILE_NAME は構成ファイルの名前です。

Notifier をビルドしてデプロイします。

logging-sample の Dockerfile を作成します。


FROM golang AS build-env
COPY . /go-src/
WORKDIR /go-src/
RUN go build -o /go-app .

# From the Cloud Run docs:
# https://cloud.google.com/run/docs/tutorials/pubsub#looking_at_the_code
# Use the official Debian slim image for a lean production container.
# https://hub.docker.com/_/debian
# https://docs.docker.com/develop/develop-images/multistage-build/#use-multi-stage-builds
FROM debian:buster-slim
# Modify sources.list to point to the Debian archive
RUN sed -i 's|deb.debian.org|archive.debian.org|g' /etc/apt/sources.list && \
    sed -i 's|security.debian.org|archive.debian.org/debian-security|g' /etc/apt/sources.list && \
    sed -i '/buster-updates/d' /etc/apt/sources.list && \
    echo "deb http://archive.debian.org/debian buster-updates main contrib non-free" >> /etc/apt/sources.list && \
    set -x && \
    apt-get update --allow-releaseinfo-change && \
    DEBIAN_FRONTEND=noninteractive apt-get install -y ca-certificates && \
    rm -rf /var/lib/apt/lists/*


FROM gcr.io/distroless/base
COPY --from=build-env /go-app /
ENTRYPOINT ["/go-app", "--v=1", "--alsologtostderr"]

次の cloudbuild.yaml ファイルを使用して Notifier をビルドしてデプロイします。

steps:
- # Build the binary and put it into the builder image.
  name: gcr.io/cloud-builders/docker
  args: ['build', '--tag=gcr.io/$PROJECT_ID/logging-sample', '.']

- # Push the container image to Container Registry
  name: gcr.io/cloud-builders/docker
  args: ['push', 'gcr.io/$PROJECT_ID/logging-sample']

- # Deploy to Cloud Run
  name: google/cloud-sdk
  args: 
    - gcloud
    - run
    - deploy
    - logging-sample-notifier
    - --platform=managed
    - --region=us-central1
    - --image=gcr.io/$PROJECT_ID/logging-sample
    - --no-allow-unauthenticated
    - --update-env-vars=CONFIG_PATH=${_CONFIG_PATH}

# Push the image with tags.
images:
- gcr.io/$PROJECT_ID/logging-sample

ここで

_CONFIG_PATH は、Notifier 構成へのパスです（gs://BUCKET_NAME/CONFIG_FILE_NAME.yaml など）。

cloudbuild.yaml を実行するには、Notifier パスを置換変数として渡します。

 gcloud builds submit .  --substitutions=_CONFIG_PATH=gs://BUCKET_NAME/CONFIG_FILE_NAME

プロジェクトに認証トークンを作成する Pub/Sub 権限を付与します。
```
 gcloud projects add-iam-policy-binding PROJECT_ID \
   --member=serviceAccount:service-PROJECT_NUMBER@gcp-sa-pubsub.iam.gserviceaccount.com \
   --role=roles/iam.serviceAccountTokenCreator
```
ここで
- PROJECT_ID は、実際の Google Cloud プロジェクトの ID です。
- PROJECT_NUMBER は Google Cloud プロジェクト番号です。
Pub/Sub サブスクリプション ID を表すサービスアカウントを作成します。
```
gcloud iam service-accounts create cloud-run-pubsub-invoker \
  --display-name "Cloud Run Pub/Sub Invoker"
```
cloud-run-pubsub-invoker を使用するか、 Google Cloud プロジェクト内で一意の名前を使用します。
cloud-run-pubsub-invoker サービスアカウントに Cloud Run Invoker 権限を付与します。
```
gcloud run services add-iam-policy-binding SERVICE_NAME \
   --member=serviceAccount:cloud-run-pubsub-invoker@PROJECT_ID.iam.gserviceaccount.com \
   --role=roles/run.invoker
```
ここで
- SERVICE_NAME は、イメージをデプロイする Cloud Run サービスの名前です。
- PROJECT_ID は、実際の Google Cloud プロジェクトの ID です。
cloud-builds トピックを作成して、Notifier のビルド更新メッセージを受信します。
```
gcloud pubsub topics create cloud-builds
```
ビルド構成ファイルでカスタムトピック名を定義して、メッセージがカスタムトピックに送信されるようにすることもできます。この場合、同じカスタムトピック名でトピックを作成します。
```
gcloud pubsub topics create topic-name
```
詳細については、ビルド通知の Pub/Sub トピックをご覧ください。
Notifier に Pub/Sub push サブスクライバーを作成します。
```
 gcloud pubsub subscriptions create subscriber-id \
   --topic=cloud-builds \
   --push-endpoint=service-url \
   --push-auth-service-account=cloud-run-pubsub-invoker@project-id.iam.gserviceaccount.com
```
ここで
- subscriber-id は、サブスクリプションに付ける名前です。
- service-url は、Cloud Run によって生成された、新しいサービスの URL です。
- project-id は、実際の Google Cloud プロジェクトの ID です。

これで Cloud Build プロジェクトの通知が設定されました。次にビルドを呼び出したときに、構成したフィルタとビルドが一致すると、チャネルに通知が届きます。

テスト通知

gcloud builds submit コマンドを実行してビルドを呼び出し、このガイドで説明される例の通知をテストできます。

次の例では、構成パスとして success.yaml を指定しています。このコマンドを実行すると、最小限のビルドが成功します。また、ビルドログの出力を確認できます。

 gcloud builds submit --no-source --config=success.yaml

ここで、success.yaml は次のようになります。

 steps:
 - name: busybox
   args: ["true"]

次の例では、構成パスとして failure.yaml を指定しています。このコマンドを実行すると、ビルドが失敗します。ビルドログの出力ではなく、ソースで指定した CEL フィルタに一致する項目がないことを示す出力が表示されます。

gcloud builds submit --no-source --config=failure.yaml

ここで、failure.yaml は次のようになります。

 steps:
 - name: busybox
   args: ["false"]

Cloud Run サービスログへのログ出力以外のタスクを実行するように構成された Notifier を作成している場合、gcloud builds submit コマンドを実行して通知をテストすることもできます。ビルドに関連するエラーを確認するには、サービスの Cloud Run ログを確認します。詳しくは、Cloud Run でログを表示するをご覧ください。

次のステップ

Cloud Build Notifier の詳細を確認します。
ビルド通知をサブスクライブする方法を学習する。

独自の Notifier の作成 コレクションでコンテンツを整理 必要に応じて、コンテンツの保存と分類を行います。

始める前に

設定

独自の Notifier の作成

通知の構成

テスト通知

次のステップ

独自の Notifier の作成