ユーザー定義のアクション、関数、およびワークフローエンジンの変更
次のセクションでは、Paragon Automationコマンドラインインターフェイス(CLI)でUDA/UDF/ワークフローエンジンを変更する方法について説明します。
以下に示すように、Paragon Automation CLIを使用してUDA、UDF、またはワークフローエンジンを変更できます。
Paragon Automationのプライマリノードから以下のbashコマンドを実行する必要があります。
user@paragon-master:/var/local/healthbot# ./healthbot modify-uda-engine --help
usage: healthbot modify-uda-engine [-h] (-s SCRIPT | --rollback) [--simulate]
optional arguments:
-h, --help show this help message and exit
-s SCRIPT, --script SCRIPT
Run script in UDA engine
--rollback, -r Rollback UDA engine to original state
--simulate Run script in simulated UDA engine and show output
user@paragon-master:/var/local/healthbot# ./healthbot modify-udf-engine --help
usage: healthbot modify-udf-engine [-h] (-s SCRIPT | --rollback) [--simulate]
[--service SERVICE]
optional arguments:
-h, --help show this help message and exit
-s SCRIPT, --script SCRIPT
Run script in UDF engine
--rollback, -r Rollback UDF engine to original state
--simulate Run script in simulated UDF engine and show output
--service SERVICE Modify specific service UDF
root@paragon-master:/var/local/healthbot# ./healthbot modify-workflow-engine --help
usage: healthbot.py modify-workflow-engine [-h] (-s SCRIPT | --rollback)
[--simulate]
optional arguments:
-h, --help show this help message and exit
-s SCRIPT, --script SCRIPT
Run script in WORKFLOW engine
--rollback, -r Rollback WORKFLOW engine to original state
--simulate Run script in simulated WORKFLOW engine and show output
コマンドには、主に次の 3 つのオプションがあります。
-
シミュレーション—実行中のParagon Automationシステムに影響を与えることなく、シミュレートされたUDA/UDF/ワークフローエンジン環境でスクリプトをテストします(そしてその出力を表示します)
-
変更 - スクリプトを使用して実際の UDA/UDF/ワークフロー エンジンを変更します。
-
ロールバック - UDA/UDF/ワークフロー エンジンの元のバージョンに戻します。
使用上の注意
-
bash スクリプトは、Ubuntu OS リリース 16.04 または 18.04 を実行しているコンテナーで実行されます。それに応じてスクリプトを記述します。
-
スクリプトは非対話型である必要があります。質問は事前に回答する必要があります。たとえば、apt-get を使ってパッケージをインストールする場合は、'-y' オプションを使用します。
-
依存関係モジュールのソースパッケージをParagon Insightsサーバーにコピーして、エンジンがインターネットからダウンロードする代わりに手動でインストールできるようにする場合は、必要なソースパッケージを /var/local/healthbot/input ディレクトリに配置します。次に、bashスクリプト内で/ input ディレクトリをポイントします。たとえば、 /var/local/healthbot/input/myfile.txt に配置されたファイルを使用するには、 /input/myfile.txt でアクセスするように bash スクリプトを設定します。
-
UDA/UDF/ワークフロー エンジンを複数回変更することは、増分手順 ではありません 。元の命令と新しい命令の両方を含む新しい Bash スクリプトを使用し、新しいスクリプトを使用して modify プロシージャを再実行します。
-
UDA/UDF/ワークフロー エンジンへの変更は、現在のインストールに適用できます。
バージョンをアップグレードしたら、スクリプトを実行して UDA/UDF/ワークフロー エンジンを変更する必要があります。
次の例では、UDA エンジンを使用しています。これらの手順は、UDF エンジンとワークフロー エンジンに等しく適用されます。
次の手順は、Paragon Automationサーバーがインストールされていることを前提としています。
シミュレート
シミュレーション機能を使用して、実行中のParagon Insightsシステムに影響を与えることなく、シミュレーション環境でbashスクリプトをテストします。
UDA エンジンの変更をシミュレートするには:
-
コマンド
./healthbot modify-uda-engine -s /<path>/<script-file> --simulateを入力します。 -
スクリプトが実行され、自分でスクリプトコマンドを入力したかのように出力が画面に表示されます。
user@paragon-master:/var/local/healthbot# ./healthbot modify-uda-engine -s /var/tmp/test-script.sh --simulate Running /var/tmp/test-script.sh in simulated alerta engine.. Get:1 http://security.ubuntu.com/ubuntu xenial-security InRelease [109 kB] ... Fetched 4296 kB in 15s (278 kB/s) Reading package lists... Building dependency tree... Reading state information… ...
変更
シミュレーション結果に問題がなければ、実際の修正手順に進みます。
UDA エンジンを変更するには:
-
目的のbashスクリプトをParagon Insightsサーバーに読み込みます。
-
Paragon Insightsサーバーが完全に稼働している場合は、 コマンド
./healthbot stop -s alertaを発行して実行中のサービスを停止します。 -
コマンドを実行
./healthbot modify-uda-engine -s /<path>/<script-file>します。user@paragon-master:/var/local/healthbot# ./healthbot modify-uda-engine -s /var/tmp/test-script.sh Running /var/tmp/test-script.sh in simulated alerta engine.. Success! See /tmp/.alerta_modification.log for logs Please restart alerta by issuing './healthbot start --device-group healthbot -s alerta'
-
(オプション)出力に示されているように、ログ ファイルをチェックして、スクリプトが正常に読み込まれたことをさらに確認できます。
-
コマンドを使用して
./healthbot start -s alertaアラートサービスを再起動します。 -
完了したら、 コマンドを使用して
./healthbot statusalerta サービスが稼働していることを確認します。 -
UDA エンジンが更新されたことを確認するには、コマンドを使用して
./healthbot version -s alerta、healthot_alerta コンテナーがタグ<version>-customを使用していることを確認します。user@paragon-master:/var/local/healthbot# ./healthbot version -s alerta {'alerta': 'healthbot_alerta:2.1.0-custom'}
UDA エンジンは、bash スクリプトに従って、インストールされた依存関係で実行されているようになりました。
ロールバック
エンジンへの変更を削除する必要性または要望がある場合は、エンジンを元の状態に戻すことができます。
UDA エンジンをロールバックするには:
-
コマンド
./healthbot modify-uda-engine --rollbackを入力します。user@paragon-master:/var/local/healthbot# ./healthbot modify-uda-engine --rollback Rolling back alerta engine to original state.. Successfully rolled back alerta engine Please restart alerta by issuing './healthbot start --device-group healthbot -s alerta'
この時点では、alerta サービスを再起動する必要はありません。
-
完了したら、 コマンドを使用して
./healthbot statusalerta サービスが稼働していることを確認します。 -
UDA エンジンが元に戻ったことを確認するには、コマンドを使用して
./healthbot version -s alerta、healthot_alerta コンテナーがタグ<version>を使用していることを確認します。user@paragon-master:/var/local/healthbot# ./healthbot version -s alerta {'alerta': 'healthbot_alerta:2.1.0'}
これで、UDA エンジンは元の状態で実行され、追加の依存関係はインストールされていません。