Skip to content

About

External MicroSandbox runtime provider for Devsy

Resources

Stars

0 stars

Watchers

0 watching

Forks

Repository files navigation

MicroSandbox Provider for Devsy

Run Devsy workspaces in MicroSandbox microVMs.

External provider requires msb 0.7.13+. Built-in Devsy driver requires 0.7.2+ for provisioning, 0.7.7+ for recreate. The SDK upgrades the MSB_HOME database; update msb and provider together because older versions cannot use it.

Devsy 1.24.0+ supports the short name:

devsy provider add microsandbox

If the deprecated built-in provider already uses microsandbox, add --name microsandbox-external. Existing configurations are not migrated.

Empty/whitespace-only MSB_PATH and MSB_LIBKRUNFW_PATH use runtime discovery; select both paths together. Blank MSB_HOME, MSB_CONFIG_PATH, and MSB_AGENTD_PATH use MicroSandbox defaults.

Platforms: linux amd64/arm64, darwin arm64, windows amd64.

See website documentation and contributor guidance.

Podman image builds

Docker is the default image builder. To use Podman instead:

devsy provider set microsandbox --option MICROSANDBOX_IMAGE_BUILDER=podman
devsy workspace up /absolute/path/to/project --provider microsandbox --ide none

Use microsandbox-local instead for the local development provider. The option also accepts an executable path, without flags.

Keep connection and environment settings consistent so builds and imports use the same Podman image store. When using rootless Podman, do not use sudo: rootful Podman has a separate image store.

Before pulling an image that Devsy did not build, the provider checks for a local copy with image inspect. That check times out after 5 seconds. With the default docker, any failed check falls back to the registry. With any other value, only a missing image falls back; other failures, including a timeout, fail the workspace. Start Podman, or podman machine on macOS, before running a workspace.

Registry fallback uses Docker-compatible credentials and can ignore Podman's login file when a Docker configuration exists. For private images authenticated with podman login, run podman pull registry.example.com/team/image:tag before starting the workspace. The provider then imports the local image.

No Docker installation or compatibility symlink is needed. Podman builds images on the host; workspaces still run in MicroSandbox microVMs. Compose is not supported.

Local development

Use existing matching runtime/firmware with absolute paths:

export MSB_PATH=/absolute/path/to/msb
export MSB_LIBKRUNFW_PATH=/absolute/path/to/libkrunfw
unset DEVSY_HOME
mise install
mise run build:provider:dev
devsy provider add --use=false --name microsandbox-local "$PWD/dist/local/provider.yaml"
devsy provider init microsandbox-local
devsy workspace up /absolute/path/to/project --provider microsandbox-local --id local-test --ide none
devsy workspace ssh local-test --start-services=false --command 'uname -sm'
devsy workspace delete local-test --force

The host-only task builds for macOS arm64 or Linux amd64/arm64, keeps pinned executables, and isolates its runtime home in dist/m. Use short checkout paths for Unix sockets. It does not download runtimes or remove old builds. Rebuild, then refresh:

mise run build:provider:dev
devsy provider set-source --use=false microsandbox-local "$PWD/dist/local/provider.yaml"
devsy provider init microsandbox-local

Devsy older than v1.27.0 loses runtime paths with --disable-daemon.

Real VM tests need Hypervisor.framework or KVM and are not run on hosted CI. Run the conformance command in AGENTS.md locally before a release and when the runtime changes.

Creation errors redact request environment, label and bind source values, including devcontainer metadata and short values; SDK errors pass through unchanged. Provider generated user and workspace mount labels stay readable unless the same value also appears in a request environment variable or label.

License

MPL-2.0.

About

External MicroSandbox runtime provider for Devsy

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages