注: 以下の翻訳の正確性は検証されていません。AIPを利用して英語版の原文から機械的に翻訳されたものです。

基本概念

ブランチ

ソフトウェア開発者は通常、バージョン管理システムを使ってコードベースでの作業を調整します。これにより、複数のエンジニアが同じコードに安全に変更を加えられます。

Palantir プラットフォームでは、ソフトウェア開発者がコードを扱うのと同じように、データと変更管理を考えることができます。つまり、多くのユーザーがほかのユーザーの作業を妨げずに、同じデータに変更を加えたり、操作したりするための方法が必要です。Global Branching は、バージョン管理システムで一般的なブランチという機能を活用し、ソフトウェア開発のベストプラクティスを Palantir プラットフォームに適用します。

大まかに言うと、ブランチを使うことで、既存の環境を分岐させ、独立したブランチ内でエンドツーエンドのワークフローのコンポーネントを操作できます。変更内容に問題がなければ、このブランチで加えた変更を main ブランチにマージできます。

ブランチのワークフロー

グローバルブランチは、Foundry アプリケーション内、または Global Branching アプリケーションで直接作成できます。次の図は、ブランチのワークフローを使って Palantir プラットフォームのリソースを変更する方法を示しています。

ブランチのワークフロー。

ブランチを作成またはアクセスする

Foundry アプリケーションのブランチセレクターから、または Global Branching アプリケーションでブランチを作成できます。

新しいブランチの作成ダイアログ。

オントロジー、組織、スペースがブランチの作成にどう関係するかについては、ブランチのセキュリティのドキュメントを参照してください。

既存のグローバルブランチにアクセスするには、対応しているアプリケーションのブランチセレクターでそのブランチを選択します。Global Branching アプリケーションのブランチタブから既存のブランチを探して移動することもできます。

ブランチタブ。

対応しているアプリケーションでグローバルブランチを操作している間は、ブランチタスクバーが表示されます。

ブランチタスクバー。

ブランチで変更を加える

リソースを編集する

ブランチ内では、main ブランチに影響を与えずに Foundry リソースを変更できます。ただし、ブランチで Foundry リソースを作成または削除すると、main に影響します。これはオントロジーリソースには当てはまりません。オントロジーリソースでは、main ブランチに影響を与えずに、ブランチ上でエンティティを作成、変更、削除できます。

リソースの変更をはじめるにあたり、事前にリソースをこのブランチに追加する必要があるアプリケーションもあれば、最初の変更を保存した後に自動的に追加されるアプリケーションもあります。事前の追加が必要な場合は、ブランチを選択すると追加を求めるダイアログが表示されます。

パイプラインをグローバルブランチに追加。

main ブランチからの更新

このブランチでリソースを変更している間に、main ブランチでも同じリソースが更新されることがあります。これらの更新を取り込むには、このブランチをリベースします。つまり、main の変更をこのブランチにマージし、その上に以前保存したブランチの変更を再適用します。

オントロジーでのリベース。

このブランチから変更を取り除く

ブランチからリソースを外すと、その状態は main ブランチ上のリソースのバージョンに戻ります。Global Branching アプリケーションまたはブランチタスクバーから、ブランチのリソースを直接外すことができます。

このブランチからリソースを外す。

リソースを外すと、ブランチの状態が破損する可能性があります。そのため、リソースのリネージを確認し、ブランチ内のほかのリソースがその変更に依存していないことを確認することが重要です。

提案を作成して準備する

ブランチの状態に問題がなければ、提案を作成して変更のレビューをはじめ、最終的に main ブランチにマージします。はじめるには、Global Branching アプリケーションで提案の作成を選択するか、ブランチタスクバーで同じ選択肢を選択します。提案を作成するには、ブランチの所有者ロールまたはスペースの管理者権限が必要です。ブランチのロールと権限の詳細については、ブランチのセキュリティのドキュメントを参照してください。提案には説明項目があり、変更のレビューに必要な情報を入力できます。この項目は Markdown テキストに対応しています。

提案の作成ダイアログ。

提案ページまたはブランチタスクバーでは、チェックを使ってリソースのマージ準備状況を確認し、リソースごとの承認ポリシーを表示できます。

提案ページ。

チェック

提案を作成すると、提案をマージできるかどうかを判断するために、リソースごとにチェックが実行されます。

チェックでは、main ブランチと現在のブランチの競合や必要な承認など、リソースのマージを妨げる可能性のある問題が表示されます。提案をマージするには、ブランチ内のリソースに対するすべてのチェックに合格する必要があります。

リベースと競合の解決

ブランチをマージ可能な状態にするには、ブランチ内のすべてのリソースが main ブランチの最新バージョンとマージ可能である必要があります。リソースが main より古い状態である場合や、競合なくマージできない場合は、リベースのチェックに失敗します。ブランチ内のリソースをリベースするために、適切なアプリケーションにリダイレクトされます。ブランチ内のリソースと main 上のリソースの間に競合がある場合は、リベースのチェックに合格するために、それらの競合を解決する必要があります。

アプリケーションごとのリベースの実装方法に関するドキュメントについては、統合ページを参照してください。

Global Branching は、リベース中に競合のない変更をすべて自動的に解決します。実際に競合している場合、つまり同じリソースの同じプロパティが main とこのブランチの両方で編集されている場合は、自動では解決されません。リベースを続行するには、いずれかのバージョンを手動で選択する必要があります。

ブランチ内のリソースに対するチェック。

承認ポリシー

このブランチをマージするには、すべての承認ポリシーを満たす必要があります。保護されていないリソースでも、編集レベルの権限を持つユーザーによる承認が必要ですが、変更を加えたユーザーがポリシーを満たしている場合は、自動的に承認されることがあります。保護されたリソースには、リソースの保護と承認ポリシーで定義された必須のレビュー担当者によるレビューが必要です。

承認待ちと表示されているリソースごとに、承認ステータスを選択して、関連する承認ポリシーと承認資格のあるレビュー担当者を表示します。

提案ページの承認ポリシー。

Code Repositories および Pipeline Builder のパイプラインでは、承認ポリシーはリソース内で定義されます。

提案をレビューする

資格のあるレビュー担当者は、提案の変更タブまたはリソースのアプリケーションでリソースをレビューできます。提案ページでリソースのレビューを選択するか、ブランチタスクバーまたは提案ページのリソースメニューにあるリンクを使います。どちらの方法でも、リソースの種類に応じて、提案内でのレビューに対応している場合は変更タブが開き、それ以外の場合はリソースのアプリケーションが開きます。

ブランチ内のリソースのレビュー。

提案上のリソースへの変更を拒否する

レビュー中にいずれかのユーザーが1回でも拒否すると、そのリソースの変更は拒否済みになります。これにより、 提案全体をマージできなくなります。提案をマージするには、拒否したユーザーが変更を再度レビューし、承認する 必要があります。

提案をマージする

変更が承認され、すべてのチェックに合格すると、ブランチタスクバーまたは Global Branching アプリケーションで提案をマージを選択して、提案を main ブランチにマージできます。マージ権限については、ブランチのセキュリティに関するドキュメントで説明しています。

提案をマージするときに、ブランチ上で直接変更されていないリソースも含め、影響を受けるリソースのビルドをトリガーできます。ビルドには3つのオプションがあります。

  • 変更されたリソースとその間にあるすべてのリソースをビルド: 変更されたリソースと、それらの間にあるトランスフォームの両方がビルドされます。
  • 変更されたリソースのみをビルド: このブランチ上で直接変更されたリソースのみがビルドされます。このブランチの上流の変更に依存するリソースは、手動でビルドする必要がある場合があります。
  • リソースをビルドしない: リソースはビルドされません。提案がマージされた後、リソースを手動でビルドする必要があります。

提案のマージ時のビルドオプション。

必要に応じて、変更されたリソースをマージ時のビルドから除外できます。除外するリソースの選択を保存すると、影響を受けるリソースのプレビューが更新されます。影響を受けるリソースとは、選択された変更済みリソースのペアの間にあると算出されたトランスフォームです。リソースを除外しても、マージ時のビルドから除かれるだけで、そのリソースの変更はマージされます。

提案のマージダイアログには、変更されたリソースと影響を受けるリソースが表示され、変更されたリソースのうち2個がマージ時のビルドから除外されています。

マージが部分的に失敗した場合、提案ページには、マージに成功したリソースと、マージに失敗してブランチ上に残っているリソースが表示されます。現在、部分的に失敗したマージを元に戻すことはできません。表示されたエラーを解決し、提案のマージを再試行する必要があります。

ブランチと提案のライフサイクル

ブランチのライフサイクル

アクティブ、非アクティブ、マージ済み、アーカイブ済みの状態を示すブランチのライフサイクル図。

ブランチを作成すると、ステータスはアクティブに設定されます。その後、ブランチは非アクティブ、アーカイブ済み、マージ済みのいずれかの状態に移行できます。利用可能な4つのブランチの状態は、次のように定義されています。

  • アクティブ: 作業中、またはマージ処理中のブランチです。アクティブなブランチ上でビルドまたはインデックス化されたデータは、ブランチがアクティブな間は保持されます。

  • 非アクティブ: アクティビティがない状態が設定可能な期間続いた後、自動的に非アクティブとしてマークされるブランチです。この状態では、オントロジーリソースのインデックス化が解除され、指定された日数が経過するとデータが削除されます。非アクティブなブランチ上のリソースのビルドは、直ちに失敗します。ブランチが非アクティブとしてマークされると、ブランチの所有者にメール通知とプラットフォーム内の通知の両方が送信されます。

    • ブランチが非アクティブとしてマークされるまでの期間と、データ削除がトリガーされるまでの期間は、Control Panel の Control Panel > スペース > 操作 > グローバルブランチの保持ポリシーで定義します。デフォルトでは、ブランチが非アクティブになるまでの期間は35日に設定され、その7日後にブランチのデータ削除がトリガーされます。 Control Panel でのブランチの保持設定の管理。
    • 非アクティブなブランチをアクティブな状態に戻すには、ブランチの非アクティブラベルを手動で外します。
    • 非アクティブなブランチ上のリソースを開くと、そのブランチが非アクティブであることを警告するダイアログが表示されます。ブランチをアクティブ化を選択すると、ブランチがアクティブになります。代わりにダイアログを閉じた場合も、リソースの操作を続けられますが、これは推奨されません。 ブランチ上のリソースを表示したときに、ブランチが非アクティブであることを警告し、アクティブ化を促すダイアログ。
  • アーカイブ済み: 作業が行われなくなったブランチです。アーカイブは常に手動で行います。ブランチの所有者には、メール通知とプラットフォーム内の通知の両方が送信されます。アーカイブ済みブランチでのインデックス化の解除、ビルドの失敗、データの削除は、非アクティブなブランチと同じように行われます。以前に変更されたリソースなどのメタデータは保持され、アーカイブ済みブランチは復元できます。アーカイブ済みブランチはブランチセレクターに表示されませんが、Global Branching アプリケーションで開いて復元できます。

    • アーカイブ済みブランチ上のリソースを開くと、そのブランチがアーカイブ済みであることを警告するダイアログが表示されます。ブランチを復元を選択すると、ブランチが復元されます。代わりにダイアログを閉じた場合も、リソースの操作を続けられますが、これは推奨されません。 ブランチ上のリソースを表示したときに、ブランチがアーカイブ済みであることを警告し、復元を促すダイアログ。
  • マージ済み: 提案がマージされたブランチです。マージ済みブランチは最終状態であり、復元できず、ブランチセレクターにも表示されません。アクセスできるのは Global Branching アプリケーションからのみです。

ブランチが非アクティブになるのを防ぐ

ブランチが非アクティブになるのを防ぐには、ブランチの詳細パネルのブランチ設定セクションで、ブランチをアクティブに保つオプションを有効にします。ブランチはアクティブな状態を維持し、その後のインデックス化の解除やデータ削除の対象にはなりません。アクティブなブランチは、非アクティブなブランチと比べて、時間の経過とともにコストが増加します。

ブランチページでの「ブランチをアクティブに保つ」の設定。

以前に非アクティブまたはアーカイブ済みだったブランチで作業する

ブランチが非アクティブまたはアーカイブ済みだった場合、そのブランチ上のリソースでは、オントロジーエンティティのインデックス化の解除や、ロジックとデータの削除が行われている可能性があります。その後ブランチをアクティブ化または復元した場合、削除されたデータやインデックス化が解除されたデータを復旧するため、次の操作が必要になることがあります。

  • オントロジーリソース: オントロジーエンティティの再インデックス化をトリガーするには、オントロジーリソースの説明をわずかに更新するなど、動作に影響しない変更を加えるか、Ontology Manager のバナーから再インデックス化します。
  • Code Repositories: JobSpec が削除されている場合は、リポジトリ内の該当するトランスフォームのコメントを編集するなど、動作に影響しない変更を加えてコミットします。その後、コードリポジトリ内からビルドを実行すると、該当するデータセットにロジックが再配置され、それらがビルドされます。この最初のビルドを Data Lineage などのほかのアプリケーションから実行しても、JobSpec は配置されません。
  • Pipeline Builder: Pipeline Builder からデプロイとビルドを実行して、ブランチに JobSpec とデータを再配置します。
  • ビルドスケジュール: アーカイブ済みまたは非アクティブなブランチでのビルドは、自動的に失敗します。スケジュールがそのブランチ上のリソースをビルドする場合、ビルドの失敗が繰り返されることで、スケジュールが一時停止されることがあります。Build Schedules アプリケーションまたは Data Lineage から、手動でスケジュールを再開できます。

既知の制限事項

  • ビルドの失敗が繰り返されると、非アクティブまたはアーカイブ済みのブランチ上のスケジュールは自動的に一時停止されます。ブランチを再度アクティブ化した場合は、必要に応じて、ブランチ上のスケジュールの一時停止を手動で解除してください。
  • ローカル開発中、たとえばローカルマシンから git を直接使用してブランチ上のリソースを操作する場合、非アクティブまたはアーカイブ済みのブランチでの作業は制限されません。加えた変更に基づいて実体化されたデータや JobSpec は、削除される可能性があります。

AI FDE

  • AI FDE では、非アクティブまたはアーカイブ済みのブランチを変更できません。続行するために、ブランチの再アクティブ化または復元を促すプロンプトが表示されます。

提案のライフサイクル

提案は、次の3つの状態のいずれかになります。

  • オープン中: 進行中または承認済みの提案です。
  • マージ済み:main ブランチにマージされた提案です。
  • クローズ済み: マージされずにクローズされた提案です。