CodeCanvas を構成する

1. CodeCanvas インスタンスをアクティブ化する

1. ブラウザーで、インストール時に指定した CodeCanvas URL を開きます。

2. インストール中に指定されたシステム管理者の資格情報を使用して CodeCanvas にログインします。

3. ヘッダーナビゲーションで管理を選択し、サイドバーメニューで基本を選択します。

4. すでにライセンスキーをお持ちの場合は、それをライセンスキーフィールドに挿入し、保存をクリックします。

   

   ライセンスキーをまだお持ちでない場合は、ライセンスキーの取得方法に関する手順に従ってください。

2. （オプション）認証を設定する

CodeCanvas はデフォルトで組み込みの認証プロバイダーを使用し、ユーザーは CodeCanvas のユーザー名とパスワードでログインできます。インストール直後は、CodeCanvas にはインストール時に指定したシステム管理者アカウントが 1 つだけ組み込まれています。

次の 3 つのオプションがあります。

• 組み込みの認証プロバイダーを引き続き使用します。この場合、ユーザーアカウントはシステム管理者またはユーザー自身が手動で作成する必要があります。

• CodeCanvas を、Google、GitHub、SAML 2.0、LDAP、OpenID Connect に基づくその他のプロバイダーなどのサードパーティ認証プロバイダーを使用するように構成します。この場合、従業員はサードパーティシステムの既存のアカウントを使用して CodeCanvas にログインできます。

• 上記を任意に組み合わせて使用します。たとえば、組み込みの認証プロバイダーと GitHub の両方を使用するように CodeCanvas を構成できます。

サードパーティの認証プロバイダーを追加するには、システム管理者として CodeCanvas にログインし、管理 | Auth モジュールページでプロバイダーを構成します。

特定の認証プロバイダーを構成する方法の詳細な手順については、以下を参照してください。

• 内蔵認証モジュール

• Active Directory 認証モジュール

• GitHub 認証モジュール

• Google 認証モジュール

• JetBrains Hub 認証モジュール

• LDAP 認証モジュールを開く

• SAML 2.0 認証モジュール

• Azure AD 認証モジュール

• OpenID Connect 認証モジュール

3. 開発環境インスタンスタイプを作成する

インスタンスタイプとは、開発環境の割り当てに必要なリソース（CPU、メモリなど）とコンピューティングプラットフォーム（Kubernetes クラスターなど）を定義するプリセットです。たとえば、4 つの CPU と 16GB のメモリを備えた small インスタンスタイプ、6 つの CPU と 32GB のメモリを備えた medium インスタンスタイプなどを作成できます。名前空間管理者は、開発環境テンプレートを作成する際に適切なインスタンスタイプを選択できます。

1. ヘッダーナビゲーションで管理を選択し、サイドバーメニューでインスタンスタイプを選択します。

2. 新しいインスタンスタイプをクリックします。

3. インスタンスタイプ名前およびその他の設定を指定します。

   • コンピューティングプラットフォーム – 開発環境を起動するコンピューティングプラットフォーム (Kubernetes クラスターなど) への接続。

   • CPU、メモリ、音量 – 開発環境に割り当てられたリソース。

   • ボリュームストレージクラス – 各開発環境には、開発環境データが格納された Kubernetes ボリュームが関連付けられています。ここでは、そのようなボリュームを定義するカスタム StorageClass を指定できます。CodeCanvas はデフォルトのボリュームの代わりにそのボリュームを使用します。AWS EBS ボリュームを使用する場合は、最高のパフォーマンスを得るために io2 ベースのボリュームを使用することをお勧めします。

   • ボリュームスナップショットクラス – ウォームアップ中に、CodeCanvas はプロジェクトインデックス、依存関係などを含む開発環境ファイルシステムのスナップショットを作成します。ここで、このようなボリュームを定義するカスタム VolumeSnapshotClass を指定すると、CodeCanvas はデフォルトのボリュームの代わりに使用します。

   • 名前空間 – このインスタンスタイプが利用可能な名前空間です。すべての名前空間、または特定の名前空間を指定できます。まだ名前空間を作成していないため、すべての名前空間のままにしておきます。

4. デフォルトの IDE 設定を指定する

システム管理者は、開発環境で使用する IDE バージョンの組織全体のデフォルトを指定できます。プロジェクト管理者は、開発環境の設定でこれらのデフォルトを上書きできます。

1. CodeCanvas で、管理 | デフォルトの IDE バージョンを選択します。

2. インストール後、CodeCanvas は IDE の最新リリースバージョンを使用するように設定されます。各 IDE のデフォルトバージョンを選択するか、最新リリースのままにしておきます。特定のバージョンを使用する場合は、2023.3 以降を使用することをお勧めします。

   

3. 管理 | IDE フィードページでは、利用可能な IDE バージョンを提供するフィードを選択できます。これは、CodeCanvas クラスターがインターネットに接続されておらず、IDE バージョンを含むカスタムローカルフィードを使用したい場合に便利です。

5. （オプション）クリーンアップポリシーを構成する

システム管理者は、CodeCanvas が未使用のリソースをクリーンアップする方法を設定できます。

1. CodeCanvas で、管理 | クリーンアップポリシーを選択します。

2. クリーンアップ設定を指定します。

   • 開発環境 :

     • リマインダーしきい値 (日数) – 非アクティブ期間が経過すると、CodeCanvas から開発環境の所有者にメールによるリマインダーが送信されます。

     • 削除しきい値 (日数) – 非アクティブ期間が経過すると、CodeCanvas は開発環境を削除します。

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

     • 削除しきい値 (日数) – この期間中にウォームアップスナップショットから開発環境が開始されなかった場合、CodeCanvas はスナップショットを削除します。

6. 名前空間を作成する

名前空間とは、Git リポジトリ、シークレット、開発環境テンプレート、その他の設定といった関連リソースをグループ化する論理エンティティです。名前空間は、組織内のプロジェクト、プロジェクトグループ、チームを表すことができます。

組織内の名前空間の操作方法については、さまざまなポリシーが考えられます。

• デフォルト (システム管理者が名前空間を作成する)

  デフォルトでは、システム管理者が名前空間を作成し、名前空間管理者を割り当てます。このポリシーを使用する場合は、以下の手順に従ってください。

• セルフサービス (ユーザーが名前空間を作成する)

  ユーザーは自分で名前空間を作成できます。この場合、システム管理者はユーザーに名前空間を作成する権限を付与できます。このポリシーを使用する場合は、この手順をスキップして推奨事項に従ってください。

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

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

   

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

6. ユーザーの追加

6.1 （オプション）ロールと権限を編集する

CodeCanvas にユーザーアカウントを追加する前に、CodeCanvas におけるロールと権限の仕組みを理解しておくことが重要です。ロールと権限は管理 | ロールページで管理できます。

グローバルロールは CodeCanvas インスタンス全体に適用されます。

• システム管理者 – CodeCanvas 内のすべての管理タスクを実行できます。

• メンバー – 通常の CodeCanvas ユーザー。デフォルトでは、メンバーには名前空間を作成する権限がありませんが、この権限を付与することができます。付与した場合、メンバーは名前空間を作成し、そこで名前空間管理者になることができます。詳細は以下を参照してください。

名前空間ロールは特定の名前空間に適用されます。

• 名前空間管理者 – 開発環境テンプレートの作成、Git リポジトリの接続など、名前空間内のすべての管理タスクを実行できます。

6.3 名前空間管理者を割り当てる

名前空間の操作にデフォルトのポリシー (システム管理者が名前空間を作成する) を使用する場合は、名前空間管理者を割り当てる必要があります。

1. CodeCanvas で名前空間 | すべての名前空間を選択します

2. 管理者を割り当てる名前空間をクリックします。

3. サイドバーメニューで、アクセスを選択します。

4. 人を追加するをクリックし、管理者として割り当てるユーザーまたはユーザーグループを選択します。

次は

CodeCanvas インスタンスの基本設定が完了し、チームは作業を開始する準備が整いました。次は、名前空間管理者がチームのプロジェクト用に CodeCanvas を準備する番です。Git リポジトリへの接続、開発環境テンプレートの作成など、様々な作業が必要です。詳しくはプロジェクトの構成ガイドを参照してください。