クラウド実行環境の管理
はじめに
クラウド実行環境は、左側に表示するサイドメニューのクラウド実行環境
から利用できます。
ここでは、画面構成に沿ってクラウド実行環境の利用方法を説明します。
クラウド実行環境の一覧画面
クラウド実行環境の確認
サイドメニューのクラウド実行環境
をクリックするとクラウド実行環境の一覧を表示します。
この一覧では、各クラウド実行環境について以下の項目を確認できます。
- 名称
クラウド実行環境の名前です。 - ステータス
クラウド実行環境の状態を表します。- 有効: 以下のいずれかを満たす状態
- HTTPトリガーがON
- スケジュールトリガーがON
- エージェント実行環境との接続がON
- データストアへの接続がON
- SlackBot I/Fの利用がON
- データストア機能のテーブル更新時の呼び出し先に指定されている
- 無効: 以下のすべてを満たす状態
- HTTPトリガーがOFF
- スケジュールトリガーがOFF
- エージェント実行環境との接続がOFF
- データストアへの接続がOFF
- SlackBot I/Fの利用がOFF
- データストアのテーブル更新時の呼び出し先に指定されていない
- 制限中: 今月の利用上限を超え、フロー実行や設定変更等が制限されている状態
- 有効: 以下のいずれかを満たす状態
- 種別
クラウド実行環境の種類です。クラウド実行環境の場合は、クラウド
固定です。 - フロー
クラウド実行環境にデプロイされたフローの名前です。 - フローバージョン
クラウド実行環境にデプロイされたフローのバージョンです。 - 最終フローデプロイ結果
クラウド実行環境に対して最後にフローをデプロイした結果です。デプロイエラーやデプロイ失敗の場合は、その前にデプロイしていたフローが利用可能な状態になります。 - 実行環境バージョン
クラウド実行環境のバージョンです。 - ログ
クラウド実行環境で出力されたログを閲覧する画面へのリンク(アイコン)を表示します。 - タグ
クラウド実行環境を分類するために必要に応じタグを付与できます。複数のタグを付与することもできます。
クラウド実行環境の作成
クラウド実行環境を作成する場合は、右下の+
ボタンを押します。
クラウド実行環境の名称を入力するためのダイアログが表示されますので、名称を入力し、OK
ボタンを押します。
しばらくするとクラウド実行環境の作成が完了し、クラウド実行環境の概要タブが表示されます。
プロジェクト毎に作成できるクラウド実行環境の数には上限があります。すでに上限分クラウド実行環境が作成済みであれば+
ボタンを表示しません。
概要タブ
概要情報の確認
クラウド実行環境の一覧画面にて、クラウド実行環境の名称をクリックするとそのクラウド実行環境の概要タブを表示します。
概要タブでは、クラウド実行環境の名称、デプロイしたフロー、デプロイしたフローのバージョンに加え、クラウド実行環境の使用状況を確認できます。 確認できる使用状況は以下の通りです。各々今月分の集計結果になります。
- フローデプロイ回数
クラウド実行環境にフローをデプロイした回数です。 - 実行時間
クラウド実行環境で処理を行った合計時間です。何も処理を行っていない時間は集計対象となりません。/(スラッシュ)以降には、今月実行できる時間の上限を表示します。 - ログサイズ
クラウド実行環境がフローを実行した際に出力したログのサイズです(表示に反映されるまで24時間程度かかることがあります)。/(スラッシュ)以降には、今月出力できるログサイズの上限を表示します。 - 実行エラー回数
クラウド実行環境で発生したエラーの回数です。 - 最大同時実行数
クラウド実行環境が同時に実行されたときの最大数です。
実行時間、ログサイズが上限を超えた場合は、その項目が赤字で表示され、当月はクラウド実行環境を利用できなくなります。
上限と、上限を超えた場合の制限については、「月当たりの利用上限」を参照ください。
また、使用状況については、右上の[ユーザー名]-[使用状況]-[クラウド実行環境]をクリックすると別のクラウド実行環境や先月の状況も含め確認できます。
フローのデプロイ
概要タブの右にあるデプロイ
ボタンからクラウド実行環境にフローをデプロイできます。
デプロイ
ボタンを押すと、デプロイ対象のフローを選択するダイアログが表示されます。
デプロイしたいフローを選択します。このフローがバージョン管理されていれば、次へ
ボタンが表示され、バージョン管理されていなければデプロイ
ボタンが表示されます。
次へ
ボタンをクリックすると、バージョンを選択する画面が表示されますので、デプロイしたいバージョンを選択します。
デプロイ
ボタンを押すと、クラウド実行環境へのフローのデプロイが開始され、デプロイ履歴タブに切り替わります。
デプロイが完了すると、デプロイステータスの表示が、デプロイ中
からデプロイ済み
に変わります。
フローの確認
クラウド実行環境にフローがデプロイされている場合、概要タブの右側にフローの表示
ボタンを表示します。
デプロイされているフローを確認したい場合は、フローの表示
ボタンをクリックし、デプロイされているフローの概要タブに遷移してください。
実行環境バージョンの確認
クラウド実行環境のバージョンを確認できます。 このバージョンは、クラウド実行環境を作成した時点でenebularに組み込まれているNode-REDのバージョンに基づいて決定され、以降変更することはできません。
クラウド実行環境のバージョンアップの想定手順を以下に示します。
- 新しく移行先のクラウド実行環境を作成します
- 移行元のクラウド実行環境で利用していたフローを移行先のクラウド実行環境にデプロイします(クラウド実行環境に仮の設定を行い、移行先の環境でフローが正しく動作することを確認しておくことを推奨します)
- 移行元のクラウド実行環境の設定を移行先のクラウド実行環境に移行します(クラウド実行環境設定の移行機能をご利用ください)
実行環境サイズの確認
クラウド実行環境のサイズを確認できます。
クラウド実行環境にデプロイできるファイルサイズの確認などにご活用ください。
デプロイ履歴タブ
デプロイ履歴の確認
クラウド実行環境へのフローのデプロイ履歴を確認できます。確認できる項目を以下に示します。
- 名称
デプロイしたフローの名称です。 - アセット種別
デプロイしたアセットの種別です。クラウド実行環境の場合、デプロイできるのはフローのみなのでフローに固定されます。 - デプロイステータス
デプロイの状況を表示します。デプロイを実施すると、デプロイ中
となり、デプロイが成功するとデプロイ済み
となります。 - バージョン
デプロイしたフローのバージョンです。 - デプロイ実行者
デプロイを実行したユーザー名です。 - リクエスト日時
デプロイを実行した日時です。 - 最終更新日時
デプロイ状況を最後に更新した日時です。 - 再デプロイ
同じフローの再デプロイを行うためのボタン(アイコン)を表示します。
デプロイ
右上のデプロイ
ボタンからフローをデプロイできます。
デプロイ操作は、概要タブのデプロイ
ボタンからデプロイを行う場合と同様です。
再デプロイ
デプロイ履歴の一覧表の再デプロイ列のアイコンをクリックすることで、デプロイしたフローを再度デプロイできます。
再デプロイボタンをクリックすると、確認ダイアログが表示されます。確認
ボタンをクリックすると再デプロイを開始します。
アクセスタブ
クラウド実行環境に対するアクセス制御を設定できます。
プロジェクトの所有者、管理者ロールのユーザーは、クラウド実行環境に対してすべての操作を行うことができます。 ここでアクセスの設定を行えるのは、コラボレーターロールのユーザーに対するアクセス制御です。アクセス制御できる操作は以下です。
- ログ
クラウド実行環境のログの閲覧可/不可を制御します。ログを閲覧不可にした場合、そのユーザーがクラウド実行環境画面を表示するとログタブは表示されなくなります。 - デプロイ
クラウド実行環境へのフローのデプロイ可/不可を制御します。デプロイを不可にした場合、そのユーザーがクラウド実行環境画面を表示するとデプロイ
ボタンが表示されなくなります。 - 設定
クラウド実行環境の設定変更可/不可を制御します。設定変更を不可にした場合、そのユーザーがクラウド実行環境画面を表示すると設定タブは表示されなくなります。
アクセス制御の設定は、プロジェクトの所有者、および、管理者ロールのユーザーのみ実施できます。
クラウド実行環境作成直後は、コラボレーターによるすべての操作は不可であるため、必要に応じ可に変更してください。
ログタブ
ログの閲覧
クラウド実行環境にデプロイされたフローが実行時に出力したログを閲覧できます。
ログは背景が灰色の領域に表示します。 左側にログの受信時刻を水色の文字で表示します。この日時のタイムゾーンはWebブラウザの設定に従います。
右側の<最初のログが出力された時刻>〜<最後のログが出力された時刻>の形式で表示された日時の一覧は、その期間に出力されたログのかたまりを表します。日付をクリックするとそのかたまりに含まれるログが表示されます。
このログのかたまりは、1回以上のフローの実行で出力される一連のログがまとめられます。1回の実行で出力されるログが複数のログのかたまりに分散することはありません。
また、右側の日付のうち濃い黒字になっているログのかたまりは、Webブラウザに読み込み済みであることを表します。読み込み済みのログは、すぐに表示できますが、読み込まれていない場合は表示までに時間がかかることもあります。
ライブモード
上部のライブモードをONにすると、5秒間隔で自動的にログの取得を行います。
フローを動作させながらデバッグを行う場合に有用です。
フィルター
ログを検索したい場合は、上部のフィルター
ボタンから行うことができます。
フィルターで利用できるパラメーターは以下です。
- フィルターしたい語句
特定のキーワードで検索したい場合には、フィルターしたい語句欄にそのキーワードを入力してください。 - 開始時間
ログの検索対象の開始時間を指定します。開始時間を設定する
をONにすると、日時を入力するフォームが表示されるので日時を指定してください。日時は、Webブラウザに設定されたタイムゾーンで入力してください。 - 終了時間
ログの検索対象の終了時間を指定します。終了時間を設定する
をONにすると、日時を入力するフォームが表示されるので日時を指定してください。日時は、Webブラウザに設定されたタイムゾーンで入力してください。
上記を設定し、確認
ボタンを押すと条件に合致するログのみ表示されます。
設定タブ
タグの追加
クラウド実行環境の区別をするために、タグを付与できます。
設定タブの上部にクリックしてタグを追加
と表示があるので、これをクリックして付与したい文字列を入力し、改行キーを押してください。同様の操作を繰り返すことで複数のタグを入力できます。
タグは、概要タブ、設定タブ、クラウド実行環境の一覧画面で閲覧できます。
設定を編集する
設定を変更するには、右上の設定を編集する
をクリックしてください。
クリックすると編集モードに変わり、設定を変更できるようになります。
名称
クラウド実行環境の名称を変更します。
トリガー設定
HTTPトリガー
クラウド実行環境にデプロイしたフローをHTTPリクエストにより実行できるようにします。
HTTPトリガーのトグルスイッチをONにし、パス
にフローを呼び出すためのパスの文字列を指定してください。すでに他のクラウド実行環境で利用されているパスは利用することができません。
HTTPトリガーを設定すると、以下のURLにアクセスすることにより、フローを呼び出すことが可能になります。
https://lcdp<3桁の番号>.enebular.com/<指定したパス>/
3桁の番号は、HTTPトリガーを設定したときに自動的に決定される番号です。
上記URLは、HTTPトリガーのトグルスイッチをオフにしてもキープされ続けます。
URLを解放したい場合は、パス欄を空欄にして設定を保存します。
スケジュールトリガー
定期的にフローを実行したい場合に、スケジュールトリガーを設定してください。
スケジュールトリガーのトグルスイッチをONにし、スケジュールの指定を行うことで設定できます。
たとえば、10分おきにフローを実行したい場合は、毎分
と記載された欄をクリックし、0、10、20、30、40、50を選択すると指定できます。
次のスケジュールトリガー
欄に、今後の実行予定が3件分表示されますので参考にしてください。
以下にスケジュールトリガーを利用する際の注意点を列挙します。
- スケジュールトリガーで指定できる最小の頻度は1分毎です
- 指定された実行日時から1分程度の遅延の可能性があります
- なんらかの理由でスケジュールトリガーの実行が行われなかった場合、実行できるようになったタイミングで実行されます(次のスケジュールされた時刻まで待つことはしません)
- 例1: たとえば1時間毎の0分に実行するように設定していた状態で、障害などにより10:00の実行が行われず、10:30に障害から復旧した場合には10:30に実行されます(その次の実行予定は11:00です)
- 例2: たとえば1時間毎の0分に実行するように設定していた状態で、障害などにより10:00の実行が行われず、11:30に障害から復旧した場合には10:00の実行はスキップされ、11:30に実行されます(その次の実行予定は12:00です)
タイムアウト
フローの実行を中断するまでのタイムアウト時間を指定します。適切なタイムアウト時間を指定することで、予想外に実行時間が増えてしまうことを抑止できます。
1回のフローの実行時間が、ここで指定したタイムアウト時間を超えた場合、フローの実行は中断されます。
環境変数
クラウド実行環境に環境変数を設定します。
環境変数は、キーと値のペアで、クラウド実行環境毎に複数の環境変数を指定できます。
設定した環境変数は、フローから参照します。1つのフローを複数のクラウド実行環境にデプロイして実行する場合に、クラウド実行環境に応じて振る舞いを変更するために利用します。
たとえば、テスト用クラウド実行環境からアクセスする外部サーバと、本番用クラウド実行環境からアクセスする外部サーバのURLを別にしたい場合、テスト用実行環境の環境変数にテスト用の外部サーバのURLを設定し、本番用クラウド実行環境の環境変数に本番用の外部サーバのURLを設定することでテストと本番で同じフローが利用できます。
環境変数を追加するには、環境変数
欄のキーと値の入力フィールドに適切な値を入力し、追加
ボタンを押します。
これを繰り返すことで複数の環境変数を追加可能です。
すでに追加した環境変数の値を変更したい場合は、設定済みの環境変数の右の鉛筆アイコンをクリックすると編集できるようになります。
環境変数を削除したい場合は、設定済みの環境変数の右のX
アイコンをクリックすると削除できます。
環境変数に、AWS_
またはLAMBDA_
、ENEBULAR_
から始まるキーなど設定不可能なキーがあります。設定不可能なキーを設定した場合は、追加できません。
エージェント実行環境との接続
エージェント実行環境とメッセージをやり取りするには、エージェント実行環境との接続
のトグルボタンをONにします。
エージェント実行環境と接続するために必要な準備については実行環境間の接続準備を参照ください。
データストアへの接続
データストアへの接続を行う場合は、データストアへの接続
のトグルボタンをONにします。
データストアへの接続をするために必要な準備についてはデータストアを利用するフローの作成を参照ください。
webスクレイピングの利用
webスクレイピングは、トライアルプラン、またはエンタープライズプランでのみ利用できます。
フリープランの場合、webスクレイピングの利用
のトグルボタンは表示されません。
クラウド実行環境で、webスクレイピングノードを利用する場合は、webスクレイピングの利用
のトグルボタンをONにします。
webスクレイピングノードは、Discover Assetsに公開していますので、以下の手順でプロジェクトにインポートしてください。
- 検索欄に
web-scraping
と入力し、プルダウンから名称
を選択してください web-scraping
のオフィシャルアセット(enebular
の帯付きのアセット)が表示されますのでクリックします- 右上の
インポート
ボタンを押します - インポート先を選択するダイアログが表示されますので、インポート先のプロジェクト名と、このアセットに対するコラボレーターの権限を設定し、
インポート
ボタンを押します
webスクレイピングノードの詳細については、webスクレイピングノードの情報タブのヘルプをご参照ください。
クラウド実行環境で動作するフローを作成する場合は、以下を参照し必要なプライベートノードのインポートを実施してください。
SlackBot I/Fの利用
SlackBot I/Fは、トライアルプラン、またはエンタープライズプランでのみ利用できます。
フリープランの場合、SlackBot I/Fの利用
のトグルボタンは表示されません。
Slackのスラッシュコマンドで、クラウド実行環境を実行したい場合に、SlackBot I/Fの利用設定をしてください。
SlackBot I/Fを利用する場合は、SlackBot I/Fの利用
のトグルボタンをONに切り替え、以下の項目に、Slackの情報を入力します。
- ドメイン
- スラッシュコマンド
- Signing Secret
利用手順は以下のとおりです。
利用手順
- Slack APIでアプリを作成し、以下を控えておきます
- Signing Secret
- ワークスペースのドメイン
- クラウド実行環境の設定画面で
SlackBot I/Fの利用
のトグルスイッチをONにします - 以下を入力して、
保存
ボタンをクリックします- ドメイン
- スラッシュコマンド
- Signing Secret
- SlackアプリのSlash Commandsページを開き、Create New Commandボタンをクリックします
- Slash Command作成ページで、commandとRequest URLそれぞれにクラウド実行環境設定ページで入力したスラッシュコマンド名とRequest URLを入力して、保存します
- ワークスペースの任意のチャンネルからコマンドを送信すると、クラウド実行環境が実行されます
実行に成功した場合、Slackから以下の応答があります。
- [🟢 Success] <スラッシュコマンド名>の実行に成功しました。
実行に失敗した場合、Slackから以下いずれかの応答があります。クラウド実行環境、およびSlackアプリの設定を見直していただき、再度お試しください。
- [🔴 Error] <エラーメッセージ>
- <スラッシュコマンド>はエラー「dispatch_failed」により失敗しました
クラウド実行環境設定の移行
クラウド実行環境の設定を別のクラウド実行環境に移行します。 移行完了後、移行先のクラウド実行環境の設定は移行元の設定で上書きされます。
移行手順は以下のとおりです。
移行手順
- 移行元の
実行環境の移行
欄に、移行先のクラウド実行環境のIDを入力します 移行
ボタンをクリックします- モーダル画面の内容を確認し、
移行
ボタンをクリックします - 移行先のクラウド実行環境のプロジェクトの所有者に承認用のメールが届きます。メール内に記載されたURLをブラウザで開くことにより、クラウド実行環境の移行が完了します。
注意
- クラウド実行環境設定の移行欄はプロジェクトの所有者のみに表示されます。
- 移行リクエスト承認用のメール内のリンクの有効期限は10分間です。
移行対象の設定項目
移行できるクラウド実行環境の設定項目は以下のとおりです。
- タイムアウト設定
- すべての環境変数
- トリガー設定
- HTTPトリガー
- トリガーのON/OFF
- パス
- スケジュールトリガー
- トリガーのON/OFF
- スケジュール
- HTTPトリガー
注意 移行完了後、移行元のクラウド実行環境のHTTPトリガーはOFFになり、パスは削除されます。
クラウド実行環境IDのコピー
実行環境ID
欄からクラウド実行環境のIDをコピーできます。
クラウド実行環境の設定を移行したいときなどに利用します。
削除
クラウド実行環境を削除したい場合は、削除
ボタンを押して実施します。