アーティファクト移行ツール

アーティファクト移行ツールをダウンロードする

このツールはプロジェクト設定 | アーティファクトストレージページからダウンロードできます。

このツールは、TeamCity サーバーがインストールされているのと同じマシン上にある必要があることに注意してください。

構成ファイル

アーティファクト移行ツールを実行する前に、config/application.properties ファイルで次の設定を指定する必要があります。

• teamcity.storage.migration.host — TeamCity サーバーのアドレス (プロトコル、ホスト、ポート)。

• teamcity.storage.migration.access.token — TeamCity 認証トークン。トークンには、アーティファクトストレージにアクセスするのに十分な権限が必要です。プロファイル | アクセストークンに移動して、新しいトークンを作成します。

サーバー URL とデフォルトのアーティファクトストレージパスは、管理 | グローバル設定ページで見つけることができます。

以下のスニペットは、サンプル application.properties ファイルの内容を示しています。

クラウドストレージの認証設定

ターゲットストレージ設定

移行ツールは、アーティファクトを現在アクティブなストレージにコピーまたは移動します。移行プロセスを実行する前に、アーティファクトを移行するプロジェクトのプロジェクト設定 | アーティファクトストレージページに移動し、ターゲットストレージをアクティブ化します。

移行ツールを実行する

<アーティファクト移行ツール>/bin フォルダーでターミナルを開き、--project (-p) パラメーターを指定して「migrate」(Linux、macOS) または「migrate.bat」(Windows) ファイルを実行します。このパラメーターは、外部プロジェクト ID を値として受け入れます。

--recursive (-r) パラメーターを追加して、ツールが選択したプロジェクトのすべてのサブプロジェクトを再帰的に処理するかどうかを指定できます。

ローカルディレクトリではなくクラウドストレージからアーティファクトを移行する必要がある場合は、追加の --source (-s) パラメーターを指定し、ストレージ ID を値として渡します。

このモードで初めて移行ツールを実行すると、コピーする必要があるアーティファクトが検出され、移行計画が保存され、次の手順を実行するよう求められます。

• 移行計画を更新します。

• 移行計画を表示します。

• ソースストレージからターゲットストレージにアーティファクトをコピーします。

• 移行を元に戻します。このオプションは、コピーされたアーティファクトをターゲットストレージから削除します。移行が不完全または中断された場合は、このオプションを選択できます。

• ソースストレージからアーティファクトを削除します。

• 移行計画は忘れてください。誤った移行パラメーターを指定した場合に、保存された移行計画を破棄するには、このオプションを使用します。

アーティファクトを一度に移行するには (ツールによる確認や入力の要求なし)、次のコマンドを追加して必要な移行手順を指定します。

• --create-migration-plan — 移行計画を作成または更新します。

• --show-migration-plan — 移行計画を表示します。

• --start-migration — ソースストレージからターゲットストレージにアーティファクトをコピーします。

• --revert-migration — 移行が不完全または中断された場合は、コピーされたアーティファクトをターゲットストレージから削除します。

• --remove-artifacts-in-source — コピーされたアーティファクトをソースストレージから削除します。コピーされなかったアーティファクトは削除されません。

• --reset-migration-plan — 現在の移行計画を破棄します。

例: 次のコマンドは、指定された Amazon S3 ストレージから現在アクティブなストレージにアーティファクトを移動します。

追加の構成プロパティ

次のプロパティを構成ファイルに追加できます。

• teamcity.storage.migration.processing.threadCount — ツールが処理に使用するスレッドの数。デフォルト値は 4 です。

• teamcity.storage.migration.failWhenCannotAccessStorageSettings — ツールが TeamCity サーバーからストレージ設定を取得できない場合に移行が失敗するかどうかを制御します。これは権限不足が原因で発生する可能性があります。デフォルト値は false です。

• teamcity.storage.migration.copying.threadCount — ツールがクラウドストレージにデータをアップロードするために使用するスレッドの数。デフォルト値は 4 です。

• teamcity.storage.migration.upload.numberOfRetries — エラーが発生した場合に、ツールがクラウドストレージにデータをアップロードするときに試行する回数。デフォルト値は 5 です。

• teamcity.storage.migration.upload.retryDelayMs — 試行間の最初の遅延 (ミリ秒単位)。デフォルト値は 1000 です。

• teamcity.storage.migration.s3.forceVirtualHostAddressing — ツールが非推奨のパススタイルの代わりに S3 URL アドレスの仮想ホストスタイルを使用するかどうかを指定します。デフォルト値は true です。