Skip to content

Workspaces

DETAILS: Tier: Premium, Ultimate Offering: GitLab.com, Self-managed, GitLab Dedicated

A workspace is a virtual sandbox environment for your code in GitLab. You can use workspaces to create and manage isolated development environments for your GitLab projects. These environments ensure that different projects don't interfere with each other.

Each workspace includes its own set of dependencies, libraries, and tools, which you can customize to meet the specific needs of each project.

For a click-through demo, see GitLab workspaces.

Workspaces and projects

Workspaces are scoped to a project. When you create a workspace, you must:

  • Assign the workspace to a specific project.
  • Select a project with a devfile.

The workspace can interact with the GitLab API, with the access level defined by current user permissions. A running workspace remains accessible to the user even if user permissions are later revoked.

Manage workspaces from a project

To manage workspaces from a project:

  1. On the left sidebar, select Search or go to and find your project.
  2. In the upper right, select Edit.
  3. From the dropdown list, under Your workspaces, you can:
    • Restart, stop, or terminate an existing workspace.
    • Create a new workspace.

WARNING: When you terminate a workspace, any unsaved or uncommitted data in that workspace is deleted and cannot be recovered.

Deleting resources associated with a workspace

When you terminate a workspace, all resources associated with the workspace are deleted. When you delete a project, agent, user, or token associated with a running workspace:

  • The workspace is deleted from the user interface.
  • In the Kubernetes cluster, the running workspace resources become orphaned and are not automatically deleted.

To clean up orphaned resources, an administrator must manually delete the workspace in Kubernetes.

Issue 414384 proposes to change this behavior.

Manage workspaces at the agent level

To manage all workspaces associated with an agent:

  1. On the left sidebar, select Search or go to and find your project.
  2. Select Operate > Kubernetes clusters.
  3. Select the agent configured for remote development.
  4. Select the Workspaces tab.
  5. From the list, you can restart, stop, or terminate an existing workspace.

WARNING: When you terminate a workspace, any unsaved or uncommitted data in that workspace is deleted and cannot be recovered.

Identify an agent from a running workspace

In deployments that contain multiple agents, you might want to identify an agent from a running workspace.

To identify an agent associated with a running workspace, use one of the following GraphQL endpoints:

  • agent-id to return the project the agent belongs to.
  • Query.workspaces to return:
    • The cluster agent associated with the workspace.
    • The project the agent belongs to.

Devfile

A devfile is a file that defines a development environment by specifying the necessary tools, languages, runtimes, and other components for a GitLab project.

Workspaces have built-in support for devfiles. The default location is .devfile.yaml, but you can also use a custom location. The devfile is used to automatically configure the development environment with the defined specifications.

This way, you can create consistent and reproducible development environments regardless of the machine or platform you use.

Validation rules

  • schemaVersion must be 2.2.0.
  • The devfile must have at least one component.
  • For components:
    • Names must not start with gl-.
    • Only container and volume are supported.
  • For commands, IDs must not start with gl-.
  • For events:
    • Names must not start with gl-.
    • Only preStart is supported.
  • parent, projects, and starterProjects are not supported.
  • For variables, keys must not start with gl-, gl_, GL-, or GL_.

container component type

Use the container component type to define a container image as the execution environment for a workspace. You can specify the base image, dependencies, and other settings.

The container component type supports the following schema properties only:

Property Description
image Name of the container image to use for the workspace.
memoryRequest Minimum amount of memory the container can use.
memoryLimit Maximum amount of memory the container can use.
cpuRequest Minimum amount of CPU the container can use.
cpuLimit Maximum amount of CPU the container can use.
env Environment variables to use in the container. Names must not start with gl-.
endpoints Port mappings to expose from the container. Names must not start with gl-.
volumeMounts Storage volume to mount in the container.

Example configurations

The following is an example devfile configuration:

schemaVersion: 2.2.0
variables:
  registry-root: registry.gitlab.com
components:
  - name: tooling-container
    attributes:
      gl/inject-editor: true
    container:
      image: "{{registry-root}}/gitlab-org/remote-development/gitlab-remote-development-docs/ubuntu:22.04"
      env:
        - name: KEY
          value: VALUE
      endpoints:
        - name: http-3000
          targetPort: 3000

For more information, see the devfile documentation. For other examples, see the examples projects.

This container image is for demonstration purposes only. To use your own container image, see Arbitrary user IDs.

Workspace container requirements

By default, workspaces inject and start the GitLab VS Code fork in the container that has a defined gl/inject-editor attribute in the devfile. The workspace container where the GitLab VS Code fork is injected must meet the following system requirements:

  • System architecture: AMD64
  • System libraries:
    • glibc 2.28 and later
    • glibcxx 3.4.25 and later

These requirements have been tested on Debian 10.13 and Ubuntu 20.04. For more information, see the VS Code documentation.

Workspace add-ons

The GitLab Workflow extension for VS Code is configured by default in workspaces.

With this extension, you can view issues, create merge requests, and manage CI/CD pipelines. This extension also powers AI features like GitLab Duo Code Suggestions and GitLab Duo Chat.

For more information, see GitLab Workflow extension for VS Code.

Extension marketplace

  • Introduced in GitLab 16.9 with a flag named allow_extensions_marketplace_in_workspace. Disabled by default.

FLAG: The availability of this feature is controlled by a feature flag. For more information, see the history.

When allow_extensions_marketplace_in_workspace is enabled, you can use the extension marketplace in workspaces. An administrator can enable or disable the flag for top-level groups only.

The extension marketplace connects to the Open VSX Registry.

Personal access token

When you create a workspace, you get a personal access token with write_repository and api permissions. This token is used to initially clone the project while starting the workspace and to configure the GitLab Workflow extension for VS Code.

Any Git operation you perform in the workspace uses this token for authentication and authorization. When you terminate the workspace, the token is revoked.

The GIT_CONFIG_COUNT, GIT_CONFIG_KEY_n, and GIT_CONFIG_VALUE_n environment variables are used for Git authentication in the workspace. Support for these variables was added in Git 2.31, so the Git version you use in the workspace container must be 2.31 and later.

Pod interaction in a cluster

Workspaces run as pods in a Kubernetes cluster. GitLab does not impose any restrictions on the manner in which pods interact with each other.

Because of this requirement, you might want to isolate this feature from other containers in your cluster.

Network access and workspace authorization

It's the client's responsibility to restrict network access to the Kubernetes control plane because GitLab does not have control over the API.

Only the workspace creator can access the workspace and any endpoints exposed in that workspace. The workspace creator is only authorized to access the workspace after user authentication with OAuth.

Compute resources and volume storage

When you stop a workspace, the compute resources for that workspace are scaled down to zero. However, the volume provisioned for the workspace still exists.

To delete the provisioned volume, you must terminate the workspace.

Arbitrary user IDs

You can provide your own container image, which can run as any Linux user ID.

It's not possible for GitLab to predict the Linux user ID for a container image. GitLab uses the Linux root group ID permission to create, update, or delete files in a container. The container runtime used by the Kubernetes cluster must ensure all containers have a default Linux group ID of 0.

If you have a container image that does not support arbitrary user IDs, you cannot create, update, or delete files in a workspace. To create a container image that supports arbitrary user IDs, see Create a custom workspace image that supports arbitrary user IDs.

For more information, see the OpenShift documentation.