Feature Parity: Orka Tools
Feature parity across the Orka CLI, Orka API, and the Orka Web UI.
Quick navigation
General: macOS versions | General features | Tool configuration | Checks
Users: Users
Service accounts: Service accounts
Namespaces: Namespaces
Nodes: Nodes
VMs: Listing and info | Create VM configurations | Deploy VMs | Start/stop/suspend/resume | Delete and purge | Storage | Networking | Performance
Images: Images
ISOs: ISOs
General features
| Feature | Orka3 CLI | Orka3 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 WIDE format | β | β | β |
| View output in JSON format | β | β | β |
Tool configuration
| Feature | Orka3 CLI | Orka 3 API | Web UI |
|---|---|---|---|
| Configure API IP | β | β | β |
| Configure built-in Orka domain | β | β * | β * |
| Configure external custom domain | β | β * | β |* |
| Upload TLS certificate to use with an external custom domain | β | β | β |
* Requires additional configuration. See Built-In Orka Domains and External Custom Domains.
Checks
| Feature | Orka3 CLI | Orka3 API | Web UI |
|---|---|---|---|
| Check the current tool version | β | β | β |
Users
| Feature | Orka 3 CLI | Orka3 API | Web UI |
|---|---|---|---|
| Log in | β | β | β * |
| Log out | β | β | β |
| Get token | β | β | β |
| Set token (authenticate with a pre-existing token) | β | β | β |
| Manage role bindings for the user | β | β | β |
* You need an authentication token obtained with the Orka3 CLI.
Service accounts
| Feature | Orka3 CLI | Orka3 API | Web UI |
|---|---|---|---|
| Create service account | β | β | β |
| Get service account token | β | β | β |
| List service accounts | β | β | β |
| Delete service account | β | β | β |
| Manage role bindings for the service account | β | β | β |
Namespaces
| Orka3 API | Orka3 CLI | Orka3 API | Web UI |
|---|---|---|---|
| List namespaces | β | β | β |
| Create namespace | β | β | β |
| Delete namespace | β | β | β |
| Manage role bindings for the namespace | β | β | β |
Nodes
| Feature | CLI: direct | API | Web UI |
|---|---|---|---|
| List nodes | β | β | β |
| Assign node to a namespace (formerly, grouping) | β | β | β |
| Assign node to a namespace with enabled custom pods (formerly, sandboxing) | β | β | β |
| Apply tag (node affinity) | β | β | β |
| Remove tag (node affinity) | β | β | β |
VMs: Listing and info
| Feature | Orka3 CLI | Orka3 API | Web UI |
|---|---|---|---|
| List all users' VMs | β | β | β |
| List specific VMs | β | β | β |
| List all users' VM configurations | β | β | β |
| List specific VM configurations | β | β | β |
| List the VM's ports reserved for VNC, SSH, and Apple Screen Sharing | β | β | β |
| List the VM's ports reserved for port forwarding | β | β | β |
VMs: Create VM configurations
| Feature | Orka3 CLI | Orka3 API | Web UI |
|---|---|---|---|
| Create basic VM configuration (name, image) | β | β | β |
| Create VM configuration with custom memory | β | β | β |
| Create VM configuration with attached ISO | β | β | β |
| 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: Deploy VMs
| Feature | Orka3 CLI | Orka3 API | Web UI |
|---|---|---|---|
| Deploy basic VM (name, image) | β | β | β |
| Deploy VM with custom memory | β | β | β |
| Deploy VM with attached ISO | β | β | β |
| Deploy VM with enabled/disabled VNC | β | β | β |
| Deploy VM with enabled/disabled I/O boost | β | β | β |
| Deploy VM with enabled/disabled Network boost | β | β | β |
| Deploy VM with enabled/disabled GPU passthrough | β | β | β |
| Deploy VM with custom serial number | β | β | β |
| Deploy VM with preferred tag (node affinity) | β | β | β |
| Deploy VM with required tag (node affinity) | β | β | β |
| Deploy VM with custom scheduler | β | β | β |
| Deploy without VM configuration | β | β | β |
| Deploy from VM configuration | β | β | β |
| Deploy VM from VM configuration and override the VM configuration | β | β | β |
VMs: Start/stop/suspend/resume
| Feature | Orka3 CLI | Orka3 API | Web UI |
|---|---|---|---|
| Stop VM by name (power off) | β | β | β |
| Start VM by name (power on) | β | β | β |
| Suspend VM by name (sleep) | β | β | β |
| Resume VM by name (wake) | β | β | β |
VMs: Delete and purge
| Feature | Orka3 CLI | Orka3 API | Web UI |
|---|---|---|---|
| Delete VM by name | β | β | β |
| Purge VM config (delete the VM config and any instances) | β | β | β |
VMs: Storage
| Feature | Orka3 CLI | API | Web UI |
|---|---|---|---|
| Shared VM storage** | β | β | β |
| I/O boost | β | β | β |
** You can access and manage the shared storage from within the VM.
VMs: Networking
| Feature | Orka3 CLI | Orka3 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.
VMs: Performance
| Feature | Orka3 CLI | Orka3 API | Web UI |
|---|---|---|---|
| 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
| Feature | Orka3 CLI | Orka3 API | Web UI |
|---|---|---|---|
| Deploy from public OCI-compatible images | β | β | β * |
| Deploy from private OCI-compatible images (with registry credentials configured locally) | β | β | β * |
| Push an image from a running VM to an OCI-compatible registry (with registry credentials configured locally) | β | β | β |
| 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 | β | β | β |
| Set an image description | β | β | β |
| 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 | β | β | β |
* If the respective VM configuration was created with the Orka3 CLI or the Orka3 API, and if the respective registry credentials are configured for the orka-default namespace.
ISOs
| Feature | Orka3 CLI | Orka3 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 | β | β | β |
| Download an ISO | β | β | β |
| Upload an ISO | β | β | β |
See also
Updated 5 months ago