3.1 ライセンスとは

SenseIDのGo-Workersサービスを使用するには、ライセンスファイルが必要です。ライセンスファイルのアクティベーションは、UDIDに紐づける形で実行されます。異なるサービスを使用する場合、対応するライセンスファイルも異なります。1つのSenseIDサーバーには、1〜3つのライセンスファイルに対応します。SenseIDを展開する前に、ライセンスファイルの名前を変更して、指定のディレクトリに配置する必要があります。

SenseIDのライセンスファイルは、JCV製品窓口より提供されます。アクティベーションの詳細については、次の手順を参照してください。

3.2 ライセンスの名前変更

• SENSEID_FACE_xxx.licファイルの名前を、senseid_face.licに変更

• SENSEID_KESTREL_xxx.licファイルの名前を、senseid_kestrel.licに変更

• SENSEID_LIVENESS_xxx.licファイルの名前を、senseid_liveness.licに変更

3.3 ライセンスの置き換え手順

3.3.1 インストールパッケージ展開

パッケージ名：1v1-private-cloud-v1.8.tgz

3.3.2 ライセンスファイル配置

SenseIDのインストールパッケージの解凍先にある、ライセンスディレクトリへ移動します。

以下の命令を実施し、次の3つのフォルダーが表示されることを確認できます。

指定したディレクトリにライセンスファイルをコピーし、元のファイルを上書きします。

SenseIDを認証するための展開方法について、主にインストール、設定、重要なサービスの起動、また発生する可能性のある問題とその解決策について詳しく説明しています。

4.1 インストールパッケージの展開確認

ライセンスファイルファイルを配置する為に、パッケージを解凍します。手順は3.3.1節をご参照ください。

解凍されたファイルのディレクトリへ移動し、現在のディレクトリにあるファイルを表示します。

$ cd 1v1-private-cloud-v1.8
$ ls -1

構造は次のとおりです。

api.tar
docker-compose
docker-compose.yml
go-workers
load_image.sh
package.toml
product.toml

4.2 Go-Workersの展開

このサービスは主要なコンピューティングサービスであるため、できれば専用のサーバーリソースを割り当てるようにしてください。

4.2.1 並行CPU数を調整

Go-Workersを配置する前に、サーバーの物理CPUコア数を確認する必要があります。物理CPUコア情報を取得するコマンドは以下のとおりです。

$ echo Cores=$(($(lscpu | awk '/^Socket/{print $2}') * $(lscpu | awk '/^Core/{print $4}')))

Go-Workersディレクトリへ移動して.envファイルを開き、専用サーバーを利用する場合、HANDLERSの値を先程確認した物理CPUコア数に設定してください。それ以外の場合は、コア数を指定してください。編集後、.envファイルを保存してください。

$ cd go-workers
$ vi .env

4.2.2 Go-Workersサービスを開始

Go-Workersサービスを開始します。

$ sudo ./start.sh

なお、展開ディレクトリ内に停止スクリプトも用意されています。停止したい場合、以下の命令を実行してください。

$ sudo ./stop.sh

4.2.3 Go-Workersサービス開始の確認

サービスが正常に開始したかを確認するために、以下の命令でログを参照します。

$ tail -f tmp/worker.log.0

tailコマンドの実行結果にポート番号50050のServer Listenが含まれていれば、サービスが正常に開始されたことを示します。

また、以下の命令でヘルスチェックを実施してください。

$ curl 127.0.0.1:50050/healthcheck

正常に展開された場合の実行結果の例は、以下のとおりです（これはサービスが正常に開始したことを示しています）。

{"request_id":"07a41c21822e4223a373e77bfc186ed2","status":"ok"}

4.3 Ruby-Cloud-APIを展開

4.3.1 サービスイメージを読み込む

Ruby-Cloud-APIのイメージファイルを読み込みます。

$ cd 1v1-private-cloud-v1.8
$ sudo ./load_image.sh

実行結果は以下のとおりです。

Loaded image: registry.sensetime.com/senseid-cloudv2/api-1v1:xxx

4.3.2 Go-Workersサービスアドレスを設定

Go-WorkersサーバーのIPアドレスを取得してください。

$ hostname -I | cut -d' ' -f1

SenseIDインストールパッケージのルートフォルダにある.envファイルを開きます。

$ vi .env

最終行の WORKER_IP 値を、Go-Workersサービスが展開されているサーバーの IP アドレスで設定します。

4.3.3 並行CPU数を調整

Go-Workersと同様に、サーバーの物理CPUコア数を設定します。

$ vi .env

.envファイルを開き、専用サーバーを利用する場合、API_HANDLESの値を先程確認した物理CPUコア数に設定してください。それ以外の場合は、コア数を指定してください。編集後、.envファイルを保存してください。

4.3.4 Ruby-Cloud-APIサービス開始

Ruby-Cloud-APIサービスを開始します。

$ sudo ./docker-compose up -d

結果は、以下のとおりです。

Creating network "1v1-private-cloud-yyyymmdd_default" with the default driver
Creating 1v1-private-cloud-yyyymmdd_api_1 ... done

Dockerが起動していることを確認します。

$ sudo ./docker-compose ps

結果は以下のとおりです。

         Name                    Command             State               Ports
---------------------------------------------------------------------------------------
1v1-private-cloud_api_1   ./entrypoint.sh start   Up (healthy)   0.0.0.0:3000->3000/tcp

ここまででサービスは展開されています。

4.3.5 Ruby-Cloud-APIサービス開始を確認

以下の命令で、ヘルスチェックを実施してください。

$ curl 127.0.0.1:3000/healthcheck

正常に展開された場合、実行結果の例は以下のとおりです（サービスが正常に開始したことを示しています）。

{"code":1000,"status":"ok"}

Q1.展開先マシンのバージョンが古く、命令セットが低レベル（または対応する命令セットに AVX 命令セットが含まれていない）な状態です。ログを取得し確認するために、”tail -f tmp/worker.log.0” コマンドを実行したところ、ログ内に "SIGILL: illegal instruction” と出てきてしまいました。この問題の解決方法を教えてください。

A1. まず、マシンで対応している命令セットを確認します。

1. cat /proc/cpuinfo コマンドを実行します。

2. フラグを確認します。

AVXとAVX2の組み合わせが含まれていない場合、CPU命令セットがAVX命令セットをサポートしていないことを示します。

この場合、解決方法は2通りあります。

1) AVX 命令セットが含まれるマシンに変更します。

2) 現在のマシンで、強制的にSSE 命令セットが使用されるようにします。ただしサービスの性能は低下するため、処理スピードは半減します。

強制的にSSE命令セットを使用できるようにするには、go-workersのenvファイルを開き、FORCE_SET_SSE=falseをFORCE_SET_SSE=trueに変更します。変更後、保存してから、go-workers サービスを再起動します。

Q2. go-workersで./start.shを複数回実行するなど、展開中に開始コマンド (./start.sh) が繰り返し呼び出される場合、またはポートが使用されている場合、ログを確認すると次のエラーが発生していました。

listen: listen tcp :50050: bind: address already in use

A2. 1) 下記のコマンドを実行します。

$ ps aux | grep supervisord

2) ./tool/supervisord -c config/supervisor.conf -dに対応するプロセス番号を強制終了します。

$ kill -9 PID

Q3. ライセンスの使用に関するエラータイプのまとめ

A3. 弊社が提供する「プライベートクラウドパッケージ」には、デフォルトでライセンスが含まれていません。ライセンスの詳細な利用方法については、プライベートクラウドファイルのライセンスの使い方を参照してください。

1）panic: bad license: -1

ライセンスが壊れている（空のライセンスなど）ので、再度ライセンスファイルを差し替えてください。

2) panic: open fixture/license/senseid_ocr/senseid_ocr.lic: no such file or directory

ライセンスがインポートされていないので、指定したフォルダにライセンスファイルをインポートしてください。

3）panic: bad license: -16

udid mismatch と表示され、ライセンスにバインドされているハードウェアの指紋と現在のデバイスのハードウェアの指紋が一致していません。

デバイスのハードウェア情報が変更されていないことを確認してください。

デバイスのUUIDが変更されていることを確認したら、新しいライセンスを申請できる事業者に新しいUUIDを提供して、新しいライセンスを忘れずに交換してください。

Q4 error:-8 ？

4. 主にモデルファイルに関連したファイル形式が間違っていることを意味します。

例えばWindows用の解凍ソフトを使用して、「プライベートクラウドパッケージ」を解凍してサーバーにアップロードすると、モデルファイルの一部が破損する可能性があります。そのため、インストールパッケージをサーバに再アップロードし、コマンドラインで解凍することをお勧めします。

1.1 システムについて

SenseIDの利用環境には、Ubuntu Server 18.04 LTSを推奨します。ハードウェア側では、クアッドコアまたはそれ以上のCPU、8GM以上のRAM、100GB以上のディスク容量を推奨します。なお、CPU命令セットにAVXが必要です。

1.2 サービスについて

• Ruby-Cloud-API

  • クライアントから呼び出される主要なインターフェースを含む、HTTP サービス。

  • サービスポート：3000

• Go-Workers

  • バックエンドのコンピューティングサービス。主にアルゴリズムをカプセル化してあり、Ruby-Cloud-APIに対してHTTP形式で提供されます。

  • サービスポート：50050

2.1 UDIDとは

UDIDは、サーバーのハードウエア情報から算出したサーバーの識別コードです。SenseIDのアクティベーションは、UDIDに紐づける形で実行されます。SenseIDの認証を申請する前にUDID取得ツールをダウンロードし、指示に従ってUDIDを取得してください。

2.2 UDID取得ツール

デプロイターゲットのサーバーの UDIDを取得します。

UDID取得ツールのファイル名称は、SenseIDPrivateCloud-UDIDGetter-V4.1.0.zipです。

2.3 UDIDを取得

UDID取得ツールをサーバーに配置・解凍してください。

$ unzip SenseIDPrivateCloud-UDIDGetter-V4.1.0.zip

解凍したディレクトリへ移動し、UDIDGetter.shを実行してください。

$ cd /SenseIDPrivateCloud-UDIDGetter-V4.1.0
$ sudo ./UDIDGetter.sh

出力されたUDID.txtファイル、およびお客様の契約番号を、JCV製品提供窓口である、宛にご連絡ください。

本マニュアルでは、JCV顔認証サービス「SenseID」のインストール方法について説明します。導入を成功させるために、導入作業を開始する前には、当マニュアルをよくお読みください。

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

本マニュアルで記載されているインストールのプロセスについては、次の図で詳細に説明します。