Feature Parity: Apple Hardware

Compatibility between Orka features and Intel- and Apple silicon-based nodes, VMs, and images.

🚧

Quick navigation

General: macOS versions | General features | Tool configuration | Cluster configuration and features | Checks | Logging

Users: Users

Nodes: Nodes

VMs: Listing and info | Create VM configurations | Create and deploy VMs (single operation) | Deploy VMs from existing VM configurations | States | Start/stop/suspend/resume | Delete and purge | Storage | Networking | Performance

Images: Images

ISOs: ISOs

Kube: Kube

macOS versions

macOS versionIntelApple silicon
macOS 10.14 (Mojave)
macOS 10.15 (Catalina)
macOS 11 (Big Sur)
macOS 12 (Monterey)
macOS 13 (Ventura)

General features

FeatureIntelApple silicon
Use API IP to access Orka
Use built-in Orka domain to access Orka
Use external custom domain to access Orka
View output in TABLE format
View output in JSON format
View output in RAW format

Tool configuration

FeatureIntelApple silicon
Configure API IP
Configure built-in Orka domain
Configure external custom domain
Configure global output
Store license key
Upload TLS certificate to use with an external custom domain

Cluster configuration and features

FeatureIntelApple silicon
VM scheduling
GPU passthrough✅*✅**
VM Internet isolation
VM network isolation
Sandbox namespace
Nested virtualization (Beta)

The listed configurations are disabled by default and are available upon request.

** GPU passthrough is always enabled by default on Apple silicon-based nodes.

Checks

FeatureIntelApple silicon
Check the current environment and tool version
Check the current environment and tool version (extended)
Check environment status
Check token status
Check password requirements
Check default base image
Validate license key

Logging

FeatureIntelApple silicon
Logs 1.0*✅*✅*
Logs 2.0

* Logging 1.0 is deprecated and will be removed in an upcoming release.

Users

FeatureIntelApple silicon
Create account
Log in
Log out
Create token
Get token
Revoke token
Update email
Update password
Reset password (administrative)
Group users (node dedication)
Ungroup users (node dedication)
Delete user

Nodes

FeatureIntelApple silicon
List worker nodes
List all nodes
Check node status
List the node's ports reserved for VNC, SSH, Apple Screen Sharing, or port forwarding
List the VMs deployed on the node
Apply sandbox
Remove sandbox
Apply node dedication
Remove node dedication
Apply tag (node affinity)
Remove tag (node affinity)

VMs: Listing and info

FeatureIntelApple silicon
List current user's VMs
List another user's VMs*
List all users' VMs*
List current user's VMs with replicas expanded
List another user's VMs with replicas expanded*
List all users' VMs with replicas expanded*
List current user's VM configurations
View a specific VM configuration
Check VM status
Check VM status for another user's VM*
List the VM's ports reserved for VNC, SSH, and Apple Screen Sharing
List the VM's ports reserved for port forwarding

* These are administrative operations and require providing a valid Orka license key.

VMs: Create VM configurations

FeatureIntelApple silicon
Create basic VM configuration (name, base image, CPU, vCPU)
Create VM configuration with custom memory
Create VM configuration with attached ISO
Create VM configuration with attached disk
Create VM configuration with enabled/disabled VNC
Create VM configuration with enabled/disabled I/O boost*❌*
Create VM configuration with enabled/disabled Network boost setting*❌*
Create VM configuration with enabled/disabled GPU passthrough*❌*
Create VM configuration with custom serial number
Create VM configuration with preferred tag (node affinity)
Create VM configuration with required tag (node affinity)
Create VM configuration with custom scheduler

* GPU passthrough, I/O boost, and Network boost are always enabled for Apple silicon-based nodes and VMs. You cannot manually disable or override these settings on the VM config or VM level.

VMs: Create and deploy VMs (single operation)

FeatureIntelApple silicon
Create and deploy basic VM (name, base image, CPU, vCPU)
Create and deploy VM with custom memory
Create and deploy VM with attached ISO
Create and deploy VM with attached disk
Create and deploy VM with enabled/disabled VNC
Create and deploy VM with enabled/disabled I/O boost*❌*
Create and deploy VM with enabled/disabled Network boost*❌*
Create and deploy VM with enabled/disabled GPU passthrough*❌*
Create and deploy VM with custom serial number
Create and deploy VM with preferred tag (node affinity)
Create and deploy VM with required tag (node affinity)
Create and deploy VM with custom scheduler

* GPU passthrough, I/O boost, and Network boost are always enabled for Apple silicon-based nodes and VMs. You cannot manually disable or override these settings on the VM config or VM level.

VMs: Deploy VMs from existing VM configurations

FeatureIntelApple silicon
Deploy VM by name
Deploy VM by name and node
Deploy VM with a specified number of replicas
Deploy VM and attach ISO (override VM configuration)
Deploy VM and attach disk (override VM configuration)
Deploy VM and enable port forwarding
Deploy VM and enable/disable VNC (override VM configuration)
Deploy VM and enable/disable I/O boost (override VM configuration)*❌*
Deploy VM and enable/disable Network boost (override VM configuration)*❌*
Deploy VM and enable/disable GPU passthrough (override VM configuration)*❌*
Deploy VM and set custom serial number (override VM configuration)
Deploy VM with preferred tag (node affinity) (override VM configuration)
Deploy VM with required tag (node affinity) (override VM configuration)
Deploy VM with custom scheduler (override VM configuration)
Deploy VM and inject custom metadata

* GPU passthrough, I/O boost, and Network boost are always enabled for Apple silicon-based nodes and VMs. You cannot manually disable or override these settings on the VM config or VM level.

VMs: States

FeatureIntelApple silicon
Save the live state of the VM to the VM config
Delete a saved live state (and reset the VM config to its initial state)
Revert VM by name (revert to the latest state of the base disk)
Revert VM by name and node (revert to the latest state of the base disk)
Revert VM by ID (revert to the latest state of the base disk)

VMs: Start/stop/suspend/resume

FeatureIntelApple silicon
Stop VM by name, ID, or name and node (power off)
Start VM by name, ID, or name and node (power on)
Suspend VM by name, ID, or name and node (sleep)
Resume VM by name, ID, or name and node (wake)

VMs: Delete and purge

FeatureIntelApple silicon
Delete VM by name
Delete VM by ID
Delete VM by name and node
Delete another user's VM*
Purge VM config (delete the VM config and any instances)
Purge another user's VM (delete the VM config and any instances)*

* These are administrative operations and require providing a valid Orka license key.

VMs: Storage

FeatureIntelApple silicon
Attach a disk to VM
List VM disks
Shared VM storage
I/O boost*✅ *

* I/O boost is always enabled on Apple silicon-based nodes and VMs. You cannot manually disable or override it on the VM config or VM level.

macOS and shared VM storage

macOS versionIntelApple silicon
macOS 10.14 (Mojave)
macOS 10.15 (Catalina)
macOS 11 (Big Sur)
macOS 12 (Monterey)✅*
macOS 13 (Ventura)

* Starting with Orka 2.4.0, shared VM storage is deprecated for Apple silicon-based VMs running macOS Monterey. In Orka 2.5.0, shared VM storage will be removed for all Apple Silicon-based Monterey VMs.

VMs: Networking

FeatureIntelApple silicon
VNC
SSH
Apple Screen Sharing
Port forwarding
Network boost*✅*

* Network boost is always enabled on Apple silicon-based nodes and VMs. You cannot manually disable or override it on the VM config or VM level.

VMs: Performance

FeatureIntelApple silicon
Use saved state (optimizes startup)
GPU passthrough
I/O boost*✅*
Network boost*✅*

* I/O boost and Network boost are always enabled for Apple silicon-based nodes and VMs. You cannot manually disable or override these settings on the VM config or VM level.

Images

FeatureIntelApple silicon
List images
List remote images
Pull a remote image
Pull a remote image and rename it
Download an image on your local machine
Upload an image from your local machine
Generate a new empty image
Calculate the image checksum
Rename image
Copy and rename an image
Save a new image from the specified VM (Save as)
Overwrite the existing image with its current state from the specified VM (Save)
Resize the disk and automatically resize the partition of the specified VM
Resize the disk and automatically resize the partition of a specified VM and automatically save a new image from it
Only resize the disk of the specified VM
Delete an image

ISOs

FeatureIntelApple silicon
List ISOs
List remote ISOs
Pull a remote ISO
Pull a remote ISO and rename it
Rename an ISO
Copy and rename an ISO
Delete an ISO

Kube

FeatureIntelApple silicon
Create kube account
List all kube accounts for the current Orka user
Get the kubeconfig for the specified kube account
Delete and re-create the specified kube account
Delete all kube accounts for the current user

See also


© 2019-2023 Copyright MacStadium, Inc. – Documentation built with readme.com. Orka is a registered trademark of MacStadium, Inc.