Bitnami Redmine (Windows) 3.1.2→4.1.0の移行でハマった事

2019/12/20に1年ぶりのリリースとなるRedmine 4.1.0がリリースされました。

UIの改善や機能追加が多くかなり良さそうな印象を受けたので、長らくアップデートしていなかった3.1.2から4.1.0への移行の検証を行う事にしました。

Redmine 4.1.0 リリース - Redmine.JP -

mysql -u root -p<password> bitnami_redmine < <移行するデータベースのパス>
cd apps\redmine\htdocs
bundle exec rake db:migrate RAILS_ENV=production

エラーメッセージ

Mysql2::Error: Incorrect datetime value: '0000-00-00 00:00:00' for column 'closed_on' at row 281: ALTER TABLE `issues` CHANGE `description` `description` longtext DEFAULT NULL

5.7.8以降はsql_modeのデフォルト値が以下のようになっており、00:00:00 0000-00-00を許さないのがエラーの原因のようです。

mysql -u root -p<password> bitnami_redmine

mysql>SELECT @@GLOBAL.sql_mode;
+-------------------------------------------------------------------------------------------------------------------------------------------+
| @@GLOBAL.sql_mode                                                                                                                         |
+-------------------------------------------------------------------------------------------------------------------------------------------+
| ONLY_FULL_GROUP_BY,STRICT_TRANS_TABLES,NO_ZERO_IN_DATE,NO_ZERO_DATE,ERROR_FOR_DIVISION_BY_ZERO,NO_AUTO_CREATE_USER,NO_ENGINE_SUBSTITUTION |
+-------------------------------------------------------------------------------------------------------------------------------------------+
1 row in set (0.00 sec)

SET GLOBAL sql_mode='ONLY_FULL_GROUP_BY,STRICT_TRANS_TABLES,ERROR_FOR_DIVISION_BY_ZERO,NO_AUTO_CREATE_USER,NO_ENGINE_SUBSTITUTION';

Index name 'index_issues_on_parent_id' on table 'issues' already exists

ALTER TABLE issues DROP INDEX index_issues_on_parent_id;

本流の開発はストップして4.1に対応していませんでしたが、こちらもフォークして4.0-stable(Rails 5.2.2)に対応してくれてる方がいました。

https://github.com/southbridgeio/redmine_knowledgebase

しかしこちらはそのままではマイグレーション時にエラーが発生します。

Cannot drop index 'index_taggings_on_tag_id': needed in a foreign key constraint: DROP INDEX `index_taggings_on_tag_id` ON `taggings`

これはデータベースにログインし、SQLで外部キー制約を無視するコマンドを入力する事でマイグレーションが通るようになりました。

SET FOREIGN_KEY_CHECKS=0;

※正規の方法では無いのでデータ移行後に過去のデータに破損が無いか、新規に記事が作成できるかなどを確認してください。

本来はRailsのマイグレーションの中で処理するべきとこちらの記事にもありますが、とりあえず通る事を確認するだけならこの方法でも良いのかも…

https://redmine.tokyo/issues/1085

4.1への移行の流れのまとめ

データベース移行でハマった事を踏まえて一連の流れとしてまとめます。

• 現行(移行元)のデータベースをバックアップ(パスワードはRedmineインストール時のもの)

mysqldump -u root -p<password> bitnami_redmine > <任意のバックアップファイル名>

• 移行先サーバーに4.1をインストール
• C:\Bitnami\redmine-4.1.0-8\manager-windows.exeで移行先サーバーのApacheとRedmineを停止し、MySQLのみ動く状態にする
• データベースにログイン

mysql -u root -p<password> bitnami_redmine

• データベースの作り直しと権限付与してログアウト

DROP DATABASE bitnami_redmine;
CREATE DATABASE bitnami_redmine;
GRANT all privileges on bitnami_redmine.* to bitnami@localhost identified by '<apps/redmine/htdocs/config/database.ymlに記載されてるbitnami_redmineのパスワード>';
flush privileges;
exit;

• バックアップした移行元データベースをインポート

mysql -u root -p<password> bitnami_redmine < <移行元のバックアップファイルのパス>

• 再度データベースにログイン

mysql -u root -p<password> bitnami_redmine

• sql_modeで000:00:00 0000-00-00エラーが発生しないようにする

SET GLOBAL sql_mode='ONLY_FULL_GROUP_BY,STRICT_TRANS_TABLES,ERROR_FOR_DIVISION_BY_ZERO,NO_AUTO_CREATE_USER,NO_ENGINE_SUBSTITUTION';

• インデックスを削除してデータベースからログアウト

ALTER TABLE issues DROP INDEX index_issues_on_parent_id;
exit;

• apps\redmine\htdocs\pluginsフォルダに4.1で動作するプラグインを保管する (knowledgebaseなど事前に対処必要なものは対処しておく)
• apps\redmine\htdocs\filesフォルダの中身(添付した画像やファイル等)を移行元から移行先へ丸ごとコピペ
• インストール・マイグレーション(※ruby/binを環境変数に登録してbundleのパスを通しておく)

bundle install --no-deployment
bundle exec rake db:migrate RAILS_ENV=production
bundle exec rake redmine:plugins:migrate RAILS_ENV=production

エラーが無ければOK。

MySQL、Apache、Redmineを再起動して移行完了。

社内サーバーの本番環境ではファイアウォールに注意！

Azureの仮想環境では上手く移行できましたが、いざ社内サーバーで環境構築した際にまたエラーが発生しました。

knowledgebaseプラグインのインストール時に発生したのですが、gitプロトコルが通らなくて依存パッケージがダウンロードできない…

みたいなエラーメッセージが出ていました。

gitプロトコルはTCPの9418番ポートで、社内のファイアウォールではブロックされていました。

gitプロトコルは高速な代わりにセキュアではない通信だそうです。

bundle config github.https true

上記のコマンドを実行する事でgitプロトコルからHTTPSに切り替える事ができ、インストール・マイグレーションには成功するのですが、何故かこのパターンだとThin_redmineが停止してしまうエラーが発生しました。

Thin_redmineのログを取る方法が見つからず、HTTPSを利用したインストールは諦めました。

knowledgebaseプラグインをアンインストールすれば正常動作するのですが、これを諦めたくなかった為ファイアウォールのgitプロトコルのポートを開放して再度インストールする事で正常にRedmineが動作するようになりました。

企業のサーバーで上手く環境構築ができない場合はファイアウォールの設定に注意しましょう！