1 / 12

インストールマニュアル

SenseLink GE Enterpriseをインストールする手順について記載されています。

本マニュアルでは、ビルディングアクセスソリューションおよびAI温度検知ソリューションの管理プラットフォームであるSenseLink GE Enterprise V2.2.0（以下SenseLink）をインストールする手順について記載しています。

本マニュアルはIT部門に所属するお客様、Linux、Kubernetes、Docker、クラウドなどの利用・運用経験があるお客様を対象にしています。

改訂履歴

1 概要

SenseLinkのインストールパッケージは、ファイルの容量が大きいため以下の通り分割して提供いたします。

分割ファイル1：SenseLinkGE-Enterprise-2.x.0.yyyymmdd.tar.gz-aa　
分割ファイル2：SenseLinkGE-Enterprise-2.x.0.yyyymmdd.tar.gz-ab

分割ファイルからインストールパッケージへの復元は、格納フォルダーへ遷移し下記コマンドを実行してください。

Ubuntu/Macの場合

Windowsの場合

2 サーバー要件

2.1 前提

当ソフトウェアは、物理サーバーまたはAmazon Web Service社が提供する仮想サーバー Amazon Elastic Compute Cloud （Amazon EC2）、ソフトバンク株式会社が提供するAlibaba Cloud Elastic Compute Service （Alibaba ECS）にインストールしてご利用いただけます。その他の仮想サーバーではご利用いただけませんのでご注意ください。

2.2 基本要件

当ソフトウェアのサーバー要件は、登録者数及び接続する顔認証デバイス数に応じます。

各型番の要件は以下の通りです。要件を満たすAmazon EC2およびAlibaba ECSのインスタンスタイプについては、Amazon Web Service社、ソフトバンク株式会社へお問い合わせください。

※HDD容量の見積もりについては、参考値を記載しております。次項HDD容量サイジング指標をご参照ください。データ保存用ストレージのHDDを追加マウントする方法の参照例は8.2節を参照ください。

2.3 HDD容量サイジング指標

顔認証1件の履歴データとして約700KBがHDDに追加で保存されます。1日の顔認証人数と頻度、データ保存年数年数から適切なHDDの容量をお見積もりください。

3 システム動作環境

3.1 定義

当ソフトウェアには、以下のシステム動作環境が必要です。必須の項目については、サポート環境または推奨環境から環境をご準備ください。任意の項目は当ソフトウェアの動作環境に必要なものではございませんが、セキュリティやお客様の効率性の観点でより快適にご利用いただくために、代表的なソフトウェアを記載しております。記載されたソフトウェア以外をご利用いただくことも可能です。

また、当ソフトウェアにはサポート環境と推奨環境をご用意しています。サポート環境は最低動作環境を含む環境条件を指し、サポート環境にてSenseLinkをご利用いただく場合、サポートサービス規約にて定義されるサポートサービスをご提供させていただきます。推奨環境はサポート環境のうちもっとも安定した稼働が当社により確認されている環境です。特別な条件、指定、制限がない場合、推奨環境でのご利用をおすすめします。また、当インストールマニュアルでは推奨環境でのインストールを例としてご案内しております。お客様の既存環境に影響を及ぼさない為に、当ソフトウェアの専用環境を構築することを推奨します。

3.2 システム動作環境

アンチウイルスソフトを導入した状態では、品質保証試験を実施していないため、「アンチウィルスソフトをインストールする事」はお勧めしていません。なお「アンチウィルスソフトをインストールしない事」でセキュリティ面の問題があるか否かは、お客様ご自身で判断していただく必要があります。

4 物理サーバーの事前準備

本章では、物理サーバーの事前準備の概要について記載します。Amazon EC2やAlibaba ECSをご利用のお客様は、次章、次々章へお進みください。

SenseLink GE V2.x.0のイメージファイル（SenseLinkGE-Enterprise-2.x.0.yyyymmdd.tar.gzファイル）をサーバーに配備してください。

サーバをネットワークに接続してください。なお、サーバー配置場所の物理的なセキュリティ対策、およびサーバーへのアクセスIP制限や、アクセス可能なIPを持つPCへのログイン制御などのセキュリティ対策の実施をお願い申し上げます。

以上で物理サーバーの事前準備は完了です。事前準備が完了したお客様は、第5章、第6章をスキップし第7章へお進みください。

5 Amazon EC2の事前準備

本章ではAmazon EC2の事前準備の概要について記載します。物理サーバーをご利用のお客様は前章をご確認ください。Alibaba ECSをご利用のお客様は当章をスキップし次章へお進みください。また、Amazon EC2の他Amazon Web Serviceが提供するサービスの設定や利用方法の詳細については、Amazon Web Service社へお問い合わせください。

なお、メニュー名やAmazon Web Serviceのマネジメントコンソール図を英語表記とさせていただいております。ご了承ください。マネジメントコンソール図内の設定情報はお客様の環境によって異なります。

5.1 VPCの設定

Amazon Web ServiceのマネジメントコンソールからVPCのダッシュボードを開き、Launch VPC Wizardを押下してください。

お客様環境に合わせVPCの設定情報を入力、Create VPCを押下してください。

5.2 インスタンスの設定

EC2のダッシュボードからLaunch Instanceを押下してください。

Step1：Amazon Machine Imageを選択してください。

Step2: インスタンスタイプを選択してください。

Step3: VPCを設定してください。

Step4: ストレージを設定してください。

Step5、Step6 : Tagの設定を行なってください。セキュリティグループの設定ページで、お客様のポリシーに合わせてインターネットアクセスへの制限等の設定を行なってください。

Step7: 設定内容を確認し、Launchを選択してください。

Step8: キーペアを選択、ダウンロードしてInstanceをLaunchしてください。

5.3 ログイン

ご利用の端末から、キーペアを利用しインスタンスへログインしてください。

$ ssh -i launch.pem [ユーザー名]@[IPアドレス]

5.4 ディスクのフォーマット

ディスクのフォーマットを行なってください。

$ sudo lsblk
NAME MAJ:MIN RM SIZE RO TYPE MOUNTPOINT
xvda 202:0 0 20G 0 disk
xvda1 202:1 0 20G 0 part /
xvdh 202:112 0 1000G 0 disk
$ sudo mkfs.ext4 /dev/xvdh
$ echo -e "/dev/xvdh\t/data\text4\tdefaults\t0 0" >> /etc/fstab

5.5 SenseLinkイメージファイルの配備

SCPでSenseLink GE V2.2.0のイメージファイル

（SenseLinkGE-Enterprise-2.2.0.yyyymmdd.tar.gzファイル）をインスタンスに配備してください。

（下記のlaunch.pemを適切なssh private key fileに置き換えてください）

$ scp -i launch.pem SenseLinkGE-Enterprise-2.2.0.yyyymmdd.tar.gz [ユーザー名]@[IPアドレス]:[配備先パス]

以上でAmazon EC2の事前準備は完了です。事前準備が完了したお客様は、第6章をスキップし第7章へお進みください。

ライセンスのアクティベーション後にインスタンスを長期間停止後再起動するとUDIDが変更・ディアクティベートされ再度アクティベーションできなくなる可能性があります。可能な限りインスタンスを停止しないようお願い申し上げます。新しいUDIDのライセンスの再発行が必要な場合JCV製品提供窓口までご連絡ください。なお、ライセンスの再発行には数日頂戴する場合がございます。

6 Alibaba ECSの事前準備

本章ではAlibaba ECSの事前準備の概要について記載します。物理サーバーをご利用のお客様は前々章を、Amazon ECSをご利用のお客様は前章をご確認ください。また、Alibaba ECSの他Alibaba Cloudが提供するサービスの設定や利用方法の詳細については、ソフトバンク株式会社へお問い合わせください。

なお、メニュー名やAlibaba Cloudのコンソール図を英語表記とさせていただいております。ご了承ください。コンソール図内の設定情報はお客様の環境によって異なります。

6.1 基本設定

Step1: Alibaba CloudのWebコンソールからElastic Compute Serviceを選択し、Create Instanceボタンを押下してください。

Step2: 基本設定を行います。Billing MethodとリージョンRegionを選択してください。

Step3: インスタンスタイプを選択してください。以下の図は一例です。お客様の利用用途や環境に合わせたインスタンスタイプを選択してください。

Step4: Imageを選択してください。

Step5: ストレージの設定を行なってください。System Disk、Data Disk両方の設定が必要です。

Step6: ネットワークの設定を行なってください。VPC、VSwitchともに既存のものまたは新規作成を選択いただけます。

Step7: ネットワークのBilling Methodの設定を行なってください。

Step8: セキュリティグループの設定を行なってください。既存のセキュリティーグループまたは新規作成を選択いただけます。

ポートの22番と443番が許可されていることを確認してください。また、セキュリティグループの設定ページで、お客様のポリシーに合わせてインターネットアクセスへの制限等の設定を行なってください。

Step9: Logon Credentialsの設定を行なってください。既存のキーペアまたは新規作成を選択いただけます。キーペアはダウンロードして安全に保管してください。

Step10: プレビューより、インスタンスの設定が正しく行われていることを確認してください。確認後、Create Instanceを押下してください。

インスタンスが立ち上がるまでお待ちください。

6.2 ログイン

ご利用の端末から、キーペアを利用しインスタンスへログインしてください。

ssh -i launch.pem [ユーザー名]@[IPアドレス]

6.3 ディスクのフォーマット

ディスクのフォーマットを行なってください。

$ sudo lsblk
NAME MAJ:MIN RM SIZE RO TYPE MOUNTPOINT
vda 253:0 0 20G 0 disk
`-vda1 253:1 0 20G 0 part /
vdb 253:16 0 1000G 0 disk
$ sudo mkfs.ext4 /dev/vdb
$ echo -e "/dev/vdb\t/data\text4\tdefaults\t0 0" >> /etc/fstab

6.4 SenseLinkイメージファイルの配備

SCPでSenseLink GE V2.2.0のイメージファイル

（SenseLinkGE-Enterprise-2.2.0.yyyymmdd.tar.gzファイル）をインスタンスに配備してください。

（下記のlaunch.pemを適切なssh private key fileに置き換えてください）

$ scp -i launch.pem SenseLinkGE-Enterprise-2.2.0.yyyymmdd.tar.gz [ユーザー名]@[IPアドレス]:[配備先パス]

以上でAlibaba ECSの事前準備は完了です。

7 SenseLink GEのイメージファイル

7.1 メインディレクトリ

7.2 Public ディレクトリ

7.3 ポート使用状況

下記2のポート以外はSenseLinkの内部サービス間の通信のみに使われ、外部との通信では必要がないため、開放する必要がありません。

下記2つのポートは外部との通信で利用するため、開放してください。

80 (httpでSenseLinkを利用する場合)
443 (httpsでSenseLinkを利用する場合)

上記以外のポートは外部からの通信を許可しない設定にすることをお勧めします。ただし、デバイスからSenseLinkのNTPサービスを使う場合、ポート123を開く必要があります。

ファイアウォールを使ってポートの外部通信を許可しない設定にすることが可能です。

ubuntuにはデフォルトで「ufw」というファイアウォールツールが存在しています。詳細な使い方については、ubuntuのオフィシャルドキュメントをご参照ください(https://help.ubuntu.com/community/UFW)

本書では、「ufw」を使ってポートの外部通信をブロックする方法を例としてご紹介します。

ターミナル（端末）を開き、まず、すべてのポートをブロックしてください。

$ sudo ufw default DENY

SenseLinkのために80番もしくは443番のポートを、その他お客様ご自身がご利用になるアプリケーションのためのポート（例：SSH通信のための22番）に外部通信を許可してください。

$ sudo ufw allow 22
$ sudo ufw allow 80
$ sudo ufw deny 443

メールサービスが必要な場合、必要に応じてアウトバンドポートを開いてください。

$ sudo ufw allow out to any port {smtp port} proto tcp

smtpポートを開く例：

$ sudo ufw allow out to any port 465 proto tcp

ufwを有効化してください。

$ sudo ufw enable

7.4 イメージファイル内容

7.5 コンテナのマウントファイル

上記マウントディレクトリ/data/sensetime/senselinkは8.8 データ保存ディレクトリの変更の設定次第で変化します。

8 インストール

8.1 インストール準備

サーバーのTerminal（端末）を開き、root権限を取得したうえで必要なソフトウェアをインストールしてください。

root権限を取得しパスワードを入力してください。

sudo su -

8.2 ハードディスクの追加

※要件を満たすハードディスクの設定がすでに完了している場合、またAmazon EC2及びAlibaba ECSをご利用の場合、このステップをスキップしてください。ディスク管理ツールを立ち上げるため、次のコマンドを入力してください。

sudo gnome-disks

ファイルシステムタイプはお客様のHDD設備に合わせて変更してください。

8.3 Docker のアンインストール

次のステップを進めると、お客様の既存Docker環境が使用できなくなります。お客様の既存環境に影響を及ぼさない為に、当ソフトウェアの専用環境を構築することを推奨します。

システム環境にdocker、docker.io、docker-engineがすでにインストールされている場合、すべてアンインストールしてから次のステップに進んでください。

sudo apt-get purge $(sudo dpkg -l | \ 
grep -e docker -e containerd -e runc | awk '{ print  $2 }')

8.4 Docker19.03.5のインストール

Ubuntu 18.04を使用する場合は以下です。

#Ubuntu 18.04の場合
$ sudo apt-get update
$ sudo apt-get install \
   apt-transport-https \
   ca-certificates \
   curl \
   gnupg-agent \
   software-properties-common
$ curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo apt-key add -
$ sudo apt-key fingerprint 0EBFCD88
$ sudo add-apt-repository \
  "deb [arch=amd64] https://download.docker.com/linux/ubuntu \
  $(lsb_release -cs) \
  stable"
$ sudo apt-get update
$ sudo apt-get install docker-ce=5:19.03.5~3-0~ubuntu-bionic docker-ce-cli=5:19.03.5~3-0~ubuntu-bionic containerd.io
# Check that docker version has been 19.03.5
$ sudo docker version

Ubuntu 16.04を使用する場合は以下です。

$ sudo apt-get update
$ sudo apt-get install \
   apt-transport-https \
   ca-certificates \
   curl \
   gnupg-agent \
   software-properties-common
$ curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo apt-key add -
$ sudo apt-key fingerprint 0EBFCD88
$ sudo add-apt-repository \
  "deb [arch=amd64] https://download.docker.com/linux/ubuntu \
  $(lsb_release -cs) \
  stable"
$ sudo apt-get update
$ sudo apt-get install docker-ce=5:19.03.5~3-0~ubuntu-xenial docker-ce-cli=5:19.03.5~3-0~ubuntu-xenial containerd.io
# Check that docker version has been 19.03.5
$ sudo docker version

8.5 Dockerのディレクトリ変更

手順1：daemon.jsonという名前のファイルを下記ディレクトリに保存します。　/etc/docker/daemon.json

例：Dockerコンテナ保存先を/dataにする場合

{
"data-root": "/data"
}

手順2：Dockerを再起動します。

sudo service docker restart

■Dockerコンテナの保存先を変更する理由システムドライブではなく別のドライブにDockerコンテナを保存することにより、システムドライブの容量を確保するためです。この設定は環境に応じて変更してください。なお、設定を変更しなくてもSenseLink GE Enterpriseの動作に影響はありません。

8.6 Dockerコンテナのリソース（メモリ）の権限設定

設定ファイルを変更してください。

vim /etc/default/grub

設定ファイルの、

GRUB_CMDLINE_LINUX=...　　

の行を以下のように変更してください。

GRUB_CMDLINE_LINUX="cgroup_enable=memory swapaccount=1"

（設定ファイルのデフォルト値はご利用になるOSのバージョンによって異なります）

上記変更後、新しい設定を適用させるため以下のコマンドを入力してください。

sudo update-grub

次に、サーバーを再起動してください。再起動コマンドは以下です。

reboot

8.7 イメージファイルの権限変更

ターミナルでroot権限を取得してください。その後、chomd 775 -Rで解凍されたSenseLinkのディレクトリに読込み、書込み及び実行する権限を付与してください。

# 下記"/home/root6/Desktop/{senselinkge-standardalone}"はインストールパッケージのディレクトリに置き換えてください
chmod 775 –R /home/root6/Desktop/{senselinkge-standardalone}

※アップグレードパッケージの保存ディレクトリおよびアップグレードパッケージ名は、お客様の環境に合わせて変更してください。

8.8 データ保存ディレクトリの変更

# 下記"/home/root6/Desktop/{senselinkge-standardalone}"はインストールパッケージのディレクトリに置き換えてください
vim /home/root6/Desktop/{senselinkge-standardalone}/config

senselink_config_pathを適切なデータ保存ディレクトリに変更してください。

本文ではsenselink_config_path=/data/sensetime/senselinkを前提で記述しています。

8.9 サービスのタイムゾーンを変更（オプション）

configファイルをvimで開き、time_zoneを適切に変更してください

例

# 下記"/home/root6/Desktop/{senselinkge-standardalone}"はインストールパッケージのディレクトリに置き換えてください
vim /home/root6/Desktop/{senselinkge-standardalone}/config
# vimを開く後、time_zone部分を変更
time_zone=GMT+9:00

8.10 インストール

SSLサーバー証明書の使用有無（SSL/TLS対応有無）によってインストールする前の事前作業が異なります。

httpsでインストールする場合（デフォルト）

お客様が準備したSSLサーバー証明書を「./public/web_service/Cert/」の直下にコピーして、「senselink.crt」と「senselink.key」にリネームしてください。

（本製品に同梱する「senselink.crt」と「senselink.key」は参照例です、使用しないでください。）

# 下記"/home/root6/Desktop/{senselinkge-standardalone}"はインストールパッケージのディレクトリに置き換えてください
cp {お客様のCert格納ディレクトリ}/sample.crt /home/root6/Desktop/{senselinkge-standardalone}/public/web_service/Cert/senselink.crt
cp {お客様のCert格納ディレクトリ}/sample.key /home/root6/Desktop/{senselinkge-standardalone}/public/web_service/Cert/senselink.key

httpでインストールする場合

run_all.sh内で実行するweb_serviceのシェルを、run.sh（https用）からrun_http.sh（http用）に変更してください。

run_all.shの内容を変更します。変更コマンドは以下です。

# 下記"/home/root6/Desktop/{senselinkge-standardalone}"はインストールパッケージのディレクトリに置き換えてください
vim /home/root6/Desktop/{senselinkge-standardalone}/public/run_all.sh

スクリプト内の下記箇所

cd ../web_service
./run.sh ${web_version}

を

cd ../web_service
./run_http.sh ${web_version}

に変更してください。

その後、アクセス可能なドメイン名を設定してください

# httpの場合は./public/web_service/defaultを編集してください
# 下記"/home/root6/Desktop/{senselinkge-standardalone}"はインストールパッケージのディレクトリに置き換えてください
vim /home/root6/Desktop/{senselinkge-standardalone}/public/web_service/default_https

add_header 'Access-Control-Allow-Origin' *; の部分が複数箇所存在します。

add_header 'Access-Control-Allow-Origin' http://xxx.xxx.com; に変更してください。（*の部分をアクセス可能なドメイン名を設定してください）

上記の準備完了後、install.shを実行して、インストールを開始してください。（約5分以内で完了します。）

# 下記"/home/root6/Desktop/{senselinkge-standardalone}"はインストールパッケージのディレクトリに置き換えてください
cd /home/root6/Desktop/{senselinkge-standardalone}
./install.sh

8.11 インストール時の注意事項

install.shの実行時、ハードウェア要件に満たすかどうかのチェックが実施されます。やむを得ずハードウェア要件に満たさないサーバーをご利用する場合、install.shと同ディレクトリにあるverify-env.shを修正する必要があります。下記の図の通りにハードウェアチェックの部分をコメントアウトしてからinstall.shを実行してください。

なお、ハードウェア要件に満たさないサーバーで本製品を稼働する場合、アプリケーションの動作が不安定となる恐れがあるため、ご了承ください。

8.12 データベースパスワードの変更（オプション）

インストール後でもデータベースのパスワードは変更可能です。全ての初期パスワードを変更するように推奨します。

変更するにはまずdatabase_serviceコンテナにログインして、MySQL、MongoDB、Redisのパスワードをそれぞれ変更した後（デフォルトパスワードはconfigファイルから確認できます）、configファイルのパスワードを変更し、restart.shを実行することでサービスを再起動してください。

# login to database_service container
docker exec -it database_service bash

# login to mysql, please change "senselink_2018_local" to your mysql password
mysql -u senselink -psenselink_2018_local
# change password for current user, please change "new_password" to your password
mysql> set password="new_password";
Query OK, 0 rows affected (0.00 sec)
mysql> exit
Bye

# login to mongodb
mongo
> use sensekeeper
switched to db sensekeeper
# please change "username","password" to your username/password in config file
> db.auth("username","password")
1
# now you can change the password
> db.changeUserPassword("username","new_password")
> exit
bye

# redis passowrd can be changed by modifying the config file and restart
# 下記"/home/root6/Desktop/{senselinkge-standardalone}"はインストールパッケージのディレクトリに置き換えてください
vim /home/root6/Desktop/{senselinkge-standardalone}/config
# modify “redis_password=senselink_redis” to “redis_password={new_password}”

# 下記"/home/root6/Desktop/{senselinkge-standardalone}"はインストールパッケージのディレクトリに置き換えてください
cd /home/root6/Desktop/{senselinkge-standardalone}
./restart.sh

9 ライセンスのアクティベーション

9.1 アクティベーション

ご利用のPCをSenseLinkのサーバーと同じネットワークに接続してください。PCのWebブラウザを立ち上げ、SenseLinkのサーバーアドレスを入力し、SenseLinkの管理画面を表示してください。サポートされているWebブラウザはGoogle Chrome、Firefox、Safariです。（それ以外のブラウザは保証しておりません。）

HTTP通信をご利用の場合
- http://{SenseLinkのサーバーアドレス}
HTTPS通信をご利用の場合
- https://{SenseLinkのサーバーアドレス}

ライセンスアクティベーション前のみ、ライセンスアクティベーションページが表示されます。

JCV製品窓口よりライセンスファイルとアクティベーションコードが送付されます。ライセンスアクティベーションページにてアクティベーションコードを入力し、ライセンスファイルをアップロードすると、ライセンスアクティベーションが完了します。

「Account」欄にアカウント名を、「Password」欄にパスワードを入力し、「Login」をクリックしてください。

Super Adminユーザーの初期アカウント名/パスワードは「admin1234」です。初期ログイン後、必ず初期パスワードの変更を行ってください。パスワード変更手順はユーザーマニュアル 11.2.3項アカウントの修正と削除を参照ください。

SenseLinkの利用開始に必要なインストール手順は以上です。 - SenseLinkユーザーマニュアル - SenseLink ToolKit ユーザーマニュアル - SenseLink APIマニュアルをご覧いただき、SenseLinkを引き続きご利用ください。

Amazon EC2またはAlibaba ECSをご利用中のお客様ライセンスのアクティベーション後にインスタンスを長期間停止後再起動するとディアクティベートされアクティベーションされない可能性があります。可能な限りインスタンスを停止しないようお願い申し上げます。ライセンスの再発行が必要な場合JCV製品提供窓口までご連絡ください。なお、ライセンスの再発行には数日頂戴する場合がございます。

10 アンインストール

サーバーのTerminal（端末）を開き、root権限を取得してください。

カレントディレクトリをパッケージのインストールディレクトリへ変更してください。

※パッケージのインストールディレクトリはお客様の環境に合わせて変更してください。

docker psを実行し、動いているdockerコンテナを確認します。

./uninstall.shを実行して、SenseLinkをアンインストールします。

参照：下記のアンインストールログが出力される想定です。

docker psを実行し、dockerコンテナが動いてないことを確認します。

次のステップを進むと、お客様の全データが消去されます。バックアップする必要がある場合は、運用マニュアルのデータバックアップとリストアを参照ください。

最後に、データ保存ディレクトリを削除します。