プロジェクトの構成

1. 名前空間を作成する

会社のポリシーで名前空間の作成が許可されている場合は、自分で作成できます。そうでない場合は、システム管理者に名前空間の作成を依頼し、次の手順に進んでください。

1. ヘッダーナビゲーションで名前空間を選択し、サイドバーメニューですべての名前空間を選択します。

2. 新しい名前空間をクリックし、名前空間名とその他の設定を指定します。

   

名前空間について詳しく学びます。

2. Git リポジトリを接続する

CodeCanvas は Git ホスティングを提供していないため、プロジェクトを他の場所でホストされている Git リポジトリに接続する必要があります。開発環境が作成されると、接続されたリポジトリのクローンが提供されます。

この例では、GitHub リポジトリを接続します。ドキュメントには、GitLab、Bitbucket、その他の Git ホスティングサービスに関する手順も記載されています。

1. ヘッダーナビゲーションで、名前空間を選択し、必要な名前空間を選択します。

2. サイドバーの名前空間メニューで、リポジトリを選択します。

3. 新規接続をクリックします。

   

4. リポジトリ名前とその他の設定を指定します。

   • リモートリポジトリ URL – リポジトリの SSH または HTTPS URL (例: git@github.com:MyCompany/my-project.git または https://github.com/MyCompany/my-project.git)

   • リポジトリの Web URL – リモートリポジトリの Web インターフェースの URL。CodeCanvas はリポジトリリストにこのリンクを表示します。例: これは GitHub にあるプロジェクトの README ファイルへのリンクになります。

   • アクセス制御 –すべてのユーザーのままにするか、選択されたユーザーのみを選択してリポジトリの内容の読み取りを許可するユーザーを指定します。この場合、このリストは Git サーバーの許可されたユーザーのリストと同期する必要があります。

5. リポジトリに認証が必要ない場合は、匿名を認証のままにして、接続をクリックします。認証が必要な場合は、SSH（SSH 認証用）またはパスワード（HTTPS 認証用）を選択します。

   SSH 認証には、SSH キーペアが必要です。CodeCanvas は、リポジトリを開発環境にクローンする際にのみ秘密鍵を使用します。ユーザーは、リポジトリからのプルやリポジトリへのプッシュを行う際に、独自の SSH キーを指定する必要があります。

   最も簡単な方法は、CodeCanvas に新しい SSH キーペアを生成させることです。

   1. 認証フィールドで、SSH を選択し、SSH キーの自動生成がオンになっていることを確認します。

   2. 接続をクリックし、生成された公開鍵をコピーします。

   3. リモート Git サーバーで、公開鍵を承認済みキーのリストに追加します。

      GitHub の場合: リポジトリ | 設定 | キーをデプロイするに移動し、デプロイキーを追加するをクリックします。公開鍵をキーフィールドに貼り付け、Key の追加をクリックします。

      

   4. まず接続のテストをクリックし、問題がなければ接続をクリックします。その後、リポジトリがリポジトリリストに表示されます。

   CodeCanvas の認証フィールドで、パスワードを選択し、リモート Git サーバーのユーザー名とパスワードを入力します。

   GitHub では、個人用アクセストークンを生成し、パスワードとして使用できます。CodeCanvas はこのトークンを、リポジトリを開発環境にクローンする場合にのみ使用します。ユーザーは、リポジトリからのプルやプッシュを行う際に、GitHub の認証情報を独自に指定する必要があります。

   1. GitHub で、プロファイル | 設定 | 開発者設定 | 個人アクセストークン | 細粒度トークンに移動し、新しいトークンを生成するをクリックします。

      

   2. リポジトリアクセスで、選択したリポジトリのみを選択し、接続するリポジトリを選択します。

   3. 許可の内容で、読み取り専用を選択します。

   4. トークンの生成をクリックします。

   5. トークンをコピーし、CodeCanvas でリポジトリパスワードと GitHub ユーザー名ユーザー名として指定します。

   6. まず接続のテストをクリックし、問題がなければ接続をクリックします。その後、リポジトリがリポジトリリストに表示されます。

3. 開発環境テンプレートを作成する

開発環境テンプレートは、開発環境の作成方法を定義する設定のセットです。たとえば、ベースイメージ（ツールチェーン、ランタイムなど）、開発環境に割り当てるリソース、クローンする Git リポジトリとブランチリポジトリ、その他の設定を指定できます。ユーザーが新しい開発環境を作成する際、テンプレートを選択するように求められます。

1. ヘッダーナビゲーションで名前空間を選択し、サイドバーメニューで必要な名前空間を選択します。

2. 名前空間サイドバーメニューで、テンプレートを選択し、新規テンプレートをクリックします。

   

3. テンプレート名前と基本設定を提供します:

   • リポジトリ – ユーザーの開発環境にクローンする Git リポジトリ。ここでは、前の手順で接続したリポジトリを選択するか、新しいリポジトリ接続を追加できます。

   • インスタンスタイプ – ユーザー開発環境に割り当てられるリソースを定義します。利用可能なインスタンスタイプのリストはシステム管理者によって設定されます。詳細

   • IDE および IDE バージョン – ユーザー開発環境でプロジェクトを開く際に使用する IDE とそのバージョン。利用可能な IDE とバージョンのリストはシステム管理者によって設定されます。詳細

4. 次へをクリックし、その他の設定を入力します。

   • プロジェクト設定

     • ブランチをチェックアウトする – リポジトリからクローンするブランチを指定します。デフォルトのブランチをクローンする場合は、空欄のままにしてください。

     • プロジェクトルート – ユーザーの IDE で開かれるプロジェクトのルートディレクトリからの相対パス。このパスは作業ディレクトリとして使用されます。

     • 環境変数 – ユーザー開発環境で利用可能な追加の環境変数です。ここでは、変数の追加をクリックして、名前と値を指定できます。パスワードやトークンなどの機密データの提供には、この設定を使用しないでください。

     • IDE プラグイン – IDE にインストールされるプラグインのリスト。JetBrains マーケットプレイスに表示されるプラグイン ID を指定してください。詳細

   • 起動パフォーマンス

     ここでは、ウォームアップとスタンバイプールの機能を設定できます。これはオプションの手順ですが、ユーザー開発環境の起動パフォーマンスを大幅に向上させることができます。これらについては、次の手順で説明します。

   • アクセス

     このテンプレートに基づいて開発環境を作成できるユーザーを指定します（選択されたユーザーのみまたはすべてのユーザー (条件が適用されます)）。このリストに含まれないユーザーは、JetBrains Gateway クライアントでこのテンプレートを表示できません。

     重要 ! この設定は、接続されたリポジトリの読み取り制限と一致させる必要があります。読み取り制限およびアクセスリストに含まれていないユーザーは開発環境を作成できません。

   • ライフサイクルスクリプト

     ここでは、開発環境のライフサイクル中に実行されるシェルスクリプトを指定できます。たとえば、自動化タスク、パーソナライズされた環境、その他のカスタムアクションの設定に使用できます。詳細については、開発環境のライフサイクルを参照してください。

   • 個人パラメーター

     プロジェクトでパスワードやトークンなどの機密データが必要な場合は、開発環境の作成時にユーザーにそれらの提供を求めることができます。開発環境内では、これらのパラメーターは環境変数またはファイルとして利用できます。

     例: 環境変数 DB_PASSWORD を作成し、必須パラメーターとしてマークすることができます。ユーザーが開発環境を作成すると、個人用ストレージから対応するシークレットをこのパラメーターにリンクするよう求められます。

     個人パラメーターの詳細を参照してください。

     

   • 拡張

     • SSH アクセス – ユーザーが SSH 経由で開発環境にアクセスできるようにするには、このオプションを選択してください。カスタム開発環境イメージを使用する場合は、sshd などの SSH サーバーが提供されていることを確認してください。

     • VM オプション – ユーザー IDE 用の追加の JVM オプション。IDE パフォーマンスにとっておそらく最も重要なオプションは -Xmx です。これは、ユーザー IDE に割り当てられる最大メモリサイズを定義します。デフォルト値は、開発環境で利用可能なメモリ量に基づいて自動的に計算されます。

     • 開発コンテナーイメージ – ユーザー開発環境の作成に使用する Docker イメージのフルネーム。プロジェクトに必要なツールチェーンとランタイムがすべて含まれていることを確認してください。イメージを指定しない場合、CodeCanvas はほぼすべての一般的なツールチェーンとランタイムを含むデフォルトのイメージを使用します。

       Docker レジストリに認証が必要な場合は、名前空間設定 | Docker レジストリ接続ページで資格情報を提供できます。

       

     • クラウドポリシー – システム管理者がクラウドポリシーを介してクラウドリソースへのシームレスなアクセスを構成している場合は、ここでポリシーを選択できます。

5. 作成をクリックします。すると、テンプレートがテンプレートリストに表示されます。

（オプション、起動を高速化）ウォームアップを構成する

ウォームアップスナップショットを事前に作成しておくことで、IDE の初期起動時間を大幅に短縮できます。これらのスナップショットには、IDE のインデックス、プロジェクトの依存関係、その他のデータを含めることができます。ユーザーが開発環境を作成すると、CodeCanvas はウォームアップスナップショットを開発環境にマウントし、プロジェクトのインポート、初期インデックス作成、ビルドを省略します。

ウォームアップを構成するときに、次の設定を指定できます。

• インスタンスタイプ – ウォームアップスナップショットの作成に使用される、開発環境に割り当てられたリソース。

• IDE のプロジェクトインデックスを作成する – 有効にすると、CodeCanvas はウォームアップスナップショットでプロジェクトの IDE インデックスを作成します。異なる IDE バージョンで作成されたインデックスは互換性がない可能性があることに注意してください。通常、メジャーバージョン（例: 2023.3.X）のビルド間では互換性が維持されます。

• カスタムスクリプトを実行する – 有効にすると、ウォームアップ時にスクリプトで指定されたカスタムシェルスクリプトが実行されます。このスクリプトを使用して、プロジェクトの依存関係のインストールやプロジェクトのビルドなどを行うことができます。このスクリプトはスクリプトの作業ディレクトリで実行されます。IDE インデックスが作成された後に実行されることに注意してください。

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

• Cron トリガー –スケジュール通りにウォームアップを実行するをオンにして、ウォームアップスナップショットを作成するスケジュールを指定します。例: 毎日午前 3 時にスナップショットを作成できます（0 3 * * *）。

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

cron トリガーを待たずにウォームアップスナップショットを作成する場合は、「ウォームアップスナップショット」ページで「新しいウォームアップスナップショット」をクリックします。このページには、作成されたスナップショットのリストとそのステータスも表示されます。

次は

これで、名前空間を他のユーザーが利用できるようになります。CodeCanvas では、ユーザーは名前空間を直接操作することはできません。JetBrains Gateway クライアントでは、開発環境テンプレートのみが表示されます。作成したテンプレートに基づいて、ユーザーは開発環境を作成し、プロジェクトの作業を開始できます。その方法については、開発環境ユーザーとして始めるガイドを参照してください。