The Anbox Cloud Appliance provides a deployment of Anbox Cloud to a single machine. This offering is well suited for initial prototype and small scale deployments.
There are differences between the Anbox Cloud Appliance and the full Anbox Cloud installation (see Variants). This tutorial focuses on installing the Anbox Cloud Appliance on a single dedicated machine.
This tutorial guides you through the steps that are required to install and initialise the Anbox Cloud Appliance on the machine from the snap:
Check the prerequisites
Make sure you have the following prerequisites:
- An Ubuntu SSO account. If you don’t have one yet, create it here.
- A virtual or bare metal machine running Ubuntu 20.04 or 22.04. See the detailed requirements here.
- Your Ubuntu Pro token for an Ubuntu Pro subscription. If you don’t have one yet, speak to your Canonical representative. If you already have a valid Ubuntu Pro token, log in to https://ubuntu.com/pro to retrieve it.
The Ubuntu Pro (Infra-only) token does NOT work and will result in a failed deployment. You need an Ubuntu Pro subscription.
Install the appliance
The following instructions guide you through all relevant steps to install the Anbox Cloud Appliance from the snap.
1. Update your system
Run the following commands to ensure that all installed packages on your system are up-to-date:
sudo apt update sudo apt upgrade
2. Install dependencies
The Anbox Cloud Appliance requires LXD >= 5.0. Check which version you have currently installed:
If LXD is not installed, run:
snap install --channel=5.0/stable lxd
If LXD is already installed but the version is older than 5.0, run:
snap refresh --channel=5.0/stable lxd
3. Attach your machine to the Ubuntu Pro subscription
The Anbox Cloud Appliance requires a valid Ubuntu Pro subscription.
Before installing the appliance, you must attach the machine on which you want to run the Anbox Cloud Appliance to your Ubuntu Pro subscription. To do so, run the following command, replacing <pro_token> with your Ubuntu Pro token:
sudo ua attach <pro_token>
4. Install the snap
Run the following command to install the
anbox-cloud-appliance snap, which handles the installation and deployment of the Anbox Cloud Appliance:
sudo snap install --classic anbox-cloud-appliance
5. Install additional tools
sudo snap install amc to install the Anbox Management Client (AMC).
Initialise the appliance
After the installation, access the appliance in your web browser by entering the IP of your machine (in the following steps referred to as
https://your-machine-address). This web page provides status information for the following initialisation process.
By default, the Anbox Cloud Appliance uses self-signed certificates, which might cause a security warning in your browser. Use the mechanism provided by your browser to proceed to the web page.
1. Start the initialisation process
On your machine, enter the following command to invoke the initialisation process of the Anbox Cloud Appliance:
sudo anbox-cloud-appliance init
You will be asked a few questions. If you don’t want to make any specific changes, you can safely stay with the offered default answers. When the command returns, the initialisation process will run fully automatically in the background.
2. Monitor the progress
You can watch the status web page at
https://your-machine-address for progress information.
Alternatively, you can also use the
anbox-cloud-appliance status command to monitor the progress information on the command line.
status: initializing progress: 60 update-available: false reboot-needed: false version: 1.19.1
Register with the dashboard
Once the initialisation process has finished, you are presented with a welcome page on
https://your-machine-address with instructions on how to register a user account with your installation. This registration is needed to access the web dashboard.
1. Register your Ubuntu SSO account
Enter the following command to register your Ubuntu SSO account:
anbox-cloud-appliance dashboard register <your Ubuntu SSO email address>
The output provides a link that you must open in your web browser to finish the account creation. By default, the registration link expires after one hour. After registering, you can log into the appliance dashboard with your Ubuntu SSO account.
2. Log into the appliance dashboard
After registering, you can log into the appliance dashboard at
https://your-machine-address with your Ubuntu SSO account.
Your Anbox Cloud Appliance is now fully set up and ready to be used! Next, you should check out the Get started with Anbox Cloud (web dashboard) or the Get started with Anbox Cloud (CLI) tutorial to familiarise yourself with how to use Anbox Cloud.
You can find more information about how to use the appliance in the documentation. The appliance installation is nearly identical to installing via Juju, so all the commands and examples not relating directly to Juju will apply.
If you want to increase the capacity of your Anbox Cloud Appliance deployment, you can add more machines to it. See How to join a machine to the Anbox Cloud Appliance for instructions.