Saving Images
orka3 vm save
Save a new image from a running VM. This saves the file system and the state of the OS, including any running applications. You can preserve the original image and deploy new VMs with the applied changes from the new image.
Image Name Requirements:
- Does not exceed 63 characters including the file extension (if set)
- Consists of lowercase alphanumeric characters, dashes (-) or periods (.)
- Must be unique to the cluster
Note: Saving a new image is an async operation. To check the status: orka3 image list NEW_IMAGE_NAME. This operation does not affect the original image of the VM. This operation restarts the VM.
Syntax:
Options:
Examples:
orka3 vm commit
Update an existing image from a running VM. Take the changes from the specified deployed VM and commit them back to its respective base image. For Intel-based VMs, the image must not be in use by any other VMs.
This operation applies any file system changes and the state of the OS, including any running applications, to the original image.
Note: Committing changes to an existing image is an async operation. To check the status: orka3 image list IMAGE_NAME. This operation restarts the VM.
Syntax:
Options:
Examples:
Pushing to OCI Registries
orka3 vm push
(Apple silicon-only) The state of a running VM is saved on the host and pushed to an OCI-compatible registry.
The provided image must be in the following format: server.com/repository/image:tag. The :tag portion is optional and defaults to latest if not provided.
Requirements:
- Registry credentials must exist in the same namespace as the VM
- This is an async operation. To check the status:
orka3 vm get-push-status JOB_NAME
Syntax:
Options:
Examples:
orka3 vm get-push-status
(Apple silicon-only) View the status of an image being pushed to an OCI-compatible registry. The status is viewable for one (1) hour after finishing, after which point the underlying job is cleaned up.
If a job name is not provided, the status of all current image push operations is shown. The job name is initially shown when the image push operation is started.
Syntax:
Options:
Examples:
Resizing VM Disks
orka3 vm resize
Resize the disk of a running VM; but only increase the size of the disk.
Architecture-Specific Behavior:
- For Apple silicon-based VMs (arm64): Nothing is needed after the command completes
- For Intel-based VMs (amd64): Provide SSH access credentials for Orka to complete the resize and repartition automatically. If not provided, it must be completed manually
For Intel-based VMs, you can save or commit the modified image manually:
Resize always assumes working in GB. This operation restarts the VM.
Syntax:
Options:
Examples:
Power Operations (Intel Only)
Note: Power operations are only available for Intel-based VMs. Stopped or suspended VMs appear as ‘Running’ when listed with orka3 vm list.
orka3 vm start
Power ON a stopped VM. The orka3 vm stop and orka3 vm start sequence acts as a VM reboot.
Syntax:
Options:
Examples:
orka3 vm stop
Power OFF a running VM. The orka3 vm stop and orka3 vm start sequence acts as a VM reboot.
Syntax:
Options:
Examples:
orka3 vm suspend
Suspend a running VM. This operation freezes all running processes on the VM, without turning it off. The orka3 vm suspend and orka3 vm resume sequence acts as putting the VM on hold then resuming it.
Syntax:
Options:
Examples:
orka3 vm resume
Resume a suspended VM. This operation resumes all suspended processes on the VM, without turning it on.
Syntax:
Options:
Examples:
Reverting VMs (Intel Only)
orka3 vm revert
(Intel-only) Revert a VM to the latest state of its image. This operation restarts the VM.
This operation cannot be undone. Any unsaved or uncommitted data will be lost and unable to be retrieved.
