Skip to content

[docs] AppleVZ docs#4787

Open
sharder996 wants to merge 4 commits intomainfrom
feature/apple/docs
Open

[docs] AppleVZ docs#4787
sharder996 wants to merge 4 commits intomainfrom
feature/apple/docs

Conversation

@sharder996
Copy link
Copy Markdown
Collaborator

@sharder996 sharder996 commented Apr 2, 2026

This PR adds references in the docs to the new AppleVZ backend driver.


MULTI-2529

@sharder996 sharder996 requested a review from geoffreynyaga April 2, 2026 20:25

You've installed Multipass. Time to run your first commands! Use `multipass version` to check your version or `multipass launch` to create your first instance.

Multipass defaults to using QEMU as its virtualisation provider. If you'd like to use AppleVZ, you can do so using the following command:
Copy link
Copy Markdown
Contributor

@geoffreynyaga geoffreynyaga Apr 8, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just a small fix.
We should use US english for consistency. I'd recommend we swap virtualisation with virtualization. This also helps with consistency even when we reference AppleVZ.

Note: US english is now recommended internally https://docs.ubuntu.com/styleguide/en/#spelling and the word 'virtualization' is specifically listed under the "Other common terms" section. The functionality is already implemented in the Multipass repo, but we have not enabled the check on CI (it requires effort to update all pages). Hint: If you run make run locally, you should see a docs/.sphinx/styles/Canonical/000-US-spellcheck.yml file.

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I used virtualization explicitly because its part of the name of the framework, but if you want I can find/replace all instances of virtualisation with the former.

Comment thread docs/explanation/driver.md Outdated

- On Linux, Multipass can be configured to use QEMU. As of Multipass version 1.16, LXD and libvirt are no longer available.
- On macOS, the options are QEMU and VirtualBox. As of Multipass version 1.13, Hyperkit is no longer available.
- On macOS, the options are QEMU, the Apple Virtualization framework, and VirtualBox. As of Multipass version 1.13, Hyperkit is no longer available.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Minor request. Since we use both the full name and the abbreviation interchangeably throughout the docs, I'd suggest introducing both together at first mention so readers always have the reference:

+ the Apple Virtualization framework (AppleVZ), ...

Quick question: I know that Apple uses VZ as class prefix throughout its codebase. Are apple-vz/AppleVZ terms that Apple uses officially, or are they Multipass-specific shorthands derived from that prefix? Knowing this will help us write a more accurate explanation in the docs down the line.

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have found no references to any other AppleVZ mutations in the Apple docs. Its always referred to by its full moniker.

Copy link
Copy Markdown
Collaborator

@ricab ricab Apr 8, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will the setting value be named as applevz? If so, better tie the two together somewhere in the docs (not sure where)

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It is mentioned in

## Install an alternative driver
`````{tab-set}
````{tab-item} macOS
:sync: macOS
An alternative option is to use the Apple Virtualization framework.
To switch the Multipass driver to AppleVZ, run this command:
```{code-block} text
sudo multipass set local.driver=applevz
```

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants