Jump to main content

Instances

Instances are the centre piece of the Anbox Cloud stack. Every time you launch an application or an image, Anbox Cloud creates an instance for it. Every instance provides a full Android system.

All instances in Anbox Cloud are ephemeral, which means that as soon as an instance is stopped, all of its data is deleted. Anbox Cloud DOES NOT back up any data from the Android or the outer Ubuntu instance. Backup and restore of data must be implemented separately through addons. See Example: Back up data for information on how to do this.

Regular instances vs. base instances

Anbox Cloud differentiates between two types of instances: regular and base. The instance type is visible in the output of the amc ls command.

Regular instances are containers or virtual machines that are launched from either an application or an image. They exist until they are deleted.

Base instances are temporary containers or virtual machines that are used when bootstrapping an application. They are automatically deleted when the application bootstrap is completed.

When we refer to instances in this documentation without specifying the instance type, we mean regular instances.

Application instances vs. raw instances

Instances are based on either applications or images. So if you launch an application or an image, Anbox Management Service (AMS) automatically creates an instance for it.

Application instances are containers or virtual machines created when launching an application and run the full Android system. If the application is based on an Android app (an APK package), this app is launched after the system boots and monitored by the watchdog. With the default configuration, you will see only the app and not the Android launcher.

Raw instances are containers or virtual machines created when launching an image. They run the full Android system, without any additional apps installed.

Life cycle of an instance

Creating an instance

When you create an instance by either launching or initialising an application or an image, AMS schedules the instance on a LXD node. The instance then executes the following steps in order:

  1. Configure the network interface and gateway.
  2. (Only for raw instances) Install addons that are specified with --addons.
  3. Expose services that are specified with --service or through the application manifest.
  4. Execute the pre-start hook provided by the installed addons.
  5. Launch the Android container.
  6. Execute the post-start hook provided by the installed addons.

Instance start

Launching an instance is successful only if all of the above steps succeed. If there are issues during the process, the status of the instance changes to error. You can view the available logs from the instance for further troubleshooting.

Stopping an instance

Instances can be stopped because of the following scenarios:

  • You stopped it.
  • You deleted it.
  • An error occurred.

When an instance is stopped, it executes the following steps in order:

  1. Stop the Android container.
  2. Execute the post-stop hook provided by the installed addons.
  3. Shut down the instance.

Beyond that, the instance will be removed from AMS either because you deleted it or because an error occurred during its runtime.
Instance stop

Possible instance statuses

An instance moves through different stages and correspondingly can have the following statuses depending on its current state.

Status Description
created AMS has created an internal database object for the instance and will next schedule the instance onto a suitable LXD node.
prepared AMS has decided the LXD node on which it will schedule the instance.
started The instance is started and now booting. During the boot sequence, possible hooks are executed. Once all hooks have been executed, the instance will switch to running.
running The instance is fully up and running.
stopped The instance has been stopped and can be restarted when required.
deleted The instance has been deleted and will be removed from the AMS database soon.
error An error occurred while processing the instance. The instance is stopped.
unknown A possible error occurred and the real state of the instance cannot be determined.

If you encounter the error or the unknown status, use amc show <instance_id> or amc-showlog to troubleshoot. If you are still unable to figure out the issue, file a bug with the relevant instance logs.

Development mode

AMS allows to start an instance in development mode. This mode turns off some features that are usually active in an instance. It is mainly useful when developing addons inside an instance.

When development mode is enabled, the instance sends status updates to AMS when the Anbox runtime is terminated, however, AMS allows the instance to continue running. This allows you to restart the Anbox runtime inside the instance, providing an easy way to test addons or develop a platform plugin.

To check whether development mode is enabled, run amc show <instance_ID> or look at the /var/lib/anbox/session.yaml file in the instance. If the devmode field in the configuration file is set to true, development mode is active.

Related information

Last updated 10 days ago. Help improve this document in the forum.