高度なデプロイモード

デフォルトの Looker Git 統合では、Looker デベロッパーは変更を開発ブランチに commit してから、開発ブランチを本番環境ブランチにマージします。その後、Looker 環境にデプロイすると、Looker は本番環境ブランチで最新の commit を使用します。(デフォルトの Git ワークフローと、高度な Git 実装のその他のオプションについては、バージョン管理とデプロイの使用に関するドキュメント ページをご覧ください)。

本番環境ブランチで最新の commit を Looker 環境で使用したくない高度な Git 実装の場合、Looker 管理者は高度なデプロイモードを有効にできます。有効にした場合、deploy 権限を持つデベロッパーは、本番環境ブランチで最新の commit を使用する代わりに、別の commit SHA またはタグを Looker 本番環境にデプロイするよう指定できます。別のブランチから commit をデプロイする場合は、高度なデプロイモードの webhook または API エンドポイントを使用できます。

高度なデプロイモードでは、マルチ環境の開発ワークフローにリポジトリを統合できます。このワークフローでは、各環境で異なるバージョンのコードベースを指します。また、1 つ以上のデベロッパーや管理者が、本番環境にデプロイされる変更をより詳細に制御できるようになります。

高度なデプロイモードが有効の場合、Looker IDE には変更を本番環境にデプロイするよう求めるプロンプトがデベロッパーに表示されません。代わりに、変更を本番環境ブランチにマージするよう求めるプロンプトが表示されます。ここから変更をデプロイする方法は次のとおりです。

高度なデプロイモードの有効化

高度なデプロイモードを有効にするには:

  1. 左側のアイコンメニューから [設定] アイコンをクリックして、[プロジェクト設定] ページの [設定] タブに移動します。
  2. [Deployment] セクションの [Enable Advanced Deploy Mode] の横にあるチェックボックスをオンにします。
  3. [Save Project Configuration] ボタンを選択して、変更を保存します。

高度なデプロイモードによるバージョン管理

高度なデプロイモードを有効にすると、IDE のボタンから本番環境へのデプロイができなくなります。その代わりに、デベロッパーが commit を行うときに、本番環境にデプロイするよう促すのではなく、変更をプライマリ ブランチにマージするよう求めるプロンプトが表示されます。

変更は、WebhookAPI、または Looker IDE の Deployment Manager UI を使用して本番環境にデプロイされます。

Deployment Manager

高度なデプロイモードが有効になっているプロジェクトの場合、deploy 権限を持つ Looker デベロッパーは Looker IDE のデプロイ マネージャーを使用して、commit またはタグを Looker 本番環境にデプロイできます。

Deployment Manager には、高度なデプロイモードを使用して以前にデプロイされたすべての commit とタグが表示されます。

このページの Deployment Manager から commit をデプロイするで説明したように、commit はタグの有無にかかわらずデプロイできます。タグを設定した commit をデプロイすると、Deployment Manager にはタグ SHA が表示されます。これは、commit SHA とは異なります。Looker プロジェクトのコミット履歴を使用して、タグに関連付けられた commit SHA を表示できます。タグを使用しない commit をデプロイすると、Deployment Manager は commit SHA を表示します。これは、Git プロバイダのインターフェースまたは Looker プロジェクトの commit 履歴に表示される commit SHA と同じです。

高度なデプロイモードを使用して commit をデプロイしていない場合は、[Commit を選択] ボタンをクリックして、Looker デベロッパーが本番環境ブランチに commit した commit を含む commit 履歴を表示します。

高度なデプロイモードを使用して commit をデプロイしたプロジェクトの場合、commit 履歴には commit に関連するタグ(ある場合)が表示され、本番環境に現在使用されている commit がどれかが示されます。

本番環境ブランチに新たにデプロイされた commit よりも新しい commit がある場合、Deployment Manager にはこの情報が表示され、Looker デベロッパーが本番環境ブランチにマージした最新の commit が表示されます。

Deployment Manager から commit をデプロイする

Deployment Manager から commit をデプロイする方法はいくつかあります。

  1. まだデプロイされていない commit をデプロイするには、[Select Commit] ボタンをクリックして、リモートの本番環境ブランチにマージされたすべての commit から選択します。(別のブランチから commit をデプロイする場合は、高度なデプロイモードの webhook または API エンドポイントを使用します)。
  2. 最新のマージされた commit をリモート本番環境ブランチにデプロイするには、[Deploy Latest] ボタンをクリックします。
  3. 以前にデプロイした commit またはタグをデプロイするには、Deployment Manager でその他メニューをクリックし、[Deploy to Production] を選択します。

まだデプロイされていない commit を選択すると、Deployment Manager に次のようなモーダルが表示されます。

  1. タグを指定せずに commit をデプロイするには、[タグなしでデプロイ] を選択し、[環境へのデプロイ] をクリックします。それ以外の場合は、[タグとデプロイ] オプションを選択したままにします。
  2. commit のタグを指定します。Git タグは、リリース番号やバージョン名など、リポジトリの履歴内の commit の重要度を示します。Git タグについては、次の点に注意してください。

    • Git タグは Git リポジトリ内で一意である必要があります。リポジトリ内の 2 つの異なる commit に同じタグを使用することはできません。
    • Git タグには、スペースや特定の特殊文字を含めることはできません。Git での参照に名前を付けるルールについては、Git リファレンス ドキュメントをご覧ください。
  3. 必要に応じて、タグの説明を追加して、commit に関する詳細を指定することもできます。

  4. [Deploy to Environment] をクリックして、commit を Looker インスタンスの本番環境バージョンにデプロイします。

commit をデプロイすると、Deployment Manager は Looker 本番環境において、commit を現在のバージョンとしてマークします。

Webhook を使用してデプロイする

デプロイ Webhook を設定するには、まず [Project Settings] ページから Looker プロジェクトの Webhook シークレットを追加する必要があります。これにより、承認済みの担当者だけがデプロイ Webhook をトリガーできるようになります。

高度なデプロイモードが有効になっている状態で変更を本番環境にデプロイするには、2 つの Webhook を使用できます。一つはブランチの先頭をデプロイするためのもので、もう一つは特定の Git SHA またはタグをデプロイするためのものです。

ブランチの先頭をデプロイするための Webhook では、次の形式を使用します。

`<Looker URL>/webhooks/projects/<LookML project name>/deploy/branch/<Git branch name>`

commit SHA またはタグをデプロイするための Webhook では、次の形式を使用します。

`<Looker URL>/webhooks/projects/<LookML project name>/deploy/ref/<commit SHA or tag>`

山かっこ < > の情報は、インスタンスのアドレス、LookML プロジェクト、ブランチ名、commit SHA / タグに固有の情報に置き換えます。e_faa プロジェクトの v1.0 タグ名を docsexamples.dev.looker.com Looker インスタンスにデプロイする Webhook の例を次に示します。

`https://docsexamples.dev.looker.com/webhooks/projects/e_faa/deploy/ref/v1.0`

API によるデプロイ

高度なデプロイモードが有効になっている場合は、Webhook API を使用せずにデプロイできます。API を使用してデプロイするには、API 呼び出しを行う deploy 権限が必要です。

Looker API の認証と使用の詳細については、Looker API 認証API のスタートガイドをご覧ください。

API を使用してデプロイするには、deploy_ref_to_production エンドポイントを使用します。このエンドポイントは、複数の方法で呼び出すことができます。次の例は、HTTPS メソッドと SDK メソッドを示しています。

HTTPS

以下の例を使用する場合は、山かっこ < > の部分を、インスタンス アドレス、LookML プロジェクト、ブランチ名、SHA、タグに固有の情報に置き換えてください。

deploy_ref_to_production API エンドポイントを使用して手動でデプロイするには、HTTPS メソッドを使用する次の例をご覧ください。CURL リクエストを使用して API を手動で呼び出す方法や詳細については、GitHub API の API に対する認証方法を参照するか、API Explorer をご覧ください。API Explorer は、Looker Marketplace から Looker インスタンスにインストールできます。また、Looker のデベロッパー ポータルで一般公開バージョンを表示することもできます。

HTTPS リクエストで次の例を使用して、deploy_ref_to_production API エンドポイントを介してブランチの先頭または特定の commit SHA またはタグをデプロイします。

ブランチの先頭をデプロイします。 <HOST_URL>/api/4.0/projects/<PROJECT_ID>/deploy_ref_to_production?branch=<BRANCH_NAME>

commit SHA またはタグをデプロイします。 <HOST_URL>/api/4.0/projects/<PROJECT_ID>/deploy_ref_to_production?ref=<SHA_OR_TAG>

SDK

以下の例を使用する場合は、山かっこ < > の情報を LookML プロジェクトに固有の情報と、ブランチ名、SHA、タグで置き換えてください。

または、API に手動でリクエストを行う代わりに、Looker の SDK のいずれかを使用します。SDK は認証の詳細や、パラメータおよびレスポンスのシリアル化など、さまざまな問題に対処します。

SDK メソッドを使用した deploy_ref_to_production によるデプロイは次のようになります。

ブランチの先頭をデプロイします。 deploy_ref_to_production(<PROJECT_ID>, {branch: <BRANCH_NAME>})

commit SHA またはタグをデプロイします。 deploy_ref_to_production(<PROJECT_ID>, {ref: <SHA_OR_TAG>})