Git 接続の設定とテスト

新しいプロジェクトを作成する場合、開発モードの場合にのみ存在します。他のユーザーに影響を与えない安全な環境でモデルを開発できます。プロジェクトを公開する準備ができたら、次のステップでは Git 接続を構成します。

プロジェクトに Git 接続を構成すると、LookML を本番環境モードにデプロイできます。これにより、他のユーザーがデータモデルを探索し、ダッシュボードを構築して、LookML をモデルに追加できます。設定を短時間で行うには、ベアメタル リポジトリを使用します。より堅牢な Git 統合を行うには、独自の Git リポジトリを作成し、このページの手順に沿って Looker インスタンスに接続します。

Looker と Git の統合

Looker は、Git を使用して変更を記録し、ファイルのバージョンを管理します。各 LookML プロジェクトは 1 つの Git リポジトリに対応し、ユーザーが開発モードになったときは、いつでも自分の Git ブランチに配置されます。Git リポジトリは通常、リポジトリと呼ばれます。

LookML のソースファイル管理では、認証に SSH 認証鍵または HTTPS を使用する Git プロバイダを使用して Looker を構成できます。どのプラットフォームを使用する場合でも、一般的な手順は同じです。このページでは、Git リポジトリを作成した後に Looker プロジェクトを Git に接続するための例として GitHub を使用します。

Git 統合オプションにアクセスするには、開発モードを有効にする必要があります。

Git 統合は、次のいずれかのプロトコルを使用して構成できます。

  • HTTPS: HyperText Transfer Protocol Secure。HTTPS を使用する場合、Looker は、以下の HTTPS を使用して Git に接続するで説明されているように、ユーザーが指定したユーザー名とパスワード(またはアクセス トークン)で Git リポジトリにアクセスします。
  • SSH: セキュアシェルSSH の場合、Looker は、Git プロバイダのウェブサイトを介して生成したデプロイキーを使用して Git リポジトリにアクセスします(以下の SSH を使用した Git への接続を参照)。

HTTPS を使用して Git に接続する

GitHub では、github.com での Git オペレーションの認証用のアカウントのパスワードを使用できません。詳しくは、GitHub のブログ投稿をご覧ください。HTTPS を使用して Looker プロジェクトを GitHub に接続するには、GitHub のデベロッパー設定を使用して個人用のアクセス トークンを作成します。HTTPS を使用して GitHub に接続する既存の Looker プロジェクトの場合は、GitHub の個人アクセス トークンを使用して Git 接続をリセットします。

HTTPS 認証で構成された LookML プロジェクトの場合、Looker は、Git プロバイダで設定された 1 つ以上のユーザー アカウントを使用して Git プロバイダに接続します。Looker は、ユーザー名とパスワード(またはアクセス トークン)を使用して Git プロバイダにログインし、LookML デベロッパーの代わりに Git オペレーションを実行します。

Git アカウントで 2 要素認証プロセスを使用している場合は、Git プロバイダに移動し、パスワードの代わりに使用するアクセス トークンを作成できます。一般的な Git プロバイダの個人用アクセス トークンの作成手順については、こちらのコミュニティ トピックをご覧ください。

HTTPS 認証を使用すると、LookML プロジェクトはプロジェクト全体で単一の Git アカウントを使用するように構成できます。また、開発者が個々の Git アカウントを使用して Git オペレーションを実行できるように構成することもできます。

単一アカウントの HTTPS 認証

LookML プロジェクトを 1 つの Git アカウントで設定している場合、Looker はその Git アカウントを使用して Git プロバイダにログインし、デベロッパーに代わって変更を commit します。Looker は、デベロッパーの Looker ユーザー名を使用してこれらの commit を行うため、どのデベロッパーがどの commit を行ったかがわかります。プロジェクトの commit 履歴は、Git プロバイダのインターフェースで確認できます。または、Looker IDE の Git メニューから [履歴] オプションを選択して表示することもできます。Looker の Git メニューの詳細については、Looker での Git コマンドの実行をご覧ください。

単一アカウントの HTTPS 認証では、指定する Git ユーザー アカウントに、Git リポジトリへの読み取りおよび書き込みアクセス権限が必要です。LookML 開発者自身に Git ユーザー アカウントを用意する必要はありません。

ユーザー属性による複数アカウントの HTTPS 認証

複数のアカウントで LookML プロジェクトを設定した場合、LookML プロジェクトはそれぞれの Looker デベロッパーの個々の Git アカウントを使用して Git オペレーションを実行します。また、少なくとも 1 つの読み取りアクセス権を持つ一般的な Git ユーザー アカウントを 1 つ構成し、Looker が本番環境のファイルの pull に使用する必要があります。

ユーザー属性を使用した Git 認証には、次のタスクと要件が必要です。

  • LookML デベロッパーは、Git プロバイダごとに独自のユーザー アカウントを用意する必要があります。各 Git ユーザー アカウントには、プロジェクトのリポジトリへの読み取り / 書き込みアクセス権が必要です。
  • Looker 管理者は、Git ユーザー名と Git パスワードに対応するユーザー属性(Git ユーザー アカウントに 2 要素認証プロセスがある場合はアクセス トークン)を使用して Looker ユーザー アカウントを設定する必要があります。
  • Git アカウントのパスワード(またはアクセス トークン)のユーザー属性を非表示にする必要があります。パスワードまたはアクセス トークン属性を作成するときに、[Hide Values] オプションで [Yes] を選択し、[Domain Allowlist] フィールドに Git プロバイダの URL を入力します。
  • Git ユーザー名とパスワード(またはアクセス トークン)のユーザー属性は、Looker 開発者ごとに入力する必要があります。ユーザー属性は Looker 管理者または Looker ユーザーによって構成できます。

以下は、[User Attributes] 管理ページの例です。Looker 管理者が Git ユーザー名とユーザー アクセス トークンのユーザー属性を設定しています。

以下は、Looker ユーザーの [アカウント] ページの例です。ユーザーがユーザー属性フィールドに Git 認証情報を入力しています。

HTTPS Git 認証の構成

HTTPS Git 認証を使用して LookML プロジェクトを構成するには:

  1. Git リポジトリの HTTPS URL を取得します。GitHub の場合、新しいリポジトリ(まだファイルを含まないリポジトリ)の場合、GitHub は初期設定の一部として URL を表示します。[HTTPS] ボタンをクリックして HTTPS URL を入手し、コピーボタンをクリックしてクリップボードにコピーします。

    既存の GitHub リポジトリ(すでにファイルが含まれているリポジトリ)の場合は、リポジトリの [Code] タブに移動し、[Code] ボタンをクリックすると HTTPS URL を確認できます。[HTTPS] リンクをクリックします。クリップボード アイコンをクリックして、クリップボードにコピーできます。

  2. LookML プロジェクトに移動し、ナビゲーション バーで [Settings] アイコンをクリックし、[Configure Git] セクション(新しいプロジェクトの場合)または [Reset Git Connection] セクション(以前に Git に接続したことがある既存のプロジェクトの場合)まで下にスクロールします。

    Git 接続をリセットすると、マスター ブランチの Git 履歴が保持されます。また、各 Looker デベロッパーの個人ブランチが pull、マージ、デプロイされると、そのブランチの履歴が保持されます。すべてのブランチの履歴を保持するには、ヘルプセンターの記事新しい Git リポジトリへの移行をご覧ください。

  3. Looker の [Git の構成] セクションで、[リポジトリの URL] フィールドに Git リポジトリの HTTPS URL を貼り付け、[続行] をクリックします。

    Looker が Git プロバイダを検出し、Git リポジトリに関する情報でウィンドウを更新します。

    Looker が Git プロバイダを正常に検出できない場合は、プルダウンから選択するように求められます。

  4. Git ログイン オプションを選択します。

  5. [Username] フィールドと [Password] / [Personal Access Token] フィールドに、LookML プロジェクトが Git へのアクセスに使用する認証情報を入力します。これは、Git のログイン設定に関係なく必要です。

    • [Use a single, 定数のユーザー名とパスワード、/ 個人アクセス トークンの組み合わせを使用する] を選択した場合、Looker インスタンスがすべての Git オペレーションに使用する Git ユーザー名とパスワード(またはアクセス トークン)です。この Git ユーザー アカウントには、Git リポジトリへの読み取りおよび書き込みアクセス権が必要です。
    • [Use user CSS for username and password/personal access token] を選択した場合、これは、Looker インスタンスがリポジトリの本番環境バージョンの pull に使用する、Git のユーザー名とパスワードです。この Git ユーザー アカウントには、少なくとも Git リポジトリへの読み取りアクセス権が必要です。

    Git アカウントで 2 要素認証が使用されている場合、または GitHub を使用している場合(パスワードの代わりに個人用のアクセス トークンが必要な場合)は、Git プロバイダにアクセスしてパスワードの代わりに使用するアクセス トークンを作成できます。一般的な Git プロバイダの個人用アクセス トークンの作成手順については、こちらのコミュニティ トピックをご覧ください。

  6. [ユーザー名、パスワード、個人用アクセス トークンにユーザー属性を使用する] を選択した場合、ユーザー属性の設定が表示されます。プルダウン メニューを使用して、各デベロッパーの Git 認証情報のユーザー属性を選択します。

    (Looker ユーザーは [Account] ページでユーザー属性フィールドの値を編集でき、Looker 管理者は [Users] 管理ページでユーザーのユーザー属性値を編集できます)。

  7. [設定を続行] をクリックします。

これで Git が LookML プロジェクト用に構成されました。ここで、LookML を検証し、最初の commit を作成して本番環境にデプロイします。これにより、プロジェクトを本番環境モードで使用できるようになります。次の操作も行えます。

SSH を使用した Git への接続

SSH 認証を使用して、Git プロバイダのデプロイキーを作成します。Looker によって SSH 認証鍵ペアが生成され、以下のステップ 4 に示すように公開鍵が UI に表示されます。Looker は、このデプロイキーを使用して Git プロバイダにログインし、Looker デベロッパーに代わって変更を commit します。Looker は、デベロッパーの Looker ユーザー名を使用して commit します。これにより、各 commit を行ったデベロッパーを確認できます。プロジェクトの commit 履歴は、Git プロバイダのインターフェースで確認できます。または、Looker IDE の Git メニューから [履歴] オプションを選択して表示することもできます。Looker の Git メニューの詳細については、Looker での Git コマンドの実行をご覧ください。

SSH Git 認証を使用して LookML プロジェクトを構成するには:

  1. プロジェクトを開き、プロジェクトの設定パネルで [構成] を選択して、プロジェクトの構成を表示します。次に、以下のいずれかを行います。

    • 新しいプロジェクトの場合は、プロジェクト構成セクションで [Configure Git] ボタンを選択します。
    • 既存のプロジェクトの Git 設定を変更するには、プロジェクト構成セクションで [Reset Git Connection] を選択します。

    Git 接続をリセットすると、マスター ブランチの Git 履歴が保持されます。また、各 Looker デベロッパーの個人ブランチが pull、マージ、デプロイされると、そのブランチの履歴が保持されます。すべてのブランチの履歴を保持するには、ヘルプセンターの記事新しい Git リポジトリへの移行をご覧ください。

  2. Git リポジトリの SSH URL を取得します。一般的な Git プロバイダの形式は次のとおりです。

    • GitHub: git@github.com:<organization-name>/<repository-name>.git
    • GitHub Enterprise: git@example.com:<organization-name>/<repository-name>.git
    • Cloud Source Repositories: ssh://username@example.com@source.developers.google.com:2022/p/<project-id>/r/<repository-name>
    • GitLab: git@gitlab.com:<organization-name>/<repository-name>.git
    • Bitbucket: git@bitbucket.org:<organization-name>/<repository-name>.git
    • Phabricator: ssh://username@example.com/diffusion/MYCALLSIGN/<repository-name>.git

    GitHub の場合、新しいリポジトリ(まだファイルを含まないリポジトリ)の場合、GitHub は初期設定の一部として SSH URL を表示します。[SSH] ボタンをクリックして SSH URL を取得し、クリップボード アイコンをクリックしてクリップボードにコピーします。

    既存の GitHub リポジトリ(すでにファイルが含まれているリポジトリ)の場合は、リポジトリの [Code] タブに移動し、[Code] ボタンをクリックすると、SSH URL を確認できます。必ず [SSH を使用] をクリックしてください。クリップボード アイコンをクリックして、クリップボードにコピーできます。

  3. Looker の [Git の構成] セクションで、[リポジトリの URL] フィールドに Git リポジトリの SSH URL を貼り付け、[続行] をクリックします。

    カスタムまたは標準以外の Git ポートを持つ URL は、標準以外のポート番号を Git URL に追加することで Looker で使用できます。例: ssh://git@corporate.git.server.com:22/myorganization/myproject.git
    正常に動作するには、ssh:// を含める必要があります。

  4. Looker が Git プロバイダを検出し、リポジトリのデプロイキーを表示します。(Looker で Git プロバイダが適切に検出されなかった場合は、プルダウンから選択するよう求められます)。デプロイキー全体を選択してクリップボードにコピーし、[Deploy Key settings for your repository] リンクをクリックして、GitHub リポジトリの GitHub Deploy キーページを開きます。

  5. GitHub の [Deploy keys] ページで、[Add deploy key] ボタンをクリックします。

    GitHub に [Deploy keys / Add new] ページが表示されます。

  6. デプロイキーのタイトルを追加します。名前は重要ではありませんが、「Looker」とプロジェクトのタイトルを含めておくと、後で確認しやすくなります。

  7. Looker からコピーしたデプロイキーを貼り付けます。

  8. [書き込みアクセスを許可する] オプションを選択します。
    LookerML モデルに変更を加えてこれをデプロイするには、Looker でこの設定が必要となるため、これは重要なステップです

  9. [鍵を追加] ボタンをクリックします。(この時点で、Git プロバイダからパスワードの入力を求められることがあります。その場合は、パスワードを入力して [パスワードを確認] をクリックします)。

  10. GitHub には、リポジトリに追加されたすべてのデプロイキーが表示されます。

  11. Looker ウィンドウに戻り、[Configure Git] セクションの [Test and Finalize Setup] をクリックします。Git の設定に問題がある場合は、次のようなエラーが表示されます。

ここで、デプロイキーの設定をもう一度試すか、[テストをスキップして設定を完了] をクリックして現在の設定を保持してください。

これで Git が LookML プロジェクト用に構成されました。ここで、LookML を検証し、最初の commit を作成して本番環境にデプロイします。これにより、プロジェクトを本番環境モードで使用できるようになります。次の操作も行えます。

ベアメタル版 Git リポジトリの構成

リモート Git リポジトリをまだ作成していない場合や、LookML の利点を活用できるようセットアップをすぐに行う場合は、ベアメタル Git リポジトリを構成できます。ベアメタル版 Git リポジトリを構成すると、リモート リポジトリに接続するのではなく、Looker インスタンスにローカル Git リポジトリが作成されます。

ベアメタル版 Git リポジトリを使用して LookML プロジェクトを構成するには:

  1. プロジェクトを開き、プロジェクトの設定パネルで [構成] を選択して、プロジェクトの構成を表示します。次に、以下のいずれかを行います。

    • 新しいプロジェクトの場合は、プロジェクト構成セクションで [Configure Git] ボタンを選択します。
    • 既存のプロジェクトの Git 設定を変更するには、プロジェクト構成セクションで [Reset Git Connection] を選択します。

    Git 接続をリセットすると、マスター ブランチの Git 履歴が保持されます。また、Looker デベロッパーが個人ブランチを pull してマージし、デプロイした後も、そのブランチの履歴が保持されます。すべてのブランチの履歴を保持するには、ヘルプセンターの記事新しい Git リポジトリへの移行をご覧ください。

  2. Looker の [Configure Git] ダイアログ ボックスで、[Set an Bare repository] をクリックします。

  3. [Configure Bare Git Repository] ダイアログ ボックスで、[Create Repository] をクリックします。

    Git リポジトリを作成すると、新しい Git リポジトリへのパスを示すダイアログ ボックスが Looker に表示されます。

これで Git が LookML プロジェクト用に構成されました。ここで、LookML を検証し、最初の commit を作成して本番環境にデプロイします。これにより、プロジェクトを本番環境モードで使用できるようになります。次の操作も行えます。

新しい LookML プロジェクトを空でない Git リポジトリに接続する

Git をバージョン管理用に構成することは、新しい LookML プロジェクトを作成するための重要なステップです。通常、プロジェクトごとに独自のリポジトリが必要です。ただし、次のような場合は、既存の LookML を含む Git リポジトリを使用してプロジェクトを構成する必要があります。

  • インスタンス間で既存の LookML プロジェクトを移動する場合
  • 新しいプロジェクトで使用するために、壊れた、または機能しなくなった LookML プロジェクトのコードを復活させる場合

このセクションでは、LookML をさらに開発するために、空でない既存の Git リポジトリを使用して新しい LookML プロジェクトを構成するためのベスト プラクティスについて説明します。

このワークフローは、書き込みアクセス権を持つリポジトリ専用です。

  1. 出発点として [Blank Project] を選択して、新しい LookML プロジェクトを作成します。空のプロジェクトは、データベース スキーマや SQL クエリからではなく、既存のリポジトリから LookML オブジェクトが入力されるため、出発点になります。
  2. HTTPS または SSH でプロジェクトの Git を構成する。Git の構成セクションの [リポジトリの URL] セクションで空でないプロジェクトの URL を使用します。
  3. プロジェクトに Git を構成したら、[Git Actions] パネルから本番環境から pull します。
  4. 本番環境から pull が完了したら、[Deploy to Production] を選択します。

プロジェクトで LookML に加えた変更は、元のリポジトリには影響しません。元のリポジトリのローカル バージョンに保存されます。

空の LookML プロジェクトのベースとして使用する公開リポジトリがあるものの、そのリポジトリへの書き込みアクセス権がない場合は、新しい LookML プロジェクトの作成に関するドキュメント ページの公開 Git リポジトリのクローン作成の手順を行います。

複数のインスタンスで 1 つのリポジトリを使用して Git ワークフローを設定する場合は、複数のインスタンスにまたがる 1 つのリポジトリ(開発、ステージング、本番環境)を使用した Git ワークフローのコミュニティ トピックをご覧ください。

Git 接続のテスト

Looker には、Git 接続を検証するための Git 接続テストが用意されています。Git 接続テストでは、正しい Git URL が設定されており、Looker が Git ホストに到達できることを確認します。また、Git 接続テストでは、有効な Git デプロイキーを指定したことと、デプロイキーに Git リポジトリへの書き込みアクセス権があることも確認します。

Looker が Git リポジトリに接続できない場合は、[Test Git Connection] ボタンが表示されます。

Git アクションのテストツールで [Test Git Connection] を選択して、Git 接続テストツールにアクセスすることもできます。

Git 接続テストツールには、Git 接続をテストするための手順が表示されます。テスト成功の例を次に示します。

この例の Git リポジトリには、Looker 接続用に構成されたデプロイキーがありません。