-
Notifications
You must be signed in to change notification settings - Fork 16
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(many): update for changes coming with appliance v2
The new appliance v2 mainly stays identical as v1 but a few changes exist. This updates existing content to adapt to the new changes and removes no longer needed parts.
- Loading branch information
Showing
21 changed files
with
160 additions
and
245 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,47 +1,4 @@ | ||
(howto-upgrade-appliance)= | ||
# How to upgrade the Anbox Cloud Appliance | ||
|
||
Before you upgrade the Anbox Cloud Appliance, make sure all packages on the machines that are part of the deployment are up-to-date. To do so, run the following commands on each machine: | ||
|
||
sudo apt update | ||
sudo apt upgrade | ||
sudo snap refresh | ||
|
||
The Anbox Cloud Appliance includes an `upgrade` command which will perform all relevant upgrade steps to a newer version of the appliance. First, run `anbox-cloud-appliance status` to check if an update is available: | ||
|
||
status: ready | ||
update-available: true | ||
reboot-needed: false | ||
version: 1.19.0 | ||
|
||
```{important} | ||
While the upgrade process is active, API endpoints and the dashboard will not be available. Anbox Cloud instances will stay active and existing streams will also not be interrupted. | ||
``` | ||
|
||
In the `anbox-cloud-appliance status` command output, the `update-available` field indicates if an update is available. If an update is available, the upgrade process can now be initiated by running the `upgrade` command: | ||
|
||
anbox-cloud-appliance upgrade | ||
|
||
The appliance will now perform all necessary steps to upgrade to the newer available version. | ||
|
||
```{note} | ||
In case automatic updates are disabled for applications, Anbox Management Service (AMS) cannot update the application. See {ref}`sec-configure-automatic-app-updates` to enable automatic updates or to manually update the applications. | ||
``` | ||
|
||
You can watch the upgrade progress on the web interface: | ||
|
||
![Upgrade the appliance|690x435](https://assets.ubuntu.com/v1/1093e239-update_appliance.png) | ||
|
||
or with the same `anbox-cloud-appliance status` command that you used earlier: | ||
|
||
status: maintenance | ||
progress: 40 | ||
update-available: false | ||
reboot-needed: true | ||
version: 1.19.1 | ||
|
||
When the upgrade is successful, the appliance is again available for regular use. | ||
|
||
In case the upgrade fails due to a transient error or an issue with the system configuration, after resolving the issue, use the `--force` option to run the upgrade process again: | ||
|
||
anbox-cloud-appliance upgrade --force | ||
The Anbox Cloud Appliance does not require any specific steps to upgrade other than apply any pending snap package updates. Internally the snap will automatically apply necessary configuration changes and restart servies as needed. |
Binary file not shown.
Binary file not shown.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,52 @@ | ||
(ref-appliance-preseed-config)= | ||
# Anbox Cloud Appliance preseed configuration format | ||
|
||
The Anbox Cloud Appliance supports a `--preseed` command line flag for its `init` command that makes it possible to fully configure it in a non-interactive way. | ||
|
||
For example, starting from a clean installation of the Anbox Cloud Appliance, the preseed configuration can be provided in the folowing way: | ||
|
||
cat << EO | sudo anbox-cloud-appliance init --preseed | ||
network: | ||
listen-address: 192.168.11.4 | ||
lxd: | ||
storage-pool: my-pool | ||
project: anbox-cloud | ||
ams: | ||
api: | ||
allowed-uid: [0, 1000] | ||
EOF | ||
|
||
## Configuration format | ||
|
||
The following shows a complete example of the preseed configuration with all available keys: | ||
|
||
```yaml | ||
network: | ||
# An IP address all services the appliance deploys will listen on. | ||
listen-address: 192.168.11.4 | ||
# The IP address the appliance is accessible on when running behind NAT | ||
public-address: 192.168.11.4 | ||
# The DNS name the appliance is accessible on when running behind NAT | ||
public-location: foo.bar | ||
lxd: | ||
# Specifies the path to a storage disk. This can be used to ask the | ||
# appliance to create a new storage pool based on the specified | ||
# storage disk. The option is mutually exclusive to StorageSize | ||
storage-disk: /dev/sdc | ||
# The size in bytes of a new storage pool to create with the name | ||
# specified in `storage-pool`. The option is mutually exclusive to | ||
# `storage-disk` | ||
storage-size: 343413411 | ||
# Specifies the name of an existing LXD storage pool to use. If not | ||
# specified the appliance will automatically select a suitable | ||
# storage pool if available. If `storage-disk` or `storage-size` | ||
# are specified this will describe the name of the storage pool to | ||
# create | ||
storage-pool: local | ||
# The name of a to be created LXD project the appliance will use. If | ||
# not specified the default "anbox-cloud" name will be used. | ||
project: anbox-cloud | ||
ams: | ||
api: | ||
allowed-uids: [0, 1000] | ||
``` |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.