🚧
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
| Feature | CLI: interactive | CLI: direct | API | Web 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 | ❌ | ✅ | ❌ | ❌ |
| Feature | CLI: interactive | CLI: direct | API | Web 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.
| Feature | CLI: interactive | CLI: direct | API | Web 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 | ❌ | ❌ | ✅ | ❌ |
| Feature | CLI: interactive | CLI: direct | API | Web UI |
|---|
| Logs 1.0* | ❌ | ❌ | ✅ | ❌ |
| Logs 2.0 | ❌ | ❌ | ✅ | ❌ |
* Logging 1.0 is deprecated and will be removed in an upcoming release.
| Feature | CLI: interactive | CLI: direct | API | Web 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 | ✅ | ✅ | ✅ | ❌ |
| Feature | CLI: interactive | CLI: direct | API | Web 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) | ✅ | ✅ | ✅ | ❌ |
| Feature | CLI: interactive | CLI: direct | API | Web 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.
| VM feature | Create VM configuration | Create VM | Deploy 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: interactive | CLI: direct | API | Web UI |
|---|
| Create VM configuration | ✅ | ✅ | ✅ | ✅ |
| Create and deploy VM (single operation) | ✅ | ✅ | ❌ | ❌ |
| Deploy VM | ✅ | ✅ | ✅ | ✅ |
| Feature | CLI: interactive | CLI: direct | API | Web 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 | ❌ | ✅ | ✅ | ❌ |
| Feature | CLI: interactive | CLI: direct | API | Web 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 | ❌ | ✅ | ❌ | ❌ |
| Feature | CLI: interactive | CLI: direct | API | Web 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 | ❌ | ❌ | ✅ | ❌ |
| Feature | CLI: interactive | CLI: direct | API | Web 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) | ✅ | ✅ | ✅ | ❌ |
| Feature | CLI: interactive | CLI: direct | API | Web 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) | ✅ | ✅ | ✅ | ❌ |
| Feature | CLI: interactive | CLI: direct | API | Web 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.
| Feature | CLI: interactive | CLI: direct | API | Web 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.
| Feature | CLI: interactive | CLI: direct | API | Web 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.
| Feature | CLI: interactive | CLI: direct | API | Web 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.
| Feature | CLI: interactive | CLI: direct | API | Web 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 | ✅ | ✅ | ✅ | ✅ |
| Feature | CLI: interactive | CLI: direct | API | Web 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 | ✅ | ✅ | ✅ | ✅ |
| Feature | CLI: interactive | CLI: direct | API | Web 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 | ✅ | ✅ | ✅ | ❌ |
