ウォームアップ

ウォームアップを設定する

ウォームアップを構成するには、開発環境テンプレートの起動パフォーマンス | ウォームアップセクションを使用します。

ここに:

• インスタンスタイプ – ウォームアップスナップショットの作成に使用される開発環境に割り当てられるリソース。ウォームアップ開発環境ではパフォーマンスがそれほど重要ではないため、ユーザー開発環境よりも小さいインスタンスタイプを選択できます。

• IDE のプロジェクトインデックスを作成する – 有効にすると、ウォームアップによってテンプレートで指定された IDE のプロジェクトインデックスが作成されます。重要:

  • このオプションを無効にする場合は、スクリプトにウォームアップスクリプトを必ず用意してください。そうしないと、ウォームアップが無駄になります。

  • テンプレートに複数のリポジトリがある場合、ウォームアップによってそれらすべてのリポジトリのインデックスが構築されます。

  • VS Code/Cursor のプロジェクトインデックスの作成はサポートされていません。

• カスタムスクリプトを実行する – 有効にすると、ウォームアップ時にスクリプトで指定されたカスタムシェルスクリプトが実行されます。たとえば、これを使用して ./gradlew build でプロジェクトをビルドしたり、IDE を設定したりできます。重要:

  • スクリプトでは、テンプレートで定義された環境変数と事前定義された環境変数を使用できます。

  • このスクリプトはユーザーなしで実行されるため、個人のパラメーター（シークレット）にはアクセスできません。ウォームアップに機密データを提供する必要がある場合は、ウォームアップ開発環境に秘密を提供するを参照してください。

  • 追加のツールをインストールするスクリプトを使用しないでください (例: apt get を使用)。このデータはスナップショットに保存されません。

  • ウォームアップでは、まず IDE インデックスを構築し、その後でのみスクリプトを実行します。

  • スクリプトで docker コマンドを実行する場合は、必ず最初に canvas await-dockerd を実行します。例:

    canvas await-dockerd docker login ...

    このコマンドは、Docker デーモンがコマンドを受け入れる準備ができていることを確認します。

  スクリプトの作業ディレクトリ –スクリプトが実行される作業ディレクトリへのパス。このパスは /mnt/jetbrains/work ディレクトリからの相対パスです。指定されていない場合、スクリプトは /mnt/jetbrains/work で実行されます。ディレクトリ構造を参照

• パラメーター – ウォームアップで使用できる環境変数。ユーザー認証情報やアクセストークンなどの機密データをウォームアップ環境に提供するために使用します。詳細

• 実行タイムアウト (分) – CodeCanvas は、指定された時間よりも長くかかる場合はウォームアップを停止し、失敗したと見なします。

• スケジュール通りにウォームアップを実行する – 有効にすると、ウォームアップは Cron トリガーで指定されたスケジュールで実行されます。スケジュールは crontab 形式（CodeCanvas サーバー OS のタイムゾーン）で指定します。例: 0 1 * * 1-5 は週末を除き、毎日午前 1 時にウォームアップを実行します。詳細

• リポジトリに変更がない場合はスキップ – 有効にすると、前回のウォームアップ以降に Git リポジトリに変更がない場合、ウォームアップは実行されません。テンプレートに複数のリポジトリがある場合は、少なくとも 1 つのリポジトリに変更がある場合にのみウォームアップが実行されます。

• スケジュールを無効にする場合 – ウォームアップが指定回数実行されても失敗する場合、または結果のスナップショットが指定時間使用されていない場合に、ウォームアップのスケジュールを自動的に無効にすることができます。詳細

ウォームアップの仕組み

ウォームアップがトリガーされると、CodeCanvas はテンプレート設定（指定されたコンテナーイメージ、環境変数など）に基づいて開発環境を作成します。重要: 環境を特定のユーザー向けにカスタマイズすることはできません。つまり、個人パラメーターは使用できません。ウォームアップに機密データを提供する必要がある場合は、ウォームアップパラメーターを使用してください。

このウォームアップ環境では、CodeCanvas は次の処理を実行します。

1. プロジェクトのソースコードをチェックアウトします。

2. スクリプトフィールドにカスタムシェルスクリプトを指定した場合、そのスクリプトを実行します。スクリプトがステータスコード 0 で正常に終了した場合にのみ、ウォームアップは次のステップに進みます。

3. テンプレートで指定された IDE を実行し、プロジェクトインデックスを構築します。

   プロジェクトインデックスは IDE ごとに固有であり、多くの場合 IDE のバージョンごとに異なります。ウォームアップでは、CodeCanvas はテンプレートの IDE バージョンパラメーターで指定された IDE バージョンを使用します。デフォルトの場合は、ウォームアップでデフォルトの IDE バージョンのインデックスが作成されます。

   ウォームアップでプロジェクトインデックスを構築したくない場合は、IDE のプロジェクトインデックスを作成するチェックボックスをオフにします。

4. ファイルシステムのスナップショット (ウォームアップスナップショット) を保存します。

ウォームアップのスナップショット

ウォームアップスナップショットは、マウントされていない開発環境ストレージ（Docker ボリューム）です。作業ディレクトリ、プロジェクトインデックスを含むユーザーのホームディレクトリ、CodeCanvas システムデータを含むディレクトリが含まれます。ディレクトリ構造の詳細

その他のデータはすべて破棄されます。そのため、ウォームアップ中に追加のツール（例: apt get）をインストールしないでください。カスタムツールが必要な場合は、代わりにカスタム開発環境イメージを使用してください。

重要なメモ：

• CodeCanvas は、IDE と Git ブランチの組み合わせごとに、最新のウォームアップスナップショットのみを保存します。IDE のバージョンは考慮されません。例: プロジェクトに 2 つのブランチ（main と feature-branch）があるとします。一部の開発者が JetBrains Rider を使用し、一部の開発者が IntelliJ IDEA を使用しているとします。この場合、スナップショットは最大 4 つ（main + Rider、main + IDEA、feature-branch + Rider、feature-branch + IDEA）になります。

• 同じスナップショットから開始された開発環境は互いに独立しており、状態を共有することはありません。

• スナップショットの取得方法はインフラストラクチャによって異なります。例: AWS では、開発環境のディスクとスナップショットは EBS(英語) に基づいています。

ウォームアップを開始する

ウォームアップをトリガーする方法は 2 つあります。CodeCanvas UI で手動でトリガーする方法と、スケジュールによってトリガーする方法です。

ウォームアップスケジュールの自動無効化

リソースコストを削減するために、ウォームアップスケジュールを自動的に無効にすることができます。開発環境テンプレートの起動パフォーマンス | ウォームアップセクションで、スケジュールを無効にする場合の以下のオプションを使用します。

• ウォームアップ失敗 – 指定された回数のウォームアップ実行が失敗した後、ウォームアップのスケジュールを無効にします。デフォルト: 3

• ウォームアップスナップショットは使用されていません – 指定された時間数の間、スナップショットが使用されなかった場合、ウォームアップスケジュールを無効にします。デフォルト: 72 時間

スケジュールを無効にすると、スナップショットは自動更新されなくなります。ただし、ウォームアップは手動で実行できます。

スケジュールが無効になったことを通知するには、ウォームアップスケジュールが無効になっていますイベントをサブスクライブしてください。詳細については、通知を参照してください。

ウォームアップ開発環境に秘密を提供する

プロジェクトでは、プライベートリポジトリから依存関係を取得したり、データベースにアクセスしたりするために、ユーザー認証情報やアクセストークンといった機密データが必要になる場合があります。個々のユーザー開発環境では個人用ユーザーパラメーターを使用できますが、ウォームアップ開発環境でもこれらのデータは作業に必要です。必要なウォームアップパラメーターは名前空間レベルで定義し、ウォームアップ設定で対応する環境変数に割り当てます。

カスタムブランチのウォームアップスナップショットを作成する

デフォルトでは、開発環境テンプレートで指定されたブランチに対してウォームアップスナップショットが作成されます。別のブランチのスナップショットを作成する必要がある場合は、手動で作成できます。