インストール(Linux版)¶
このページではCSA Data Uploader(以下、"Data Uploader")のLinux環境におけるインストール手順について解説します。
対応OS・環境¶
- 64bit(x86_64)のLinux OSに対応しています。
- 動作確認については『Amazon Linux 2023』で確認済、推奨も『Amazon Linux 2023』となります。
なお、利用する地域のタイムゾーンとOSのタイムゾーンは一致させてください。(日本で利用する場合はOSのタイムゾーン設定も同様に合わせてください)
$ date
2020年 12月 xx日 *曜日 xx:xx:xx UTC
$ sudo vi /etc/sysconfig/clock
----
ZONE="Asia/Tokyo"
UTC=true
----
$ sudo ln -sf /usr/share/zoneinfo/Asia/Tokyo /etc/localtime
$ sudo reboot
$ date
2020年 12月 xx日 *曜日 xx:xx:xx JST
インストール手順¶
対象の環境にて、予めunixODBCをインストールしておきます。
$ yum install -y unixODBC-devel
Linux版インストーラファイルを含むアーカイブファイルを対象サーバに配置し、/usr/local 配下に解凍。
$ sudo tar -axvf csa_du-v1.7.0-linux_x64.tar.gz -C /usr/local
csa_du/
csa_du/README.txt
csa_du/user_config.toml
csa_du/bin/
csa_du/bin/csa_du
実行ファイルをPATHに設定追記。以上で初期設定は完了です。
$ echo 'PATH=$PATH:/usr/local/csa_du/bin' >> ~/.bash_profile
$ source ~/.bash_profile
$ which csa_du
/usr/local/csa_du/bin/csa_du
入出力データソースの利用に関する設定について¶
Data UploaderのWebサーバを起動させるための最低限の設定については上記の内容に従う形となりますが、入力・出力で各種データソースを扱う際は(データソースに応じて)各種連携設定が必要となります。
入力データソースに関する設定¶
- GCP:Google Cloud Storage:利用するためのGCP環境設定が必要です。(※GCP利用設定を参照)
出力データソースに関する設定¶
- Amazon S3:AWS CLI利用に関するアクセスキー設定を所定の手順に従って行ってください。(※ AWS CLI設定を参照)
起動・停止について¶
利用ポート番号¶
Linux版のCSA Data Uploaderはデフォルト設定で80番ポートを利用します。この設定を用いる場合、実行プログラム(csa_du)に特権ポート(80番)の利用を許可するコマンドを実行してください。
$ sudo setcap 'cap_net_bind_service=+ep' /usr/local/csa_du/bin/csa_du
また、80番以外のポートを利用する場合、環境変数CSA_DU_PORT_NUMBERに利用するポート番号を設定してください。
$ export CSA_DU_PORT_NUMBER=8080
フォアグラウンド・バックグラウンド実行¶
CSA Data Uploaderでは実行形式としてフォアグラウンド・バックグラウンド双方を選択可能です。
フォアグラウンド実行の場合はそのまま実行プログラム(csa_du)を実行してください。停止する場合はキャンセルコマンドをリクエストしてください。
$ csa_du
2020/xx/xx xx:xx:xx Running in terminal.
I: xx:xx:xx Running in terminal.
⇨ http server started on [::]:8080
^C2020/xx/xx xx:xx:xx Stop request
I: xx:xx:xx Stop request
2020/xx/xx xx:xx:xx Stopping..
I: xx:xx:xx Stopping..
2020/xx/xx xx:xx:xx Done..
I: xx:xx:xx Done..
バックグラウンド実行の場合、以下のコマンドでサービスとしてインストールしてください。
$ sudo /usr/local/csa_du/bin/csa_du webserver --service install
install に成功しました
アプリケーション起動のために、上記インストール作業で生成された設定ファイルに一部修正を加えます。
rootユーザにユーザー変更した上で、/etc/systemd/system/csa_data_uploader.service
ファイルの[Service]項目配下に Environment=HOME=/root
の行を追加します。
[Unit]
Description=Classmethod CS Analytics Data Uploader Application
ConditionFileIsExecutable=/usr/local/csa_du/bin/csa_du
[Service]
StartLimitInterval=5
StartLimitBurst=10
ExecStart=/usr/local/csa_du/bin/csa_du
Environment=HOME=/root
Restart=always
RestartSec=120
EnvironmentFile=-/etc/sysconfig/csa_data_uploader
[Install]
WantedBy=multi-user.target
sudo systemctl daemon-reload
コマンド実行で設定のリロードを行った後は、サービスの運用(起動・停止)が可能となります。
$ sudo systemctl daemon-reload
$ sudo /usr/local/csa_du/bin/csa_du webserver --service start
start に成功しました
$ sudo /usr/local/csa_du/bin/csa_du webserver --service stop
stop に成功しました
Data Uploderの起動を確認出来れば、以降の作業(ブラウザアクセス及び初期設定・機能利用)についてははWindows版と同様です。
Note
ブラウザアクセスの際は、対象Linux環境へのアクセス制限(セキュリティグループ設定など)
を踏まえた形で行ってください。
Note
logファイルやdbファイルは、「$HOME/csa_du」配下に作成されます。
環境のアップグレードについて¶
Data Uploaderの環境をバージョンアップグレードする場合は、対象インストーラのアーカイブを解凍し、実行プログラム(csa_du)のみを差し替えてください。
1. (バックアップが必要な場合)Data Uploaderのフォルダ(/usr/local/csa_du)ごとバックアップ
2. Data Uploaderを停止(※)
3. 実行プログラム(csa_du)を上書き
4. Data Uploaderを起動(※)
※起動・停止については上記「起動・停止について」を参照
Note
※csa_du以外のファイル(storage.dbなど)はアプリケーションで管理しているデータを扱っているものとなりますので削除・上書きなどはしないようにお願いします。