プログラマーのメモ書き

伊勢在住のプログラマーが気になることを気ままにメモったブログです

QNAP Container Station で動かしている docker 版 Pleasanter のアップデート（1.4.13 -> 1.4.17）

Pleasanter docker

QNAP NAS で利用できる docker (Container Station) 上で、 docker 版の Pleasanter をあれこれ試しています。

いま動いている Pleasanter のコンテナは書籍『入門プリザンター』

入門プリザンター

入門プリザンター

Amazon

が出たときに作ったものがベースのため、バージョン 1.4.13 になっています。

少し前に出たバージョン 1.4.15 で GUI 操作で画面項目を作ることができるなど、なかなか面白そうな機能が追加されていたりします。あと、うれしいことに Pleasanter も結構バージョンアップしているので、若干今の環境が古くなりつつあります。

ということから、思い切って docker 版 Pleasanter のバージョンアップを行ってみたので、その時の作業をメモっておきます。

  • QNAP NAS TS-262, QTS 5.2.4.3079
  • Container Station 3.0.9.1038
  • バージョンアップ前 Pleasanter 1.4.13.0
  • バージョンアップ後 Pleasanter 1.4.17.0

公式の手順の確認

Pleasanter のページには、 docker 版の Pleasanter のバージョンアップ手順も載っているので確認しておきます。

Dockerイメージのプリザンターをバージョンアップする | Pleasanter

なるほど。それほど難しくはなさそうです。

ただ、手元の環境は QNAP の Container Station の docker を利用していることもあり、公式の手順とはちょっと異なる構成になってしまってます。 なので、上記の公式の手順を参考にして、自分の環境でバージョンアップを行ってみます。

Contaienr Station でのバージョンアップ手順

下記の手順でバージョンアップしました。

  1. プリザンターの停止
  2. パラメータファイルの更新
  3. docker-compose.yml の更新
  4. pleasanter アプリケーションの再作成
  5. ファイルのコピー
  6. CodeDefiner イメージの更新と実行
  7. Pleasanter の実行

以下では、実際に試して時の詳細を書いておきます。

プリザンターの停止

これは Container Station から操作します。

pleasanter のアプリケーションを選択して、歯車のアイコンから『停止』を選択すれば完了です。

パラメータファイルの更新

公式の手順『3.パラメータファイルの更新』に書いていることと同等のことを行います。

GitHub のリリースのページから、アップデートしたいバージョンの zip ファイルをダウンロードします。ただ、Docker Hub の Pleasanter を利用する関係で、そちらで公開されているバージョンと同じバージョンを選んでおいた方が無難かと思います。今回の場合だと、 Github ではすでに 1.4.17.1 がリリースされていたのですが、 Docker hub は 1.14.7.0 までだったので、 1.4.17.0 をダウンロードしました。

ファイルを解凍して、

Pleasanter_1.4.17.0\pleasanter\Implem.Pleasanter\App_Data\Parameters

にあるファイルのうち、利用しているパラメータファイルのみをコピーします。

いまの環境なら、

  • BackgroundService.json
  • Mail.json
  • Service.json

の３ファイルです。

次に、コピーした上記３ファイルに、既存ファイルの内容を反映します。

実際には、変更している設定ファイルは git で管理しているので、 git の管理フォルダに先ほどのファイルをコピーして、変更行を見比べながら自分の設定を書き戻すような作業になると思います。

たとえば、 BackgroundService.json というファイルを 1.4.17.0 のフォルダから git 管理化のフォルダにコピーすると

に示すように、 Reminder の行が変更としてマークされています。これは、リマインダー機能を有効にしているので、設定値が true だったのがダウンロードしたファイルの値 false になっているためです。

自分用の設定を反映すると

こんな感じになりました。なお、緑でマークされている行は、バージョンアップに伴い追加された行のようなのでこのままとしておきます。また、ファイルの最後の削除マークは空行の変更なので、これもこのままとします。

この作業を変更している設定ファイルすべてに対して行っておきます。

docker-compose.yml の更新

docker-compose.yml ファイルの pleasanter のバージョンを新しいものに変更しておきます。

（略）
  pleasanter:
    container_name: pleasanter
    image: implem/pleasanter:1.4.17.0
（略）

codedefiner 用の docker-compose.codedefiner.yml のほうは特に変更は加えません。

ここまでで準備完了ですね。

pleasanter アプリケーションの再作成

さて、 ContainerStation の docker を使っている場合、 docker-compose.yml を更新するためには、一度再作成を行う必要があります（こちらの https-portal を別アプリケーションに分離したときと同じですね）。

ちなみに、 ContainerStation からの再作成では、必要な環境変数やファイルがないので、コンテナの起動に失敗します。

こんな感じで、 postgres コンテナはありますが、 pleasanter のコンテナはありません。

ファイルのコピー

pleasanter のアプリケーションを再作成するとアプリケーションフォルダごと作り直すため、既存のファイルは一度消えてしまいます。ということで、次は pleasanter のアプリケーションフォルダに必要なファイルをコピーしてやります。

  • .env
  • BackgroundService.json
  • Mail.json
  • Service.json
  • docker-compose.codedefiner.yml

今回の場合は上記のものになります。

CodeDefiner イメージの更新と実行

ここで、今まで通り CodeDefiner を実行すればいいと思いきや、実はこのままだと CodeDefiner が古いバージョンで実行されてしまいます。というのも、 docker-compose.codedefiner.yml を見るとわかるのですが、 codedefiner のタグにはバージョンが含まれていません。

  codedefiner:
    container_name: codedefiner
    image: implem/pleasanter:codedefiner

試しにこのまま CodeDefienr を実行すると

[ユーザー名@NAS名 pleasanter-test]$ docker compose -f docker-compose.yml -f docker-compose.codedefiner.yml run --rm codedefiner
[+] Creating 1/1
 ✔ Container postgres  Recreated
[+] Running 1/1
 ✔ Container postgres  Started
<INFO> Starter.Main: Implem.CodeDefiner 1.4.13.0
<INFO> RdsConfigurator.UpdateDatabase: Implem.Pleasanter
（略）

のように、 1.4.13 時点のものが実行されます。

でも、 docker hub を見ると、 codedefiner も更新されているのがわかります。

なので、一度 CodeDefiner のイメージを手作業で更新して置く必要があります。

[ユーザー名@NAS名 pleasanter-test]$ docker pull implem/pleasanter:codedefiner

更新前は、

[ユーザー名@NAS名 pleasanter-test]$ docker image ls
REPOSITORY                  TAG                         IMAGE ID       CREATED         SIZE
implem/pleasanter           1.4.17.0                    ecbfb1d0232a   11 days ago     605MB
（略）
implem/pleasanter           codedefiner                 7151e0efaf45   4 months ago    420MB
implem/pleasanter           1.4.13.0                    e2d1ea89cd77   4 months ago    465MB
（略）

とあったものが、更新後は

[ユーザー名@NAS名 pleasanter-test]$ docker image ls
REPOSITORY                  TAG                         IMAGE ID       CREATED         SIZE
implem/pleasanter           codedefiner                 d6311b9e7457   11 days ago     561MB
implem/pleasanter           1.4.17.0                    ecbfb1d0232a   11 days ago     605MB
（略）

のように更新されていることがわかります（CREATED の日付が違いますよね）。

ここまでできたら、あとはいつもと同じです。

[ユーザー名@NAS名 pleasanter-test]$ docker compose -f docker-compose.yml -f docker-compose.codedefiner.yml run --rm codedefiner
[+] Creating 1/0
 ✔ Container postgres  Running
<INFO> Starter.Main: Implem.CodeDefiner 1.4.17.0
<INFO> RdsConfigurator.UpdateDatabase: Implem.Pleasanter
（略）

CodeDefiner も 1.4.17.0 版で動作していることがわかります。

Pleasanter の実行

ここまでできたら、最後は、

[ユーザー名@NAS名 pleasanter-test]$ docker compose up -d pleasanter
[+] Running 2/2
 ✔ Container postgres    Running
 ✔ Container pleasanter  Started
[ユーザー名@NAS名 pleasanter-test]$

として、 pleasanter のコンテナを起動します。

動作確認

無事に起動したのを確認したら、 Pleasanter にログインして、ヘルプのバージョン情報を表示させると、

となっています。問題なさそうですね。

まとめ

一度手順がわかってしまうと、バージョンアップもさほど難しくないことがよくわかります。さて、これで最新版を試してみようと思います。