Orka 3.4 Release Notes

The Orka 3.4.0 release brings with it an update to allow users to set custom display settings when deploying or configuring a VM using Orka.

New Features

In Orka 3.4.0, users can now set custom display settings when deploying or configuring a VM as a part of their UI testing workflow. Users can access this workflow via the Orka CLI. These instructions assume you are currently logged into your Orka cluster, and can access your VMs using Apple Screen Sharing and an applicable image running a version of MacOS.

Set display settings at VM deployment:

The orka3 vm deploy command has the following new options:

--display-width - Adjust console display window width in pixels
--display-height - Adjust console display window height in pixels
--display-dpi - Adjust console display density in pixels

In the following example, we have specified a VM deployment running Sequoia 15.4.1 with a height of 2560px, a width of 1600px, and a DPI of 320px.

New Orka 3.4.0 CLI commands for setting VM display width, height, and DPI

New Orka 3.4.0 CLI commands for setting VM display width, height, and DPI

Examples:

Deploy a VM running MacOS Sequoia 15.4.1 with a display width of 2560x1600px and 320px display DPI (HiDPI):orka3 vm deploy --image ghcr.io/macstadium/orka-images/sequoia:15.4.1 --display-width 2560 --display-height 1600 --display-dpi 320

Deploy a VM running the latest version of Mac OS Sequoia (15.5) with a display width of 1920x1080px and a display DPI of 90px:orka3 vm deploy --image ghcr.io/macstadium/orka-images/sequoia:latest-display-width 1920 --display-height 1080 --display-dpi 90

After the VM is successfully created, the display settings specified in the CLI will be reflected in the VM’s display as was specified by the user:

A deployed Sequoia VM login screen with display resolution configurations set using the Orka 3.4.0 CLI

A deployed Sequoia VM login screen with display resolution configurations set using the Orka 3.4.0 CLI

Set display settings for VM configurations:

The orka3 vm create command has the following new options:

--display-width - Adjust console display window width in pixels
--display-height - Adjust console display window height in pixels
--display-dpi - Adjust console display density in pixels

The following constraints apply to both deployed and configured VMs:

  • Supports a minimum width of 320 px.
  • Supports a maximum width of 3840 px.
  • Supports a minimum height of 480 px.
  • Supports maximum height of 2160 px.
  • Supports a minimum DPI of 60 px.
  • Supports a maximum DPI of 240 px.
  • Supports an optional maximum DPI of 320 px.

If a user selects an unsupported resolution, they will see the following error(s):

Display height error when deploying a VM on Orka 3.4.0

Display height error when deploying a VM on Orka 3.4.0

Set display settings via Orka API at VM deployment

Users can now set custom display settings when deploying a VM via the Orka API.

The POST /api/v1/namespaces/{namespace}/vms route now accepts the following fields:

displayWidth - Adjust console display width in pixels
displayHeight- Adjust console display height in pixels
displayDPI- Adjust console display density in pixels

Set display settings via Orka API at VM configuration

Users can now set custom display settings when configuring a VM via the Orka API.

The POST /api/v1/namespaces/{namespace}/vmconfigs route now accepts the following fields:

displayWidth - Adjust console display width in pixels
displayHeight- Adjust console display height in pixels
displayDPI- Adjust console display density in pixels

Example of adjusting display resolution via the Orka API

Example of adjusting display resolution via the Orka API

The following constraints apply to both deployed and configured VMs:

  • Supports a minimum width of 320 px.
  • Supports a maximum width of 3840 px.
  • Supports a minimum height of 480 px.
  • Supports maximum height of 2160 px.
  • Supports a minimum DPI of 60 px.
  • Supports a maximum DPI of 240 px.
  • Supports an optional maximum DPI of 320 px.

Improvements to existing features

Internal improvements resulting in faster deployment times overall.

VMs created from an IPSW now have a default display resolution of 1920x1080x96 px.

Bug fixes

This release addresses the [known issue](Orka 3.3 Release Notes ) in Orka 3.3.0 involving virtualization and unique machine identifiers. Unique machine ID/UUID configuration is now behind a feature flag. Customers who need unique machine IDs for their Orka environment should raise a support ticket with MacStadium to control this behavior for their cluster.

Orka no longer sends cookies when interacting with OCI registries


© 2019-2023 Copyright MacStadium, Inc. – Documentation built with readme.com. Orka is a registered trademark of MacStadium, Inc.