DOCSEARCHbyAlgolia
Submit Docs

DevPod

website·Indexed 35 days ago

https://devpod.sh/docs/

An open-source tool used to create reproducible developer environments. DevPod allows developers to deploy containerized workspaces using a Desktop Application or CLI, supporting various providers such as GCP, AWS, and Docker. It integrates with IDEs like VS Code, Vim, and NeoVim to provide consistent development environments.

Tokens
19.1K
Snippets
107
Records
168
Agent score
67%

What's inside DevPod

  1. Overview of DevPod for reproducible developer environments

    DevPod is an open-source tool that creates reproducible developer environments based on the open DevContainer standard (devcontainer.json). It acts as a bridge between a local IDE and a development machine, allowing workspaces to be hosted locally, on remote machines, or in public/private clouds. Because it uses a consistent management layer, developers can switch between different hosting backends without changing their workflow. Key capabilities include support for VS Code and JetBrains IDEs (or any IDE via SSH), automatic shutdown of unused virtual machines to save costs, and the ability to create custom providers.

  2. Overview of DevPod

    DevPod is an open-source, client-only tool for creating and managing repeatable development environments. It allows developers to spin up environments based on the devcontainer.json standard or via automated project analysis. Because it is client-only, it requires no server-side setup and works with any infrastructure (local laptop, Kubernetes cluster, or cloud provider), any IDE, and any programming language. It supports both public and private repositories via git clone.

  3. Understand how DevPod manages Kubernetes workspaces

    DevPod manages Kubernetes workspaces by wrapping kubectl commands via the devpod-provider-kubernetes provider. Unlike standard machine deployments, it uses the Kubernetes control plane to establish a secure tunnel, eliminating the need to run a separate agent on the Kubernetes node.

  4. Configure DevPod workspaces using devcontainer.json

    DevPod uses the open devcontainer.json standard to customize development containers. This allows for consistent developer experiences across different providers (local, remote VMs, or Kubernetes). If no configuration is found, DevPod automatically detects the programming language and provides a default configuration. The configuration is compatible with VS Code Dev Containers and GitHub Codespaces.

  5. Understand DevPod providers

    Providers in DevPod are CLI programs that enable the creation, management, and execution of workspaces. They provide a flexible backend model, allowing DevPod to adapt to various environments. Each provider is defined via a provider.yaml file, which specifies the required options, configuration, binaries, and commands necessary to handle workspace lifecycles.

  6. Install DevPod Desktop application

    DevPod Desktop is available for multiple operating systems. Download the appropriate installer for your architecture:

    • MacOS Silicon/ARM: .dmg
    • MacOS Intel/AMD: .dmg
    • Windows: .msi
    • Linux: AppImage (Official) or tar.gz

    Windows Requirements: Requires WebView 2, which is typically pre-installed on recent Windows versions.

    Linux AppImage Requirements: Tested on Debian 12+, Ubuntu 22.04+, Fedora 36+, Opensuse Leap 15.3+, Opensuse Tumbleweed, and Archlinux. Requires glibc 2.35+ and the following libraries:

    • Ubuntu/Debian: sudo apt-get install fuse libfuse2 libopengl0 libfribidi0 libgles2-mesa
    • Fedora: sudo dnf install fuse fuse-libs libglvnd-egl libglvnd-opengl libglvnd-glx harfbuzz fontconfig fribidi libthai
    • Opensuse: sudo zypper in fuse libfuse2 libharfbuzz0 libfribidi0 libthai0

  7. Define helper binaries in a DevPod provider

    The binaries section in a provider.yaml allows you to specify helper binaries that DevPod should automatically download based on the user's operating system and architecture. Each binary entry must include the OS, architecture, download path (URL or local), and a SHA checksum for verification to ensure the integrity of the executed binary.
    binaries:
  AWS_PROVIDER:
    - os: linux
      arch: amd64
      path: https://github.com/loft-sh/devpod-provider-aws/releases/download/v0.0.1-alpha.15/devpod-provider-aws-linux-amd64
      checksum: d1e774419d90c3ed399963d9322d57bfdcee189767eabb076a2c2e926bfd9b8b
    - os: darwin
      arch: arm64
      path: https://github.com/loft-sh/devpod-provider-aws/releases/download/v0.0.1-alpha.15/devpod-provider-aws-darwin-arm64
      checksum: 82b6713069fa061ea59941600ed32a15f73806a9af3074d67a20ed367d18b2aa

  8. Understand DevPod's client-agent architecture

    DevPod uses a client-agent architecture to provision workspaces on any infrastructure. The DevPod client wraps conventional CLI tools (e.g., kubectl, docker, gcloud) to deploy the environment. During workspace creation, DevPod deploys an agent to both the host machine and the container itself. This agent provides a control plane for essential functions including port forwarding, credential forwarding, and log streaming. Because the client deploys its own agent, there are no version conflicts between the client and server, and users do not need to manage separate infrastructure.

  9. Define provider binaries and execution commands in provider.yaml

    In a DevPod provider configuration, the binaries section maps a provider identifier to a list of platform-specific binary downloads (including OS, architecture, path, and checksum). The exec section defines how DevPod invokes the provider binary for specific lifecycle actions such as initialization, creating, deleting, starting, stopping, and checking the status of a workspace.
    binaries:
  GCLOUD_PROVIDER:
    - os: linux
      arch: amd64
      path: https://github.com/loft-sh/devpod-provider-gcloud/releases/download/v0.0.1-alpha.10/devpod-provider-gcloud-linux-amd64
      checksum: 38f92457507563ee56ea40a2ec40196d12ac2bbd50a924d76f55827e96e5f831
    - os: linux
      arch: arm64
      path: https://github.com/loft-sh/devpod-provider-gcloud/releases/download/v0.0.1-alpha.10/devpod-provider-gcloud-linux-arm64
      checksum: 48e8dfa20962f1c3eb1e3da17d57842a0e26155df2b94377bcdf5b8070d7b17e
    - os: darwin
      arch: amd64
      path: https://github.com/loft-sh/devpod-provider-gcloud/releases/download/v0.0.1-alpha.10/devpod-provider-gcloud-darwin-amd64
      checksum: 43ee6ecb7855d282a0512ccf6055cce029895f173beb95a8c442f77560d26678
    - os: darwin
      arch: arm64
      path: https://github.com/loft-sh/devpod-provider-gcloud/releases/download/v0.0.1-alpha.10/devpod-provider-gcloud-darwin-arm64
      checksum: c2c2d57c5d48f22814f2393f61fd6a78bdc2cde7eabc3faffd8f35eaceec4422
    - os: windows
      arch: amd64
      path: https://github.com/loft-sh/devpod-provider-gcloud/releases/download/v0.0.1-alpha.10/devpod-provider-gcloud-windows-amd64.exe
      checksum: 9b81ec48c849f222aaf30f0cb85057d4e6619d1c0f787b27925c8b8adb431a58
exec:
  init: ${GCLOUD_PROVIDER} init
  command: ${GCLOUD_PROVIDER} command
  create: ${GCLOUD_PROVIDER} create
  delete: ${GCLOUD_PROVIDER} delete
  start: ${GCLOUD_PROVIDER} start
  stop: ${GCLOUD_PROVIDER} stop
  status: ${GCLOUD_PROVIDER} status

  10. Understand how DevPod builds workspaces from devcontainer.json

    DevPod builds OCI-compliant workspace images by parsing a devcontainer.json file and a git repository. It extracts the defined "features" from the devcontainer.json and appends them as build stages to the base Dockerfile. Depending on the configured driver, the image is built using Docker, BuildKit, or Kaniko and then deployed based on the provider context. To optimize subsequent builds or share environments with other developers, the resulting image can be pushed to a container registry for caching.

  11. Understand how DevPod deploys and connects to machines

    DevPod uses 'machine' providers (such as AWS, GCP, and DigitalOcean) to provision virtual machines (VMs) that host devcontainers. When executing devpod up, DevPod uses local environment credentials and the provider's CLI tool (e.g., aws or az) to set up the VM.

    Connectivity is established via secure tunnels to allow the DevPod CLI/UI to forward ports and connect a local IDE to the devcontainer via SSH. The DevPod agent starts an SSH server using the STDIO of the secure tunnel.

    Supported secure tunnels by provider include:

    • AWS: Instance Connect
    • Google Cloud (GCP): Cloud IAP (Identity-Aware Proxy)
    • Azure: Azure Bastion
    • Generic: SSH tunneling (if supported by the setup)
    # Example command to start a workspace and trigger machine deployment
devpod up

  12. Understand DevPod Workspaces

    A workspace in DevPod is a containerized development environment that bundles a project's source code with its necessary dependencies (e.g., compilers, debuggers). Workspaces are managed via DevPod providers, enabling a consistent experience across various environments including localhost, public cloud remote machines, or Kubernetes clusters. Workspaces can be stopped and restarted without losing state, allowing for persistent configuration changes and tool installations.