JetBrains CodeCanvas 2024.1 Help

Manage Dev Environments

View dev environments

To view all dev environments in CodeCanvas (system admin view)

  1. On the sidebar menu, select Administration, then Dev environments.

  2. Use filters on top of the page to choose environments by state, by IDE, by template, by namespace, by computing platform, and by owner.

To view all personal dev environments

  1. On the sidebar menu, select My dev environments.

  2. Use filters on top of the page to choose environments by state, by IDE, by template, by namespace, and by computing platform.

To view dev environments created within a namespace

  1. Find the namespace.

  2. On the sidebar menu, select Dev Environments.

    List of project dev environments
  3. Use filters on top of the page to choose environments by state, by IDE, by template, by namespace, by computing platform, and by owner (the result of this filter depends on your permissions).

To view dev environment logs and other details

  1. Find the namespace.

  2. On the sidebar menu, select Dev environments.

  3. Open the required dev environment.

  4. View the details:

    • The Timeline page is a chat channel where the dev environment posts messages about its current state.

    • The Logs page contains dev environment logs.

    To download logs, in the dev environment menu Menu, select Download logs.

    Dev environment details

To view your dev environments

  1. In Gateway, open the connection to your CodeCanvas instance.

  2. All your dev environments are listed on the Dev environments page. Here you can find specific environments by name and by namespace.

To view dev environment logs

  1. In Gateway, open the connection to your CodeCanvas instance.

  2. Find the required dev environment and click Download logs in its menu.

Stop and activate dev environments

To stop a dev environment

  1. Find the namespace.

  2. On the sidebar menu, select Dev environments.

  3. Find the required dev environment and click Stop.

    Stop dev environment

    CodeCanvas will initiate stopping the dev environment: save the contents of the working directory /mnt/jetbrains and user home directory /root to the dev environment storage, unmount the storage, and perform graceful shutdown for the container (docker stop). All uncommitted changes will be available after you restart the environment.

    All other directories aren't saved. For example, if, during your session, you installed additional tools with apt get, they won't survive stopping the environment. For this purpose, you should use custom dev environment images.

To activate a stopped dev environment

  1. Find the namespace.

  2. On the sidebar menu, select Dev environments.

  3. Find the required dev environment and select Reactivate in the dev environment menu.

To stop a dev environment

  1. In Gateway, open the connection to your CodeCanvas instance.

  2. Find the required dev environment and click Stop in its menu.

    Stop dev environment

    CodeCanvas will initiate stopping the dev environment: save the contents of the working directory /mnt/jetbrains and user home directory /root to the dev environment storage, unmount the storage, and perform graceful shutdown for the container (docker stop). All uncommitted changes will be available after you restart the environment.

    All other directories aren't saved. For example, if, during your session, you installed additional tools with apt get, they won't survive stopping the environment. For this purpose, you should use custom dev environment images.

To activate a stopped dev environment

  1. In Gateway, open the connection to your CodeCanvas instance.

  2. Find the required dev environment and click Activate in its menu.

Delete dev environments

  1. Find the namespace.

  2. On the sidebar menu, select Dev environments.

  3. Find the required dev environment and select Delete in the dev environment menu.

  1. In Gateway, open the connection to your CodeCanvas instance.

  2. Find the required dev environment and click Delete in its menu.

Dev environment states

State

Description

Starting

CodeCanvas is creating the dev environment. The environment is not yet accessible.

Active

The dev environment is up and running.

Stopping, Stopped

The dev environment wasn't used for more than 30 minutes, or you stopped it manually. The virtual machine is released, the dev environment disk is stored in the CodeCanvas cloud storage.

Failed

CodeCanvas failed to create the dev environment. Delete this environment and try creating a new one.

Last modified: 17 May 2024