JetBrains CodeCanvas 2024.1 Help

Installation

CodeCanvas is designed for on-premises deployment within Kubernetes (K8s) clusters. The minimum supported Kubernetes version is 1.27.

Supported cloud providers

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

Installation process

In general, during the CodeCanvas installation you should:

  1. Prepare the infrastructure – create a Kubernetes cluster for the CodeCanvas application and, optionally, a Kubernetes cluster for user dev environments. Configure external database and object storage and all other necessary resources and services listed in the installation prerequisites.

  2. Fill in the custom.values.yaml file (provided by JetBrains) with your custom configuration, replacing placeholders with correct values. This file will provide your values to the CodeCanvas Helm chart. In this file, you also specify your external database and object storage settings.

  3. Install the CodeCanvas Helm chart with helm upgrade. The command deploys CodeCanvas to your Kubernetes cluster.

  4. Connect your dev environment cluster to CodeCanvas via the user interface.

  5. If you have custom infrastructure requirements during the installation (custom network setup, Ingress configuration, etc.), check Optional Configuration.

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).

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.

Last modified: 17 May 2024