エージェント実行環境の管理

はじめに

エージェント実行環境は、サイドメニューのエージェント実行環境から利用できます。 ここでは、画面構成に沿ってエージェント実行環境の利用方法を説明します。

エージェント実行環境の一覧画面

実行環境の確認

サイドメニューのエージェント実行環境をクリックするとエージェント実行環境の一覧を表示します。 この一覧では、各エージェント実行環境について以下の項目を確認できます。

名称

エージェント実行環境の名前です。ユーザーが指定します。

エージェントステータス

エージェント実行環境の接続状態を表します。

表示	説明
	エージェントがenebularに接続されています
	エージェントがenebularに接続されていません
	エージェントの接続状態を取得できません
	エージェントのインストールが実施されていません
-	モニタリングがOFFに設定されています

フロー

エージェント実行環境にデプロイされたフローの名前です。

フローバージョン

エージェント実行環境にデプロイされたフローのバージョンです。

フローステータス

エージェント実行環境にデプロイされたフローの状態です。

最終フローデプロイ結果

エージェント実行環境に対して最後にフローをデプロイしたときの実行結果です。 デプロイエラーやデプロイ失敗の場合は、その前にデプロイしていたフローを利用できる状態になります。

エージェントのバージョン

エージェント実行環境にインストールされたエージェントのバージョンです。

ログ

エージェント実行環境で出力されたログを閲覧する画面へのリンク(アイコン)を表示します。

タグ

エージェント実行環境を分類するために必要に応じタグを付与できます。複数のタグを付与することも可能です。

エージェント実行環境の作成

エージェント実行環境を作成する場合は、右下の+ボタンを押します。 エージェントの名称を入力するためのダイアログが表示されますので、名称を入力し、OKボタンを押します。

しばらくするエージェント実行環境の概要タブが表示されます。設定タブに表示されるインストールコマンドを使って、Raspberry Piなどのデバイスにenebular-agentをインストールします。詳細は、エージェントインストールを参照ください。

プロジェクト毎に作成できる実行環境の上限を超えると、+ボタンが表示されなくなります。

概要タブ

概要情報の確認

エージェント実行環境の一覧画面で、実行環境の名称をクリックするとそのエージェント実行環境の概要タブを表示します。 エージェントがまだインストールされていません。と表示される場合には、エージェントインストールを参照し、インストールを実施してください。

概要タブでは、以下の情報を確認できます。

実行環境の名称

実行環境の名称を確認します。

デプロイしたフロー

エージェント実行環境にフローがデプロイされている場合、概要タブのデプロイしたフロー欄の右側にフローの表示ボタンを表示されます。

フローの表示ボタンをクリックすると、デプロイされているフローの概要タブに遷移します。

デプロイしたファイル

エージェント実行環境にデプロイしたファイル数およびデプロイ済みファイルの合計サイズを表示します。

ファイルデプロイを指示すると、通常はすぐにデプロイを開始します。ネットワークの障害などにより、デプロイに失敗した場合は、次にエージェント実行環境がネットワークに接続された場合にデプロイを再度試します。

ファイル数には、デプロイの成否にかかわらず、デプロイを指示したファイル数を表示します。

デプロイ済みのファイルの合計サイズは、デプロイに成功したファイルのサイズです。

モニタリング

エージェント実行環境が、オンライン/オフラインの状況を確認します。

エージェントバージョン

インストールしたenebular-agentのバージョンを確認します。

使用状況

確認できる使用状況を以下に示します。各使用状況は今月分の集計結果になります(毎月初日にリセットされます)。

• フローデプロイ回数
  エージェント実行環境にフローをデプロイした回数です。
• ログサイズ
  エージェント実行環境がフローを実行した際に出力したログのサイズです(表示に反映されるまで24時間程度かかることがあります)。
• 送信メッセージ数
  クラウド実行環境へ送信したメッセージ数です。
• 送信メッセージサイズ
  クラウド実行環境へ送信したメッセージの合計サイズです。

また、画面右上の[ユーザー名]-[使用状況]-[エージェント実行環境]をクリックすると別のエージェント実行環境や先月の使用状況を確認できます。

フロー/ファイルのデプロイ

概要タブの右上にあるデプロイボタンから実行環境にフローやファイルをデプロイできます。 デプロイボタンを押すと、デプロイ対象のフローまたはファイルを選択するダイアログが表示されます。

デプロイしたいフローを選択します。このフローがバージョン管理されていれば、次へボタンが表示され、バージョン管理されていなければデプロイボタンが表示されます。 次へボタンをクリックすると、バージョンを選択する画面が表示されますので、デプロイしたいバージョンを選択します。 デプロイボタンを押すと、エージェント実行環境へのフローのデプロイが開始され、デプロイ履歴タブに切り替わります。

デプロイが完了すると、デプロイステータスの表示が、デプロイ中からデプロイ済みに変わります。

デプロイ履歴タブ

デプロイ履歴の確認

エージェント実行環境へのフローのデプロイ履歴を確認できます。確認できる項目を以下に示します。

• 名称
  デプロイしたフローの名称です。
• アセット種別
  デプロイしたアセットの種別です。エージェント実行環境の場合、デプロイできるのはフローのみなのでフローと表示します。
• デプロイステータス
  デプロイの状況を表示します。デプロイを実施すると、デプロイ中となり、デプロイが成功するとデプロイ済みとなります。
• バージョン
  デプロイしたフローのバージョンです。
• デプロイ実行者
  デプロイを実行したユーザー名です。
• リクエスト日時
  デプロイを実行した日時です。
• 最終更新日時
  デプロイ状況を最後に更新した日時です。
• 再デプロイ
  同じフローの再デプロイを行うためのボタン(アイコン)を表示します。

デプロイ

右上のデプロイボタンからフローやファイルをデプロイできます。 デプロイ操作は、概要タブのデプロイボタンからデプロイを行う場合と同様です。

再デプロイ

デプロイ履歴の一覧表の再デプロイ列のアイコンをクリックすることで、デプロイしたフローを再度デプロイできます。

再デプロイボタンをクリックすると、確認ダイアログが表示されます。確認ボタンをクリックすると再デプロイを開始します。

アクセスタブ

エージェント実行環境に対するアクセス制御を設定できます。

プロジェクトの所有者、管理者ロールのユーザーは、エージェント実行環境に対してすべての操作を行うことができます。 ここでは、コラボレーターロールのユーザーに対するアクセス制御を行えます。アクセス制御できる操作は以下です。

• ログ
  エージェント実行環境のログの閲覧可/不可を制御します。ログを閲覧できないユーザーが、エージェント実行環境画面を表示するとログタブが表示されなくなります。
• デプロイ
  エージェント実行環境へのフローのデプロイ可/不可を制御します。デプロイを実施できないユーザーが、エージェント実行環境画面を表示するとデプロイボタンが表示されなくなります。
• 設定
  エージェント実行環境の設定変更可/不可を制御します。設定変更できないユーザーが、エージェント実行環境画面を表示すると設定タブが表示されなくなります。

アクセス制御の設定は、プロジェクトの所有者、および、管理者ロールのユーザーのみ実施できます。

エージェント実行環境作成直後は、コラボレーターによるすべての操作は不可であるため、必要に応じ可に変更してください。

ログタブ

ログの閲覧

エージェント実行環境にデプロイされたフローが実行時に出力したログを閲覧できます。
enebular-agentは、基本的に特定の頻度(デプロイを実施した直後など頻度が変わることもあります)でログを送信するため、ログが閲覧できるようになるまでにタイムラグがありますので注意してください。

ログは背景が灰色の領域に表示します。 左側にログの受信時刻を水色の文字で表示します。この時刻のタイムゾーンはWebブラウザの設定に従います。

右側の<最初のログが出力された時刻>〜<最後のログが出力された時刻>の形式で表示された日時の一覧は、その期間に出力されたログのかたまりを表します。クリックするとそのかたまりに含まれるログが表示されます。

エージェント実行環境から一度に送信されたログがこのログのかたまりにあたります。

また、右側の日付のうち濃い黒字になっているログのかたまりは、Webブラウザに読み込み済みであることを表します。読み込み済みのログは、すぐに表示できますが、読み込まれていない場合は表示までに時間がかかることもあります。

更新

上部の更新ボタンをクリックすると、サーバーからログを再取得し、画面を更新します(enebular-agentから送信されていないログについては更新ボタンを押しても閲覧できません)。

フィルター

ログを検索したい場合は、上部のフィルターボタンから行うことができます。

フィルターで利用できるパラメーターは以下です。

• フィルターしたい語句
  特定のキーワードで検索したい場合には、フィルターしたい語句欄にそのキーワードを入力してください。
• 開始時間 ログの検索対象の開始時間を指定します。開始時間を設定するをONにすると、日時を入力するフォームが表示されるので日時を指定してください。日時は、Webブラウザに設定されたタイムゾーンで入力してください。
• 終了時間 ログの検索対象の終了時間を指定します。終了時間を設定するをONにすると、日時を入力するフォームが表示されるので日時を指定してください。日時は、Webブラウザに設定されたタイムゾーンで入力してください。

上記を設定し、確認ボタンを押すと条件に合致するログのみ表示されます。

設定タブ

タグの追加

エージェント実行環境の区別をするために、タグを付与できます。

設定タブの上部にクリックしてタグを追加と表示があるので、これをクリックして付与したい文字列を入力し、改行キーを押してください。同様の操作を繰り返すことで複数のタグを入力できます。

タグは、概要タブ、設定タブ、実行環境の一覧画面で閲覧できます。

名称

エージェント実行環境の名称を変更します。

エージェントインストール

エージェント実行環境を稼働させたいデバイスなどに、enebular-agentをインストールするコマンドを提供します。

インストールユーザーは、enebular-agentのインストール/実行に利用するLinuxのユーザーです。インストールユーザーを変更するとインストールコマンドに反映されます。

インストールコマンドの右にあるアイコンをクリックすると、インストールコマンドがコピーされます。 このコマンドをエージェント実行環境がサポートする環境上のターミナルに貼り付けて実行することにより、enebular-agentのインストールを行うことができます。(注1)

enebular-agentのインストールを行うと、インストールユーザー、インストールコマンドが非表示になり、代わりにインストール日時とインストールコマンド再作成ボタンが表示されます。

インストールコマンドの再作成は、たとえば、デバイスが故障して別のデバイスに切り替えたい場合などに利用することを想定しています。

インストールコマンド再作成ボタンを押すと、インストールユーザー、インストールコマンドを再度表示します。インストールコマンドの再作成を行うと、再作成前のインストールコマンドでインストールしたenebular-agentは無効化されますので注意してください。

インストールコマンドの再作成を実施しても以下の情報は保持され続けます。

• 使用状況
• デプロイ履歴
• ログ

(注1) セキュリティのため、リモートメンテナンスを行う際のログインユーザのパスワードを設定することを推奨します。下記のオプションをインストールコマンドに加えてパスワードを設定できます。

--remote-maintenance-user-password=パスワード

その他のオプションについてはオプションを参照してください。

モニタリング

エージェントステータスの確認およびモニタリングのON/OFFの切り替えを行うことができます。

モニタリングをOFFにすると以下のように動作が変わります。

• enebular-agentからログが送信されなくなります
• エージェントステータスの確認が不可となり、表示が-に変わります

デプロイしたフロー

デプロイされたフローの名称、フローバージョン、フローステータスを確認できます。

フローの名称の右にあるフローの表示ボタンを押すとデプロイしたフローの概要ページに遷移します。

フローステータスのトグルボタンを切り替えることで、エージェント実行環境にデプロイされたフローの実行/停止を切り替えられます。

デプロイしたファイル

デプロイを指示したファイル数とデプロイ済みの合計ファイルサイズを表示します。

右にあるファイルの管理ボタンを押すとデプロイを支持したファイルの情報を表示します。表示される情報は以下です。

• ファイル欄
  ファイルアセットの名称、ファイル名、バージョン、デプロイ先のディレクトリ、サイズを表示します。
• 状態欄
  デプロイ済み、保留中などの実行状態を表示します。
• 実行欄
  ✕ボタンを押すと、デプロイを指示したファイルを削除できます。すでにデプロイ済みであれば、デプロイ済みのファイルも削除します。

環境変数

エージェント実行環境に環境変数を設定します。 ※環境変数の設定が行えるのは、エージェントバージョンが2.17.1以降です。

環境変数は、キーと値のペアで、エージェント実行環境毎に複数の環境変数を指定できます。

設定した環境変数は、フローから参照します。1つのフローを複数のエージェント実行環境にデプロイして実行する場合に、エージェント実行環境に応じて振る舞いを変更するために利用します。

たとえば、テスト用エージェント実行環境からアクセスするサービスと、本番用エージェント実行環境からアクセスするサービスのURLを別にしたい場合、テスト用実行環境の環境変数にテスト用のサービスのURLを設定し、本番用エージェント実行環境の環境変数に本番用のサービスのURLを設定することでテストと本番で同じフローが利用できます。

環境変数を追加するには、環境変数欄のキーと値の入力フィールドに適切な値を入力し、追加ボタンを押します。 これを繰り返すことで複数の環境変数を追加可能です。

すでに追加した環境変数の値を変更したい場合は、設定済みの環境変数の右の鉛筆アイコンをクリックすると編集できるようになります。

環境変数を削除したい場合は、設定済みの環境変数の右のXアイコンをクリックすると削除できます。

環境変数に、ENEBULAR_から始まるキーなど設定不可能なキーがあります。設定不可能なキーを入力した場合は、追加できません。

リモートメンテナンス

エージェント実行環境のリモートメンテナンスを行うために、enebular-agentが稼働するOSに、SSHログインできるようにします。 リモートメンテナンスを利用するには、トグルボタンを操作し、中継サーバーを起動する必要がありますが、このトグルボタンを操作できるのはプロジェクトの所有者および管理者のみです。 利用方法については、リモートメンテナンスを参照ください。

リモートメンテナンスは、プロジェクト毎に、一ヶ月間の利用時間の上限があります。上限を以下に示します。

• エンタープライズ/トライアルプラン
  • 100時間 + デバイスまたはエージェント実行環境数 × 10時間
• フリープラン
  • 10時間

エージェント実行環境の設定タブには、今月中のリモートメンテナンスの残り利用時間を表示しますが、この表示は画面の再読み込みを行わないと更新されませんのでご注意ください。

クラウド実行環境との接続

クラウド実行環境とメッセージをやり取りするには、クラウド実行環境との接続のトグルボタンをONにします。 ※クラウド実行環境との接続の設定が行えるのは、エージェントバージョンが2.17.2以降です。

クラウド実行環境と接続するために必要な準備については実行環境間の接続準備を参照ください。

エージェント実行環境IDのコピー

実行環境ID欄からエージェント実行環境のIDをコピーできます。
実行環境間の接続機能などで利用します。

削除

エージェント実行環境を削除したい場合は、削除ボタンを押して実施します。 削除を実施すると、デバイスなどにインストールしたenebular-agentとenebularは通信できなくなります。