GuidesDiscussions
GuidesAPI ReferenceJoin the Mailing List

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.