ウェブ UI をインストールする

ドキュメントのバージョンを選択してください。

このページでは、AlloyDB Omni ウェブ ユーザー インターフェースをインストールして、セルフマネージド データベース クラスタの健全性と構成をモニタリングする方法について説明します。ウェブ UI には次の機能があります。

機能 説明 コンテナ(スタンドアロン) Kubernetes RPM(Linux) RPM オーケストレーター
クラスタの選択 ターゲット クラスタにアクセスするための接続認証情報を確立、登録、保存できる接続画面。 サポート対象 サポート対象 サポート対象 サポート対象
クラスタの概要 すべてのアクティブなクラスタ インスタンスとテレメトリー グラフを表示するモニタリング ダッシュボード。 部分サポート。テレメトリー グラフはサポートされていません。 サポート対象 サポート対象 サポート対象
データベース クラスタ上のカタログ テーブルとデータベース サイズを表示する概要ページ。 サポート対象 サポート対象 サポート対象 サポート対象
カラム型エンジン 分析クエリの構成設定とスキャン実行の統計情報。 サポート対象 サポート対象 サポート対象 サポート対象
データベース フラグ デフォルト設定から逸脱しているアクティブなフラグと構成を表示する観察ボード。 サポート対象 サポート対象 サポート対象 サポート対象
Query Insights 構造ヒストグラムと低速クエリリストを表示するテレメトリーとクエリ パフォーマンス ダッシュボード。 サポート対象 サポート対象 サポート対象 サポート対象
システム分析情報 CPU 使用量、メモリ使用量、ディスク I/O を表示するテレメトリー グラフ。 非対応 サポート対象 サポート対象 サポート対象

始める前に

ウェブ UI をインストールする前に、次の前提条件を満たしてください。

  1. デプロイ用のイメージを取得し、AlloyDB Omni をダウンロードしてインストールし、ウェブ UI を使用できるようにします。 コンテナを使用して AlloyDB Omni をインストールする。

  2. データベース ユーザーを構成します。

    ウェブ UI は、データベースにアクセスするための pg_monitor ロールを持つ制限付きユーザー アカウントに依存しています。psql セッションで次のコマンドを実行して、各クラスタでこのユーザーを構成します。

    CREATE ROLE alloydbui WITH LOGIN PASSWORD 'PASSWORD';
    GRANT pg_monitor TO alloydbui WITH INHERIT TRUE;
    

    PASSWORD は、alloydbui データベース ロールのパスワードに置き換えます。

  3. Prometheus を構成します。

    CPU 使用率など、[概要] ページと [システム分析情報] ページでグラフデータを表示するには、Prometheus をインストールして構成します。注: AlloyDB Omni をスタンドアロン コンテナとしてデプロイする場合、コンテナ化されたモニタリング エージェントは使用できません。スタンドアロン コンテナ デプロイに接続する場合、[概要] ページと [システム分析情報] ページの Prometheus グラフの指標はサポートされません。

省略可能な手順

追加のウェブ UI 機能を有効にするには、次のオプション構成を完了します。

  • Query Insights の設定

    Query Insights 機能を使用するには、pg_stat_statements 拡張機能を有効にします。psql セッションで、次のコマンドを実行してライブラリを構成します。

    ALTER SYSTEM SET shared_preload_libraries=google_columnar_engine,google_job_scheduler,google_storage,google_db_advisor,pg_stat_statements;
    ALTER SYSTEM SET pg_stat_statements.max = 10000;
    ALTER SYSTEM SET pg_stat_statements.track_utility = on;
    ALTER SYSTEM SET track_io_timing = on;
    

    次に、各データベースで次のコマンドを個別に実行して、拡張機能を作成します。

    CREATE EXTENSION IF NOT EXISTS pg_stat_statements;
    

    これらの変更を有効にするには、データベースを再起動します。カラム型エンジンを有効にする場合は、その設定が完了するまで再起動を待ってください。

  • カラム型エンジンの設定

    ウェブ UI でカラム型エンジンデータにアクセスするには、カラム型エンジンの概要の説明に沿ってエンジンを構成します。

  • AlloyDB AI の設定

    ウェブ UI で AlloyDB AI 機能を使用するには、次の権限を付与します。

    • ベクトル インデックスにデータを入力するには、alloydbui ユーザーに pg_stat_ann_indexes に対する SELECT 権限を付与します。
    • ベクトル列を表示するには、alloydbui ユーザーにテーブルに対する SELECT 権限を付与します。
詳細については、AlloyDB AI を使用した生成 AI アプリケーションの構築をご覧ください。

ウェブ UI をインストールする

ウェブ UI は任意のノードにインストールして実行できます。ウェブ UI に専用ノードは必要ありません。完全インストールには、約 250 MB のディスク容量が必要です。デプロイ用のイメージを取得して AlloyDB Omni をダウンロードしたら、ウェブ UI をインストールして実行できます。

Docker または Podman イメージを使用してインストールする

コンテナを使用して AlloyDB Omni を実行する場合は、Docker または Podman イメージを pull します。

Docker

docker pull ALLOYDB_OMNI_UI_IMAGE_TAG

Podman

podman pull ALLOYDB_OMNI_UI_IMAGE_TAG

ALLOYDB_OMNI_UI_IMAGE_TAG は、ウェブ UI コンテナ イメージのタグに置き換えます。

ウェブ UI を起動する

ウェブ UI は、Java キーストアを使用して、接続データの暗号化に使用される 256 ビット AES 鍵を保護します。ウェブ UI を起動するときに、パスワードを含む環境変数を指定します。

コンテナでウェブ UI を起動する

次のコマンドを実行して、ウェブ UI コンテナを起動します。同じホストマシン上の AlloyDB Omni インストールに接続する場合は、--add-host=host.docker.internal:host-gateway フラグを指定します。

Docker

docker run --name alloydb-omni-ui \
  --add-host=host.docker.internal:host-gateway \
  -e ALLOYDB_OMNI_UI_KEYSTORE="PASSWORD" \
  -p 9080:9080 \
  ALLOYDB_OMNI_UI_IMAGE_TAG

Podman

podman run --name alloydb-omni-ui \
  --add-host=host.docker.internal:host-gateway \
  -e ALLOYDB_OMNI_UI_KEYSTORE="PASSWORD" \
  -p 9080:9080 \
  ALLOYDB_OMNI_UI_IMAGE_TAG

次のように置き換えます。

  • PASSWORD: ALLOYDB_OMNI_UI_KEYSTORE のキーストア パスワード。

  • ALLOYDB_OMNI_UI_IMAGE_TAG: ウェブ UI コンテナ イメージのタグ。

ウェブ UI を開く

ウェブ UI を表示するには、ブラウザで http://HOST:9080 を開きます。

HOST は、ウェブ UI がインストールされているノードのホスト名または IP アドレスに置き換えます。

  • 既存のリバース プロキシの背後でホストする場合など、オプションの ALLOYDB_OMNI_BASE_PATH 環境変数を使用してカスタム ベースパスを構成した場合は、URL にパスを追加する必要があります(http://HOST:9080/BASE_PATH)。

    BASE_PATH は、カスタムベースパスに置き換えます。

  • 先頭のスラッシュなしでベースパスを構成できます(例: ALLOYDB_OMNI_BASE_PATH=BASE_PATH)。次のいずれかの方法で対応できます。

    • /test/
    • test/
    • test
    • /test

制限事項

ウェブ UI には次の制限があります。

  • AlloyDB Omni スタンドアロン コンテナ デプロイに接続する場合、コンテナ化されたモニタリング エージェントはスタンドアロン コンテナ デプロイで使用できないため、概要グラフとシステム分析情報は使用できません。グラフ以外の機能と指標はすべて引き続き完全に機能します。

  • 特定のテーブルのカラム型エンジンデータを表示するには、alloydbui ユーザーにそのテーブルに対する権限(SELECT など)が少なくとも 1 つ必要です。

  • ベクトル インデックス データを表示するには、alloydbui ユーザーに pg_stat_ann_indexes に対する SELECT 権限が必要です。

  • 特定のテーブルのベクトル列データを表示するには、alloydbui ユーザーにそのテーブルに対する SELECT 権限が必要です。

ベスト プラクティスと注意事項

ウェブ UI をインストールして構成する際は、次のベスト プラクティスと注意事項に従ってください。

  • キーストアのパスワード保護: ウェブ UI は、256 ビット AES データベース暗号鍵を保護するために Java キーストアを生成します。ALLOYDB_OMNI_UI_KEYSTORE には強力なパスフレーズを使用してください。構成ファイルを転送し、一致しないキーストア パスワードで接続すると、復号エラーが発生します。
  • Prometheus 指標のスクレイピング: データベース ノードに過負荷をかけずに統計情報をクエリするように、標準範囲(15 秒~ 30 秒)でターゲット インスタンスをポーリングするようにスクレイパーを構成します。

    次のステップ