GuidesDiscussions
GuidesAPI ReferenceJoin the Mailing List

Feature Parity: Orka Tools

Feature parity across the Orka CLI, Orka API, and the Orka Web UI.

🚧

Quick navigation

General: General features | Tool configuration | Checks | Logging

Users

Nodes

VMs: Listing and info | Create VM configuration vs Create VM vs Deploy VM | 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

ISOs

Kube

General features

FeatureCLI: interactiveCLI: directAPIWeb UI
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

FeatureCLI: interactiveCLI: directAPIWeb UI
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βŒβŒβœ…βŒ

* Requires additional configuration. See Built-In Orka Domains and External Custom Domains.

Checks

FeatureCLI: interactiveCLI: directAPIWeb UI
Check the current API versionβœ…βœ…βœ…βœ…
Check the current tool versionβœ…βœ…βœ…βœ…
Check the current version (extended)βŒβœ…βœ…βŒ
Check environment statusβŒβŒβœ…βŒ
Check token statusβŒβŒβœ…βŒ
Check password requirementsβŒβŒβœ…βŒ
Check default base imageβŒβŒβœ…βŒ
Validate license keyβŒβŒβœ…βŒ

Logging

FeatureCLI: interactiveCLI: directAPIWeb UI
Logs 1.0*βŒβŒβœ…βŒ
Logs 2.0βŒβŒβœ…βŒ

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

Users

FeatureCLI: interactiveCLI: directAPIWeb UI
Create userβœ…βœ…βœ…βœ…
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

FeatureCLI: interactiveCLI: directAPIWeb UI
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

FeatureCLI: interactiveCLI: directAPIWeb UI
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 configuration vs Create VM vs Deploy VM

VM featureCreate VM configurationCreate VMDeploy VM
Set base imageβœ…βœ…βœ…
Set CPUβœ…βœ…βœ…
Set vCPUβœ…βœ…βœ…
Set memoryβœ…βœ…βŒ
Attach diskβœ…βœ…βœ…
Attach ISOβœ…βœ…βœ…
Enable/disable VNCβœ…βœ…βœ…
Enable/disable I/O boostβœ…βœ…βŒ
Enable/disable Network boostβœ…βœ…βŒ
Enable/disable GPU passthroughβœ…βœ…βœ…
Set serial numberβœ…βœ…βœ…
Apply a preferred tagβœ…βœ…βœ…
Apply a required tagβœ…βœ…βœ…
Set schedulerβœ…βœ…βœ…
Set scale (number of replicas)βŒβŒβœ…
Configure port forwardingβŒβŒβœ…
Inject VM metadataβŒβŒβœ…
CLI: interactiveCLI: directAPIWeb UI
Create VM configurationβœ…βœ…βœ…βœ…
Create and deploy VM (single operation)βœ…βœ…βŒβŒ
Deploy VMβœ…βœ…βœ…βœ…

VMs: Create VM configurations

FeatureCLI: interactiveCLI: directAPIWeb UI
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βŒβœ…βœ…βŒ

VMs: Create and deploy VMs (single operation)

FeatureCLI: interactiveCLI: directAPIWeb UI
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βŒβœ…βŒβŒ

VMs: Deploy VMs from existing VM configurations

FeatureCLI: interactiveCLI: directAPIWeb UI
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βŒβŒβœ…βŒ

VMs: States

FeatureCLI: interactiveCLI: directAPIWeb UI
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

FeatureCLI: interactiveCLI: directAPIWeb UI
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

FeatureCLI: interactiveCLI: directAPIWeb UI
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

FeatureCLI: interactiveCLI: directAPIWeb UI
Attach a disk to VMβœ…βœ…βœ…βŒ
List VM disksβœ…βœ…βœ…βŒ
Shared VM storage**❌❌❌❌
I/O boostβœ…βœ…βœ…βœ…

** You can access and manage the shared storage from within the VM.

VMs: Networking

FeatureCLI: interactiveCLI: directAPIWeb UI
VNCβœ…βœ…βœ…βœ…
SSH*❌❌❌❌
Apple Screen Sharing*❌❌❌❌
Port forwardingβŒβœ…βœ…βŒ**
Network boostβœ…βœ…βœ…βœ…

* Orka assigns an SSH and an Apple Screen Sharing port to all VMs during deployment. You can view the port information in the Orka CLI, Orka API, and the Orka Web UI. However, you need to manage SSH and Apple Screen Sharing from within the VM.
** You can see which ports are reserved for port forwarding.

VMs: Performance

FeatureCLI: interactiveCLI: directAPIWeb UI
Use saved state (optimizes startup)βœ…βœ…βœ…βŒ*
GPU passthroughβœ…βœ…βœ…βœ…
I/O boost*βœ…βœ…βœ…βœ…
Network boost*βœ…βœ…βœ…βœ…

* You cannot save or delete a saved state, or check if a VM configuration is using a saved state. However, if a VM configuration uses a saved state, any VMs deployed with the Orka Web UI (after applying the state to the configuration) will use the saved state.

Images

FeatureCLI: interactiveCLI: directAPIWeb UI
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 an 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

FeatureCLI: interactiveCLI: directAPIWeb UI
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

FeatureCLI: interactiveCLI: directAPIWeb UI
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.