VM サーバのアップデート手順

本ページでは、VMサーバをバージョンアップする手順についてご説明します。

アップデートを実行する

本手順は、バージョン 3.0.0以降にアップデートする際に利用できる手順となります。
バージョン 3.0.0 未満へのアップデートでは、オンラインアップデートをご利用ください。

アップデートでは、以下のURLのサイトからファイルをダウンロードする必要があります。
対象ホストで直接ファイルのダウンロードができない場合は、別のホストでダウンロードして、対象ホストへの転送をお願いします。
https://www.softek.co.jp/

本手順ではdockerを想定しております。
docker以外で、podman等のdocker互換のインタフェースを持つコンテナサービスでは、vm_update.shスクリプトの以下の行で、dockerコマンドの代替になるコマンドを指定することで動作する可能性があります。

# docker command

docker="sudo docker"

なお、docker以外については動作確認をしておりませんので、自己責任においてご対応下さいますよう宜しくお願い致します。
docker互換のコマンドラインインタフェースを持たないコンテナサービスをご利用の場合は、vm_update.shスクリプトの内容を確認し、相当する操作を実施下さい。

アップデートを実行する

アップデートを実行します。
作業を実施する前に、一通り内容をご確認頂いた上で作業を実施下さいますようお願い致します。
また、バックアップ等、ストレージ容量を消費する操作が多いため、作業前に十分な空き容量があることを確認し、作業中も空き容量を確認しながら作業を進めることを推奨します。
手順の中で不明な点がある場合や、手順の途中でエラーが発生した場合は、ヘルプデスクへ、エラーメッセージ等の具体的な内容を合わせてお問い合わせ下さいますよう宜しくお願い致します。<

必要があれば、データベースのバックアップを行います。
本手順では、既に利用いただいているデータベースをそのまま利用する形でアップデートを行いますが、必要があれば事前にデータベースのバージョンアップを実施下さい。
データベースバックアップ手順（Red Hat Enterprise Linuxにデータベースを作成する）
データベースバックアップ手順（Ubuntu にデータベースを作成する）
なお、Amazon RDS等のクラウドデータベースを利用している場合は、利用しているシステムのマニュアルをご参照ください。
利用されているバージョンを確認します。
現在利用されているSIDfm VMサーバのバージョンをご確認ください。
SIDfm VMサーバのバージョンは、以下の箇所から確認可能です。

ログイン後画面のフッタの「SIDfm VM」に設定されているツールチップ

ライセンス設定画面の「SIDfm VMバージョン」
ダウンロードページから、SIDfm VMサーバのdockerイメージをダウンロードします。

ソフトウェアダウンロードページで、契約約款、使用許諾契約のチェックを入れて「ダウンロードページ」ボタンを押下します。

ソフトウェアダウンロード（VMサーバ）ページで、dockerイメージのソフトウェアとsha256sumのファイルをダウンロードして、SIDfm VMサーバがインストールされているホストにファイルを転送します。

ダウンロードするバージョンは、先の手順で確認した利用バージョンより新しいものを選択下さい。バージョンダウンについては、正常に動作しない可能性があります。
SIDfm VMサーバをインストールしたホストにログインします。
sudoコマンドが正常に利用できるか、dockerサービスが正常に動作しているかを確認します。
「sudo docker images」を実行し、エラーにならず実行ができることをご確認ください。
sudoコマンドを実行した際に、ログイン中のユーザのパスワード入力を求められる場合がありますので、その場合はパスワード入力を行ってください。
なお以下は実行例です。
```
$ sudo docker images
```
```
REPOSITORY    TAG                 IMAGE ID       CREATED         SIZE
```
```
sidfmd        2.9.3               932efed33653   2 weeks ago     1.39GB
```
```
sidfmd        latest              fee001ecde8c   5 weeks ago     1.36GB
```
以降の操作ではsudoコマンドが正常に利用できることを前提としております。
もし利用できない場合は、suコマンドでrootユーザになり、操作を行ってください。
アップデート用のスクリプトをダウンロードして設置します。
```
$ cd /var/lib/sidfm/sidfmvm
```
```
$ sudo curl -OL https://www.softek.co.jp/SID/support/sidfmvm/download/server/vm_update.sh.gz
```
```
$ sudo curl -OL https://www.softek.co.jp/SID/support/sidfmvm/download/server/sha256sum-vm_update.sh.gz
```
```
$ sha256sum -c sha256sum-vm_update.sh.gz
```
```
vm_update.sh.gz: OK
```
```
$ sudo rm -f vm_update.sh
```
```
$ sudo gzip -d vm_update.sh.gz
```
なお、上記の手順ではユーザガイドのインストール手順通りにSIDfm VMサーバをインストールしており/var/lib/sidfmディレクトリが存在すること、SIDfm VMサーバからダウンロードURLに直接アクセス可能なことを想定しております。

/var/lib/sidfmディレクトリが存在しない場合は、以下のコマンドを実行し、予めディレクトリを作成した上で手順を実行下さい。
```
$ sudo mkdir -p /var/lib/sidfm/sidfmvm
```
SIDfm VMサーバからダウンロードURLに直接アクセス可能でない場合は、別ホストで以下のURLからファイルをダウンロードし、ダウンロードしたファイルをSIDfm VMサーバをインストールしたホストの/var/lib/sidfm/sidfmvmディレクトリに転送した上で、手順を実行下さい。
https://www.softek.co.jp/SID/support/sidfmvm/download/server/vm_update.sh.gz
https://www.softek.co.jp/SID/support/sidfmvm/download/server/sha256sum-vm_update.sh.gz

SIDfm VMサーバを停止します。

$ sudo docker exec sidfmd /vm_manage issue_update disable

$ sudo docker exec sidfmd /vm_manage server disable

SIDfm VMサーバの設定を保存します。以下の実行例では/var/lib/sidfm/vmconfbkup.tar.gzとして保存されます。

$ cd /var/lib/sidfm

$ sudo bash /var/lib/sidfm/sidfmvm/vm_update.sh backup_conf vmconfbkup

success: backup configurations to vmconfbkup.tar.gz

$ ls -l vmconfbkup.tar.gz

-rw-r--r-- 1 root root 23587 Aug  8 14:37 vmconfbkup.tar.gz

SIDfm VMサーバのログファイルを保存します。以下の実行例では/var/lib/sidfm/vmlogbkup.tar.gzとして保存されます。
```
$ cd /var/lib/sidfm
```
```
$ sudo bash /var/lib/sidfm/sidfmvm/vm_update.sh backup_log vmlogbkup
```
```
success: backup log to vmlogbkup.tar.gz
```
```
$ ls -l vmlogbkup.tar.gz
```
```
-rw-r--r-- 1 root root 146021123 Aug  8 14:49 vmlogbkup.tar.gz
```
なお、ログファイルについては、アップデート後の環境には反映しませんので、別途保存して頂きますようお願いします。
SIDfm VMサーバのコンテナの内容をイメージに反映します。
```
$ sudo docker commit sidfmd sidfmd
```
SIDfm VMサーバのコンテナの停止と削除を行います。
```
$ sudo docker stop sidfmd
```
```
$ sudo docker rm sidfmd
```
アップデート前のSIDfm VMサーバのイメージをバックアップし、sidfmd:latestのイメージ名を解放します。
ここではsidfmd:backupという名前のイメージにバックアップを作成します。もし既にsidfmd:backupという名前のイメージが存在する場合、必要が無ければ削除し、必要があれば別の名前で作成をお願いします。
```
$ sudo docker tag sidfmd:latest sidfmd:backup
```
```
$ sudo docker rmi sidfmd:latest
```
古いバージョンのSIDfm VMサーバのイメージを削除します。
古いバージョンのSIDfm VMサーバのイメージが存在している場合は、ストレージ容量を解放するため、削除することをお勧めします。
以下はイメージ一覧の例です。
```
$ sudo docker images
```
```
REPOSITORY    TAG                 IMAGE ID       CREATED         SIZE
```
```
sidfmd        2.9.1               3340d169aa73   2 weeks ago     1.39GB
```
```
sidfmd        2.9.3               932efed33653   2 weeks ago     1.39GB
```
```
sidfmd        backup              fee001ecde8c   5 weeks ago     1.36GB
```
```
sidfmd        latest              fee001ecde8c   5 weeks ago     1.36GB
```
この場合、sidfmd:backupはバックアップ、sidfmd:latestは現在稼働中のSIDfm VMサーバのイメージで削除できませんが、sidfmd:2.9.1, sidfmd:2.9.3はインストール時に使用したイメージであり、削除可能です。
sidfmd:2.9.1を削除する際には以下のように実行します。
```
$ sudo docker rmi sidfmd:2.9.1
```
アップデートする新しいバージョンのSIDfm VMサーバのイメージを読み込みます。
手順3.でダウンロードした新しいバージョンのdockerイメージを読み込みます。
以下ではダウンロードしたdockerイメージファイルを sidfmvm-image-3.0.0.tar.gz として記載します。バージョンの部分（ここでは「3.0.0」）につきましては、実際にアップデートを行うバージョン文字列を記載してください。
```
$ gzip -dc sidfmvm-image-3.0.0.tar.gz | sudo docker load
```
```
$ sudo docker tag sidfmd:3.0.0 sidfmd:latest
```
新しいバージョンのSIDfm VMサーバのコンテナを起動します。
```
$ sudo bash /var/lib/sidfm/sidfmvm/sidfmd-start.sh
```

SIDfm VMサーバの設定を復元します。
手順8.で保存したSIDfm VMサーバの設定を新しいコンテナに復元します。

$ cd /var/lib/sidfm

$ sudo bash /var/lib/sidfm/sidfmvm/vm_update.sh restore_conf vmconfbkup

success: restore configuration from vmconfbkup.tar.gz

新しいバージョン用にデータベースを更新します。

$ sudo bash /var/lib/sidfm/sidfmvm/vm_update.sh db_update

success: db update

SIDfm VMサーバを起動します。

$ sudo docker exec sidfmd /vm_manage server enable

$ sudo docker exec sidfmd /vm_manage issue_update enable

SIDfm VMサーバのWebUIからログインし、バージョンアップが行われていること、動作に問題が無いことを確認します。
動作に問題がなければ、設定済のコンテナをイメージに反映します。
```
$ sudo docker commit sidfmd sidfmd
```
以上でアップデート作業は完了です。
dockerサービスと同時にSIDfm VMサーバのコンテナを起動したい場合は以下をご参照ください。
アップデート前に設定を行っていた場合でも、アップデート手順でコンテナを作成しなおしたため、再度設定が必要です。
VMサーバの自動起動設定