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    

Orka CLI Quick Start

How to configure your Orka user and environment and how to create and deploy your first VM with the Orka CLI.

What's in the CLI

Before you begin, verify that you're running the latest CLI and that you are connected via VPN to Orka.

To see a list of the available commands, just run:

orka

Configure environment

To use your Orka environment, you need to configure your CLI to work with it.

Have a copy of the IP Plan - IP Plan - A document, prepared and provided by MacStadium, that contains access, configuration, and networking information for your Orka environment. handy and run the following command.

orka config

What's your Orka API URL?

Check the Subnet ID for your Private-1 network in your IP Plan. Replace the last octet with 100 and you'll get your Orka service endpoint.

For example, if the Subnet ID for Private-1 is 10.221.188.0, your service endpoint is 10.221.188.100.

The license key​ is provided in your IP Plan.

Output style is a personal preference between TABLE​ and JSON. TABLE provides better human readability.

Setting up a user

To access your Orka environment and manage your Orka resources, you must first create a user.

orka user create

Each user will need four elements: A preferred email, password, license key, and orka-api-url. The license key and orka-api-url persist from the pervious step. This can be auto-populated with the flags if desired, such as:

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

Authenticating

This step creates a token that will be cached for access based on the user email address.

orka login

The flags are generally consistent between orka commands, so the login can be passed the same flags and syntax as with orka user create:

orka login -e <user@example.com> -p <password>

Verify Connection to Orka

The first command to establish a connection has been made, and the credentials are good is:

orka node list

A successful result will resemble:

Then users should check for images and base VMs:

orka image list

And finally a quick look at any VMs. Since this is limited to the VMs based on user or group, this list should return as blank at the start:

orka vm list

Create a VM

The first step is to create a profile, which will pull an image and pair that image with the preferred hardware settings:

orka vm create-config

This command will walk the user through best-practices based on the number of real VMs selected. If the image is left blank, a default Mojave image will be used.

To verify configuration exists, run:

orka vm list

The named configuration should now exist in the list in the "Not Deployed" state.

Next step is to deploy the configuration to a node:

orka vm deploy

The image name is needed, as is the desired node. Leaving this node blank or selecting a node that cannot have a VM scheduled on it will result in the scheduler taking over and placing the VM on a node. The default behavior for the internal Orka scheduler system of a single VM is to randomly pick from the node list, then check for available resources.

Success will resemble:

orka vm list

Note:

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 readme.io. Orka is a registered trademark of MacStadium, Inc.

Orka CLI Quick Start


How to configure your Orka user and environment and how to create and deploy your first VM with the Orka CLI.

Suggested Edits are limited on API Reference Pages

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