The Orka Developer Hub

Welcome to the Orka developer hub. You'll find comprehensive guides and documentation to help you start working with Orka as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started    

Quick Start

Accessing Orka

To access your Orka instance, you must first create a user via the Rest API or the Orka CLI. Once you are authenticated under one of the methods above, you can create your virtual machine and deploy it to a non-occupied node. Once the virtual machine is running, you can access it using the VNC IP address and port provided in the response of a successful deployment.

Setting up a user

You can set up a user either by using the Orka Rest API or Orka CLI.The quickest way to start is by using the CLI :

$ orka user create -e <email> -p <password> -l <license-key> -a <orka-api-url>


$ orka login -e <> -p <password>

An auth token will be cached for further commands.

Upload an image

Raw or QCOW2image format to use as the VM base is preferred. VMDKs can be uploaded and converted as well.

$ orka image upload -I <mojave.img>

Running Orka VM containers

$ orka vm create-config -v <vm-image.img> -b <base-image.img> -i <image.img> -c 24 -y 
$ orka vm deploy -v <vm-image.img> -o <node-name> -y


You are not able to deploy a VM to a node that is fully occupied -- i.e. one that is out of resources. If you attempt to do this, you will receive an error.

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

Quick Start

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.