Cluster UI

Cluster UI は、Genvid クラスタを管理する Web サイトです。これは、cluster-api の GUI です。

設定

このページでシステム設定の確認と変更を行うことができます。

../_images/cluster_ui_settings.png

上級者向けエディタ

../_images/cluster_ui_settings_advanced_editor_button.png

上級ユーザー向けに、JSON エディタで設定を編集するオプションも存在します。 Advanced Editor をクリックすると、JSON エディタが次のように表示されます。

../_images/cluster_ui_settings_json_editor.png

Form Editor をクリックすると、いつでもフォームに戻ることができます。

編集した値は、エディタの切り替え中も保持されており、 Save をクリックすると保存することができます。

ジョブ

このページで、bastion クラスタのジョブを管理します。このページでは次の操作を実行できます。
  • 各ジョブのステータスを参照する。
  • スタックおよびジョブの開始と停止。
  • 対応する hashi-ui Job ページにアクセスする。

ジョブが開始されると、他のプロジェクトのWeb ページにリンクするボタンが利用できるようになります。LINKS セクションのボタンは、アクティブなときは青い文字、非アクティブなときは赤い文字になります。ボタンをクリックすると、対応する Web ページが開きます。

../_images/cluster_ui_jobs_links.png

注釈

リンクの色は、関連するサービスの利用可能性を表すものではありません。

  • 青色は URL が正しくレンダリングされていることを意味しますが、サービスが利用できない場合もあります。
  • 赤色は URL をレンダリングできないことを意味します。
../_images/genvid_ui_cluster_jobs.png

上の写真では、すべてのジョブが起動しており、ステータスが 『running』 になっています。1つ以上のサービスの起動に失敗し、すべての再起動の試みが失敗した場合、ジョブは 『dead』 と表示されます。 『dead』 のジョブサービスの自動試行は行われません。ただし、障害の根本原因に対処した後は、サービスを手動で再起動することができます。そのためには、ジョブ名の横にあるドロップダウンボタンをクリックし、実行されていないサービスを探します。次に黄色い下向きの矢印をクリックし、緑色の上向きの矢印をクリックします。下の図は、このシナリオで使用するサービスと上下の矢印が表示されたジョブを示しています。

../_images/cluster_ui_displayed_services.png

ジョブを編集する場合は、 Settings ページの Jobs セクションを開きます。テキスト形式でダウンロードできる拡張子 .nomad.tmpl のジョブテンプレートがあります。

../_images/cluster_ui_settings_job.png

ジョブを設定する場合:

  • Name
    ジョブ名はテンプレートファイル名、およびテンプレートファイル内のジョブ名に対応させる必要があります。
  • Dependencies
    ジョブ開始前に待機するサービスのリスト。デフォルトは None です。
  • Autostart
    引数なしの開始コマンドでジョブを自動的に開始する場合にチェックします。
  • Template
    ASCII ファイルをドラッグアンドドロップしてテンプレートを更新することができます。スクリプトを正しく機能させるため、ジョブ名は、テンプレート名と同じでなければなりません。詳細は、 Nomad テンプレート を参照してください。
../_images/cluster_ui_settings_job_form.png

ログ

このページには、タスクログが表示されます。サービスが実行されると、ログは自動的に更新されます。ログレベルは、デフォルトまたは、ロガーごとに割り当てることができます。

../_images/genvid_ui_logs.png

ログの編集は、設定ページのログセクションで行えます。

../_images/cluster_ui_settings_log.png

ログを設定する場合:

  • ID
    ログ ID。一度作成した ID は変更できません。
  • File Name
    ファイル名。例: stderr , stdout
  • Job
    ジョブの ID。
  • Group
    タスクグループの ID。
  • Task
    タスクの ID。
  • Log Level
    ログの情報量が変化する動的ログレベルをログでサポートする必要がある場合は、このオプションをチェックします。ログレベルには、 debug、info、warning、error、fatalpanic があります。
../_images/cluster_ui_settings_log_form.png

イベント

イベントページでは、イベントの結果のサマリーを確認できます。閉じた列に、そのイベントの結果をグループ分けして表示します。この列に、イベントの識別情報が表示されます:

  • ID: イベント名。
  • Start Time: イベントがトリガされた時間です。
  • Last Time: イベントが最後に入力を受け付けた時間です。

列をクリックすると展開し、イベントの結果を確認できます。展開したグループの各列の左にキー、右に 4 つの値が表示されます。キーはイベントで定義される文字配列です。4 つの値は、配信セッション中に継続して計算される数値です:

  • min: すべての入力値の最小値を戻します。
  • max: すべての入力値の最大値を戻します。
  • count: キーの出現数。
  • sum: すべての入力値の合計値。

Download をクリックすると、現在のサマリーを JSON 形式でダウンロードします。CLEAR をクリックすると、ページに表示されているすべてのイベントのサマリーを消去します。

警告

イベントサマリーをクリアすると、データの復元、ダウンロードはできなくなります。

../_images/genvid_ui_events.png

イベントやカテゴリの編集は、設定ページのイベントセクションで行えます。

../_images/cluster_ui_settings_event.png

参考

ゲームプロセスと視聴者との通信を、イベントがどのように制御するかの、イベント概要

取得可能なイベントの種類のガイド Events API

設定

このページには、プロジェクトでロードされる構成キーが表示されます。既存キーを変更または削除したり、新規作成することもできます。

../_images/cluster_ui_settings_config_synced.png

新規キーの作成または既存キーの変更時:

  • Key Name
    / で区切って適切な設定レベルを表すキー名。
  • Key Value
    キーの内容。
  • 変更を保存するページを離れる前に、 SUBMIT ボタンをクリックします。
../_images/cluster_ui_settings_configKey.png

サーバーに保存されていない変更されたキーが黄色で強調表示されます。 SAVE をクリックして変更を保存し、サーバー構成と同期します。

../_images/cluster_ui_settings_config.png

重要

システムは第一階層からキーを読み取ることができません。フォワードスラッシュ (/) のない キー名 を付けてキーの SUBMITSAVE を行おうとすると、新しい値が書かれた行が消えてしまいます。

必ず 1 つ以上の / で区切った キー名 を持つキーを作成する必要があります。

画像

このページには、クラスタに構成されたイメージが表示されます。

../_images/cluster_ui_settings_images.png

Status

ステータスのページには、クラスタの接続ステータスや vault ステータスなどのクラスタステータス情報が表示されます。cluster-api がダウンしているときや、ステータスが UP でない場合は、すべてのページはここにリダイレクトされます。

../_images/cluster_ui_status_vault_manager_unsealed.png

cluster-UI を適切に動作させるために

  • クラスタは UP である必要があります。
  • server_public_ips という terraform output 変数は、IPs のリストとともに存在しなければなりません。
  • Consul はこれらの IPs で実行され、ポート 8500 としてbastion サーバーに公開されている必要があります。
  • private_key_pem という Terraform output 変数は、SSH プライベートキーとともに存在しなければなりません。

Vault サーバー

Vault サーバー セクションには、利用可能な vault サーバーの一覧と、seal 状況が表示されます。

vault ステータスの確認以外に、各 vault サーバーに対して、以下のアクションを行うことができます。

Reset Vault Reset Vault はインストールされているポリシーや役割を vault サーバーからすべて削除します。

Unseal Unseal は、seal 状態の vault のステータスをアクセス可能に変更します。

Seal Seal は、unseal 状態の vault のステータスをアクセス禁止に変更します。

Vault ポリシー

Vault ポリシーセクションには、vault ポリシーのインストール状況が表示されます。アクションボタンでポリシーのインストール、アンインストールを行うことができます。

注釈

vault ステータス情報は、ローカルクラスタでは利用できません。

ヘルス

サービスのヘルスの表示。

左側の列は、サービスとそのインスタンスを示します。インスタンスは、ヘルスに応じて色が異なります。

  • 緑色: すべてのヘルスチェックは合格しています。
  • オレンジ色: 少なくとも 1 つのヘルスチェックが動作状態です。
  • 赤色: 少なくとも 1 つのヘルスチェックはクリティカルな状態です。
../_images/tool_ui_consul_health.png

このページでは:

  • 重要なサービスに集中するためにシステムサービスを非表示にする。
  • ステータスを更新する。
  • サービスインスタンスをクリックして詳細を確認する。

詳細セクションでは以下を確認できます:

  • サービス情報。
  • サービスが実行されているノード。
  • このサービスのヘルスチェック。