デプロイメントを使用すると、リモート Git リポジトリに保存されているコード(パイプラインなど)の実行をスケジュール設定できます。コードが保存されているディレクトリを選択して、次の操作を行うことができます。
- リモート リポジトリに接続されたデプロイメントを作成して管理します。
- リモート リポジトリからコードを pull して定期的にコードを実行するようにトリガーを構成します。
- スケジュールまたは他のトリガーを使用してパイプラインを実行します。
- コンソール内で実行のログを直接表示します。 Google Cloud アラートの場合、Dataform デプロイメントは Cloud Logging および Cloud Monitoring と統合されます。
制限事項
- デプロイメントにはアラート機能が組み込まれていません。アラートを構成するには、Logging と Monitoring を使用する必要があります。
- Developer Connect を使用した認証では、接続のみがサポートされ、アカウント コネクタはサポートされません。
始める前に
デプロイメントを作成する前に、次のタスクを完了します。
- コンソールの [パイプラインと接続] ページを使用するようにオプトインします。 Google Cloud
BigQuery API、Dataform API、Developer Connect API を有効にします。
必要なロール
このドキュメントのタスクを実行するために必要な権限を取得するには、次の IAM ロールを付与するように管理者へ依頼してください。
- プロジェクトに対する Dataform 管理者 (
roles/dataform.admin) - BigQuery ジョブユーザー (
roles/bigquery.jobUser) プロジェクトに対する - プロジェクトに対する Developer Connect 閲覧者 (
roles/developerconnect.viewer) -
カスタム サービス アカウントを使用してデプロイメントを実行する:
サービス アカウント ユーザー (
roles/iam.serviceAccountUser) カスタム サービス アカウントに対する
ロールの付与については、プロジェクト、フォルダ、組織へのアクセス権の管理をご覧ください。
必要な権限は、カスタム ロールや他の事前定義 ロールから取得することもできます。
カスタム サービス アカウントを使用してデプロイメントを実行するには、カスタム サービス アカウントに
BigQuery データ編集者ロール
(roles/bigquery.dataEditor)も付与する必要があります。
Deployment の作成
Dataform デプロイメントを作成する手順は次のとおりです。
コンソールで、[パイプラインと接続] ページに移動します。 Google Cloud
[作成] > [デプロイメントの作成] をクリックします。
リポジトリの認証タイプを選択し、次のいずれかのオプションを選択します。
Developer Connect
- リポジトリとブランチを選択します。
- コードが保存されているディレクトリのパスを入力します。
- デプロイメントの名前を入力します。
- デプロイメントのリージョンを選択します。
[スケジュールの頻度] セクションで、次の操作を行います。
- [繰り返しの頻度] メニューで、スケジュールされたパイプライン実行の頻度を選択します。
- [時刻] フィールドに、スケジュールされたパイプラインの実行時刻を入力します。
- [タイムゾーン] メニューで、スケジュールのタイムゾーンを選択します。
または、[オンデマンド] を選択して、デプロイメントをオンデマンドで実行します。
省略可: Google Cloud プロジェクト ID を入力します。
省略可: テーブル接頭辞を入力します。
省略可: コンパイル変数を入力します。
[デプロイ] をクリックします。
HTTPS
- リモートの Git リポジトリの URL を入力します。
- ブランチを選択します。
- コードが保存されているディレクトリのパスを入力します。
- HTTPS リモートの個人アクセス トークンを含むシークレットを入力します。詳細については、 HTTPS 経由でリモート リポジトリに接続するをご覧ください。
- デプロイメントの名前を入力します。
- デプロイメントのリージョンを選択します。
[スケジュールの頻度] セクションで、次の操作を行います。
- [繰り返しの頻度] メニューで、スケジュールされたパイプライン実行の頻度を選択します。
- [時刻] フィールドに、スケジュールされたパイプラインの実行時刻を入力します。
- [タイムゾーン] メニューで、スケジュールのタイムゾーンを選択します。
または、[オンデマンド] を選択して、デプロイメントをオンデマンドで実行します。
省略可: Google Cloud プロジェクト ID を入力します。
省略可: テーブル接頭辞を入力します。
省略可: コンパイル変数を入力します。
[デプロイ] をクリックします。
SSH
- リモートの Git リポジトリの URL を入力します。
- ブランチを選択します。
- コードが保存されているディレクトリのパスを入力します。
- ユーザーの秘密鍵と SSH 公開ホスト鍵の値を含むシークレットを入力します。詳細については、 SSH 経由でリモート リポジトリに接続するをご覧ください。
- デプロイメントの名前を入力します。
- デプロイメントのリージョンを選択します。
[スケジュールの頻度] セクションで、次の操作を行います。
- [繰り返しの頻度] メニューで、スケジュールされたパイプライン実行の頻度を選択します。
- [時刻] フィールドに、スケジュールされたパイプラインの実行時刻を入力します。
- [タイムゾーン] メニューで、スケジュールのタイムゾーンを選択します。
または、[オンデマンド] を選択して、デプロイメントをオンデマンドで実行します。
省略可: Google Cloud プロジェクト ID を入力します。
省略可: テーブル接頭辞を入力します。
省略可: コンパイル変数を入力します。
[デプロイ] をクリックします。
デプロイのリスト表示
作成したデプロイメントを一覧表示する手順は次のとおりです。
コンソールで、[パイプラインと接続] ページに移動します。 Google Cloud
デプロイメントのリストを表示します。
デプロイメント スケジュールを作成する
デプロイメントのスケジュールを作成する手順は次のとおりです。
コンソールで、[パイプラインと接続] ページに移動します。 Google Cloud
[デプロイメント] タブをクリックし、デプロイメントを選択します。
[デプロイメントの詳細] ページの [トリガー(ワークフロー構成)] セクションで、[作成] をクリックします。
In the [**ワークフロー構成の作成**] ペインで、 ワークフロー構成を作成する手順に沿って操作します。
デプロイメント スケジュールを実行する
デプロイメントのスケジュールを実行する手順は次のとおりです。
コンソールで、[パイプラインと接続] ページに移動します。 Google Cloud
[デプロイメント] タブをクリックし、デプロイメントを選択します。
[トリガー(ワークフロー構成)] セクションで、実行する デプロイメント スケジュールの横にある [アクションを表示 > 今すぐ実行] をクリックします。
デプロイメント スケジュールを削除する
デプロイメントのスケジュールを削除する手順は次のとおりです。
コンソールで、[パイプラインと接続] ページに移動します。 Google Cloud
[デプロイメント] タブをクリックし、デプロイメントを選択します。
[**デプロイメントの詳細**] ページの [**トリガー(ワークフロー構成)**] セクションで、削除するデプロイメント スケジュールの横にある [**アクションを表示 > 削除**] をクリックします。
アラートの設定
ワークフローの実行が失敗したときに通知を受け取るには、 失敗したワークフロー呼び出しに対するアラートを構成します。
次のステップ
- リポジトリを作成する方法を 確認する。
- 実行を スケジュール設定する方法を確認する。
- アラートを 構成する方法を確認する。