From eae225ccb73ffc3c3ba0d8f37388bd0e0c8f199c Mon Sep 17 00:00:00 2001 From: Gerorge Liao Date: Mon, 7 Apr 2025 11:19:49 +0200 Subject: [PATCH 1/9] [docs] append all lxd word occurrences in the docs with deprecation message. --- docs/explanation/driver.md | 8 ++++---- docs/explanation/mount.md | 2 +- .../customise-multipass/set-up-the-driver.md | 2 +- docs/how-to-guides/manage-instances/create-an-instance.md | 2 +- docs/reference/command-line-interface/networks.md | 2 +- docs/reference/settings/local-driver.md | 4 ++-- 6 files changed, 10 insertions(+), 10 deletions(-) diff --git a/docs/explanation/driver.md b/docs/explanation/driver.md index e44fa66913..d2e9d1652e 100644 --- a/docs/explanation/driver.md +++ b/docs/explanation/driver.md @@ -13,7 +13,7 @@ On some platforms, it is possible to select a driver during installation. Until Different sets of drivers are available on different platforms: -- On Linux, Multipass can be configured to use QEMU, LXD, and libvirt. +- On Linux, Multipass can be configured to use QEMU, LXD (deprecated), and libvirt (deprecated). - On macOS, the options are QEMU and VirtualBox. As of Multipass version 1.13, Hyperkit is no longer available. - On Windows, Multipass uses Hyper-V (only available on Windows Pro) or VirtualBox. @@ -23,7 +23,7 @@ When Multipass is installed, the following drivers are selected by default: - On Linux, the default driver depends on the host's architecture: + QEMU on AMD64 - + LXD on other platforms. + + LXD (deprecated) on other platforms. - On macOS, QEMU is used. - On Windows, the default driver depends on the OS version: + Hyper-V on Windows Pro @@ -52,8 +52,8 @@ While we strive to offer a uniform interface across the board, not all features | Feature | Only supported on... | Notes | |--- | --- | --- | -| **Native mounts** | | This affects the `--type` option in the [`mount`](/reference/command-line-interface/mount) command). | -| **Extra networks** | | This affects the [`networks`](/reference/command-line-interface/networks) command, as well as the `--network` and `--bridged` options in [`launch`](/reference/command-line-interface/launch). | +| **Native mounts** | | This affects the `--type` option in the [`mount`](/reference/command-line-interface/mount) command). | +| **Extra networks** | | This affects the [`networks`](/reference/command-line-interface/networks) command, as well as the `--network` and `--bridged` options in [`launch`](/reference/command-line-interface/launch). | | **Snapshots** | | | | **Clone** | | This affects the [`clone`](/reference/command-line-interface/clone) command.| | **VM suspension** | | This affects the [`suspend`](/reference/command-line-interface/suspend) command. | diff --git a/docs/explanation/mount.md b/docs/explanation/mount.md index 0f68e24228..58710e9b35 100644 --- a/docs/explanation/mount.md +++ b/docs/explanation/mount.md @@ -23,7 +23,7 @@ Native mounts use driver-dependent technologies to achieve the high performance. - On **Hyper-V**, where they are implemented with [SMB/CIFS](https://learn.microsoft.com/en-us/windows/win32/fileio/microsoft-smb-protocol-and-cifs-protocol-overview). - On **QEMU**, where they are implemented with [9P](https://en.wikipedia.org/wiki/9P_(protocol)). -- On **LXD**, using that backend's own mounts, which also rely on [9P](https://en.wikipedia.org/wiki/9P_(protocol)). +- On **LXD** (deprecated), using that backend's own mounts, which also rely on [9P](https://en.wikipedia.org/wiki/9P_(protocol)). > See also: {ref}`driver-feature-disparities`. diff --git a/docs/how-to-guides/customise-multipass/set-up-the-driver.md b/docs/how-to-guides/customise-multipass/set-up-the-driver.md index a640d036c6..da5d4df7fa 100644 --- a/docs/how-to-guides/customise-multipass/set-up-the-driver.md +++ b/docs/how-to-guides/customise-multipass/set-up-the-driver.md @@ -11,7 +11,7 @@ This document demonstrates how to choose, set up, and manage the drivers behind ````{group-tab} Linux -By default, Multipass on Linux uses the `qemu` or `lxd` driver (depending on the architecture). +By default, Multipass on Linux uses the `qemu` or `lxd` (deprecated) driver (depending on the architecture). ```` diff --git a/docs/how-to-guides/manage-instances/create-an-instance.md b/docs/how-to-guides/manage-instances/create-an-instance.md index c166dd8469..bb6ed09077 100644 --- a/docs/how-to-guides/manage-instances/create-an-instance.md +++ b/docs/how-to-guides/manage-instances/create-an-instance.md @@ -117,7 +117,7 @@ Multipass can create instances with additional network interfaces using the `mul This feature is only supported for images with [`cloud-init` support for v2 network config](https://cloudinit.readthedocs.io/en/latest/topics/network-config-format-v2.html), which in turn requires [netplan](https://netplan.io/) to be installed, meaning that you'll require Ubuntu 17.10 and Ubuntu Core 16 (except `snapcraft:core16`) or later. More specifically, this feature is only supported in the following scenarios: -* on Linux, with LXD +* on Linux, with LXD (deprecated) * on Windows, with both Hyper-V and VirtualBox * on macOS, with the QEMU and VirtualBox drivers diff --git a/docs/reference/command-line-interface/networks.md b/docs/reference/command-line-interface/networks.md index 08b9163ba6..c5042736bc 100644 --- a/docs/reference/command-line-interface/networks.md +++ b/docs/reference/command-line-interface/networks.md @@ -7,7 +7,7 @@ The `multipass networks` command lists network interfaces that multipass can con At this time, `multipass networks` can only find interfaces in the following scenarios: -- on Linux, with LXD (*and QEMU starting from Multipass version 1.15*) +- on Linux, with QEMU (*from Multipass 1.15 onwards*) and LXD (deprecated) - on Windows, with both Hyper-V and VirtualBox - on macOS, with the QEMU and VirtualBox drivers diff --git a/docs/reference/settings/local-driver.md b/docs/reference/settings/local-driver.md index 37319736d2..2bc61c74bd 100644 --- a/docs/reference/settings/local-driver.md +++ b/docs/reference/settings/local-driver.md @@ -13,7 +13,7 @@ A string identifying the hypervisor back-end in use. ## Possible values - - `qemu`, `libvirt` and `lxd` on Linux + - `qemu`, `libvirt` and `lxd` (deprecated) on Linux - `hyperv` and `virtualbox` on Windows - `qemu` and `virtualbox` on macOS 10.15+ - *(deprecated)* `hyperkit` on Intel macOS 10.15+ @@ -21,5 +21,5 @@ A string identifying the hypervisor back-end in use. ## Default values - `qemu` on macOS and AMD64 Linux - - `lxd` on non-AMD64 Linux + - `lxd` (deprecated) on non-AMD64 Linux - `hyperv` on Windows From 54ab58e8e54f5328c099326b2802791c76a0ddef Mon Sep 17 00:00:00 2001 From: Gerorge Liao Date: Mon, 7 Apr 2025 11:40:08 +0200 Subject: [PATCH 2/9] [docs] fix the spell check and linter. --- docs/reference/command-line-interface/networks.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/reference/command-line-interface/networks.md b/docs/reference/command-line-interface/networks.md index c5042736bc..d696942cb5 100644 --- a/docs/reference/command-line-interface/networks.md +++ b/docs/reference/command-line-interface/networks.md @@ -7,7 +7,7 @@ The `multipass networks` command lists network interfaces that multipass can con At this time, `multipass networks` can only find interfaces in the following scenarios: -- on Linux, with QEMU (*from Multipass 1.15 onwards*) and LXD (deprecated) +- on Linux, with QEMU (*from Multipass 1.15 onward*) and LXD (deprecated) - on Windows, with both Hyper-V and VirtualBox - on macOS, with the QEMU and VirtualBox drivers From df85690680481e4da7629428745413e75e3f6313 Mon Sep 17 00:00:00 2001 From: Gerorge Liao Date: Mon, 7 Apr 2025 12:40:35 +0200 Subject: [PATCH 3/9] [docs] added deprecation warning to libvirt driver. --- docs/explanation/driver.md | 2 +- docs/how-to-guides/customise-multipass/set-up-the-driver.md | 2 +- docs/reference/settings/local-driver.md | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/explanation/driver.md b/docs/explanation/driver.md index d2e9d1652e..c5309db7e6 100644 --- a/docs/explanation/driver.md +++ b/docs/explanation/driver.md @@ -42,7 +42,7 @@ Nonetheless, instances are preserved across drivers. After switching back to a p There are two exceptions to the above: - - On Linux, QEMU and libvirt share the same driver scope. + - On Linux, QEMU and libvirt (deprecated) share the same driver scope. - On macOS, stopped Hyperkit instances are automatically migrated to QEMU by Multipass's version 1.12 or later (see [How to migrate from Hyperkit to QEMU on macOS](/how-to-guides/customise-multipass/migrate-from-hyperkit-to-qemu-on-macos)). (driver-feature-disparities)= diff --git a/docs/how-to-guides/customise-multipass/set-up-the-driver.md b/docs/how-to-guides/customise-multipass/set-up-the-driver.md index da5d4df7fa..82a8819f9f 100644 --- a/docs/how-to-guides/customise-multipass/set-up-the-driver.md +++ b/docs/how-to-guides/customise-multipass/set-up-the-driver.md @@ -35,7 +35,7 @@ By default, Multipass on Windows uses the `hyperv` driver. ````{group-tab} Linux -If you want more control over your VMs after they are launched, you can also use the experimental [libvirt](https://libvirt.org/) driver. +If you want more control over your VMs after they are launched, you can also use the experimental [libvirt](https://libvirt.org/) (deprecated) driver. To install libvirt, run the following command (or use the equivalent for your Linux distribution): diff --git a/docs/reference/settings/local-driver.md b/docs/reference/settings/local-driver.md index 2bc61c74bd..00b0203c45 100644 --- a/docs/reference/settings/local-driver.md +++ b/docs/reference/settings/local-driver.md @@ -13,7 +13,7 @@ A string identifying the hypervisor back-end in use. ## Possible values - - `qemu`, `libvirt` and `lxd` (deprecated) on Linux + - `qemu`, `libvirt` (deprecated) and `lxd` (deprecated) on Linux - `hyperv` and `virtualbox` on Windows - `qemu` and `virtualbox` on macOS 10.15+ - *(deprecated)* `hyperkit` on Intel macOS 10.15+ From b3fea51cf1b0f8db8665bcfda1860ce2a8ac6c13 Mon Sep 17 00:00:00 2001 From: Gerorge Liao Date: Mon, 7 Apr 2025 12:51:28 +0200 Subject: [PATCH 4/9] [docs] polished the deprecation warning message on libvirt dedicated section. --- docs/how-to-guides/customise-multipass/set-up-the-driver.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/how-to-guides/customise-multipass/set-up-the-driver.md b/docs/how-to-guides/customise-multipass/set-up-the-driver.md index 82a8819f9f..15c6d68b9f 100644 --- a/docs/how-to-guides/customise-multipass/set-up-the-driver.md +++ b/docs/how-to-guides/customise-multipass/set-up-the-driver.md @@ -34,8 +34,9 @@ By default, Multipass on Windows uses the `hyperv` driver. `````{tabs} ````{group-tab} Linux - -If you want more control over your VMs after they are launched, you can also use the experimental [libvirt](https://libvirt.org/) (deprecated) driver. +Warning! The libvirt driver is deprecated and will be removed in an upcoming release. + +If you want more control over your VMs after they are launched, you can also use the experimental [libvirt](https://libvirt.org/) driver. To install libvirt, run the following command (or use the equivalent for your Linux distribution): From 260aebda15573594df29a0ed9c52f21366c5c098 Mon Sep 17 00:00:00 2001 From: Gerorge Liao Date: Mon, 7 Apr 2025 14:06:04 +0200 Subject: [PATCH 5/9] [docs] fix the linter. --- docs/how-to-guides/customise-multipass/set-up-the-driver.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/how-to-guides/customise-multipass/set-up-the-driver.md b/docs/how-to-guides/customise-multipass/set-up-the-driver.md index 15c6d68b9f..03c926583c 100644 --- a/docs/how-to-guides/customise-multipass/set-up-the-driver.md +++ b/docs/how-to-guides/customise-multipass/set-up-the-driver.md @@ -35,7 +35,7 @@ By default, Multipass on Windows uses the `hyperv` driver. ````{group-tab} Linux Warning! The libvirt driver is deprecated and will be removed in an upcoming release. - + If you want more control over your VMs after they are launched, you can also use the experimental [libvirt](https://libvirt.org/) driver. To install libvirt, run the following command (or use the equivalent for your Linux distribution): From 5fa5fb4358bbb40cdb45e3eb489d75da444d14e0 Mon Sep 17 00:00:00 2001 From: Gerorge Liao Date: Mon, 7 Apr 2025 14:58:04 +0200 Subject: [PATCH 6/9] [docs] bold the warning word. --- docs/how-to-guides/customise-multipass/set-up-the-driver.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/how-to-guides/customise-multipass/set-up-the-driver.md b/docs/how-to-guides/customise-multipass/set-up-the-driver.md index 03c926583c..eed3562fbb 100644 --- a/docs/how-to-guides/customise-multipass/set-up-the-driver.md +++ b/docs/how-to-guides/customise-multipass/set-up-the-driver.md @@ -34,7 +34,7 @@ By default, Multipass on Windows uses the `hyperv` driver. `````{tabs} ````{group-tab} Linux -Warning! The libvirt driver is deprecated and will be removed in an upcoming release. +**Warning!** The libvirt driver is deprecated and will be removed in an upcoming release. If you want more control over your VMs after they are launched, you can also use the experimental [libvirt](https://libvirt.org/) driver. From d0df324c26fa926dc04689e36b31c6d4b4b66475 Mon Sep 17 00:00:00 2001 From: Gerorge Liao Date: Wed, 9 Apr 2025 18:25:53 +0200 Subject: [PATCH 7/9] [docs] refined the warning message and also added it to the driver page. --- docs/explanation/driver.md | 4 ++++ docs/how-to-guides/customise-multipass/set-up-the-driver.md | 5 +++-- 2 files changed, 7 insertions(+), 2 deletions(-) diff --git a/docs/explanation/driver.md b/docs/explanation/driver.md index c5309db7e6..a2ee849dbd 100644 --- a/docs/explanation/driver.md +++ b/docs/explanation/driver.md @@ -1,6 +1,10 @@ (explanation-driver)= # Driver +```{warning} +Support for libvirt and LXD will be deprecated and removed in a future release. +``` + > See also: [How to set up the driver](/how-to-guides/customise-multipass/set-up-the-driver), [`local.driver`](/reference/settings/local-driver), [Instance](/explanation/instance), [Platform](/explanation/platform) A **driver** is the technology through which Multipass emulates a running machine. It corresponds to a hypervisor or intermediary technology to run virtual machines. The driver is sometimes also referred to as "backend". diff --git a/docs/how-to-guides/customise-multipass/set-up-the-driver.md b/docs/how-to-guides/customise-multipass/set-up-the-driver.md index eed3562fbb..797da1a11e 100644 --- a/docs/how-to-guides/customise-multipass/set-up-the-driver.md +++ b/docs/how-to-guides/customise-multipass/set-up-the-driver.md @@ -34,8 +34,9 @@ By default, Multipass on Windows uses the `hyperv` driver. `````{tabs} ````{group-tab} Linux -**Warning!** The libvirt driver is deprecated and will be removed in an upcoming release. - +```{warning} +Support for libvirt driver will be deprecated and removed in a future release. +``` If you want more control over your VMs after they are launched, you can also use the experimental [libvirt](https://libvirt.org/) driver. To install libvirt, run the following command (or use the equivalent for your Linux distribution): From 02882aa20d02eead289fee7ca529e3aca26d3fa7 Mon Sep 17 00:00:00 2001 From: Gerorge Liao Date: Wed, 9 Apr 2025 20:36:32 +0200 Subject: [PATCH 8/9] [docs] addressed a few review comments. --- docs/how-to-guides/customise-multipass/set-up-the-driver.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/how-to-guides/customise-multipass/set-up-the-driver.md b/docs/how-to-guides/customise-multipass/set-up-the-driver.md index 797da1a11e..1aabef486c 100644 --- a/docs/how-to-guides/customise-multipass/set-up-the-driver.md +++ b/docs/how-to-guides/customise-multipass/set-up-the-driver.md @@ -11,7 +11,7 @@ This document demonstrates how to choose, set up, and manage the drivers behind ````{group-tab} Linux -By default, Multipass on Linux uses the `qemu` or `lxd` (deprecated) driver (depending on the architecture). +By default, Multipass on Linux uses the `qemu` driver. ```` From 2b0c992641b29cf19503860df5fa8cf1210a6082 Mon Sep 17 00:00:00 2001 From: Gerorge Liao Date: Thu, 10 Apr 2025 11:11:41 +0200 Subject: [PATCH 9/9] [docs] addressed a few review comments. --- docs/explanation/driver.md | 2 +- docs/how-to-guides/manage-instances/create-an-instance.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/explanation/driver.md b/docs/explanation/driver.md index a2ee849dbd..53b95bf6cf 100644 --- a/docs/explanation/driver.md +++ b/docs/explanation/driver.md @@ -17,7 +17,7 @@ On some platforms, it is possible to select a driver during installation. Until Different sets of drivers are available on different platforms: -- On Linux, Multipass can be configured to use QEMU, LXD (deprecated), and libvirt (deprecated). +- On Linux, Multipass can be configured to use QEMU, LXD, and libvirt. As of Multipass version 1.16, LXD and libvirt are no longer supported. - On macOS, the options are QEMU and VirtualBox. As of Multipass version 1.13, Hyperkit is no longer available. - On Windows, Multipass uses Hyper-V (only available on Windows Pro) or VirtualBox. diff --git a/docs/how-to-guides/manage-instances/create-an-instance.md b/docs/how-to-guides/manage-instances/create-an-instance.md index bb6ed09077..19f3683d82 100644 --- a/docs/how-to-guides/manage-instances/create-an-instance.md +++ b/docs/how-to-guides/manage-instances/create-an-instance.md @@ -117,7 +117,7 @@ Multipass can create instances with additional network interfaces using the `mul This feature is only supported for images with [`cloud-init` support for v2 network config](https://cloudinit.readthedocs.io/en/latest/topics/network-config-format-v2.html), which in turn requires [netplan](https://netplan.io/) to be installed, meaning that you'll require Ubuntu 17.10 and Ubuntu Core 16 (except `snapcraft:core16`) or later. More specifically, this feature is only supported in the following scenarios: -* on Linux, with LXD (deprecated) +* on Linux, with QEMU (*from Multipass 1.15 onward*) * on Windows, with both Hyper-V and VirtualBox * on macOS, with the QEMU and VirtualBox drivers