バックアップからの TeamCity データの復元

復元前

バックアップされたデータは、 サポートされている任意のデータベースから、またはサポートされている任意のデータベースに、同じデータベースまたは別のデータベースに復元できます (たとえば、HSQL データベースから PostgreSQL データベースにデータを復元したり、PostgreSQL データベースのバックアップを新しい PostgreSQL データベースに復元したりできます)。

新しいバージョンの TeamCity を使用して、以前の任意の TeamCity バージョンで作成されたバックアップを復元できます (TeamCity バージョンが 6.0 より後の場合)。

大規模なデータベースの復元中に、大量のデータ変更をより速く行うためにデータベース固有の設定を構成することが必要な場合があります (SQL Server の「リカバリモデル」を「シンプル」に設定するなど)。 詳細については、DBA にお問い合わせください。

TeamCity の バックアップファイルビルドアーティファクトが含まれていません。 ビルドログとアーティファクトをバックアップするには、 アーティファクトディレクトリ (デフォルトでは <TeamCity データディレクトリ>/system/artifacts) の内容を古い場所から新しい場所に手動でコピーします。 システム/アーティファクト 配下のデータに関する一般的な互換性ルールでは、古い TeamCity バージョンで作成されたファイルは新しいバージョンで読み取れますが、その逆が必ずしも可能とは限りません。

外部アーティファクトストレージが有効化されている場合、TeamCity データディレクトリの アーティファクトディレクトリにはアーティファクトマッピングに関するメタデータが含まれるため、必ず復元されていることを確認してください。

TeamCity データディレクトリの説明にあるディレクトリの詳細も参照してください。

バックアップから復元されたサーバーの起動時にビルドメタデータの再インデックスが自動的に開始されるため、 サーバーの起動前にアーティファクトをコピーする することが重要です。 インデックス作成中に一部のアーティファクトが欠落していると、TeamCity サーバーの一部で障害が発生する可能性があります (例: NuGet フィード)。 サーバーの起動後にアーティファクトをコピーした場合 (またはサーバーの起動前にアーティファクトのコピーが完了していない場合)、 ビルドメタデータを手動で再インデックスし、再インデックスが完了するまで待つ必要がある場合があります。

復元の実行

TeamCity は、バックアップされたデータを 新しい TeamCity インストールに自動的に復元できます (たとえば、既存サーバーのコピーを作成する場合)。 このプロセスは maintainDB ユーティリティに依存しますが、必要なすべての操作を内部で実行します。

1. ブラウザーで TeamCity URL (デフォルトでは、 http://localhost/ は exe インストール用、 http://localhost:8111/ は TAR.GZ 用) を開きます。

2. TeamCity の初回起動ページで、 データディレクトリへのパスを入力し、 バックアップから復元 をクリックします。

3. TeamCity サーバー上のバックアップディレクトリへの絶対パスを入力するか、バックアップされたデータを含む ZIP アーカイブをアップロードします。

4. ターゲットデータベースを選択します。 外部データベースを使用する場合、そのアドレスと資格情報を構成します。

5. 修復を続行します。

TeamCity はデータを復元し、 maintainDB ユーティリティログを表示します。 バックアップされたデータフォーマットのバージョンが現在のものより古い場合、TeamCity はアップグレードを提案します。

バックアップされたファイルを 既存の TeamCity インストールに復元する場合、または自動復元の制限を回避する場合は、 maintainDB ユーティリティを手動で使用します。 このセクションでは、 maintainDB オプションの 一部のみ 説明します。 使用可能なすべてのオプションの完全なリストについては、コマンドラインからパラメーターなしで maintainDB を実行してください。 maintainDB 起動オプションも参照してください。

maintainDB を介してバックアップファイルから復元を実行するには:

1. TAR.GZ または .exe インストールパッケージから TeamCity サーバーをインストールします。 TeamCity サーバーを起動しないでください。

2. 新しい空の TeamCity データディレクトリを作成します。

3. 次のオプションのいずれかを選択します。

   • バックアップを 新しい外部データベース に復元するには、 空のデータベースを作成して構成し、 database.properties ファイルを、後で 復元 コマンドに渡すデータベース設定で構成し、それを /設定 サブディレクトリ (新しく作成した TeamCity データディレクトリ 内) または TeamCity データディレクトリ外のファイルシステム上の任意の場所に配置します。

   • バックアップの作成元と同じデータベース にデータを復元するには、次の手順に進みます。

4. 必要な データベースドライバーを ライブラリ/JDBC サブディレクトリ、つまり新しく作成した TeamCity Data Directory ディレクトリ内のサブディレクトリに配置します。

5. <TeamCity ホーム>/バイナリ ディレクトリにある maintainDB ユーティリティを使用して、 復元 コマンドを実行します。

   a. バックアップを 新しい外部データベース に復元するには

   • database.properties ファイルが TeamCity データディレクトリ内にある場合：

   maintainDB.[cmd|sh] restore -A <absolute path to the newly created TeamCity Data Directory> -F <path to the TeamCity backup file> -T <config/database.properties>

   • database.properties ファイルが TeamCity データディレクトリ外にある場合：

   maintainDB.[cmd|sh] restore -A <absolute path to the newly created TeamCity Data Directory> -F <path to the TeamCity backup file> -T <absolute path to the database.properties file of the target database on the file system outside data dir>

   b。 データを バックアップの作成元と同じデータベース に復元するには：

   maintainDB.[cmd|sh] restore -A <absolute path to the newly created TeamCity Data Directory> -F <path to the TeamCity backup file>

   c. バックアップを 内部データベース に復元するには:

   maintainDB.[cmd|sh] restore -A <absolute path to the newly created TeamCity Data Directory> -I -F <path to the TeamCity backup file>

6. プロセスが正常に完了した場合、 復元を完了する には、古いディレクトリから <TeamCity データディレクトリ>/system/artifacts を コピー 必要があります。 ディレクトリにはビルドアーティファクトが保存されますが、それらはバックアップファイルには含まれません。

復元 コマンドオプションに関する注意:

• TEAMCITY_DATA_PATH 環境変数が設定されている場合、 -A 引数は省略できます。

• -F 引数は絶対パスまたは <TeamCity データディレクトリ>/system/backup ディレクトリへの相対パスにすることができます。

• -T 引数は、手順 3 で作成された database.properties ファイルを指している必要があります。

• -T 引数が指定されておらず、新しく作成された <TeamCity データディレクトリ>/config およびバックアップファイルに database.properties ファイルが存在する場合、データベースは <TeamCity データディレクトリ>/config のプロパティファイルを使用して復元されます。

• デフォルトでは、 -F 以外のオプションが指定されていない場合、バックアップされたすべてのスコープがバックアップファイルから復元されます。 バックアップファイルから特定のスコープのみを復元するには、 maintainDB ユーティリティの対応するオプション -D、 -C、 -U、 -L、 -P を使用します。

データベースのみの復元

データベースを復元しつつ、より新しい TeamCity データディレクトリを保持する場合は、データの一貫性を確認することが重要です：

• データベースに保存されているデータと一貫性を保つために、 <TeamCity データディレクトリ>/system/pluginData (補足データ) も復元する必要があります。

• サーバーの起動前に <TeamCity データディレクトリ>/system/caches をクリアする必要があります。

TeamCity データベースを既存のサーバーに復元する前に、TeamCity サーバーが実行されていないことを確認してください。

TeamCity データベースのみをバックアップファイルから既存のサーバーに復元するには：

1. データベースを作成して構成する、 database.properties ファイルを TeamCity データディレクトリ の 設定 サブディレクトリに配置します。

2. 必要なデータベースドライバが /ライブラリ/JDBC サブディレクトリに存在することを確認してください。

3. maintainDB ユーティリティを使用します。このユーティリティは <TeamCity データディレクトリ>/バイナリ ディレクトリにあります (TeamCity .tar.gz および .exe ディストリビューションでのみ使用可能)。

4. バックアップに 追加データが存在する場合は、 <TeamCity データディレクトリ>/system/pluginData ディレクトリの内容を削除します (最初に別の場所にバックアップすることを検討してください)。

5. 復元 コマンドを使用します（-T 引数は、ステップ 1 で作成された database.properties ファイルを指している必要があります）。

   maintainDB.[cmd|sh] restore -A <absolute path to TeamCity Data Directory> -F <path to the TeamCity backup file> -T <path to the database.properties file of the target database> -D

6. maintainDB ユーティリティコンソールの出力を参照してください。 要求された場合は、 database.properties ファイルを手動でコピーする必要があります。

7. <TeamCity データディレクトリ>/system/caches ディレクトリの内容を削除します。

中断後の復元の再開

次の理由により、復元が中断される場合があります。

• ファイルシステムまたはデータベースのスペース不足

• ファイルシステムまたはデータベースに対する権限が不十分です

この中断は、テーブルまたはインデックスのいずれかの復元に失敗した場合に発生し、 maintainDB ユーティリティのコンソール出力に示されます。
復元を再開する前に 、正しく復元されなかったオブジェクトをデータベースから手動で削除します。

中断後にバックアップの復元を再開するには:
必要なオプションと --続行 オプションを指定した 復元 コマンドを使用して、 maintainDB ユーティリティを実行します。