アップデート手順
概要
本手順書では、enebular-agentアップデート(ユーティリティ)を使用したアップデート手順を説明します。
本手順書では、両方のアップデート手順を記載していますが、enebular-agentアップデートはすでにデバイスにインストールされている接続方法に合わせてアップデートを行います。
なお、Pelion Device Managementでインストールしているenebular-agentはアップデートできません。
アップデートは、対象デバイスのLinux OS上でシェルスクリプト(以降、アップデートスクリプト)を実行することにより行われます。
説明
前提条件
アップデートスクリプトでは、現在から2年以内にリリースされたenebular-agentのバージョンからのアップデートをサポートします。
アップデートスクリプトを実行するための前提条件は以下です。
- 2年以内にリリースされたenebular-agentのインストールが完了していること
- enebularへの接続方法:AWS IoT / エージェント実行環境
- サポートしているOS(参照)にアップデートしてからenebular-agentのアップデートを行ってください
以下に対象毎の確認事項を記載します。
Linux
- enebular-agentがサポートするDebian GNU/Linuxであること
- enebular-agentを実行するユーザーが作成されていること(以降では
enebular
ユーザーが作成されているという前提で記載) - インストールに使用するユーザーがsudo権限(
sudo
コマンドを使用)を持っていること - インターネット接続環境があること
AWS IoT
- AWSのアカウントが作成されていること
- このアカウントにはAWSIoTConfigAccessの権限が与えられていること
enebular
- enebularのアカウント
- enebularのプロジェクト
インストール時のオプション
- インストール時のオプションに
--no-startup-register
を指定していないこと--no-startup-register
を指定していた場合、アップデートスクリプトを使用したアップデートは行えません。
アップデートスクリプトを使用しないアップデートについては、 [email protected] までお問い合わせください。--no-startup-register
オプションの詳細は、インストール手順 - オプションを参照してください。
アップデートスクリプトの実行
アップデートスクリプトは、対象デバイスのLinuxにログインして、shellより以下のコマンドを入力することで実行できます。
wget -qO- https://enebular.com/agent-update | sudo -E bash -s -- オプション1 オプション2 ・・・
上記のコマンドを実行するフォルダーは、どこでも構いません。
アップデートスクリプトは、enebular.comサーバーよりインターネット経由で取得します。
アップデートに必要な情報(enebularへの接続方法:AWS IoT、インストール先フォルダー等)はアップデートスクリプトが環境変数等を参照して自動取得します。
そのため、任意のフォルダーでアップデートスクリプトを実行できます。
また、アップデートスクリプトはenebular-agentのサービスの起動状況によらず、アップデートを行うことができます。
オプション
アップデートスクリプトに設定できるオプションとオプション引数と省略可/不可は次の表のとおりです。
オプション | オプション引数 | 省略可/不可 | 説明 |
---|---|---|---|
--user | =enebular-agentをインストールした名 |
省略不可 | enebular-agentを実行するユーザー |
-h,--help | 無し | 省略可 | 利用情報を出力する |
オプション設定時の注意事項
オプション設定時の注意事項を列挙します。
- オプションは複数指定可能です(オプションとオプションの間は半角ブランク)
- オプション引数には不要な半角ブランクを入れないでください
事例
アップデートスクリプトの実行例
アップデートスクリプトの実行例を示します。
コマンド実行例(AWS IoTの場合)
wget -qO- https://enebular.com/agent-Update | sudo -E bash -s -- --user=enebular
上記事例のオプションの意味は以下のとおりです。
- Linuxユーザーは
enebular
- その他のオプションは省略
結果
アップデートスクリプトは、アップデート前のenebular-agentを停止してからアップデート処理を行います。
その後アップデートしたenebular-agentを起動し、アップデートスクリプトは終了します。
enebular-agentの実行状況の確認方法
systemctl status enebular-agent-enebular.service
上記のコマンドを実行することでenebular-agentのサービスの起動状況(起動/停止)を確認できます。
sudo journalctl -ex -u enebular-agent-enebular.service
enebular-agentのサービスが起動している場合は、上記のコマンドを実行することでenebular-agentの実行状況を確認できます。
Node.jsのインストール
必要としているNode.jsのバージョンを利用可能にするため、Node.jsをダウンロードしインストールする場合があります。
Node.jsの詳細については、Node-RED - 備考を参照してください。