Zenn
🙌

Looker のコンテンツ管理ソフトウェアの Gazer(gzr) のインストール手順

2022/09/15に公開
Looker
gazer
tech

クラウドエースの小坂です。
データウェアハウス構築、最近は特に Looker を活用した分析環境構築プロジェクトのプロジェクトマネージャーをよくやっています。

今回は Looker の OSS である Gazer(gzr) のインストール手順をまとめてみました。

gzr とは

Looker が OSS で提供するコンテンツ(ダッシュボード・Look)の管理を行うためのコマンドラインツールです。
https://github.com/looker-open-source/gzr

主に、開発環境(インスタンス)で作成したコンテンツを本番環境(インスタンス)に移行する、等の用途で使用するツールです。

OSS での提供となるため、Looker のチャットサポート窓口では使用方法等に関するサポートは基本的に受けられないのでご注意ください。

基本的に Github の Readme にインストール手順の記載はありますが、今回はより詳細に、ステップ・バイ・ステップで手順をまとめてみました。

手順概要

今回は Cloud Shell を用いて gzr のインストールを行う手順を説明します。
ローカル環境にインストールして使用することも可能なので、要件に応じてインストール先はご選択ください。

大まかな手順は以下の通りです。

  1. Cloud Shell に gzr のインストールを行う
  2. gzr で利用する API3 キーを Looker の管理画面から払い出しを行う
  3. .netrc ファイルに API3 キーの情報を登録する
  4. gzr の動作確認を行う

手順詳細

続いて詳細手順について説明します。

1. Cloud Shell に gzr のインストールを行う

まずはじめに Cloud Shell に gzr のインストールを行います。

  1. Cloud Console へアクセスします
    https://console.cloud.google.com/home/dashboard

  2. Cloud Shell を起動します
    右上のボタンをクリックします
    1

  3. Cloud Shell Editor を起動します
    このあとファイルの作成・編集を行うため、先に Editor も起動しておきます
    2
    クリックすると以下の画面が開きます
    3

  4. gzr のインストールコマンドを実行します

$ gem install gazer

コマンドの実行が完了すれば gzr のインストールは完了です。

2. gzr で利用する API3 キーを Looker の管理画面から払い出しを行う

続いて gzr で利用する API3 キーの払い出しを行います。
gzr では Looker の API を利用してコンテンツの管理を行うため、API3 キーの払い出しが必要になります。
基本的に管理権限を利用した操作を行うため、払い出しを行うユーザーは Admin 権限を持つユーザーとしてください。

  1. Looker インスタンスへアクセスします

  2. Looker のユーザー管理画面に移動します
    Admin メニューを開きます
    4
    Users をクリックします
    5

  3. API3 キーの払い出しを行うユーザーの Edit 画面に移動します
    API3 Key の払い出しを行うユーザーの右側の Edit ボタンをクリックします
    6
    Edit ボタンをクリックすると以下の画面が開くので、API3 Keys の隣にある Edit Keys をクリックします
    7

  4. API3 キーの払い出しを行います
    遷移先の画面で New API3 Key をクリックします
    8
    クリックするとキーが生成されるので Client ID Client Secret をメモしておいてください
    9

これで gzr で利用する API3 Keys の払い出しは完了です。

3. .netrc ファイルに API3 キーの情報を登録する

続いて先程払い出しをした API3 キーの情報を gzr が利用できるように .netrc ファイルに認証情報の登録を行います。

  1. Cloud Shell のホームディレクトリに移動します
$ cd
  1. Cloud Shell から .netrc ファイルの作成を行います
$ touch .netrc

  1. Cloud Shell Editor でホームディレクトリを開きます
    以下の手順で Cloud Shell Editor でホームディレクトリを開きます
    このとき Display Hidden Files にチェックをつけるのを忘れないようにしてください。
    10
    チェックをつけ忘れると .netrc が、表示されません。
    もしチェックをつけ忘れた場合には Cloud Shell Editor のメニューの View > Toggle Hidden Files を選択すれば、Hidden File の表示・非表示が切り替えられるので表示することが可能です。

  2. .netrc ファイルに Looker のホスト名と API3 キー情報の登録を行います
    .netrc ファイルを開き、ホスト名と先程メモした API3 キー情報を登録します
    11

machine foo.bar.mycompany.com
  login AbCdEfGhIjKlMnOp
  password QrStUvWxYz1234567890

変更したら File > Save をクリックして変更内容を保存します

  1. .netrc ファイルのアクセス権限の変更を行います
$ chmod 0600 .netrc

こちらで .netrc ファイルに API3 キーの情報登録は完了です。

4. gzr の動作確認を行う

最後に正しくインストール及び API3 キー情報の登録ができているかを確認するために、API3 キーのユーザー情報を取得するコマンドを実行します

$ gzr user me --host mycompany.cloud.looker.com --port 443

以下のようにユーザーの情報が取得できれば設定完了です。
12

まとめ

今回は gzr のインストール手順をまとめてみました。

次回は gzr を用いたコンテンツの移行手順についてまとめてみようと思います。
(気が向いたら)

Discussion