Backlogエンタープライズ 2.1.0
アップグレードガイド

SSL証明書を用意

Backlogでは通信にHTTPSを使用します。Ver.1ですでにSSL通信を使用していた場合、この手順は不要です。
あらかじめ、サーバーに配置する

• SSL証明書
• 秘密鍵ファイル

をご用意ください。

AWS CLIをインストール

AWS CLIのインストーラーをダウンロード、インストールします。

curl "https://awscli.amazonaws.com/awscli-exe-linux-x86_64.zip" -o "awscliv2.zip"
unzip awscliv2.zip
sudo ./aws/install

AWS CLIのインストールに関する詳細は以下のAWS公式ガイドをご覧ください。
https://docs.aws.amazon.com/ja_jp/cli/latest/userguide/cli-chap-getting-started.html

Dockerをインストール

yumリポジトリを追加して、Dockerをインストールします。

sudo yum install -y yum-utils
sudo yum-config-manager \
    --add-repo \
    https://download.docker.com/linux/centos/docker-ce.repo
sudo yum install docker-ce docker-ce-cli containerd.io docker-buildx-plugin docker-compose-plugin

Dockerを自動起動するよう設定します。

sudo systemctl enable docker

Dockerを起動します。

sudo systemctl start docker

Docker Composeをインストールします。

sudo curl -L https://github.com/docker/compose/releases/download/v2.18.1/docker-compose-linux-x86_64 \
    -o /usr/local/bin/docker-compose
sudo chmod +x /usr/local/bin/docker-compose

Dockerのインストールに関する詳細は、詳しくは以下のサイトもご覧ください。

• LinuxでDockerを利用する場合
  • https://docs.docker.com/engine/install/
• Amazon Linux 2でDockerを利用する場合
  • https://docs.aws.amazon.com/ja_jp/AmazonECS/latest/developerguide/create-container-image.html#create-container-image-prerequisites

データベース（MySQL）を用意

Backlogのデータを保存するデータベース（MySQL）を使用します。Ver.1で使用しているデータベースをそのまま使える場合、この手順は不要です。
Amazon RDSなどのIaaSを利用したり、Backlogのインストール先と同じサーバーなど、任意のサーバーにインストールしたものを利用できます。
my.cnfには以下の設定を追加してください。

[mysqld]
max_allowed_packet = 16M
character-set-server=utf8mb4
sql_mode = "NO_ENGINE_SUBSTITUTION"

[mysql]
default-character-set=utf8mb4

[client]
default-character-set=utf8mb4

SMTPサーバーを用意

Backlogからメールを送信するためのSMTPサーバーを利用します。Ver.1で使用しているSMTPサーバーをそのまま使える場合、この手順は不要です。
SMTP認証なしでメールを送信できるSendmail、Postfixなど、Red Hat Enterprise LinuxやCentOSに標準でインストールされるSMTPサーバーが利用できます。

データベースを作成

データベースサーバーにBacklog用のデータベースとデータベースユーザーを作成してください。Ver.1で使用しているデータベースをそのまま使える場合、この手順は不要です。

データベース名、ユーザー名は任意の値を設定できます。

SSL証明書を配置

SSL証明書と秘密鍵をサーバー上の任意のディレクトリに配置します。

mkdir <任意のディレクトリ>
cp <SSL証明書> <任意のディレクトリ>/crt.pem
cp <秘密鍵> <任意のディレクトリ>/key.pem

Ver.1のデータをVer.2のサーバーにコピー

Ver.1と同じサーバーでVer.2へアップグレードする場合、本手順は不要です。Backlogをアップグレードに進んでください。

以下の手順でデータをコピーします。
Ver.1環境での作業

1. Backlogを停止
2. データをバックアップ

Ver.2環境での作業

1. バックアップデータを展開

Ver.1環境での作業

systemctl stop backlog.target

cd /opt/backlog/
tar cvfp data.tar.gz data

mysqldump -ubacklog -p --opt backlog > backlog-dump.sql

Ver.2環境での作業

Ver.1環境での作業で作成した圧縮ファイル、ダンプファイルをscpコマンド等でVer.2をインストールするサーバーへ転送してください。

mkdir -p /opt/backlog
tar xvfp data.tar.gz -C /opt/backlog

mysql -ubacklog -p backlog < backlog-dump.sql

Ver.1を停止

以下でVer.1を停止します。root権限で実行してください。

systemctl stop backlog.target

バックアップ

アップグレードする前に必ずデータベースをバックアップしてください。

アップグレードツールをダウンロード

アップグレードツールをダウンロードします。
エンタープライズ契約管理サイトに記載されたAWS_ACCESS_KEY_ID、AWS_SECRET_ACCESS_KEYを環境変数に設定してください。

export AWS_ACCESS_KEY_ID="XXXX"
export AWS_SECRET_ACCESS_KEY="XXXX"

Dockerにログインします。

aws ecr get-login-password --region ap-northeast-1 | \
    docker login --username AWS --password-stdin 019623933850.dkr.ecr.ap-northeast-1.amazonaws.com

次に、アップグレード先のディレクトリでアップグレードツールを起動します。
下記ではアップグレード先のディレクトリをbacklog-enterpriseとします。

アップグレード先のディレクトリとして/opt/backlogおよびそれ以下のディレクトリパスを指定しないでください。

mkdir backlog-enterprise
cd backlog-enterprise
docker run --rm -it -v $PWD:/work \
    019623933850.dkr.ecr.ap-northeast-1.amazonaws.com/enterprise-bootstrap:2.1.0 upgrade

Ver.1環境を検証

アップグレードの前に検証ツールを起動します。

cd upgrade-assistant

./advance-check.sh

10 database records will be truncated when the upgrade tool is run due to changes in the database table structure. Please see the red messages above for further details.

アップグレードツールを起動

Backlogをアップグレードします。アップグレードには数分かかる場合があります。

docker pull 019623933850.dkr.ecr.ap-northeast-1.amazonaws.com/enterprise-database-migration:2.1.0
docker pull 019623933850.dkr.ecr.ap-northeast-1.amazonaws.com/enterprise-password-migration-tool:2.1.0
docker pull 019623933850.dkr.ecr.ap-northeast-1.amazonaws.com/enterprise-git-rpc:2.1.0
sudo ./upgrade.sh

データベースにログインし、以下のSQLを実行します。

INSERT INTO project_setting (PROJECT_ID, PROJECT_LEADER_CAN_EDIT_PROJECT_LEADER,
 USE_WIKI, USE_FILE_SHARING, USE_WIKI_TREE_VIEW, USE_ORIGINAL_IMAGE_SIZE_AT_WIKI,
 USE_DEV_ATTRIBUTES, CREATED_USER_ID, CREATED, UPDATED_USER_ID, UPDATED)
  SELECT project.id, 0, 1, 1, 0, 0, 1, NULL, NOW(), NULL, NOW()
  FROM project
  LEFT JOIN project_setting ps ON ps.project_id = project.id
  WHERE ps.project_id IS NULL;

以上でBacklogのアップグレードは完了です。