From f2c1058f5f1f46230ff7b66cee991ce527acf81e Mon Sep 17 00:00:00 2001 From: Keirthana T S Date: Tue, 7 Jan 2025 13:01:16 +0530 Subject: [PATCH 1/6] Fix error in roadmap --- reference/release-notes/release-notes.md | 1 - 1 file changed, 1 deletion(-) diff --git a/reference/release-notes/release-notes.md b/reference/release-notes/release-notes.md index d6017804..1cca214f 100644 --- a/reference/release-notes/release-notes.md +++ b/reference/release-notes/release-notes.md @@ -25,7 +25,6 @@ The following target dates for upcoming releases are not final and could vary de | Target date | Version | Planned updates | |----|----|----| -| December 11 2024 | Anbox Cloud 1.24.1 | * Android security updates for December 2024
* Bug fixes | | January 15 2025 | Anbox Cloud 1.24.2 | * Android security updates for January 2025
* Bug fixes | | February 12 2025 | Anbox Cloud 1.25.0 | * Integration with the [Canonical Observability Stack](https://charmhub.io/topics/canonical-observability-stack)
* Backup and restore support for the Anbox Cloud dashboard charm
* Support for Ubuntu 24.04 (Noble Numbat) for all charms
* (Alpha release) Terraform plan replacing the Anbox Cloud bundles
* Improvements to the Anbox Management Service (AMS)
* Reworked charms
* Upgrade to LXD 5.21
* Android security updates for February 2025
* Bug fixes | From 3b2f3dafcb295591650be264e6d4eca2669b8a76 Mon Sep 17 00:00:00 2001 From: Keirthana T S Date: Wed, 8 Jan 2025 10:21:22 +0530 Subject: [PATCH 2/6] Update getting-started-aaos.md --- tutorial/getting-started-aaos.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tutorial/getting-started-aaos.md b/tutorial/getting-started-aaos.md index 8b7657c2..8346e2f2 100644 --- a/tutorial/getting-started-aaos.md +++ b/tutorial/getting-started-aaos.md @@ -43,7 +43,7 @@ Confirm with *Add application* and wait till the *Applications* list screen show Go to the *Instances* screen and wait until you see an instance for the created application with a *running* status. -Click *Stream* ( ![stream icon](/images/join-session-icon.png) ) to stream the application. +Click *Stream* ( ![stream icon](/images/icons/stream-icon.png) ) to stream the application. If you want to stream with specific capabilities and display options, create your custom instance from the *Instances* screen and specify the desired *Capabilities* and *Virtual display* options. From a5c31cc12ccc83d6fcb50603be6ffa6a6e46801d Mon Sep 17 00:00:00 2001 From: Keirthana Date: Wed, 8 Jan 2025 12:28:02 +0530 Subject: [PATCH 3/6] Enable link check and fix outdated links --- Makefile | 3 +-- custom_conf.py | 3 ++- explanation/production-planning.md | 2 +- howto/upgrade/upgrade-anbox.md | 2 +- reference/release-notes/release-notes.md | 2 +- 5 files changed, 6 insertions(+), 6 deletions(-) diff --git a/Makefile b/Makefile index d290f854..435e44bc 100644 --- a/Makefile +++ b/Makefile @@ -94,8 +94,7 @@ spelling: html . $(VENV) ; python3 -m pyspelling -c $(SPHINXDIR)/spellingcheck.yaml -j $(shell nproc) linkcheck: install - echo "Link check is disabled temporarily" -# . $(VENV) ; $(SPHINXBUILD) -b linkcheck "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) + . $(VENV) ; $(SPHINXBUILD) -b linkcheck "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) woke: woke-install woke *.rst **/*.rst --exit-1-on-failure \ diff --git a/custom_conf.py b/custom_conf.py index 5ec9d6f3..7694f149 100644 --- a/custom_conf.py +++ b/custom_conf.py @@ -139,7 +139,8 @@ linkcheck_ignore = [ 'http://127.0.0.1:8000', 'https://support.canonical.com/', - 'https://assets.ubuntu.com/manager' + 'https://assets.ubuntu.com/manager', + 'https://images.anbox-cloud.io/stable/' ] # This setting will check the links but not the anchors diff --git a/explanation/production-planning.md b/explanation/production-planning.md index fa5244bb..0a7d45e6 100644 --- a/explanation/production-planning.md +++ b/explanation/production-planning.md @@ -93,4 +93,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-release-notes`. +You can also choose to subscribe to the [Anbox Cloud category](https://discourse.ubuntu.com/c/anbox-cloud/49) on discourse. For insights into the Anbox Cloud release roadmap, see {ref}`ref-release-notes`. diff --git a/howto/upgrade/upgrade-anbox.md b/howto/upgrade/upgrade-anbox.md index e9aec9e3..f78690c4 100644 --- a/howto/upgrade/upgrade-anbox.md +++ b/howto/upgrade/upgrade-anbox.md @@ -2,7 +2,7 @@ # How to upgrade the charmed deployment ```{note} -If you're interested in getting notified for the latest Anbox Cloud releases, make sure you subscribe to notifications on the [announcements category](https://discourse.ubuntu.com/c/anbox-cloud/announcements/55) on the Anbox Cloud discourse. +If you're interested in getting notified for the latest Anbox Cloud releases, make sure you subscribe to the [Anbox Cloud category](https://discourse.ubuntu.com/c/anbox-cloud/49) on the Ubuntu discourse. ``` Anbox Cloud allows upgrades from older versions to newer version. This describes the steps necessary to perform the upgrade. diff --git a/reference/release-notes/release-notes.md b/reference/release-notes/release-notes.md index 1cca214f..9a798e24 100644 --- a/reference/release-notes/release-notes.md +++ b/reference/release-notes/release-notes.md @@ -1,7 +1,7 @@ (ref-release-notes)= # Release notes -This page outlines the release notes of all versions of Anbox Cloud. If you're interested in getting notified for the latest Anbox Cloud releases, make sure you subscribe to notifications on the [announcements category](https://discourse.ubuntu.com/c/anbox-cloud/announcements/55) on the Anbox Cloud discourse. +This page outlines the release notes of all versions of Anbox Cloud. If you're interested in getting notified for the latest Anbox Cloud releases, subscribe to the [Anbox Cloud category](https://discourse.ubuntu.com/c/anbox-cloud/49) on the Ubuntu discourse. For instructions on how to update your Anbox Cloud deployment to later versions, see {ref}`howto-upgrade-anbox-cloud` or {ref}`howto-upgrade-appliance`. From 4620b8af61ee13f108d3ba61cbdb98a9f5575160 Mon Sep 17 00:00:00 2001 From: Keirthana Date: Mon, 13 Jan 2025 10:28:42 +0530 Subject: [PATCH 4/6] Ignore links from sources other than documentation --- custom_conf.py | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/custom_conf.py b/custom_conf.py index 7694f149..87425b61 100644 --- a/custom_conf.py +++ b/custom_conf.py @@ -140,7 +140,9 @@ 'http://127.0.0.1:8000', 'https://support.canonical.com/', 'https://assets.ubuntu.com/manager', - 'https://images.anbox-cloud.io/stable/' + 'https://images.anbox-cloud.io/stable/', + 'https://10.2.9.2/', + 'http://Add-SECURITY.md' ] # This setting will check the links but not the anchors From 66bd272db5cd8bdc48f3789305a7b8b24a7751a5 Mon Sep 17 00:00:00 2001 From: Anusha Chaturvedi Date: Mon, 13 Jan 2025 17:50:04 +0530 Subject: [PATCH 5/6] feat(instances): add docs for instance details page --- howto/instance/create-instance.md | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/howto/instance/create-instance.md b/howto/instance/create-instance.md index 8cd3f8f3..91214476 100644 --- a/howto/instance/create-instance.md +++ b/howto/instance/create-instance.md @@ -139,9 +139,19 @@ When you create the instance from an application, the attributes you define for When you create the instance from an image, you can define the properties of the instance during its creation. +There may be more advanced scenarios while creating an instance that cannot be performed using the dashboard and may require using the `amc` CLI. + Once you create an instance by providing the necessary attributes, you can view the instance and its status on the *Instances* page. -There may be more advanced scenarios while creating an instance that cannot be performed using the dashboard and may require using the `amc` CLI. +You can view details about a particular instance when you click on the instance name in the *Instances* list page. The instance details page offers three types of information: *Overview*, *Terminal*, and *Logs*. + +The *Overview* tab provides detailed information about the instance, including sections for the instance details, associated image or application, streaming configurations, network settings, and tags. + +The *Terminal* tab features a terminal interface for the Anbox instance, helping you to monitor system processes in real-time, check memory usage, view android and system logs, and much more. + +The *Logs* tab helps you debug issues with the instances as it provides downloadable logs for instances in an error state. + +The instance details page also contains all the available actions including streaming, setting up sharing, connecting ADB, starting or stopping the instance, and deleting the instance. ``` From a5a854f1d29ddf4a69871a70c31f1bf42079a2bc Mon Sep 17 00:00:00 2001 From: Anusha Chaturvedi Date: Thu, 9 Jan 2025 16:49:23 +0530 Subject: [PATCH 6/6] update create and delete applications details --- howto/application/create-application.md | 8 +++++++- howto/application/delete-application.md | 4 +++- 2 files changed, 10 insertions(+), 2 deletions(-) diff --git a/howto/application/create-application.md b/howto/application/create-application.md index 5562470c..f4e0d217 100644 --- a/howto/application/create-application.md +++ b/howto/application/create-application.md @@ -123,7 +123,13 @@ resources: ```{group-tab} Dashboard -Click *Create application* on the applications page, enter the required and any optional details that you want to provide and confirm with *Create application* again. The *Create application* form also provides an option to customise your application manifest. +Click *Create application* on the applications page, enter the required and any optional details that you want to provide and confirm with *Create application* again. + +An application can be created either in a VM or a container. Selecting one of these options will update the image field to only show images of the chosen type. The default image for the selected type is automatically populated in the image field. + +The advanced fields allows you to define a {ref}`version `, specify a {ref}`boot package `, add multiple {ref}`tags `, and disable {ref}`sec-application-manifest-watchdog`. + +The *Create application* form also provides an option to customise your application manifest. There may be more advanced scenarios while creating an application that cannot be performed using the dashboard and may require using the `amc` CLI. ``` diff --git a/howto/application/delete-application.md b/howto/application/delete-application.md index af1382d4..3e721687 100644 --- a/howto/application/delete-application.md +++ b/howto/application/delete-application.md @@ -1,7 +1,9 @@ (howto-delete-application)= # How to delete an application -When an application is no longer needed, it can be fully removed from Anbox Cloud. Removing an application will cause all of its versions to be removed, including all of its currently active instances. Be extra careful as this might affect your users if any are still using instances of the application you want to remove. +When an application is no longer needed, it can be fully removed from Anbox Cloud. However, be mindful of the consequences that come with removing an application such as: +- Removal of associated base instances. Note that the base instance could first enter an error state before being cleaned up. +- Removal of all the versions of the deleted application. Once you're sure you want to remove the application, you can delete it via the dashboard or the CLI.