リポジトリを作成する

このドキュメントでは、Dataform のリポジトリのコンセプトと、新しいリポジトリの作成方法について説明します。

Dataform リポジトリについて

各 Dataform リポジトリには、SQL ワークフローを構成する SQLX と JavaScript ファイルのコレクション、Dataform 構成ファイルとパッケージが格納されています。リポジトリ内のファイルは開発ワークスペースで操作します。

Dataform では、リポジトリは [Dataform] ページでリポジトリ ID のアルファベット順に表示され、並べ替えとフィルタリングを行えます。

• リポジトリを表示するには、 Google Cloud コンソールで [Dataform] ページに移動します。

  Dataform に移動

各 Dataform リポジトリは、カスタム サービス アカウントに接続する必要があります。カスタム サービス アカウントは、リポジトリを作成するときに選択します。サービス アカウントは後で編集できます。

Dataform では、変更の記録とファイルのバージョン管理のために、Git を使用します。 各 Dataform リポジトリは Git リポジトリに対応しています。Dataform リポジトリを作成したら、リモートの GitHub、GitLab、または Bitbucket リポジトリに接続できます。

Dataform リポジトリでは、Dataform がリポジトリ コードを保存します。接続されたリポジトリで、サードパーティのリポジトリがリポジトリ コードを保存します。Dataform をサードパーティのリポジトリと連携させることで、Dataform 開発ワークスペースでその内容を編集して実行できるようになります。

Dataform リポジトリ ページは、次のコンポーネントで構成されています。

[開発ワークスペース] タブ

リポジトリに作成された開発ワークスペースを表示します。

[ワークフローの実行ログ] タブ

Dataform ワークフローの実行ログを表示します。

[リリースとスケジュール] タブ

リリース構成とワークフロー構成を検査、作成、編集、削除できます。

[設定] タブ

リポジトリの名前と場所が表示されます。サードパーティの Git リポジトリに接続されているリポジトリの場合は、サードパーティのリポジトリ ソース、デフォルトのブランチ名、シークレット トークンを表示します。サードパーティの Git リポジトリにリポジトリを接続し、Git 接続を編集するためのボタンが表示されます。

[開発ワークスペースを作成] ボタン

開発ワークスペースを作成できます。

開発ワークスペースを作成して初期化したら、ワークフロー設定ファイルを編集して、リポジトリの次の Dataform 設定を構成できます。

• デフォルト データベース（Google Cloud プロジェクト ID）。
• デフォルトのスキーマ（BigQuery データセット ID）。
• デフォルトの BigQuery のロケーション
• アサーションのデフォルトのスキーマ（BigQuery データセット ID）
• ウェアハウス。bigquery に設定する必要があります
• コンパイル中にプロジェクト コードで使用できるユーザー定義変数。

重要: Dataform で作成されたリポジトリは、BigQuery リポジトリに表示されません。

Dataform リポジトリの設定の詳細については、Dataform コアのリファレンスの IProjectConfig をご覧ください。

リポジトリ設定

Dataform リポジトリを作成するときは、次のリポジトリ設定を行う必要があります。

リポジトリ ID

リポジトリの一意の ID。ID には数字、英字、ハイフン、アンダースコアのみを使用できます。

リージョン

リポジトリとそのコンテンツを保存する Dataform リージョン。

このストレージ リージョンは、Dataform がコードを処理して実行の出力を保存する処理リージョンとは異なる場合があります。デフォルトでは、処理リージョンはデフォルトの BigQuery データセット リージョンに設定されます。リポジトリの作成後に、ワークフロー設定ファイルで処理リージョンを編集できます。詳細については、Dataform ワークフロー設定を構成するをご覧ください。

サービス アカウント

リポジトリに関連付けられているカスタム サービス アカウント。 Google Cloud プロジェクトに関連付けられたサービス アカウントを選択することも、別のサービス アカウントを手動で入力することもできます。

リポジトリでワークフローを実行するには、カスタム サービス アカウントを使用する必要があります。他のすべてのリポジトリ オペレーションは、デフォルトの Dataform サービス エージェントによって実行されます。

厳格な act-as モード

サービス アカウントに対する iam.serviceAccounts.actAs 権限を必要とする追加のセキュリティ チェックを有効にします。すべてのリポジトリに対して厳格な act-as モードが適用されます。

暗号化

リポジトリの暗号化方式。デフォルトの暗号化、一意の顧客管理の Cloud KMS 暗号鍵、またはデフォルトの Dataform CMEK 鍵を使用できます。Dataform で顧客管理の暗号鍵（CMEK）を使用する方法については、顧客管理の暗号鍵を使用するをご覧ください。

リポジトリを作成したら、GitHub または GitLab に接続できます。

重要: dataform.restrictGitRemotes ポリシーで許可リストに登録されていないリモート Git リポジトリに接続する Dataform リポジトリを作成するには、まずリモート Git リポジトリをポリシーの allowedValues リストに追加してから、新しい Dataform リポジトリを作成して、リモート リポジトリに接続します。詳細については、リモート リポジトリを制限するをご覧ください。

始める前に

Google Cloud アカウントにログインします。 Google Cloudを初めて使用する場合は、 アカウントを作成して、実際のシナリオでの Google プロダクトのパフォーマンスを評価してください。新規のお客様には、ワークロードの実行、テスト、デプロイができる無料クレジット $300 分を差し上げます。

In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

Roles required to select or create a project

• Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
• Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

Go to project selector

Verify that billing is enabled for your Google Cloud project.

Enable the BigQuery and Dataform 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

In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

Roles required to select or create a project

• Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
• Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

Go to project selector

Verify that billing is enabled for your Google Cloud project.

Enable the BigQuery and Dataform 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

1. リポジトリに CMEK 暗号化を使用するには、Dataform リポジトリの CMEK 暗号化を有効にします。

重要: リモートの Git リポジトリに接続する Dataform リポジトリを作成する前に、組織またはプロジェクトが、dataform.restrictGitRemotes 組織のポリシーを使用してリモートの Git リポジトリを制限しているかどうかを確認します。ポリシーが設定されている場合は、Dataform リポジトリを作成してリモート リポジトリに接続する前に、リモート リポジトリが許可リストに登録されていることを確認してください。詳細については、リモート リポジトリを制限するをご覧ください。

必要なロール

リポジトリの作成と削除に必要な権限を取得するには、リポジトリに対する次の IAM ロールを付与するよう管理者に依頼してください。

• Dataform 管理者（roles/dataform.admin）- プロジェクト
• カスタム サービス アカウントに対するサービス アカウント ユーザー ロール（roles/iam.serviceAccountUser）

ロールの付与については、プロジェクト、フォルダ、組織へのアクセス権の管理をご覧ください。

必要な権限は、カスタムロールや他の事前定義ロールから取得することもできます。

必要なロールを付与する

Dataform リポジトリと BigQuery でワークフローを実行するには、カスタム サービス アカウントまたは Google アカウントを使用できます。

カスタム サービス アカウントには、次の必須ロールが必要です。

• Dataform が読み取りと書き込みの両方のアクセス権を必要とするプロジェクトまたは特定の BigQuery データセットに対する BigQuery データ編集者（roles/bigquery.dataEditor）。通常は、Dataform リポジトリをホストするプロジェクトが含まれます。
• Dataform が読み取り専用アクセス権を必要とするプロジェクトまたは特定の BigQuery データセットに対する BigQuery データ閲覧者（roles/bigquery.dataViewer）。
• Dataform リポジトリをホストするプロジェクトに対する BigQuery ジョブユーザー（roles/bigquery.jobUser）。

Dataform でカスタム サービス アカウントを使用できるようにするには、デフォルトの Dataform サービス エージェントにカスタム サービス アカウント リソースに対する次のロールが必要です。

• サービス アカウント トークン作成者（roles/iam.serviceAccountTokenCreator）
• サービス アカウント ユーザー（roles/iam.serviceAccountUser）

これらのロールを付与するには、次の手順に沿って操作します。

1. Google Cloud コンソールで、[IAM] ページに移動します。

   IAM に移動

2. [アクセス権を付与] をクリックします。

3. [新しいプリンシパル] フィールドに、カスタム サービス アカウント ID を入力します。

4. [ロールを選択] メニューで、次のロールを 1 つずつ選択します。追加のロールごとに [別のロールを追加] を使用します。

   • BigQuery データ編集者
   • BigQuery データ閲覧者
   • BigQuery ジョブユーザー

5. [保存] をクリックします。

6. Google Cloud コンソールで、[サービス アカウント] ページに移動します。

   [サービス アカウント] に移動

7. カスタム サービス アカウントを選択します。

8. [アクセス権を持つプリンシパル] に移動し、[アクセス権を付与] をクリックします。

9. [新しいプリンシパル] フィールドに、デフォルトの Dataform サービス エージェント ID を入力します。

   デフォルトの Dataform サービス エージェント ID の形式は次のとおりです。

   [e-mail]
   

   PROJECT_NUMBER は、Google Cloud プロジェクトの数値 ID に置き換えます。 Google Cloud プロジェクト ID は、Google Cloud コンソール ダッシュボードで確認できます。詳細については、プロジェクトの識別をご覧ください。

10. [ロールを選択] リストで、次のロールを追加します。

    • サービス アカウント ユーザー
    • サービス アカウント トークン作成者

11. [保存] をクリックします。

ロールの付与の詳細については、Dataform に必要なアクセス権を付与するをご覧ください。

リポジトリを作成する

Dataform リポジトリを作成する手順は次のとおりです。

1. Google Cloud コンソールで、[Dataform] ページに移動します。

   Dataform に移動

2. [リポジトリを作成] をクリックします。

3. [リポジトリの作成] ページの [リポジトリ ID] フィールドに一意の ID を入力します。

   ID には数字、英字、ハイフン、アンダースコアのみを使用できます。

4. [リージョン] プルダウン リストで、リポジトリとそのコンテンツを保存する Dataform リージョンを選択します。自分の場所に最も近い Dataform リージョンを選択します。

   使用可能な Dataform リージョンの一覧については、ロケーションをご覧ください。リポジトリ リージョンは、BigQuery データセットのロケーションと一致する必要はありません。

   workflow_settings.yaml ファイルで、Dataform がコードを処理し、実行の出力を保存する処理リージョンを設定できます。処理リージョンは、BigQuery データセットのロケーションと一致する必要がありますが、リポジトリ リージョンと一致する必要はありません。詳細については、Dataform ワークフロー設定を構成するをご覧ください。

5. [サービス アカウント] メニューで、リポジトリのカスタム サービス アカウントを選択します。

   重要: リポジトリの作成時に、デフォルトの Dataform サービス エージェントを選択することはできません。リポジトリにはカスタム サービス アカウントを使用する必要があります。

   メニューで、アクセス権のあるGoogle Cloud プロジェクトに関連付けられているカスタム サービス アカウントを選択できます。カスタム サービス アカウントは、ワークフローの実行にのみ使用されます。他のすべてのリポジトリ オペレーションは、デフォルトの Dataform サービス エージェントによって実行されます。

   1. 省略可: メニューに表示されていないサービス アカウントを選択するには（たとえば、ロールのリストを表示するために必要な iam.serviceAccounts.list 権限がない場合）、[手動で入力] をクリックして、サービス アカウント ID を入力します。
   注: iam.serviceAccounts.list 権限は、サービス アカウントの閲覧ロール（roles/iam.serviceAccountViewer）で使用できます。

6. [actAs 権限チェック] セクションで、リポジトリに対するユーザー アクションの権限チェックを適用します。これらのチェックの詳細については、厳格な act-as モードを使用するをご覧ください。

7. リポジトリ用に選択した暗号化メカニズムを構成します。

   注意: リポジトリの作成後に、Dataform リポジトリの暗号化メカニズムを変更することはできません。詳細については、Dataform CMEK の制限事項をご覧ください

   デフォルトの CMEK 鍵

   Dataform に [デフォルトの KMS 鍵を使用する] チェックボックスが表示され、デフォルトでオンになっています。

   • デフォルトの Dataform CMEK 鍵でリポジトリを暗号化するには、[デフォルトの KMS 鍵を使用する] チェックボックスをオンのままにします。

   注意: [デフォルトの KMS 鍵を使用する] チェックボックスをオンにしても、プロジェクトにデフォルトの Dataform CMEK 鍵が設定されていない場合、Dataform はリポジトリに保存データの暗号化を適用します。顧客管理の暗号鍵を使用します。

   一意の CMEK 鍵

   一意の CMEK 鍵でリポジトリを暗号化する手順は次のとおりです。

   1. [デフォルトの KMS 鍵を使用する] チェックボックスがデフォルトでオンになっている場合は、チェックボックスをオフにします。
   2. [暗号化] セクションで、[顧客管理の暗号鍵（CMEK）] オプションを選択します。
   3. [顧客管理の暗号鍵を選択] プルダウンで、一意の CMEK 鍵を選択します。

   保存時の暗号化

   • デフォルトの暗号化を使用するには、[暗号化] セクションで [Google-managed encryption key] オプションを選択します。

   注意: リポジトリのリージョンにデフォルトの Dataform CMEK 鍵が設定されている場合は、CMEK 暗号化を使用する必要があります。[Google-managed encryption key] オプションは選択しないでください。詳細については、Dataform CMEK の制限事項をご覧ください。

8. [作成] をクリックし、[リポジトリに移動] をクリックします。

サービス アカウントを編集する

リポジトリでワークフローを実行するには、カスタム サービス アカウントを使用する必要があります。他のすべてのリポジトリ オペレーションは、デフォルトの Dataform サービス エージェントによって実行されます。

Dataform リポジトリのサービス アカウントを編集する手順は次のとおりです。

1. Google Cloud コンソールで、[Dataform] ページに移動します。

   Dataform に移動

2. リポジトリを選択して、[設定] をクリックします。

   注: Dataform リポジトリ リストには、Dataform ワークフロー開発用に作成されたリポジトリのみが含まれます。ノートブックや保存済みクエリなどの BigQuery Studio アセットのリポジトリは個別に管理され、このリストには表示されません。

3. [サービス アカウント] フィールドの横にある [サービス アカウントを編集] をクリックします。

4. [サービス アカウント] メニューで、リポジトリのサービス アカウントを選択します。

   メニューで、アクセス権のあるGoogle Cloud プロジェクトに関連付けられているカスタム サービス アカウントを選択できます。

   1. 省略可: メニューに表示されていないサービス アカウントを選択するには、[手動で入力] をクリックして、サービス アカウント ID を入力します。

5. [保存] をクリックします。

リポジトリを削除する

リポジトリとそのすべてのコンテンツを削除するには、次の手順を行います。

1. Google Cloud コンソールで、[Dataform] ページに移動します。

   Dataform に移動

2. 削除するリポジトリの横にある （その他）メニューをクリックし、[削除] を選択します。

3. [リポジトリの削除] ウィンドウで、リポジトリの名前を入力して削除を確定します。

4. [削除] をクリックします。

次のステップ

• Dataform リポジトリをサードパーティの Git リポジトリに接続する方法については、サードパーティの Git リポジトリに接続するをご覧ください。
• リポジトリ サイズが Dataform での開発に与える影響については、リポジトリ サイズの概要をご覧ください。
• Dataform でリポジトリを分割する方法については、リポジトリの分割の概要をご覧ください。
• Dataform の処理設定の構成方法については、Dataform ワークフロー設定を構成するをご覧ください。
• ワークスペースを作成して初期化する方法については、ワークスペースを作成するをご覧ください。