Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

1.21.0 doc updates #30

Merged
merged 11 commits into from
Feb 14, 2024
10 changes: 5 additions & 5 deletions howto/update/upgrade-anbox.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ The deployed Juju charms need to be upgraded next.

- You can find a list of all charm, snap and Debian package versions for each Anbox Cloud release in the [component versions](https://discourse.ubuntu.com/t/component-versions/21413) overview. This also includes the charm and bundle revisions and channels for each release.

- Starting with the 1.14 release, all charms come from [Charmhub](https://charmhub.io) and use the concept of [channels](https://snapcraft.io/docs/channels) to track particular versions. The instructions below address how to upgrade from a 1.13.x release, where charms were still from the old Juju charm store. The `--channel=1.20/stable` argument instructs Juju to switch to the latest [Charmhub](https://charmhub.io) version of the charm and track the right channel.
- Starting with the 1.14 release, all charms come from [Charmhub](https://charmhub.io) and use the concept of [channels](https://snapcraft.io/docs/channels) to track particular versions. The instructions below address how to upgrade from a 1.13.x release, where charms were still from the old Juju charm store. The `--channel=1.21/stable` argument instructs Juju to switch to the latest [Charmhub](https://charmhub.io) version of the charm and track the right channel.

- With the 1.14 release, the name of the `lxd` charm changed to `ams-lxd`. If you run a deployment older than 1.14 and want to upgrade, add `--switch=ams-lxd` to the upgrade command to make Juju switch to the new charm. The charm itself remains identical with the same functionality and features.

Expand Down Expand Up @@ -95,7 +95,7 @@ The Anbox Application Registry (AAR) can be updated independently of the other s

To upgrade the registry, run

juju refresh --channel=1.20/stable aar
juju refresh --channel=1.21/stable aar

### Upgrade control plane

Expand Down Expand Up @@ -124,19 +124,19 @@ Since the NATS charm has been overhauled to use the modern charm framework (Ops

The AMS service needs to be updated independently of the other service components to ensure minimal down time. The charm can be upgraded by running the following command.

juju refresh --channel=1.20/stable ams
juju refresh --channel=1.21/stable ams

### Upgrade LXD

As the last step, you have to upgrade the LXD cluster. Upgrading LXD will not restart running instances but it's recommended to take a backup before continuing.

As the first step, you need to upgrade the AMS node controller by running:

juju refresh --channel=1.20/stable ams-node-controller
juju refresh --channel=1.21/stable ams-node-controller

Once the upgrade is completed, you can continue upgrading LXD:

juju refresh --channel=1.20/stable lxd
juju refresh --channel=1.21/stable lxd

In some cases, specifically when you maintain bigger LXD clusters or want to keep a specific set of LXD nodes active until users have dropped, it makes sense to run the upgrade process manually on a per node basis. To enable this, you can set the following configuration option for the LXD charm before running the refresh command above:

Expand Down
1 change: 1 addition & 0 deletions index.md
Original file line number Diff line number Diff line change
Expand Up @@ -182,6 +182,7 @@ 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.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.20.1 | [Release notes-Anbox Cloud 1.20.1](https://discourse.ubuntu.com/t/40988)|
| | reference/release-notes/1.20.0 | [Release notes-Anbox Cloud 1.20.0](https://discourse.ubuntu.com/t/40281)|
Expand Down
63 changes: 63 additions & 0 deletions reference/component-versions.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,69 @@ 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, this is called out in the [release notes](https://discourse.ubuntu.com/t/release-notes/17842) and components are marked with `n/a` below.

## 1.21.0

### Charms

#### Ubuntu 22.04

| Name | Channel | Revision |
|----------|--------------|--------------|
| `anbox-cloud-dashboard` | `1.21/stable` | 307 |
| `ams-node-controller` | `1.21/stable` | 315 |
| `coturn` | `1.21/stable` | 309 |
| `ams` | `1.21/stable` | 320 |
| `aar` | `1.21/stable` | 314 |
| `anbox-stream-gateway` | `1.21/stable` | 325 |
| `ams-load-balancer` | `1.21/stable` | 315 |
| `ams-lxd` | `1.21/stable` | 312 |
| `anbox-stream-agent` | `1.21/stable` | 320 |
| `nats ` | `latest/stable` | 11 |

#### Ubuntu 20.04

| Name | Channel | Revision |
|----------|--------------|--------------|
| `anbox-cloud-dashboard` | `1.21/stable` | 306 |
| `ams-node-controller` | `1.21/stable` | 314 |
| `coturn` | `1.21/stable` | 308 |
| `ams` | `1.21/stable` | 319 |
| `aar` | `1.21/stable` | 313 |
| `anbox-stream-gateway` | `1.21/stable` | 324 |
| `ams-load-balancer` | `1.21/stable` | 314 |
| `ams-lxd` | `1.21/stable` | 311 |
| `anbox-stream-agent` | `1.21/stable` | 319 |
| `nats ` | `latest/stable` | 11 |

### Bundles

| Name | Channel | Revision |
|----------|--------------|--------------|
| `anbox-cloud` | `1.21/stable` | 182 |
| `anbox-cloud-core` | `1.21/stable` | 189 |

### Snaps

| Name | Channel | Version |
|----------|--------------|---------|
| `ams` | `1.21/stable` | 1.21.0 |
| `aar` | `1.21/stable` | 1.21.0 |
| `ams-node-controller` | `1.21/stable` | 1.21.0 |
| `anbox-cloud-dashboard` | `1.21/stable` | 1.21.0 |
| `anbox-stream-agent` | `1.21/stable` | 1.21.0 |
| `anbox-stream-gateway` | `1.21/stable` | 1.21.0 |
| `anbox-cloud-appliance` | `1.21/stable` | 1.21.0 |


### Anbox images

| Name | Version |
|----------|--------------|
| `jammy:android13:amd64` | 1.21.0 |
| `jammy:android13:arm64` | 1.21.0 |
| `jammy:android12:amd64` | 1.21.0 |
| `jammy:android12:arm64` | 1.21.0 |

## 1.20.2

### Charms
Expand Down
2 changes: 2 additions & 0 deletions reference/glossary.md
Original file line number Diff line number Diff line change
Expand Up @@ -301,6 +301,8 @@ See [Hooks](https://discourse.ubuntu.com/t/hooks/28555).

The base for an instance, which contains all necessary components like Anbox or the Android root file system. Anbox Cloud provides images based on different Android and Ubuntu versions and different architectures.

The images can be an Anbox Cloud AOSP image which is based on the Android Open Source Project (AOSP), an operating system typically used in mobile devices or an Anbox Cloud AAOS image which is based on the Android Automotive OS (AAOS), an infotainment platform used in automobiles.

See [Manage images](https://discourse.ubuntu.com/t/manage-images/17758) and [Provided images](https://discourse.ubuntu.com/t/provided-images/24185).

<a name="instance"></a>
Expand Down
24 changes: 9 additions & 15 deletions reference/provided-images.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,23 +4,17 @@ Anbox Cloud images are regular [Ubuntu cloud images](https://cloud-images.ubuntu

## Supported Anbox Cloud images

The following table lists supported images available on the official image server, along with their corresponding Android and Ubuntu versions.
The following table lists supported images available on the official image server, along with their corresponding image type, Android and Ubuntu versions.

| Name | Android Version | Ubuntu Version | Available since |
|-----------------------------|-----------------|----------------|---------------|
| `jammy:android13:amd64` | 13 | 22.04 | 1.16 |
| `jammy:android13:arm64` | 13 | 22.04 | 1.16 |
| `jammy:android12:amd64` | 12 | 22.04 | 1.14 |
| `jammy:android12:arm64` | 12 | 22.04 | 1.14 |
| Name | Based on | Android Version | Ubuntu Version | Available since |
|-----------------------------|----------|-----------------|----------------|---------------|
| `jammy:android13:amd64` | AAOS | 13 | 22.04 | 1.21.0 |
| `jammy:android13:arm64` | AAOS | 13 | 22.04 | 1.21.0 |
| `jammy:android13:amd64` | AOSP | 13 | 22.04 | 1.16.0 |
| `jammy:android13:arm64` | AOSP | 13 | 22.04 | 1.16.0 |
| `jammy:android12:amd64` | AOSP | 12 | 22.04 | 1.14.0 |
| `jammy:android12:arm64` | AOSP | 12 | 22.04 | 1.14.0 |

## Deprecated Anbox Cloud images

The following table lists the images that are available on the official image server but are deprecated. They will become unsupported after two releases.

| Name | Android Version | Ubuntu Version | Available since | Deprecated since |
|-----------------------------|-----------------|----------------|-----------------|--------------------|
| `jammy:android11:amd64` | 11 | 22.04 | 1.14 | 1.19 |
| `jammy:android11:arm64` | 11 | 22.04 | 1.14 | 1.19 |

## Support for Anbox Cloud images

Expand Down
25 changes: 10 additions & 15 deletions reference/release-notes/release-notes.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,34 +7,29 @@ The following dates for upcoming releases are not final and could vary depending

| Tentative Release date | Planned release version |
|----|----|
| February 14 2024 | Anbox Cloud 1.21.0 |
| March 13 2024 | Anbox Cloud 1.21.1 |
| April 17 2024 | Anbox Cloud 1.21.2 |

## Recent releases

| Release date | Release notes |
|----|----|
| February 14 2024 | [Anbox Cloud 1.21.0](https://discourse.ubuntu.com/t/42429) |
| January 17 2024 | [Anbox Cloud 1.20.2](https://discourse.ubuntu.com/t/41686) |
| December 13 2023| [Anbox Cloud 1.20.1](https://discourse.ubuntu.com/t/40988) |
| November 16 2023 | [Anbox Cloud 1.20.0](https://discourse.ubuntu.com/t/40281) |

### What's new in 1.20.x?
### What's new in 1.21.x?

Along with bug fixes and general improvements, Anbox Cloud 1.20.x includes:

* Support for creating virtual machine instances
* Alpha support for Vulkan on NVIDIA GPUs
* Upgraded Mesa driver and `virglrenderer`
* Anbox Cloud images download only on first use
* The Anbox Management Service (AMS) snaps use [core22](https://snapcraft.io/core22)
* Modernised [NATS charm](https://charmhub.io/nats)
* Several web dashboard improvements including:
- Improvements to session streaming statistics
- Ability to select and delete multiple instances
- Ability to change the Anbox Cloud configuration using the web dashboard
- Simplified app version selection for new sessions
Along with bug fixes and general improvements, Anbox Cloud 1.21.x includes:

* Android Automotive OS (AAOS) images
* Alpha support for Vehicle Hardware Abstraction Layer (VHAL)
* Full support for Vulkan on NVIDIA GPUs
* Experimental video upscaling on the client side
* System tracing for Android
* Improvements to Anbox Management Service (AMS) API responses
* Dashboard improvements
* Android security updates

## Older releases
Expand Down
1 change: 0 additions & 1 deletion reference/roadmap.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,5 @@ Anbox Cloud follows a defined release cycle with frequent minor and patch releas

| Release | Target Date | What to expect|
|---------|-------------|---------------|
| 1.21.0 | February 14 2024 | * Production support for Vulkan on NVIDIA GPUs<br/>* Add automotive-enabled Anbox Cloud images<br/>* Support for IAM role based authentication in AAR<br/>* TLS support for `anbox-cloud-nfs-operator` charm.<br/>* Android security updates for February 2023<br/>* Bug fixes |
| 1.21.1 | March 13 2024 | * Android security updates for March 2024<br/>* Bug fixes |
| 1.21.2 | April 17 2024 | * Android security updates for April 2024<br/>* Bug fixes |