Installation

TL;DR

CodeCanvas supports several installation types depending on your goals and team setup.

• Quickest way to evaluate CodeCanvas

  Use the AWS CloudFormation installation if you want to try CodeCanvas with minimal setup. It creates all components in a single EKS cluster using a simple web wizard in less than 10 minutes.

• Evaluation in your existing cluster

  Use the single-cluster installation via a Helm chart if you want to evaluate CodeCanvas in a Kubernetes cluster you already have, or if you're on a cloud provider other than AWS (e.g., Azure AKS or Google GKE). It's suitable for small-scale or proof-of-concept setups and can be later extended by connecting a separate cluster for dev environments.

• Production use

  Use the multi-cluster installation via a Helm chart when running in production or across regions. The CodeCanvas application and dev environments are deployed to separate clusters, enabling better scalability and team distribution.

The table below summarizes the available installation options for each supported cloud provider.

Before you proceed

Before you proceed with CodeCanvas installation, we strongly recommend that you read about the CodeCanvas architecture. This will help you understand the main CodeCanvas components and the requirements for your future installation.

Installation types

You can install CodeCanvas in two ways, depending on your infrastructure and scalability needs.

Single-cluster installation

CodeCanvas application and dev environment infrastructure (dev environment cluster operator, Relay, and Jump servers) are installed in a single Kubernetes cluster.

Best for	Pros	Cons
Quick setup for evaluation or proof-of-concept	A bit faster initial setup Single cluster to manage	Less scalable (*) Limited to a single region (*) Single point of failure (*)

(*) Important! A single-cluster installation doesn't limit future expansion. As your organization grows, you can add additional dev environment clusters in different regions or availability zones. This allows you to transition into a multi-cluster installation, where dev environments run across multiple clusters while still being managed by the central CodeCanvas application.

Multi-cluster installation

CodeCanvas application and dev environment infrastructure are deployed in separate clusters, with optional additional clusters for Relay and Jump servers.

Best for	Pros	Cons
Production deployments High availability and fault tolerance	Scalable Optimized performance (compute resources per region) Fault-tolerant	Multiple clusters to manage

Supported cloud providers

Currently, you can install CodeCanvas on Kubernetes clusters hosted in:

• Amazon EKS (Elastic Kubernetes Service)

• Azure AKS (Azure Kubernetes Service)

• Google GKE (Google Kubernetes Engine)

Limitations

• CodeCanvas components require certificates for secure communication with each other over HTTPS. Currently, CodeCanvas doesn't support certificates issued by a custom Certificate Authority (CA).