Remote Development Environment Setup

1 post · Jul 2016 – Mar 2025

What this trail covers

GitLab is evolving its Web IDE by replacing the Monaco-based editor with one built on VS Code to provide a richer IDE experience, including support for extensions and tighter integration with the DevOps workflow. The existing Web Editor will be improved to support multi-file editing for simpler use cases. The Remote Development category is being formed to tackle the missing runtime environment for compilation and testing. This post details the integration with Gitpod, enabling users to s

All GitLab trails

Mar 2025Build and run containers in Remote Development workspacesThis post details how to set up a Kubernetes cluster on AWS EKS with Sysbox for secure container building and running within GitLab Workspaces. It covers cluster creation, Sysbox installation and verification, GitLab agent configuration, sudo access setup, and Ingress Controller installation. It then guides users through installing Docker within a workspace, building a container image, and running it, demonstrating a practical workflow for containerized development in remote environments.
Feb 2025Create a workspace quickly with the GitLab default devfileIntroduces a default devfile for GitLab Workspaces, simplifying the creation of development environments by eliminating the need for custom devfiles at the repository root. This default devfile is available for all projects when creating a workspace, regardless of whether custom devfiles exist. It also reiterates the benefits of custom devfiles for project-specific needs.
Nov 2024Enable secure sudo access for GitLab Remote Development workspacesThis post details how to enable secure sudo access for GitLab Remote Development workspaces by configuring the GitLab agent for workspaces to use Sysbox, Kata Containers, or user namespaces. It provides specific configuration examples for each method and demonstrates how to install and use `jq` within a workspace after enabling sudo access.
May 2024Tutorial: Install VS Code on a cloud provider VM and set up remote accessThis post introduces a two-project GitLab CI/CD workflow for automating the setup of a remote VS Code development environment on a GCP VM. The first project uses Terraform to provision a GCP VM, and the second project installs VS Code and necessary dependencies on that VM. It also provides instructions for connecting to the remote VS Code instance from a local machine using SSH with X11 forwarding.
Aug 2023Behind the scenes of the Remote Development Beta releaseThis post details the technical process of merging a large integration branch for the Remote Development feature into the master branch. It highlights the use of feature flags, extensive CI/CD pipelines, and the creation of new database tables and GraphQL/REST APIs. The post also outlines the strategy for managing follow-up tasks through child epics and the resources provided to reviewers, including documentation of discussions in Slack channels and Zoom sessions. It also covers the application security review process and the successful database review.
Advertisement
Jul 2023Contributor how-to: Remote Development workspaces and GitLab Developer KitThis post details the technical challenges and solutions for running the GitLab Development Kit (GDK) within GitLab's Remote Development workspaces. It explains the process of cloning repositories, the memory limitations encountered with large projects like GitLab, and how to overcome them by using the GDK repository itself as the starting point. It also describes the creation of a pre-built container image for GDK to reduce initial setup time and the use of a script to generate the `gdk.yml` file dynamically based on workspace environment variables. The post provides the `.devfile.yaml` configuration and the bootstrap script for setting up GDK within the workspace.
Jul 2023Cloud infrastructure for on-demand development in GitLabThis post details the infrastructure setup for on-demand, cloud-based development environments using the GitLab agent for Kubernetes. It covers requirements like domain and TLS certificate management, setting up a GitLab OAuth application, configuring Kubernetes clusters on GKE, EKS, AKS, Civo, and self-managed instances, installing the workspaces proxy and the GitLab agent for Kubernetes, and creating workspaces with custom container images. It also includes troubleshooting tips and guidance on contributing.
Jun 2023Quickstart guide for GitLab Remote Development workspacesThis post provides a quickstart guide for GitLab Remote Development workspaces, detailing the prerequisites (Kubernetes cluster, GitLab agent configuration), locating a devfile, creating a workspace, installing dependencies, previewing the application, making code changes, committing, and exploring the demo. It highlights the use of the Web IDE (VS Code browser version) integrated into the workspace and the devfile's role in defining the development environment.
May 2023A first look at workspaces: On-demand, cloud-based development environmentsIntroduces 'Workspaces' as a new feature for on-demand, cloud-based development environments. Details the creation process involving a cloud platform/Kubernetes cluster, the GitLab Agent for Kubernetes, a `.devfile.yaml` for environment definition, and integration with the Web IDE. Highlights the ephemeral nature of workspaces (default 24 hours, up to a week) and the 'bring your own infrastructure' approach. Outlines future plans including credential injection, SSH access from desktop IDEs, and support for other editors.
Jan 2023The GitLab Quarterly: How our latest beta releases support developersThis post announces the beta release of GitLab Remote Development, highlighting its Web IDE Beta which uses a VS Code interface and provides an interactive terminal. It emphasizes the benefits of not managing local development environments, enabling zero-trust policies, and adhering to compliance requirements. The roadmap for this feature includes on-demand provisioning, multi-repo environment sharing, IDE flexibility, and advanced security controls.
Dec 2022A first look at the new GitLab Web IDE and remote development experienceThis post announces the beta launch of the new GitLab Web IDE, rebuilt on VS Code, and introduces the new Remote Development category. Key technical details include: the Web IDE's performance improvements (up to 80% reduction in memory usage), customizable interface, interactive terminal access to remote environments, and the ability to securely connect to these environments directly from the Web IDE. It also mentions the underlying technical work for the merge, including new database tables and APIs, and the use of feature flags.
May 2022The Future of the GitLab Web IDEThis post announces the decision to replace the current Web IDE with a VS Code-based editor. It details the rationale, including user feedback on missing features and the benefits of leveraging VS Code's ecosystem. It also outlines the plan to integrate the GitLab Workflow extension and explore making VS Code extensions available within the Web IDE. The post also mentions improvements to the core editing component for simpler edits and the formation of the Remote Development category to address runtime environments.
Jul 2021Teams speed up development with GitLab's Gitpod integrationThis post details the integration of GitLab with Gitpod, a cloud IDE. It explains how to set up Gitpod for a VueJS application, including disabling host checks for the development server and installing the GitLab workflow VS Code extension. It also provides an example of using Gitpod for a Hugo website, demonstrating how to configure the environment and automate server startup. The post highlights the benefits of cloud IDEs for onboarding and development speed.
Mar 2021Why do GitLab designers contribute to the codebase?This post details a designer's experience contributing to the GitLab codebase. It covers the challenges and process of setting up the GitLab Development Kit (GDK), using the Web IDE's interactive terminals for development, and migrating button components. The author also discusses the benefits of understanding the codebase for design decisions and proposes contributions like adding a UX reviewer to Danger bot and a shortcut for collapsible section markdown.
Sep 2020A tale of two file editorsThis post details a study on the usage of GitLab's single-file editor versus the Web IDE. It found that users purposefully select editors based on use case complexity: single-file for simple changes, and Web IDE for multi-file edits or changes requiring context. The research disproved the initial theory of a discoverability problem and led to proposed improvements, including consolidating the Edit and Web IDE buttons into a dropdown for user choice. Mockups for the proposed UI changes are included.
Jul 2020How we created a GitLab Workflow Extension for VS CodeThis post announces the official maintenance and support of the GitLab Workflow Extension for VS Code by GitLab. It details the transition from a community-driven project to an officially maintained tool, including an application security review, the creation of a security release process, and initial automation for publishing and testing. Version 3.0.0 is highlighted for resolving long-standing bugs. Future plans include triaging existing issues, capturing new bugs, focusing on the test-suite and code-quality, and improving contribution guides.
May 2020How to make small changes using GitLab’s Web IDEThis post demonstrates the end-to-end workflow of making a code change using the GitLab Web IDE, committing it, triggering a CI pipeline (leveraging Auto DevOps for zero-configuration), and deploying to a staging environment via Review Apps. It highlights the integration of security scans and test results into the merge request, and the final merge to production. The post emphasizes the ease of use for non-developers and the seamless integration with GitLab's CI/CD and version control features.
Jun 2018Meet the GitLab Web IDEThis post details the initial development of GitLab's Web IDE, starting from a proof-of-concept 'repo editor' to a minimal viable product. It describes the integration of the Monaco editor, the iterative design process for a three-pane layout, and the introduction of distinct editing and review states. The post highlights the technical challenges and design decisions involved in creating an integrated development environment within the GitLab UI, focusing on ease of use for both new and experienced developers.
Jul 2016Koding + GitLab: Contribute code fasterThis post announces an integration between Koding and GitLab to enable one-click IDE environment setup for GitLab projects, issues, and merge requests. The goal is to reduce the time developers spend on environment configuration and facilitate faster contribution and collaboration. It highlights a vision for a seamless development workflow from idea to production, integrating chat, issue tracking, IDE development, CI/CD, code review, and deployment.