devpod-provider-multipass

README

Canonical Multipass provider for DevPod

Prerequisites

• Install Multipass
• Install DevPod

Getting started

The provider is available for auto-installation using DevPod CLI

devpod provider add minhio/devpod-provider-multipass
devpod provider use minhio/devpod-provider-multipass

Or the desktop app

Customize the Multipass Instance

This provider has the following options

NAME	REQUIRED	DESCRIPTION	DEFAULT
MULTIPASS_PATH	true	Path to multipass binary.	multipass
MULTIPASS_IMAGE	true	Image to launch.	lts
MULTIPASS_CPUS	true	Number of CPUs to allocate.	2
MULTIPASS_DISK_SIZE	true	Disk space to allocate.	40G
MULTIPASS_MEMORY	true	Amount of memory to allocate.	2G
MULTIPASS_MOUNTS	false	Comma separated list of mounts.

See https://multipass.run/docs/launch-command for more detailed description of options.

MULTIPASS_MOUNTS is a comma separated list of <absolute-local-path:instance-path>.

• Relative <instance-path> will be mounted in the /home/devpod directory.
• If <instance-path> is omitted, the mount point will be the same as the <absolute-local-path>.

Examples:

• /Users/minh/.config:/home/devpod/.config -> local path /Users/minh/.config to instance path /home/devpod/.config
• /Users/minh -> local path /Users/minh to instance path /Users/minh
• /Users/minh/.aws:.aws -> local path /Users/minh/.aws to instance path /home/devpod/.aws

The MULTIPASS_MOUNTS option enable users to mount local path to devcontainer via the multipass instance.

For example, to mount user's local ~/.aws directory to the devcontainer:

• Set MULTIPASS_MOUNTS=/Users/minh/.aws:/home/devpod/.aws
• Configure devcontainer mounts

{
    "name": "Ubuntu",
    "image": "mcr.microsoft.com/devcontainers/base:jammy",
    "mounts": [
        "source=/home/devpod/.aws,target=/home/vscode/.aws,type=bind,consistency=cached"
    ]
}