Skip to content

Commit 66417fc

Browse files
committed
Tuning intro a bit
Signed-off-by: Alex Ellis (OpenFaaS Ltd) <alexellis2@gmail.com>
1 parent 62a141e commit 66417fc

File tree

1 file changed

+17
-12
lines changed

1 file changed

+17
-12
lines changed

docs/mac/overview.md

Lines changed: 17 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,31 @@
11
# Slicer for Mac
22

3-
Slicer for Mac runs arm64 Linux VMs on Apple Silicon using Apple's native [Virtualization framework](https://developer.apple.com/documentation/virtualization). It provides a persistent Linux VM with native folder sharing, Docker, K3s, and disposable sandboxes - all driven by the same CLI and REST API as Slicer for Linux.
3+
Slicer for Mac was built from the ground up to run Linux microVMs on Apple Silicon.
44

5-
!!! note "Preview"
6-
Slicer for Mac is available on all Slicer license tiers. We've tested on macOS Sequoia and Tahoe. `slicer-mac` does not need `sudo`.
5+
It uses the same familiar API and CLI from Slicer for Linux, but instead of using KVM, leans heavily on Apple's native [Virtualization framework](https://developer.apple.com/documentation/virtualization).
6+
7+
Typical use-cases include: disposable sandboxes for agents, running local Kubernetes clusters, or getting access to a real Linux system, instead of making do with POSIX compatibility.
8+
9+
Slicer microVMs boot very quickly and have some advanced features like Rosetta for running Intel/AMD binaries, and folder sharing.
10+
11+
!!! note "macOS versions"
12+
Slicer for Mac is available on all Slicer license tiers. We've tested on macOS Sequoia and Tahoe. `slicer-mac` does not need `sudo`. Intel Macs are out of scope for Slicer at this time, but you could install Linux on them, and use Slicer for Linux instead.
713

814
## How it works
915

1016
Two binaries:
1117

12-
- **`slicer`** - the CLI client (same binary as Slicer for Linux) and used to download `slicer-mac`
13-
- **`slicer-mac`** - the daemon that manages VMs using Apple's Virtualization framework
18+
- **`slicer`** - the CLI client (same binary as Slicer for Linux)
19+
- **`slicer-mac`** - the server process aka *daemon* that manages VMs using Apple's Virtualization framework
20+
21+
An [optional menu bar app (`slicer-tray`)](/mac/tray-integration) provides quick access to VM status, shells, and controls.
1422

15-
An optional menu bar app (`slicer-tray`) provides quick access to VM status, shells, and controls.
16-
It is shipped as part of the `slicer-mac` OCI asset set.
17-
If you need tray details, see [Tray integration](/mac/tray-integration).
18-
If you need x86_64 support, see [Enable Rosetta](/mac/rosetta).
23+
If you need to run x86_64 binaries, see [Enable Rosetta](/mac/rosetta) after the initial setup.
1924

20-
The daemon reads a `slicer-mac.yaml` config file that defines two host groups:
25+
The config file for Slicer for Mac is named `slicer-mac.yaml`, it defines two host groups. Host groups launch and manage microVMs. The names are flexible on Slicer for Linux, but Slicer for Mac has two fixed groups instead.
2126

22-
- **Services** (`slicer` group) - a persistent Linux VM that boots with the daemon and stays running. This is your day-to-day Linux environment, similar to WSL on Windows.
23-
- **Sandboxes** (`sbox` group) - ephemeral VMs launched on demand via the CLI or API. They're destroyed when you restart the daemon, close the lid, or delete them.
27+
- The `slicer` group - a runs a Linux VM that start-up and stays running. This is your day-to-day Linux environment, similar to WSL on Windows, and is fully persistent.
28+
- The ``sbox` group aka "sandbox" - is for ephemeral VMs launched on demand through the CLI, API, or by one of your AI coding agents. They are permanently deleted when you shut them down, shut down Slicer for Mac, or delete them via `slicer vm delete NAME`.
2429

2530
# Architecture (conceptual)
2631

0 commit comments

Comments
 (0)