TeamCity データディレクトリ

TeamCity データディレクトリの場所

現在使用されているデータディレクトリの場所は、実行中の TeamCity サーバーインスタンスの管理 | グローバル設定ページで確認できます。参照リンクをクリックすると管理 | グローバル設定 | データディレクトリの参照タブが開き、ユーザーはディレクトリ内の新しいファイルをアップロードしたり、既存のファイルを変更したりできます。

現在のデータディレクトリの場所は、logs/teamcity-server.log ファイルでも確認できます (サーバーの起動時に「TeamCity データディレクトリ : 」行を探します)。

設定ファイルをバージョン管理にアップロードする

TeamCity を設定して、.BuildServer/config ディレクトリ (_trash サブフォルダーを除く) から外部 VCS リポジトリにファイルをプッシュすることができます。この設定により、次のことが可能になります。

• すべての構成変更を監視します。サーバー構成ファイルへの各編集は個別のコミットとして自動的にプッシュされるため、変更履歴を確認して調査できます。

• 設定ファイルが破損した場合は、サーバーを復元します。ロールバックするには、TeamCity サーバーをシャットダウンし、以前のリポジトリリビジョンからファイルを .BuildServer/config ディレクトリにプルします。

サーバーの構成ファイルを保存するリポジトリを設定するには:

1. 構成ファイルによって機密データが公開されないように、データディレクトリを保護します。

   • パスワード、シークレット、SSH キー、その他の機密データを保護するために、カスタム暗号化キーを設定します。これには、TEAMCITY_ENCRYPTION_KEY 環境変数の使用をお勧めします。

   • 管理 | グローバル設定ページから再暗号化プロセスを開始します。このアクションにより、新しいカスタム暗号化キーが既存のすべての機密値に適用されます。

   • 外部データベースの認証情報を config/database.properties ファイルから対応する環境変数に移動します。TeamCity は完全に起動する前にデータベース接続を必要とするため、このファイルを暗号化しません。そのため、これらの値を環境変数に移動して隠すのが最適です。

   さらに、構成ファイルが保存されている Git リポジトリには、信頼できるユーザーのみがアクセスできることを確認してください。

2. 管理 | 構成リポジトリに移動します。

3. 設定ファイルの変更を configs リポジトリにコミットするにチェックマークを付けます。

4. リポジトリへのパスを SSH 形式で入力します。

5. 構成ファイルを保存するリポジトリブランチの完全な名前 (heads/refs/<name>) を入力します。

6. TeamCity が SSH 経由でリポジトリにアクセスできるように、秘密鍵をアップロードします。

自動インクリメンタープラグイン(英語)をご利用の場合は、最新バージョンにアップデートすることをお勧めします。

TeamCity データディレクトリの構造

TeamCity データディレクトリの config サブディレクトリには TeamCity プロジェクトの設定が含まれ、system サブディレクトリにはビルドログ、アーティファクト、データベースファイル（デフォルトで内部データベース（HSQLDB）が使用されている場合）が含まれます。また、手動バックアップと復元に関する情報を検討して、どのデータがデータベースに保管されていて、どれがファイルシステムに保管されているかをよりよく理解することもできます。

• BuildServer/config — プロジェクト、ビルド構成、一般的なサーバー設定が保存されるディレクトリ。

  • _trash — 削除されたプロジェクトのバックアップコピー。手動で削除しても問題ありません。プロジェクトの復元の詳細については、使い方を確認してください。

  • notifications — 通知テンプレートと通知構成設定。

  • logging — 内部サーバーのログ構成ファイル。新しいファイルをディレクトリに手動で追加できます。

  • projects — すべてのプロジェクト関連の設定が含まれるディレクトリ。各プロジェクトには独自のディレクトリがあります。プロジェクト階層は使用されず、すべてのプロジェクトは「プロジェクト」の直下に対応するディレクトリを持ちます。

    • <projectID> — <projectID> ID を持つプロジェクトのすべての設定 (ビルド構成設定を含み、サブプロジェクト設定は除く) を含むディレクトリ。必須のネストされたファイルがある場合、新しいディレクトリを作成できます。ルートディレクトリには、ルートプロジェクトの設定が含まれます。ディレクトリに *.xml.N ファイルがある場合は、Web UI 経由でプロジェクト構成が変更されたときに作成された対応するファイルのバックアップコピーです。これらのバックアップコピーは、TeamCity では使用されません。

      • buildNumbers — 対応するビルド構成の現在のビルド番号カウンターを格納する <buildConfigurationID>.buildNumbers.properties ファイルを含むディレクトリ。

      • buildTypes — 対応するビルド構成またはテンプレート設定を持つ <buildConfiguration or template ID>.xml ファイルを含むディレクトリ。

      • pluginData — オプションのプラグイン関連のプロジェクトレベルの設定を保存するディレクトリ。バンドルされたプラグイン設定とカスタムプロジェクトタブなどの補助プロジェクト設定は、ディレクトリの plugin-settings.xml ファイルに保存されます。バージョン管理ごとに VCS の外部に保存された資格情報は、secure/credentials.json ファイルに保存されます。

      • vcsRoots — ファイル <VcsRootID>.xml にプロジェクトの VCS ルート設定を含むディレクトリ。

      • project-config.xml — パラメーターやクリーンアップ規則などのプロジェクト設定を含むプロジェクト構成ファイル。

  • main-config.xml — サーバー全体の構成設定。

  • database.properties — データベース接続設定については、外部データベースの設定を参照してください。

  • license.keys — TeamCity に入力されたライセンスキーを保存するファイル。

  • change-viewers.properties — 外部変更ビューアー構成プロパティ（使用可能な場合）。

  • internal.properties — さまざまな内部 TeamCity プロパティを指定するためのファイル。デフォルトでは存在しないため、必要に応じて作成する必要があります。

  • auth-config.xml — サーバー全体の認証関連の設定を格納するファイル。

  • ldap-config.properties — LDAP 認証構成プロパティ。

  • ntlm-config.properties — Windows ドメイン認証構成プロパティ。

  • issue-tracker.xml — トラッカー統合設定を発行します。

  • backup-config.xml — WebUI バックアップ構成設定。

  • roles-config.xml — ロール - 権限割り当てファイル。

  • database.*.properties — さまざまな外部データベースのデフォルトのテンプレート接続設定ファイル。

  • *.dtd — XML 構成ファイルの DTD ファイル。

  • *.dist — .dist のない対応するファイルのデフォルトのテンプレート構成ファイル。以下を参照してください。

• .BuildServer/plugins — TeamCity プラグインを保存して、TeamCity の開始時に自動的にロードできるディレクトリ。新しいプラグインをディレクトリに追加できます。サーバーが稼働していないときに、既存のものを削除できます。プラグインの構造はプラグインのパッケージング(英語)で説明されています。

  • .tools — このディレクトリを作成して、すべてのエージェントにインストールするツールを一元化します。このフォルダーにあるフォルダーまたは .zip ファイルはすべてのエージェントに配布され、エージェントホームディレクトリフォルダーに表示されます。

• .BuildServer/system — ビルド結果データが保存されるディレクトリ。ディレクトリの内容は TeamCity によって生成され、手動編集用ではありません。

  • artifacts — ビルドのアーティファクト、ログ、その他のデータが保存されるデフォルトのディレクトリ。アーティファクトストレージの形式は <project ID>/<build configuration name>/<internal_build_id> です（内部ビルド ID の詳細を参照してください）。必要に応じて、各ビルドのディレクトリ内のファイルを手動で追加 / 削除できます。これは、対応するビルドのアーティファクトに反映されます。

    • .teamcity サブディレクトリには、ビルドの非表示のアーティファクトとビルドログが保存されます（以下を参照）。ファイルは必要に応じて手動で削除できますが、ビルドによってファイルに裏付けられた対応する機能が失われるため、お勧めしません。(ビルドログのように、スナップショットの依存関係としてのビルドの再利用、カバレッジレポートなど、完成したビルドパラメーターの表示 / 使用)

      • logs サブディレクトリには、ビルドログが内部形式で保存されます。ビルドログには、ビルド出力、コンパイルエラー、テスト出力、テスト失敗の詳細が保存されます。必要に応じてファイルを手動で削除できますが、対応するビルドではビルドログと失敗の詳細 (およびテスト失敗の詳細) が失われます。

  • messages — ディレクトリには、移動できなかったファイルが格納されます（詳細については、サーバー起動時のサーバーログを参照してください）。

  • changes — リモート実行の変更が内部形式で保存されるディレクトリ。ディレクトリ内のファイルの名前には、内部の個人変更 ID が含まれます。必要に応じて、ファイルを手動で削除できますが、対応する個人ビルドでは UI の個人変更が失われ、影響を受けるキュービルドを開始しようとすると、失敗するか、個人パッチなしで実行されます。

  • pluginData — ビルド、現在のシステム状態などに関するさまざまなデータを格納するディレクトリ。このディレクトリを削除または変更することはお勧めしません。このディレクトリの内容はデータベースに保存されているデータに対応しているため、データベースを復元するときは、データベースとの整合性を保つために、このディレクトリを同じ状態に復元する必要があります。

  • audit — ビルド構成の変更の履歴を保持し、変更の差分を表示するために使用されるディレクトリ。また、関連データをデータベースに保存します。

  • caches — （VCS リポジトリの内容、検索インデックスなどの）内部キャッシュを備えたディレクトリ。キャッシュをクリアするために手動で削除できます。キャッシュは必要に応じて自動的に復元されます。サーバーが実行されていないときにディレクトリを削除する方が安全です。

    • .unpacked — 解凍されたサーバー側プラグインを格納するために自動的に作成されるディレクトリ。サーバーの実行中に変更しないでください。サーバーが実行されていない場合は、安全に削除できます。

  • buildserver.* — 組み込み HSQLDB に関連するファイルのセット。

• .BuildServer/backup — Web UI 経由で作成されたバックアップアーカイブを保存するデフォルトのディレクトリ。このディレクトリ内のファイルは TeamCity では使用されず、保管のためにすでにコピーされている場合は安全に削除できます。

• .BuildServer/lib/jdbc — TeamCity がデータベースドライバーを検索するために使用するディレクトリ。必要に応じてディレクトリを作成してください。TeamCity はディレクトリ内のファイルを管理せず、必要なドライバーを格納する .jar ファイルのみをスキャンします。

設定ファイルの直接変更

config ディレクトリのファイルは手動で編集できます (明示的に指定されていない限り)。変更はサーバーを再起動せずに反映されます。TeamCity はこれらのファイルの変更を監視し、変更または新しいファイルが検出されると自動的に再読み取りします。これらのファイルの物理構造または論理構造は簡単に壊れる可能性があるため、編集には細心の注意を払ってください。変更を行う前に必ずデータをバックアップしてください。

ファイルのフォーマットはより新しい TeamCity バージョンと変わることができるためファイル更新手順はアップグレードの後で調整を必要とするかもしれないことに注意してください。

REST API は最も一般的な設定編集のための手段を持ち、サーバーアップグレード後に機能するという点でより安定しています。