02. インストール
はじめに
インストールについて
インストールでは下記の処理が実行されます。
デバイスの固有情報を収集し、NEQTO Consoleへデバイス登録を行い、発行されたシリアルIDを格納します。
アーキテクチャを識別し、最新バージョンのソフトウェアパッケージをダウンロードして、インストールを行います。
ディストリビューションが保有する起動プロセスによって、
systemd
もしくはSysVinit
配下にNEQTOサービスを登録します。(優先的にsystemd
が選択されます)※
SysVinit
配下へのインストールはSWバージョン00.01.00
以降からサポートされています。
インストールツールはver 1.3 [2024/01/30]
以降の最新版を使用してください。
デバイス登録に関する注意事項
NEQTO Console上にデバイス登録する際、デバイスの固有情報が用いられます。
アーキテクチャ種別・CPU情報
、ネットワークアダプタMACアドレス(1つに限られ、優先的にイーサーネットアダプタが選択されます)
、OS情報(ディストリビューション名、バージョンは含まれません)
が収集され、自動登録されます。この固有情報は不変であることが前提であり、いずれかが変更となった場合、新規デバイス登録(再インストール)が必要となりますので注意願います。
再インストールについて
インストールは何度でも実行可能です。
既にインストール済みの状態で、再度インストールを実行した場合、設定済みのパラメータは引き継がれ、ソフトウェアのみ最新バージョンに更新されます。
一度アンインストールを行った状態でも、NEQTO Console上にデバイス登録が残っていれば、アンインストール前に発行されたシリアルIDで再構成されます。NEQTO Console上にデバイス登録が残っていない場合は、新規デバイス登録となります。
インストール
事前準備
インストールを開始する前に、下記項目を確認してください。
- NEQTO Consoleのアカウント登録が完了している必要があります。
- インストール対象デバイスがシステム要件を満たしている必要があります。
- インストール対象デバイスでネットワーク通信が疎通している必要があります。
- インストールには下記ツールが必要となります。必要に応じて事前にインストールしてください。
curl
またはwget
md5sum
- インストールを開始すると、デバイスのシステム固有の情報がNEQTOコンソールに送信され、自動的にデバイス登録が行われます。
systemd
サポート環境の場合、systemd
配下にNEQTOサービスが登録され、自動起動設定されます。systemd
非サポート環境の場合、SysVinit
配下にNEQTOサービスが登録され、自動起動設定されます。自動起動設定ツールとして、update-rc.d
もしくはchkconfig
が必要となります。必要に応じて事前にインストールしてください。これらのツールが存在しない状態でインストールを開始した場合、問い合わせメッセージが表示されます。
インストール手順
以下の手順に沿って操作してください。
はじめにNEQTO Consoleへログインし、インストールに必要なLinux用APIキーおよびインストールツールのダウンロードURLを確認します。
インストールツールはNEQTO Engineソフトウェアリリースと同時に更新される場合があります。常に最新バージョンのツールをダウンロードしてご使用ください。
インストールツールをLinuxデバイス内の任意ディレクトリにダウンロードします。
curl
を使用する場合$ curl -O https://<Download URL>/neqto-daemon-install.latest.sh↵ wget
を使用する場合$ wget https://<Download URL>/neqto-daemon-install.latest.sh↵
ダウンロードしたインストールツールに実行権限を設定します。
$ chmod 755 neqto-daemon-install.latest.sh↵ インストールを開始します。インストールツールに
-k
オプションでLinux用APIキーを指定し、スーパーユーザー(root)で実行してください。その他のコマンドオプションについてはこちらを参照してください。
# neqto-daemon-install.latest.sh -k <Linux API key>↵
実行直後、注意事項が表示されます。確認の上、同意する場合は
agree
を入力してください。以降、デバイス登録が実行され、継続してソフトウェアのインストールが開始されます。
============================================================
NEQTO Daemon Installation [ver X.X] (c) 2023 JIG-SAW INC
============================================================
*** IMPORTANT ***
Supported Architectures: armv6l armv7l aarch64 x86_64
Will begin installation of the NEQTO service.
Starting the installation will send the system-specific information of this device to the NEQTO Console for automatic registration.
If you agree and want to continue, please enter "agree" >> agree↵
- 下記、問い合わせメッセージが表示された場合は、こちらを確認してください。
Cannot find auto startup configuration tool for system services.
Either 'update-rc.d' or 'chkconfig' is required.
Do you want to continue the installation without setting the auto startup of the NEQTO service? [yes/no] >>
- 下記、問い合わせメッセージが表示された場合は、こちらを確認してください。
最終ステータスの
Installation completed successfully!
が表示されるまで、お待ちください。
============================================================
NEQTO Daemon Installation [ver X.X] (c) 2023 JIG-SAW INC
============================================================
*** IMPORTANT ***
Supported Architectures: armv6l armv7l aarch64 x86_64
Will begin installation of the NEQTO service.
Starting the installation will send the system-specific information of this device to the NEQTO Console for automatic registration.
If you agree and want to continue, please enter "agree" >> agree↵
============================================================ Registering device...OK
Device-specific information to register in NEQTO:
Platform: armv7l;XXXX;X;XXXX;XXXX;XXXX;XXXX
NIC: ethX-XX:XX:XX:XX:XX:XX
OS: Raspbian GNU/Linux
Assigned Serial ID: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
============================================================
Downloading package...OK
neqtod was installed under 'XXXXXX' (neqtod-XX.XX.XX)
============================================================
Starting NEQTO service...
Loaded: loaded (/etc/systemd/system/neqto.service; enabled; vendor preset: enabled)
Active: active (running)
============================================================
Installation completed successfully!
下記メッセージから、NEQTOサービスの登録先を確認できます。
systemd
配下に登録された場合neqtod was installed under 'systemd' (neqtod-XX.XX.XX)
SysVinit
配下に登録された場合neqtod was installed under 'SysVinit' (neqtod-XX.XX.XX)
デバイスではインストール完了と同時にNEQTOサービスが開始されます。
NEQTO Console上にデバイス登録された固有情報および発行されたシリアルIDは、上記インストールメッセージ上に表示されます。
継続、NEQTO Console上でノードの登録を進めてください。デバイスはNEQTO Console上でノードが紐づけられるまでリトライ動作を繰り返し、ノードが紐づけられると
neqto.js
を開始します。
コマンドオプション
-n <note>
デバイス登録と同時に、NEQTO Console上で管理されるデバイス情報の備考欄に任意文字列を書き込みます。新規デバイス登録時のみ有効となります。-f
インストールツール起動直後に表示される注意事項確認を同意とみなし、インストール処理を継続します。-i
systemd
サポート環境であっても、優先的にSysVinit
配下にNEQTOサービスを登録します。
本オプションは、初回インストール時のみ有効となります。再インストールの場合は、現在の登録先が継承されます。
トラブルシューティング
インストールが途中で失敗した場合、下記の事項を確認し、再度インストールを実行してください。それでも解決できない場合は、NEQTOサポートまでお問い合わせください。
インストール前の状態に完全クリーンアップする場合は、アンインストールを実行してください。
Please execute as root
と表示されます。
» インストールツールはスーパーユーザー(root)で実行する必要があります。APIKEY is not specified
と表示されます。
» インストールツールを起動する際に-k
オプションでLinux用APIキーを指定する必要があります。'systemctl' is required. Please install and try again
と表示されます。
» NEQTOデーモンはsystemd
が必要となります。システム要件を確認してください。'md5sum' is required. Please install and try again
と表示されます。
» インストールツールはmd5sum
コマンドを必要とします。別途インストールしてください。Either 'curl' or 'wget' is required. Please install and try again
と表示されます。
» インストールツールはcurl
またはwget
コマンドのどちらかを必要とします。別途インストールしてください。Unsupported architecture - XXXX
と表示されます。
» このデバイスのアーキテクチャはサポートされていません。システム要件を確認してください。No valid NIC
と表示されます。
» デバイス固有情報の内、必要となる有効なデバイスのNICが見当たりません。システム要件を確認してください。Registering device...
表示直後にcurl error
もくしはwget error
となります。
» 指定したLinux用APIキーが正しいか確認してください。
» ネットワーク通信が可能かつインターネットへアクセス可能であるか確認してください。Downloading package...
表示直後にcurl error
もくしはwget error
となります。
» ネットワーク通信が可能かつインターネットへアクセス可能であるか確認してください。systemctl daemon-reload error
、systemctl enable error
、systemctl start error
が表示されます。
»systemd
が正常に動作しているか確認してください。update-rc.d defaults error
、chkconfig add error
が表示されます。
»update-rc.d
もしくはchkconfig
が正常に動作しているか確認してください。NEQTO daemon start error
、NEQTO service could not be started
が表示されます。
» 何らかの要因で、NEQTOサービスが起動できません。一度アンインストールを実行してから、再度インストールを実行してください。Cannot find auto startup configuration tool for system services. Either 'update-rc.d' or 'chkconfig' is required. Do you want to continue the installation without setting the auto startup of the NEQTO service? [yes/no] >>
と表示されます。
»SysVinit
配下にNEQTOサービス登録する際に必要となる自動起動設定ツールが見当たりません。
▹no
と入力した場合、インストールが中止されます。LSB (Linux Standard Base)
仕様をサポートしているupdate-rc.d
もしくはchkconfig
を別途インストールしてください。
▹yes
と入力した場合、NEQTOサービスの自動起動が設定されない状態でインストールが継続されます。システムを再起動すると、本サービスは非アクティブ状態となります。そのため、システム起動毎にサービスをコマンド起動するもしくは、サービスを自動的に起動する仕組みを別途実装することが必要となります。
アンインストール
事前準備
アンインストールを開始する前に、下記項目を確認してください。
- アンインストールを開始すると、デバイスにインストールされているNEQTO関連データが全て消去されます。データを復元することはできません。
- NEQTO Console上に登録されている本デバイスに関連するデータ、登録情報およびライセンスは削除されません。アンインストール完了後に、別途、NEQTO Console上で削除してください。
アンインストール手順
以下の手順に沿って操作してください。
アンインストールを開始します。インストールツールに
-x
オプションを指定し、スーパーユーザー(root)で実行してください。Linux用APIキーの指定、ネットワーク通信は不要です。その他のコマンドオプションについてはこちらを参照してください。
# neqto-daemon-install.latest.sh -x↵
実行直後、注意事項が表示されます。確認の上、同意する場合は
agree
を入力してください。 以降、アンインストールが開始されます。============================================================
NEQTO Daemon Installation [ver X.X] (c) 2023 JIG-SAW INC
============================================================
*** IMPORTANT ***
Will begin uninstallation of the NEQTO service.
It completely removes all data related to the NEQTO already installed on this system. It will not be possible to restore this data.
In addition, the registration information and license associated with the device registered in the NEQTO Console will not be deleted. To delete this information, please perform the deletion on the NEQTO Console once the uninstallation is successfully complete.
If you agree and want to continue, please enter "agree" >> agree↵
最終ステータスの
Uninstallation completed successfully!
が表示されるまで、お待ちください。
============================================================
NEQTO Daemon Installation [ver X.X] (c) 2023 JIG-SAW INC
============================================================
*** IMPORTANT ***
Will begin uninstallation of the NEQTO service.
It completely removes all data related to the NEQTO already installed on this system. It will not be possible to restore this data.
In addition, the registration information and license associated with the device registered in the NEQTO Console will not be deleted. To delete this information, please perform the deletion on the NEQTO Console once the uninstallation is successfully complete.
If you agree and want to continue, please enter "agree" >> agree↵
============================================================
Uninstallation completed successfully!
コマンドオプション
- -f
インストールツール起動直後に表示される注意事項を同意とみなし、アンインストール処理を継続します。