diff --git a/providers/microsandbox/provider.yaml b/providers/microsandbox/provider.yaml index 177fc99d10..a01a51eaa7 100644 --- a/providers/microsandbox/provider.yaml +++ b/providers/microsandbox/provider.yaml @@ -3,7 +3,7 @@ version: v1.0.0 icon: https://dl.devsy.sh/assets/devsy.svg home: https://github.com/devsy-org/devsy description: |- - Devsy on Microsandbox + Deprecated. Add the external MicroSandbox provider with an unused name: devsy provider add microsandbox --name microsandbox-external. optionGroups: - options: - MICROSANDBOX_MEMORY diff --git a/sites/docs-devsy-sh/content/docs/managing-providers/manage-providers.mdx b/sites/docs-devsy-sh/content/docs/managing-providers/manage-providers.mdx index 25a9790a85..db53740db2 100644 --- a/sites/docs-devsy-sh/content/docs/managing-providers/manage-providers.mdx +++ b/sites/docs-devsy-sh/content/docs/managing-providers/manage-providers.mdx @@ -80,29 +80,23 @@ provider repository for cloud-init and image selection setup. ### MicroSandbox -Install the external provider from its release manifest: +Install the external provider and create a workspace: ```sh -devsy provider add --name microsandbox-external https://github.com/devsy-org/devsy-provider-microsandbox/releases/latest/download/provider.yaml +devsy provider add microsandbox +devsy workspace up . --provider microsandbox ``` -A successful add initializes the provider and makes it the default. To install it without initialization or changing the default, add `--use=false` and then run `devsy provider init microsandbox-external` before creating a workspace. - -The [MicroSandbox guide](./microsandbox.mdx) covers requirements, configuration and runtime compatibility. Choose another name if `microsandbox-external` already exists. +A successful add initializes the provider and makes it the default for the current context. To keep the current default, add `--use=false` and run `devsy provider init microsandbox` before creating a workspace. -**Existing built-in installations.** The built-in MicroSandbox provider is deprecated. Existing configurations are not migrated automatically. To switch one to the external provider, run: +If the built-in provider is already configured as `microsandbox`, adding the external provider with that name fails. Add it under another name: ```sh -devsy provider set-source https://github.com/devsy-org/devsy-provider-microsandbox/releases/latest/download/provider.yaml -``` - -Current Devsy versions also accept `builtin:microsandbox` to select the deprecated built-in provider explicitly: - -```sh -devsy provider add builtin:microsandbox --name legacy-microsandbox --use=false +devsy provider add --name microsandbox-external https://github.com/devsy-org/devsy-provider-microsandbox/releases/latest/download/provider.yaml +devsy workspace up . --provider microsandbox-external ``` -After initialization, the switched provider becomes the default. To restore the previous default, run `devsy provider use `. If initialization fails, the new source stays selected. Fix the cause and run `devsy provider init `, or set the previous source again. +If you add with `--use=false`, run `devsy provider init microsandbox-external` before creating a workspace. Existing built-in configurations are not migrated automatically. The built-in provider is deprecated. Use `builtin:microsandbox` as the source in `devsy provider add` to select it explicitly. The [MicroSandbox guide](./microsandbox.mdx) covers requirements, configuration and runtime compatibility. ### Docker Sandboxes diff --git a/sites/docs-devsy-sh/content/docs/managing-providers/microsandbox.mdx b/sites/docs-devsy-sh/content/docs/managing-providers/microsandbox.mdx index 4d0af4a234..0225003685 100644 --- a/sites/docs-devsy-sh/content/docs/managing-providers/microsandbox.mdx +++ b/sites/docs-devsy-sh/content/docs/managing-providers/microsandbox.mdx @@ -9,20 +9,29 @@ The external MicroSandbox provider runs Devsy workspaces in microVMs using the M Install Devsy and the [MicroSandbox CLI](https://github.com/superradcompany/microsandbox#install-the-cli), version 0.7.13 or later. Check `msb --version` in the environment running Devsy. Docker is required for image builds. Provider releases contain binaries for Linux amd64 and arm64, macOS arm64, and Windows amd64. Linux requires KVM and Windows requires Windows Hypervisor Platform. +```sh +devsy provider add microsandbox +devsy workspace up . --provider microsandbox +``` + +A successful add initializes the provider and makes it the default for the current context. Workspaces that do not specify a provider use the default. To keep the current default, add `--use=false` to the add command, then run `devsy provider init microsandbox` before creating a workspace. + +## Existing built-in installations + +If the built-in provider is already configured as `microsandbox`, adding the external provider with that name fails. Add it under another name: + ```sh devsy provider add --name microsandbox-external https://github.com/devsy-org/devsy-provider-microsandbox/releases/latest/download/provider.yaml devsy workspace up . --provider microsandbox-external ``` -A successful add initializes the provider and makes it the default for the current context. Workspaces that do not specify a provider use the default. To keep the current default, add `--use=false` to the add command, then run `devsy provider init microsandbox-external` before creating a workspace. - -Choose another name if `microsandbox-external` already exists. Existing built-in configurations are not migrated automatically. The built-in provider is deprecated and is selected explicitly with `builtin:microsandbox` in current Devsy versions. +If you add with `--use=false`, run `devsy provider init microsandbox-external` before creating a workspace. Existing built-in configurations are not migrated automatically. The built-in provider is deprecated. Use `builtin:microsandbox` as the source in `devsy provider add` to select it explicitly. The provider's SDK upgrades the `MSB_HOME` database, by default `~/.microsandbox`, when a workspace first starts. Older `msb` versions refuse the upgraded database. Older provider SDKs cannot run commands after the database is upgraded either. Update the provider and `msb` together. ## Configuration -Set options in Desktop or with `devsy provider set microsandbox-external -o KEY=value`. Empty resource options use the runtime default unless otherwise noted. +Set options in Desktop or with `devsy provider set microsandbox -o KEY=value`. If you installed the external provider as `microsandbox-external`, use that name instead. Empty resource options use the runtime default unless otherwise noted. | Option | Default | Purpose | | --- | --- | --- |