Amazon EKS へのシングルクラスタインストール (Helm)

1. PostgreSQL データベースをセットアップする

CodeCanvas では、CodeCanvas アプリケーションデータ用に PostgreSQL データベースが必要です。

1. PostgreSQL サーバーをインストールします（バージョン 12.2 – 15.12 がサポートされています）。サーバーは CodeCanvas アプリケーションクラスターからアクセスできる必要があります。たとえば、同じクラスター内にサーバーと同じ pod を作成できます。

2. CodeCanvas アプリケーション専用のデータベースを作成します。

3. インストールを続行する前に、データベースサーバーが起動して実行されていることを確認してください。

2. AWS S3 バケットを作成する

CodeCanvas とユーザーデータを保存するための AWS S3 バケットを作成します。

3. CodeCanvas アプリケーションクラスターを準備する

CodeCanvas アプリケーションクラスターは、CodeCanvas アプリケーションと関連サービスをホストします。CodeCanvas アーキテクチャの詳細

1. Amazon EKS クラスター

   次の要件を満たす CodeCanvas アプリケーション用の Amazon EKS クラスターをセットアップします。

   要件	説明
   Helm	バージョン 3.8.0 以降
   Kubernetes	バージョン 1.29 以降
   CodeCanvas アプリケーションノード	CodeCanvas アプリケーションとメインコンポーネントを実行するノード。 Linux OS (x86_64) を搭載したノードが 4 つ以上。推奨最小リソース: CPU コア 4 個、メモリ 8GB
   開発環境ノード	開発環境用のワーカー pods を実行するノード。 開発環境を実行するのに十分なノード（それぞれ Linux OS（Ubuntu、x86_64）搭載）が必要です。推奨最小リソース: CPU コア 4 個、メモリ 8GB。以下の推奨事項をご確認ください。

   ノードに関する主な推奨事項

   • 一般的なノード要件

     Linux OS (Ubuntu、x86_64)、推奨最小リソース: 4 つの vCPU と 8 GB のメモリ。

   • 自動スケーリングを構成する

     自動スケーリングを使用して、負荷に応じてノード数を調整します。通常の使用状況をカバーするのに十分な最小ノード数から開始し、ピーク時には自動スケーリングによってノードを追加できます。自動スケーリングに関する推奨事項を参照してください。

   • リソースを見積もる

     通常およびピーク時の同時使用率（同時環境の平均数と最大数）を見積もります。例: ピーク時のアクティビティで 20 人の開発者がそれぞれ 2 ～ 3 の開発環境を使用する場合、ピーク時の需要は 60 のアクティブ環境になります。

     合計リソース要件を計算します。例: 一般的な開発環境が 4 つの vCPU と 16 GB のメモリである場合、60 の開発環境では 240 の vCPU と 960 GB のメモリが必要になります。

     重要: Kubernetes は、kubelet、aws-node などのシステムタスクのために各ノードのリソースの一部を必要とします。Kubernetes システムタスク用に、ノードごとに約 0.2 vCPU と 1 ～ 2GB のメモリを予約する必要があります。正確な値はインストールによって異なります。実際のノードリソース使用量を確認するには、kubectl describe node <node-name> を実行してください。

   • ノード割り当て戦略を選択する

     • 1 つのノード – 1 つの開発環境

       1 つのノード（AWS インスタンス）は、1 つの開発環境（ワーカー、pod）のみをホストします。この例では、60 個の開発環境（たとえば、m5.xlarge インスタンス（それぞれ 4 つの vCPU と 16GB のメモリを搭載））には、60 個の個別のノードが必要になります。

       • (+) オーバープロビジョニングなし: 各ノードは単一の開発環境によって完全に利用されます。

       • (+) フォールトトレランス: ノードに障害が発生した場合、影響を受ける開発環境は 1 つだけです。

       • (-) オーバーヘッドの増加: Kubernetes は各ノードのリソースの一部をシステムタスクに使用します。そのため、この例では各開発環境に 4 つの vCPU と 16GB のメモリが割り当てられますが、開発者が利用できるのは 3.8 つの vCPU と 14 ～ 15GB のメモリのみです。残りの 0.2vCPU と 1 ～ 2GB のメモリは Kubernetes のシステムタスクによって使用され、結果として 60 * (0.2 の vCPU と 1 ～ 2GB = 12vCPU と 60 ～ 120GB のオーバーヘッドが発生します。この問題は、より大きなインスタンスを使用することで解決できます。

       • (-) 起動時間が遅い: オートスケーラーは、新しい開発環境ごとに新しいノードをプロビジョニングする必要があります。

     • 1 つのノード – 複数の開発環境

       1 つのノード（AWS インスタンス）が複数の開発環境（ワーカー、pods）をホストしています。60 の開発環境（合計 240 個の vCPU、960GB のメモリ）の例では、この負荷を m5.16xlarge （64 個の vCPU、256GB のメモリ）や m5.12xlarge （48 個の vCPU、192GB のメモリ）など、4 ～ 6 個のノードに分割できます。

       • (-) オーバープロビジョニング: 実行されている開発環境の数がノードに対応できる数より少ない場合、リソースが無駄になります。

       • (-) フォールトトレランス: ノードに障害が発生すると、複数の開発環境に影響がおよびます。

       • (+) オーバーヘッドの低減: 複数の開発環境が同じノードを共有するため、Kubernetes システムタスク（ノードあたり 0.2 vCPU と 1 ～ 2GB のメモリ）のオーバーヘッドが削減されます。この例では、4 ～ 6 ノードの場合、オーバーヘッドは 4 – 6 * (0.2 vCPU と 1 ～ 2GB = 0.8 – 1.2 vCPU と 4 ～ 12GB のメモリとなります。「1 ノード – 1 開発環境」戦略の場合の 12 vCPU と 60 ～ 120GB のオーバーヘッドと比較してみてください。

       • (+) 起動時間の短縮: ノードに使用可能なリソースがある場合、新しいノードがプロビジョニングされるのを待たずに、新しいワーカー pods をすぐに起動できます。

       • (+) 潜在的なコスト削減: 少数の大規模インスタンスを使用する方が、多数の小規模インスタンスを使用するよりもコスト効率が高く（数倍安価）、コスト削減につながります。ただし、これはリソース使用量をどれだけ正確に予測できるか、開発環境をノードにどれだけ効率的に配置できるかに左右されます。

   • Amazon インスタンスタイプを選択する

     AWS インスタンスタイプを比較して選択するには、公式の AWS ドキュメント(英語)を使用します。

     t、-series インスタンス（例: t3、t4g）は持続的なパフォーマンスを想定して設計されていないため、使用を避けてください。代わりに、m や c シリーズなど、パフォーマンスレベルが固定されたインスタンスの使用を検討してください。

2. 名前空間

   CodeCanvas アプリケーション専用の名前空間を作成します (NAMESPACE_PLACEHOLDER を実際の名前空間名に置き換えます)。

   kubectl create namespace NAMESPACE_PLACEHOLDER

3. Ingress コントローラー

   Kubernetes のセットアップと互換性のある Ingress コントローラーをインストールします。このガイドでは、ingress-nginx(英語) コントローラーを使用します。

4. CSI ドライバー

   ebs.csi.aws.com CSI ドライバをクラスタにインストールします。インストール手順については、AWS ドキュメント(英語)を参照してください。CodeCanvas の CSI について詳しく見る

5. CSI スナップショットコントローラー

   Kubernetes スナップショット操作を有効にするには、クラスターに CSI スナップショットコントローラーをインストールします。AWS マネージドアドオンを使用するか、手動でインストールできます。

6. ストレージクラス

   開発環境で使用する永続ボリュームをプロビジョニングするための Kubernetes StorageClass を作成します。以下の推奨構成を使用することも、パフォーマンスやコストの好みに応じて独自の構成を定義することもできます。推奨構成では、16,000 IOPS と 750 MB/ 秒のスループットを備えた AWS gp3 ボリュームを使用し、開発環境のパフォーマンスを保証します。

   開発環境クラスターには複数のストレージクラスを設定できます。インスタンスタイプを作成する際に、利用可能なストレージクラスから選択できます。

   1. storage-class.yaml ファイルを作成し、以下のスニペットをコピーします。

      apiVersion: storage.k8s.io/v1 kind: StorageClass metadata: name: codecanvas-storage # You can change this name mountOptions: - debug parameters: type: gp3 iops: "16000" throughput: "750" provisioner: ebs.csi.aws.com allowVolumeExpansion: true reclaimPolicy: Delete volumeBindingMode: WaitForFirstConsumer

   2. 構成をクラスターに適用します。

      kubectl apply -f storage-class.yaml

7. ボリュームスナップショットクラス

   Kubernetes VolumeSnapshotClass を作成して、開発環境で使用される永続ボリュームのスナップショットサポートを有効にします。以下の推奨ボリュームスナップショットクラス構成をご利用いただけます。

   開発環境クラスターには複数のボリュームスナップショットクラスを設定できます。インスタンスタイプを作成する際に、利用可能なクラスから選択できます。

   1. snapshot-class.yaml ファイルを作成し、以下のスニペットをコピーします。

      apiVersion: snapshot.storage.k8s.io/v1 kind: VolumeSnapshotClass metadata: name: codecanvas-volume-snapshot # You can change this name driver: ebs.csi.aws.com deletionPolicy: Delete

   2. 構成をクラスターに適用します。

      kubectl apply -f snapshot-class.yaml

8. CSI スナップショット検証 Webhook

   Kubernetes スナップショット検証を実装する CSI ドライバーのアドオンをインストールします。手順については、Kubernetes のドキュメント(英語)を参照してください。v6.2.2 でテスト済みです。

4. DNS と TLS を構成する

1. ドメイン名

   CodeCanvas インスタンスのドメイン名を登録します (例: codecanvas.example.com)。

2. DNS ゾーン

   DNS レコードを管理するには、CodeCanvas アプリケーションクラスターに ExternalDNS(英語) をインストールします。

3. TLS 証明書

   暗号化しましょうによって発行された TLS 証明書を管理するには、CodeCanvas アプリケーションクラスターに cert-manager(英語) をインストールします。

4. サブドメイン

   CodeCanvas アプリケーションコンポーネントのサブドメインを設定します。 custom.values.yaml の設定では、以下の DNS ドメイン名スキームが想定されています。

   • EXTERNAL_DOMAIN_PLACEHOLDER – メインの管理 UI と REST API を提供する CodeCanvas アプリケーションのメインドメイン。例: codecanvas.example.com

   • computeservice.EXTERNAL_DOMAIN_PLACEHOLDER – compute-service REST API（Kubernetes オペレーター用）を提供するサブドメイン。これは通常、開発環境 pods からのみアクセスされる内部ドメインです。

   • gateway.EXTERNAL_DOMAIN_PLACEHOLDER – gateway-relay サービス（リレーサーバー）を提供します。これは、ユーザーの IDE クライアントがアクセスする外部ドメインです。

   • ssh.EXTERNAL_DOMAIN_PLACEHOLDER – jump-server サービス（移動サーバー）の SSH サービスを提供します。これは、ユーザーの IDE クライアントがアクセスする外部ドメインです。

5. IAM ロールと権限を設定する

CodeCanvas に AWS のストレージバケットへのアクセスを許可するには、静的認証情報またはサービスアカウントの IAM ロール (IRSA) のいずれかを使用できます。IRSA の使用をお勧めします。

CodeCanvas アプリケーションサービスアカウントに IRSA ロールを設定します。CodeCanvas にはバケットへの書き込み権限が必要です。IRSA の設定方法の詳細については、AWS ドキュメント(英語)を参照してください。

6. （オプション）SMTP サーバーを構成する

CodeCanvas は、ユーザー作成時の招待リンク、メール認証、その他の通知など、様々なメールをユーザーに送信するために SMTP サーバーを使用します。この機能を有効にするには、CodeCanvas アプリケーションクラスターからアクセスできる SMTP サーバーを用意してください。

1. custom.values.yaml を作成する

custom.values.yaml を作成し、以下のスニペットをコピーしてください。プレースホルダーは次の手順で実際の値に置き換えます。

2. CodeCanvas アプリケーションに AWS IRSA ロールを割り当てる

custom.values.yaml で、CODECANVAS_IRSA_ARN を、CodeCanvas アプリケーションが使用する AWS IRSA ロールの実際の ARN に置き換えます。

3. 外部ドメインを指定

custom.values.yaml では、すべての EXTERNAL_DOMAIN_PLACEHOLDER プレースホルダーを CodeCanvas インスタンスに登録したドメイン名に置き換えます。

4. cert-manager を設定する

custom.values.yaml では、すべての CERT_MANAGER_NAME_PLACEHOLDER プレースホルダーをクラスターで使用されている cert-manager(英語) の名前に置き換えます。

5. データベース設定を指定する

CodeCanvas をインストールすると、外部の PostgreSQL データベースを使用することになります。任意の PostgreSQL データベースを使用できますが、Amazon RDS の使用をお勧めします。

6. オブジェクトストレージ設定を指定する

このインストールでは、ユーザーデータを保存するために AWS S3 バケットを使用することを意味します。

CodeCanvas が S3 オブジェクトストレージにアクセスすることを承認するには、静的認証情報を使用するか、サービスアカウントの IAM ロール (IRSA) を使用するかのいずれかの方法で承認する必要があります。IRSA の使用をお勧めします。

7. マスターシークレットを作成する

CodeCanvas アプリケーションは、ユーザーシークレット（外部サービスへの認証情報など）を暗号化された形式でデータベースに保存します。これらのデータの暗号化と復号には、マスターシークレットが使用されます。

マスターシークレットは、任意の Base64 エンコード文字列にすることができます。例: openssl を使用してランダムな文字列を生成できます。

1. マスターシークレットを生成するには、以下を実行します。

   openssl rand -base64 32

2. custom.values.yaml で、MASTER_SECRET_PLACEHOLDER を生成された値に置き換えます。

8. （オプション）システム管理者アカウントを構成する

システム管理者アカウントは、インストール後に CodeCanvas へのログインと設定に使用されます。認証情報は手動で入力することも、システムによって自動生成することもできます。

1. 管理者アカウントを手動で設定するには、custom.values.yaml で次の行を置き換えます。

   • 必要な管理者資格情報を持つ ADMIN_USERNAME_PLACEHOLDER および ADMIN_PASSWORD_PLACEHOLDER

   • CodeCanvas からの管理者通知を受信するためのメールアドレスを持つ ADMIN_EMAIL_PLACEHOLDER

あるいは、custom.values.yaml から localAdministrator.username と localAdministrator.password のセクションを削除することもできます。この場合、デフォルトのユーザー名は admin になり、インストール時にランダムなパスワードが生成されます（チャートのデプロイ後に表示されます）。ただし、ADMIN_EMAIL_PLACEHOLDER の代わりにメールアドレスを指定する必要があります。

9. Ingress クラスを指定する

custom.values.yaml で、すべての INGRESS_CLASS_PLACEHOLDER プレースホルダーを、CodeCanvas アプリケーションクラスターに使用される Ingress クラスに置き換えます。

10. (オプション) CodeCanvas pod の Kubernetes サービスアカウントを指定する

アプリケーションクラスタにサービスアカウントを設定し、そのサービスアカウント名を Helm リリース名とは別のものにしたいとします。その場合、CodeCanvas Helm チャートが作成する Kubernetes サービスアカウントに特定の名前を指定する必要があるかもしれません。手順は以下のとおりです。

1. custom.values.yaml の対応するセクションに次のパラメーターを追加します。

   application: serviceAccount: name: "CODECANVAS_KSA_NAME"

2. CODECANVAS_KSA_NAME をサービスアカウントの希望の名前に置き換えます。

11. (オプション) Sysbox コンテナーランタイムを構成する

デフォルトでは、CodeCanvas はワーカーコンテナーを --privileged モードで実行します（コンテナーはホストノード上でルート権限を持ちます）。セキュリティ上の理由からこれを回避したい場合は、こちらの説明に従って Sysbox Container Runtime をインストールしてください。

12. コンピューティングプラットフォームを構成する

CodeCanvas におけるコンピューティングプラットフォームは、開発環境を実行するインフラストラクチャを表します。これは、CodeCanvas オペレーター、Relay、踏み台サーバーを含む Kubernetes クラスターで構成されます。

• リレーサーバー – ユーザーマシン上の JetBrains Client と開発環境（SSL/TLS 経由）間の中継。リレーがなければ、JetBrains IDE を開発環境で使用することはできません。

• 移動サーバー – 開発環境の SSH デーモンとユーザーマシン間の間接 SSH 接続のための中間サーバー。移動サーバーがないと、ユーザーは SSH を使用して開発環境に接続したり、リモート開発に VS Code/Cursor を使用したりすることができません。

• CodeCanvas 演算子 –ワーカーインスタンス (開発環境を実行する pods) のライフサイクルを管理します。Kubernetes API と対話して、ワーカーインスタンスを作成、監視、削除します。

13. ライセンス契約に同意する

custom.values.yaml では、ACCEPTANCE_PLACEHOLDER を true に置き換えて、CodeCanvas ライセンス契約(英語)を明示的に受け入れます。

14. CodeCanvas チャートをインストールする

custom.values.yaml にパラメータープレースホルダーが残っていないことを確認してください。すべてが正しく入力されている場合は、以下を実行してください。

ここに:

• NAMESPACE_PLACEHOLDER は Kubernetes の名前空間です

• codecanvas は Helm のリリース名です。必要に応じて変更できます。

1. CodeCanvas pods の状態を確認する

実行:

すべての pods は Running 状態である必要があります。平均して、デプロイから pod がアクティブになるまで約 2 分かかります。

pods が Running でない場合は、次のコマンドを実行して原因を見つけてみてください。

および

2. ドメイン名解決の検証

ドメイン名は Ingress ロードバランサーに解決される必要があります。これは次のコマンドで確認できます。

出力にはエラーが含まれていてはなりません。

3. CodeCanvas アプリケーションを確認する

ブラウザーで CodeCanvas インスタンスを開きます。CodeCanvas にログインする際は、インストール時に提供された管理者の資格情報を使用してください。