Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.macstadium.com/llms.txt

Use this file to discover all available pages before exploring further.

Orka VM Tools is a collection of background services that let Orka communicate with the guest operating system on Apple silicon VMs. They start automatically when the guest OS starts, and they enable features that require coordination between the host and the VM. Orka VM Tools are only compatible with ARM-based guest operating systems running macOS 12 or later. The following Orka features require Orka VM Tools:
Always run the Orka VM Tools version that matches your cluster and other Orka tools and integrations. A version mismatch can cause disk resizing and shared storage failures. For example, if your cluster runs 3.x, your Orka VM Tools should also run 3.x.

​
Pre-installed on MacStadium base images

Orka VM Tools come pre-installed on all ARM base images that MacStadium provides. When you deploy from a MacStadium image, no separate installation step is needed. If you’re building a custom image from scratch or updating an existing VM, use Homebrew to install or upgrade VM Tools inside the guest: 
# Install
brew install orka-vm-tools

# Upgrade to the latest version
brew upgrade orka-vm-tools
Run brew upgrade orka-vm-tools after upgrading your cluster to keep VM Tools in sync with the cluster version.

​
Checking VM Tools status

Orka VM Tools run in the background as a daemon. To confirm they are running inside a VM: 
sudo launchctl list com.orka.vm.tools
Terminal output of launchctl list showing Orka VM Tools running