Skip to content

Commit

Permalink
Merge branch 'main' into next-patch
Browse files Browse the repository at this point in the history
  • Loading branch information
keirthana authored Jan 15, 2025
2 parents 3f79f3f + 2327c8d commit ee10c86
Show file tree
Hide file tree
Showing 9 changed files with 30 additions and 10 deletions.
3 changes: 1 addition & 2 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -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 \
Expand Down
5 changes: 4 additions & 1 deletion custom_conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,10 @@
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/',
'https://10.2.9.2/',
'http://Add-SECURITY.md'
]

# This setting will check the links but not the anchors
Expand Down
2 changes: 1 addition & 1 deletion explanation/production-planning.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`.
8 changes: 7 additions & 1 deletion howto/application/create-application.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <ref-application-manifest>`, specify a {ref}`boot package <ref-application-manifest>`, add multiple {ref}`tags <ref-application-manifest>`, 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.
```
Expand Down
4 changes: 3 additions & 1 deletion howto/application/delete-application.md
Original file line number Diff line number Diff line change
@@ -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.

Expand Down
12 changes: 11 additions & 1 deletion howto/instance/create-instance.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
```
Expand Down
2 changes: 1 addition & 1 deletion howto/upgrade/upgrade-anbox.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion reference/release-notes/release-notes.md
Original file line number Diff line number Diff line change
@@ -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`.

Expand Down
2 changes: 1 addition & 1 deletion tutorial/getting-started-aaos.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down

0 comments on commit ee10c86

Please sign in to comment.