Add 1.23.1 release documentation

.custom_wordlist.txt

@@ -57,6 +57,8 @@ cgroup-v1
 cgroup-v2
 config
 conformant
+CORS
+coturn
 Charmhub
 Charmstore
 CLI
@@ -67,15 +69,17 @@ Coturn
 CPUs
 crashdump
 Crashpad
+Cryptographic
+cryptographic
 CSV
 CTS
 CUDA
 customisable
 customisation
 customisations
 CustomLocale
-Cryptographic
-cryptographic
+CVE
+CVEs
 datacenter
 dataset
 deallocate
@@ -171,6 +175,7 @@ LXC
 LXD
 MAAS
 macOS
+micromatch
 middleware
 Minetest
 monospaced
@@ -203,6 +208,7 @@ OOB
 OOM
 OpenAPI
 OpenGL
+OpenID
 OpenSSL
 OpenStack
 PCI
@@ -349,3 +355,5 @@ vTextureCoord
 vec
 uResolution
 presigned
+upstream
+upstreams

custom_conf.py

@@ -119,6 +119,8 @@
 # the sphinx_reredirects extension will be disabled.
 redirects = {
     'howto/container': 'howto/instance',
+    'reference/roadmap': 'reference/release-notes',
+    'reference/supported-versions': 'reference-release-notes',
 }
 
 ############################################################

explanation/anbox-security.md

@@ -7,7 +7,7 @@ Anbox Cloud uses the secure [LXD](https://ubuntu.com/lxd) for container and virt
 
 Consider the following simple yet impactful measures to ensure that you run a secure Anbox Cloud deployment:
 
-- Always run the latest and supported version of Anbox Cloud. See {ref}`ref-roadmap`.
+- Always run the latest and supported version of Anbox Cloud. See {ref}`ref-release-notes`.
 - Do not set the `application.auto_update`, `instance.security_updates`, `container.security_updates` to `false`. See {ref}`ref-ams-configuration`.
 - Monitor resources used by instances regularly.
 - Do not disable TLS pinning when you are not using a load balancer.

explanation/production-planning.md

@@ -55,7 +55,7 @@ See {ref}`exp-security` for more information.
 
 You should keep your Anbox deployment updated to the latest available stable version. You should also update the other applications which make up Anbox. Keeping up to date ensures you have the latest fixes and security patches for smooth operation of your cluster.
 
-For details about the Anbox Cloud release roadmap, see {ref}`ref-roadmap`.
+For details about the Anbox Cloud release roadmap, see {ref}`ref-release-notes`.
 
 ## Data backup
 
@@ -89,4 +89,4 @@ You need the Ubuntu Pro subscription to use Anbox Cloud. Depending on the type o
 
 When you consider a production deployment, it is important to assess your upgrade roadmap. For more information about upgrading Anbox Cloud and the prerequisites required for the upgrade process, see {ref}`howto-upgrade-anbox-cloud`. 
 
-You can also choose to subscribe to the [announcements about Anbox Cloud releases](https://discourse.ubuntu.com/c/anbox-cloud/announcements/55) on discourse. For insights into the Anbox Cloud release roadmap, see {ref}`ref-roadmap`.
+You can also choose to subscribe to the [announcements about Anbox Cloud releases](https://discourse.ubuntu.com/c/anbox-cloud/announcements/55) on discourse. For insights into the Anbox Cloud release roadmap, see {ref}`ref-release-notes`.

index.md

@@ -28,10 +28,7 @@ We welcome community involvement through suggestions, fixes and constructive fee
 - [Report a bug](https://bugs.launchpad.net/anbox-cloud/+bugs) with the product or documentation
 - {ref}`contribute`
 
-The following resources help you get familiar with Anbox Cloud, its releases and roadmap:
-
-- {ref}`Release roadmap <ref-roadmap>`
-- {ref}`ref-release-notes`
+The {ref}`ref-release-notes` helps you get familiar with Anbox Cloud, its releases and roadmap.
 
 For official support requirements, you can get support through [Ubuntu Pro](https://ubuntu.com/support).
 

reference/component-versions.md

@@ -5,6 +5,71 @@ This documents the versions of the different components for each Anbox Cloud rel
 
 Not all components are updated with each release. When components are not updated, they are marked with `n/a` below.
 
+## 1.23.1
+
+### Charms
+
+#### Ubuntu 22.04
+
+| Name | Channel | Revision |
+|----------|--------------|--------------|
+| `anbox-cloud-dashboard` | `1.23/stable` | 515 |
+| `ams-node-controller` (Deprecated) | `1.23/stable` | 524 |
+| `coturn` | `1.23/stable` | 517 |
+| `ams` | `1.23/stable` | 547 |
+| `anbox-stream-gateway`  | `1.23/stable` | 533 |
+| `ams-lxd` | `1.23/stable` | 520 |
+| `anbox-stream-agent` | `1.23/stable` | 528 |
+| `nats` | `latest/stable` | 9 (AMD64), 11 (ARM64) |
+
+
+#### Ubuntu 20.04 (Deprecated)
+
+| Name | Channel | Revision |
+|----------|--------------|--------------|
+| `anbox-cloud-dashboard` | `1.23/stable` | 514 |
+| `ams-node-controller` (Deprecated) | `1.23/stable` | 523 |
+| `coturn` | `1.23/stable` | 516 |
+| `ams` | `1.23/stable` | 546 |
+| `anbox-stream-gateway` | `1.23/stable` | 532 |
+| `ams-lxd` | `1.23/stable` | 519 |
+| `anbox-stream-agent` | `1.23/stable` | 527 |
+| `nats` | `latest/stable` | 10 (AMD64), 12 (ARM64) |
+
+### Bundles
+
+| Name | Channel | Revision |
+|----------|--------------|--------------|
+| `anbox-cloud` | `1.23/stable` | 349|
+| `anbox-cloud-core` | `1.23/stable` | 358 |
+
+### Snaps
+
+| Name |  Channel | Version |
+|----------|--------------|---------|
+| `ams`    | `1.23/stable` | `1.23.1-2eb71a49d` |
+| `aar`    | `1.23/stable` | `1.23.1-2eb71a49d` |
+| `amc`    | `latest/stable` | `1.23.1-2eb71a49d` |
+| `ams-node-controller` (Deprecated) | `1.23/stable` | `1.23.1-2eb71a49d` |
+| `anbox-cloud-dashboard` | `1.23/stable` | `1.23.1-2eb71a49d` |
+| `anbox-stream-agent` | `1.23/stable` | `1.23.1-2eb71a49d` |
+| `anbox-stream-gateway` | `1.23/stable` | `1.23.1-2eb71a49d` |
+| `anbox-connect` | `latest/stable` | `1.23.1-2eb71a49d` |
+| `anbox-cloud-appliance` | `1.23/stable` | `1.23.1-2eb71a49d` |
+
+### Anbox images
+
+The following Anbox images are available in two variants: one based on a container and one based on a virtual machine.
+
+| Name | Version |
+|----------|--------------|
+| `jammy:android13:amd64` | `1.23.1-20240909122006.gitbfce81154` |
+| `jammy:android13:arm64` | `1.23.1-20240909122006.gitbfce81154` |
+| `jammy:android12:amd64` | `1.23.1-20240909122006.gitbfce81154` |
+| `jammy:android12:arm64` | `1.23.1-20240909122006.gitbfce81154` |
+| `jammy:aaos13:amd64`    | `1.23.1-20240909122006.gitbfce81154` |
+| `jammy:aaos13:arm64`    | `1.23.1-20240909122006.gitbfce81154` |
+
 ## 1.23.0
 
 ### Charms

reference/landing.md

@@ -9,11 +9,9 @@ Learn about Anbox Cloud releases, release roadmap, deprecations, supported produ
 
 | Guides | Description  |
 |--|--|
-| {ref}`ref-roadmap` | Information about general release cycle, currently supported version and future releases |
-| {ref}`ref-release-notes` | Release notes for all versions of Anbox Cloud |
+| {ref}`ref-release-notes` | Release notes for all versions of Anbox Cloud, information about supported versions, release cycle, and future releases |
 | {ref}`ref-deprecation-notes` | Deprecation notices for Anbox Cloud and its components |
 | {ref}`ref-component-versions` | Version information about different components of Anbox Cloud for each release |
-| {ref}`ref-supported-versions` | Information about supported Anbox Cloud versions and professional support |
 
 ## Usage
 

reference/release-notes/1.23.1.md

@@ -0,0 +1,132 @@
+---
+orphan: true
+---
+# 1.23.1
+
+These release notes cover new features and changes in Anbox Cloud 1.23.1.
+
+Anbox Cloud 1.23.1 is a patch release. To understand minor and patch releases, see {ref}`ref-release-notes`.
+
+Please see {ref}`ref-component-versions` for a list of updated components.
+
+## Requirements
+
+See the {ref}`ref-requirements` for details on general and deployment specific requirements to run Anbox Cloud.
+
+## New features & improvements
+
+### Anbox Cloud Appliance
+
+* You can now set the following appliance network configuration using `anbox-cloud-appliance config set`:<!--AC-2732-->
+  - The network's public IP address (`network.public_address`)
+  - The network's DNS name (`network.location`)<!--AC-2727-->.
+* You can now configure the [CORS settings](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) for those API endpoints that the appliance reverse proxy passes to the Anbox Stream Gateway. You can set the following using the `anbox-cloud-appliance config set` command:<!--AC-2732-->
+  - The [HTTP origin](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Origin) (`core.https_allowed_origin`)
+  - List of allowed HTTP headers (`core.https_allowed_headers`)
+  - List of allowed HTTP methods (`core.https_allowed_methods`)
+* You can skip setting up coturn when initialising the appliance and can configure a custom STUN server.<!--AC-2719-->
+* The [`prepare-node-script`](prepare-node-script.md) command is extended to support systems with an already installed NVIDIA driver. <!--AC-2714-->
+* You can now set up a custom identity provider for the dashboard by configuring an OpenID Connect provider through the preseed configuration when initialising the appliance.
+
+### Streaming
+
+* With the 1.23.0 release, the functionalities of the *Instances* page and the *Sessions* page on the web dashboard were merged. For debugging purposes, viewing a list of available sessions can be really useful. With the 1.23.1 release, you can list all available sessions using the `anbox-stream-gateway sessions list` command.<!--AC-2662-->
+* You can dynamically change the display density when joining an existing streaming session.<!--AC-2673-->
+
+### VHAL
+
+* Starting with 1.23.0, the VNDK version required for building a custom VHAL is 34.<!--AC-2720-->
+
+### Android vendor image
+
+* WiFi support for Android 12 vendor images.<!--AC-2707-->
+
+### Other
+
+* Android security updates for September 2024 (see [Android Security Bulletin - September 2024](https://source.android.com/docs/security/bulletin/2024-09-01) for more information). <!--AC-2712-->
+* The Android WebView has been updated to [128.0.6613.127](https://chromereleases.googleblog.com/2024/09/chrome-for-android-update.html).
+
+## Known issues
+
+* Since version 1.23.0, the Anbox WebRTC Data Proxy service starts on demand rather than at container startup. However, its startup time may take longer than expected, which can negatively impact the {ref}`out-of-band data exchange <sec-oob-data-version-2>` between the WebRTC server and client. This issue can be worked around by applying the following tweak in a [pre-start hook](https://anbox-cloud.io/docs/ref/hooks).
+
+  ```
+  #!/bin/sh -ex
+  if  [ "$CONTAINER_TYPE" = "regular" ]; then
+    exit 0
+  fi
+
+  DROP_IN_DIR=/etc/systemd/system/anbox-webrtc-data-proxy.service.d/
+  sudo mkdir -p "${DROP_IN_DIR}"
+  sudo tee "${DROP_IN_DIR}/override.conf" > /dev/null <<EOF
+  [Install]
+  WantedBy=multi-user.target
+  EOF
+
+  sudo systemctl daemon-reload
+  sudo systemctl enable anbox-webrtc-data-proxy
+  ```
+* For the Anbox Cloud Appliance deployment, after it is initialised, you may encounter the following error when creating an application or launching an instance:
+
+  ```
+  Failed to load kernel module ''anbox_sync'': Failed to run: modprobe -b anbox_sync: exit status 1 (modprobe: FATAL: Module anbox_sync not found in directory /lib/modules/x.x.x-xxxx-aws)'
+  ```
+  To resolve this issue, install the required package:
+
+      sudo apt install linux-headers-$(uname -r)
+
+  Then reinstall the `anbox-modules-dkms-123` package:
+
+      sudo apt install --reinstall anbox-modules-dkms-123
+
+  After completing these steps, you should be able to create an application or launch an instance normally. The issue will be fixed in the next patch release.
+
+* Launching a VM image with default size fails with the following error: <!--LP 2076907-->
+
+      $ amc launch -r --vm jammy:android13:arm64 --devmode
+      Error: Failed creating instance from image: Source image size (16106127360) exceeds specified volume size (15000010752)
+
+  To work around this issue, specify a disk size when launching the image:
+
+      $ amc launch -r --vm jammy:android13:arm64 --devmode --disk-size 20GB
+
+## CVEs
+
+The Anbox Cloud 1.23.1 release includes fixes from the respective upstreams for the following CVEs:
+
+| CVE | Affected Components |
+|-----|---------------------|
+| [CVE-2024-4067](https://nvd.nist.gov/vuln/detail/CVE-2024-4067) | Anbox Cloud dashboard,<br/> Anbox Cloud Appliance |
+| [CVE-2024-39338](https://nvd.nist.gov/vuln/detail/CVE-2024-39338) | Anbox Cloud dashboard,<br/> Anbox Cloud Appliance |
+| [CVE-2024-32896](https://nvd.nist.gov/vuln/detail/CVE-2024-32896) | AOSP 12/13/14 image,<br/>AAOS 13 image |
+| [CVE-2024-40650](https://nvd.nist.gov/vuln/detail/CVE-2024-40650) | AOSP 12/13/14 image,<br/>AAOS 13 image |
+| [CVE-2024-40652](https://nvd.nist.gov/vuln/detail/cve-2024-40652) | AOSP 12/13/14 image,<br/>AAOS 13 image |
+| [CVE-2024-40654](https://nvd.nist.gov/vuln/detail/CVE-2024-40654) | AOSP 12/13/14 image,<br/>AAOS 13 image |
+| [CVE-2024-40655](https://nvd.nist.gov/vuln/detail/CVE-2024-40655) | AOSP 12/13/14 image,<br/>AAOS 13 image |
+| [CVE-2024-40656](https://nvd.nist.gov/vuln/detail/CVE-2024-40656) | AOSP 12/13/14 image,<br/>AAOS 13 image |
+| [CVE-2024-40657](https://nvd.nist.gov/vuln/detail/CVE-2024-40657) | AOSP 12/13/14 image,<br/>AAOS 13 image |
+| [CVE-2024-40658](https://nvd.nist.gov/vuln/detail/CVE-2024-40658) | AOSP 12/13/14 image,<br/>AAOS 13 image |
+| [CVE-2024-40659](https://nvd.nist.gov/vuln/detail/CVE-2024-40659) | AOSP 14 image |
+| [CVE-2024-40662](https://nvd.nist.gov/vuln/detail/CVE-2024-40662) | AOSP 12/13/14 image,<br/>AAOS 13 image |
+
+## Bug fixes
+
+* [LP 2080334](https://bugs.launchpad.net/anbox-cloud/+bug/2080334) Peer connection fails with the following error: `InvalidStateError: remote description is not set`.<!--AC-2690-->
+* [LP 2080329](https://bugs.launchpad.net/anbox-cloud/+bug/2080329) After deploying the new epoch=1 version of the appliance behind a NAT, services are not publicly accessible even when configured for public access.
+* [LP 2077999](https://bugs.launchpad.net/anbox-cloud/+bug/2077999) For most of the WebRTC signaling messages exchanged between client and Anbox, the first discover message takes ~2s to receive a response.
+* [LP 2077944](https://bugs.launchpad.net/anbox-cloud/+bug/2077944) A session that enters into an error status cannot be revived again even when the associated instance is started again.
+* [LP 2077188](https://bugs.launchpad.net/anbox-cloud/+bug/2077188) When using the Anbox Cloud Appliance, the dashboard UI displays a `Something unexpected has gone wrong` error after 5 seconds.
+* [LP 2077116](https://bugs.launchpad.net/anbox-cloud/+bug/2077116) The new version of the Anbox Cloud Appliance (epoch=1) is missing required firewall rules on Oracle Cloud deployments.
+* [LP 2076893](https://bugs.launchpad.net/anbox-cloud/+bug/2076893) Instances without GPU encoding fail to start.
+* [LP 2076593](https://bugs.launchpad.net/anbox-cloud/+bug/2076593) In regular Anbox Cloud deployments, when trying to register the web dashboard, the dashboard displays an error that it is missing information to connect to either the Anbox Management Service (AMS) or the Anbox Stream Gateway. This error is caused due the dashboard charm failing to generate the certificate and key.
+* [LP 2076894](https://bugs.launchpad.net/anbox-cloud/+bug/2076894) The new epoch=1 version of the appliance uses a node preparation script which does not detect the history of enabling Anbox Cloud on Ubuntu Pro, irrespective of the Ubuntu release.
+* [LP 2077898](https://bugs.launchpad.net/anbox-cloud/+bug/2077898) Screen resolution selector for AAOS doesn't show predefined resolutions when creating a new instance for the first time (no instances or applications exist).
+* Private bugs:
+  - [LP 2076494](https://bugs.launchpad.net/anbox-cloud/+bug/2076494)
+  - [LP 2071806](https://bugs.launchpad.net/anbox-cloud/+bug/2071806)
+  - [LP 2071925](https://bugs.launchpad.net/anbox-cloud/+bug/2071925)
+  - [LP 2075494](https://bugs.launchpad.net/anbox-cloud/+bug/2075494)
+
+## Upgrade instructions
+
+See {ref}`howto-upgrade-anbox-cloud` and {ref}`howto-upgrade-appliance` for instructions on how to update your Anbox Cloud deployment to the 1.23.1 release.

reference/release-notes/release-notes-template.md

@@ -3,9 +3,15 @@ orphan: true
 ---
 # < Release version >
 
-The Anbox Cloud team is pleased to announce the release of Anbox Cloud < release-version >.
+These release notes cover new features and changes in Anbox Cloud < version >.
 
-Please see [component versions](https://documentation.ubuntu.com/anbox-cloud/en/latest/reference/component-versions) for a list of updated components.
+Anbox Cloud < version > is a < minor/patch > release. To understand minor and patch releases, see {ref}`ref-release-notes`.
+
+Please see {ref}`ref-component-versions` for a list of updated components.
+
+## Requirements
+
+See the {ref}`ref-requirements` for details on general and deployment specific requirements to run Anbox Cloud.
 
 ## New features & improvements
 
@@ -34,4 +40,4 @@ Please see [component versions](https://documentation.ubuntu.com/anbox-cloud/en/
 
 ## Upgrade instructions
 
-See [Upgrade Anbox Cloud](https://documentation.ubuntu.com/anbox-cloud/en/latest/howto/update/upgrade-anbox) or [Upgrade the Anbox Cloud Appliance](https://documentation.ubuntu.com/anbox-cloud/en/latest/howto/update/upgrade-appliance) for instructions on how to update your Anbox Cloud deployment to the < release-version > release.
+See {ref}`howto-upgrade-anbox-cloud` and {ref}`howto-upgrade-appliance` for instructions on how to update your Anbox Cloud deployment to the < release-version > release.