Skip to content

Commit bad7ab4

Browse files
committed
doc: Added a document outlining the supported hosts for vfkit
1 parent 2852d00 commit bad7ab4

File tree

2 files changed

+22
-0
lines changed

2 files changed

+22
-0
lines changed

.github/workflows/compile.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,3 +73,6 @@ jobs:
7373
name: Unsigned vfkit Universal Binary
7474
path: "./out/vfkit"
7575
if-no-files-found: error
76+
- name: Sleep for tmate session
77+
run: sleep 3600s
78+
if: matrix.runner == 'macos-15-intel'

doc/supported_platforms.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Supported Host Platforms
2+
3+
`vfkit` is a macOS-only virtualization tool which uses Apple's Virtualization framework to manage virtual machines.
4+
5+
## Host Requirements
6+
7+
**macOS 14.0 or later** is recommended and fully supported. CI tested on:
8+
- macOS 14 (Sonoma) - CI tested on Apple Silicon
9+
- macOS 15 (Sequoia) - CI tested on Apple Silicon
10+
11+
+**macOS 13.0** may work but is not officially supported. Integration tests currently run on macOS 13, but this GitHub Actions runner will be deprecated soon. See [GitHub’s announcement](https://github.blog/changelog/2025-07-11-upcoming-changes-to-macos-hosted-runners-macos-latest-migration-and-xcode-support-policy-updates/#macos-13-is-closing-down).
12+
13+
**Architectures:**
14+
- Intel x86_64
15+
- Apple Silicon
16+
17+
## Limitations
18+
19+
- **Raw block devices**: Using raw block devices like `/dev/disk1` requires macOS 14+. See Apple's [VZDiskBlockDeviceStorageDeviceAttachment](https://developer.apple.com/documentation/virtualization/vzdiskblockdevicestoragedeviceattachment) documentation.

0 commit comments

Comments
 (0)