1.22.0 release notes

.wordlist.txt

@@ -119,6 +119,7 @@ gRPC
 gzip
 HAProxy
 HIDL
+Honkai
 hotfix
 HTTPS
 HW
@@ -292,6 +293,7 @@ unpublish
 unschedulable
 untrusted
 uptime
+userspace
 UTF
 validator
 vCPU

index.md

@@ -186,7 +186,8 @@ Thinking about using Anbox Cloud for your next project? [Get in touch!](https://
 | 0 | | |
 | 1 | |[Documentation feedback](https://forms.gle/6yzgLbwN8rVYSdvG9)|
 | 0 | | |
-|   | reference/release-notes/1.21.1 | [Release notes-Anbox Cloud 1.21.2](https://discourse.ubuntu.com/t/44276)|
+|   | reference/release-notes/1.22.0 | [Release notes-Anbox Cloud 1.22.0](tbd)|
+|   | reference/release-notes/1.21.2 | [Release notes-Anbox Cloud 1.21.2](https://discourse.ubuntu.com/t/44276)|
 |   | reference/release-notes/1.21.1 | [Release notes-Anbox Cloud 1.21.1](https://discourse.ubuntu.com/t/43279)|
 |   | reference/release-notes/1.21.0 | [Release notes-Anbox Cloud 1.21.0](https://discourse.ubuntu.com/t/42429)|
 |   | reference/release-notes/1.20.2 | [Release notes-Anbox Cloud 1.20.2](https://discourse.ubuntu.com/t/41686)|

reference/release-notes/1.22.0.md

@@ -0,0 +1,88 @@
+## Introduction
+
+The Anbox Cloud team is pleased to announce the release of Anbox Cloud 1.22.0.
+
+Please see [component versions](https://anbox-cloud.io/docs/reference/component-versions) for a list of updated components.
+
+## New features & improvements
+
+The 1.22.0 release of Anbox Cloud brings the following features and improvements:
+
+### Core stack improvements
+* Support for 64-bit only systems for all supported Android versions.<!--AC-1890, AC-2428-->
+* Support for installing relevant 32-bit NVIDIA userspace binaries on AMD64 systems.<!--AC-2450-->
+* To allow easier identification and use of instances, you can now explicitly name an instance when creating it. See [How to create an instance](https://anbox-cloud.io/docs/howto/instance/create).<!--AC-2395-->
+* Support for Vulkan 1.3 for Android 13 images.<!--AC-2278-->
+* VHAL enhancements:
+    - Configuration returned by the APIs have a new field containing a name and a list of area names for the standard VHAL properties.<!--AC-2290 and AC-2289-->
+    - Property values returned by the APIs have a new field containing a list of area names for the standard VHAL properties.<!--AC-2290-->
+    - You can replace the Anbox Cloud VHAL implementation with your custom implementation for AAOS images. See [How to use a custom VHAL implementation](tbd). <!--AC-2371-->
+
+### Streaming stack improvements
+
+* Streaming can now be enabled when launching an instance using the `--enable-streaming` option. See [How to stream applications](https://anbox-cloud.io/docs/howto/application/stream) and [How to create an instance](https://anbox-cloud.io/docs/howto/instance/create).<!--Ac-2460 and AC-2360-->
+* VirGL is the default renderer for NVIDIA GPUs with driver version 545 and later. For driver versions earlier than 545 or old NVIDIA GPU architecture such as Turing, Ampere or Ada, EmuGL is used as the default renderer. See [Rendering architecture](https://anbox-cloud.io/docs/explanation/rendering-architecture).<!--AC-2459, AC-2270 and AC-2348-->
+* Experimental support for [pointer lock](https://developer.mozilla.org/en-US/docs/Web/API/Pointer_Lock_API) is available with this release. This helps in locking the pointer to a particular browser element, for example, your game window, and limits movement outside the game until the lock is disabled. The pointer lock property must be explicitly enabled on the stream object via the [streaming SDK](https://github.com/canonical/anbox-streaming-sdk).<!--AC-2379-->
+* All components of Anbox Cloud upgrade to NVIDIA 550 driver series by default on Ubuntu 22.04 images. For Ubuntu 20.04 images, 535 driver series will be used. <!--AC-2309-->
+
+
+### Dashboard improvements
+
+The following improvements are available in the Anbox Cloud dashboard for this release:
+
+* Page level guided tours are now available for help in navigating through the dashboard.
+* Support for using custom authentication server instead of Ubuntu SSO.
+* Custom instance name field in *Create instance* form.
+* User experience enhancements to the AAOS control panel:
+  - Extending VHAL support to allow setting the geographic location and to be able to provide and revoke consent for enabling APIs in the browser when using maps.
+* Enhancements to forms to support AOSP vs AAOS applications.
+
+### Other
+
+* Support for building custom images of Anbox Cloud based on AAOS. See [Custom images](tbd).<!--AC-2458-->
+* Android security updates for May 2024 (see [Android Security Bulletin - May 2024](https://source.android.com/docs/security/bulletin/2024-05-01) for more information).<!--AC-2437-->
+* The Android WebView has been updated to [124.0.6367.82](https://chromereleases.googleblog.com/2024/04/chrome-for-android-update_24.html).
+
+## Deprecations
+
+* Support for Ubuntu 20.04 (focal) will be dropped in a future release.
+* Support for the EmuGL renderer is removed in Anbox Cloud 1.23.0.
+* The Anbox Cloud Appliance is being reworked and the current implementation is deprecated. Existing installations of the current implementation will receive updates until Anbox Cloud 1.24.2. Starting from 1.23.0, new installations will receive the new implementation of the appliance.
+
+  The new implementation of the appliance will no longer use the Juju charmed operators internally but package all necessary service components directly within the snap. This helps to simplify the installation process and reduce overall footprint.
+
+## Removed functionality
+
+* Documentation on how to enable VirGL manually is removed because with this release, VirGL is the default renderer for NVIDIA GPUs.
+
+## Known issues
+
+* Video playback does not work on 64-bit only systems where the NVIDIA GPU is installed.
+
+## Bugs fixed
+
+* [LP 2061700](https://bugs.launchpad.net/anbox-cloud/+bug/2061700) When streaming from an instance that is based on an AAOS image, the following error is displayed on the right panel:<!--AC-2456-->
+
+  ```
+  VHAL error, could not get fan positions
+  ```
+* [LP 2060110](https://bugs.launchpad.net/anbox-cloud/+bug/2060110) Keyboard is not displayed in the *Honkai: Star Rail*.<!--AC-2446-->
+* [LP 2045823](https://bugs.launchpad.net/anbox-cloud/+bug/2045823) Keyboard display flickers in *Monopoly Go*. <!--AC-2439 and 2168-->
+* [LP 2059887](https://bugs.launchpad.net/anbox-cloud/+bug/2059887) Sluggish performance when playing *Honkai: Star Rail*.<!--AC-2433-->
+* [LP 2058423](https://bugs.launchpad.net/anbox-cloud/+bug/2058423) Compatibility issues with *Monopoly Go* and *Marvel Strike* in Vulkan mode causing the games to end abruptly.<!--AC-2402-->
+* [LP 2056707](https://bugs.launchpad.net/anbox-cloud/+bug/2056707) Android system unable to boot due to the error: `Extension not supported: VK_KHR_swapchain`. <!--AC-2363-->
+* [LP 2056527](https://bugs.launchpad.net/anbox-cloud/+bug/2056527) Android stops working with the error `MESA-VIRTIO: failed to create nv_mem from dma_buf`.<!--AC-2357-->
+* [LP 2046249](https://bugs.launchpad.net/anbox-cloud/+bug/2046249) Deleted applications leave behind base instances in *Error* state.<!--AC-2257-->
+* [LP 2060023](https://bugs.launchpad.net/anbox-cloud/+bug/2060023) Missing `min` values for VHAL properties.
+* [LP 2060605](https://bugs.launchpad.net/anbox-cloud/+bug/2060605) The post-stop hook fails to be called when terminating a session via the gateway DELETE endpoint API.
+* [LP 2061741](https://bugs.launchpad.net/anbox-cloud/+bug/2061741) VHAL panel displays empty values for VHAL properties.
+* Compilation errors when building Anbox kernel modules on kernel 6.8 <!--AC-2359-->
+* When using the web dashboard, occasionally the VHAL panel does not appear due to timing issues between the stream client, the stream gateway, the stream agent and the server.<!--AC-2288 and AC-2286-->
+* When running Anbox Cloud with VirGL enabled on NVIDIA L4 GPUs, Android stops abruptly on startup with the following error:<!--AC-2335-->
+
+  ```
+  vtest_resource_create_blob called virgl_renderer_resource_create_blob which failed (-1)
+  ```
+## Upgrade instructions
+
+See [Upgrade Anbox Cloud](https://anbox-cloud.io/docs/howto/update/upgrade-anbox) or [Upgrade the Anbox Cloud Appliance](https://anbox-cloud.io/docs/howto/update/upgrade-appliance) for instructions on how to update your Anbox Cloud deployment to the 1.22.0 release.