diff --git a/reference/cmd-ref/amc/ams.amc.md b/reference/cmd-ref/amc/ams.amc.md new file mode 100644 index 00000000..47eb42c0 --- /dev/null +++ b/reference/cmd-ref/amc/ams.amc.md @@ -0,0 +1,45 @@ +## ams.amc + +Anbox Management Client + +### Synopsis + +Anbox Management Client. + +The Anbox Management Client (AMC) manages containers in Anbox Cloud. +You can use it to create, launch and manage applications on any machine. + +See https://anbox-cloud.io/docs for detailed information on how to work +with Anbox Cloud. + +### Options + +``` + -h, --help help for ams.amc +``` + +### SEE ALSO + +* [ams.amc addon](ams.amc_addon.md) - Manage addons +* [ams.amc application](ams.amc_application.md) - Manage applications +* [ams.amc benchmark](ams.amc_benchmark.md) - Benchmark your Anbox Cloud deployment +* [ams.amc completion](ams.amc_completion.md) - Generate the autocompletion script for the specified shell +* [ams.amc config](ams.amc_config.md) - Manage AMS configuration +* [ams.amc delete](ams.amc_delete.md) - Delete an instance +* [ams.amc exec](ams.amc_exec.md) - Execute a command inside an instance +* [ams.amc image](ams.amc_image.md) - Manage images +* [ams.amc info](ams.amc_info.md) - Provide general information about the connected AMS service +* [ams.amc init](ams.amc_init.md) - Create an instance but do not start it immediately +* [ams.amc launch](ams.amc_launch.md) - Launch an instance +* [ams.amc list](ams.amc_list.md) - List instances +* [ams.amc logs](ams.amc_logs.md) - Show runtime logs of an instance +* [ams.amc node](ams.amc_node.md) - Manage nodes +* [ams.amc remote](ams.amc_remote.md) - Interact with remote AMS daemons +* [ams.amc shell](ams.amc_shell.md) - Open a shell inside a running instance +* [ams.amc show](ams.amc_show.md) - Show information about an instance +* [ams.amc show-log](ams.amc_show-log.md) - Show an instance log file +* [ams.amc start](ams.amc_start.md) - Start an existing instance +* [ams.amc stop](ams.amc_stop.md) - Stop a running instance +* [ams.amc wait](ams.amc_wait.md) - Wait for an instance to reach a specific condition + +###### Auto generated by spf13/cobra on 8-Oct-2024 diff --git a/reference/cmd-ref/amc/ams.amc_addon.md b/reference/cmd-ref/amc/ams.amc_addon.md new file mode 100644 index 00000000..4bb02dda --- /dev/null +++ b/reference/cmd-ref/amc/ams.amc_addon.md @@ -0,0 +1,32 @@ +## ams.amc addon + +Manage addons + +### Synopsis + +Manage addons. + +Addons are a way of customising the images that are used as the base for containers. + +Basically, an addon is a tarball that provides several hooks and additional metadata. +An example for an addon is one that enables the SSH service inside a container, to +provide access from the outside for any kind of automation of the container. + +See https://anbox-cloud.io/docs/ref/addons for detailed information. + +### Options + +``` + -h, --help help for addon +``` + +### SEE ALSO + +* [ams.amc](ams.amc.md) - Anbox Management Client +* [ams.amc addon add](ams.amc_addon_add.md) - Add an addon +* [ams.amc addon delete](ams.amc_addon_delete.md) - Delete an existing addon +* [ams.amc addon list](ams.amc_addon_list.md) - List available addons +* [ams.amc addon show](ams.amc_addon_show.md) - Show more information about a specific addon +* [ams.amc addon update](ams.amc_addon_update.md) - Update an existing addon + +###### Auto generated by spf13/cobra on 8-Oct-2024 diff --git a/reference/cmd-ref/amc/ams.amc_addon_add.md b/reference/cmd-ref/amc/ams.amc_addon_add.md new file mode 100644 index 00000000..518639c9 --- /dev/null +++ b/reference/cmd-ref/amc/ams.amc_addon_add.md @@ -0,0 +1,45 @@ +## ams.amc addon add + +Add an addon + +### Synopsis + +Add an addon. + +Addons can be created from plain directories or tarballs or zip archives. +A valid addon must contain a manifest and hooks. + +Addons are not used automatically, but they must be enabled for an application +by adding them to the application manifest. +Alternatively, you can enable them globally by setting the configuration item +'application.addons'. + +``` +ams.amc addon add ( | <.tar.bz2 tarball> | <.zip zip archive>) [flags] +``` + +### Examples + +``` +$ tree my-addon +my-addon/ +├── hooks +│   └── install +└── manifest.yaml + +$ amc addon add foo my-addon/ + +``` + +### Options + +``` + -h, --help help for add + -t, --timeout string Maximum time to wait for the operation to complete (default "5m") +``` + +### SEE ALSO + +* [ams.amc addon](ams.amc_addon.md) - Manage addons + +###### Auto generated by spf13/cobra on 8-Oct-2024 diff --git a/reference/cmd-ref/amc/ams.amc_addon_delete.md b/reference/cmd-ref/amc/ams.amc_addon_delete.md new file mode 100644 index 00000000..46c97b13 --- /dev/null +++ b/reference/cmd-ref/amc/ams.amc_addon_delete.md @@ -0,0 +1,39 @@ +## ams.amc addon delete + +Delete an existing addon + +### Synopsis + +Delete an existing addon. + +Non-interactive deletion can be achieved with the '--yes'/'-y' flag. + + +``` +ams.amc addon delete [flags] +``` + +### Examples + +``` +$ amc addon delete foo +The following addon will be REMOVED: + - foo +Do you want to continue? [Y/n]: Y + +``` + +### Options + +``` + -h, --help help for delete + -t, --timeout string Maximum time to wait for the operation to complete (default "5m") + -v, --version int Version of the application to delete. If not specified, all versions are deleted. + -y, --yes Assume 'yes' as answer to all prompts and run non-interactively +``` + +### SEE ALSO + +* [ams.amc addon](ams.amc_addon.md) - Manage addons + +###### Auto generated by spf13/cobra on 8-Oct-2024 diff --git a/reference/cmd-ref/amc/ams.amc_addon_list.md b/reference/cmd-ref/amc/ams.amc_addon_list.md new file mode 100644 index 00000000..86b86de4 --- /dev/null +++ b/reference/cmd-ref/amc/ams.amc_addon_list.md @@ -0,0 +1,40 @@ +## ams.amc addon list + +List available addons + +### Synopsis + +List available addons. + +Formatting can be controlled with the '--format' flag. +Valid formats are 'table' (see example), 'json' and 'csv'. + + +``` +ams.amc addon list [flags] +``` + +### Examples + +``` +$ amc addon list ++------+----------+---------+ +| NAME | VERSIONS | USED BY | ++------+----------+---------+ +| foo | 1 | | ++------+----------+---------+ + +``` + +### Options + +``` + --format string Output format - 'table', 'json' or 'csv' (default "table") + -h, --help help for list +``` + +### SEE ALSO + +* [ams.amc addon](ams.amc_addon.md) - Manage addons + +###### Auto generated by spf13/cobra on 8-Oct-2024 diff --git a/reference/cmd-ref/amc/ams.amc_addon_show.md b/reference/cmd-ref/amc/ams.amc_addon_show.md new file mode 100644 index 00000000..57d220e0 --- /dev/null +++ b/reference/cmd-ref/amc/ams.amc_addon_show.md @@ -0,0 +1,40 @@ +## ams.amc addon show + +Show more information about a specific addon + +### Synopsis + +Show more information about a specific addon. + +Formatting can be controlled with the '--format' flag. +Valid formats are 'json' and 'yaml'. + +``` +ams.amc addon show [flags] +``` + +### Examples + +``` +$ amc addon show foo +name: foo +versions: + 0: + size: 273B + created-at: 2019-07-15 14:02:30 +0000 UTC +used_by: [] + +``` + +### Options + +``` + --format string Output format - 'json' or 'yaml' (default "yaml") + -h, --help help for show +``` + +### SEE ALSO + +* [ams.amc addon](ams.amc_addon.md) - Manage addons + +###### Auto generated by spf13/cobra on 8-Oct-2024 diff --git a/reference/cmd-ref/amc/ams.amc_addon_update.md b/reference/cmd-ref/amc/ams.amc_addon_update.md new file mode 100644 index 00000000..525b259c --- /dev/null +++ b/reference/cmd-ref/amc/ams.amc_addon_update.md @@ -0,0 +1,33 @@ +## ams.amc addon update + +Update an existing addon + +``` +ams.amc addon update [flags] +``` + +### Examples + +``` +$ tree addon +addon/ +├── hooks +│   └── install +└── manifest.yaml + +$ amc addon update foo addon/ + +``` + +### Options + +``` + -h, --help help for update + -t, --timeout string Maximum time to wait for the operation to complete (default "5m") +``` + +### SEE ALSO + +* [ams.amc addon](ams.amc_addon.md) - Manage addons + +###### Auto generated by spf13/cobra on 8-Oct-2024 diff --git a/reference/cmd-ref/amc/ams.amc_application.md b/reference/cmd-ref/amc/ams.amc_application.md new file mode 100644 index 00000000..739111df --- /dev/null +++ b/reference/cmd-ref/amc/ams.amc_application.md @@ -0,0 +1,49 @@ +## ams.amc application + +Manage applications + +### Synopsis + +Manage applications. + +Applications are the centrepiece of Anbox Cloud. + +An application usually encapsulates one Android application and manages it +within the cluster. +The application installs the supplied APK to make it available to users. +Applications can be updated, pushed to a central registry and more. +See https://anbox-cloud.io/docs/exp/applications for detailed information. + +Android applications must go through a bootstrap process before they can +run on Anbox Cloud. This bootstrap process helps to improve the performance +and decrease the boot times. + +Applications are versioned. Every time you update an application, its version +number is incremented. Application versions are not automatically published. +While you can launch an unpublished application, it is recommended to do so +only for testing purposes. + +Once ready for use, you can publish a specific version. It will then be used +for any container launched for the application. + + +### Options + +``` + -h, --help help for application +``` + +### SEE ALSO + +* [ams.amc](ams.amc.md) - Anbox Management Client +* [ams.amc application create](ams.amc_application_create.md) - Create an application +* [ams.amc application delete](ams.amc_application_delete.md) - Delete an application +* [ams.amc application list](ams.amc_application_list.md) - List created applications +* [ams.amc application publish](ams.amc_application_publish.md) - Mark an application version as published +* [ams.amc application revoke](ams.amc_application_revoke.md) - Revoke a published application version +* [ams.amc application set](ams.amc_application_set.md) - Update fields for an application +* [ams.amc application show](ams.amc_application_show.md) - Show information about a specific application +* [ams.amc application unset](ams.amc_application_unset.md) - Reset an application field +* [ams.amc application update](ams.amc_application_update.md) - Update an existing application + +###### Auto generated by spf13/cobra on 8-Oct-2024 diff --git a/reference/cmd-ref/amc/ams.amc_application_create.md b/reference/cmd-ref/amc/ams.amc_application_create.md new file mode 100644 index 00000000..39d302c9 --- /dev/null +++ b/reference/cmd-ref/amc/ams.amc_application_create.md @@ -0,0 +1,42 @@ +## ams.amc application create + +Create an application + +### Synopsis + +Create an application. + +Applications can be created from plain directories, tarballs or zip archives. +A valid application must contain an APK and a manifest that defines various +application properties. + + +``` +ams.amc application create ( | <.tar.bz2 tarball> | <.zip archive>) [flags] +``` + +### Examples + +``` +$ tree my-app +my-app/ +├── app.apk +└── manifest.yaml + +$ amc application create my-app + +``` + +### Options + +``` + -h, --help help for create + -t, --timeout string Maximum time to wait for the operation to complete (default "5m") + --vm Create an application using VMs instead of containers +``` + +### SEE ALSO + +* [ams.amc application](ams.amc_application.md) - Manage applications + +###### Auto generated by spf13/cobra on 8-Oct-2024 diff --git a/reference/cmd-ref/amc/ams.amc_application_delete.md b/reference/cmd-ref/amc/ams.amc_application_delete.md new file mode 100644 index 00000000..47cc05a1 --- /dev/null +++ b/reference/cmd-ref/amc/ams.amc_application_delete.md @@ -0,0 +1,46 @@ +## ams.amc application delete + +Delete an application + +### Synopsis + +Delete an application. + +Deleting an application removes all of its versions. If you want to remove +only a specific version, you can use the '--version' flag. + +Applications downloaded from the registry cannot be deleted unless +you specify the '--force'|'-f' flag. + + +``` +ams.amc application delete ( | ) [flags] +``` + +### Examples + +``` +$ amc application delete foo +The following application will be REMOVED: + - foo +Do you want to continue? [Y/n]: + +``` + +### Options + +``` + -a, --all Delete all existing applications + -f, --force Force deletion of the application even if it is immutable + -h, --help help for delete + --no-wait Don't wait for the delete operation to finish + -t, --timeout string Maximum time to wait for the operation to complete (default "5m") + -v, --version int Version of the application to delete. If not specified, all versions are deleted. + -y, --yes Assume 'yes' as answer to all prompts and run non-interactively +``` + +### SEE ALSO + +* [ams.amc application](ams.amc_application.md) - Manage applications + +###### Auto generated by spf13/cobra on 8-Oct-2024 diff --git a/reference/cmd-ref/amc/ams.amc_application_list.md b/reference/cmd-ref/amc/ams.amc_application_list.md new file mode 100644 index 00000000..9e998018 --- /dev/null +++ b/reference/cmd-ref/amc/ams.amc_application_list.md @@ -0,0 +1,64 @@ +## ams.amc application list + +List created applications + +### Synopsis + +List created applications. + +Formatting can be controlled with the '--format' flag. +Valid formats are 'table' (see example), 'yaml', 'json' and 'csv'. + +You can apply filters to narrow down the list of applications. +They are of the following form: + + --filter attribute=value + +'attribute' can be one of the following: + + +---------------+----------------------------+ + | Name | Argument type | + +---------------+----------------------------+ + | instance-type | comma-separated list | + | addons | comma-separated list | + | tag | (deprecated) | + | tags | comma-separated list | + | published | Boolean (true/false) | + | immutable | Boolean (true/false) | + | status | string (ready, error etc.) | + | vm | Boolean (true/false) | + +---------------+----------------------------+ + + + +``` +ams.amc application list [flags] +``` + +### Examples + +``` +$ amc application list ++----------------------+------+---------------+--------+------+-----------+--------+---------------------+ +| ID | NAME | INSTANCE TYPE | ADDONS | TAGS | PUBLISHED | STATUS | LAST UPDATED | ++----------------------+------+---------------+--------+------+-----------+--------+---------------------+ +| bkmtdm9hpuo01q954fng | foo | a2.3 | | | true | ready | 2019-07-16 13:53:32 | ++----------------------+------+---------------+--------+------+-----------+--------+---------------------+ + +$ amc application list --filter published=true + +``` + +### Options + +``` + -f, --filter stringArray Filter the output based on conditions (for example, 'published=true') + --format string Output format - 'table', 'json', 'yaml' or 'csv' (default "table") + -h, --help help for list +``` + +### SEE ALSO + +* [ams.amc application](ams.amc_application.md) - Manage applications + +###### Auto generated by spf13/cobra on 8-Oct-2024 diff --git a/reference/cmd-ref/amc/ams.amc_application_publish.md b/reference/cmd-ref/amc/ams.amc_application_publish.md new file mode 100644 index 00000000..56636bf6 --- /dev/null +++ b/reference/cmd-ref/amc/ams.amc_application_publish.md @@ -0,0 +1,38 @@ +## ams.amc application publish + +Mark an application version as published + +### Synopsis + +Mark an application version as published. + +Publishing a version marks it as the latest available version for that application. +When you launch an application, AMS picks the latest published version unless specified otherwise. + +By default, application versions are unpublished. + +If you publish a wrong version, you can revert it with the 'application revoke' command. + + +``` +ams.amc application publish [flags] +``` + +### Examples + +``` +$ amc application publish foo 0 +``` + +### Options + +``` + -h, --help help for publish + -t, --timeout string Maximum time to wait for the operation to complete (default "5m") +``` + +### SEE ALSO + +* [ams.amc application](ams.amc_application.md) - Manage applications + +###### Auto generated by spf13/cobra on 8-Oct-2024 diff --git a/reference/cmd-ref/amc/ams.amc_application_revoke.md b/reference/cmd-ref/amc/ams.amc_application_revoke.md new file mode 100644 index 00000000..0529a67c --- /dev/null +++ b/reference/cmd-ref/amc/ams.amc_application_revoke.md @@ -0,0 +1,34 @@ +## ams.amc application revoke + +Revoke a published application version + +### Synopsis + +Revoke a published application version. + +Mark an application version as not published. + + +``` +ams.amc application revoke [flags] +``` + +### Examples + +``` +$ amc application revoke my-app 1 + +``` + +### Options + +``` + -h, --help help for revoke + -t, --timeout string Maximum time to wait for the operation to complete (default "5m") +``` + +### SEE ALSO + +* [ams.amc application](ams.amc_application.md) - Manage applications + +###### Auto generated by spf13/cobra on 8-Oct-2024 diff --git a/reference/cmd-ref/amc/ams.amc_application_set.md b/reference/cmd-ref/amc/ams.amc_application_set.md new file mode 100644 index 00000000..1b3999ea --- /dev/null +++ b/reference/cmd-ref/amc/ams.amc_application_set.md @@ -0,0 +1,34 @@ +## ams.amc application set + +Update fields for an application + +### Synopsis + +Update fields for an application. + +Update specific fields for an existing application without creating +a new version of the application. + +The following fields can be updated: image, instance-type, addons, tags, inhibit-auto-updates, resources.cpus, resources.memory, resources.disk-size, resources.gpu-slots, resources.vpu-slots, boot-activity, features, hooks.timeout, bootstrap.keep, node-selector, watchdog.disabled, watchdog.allowed-packages + +``` +ams.amc application set [flags] +``` + +### Examples + +``` +$ amc application set foo instance-type a4.3 +``` + +### Options + +``` + -h, --help help for set +``` + +### SEE ALSO + +* [ams.amc application](ams.amc_application.md) - Manage applications + +###### Auto generated by spf13/cobra on 8-Oct-2024 diff --git a/reference/cmd-ref/amc/ams.amc_application_show.md b/reference/cmd-ref/amc/ams.amc_application_show.md new file mode 100644 index 00000000..90eb5c77 --- /dev/null +++ b/reference/cmd-ref/amc/ams.amc_application_show.md @@ -0,0 +1,52 @@ +## ams.amc application show + +Show information about a specific application + +### Synopsis + +Show information about a specific application. + +Formatting can be controlled with the '--format' flag. +Valid formats are 'json' and 'yaml'. + +``` +ams.amc application show [flags] +``` + +### Examples + +``` +$ amc application show foo +id: bkmtdm9hpuo01q954fng +name: foo +status: ready +published: true +immutable: false +vm: false +inhibit-auto-updates: false +tags: [] +config: + instance-type: a2.3 + boot-package: com.android.foo +versions: + 0: + image: bkkbiaphpuo3mh78ain0 (version 0) + manifest-version: 0.1 + published: true + status: active + extra-data: {} + +``` + +### Options + +``` + --format string Output format - 'json' or 'yaml' (default "yaml") + -h, --help help for show +``` + +### SEE ALSO + +* [ams.amc application](ams.amc_application.md) - Manage applications + +###### Auto generated by spf13/cobra on 8-Oct-2024 diff --git a/reference/cmd-ref/amc/ams.amc_application_unset.md b/reference/cmd-ref/amc/ams.amc_application_unset.md new file mode 100644 index 00000000..98122613 --- /dev/null +++ b/reference/cmd-ref/amc/ams.amc_application_unset.md @@ -0,0 +1,37 @@ +## ams.amc application unset + +Reset an application field + +### Synopsis + +Reset an application field. + +The field is set to its default value. + +The following fields can be unset: tags, addons, features + +For resetting other fields, use the 'application set' command and specify a +value. + + +``` +ams.amc application unset [flags] +``` + +### Examples + +``` +$ amc application unset foo tags +``` + +### Options + +``` + -h, --help help for unset +``` + +### SEE ALSO + +* [ams.amc application](ams.amc_application.md) - Manage applications + +###### Auto generated by spf13/cobra on 8-Oct-2024 diff --git a/reference/cmd-ref/amc/ams.amc_application_update.md b/reference/cmd-ref/amc/ams.amc_application_update.md new file mode 100644 index 00000000..0fadcd30 --- /dev/null +++ b/reference/cmd-ref/amc/ams.amc_application_update.md @@ -0,0 +1,47 @@ +## ams.amc application update + +Update an existing application + +### Synopsis + +Update an existing application. + +Updating an application creates a new version that must run through +the bootstrap process. + +If no package is provided, AMS checks what updates are possible by looking +at newer images and addons and applies any pending changes if necessary. + +Depending on which updates you want to do to your existing application, +consider using the 'application set' command instead. That command allows +to update specific fields of the application without updating the application. + + +``` +ams.amc application update [] [flags] +``` + +### Examples + +``` +$ tree foo-app +foo-app/ +├── app.apk +└── manifest.yaml + +$ amc application update foo foo-app/ + +``` + +### Options + +``` + -h, --help help for update + -t, --timeout string Maximum time to wait for the operation to complete (default "5m") +``` + +### SEE ALSO + +* [ams.amc application](ams.amc_application.md) - Manage applications + +###### Auto generated by spf13/cobra on 8-Oct-2024 diff --git a/reference/cmd-ref/amc/ams.amc_benchmark.md b/reference/cmd-ref/amc/ams.amc_benchmark.md new file mode 100644 index 00000000..edc1e514 --- /dev/null +++ b/reference/cmd-ref/amc/ams.amc_benchmark.md @@ -0,0 +1,70 @@ +## ams.amc benchmark + +Benchmark your Anbox Cloud deployment + +### Synopsis + +Benchmark your Anbox Cloud deployment. + +The results can be used to evaluate the performance of Anbox Cloud for a well-defined workload. + + +``` +ams.amc benchmark ( | ) [flags] +``` + +### Examples + +``` + $ amc benchmark --fps --network-address=172.31.4.11 --num-instances=15 --instances-per-second=0.1 bh2q90vo3v1lt1ft4mlg + +2019/01/21 11:11:49 Test environment: +2019/01/21 11:11:49 AMS version: 1.2.1 +2019/01/21 11:11:49 Available nodes: +2019/01/21 11:11:49 lxd0 (CPU: 48, Memory: 185GB) +2019/01/21 11:11:49 +2019/01/21 11:11:49 Launching 15 instances for application bh2q90vo3v1lt1ft4mlg with 0.1 instances per second +[...] +2019/01/21 11:15:39 Instances boot time measurement: +2019/01/21 11:15:39 Launching all 15 instances took 2m36.560310342s +2019/01/21 11:15:39 Out of 15 instances 0 failed to launch +2019/01/21 11:15:39 Average instance launch time: 6.149119411s +2019/01/21 11:15:39 Max instance launch time: 6.576302043s +2019/01/21 11:15:39 Min instance launch time: 5.911184959s +2019/01/21 11:15:39 Android system failed to boot in the following instances: +2019/01/21 11:15:39 None +2019/01/21 11:15:39 Instances statistics: +2019/01/21 11:15:39 FPS avg 58 min 52 max 64 for 15 instances +2019/01/21 11:15:39 Instances below run at low FPS(<30): +2019/01/21 11:15:39 None + +``` + +### Options + +``` + --containers-per-second float Number of containers to launch per second (default 0.1) + -d, --dump-data Dump data collecting during the benchmark; the file name will be printed + --features string Feature flags to set for launched instances + -c, --force Force the removal of the instances + -f, --fps Measure FPS of all instances + --fps-threshold int FPS threshold below which an instance will be seen as slow (default 30) + -h, --help help for benchmark + -i, --instance-type string Instance type to use for the instance when launching a raw instance (default "a2.3") + -s, --instances-per-second float Number of instances to launch per second (default 0.1) + --keep-instances Keep all instances after finishing the benchmark itself and don't attempt to delete them + --measure-time string Time spent measuring instance statistics (default "1m") + --network-address string Outbound network address on which the instances can reach the benchmark executor (for example, 127.0.0.1) + --num-containers int Number of containers to launch (default 1) + -n, --num-instances int Number of instances to launch (default 1) + -p, --platform string Anbox platform to use for the instances (default "null") + -r, --raw If specified, the instance is created for the specified image instead of an application + --settle-time string Time the benchmark allows the instance to settle before it starts to measure performance (default "30s") + --userdata string Additional user data to be pushed into the created instance +``` + +### SEE ALSO + +* [ams.amc](ams.amc.md) - Anbox Management Client + +###### Auto generated by spf13/cobra on 8-Oct-2024 diff --git a/reference/cmd-ref/amc/ams.amc_completion.md b/reference/cmd-ref/amc/ams.amc_completion.md new file mode 100644 index 00000000..1477b4a3 --- /dev/null +++ b/reference/cmd-ref/amc/ams.amc_completion.md @@ -0,0 +1,25 @@ +## ams.amc completion + +Generate the autocompletion script for the specified shell + +### Synopsis + +Generate the autocompletion script for ams.amc for the specified shell. +See each sub-command's help for details on how to use the generated script. + + +### Options + +``` + -h, --help help for completion +``` + +### SEE ALSO + +* [ams.amc](ams.amc.md) - Anbox Management Client +* [ams.amc completion bash](ams.amc_completion_bash.md) - Generate the autocompletion script for bash +* [ams.amc completion fish](ams.amc_completion_fish.md) - Generate the autocompletion script for fish +* [ams.amc completion powershell](ams.amc_completion_powershell.md) - Generate the autocompletion script for powershell +* [ams.amc completion zsh](ams.amc_completion_zsh.md) - Generate the autocompletion script for zsh + +###### Auto generated by spf13/cobra on 8-Oct-2024 diff --git a/reference/cmd-ref/amc/ams.amc_completion_bash.md b/reference/cmd-ref/amc/ams.amc_completion_bash.md new file mode 100644 index 00000000..51998b04 --- /dev/null +++ b/reference/cmd-ref/amc/ams.amc_completion_bash.md @@ -0,0 +1,44 @@ +## ams.amc completion bash + +Generate the autocompletion script for bash + +### Synopsis + +Generate the autocompletion script for the bash shell. + +This script depends on the 'bash-completion' package. +If it is not installed already, you can install it via your OS's package manager. + +To load completions in your current shell session: + + source <(ams.amc completion bash) + +To load completions for every new session, execute once: + +#### Linux: + + ams.amc completion bash > /etc/bash_completion.d/ams.amc + +#### macOS: + + ams.amc completion bash > $(brew --prefix)/etc/bash_completion.d/ams.amc + +You will need to start a new shell for this setup to take effect. + + +``` +ams.amc completion bash +``` + +### Options + +``` + -h, --help help for bash + --no-descriptions disable completion descriptions +``` + +### SEE ALSO + +* [ams.amc completion](ams.amc_completion.md) - Generate the autocompletion script for the specified shell + +###### Auto generated by spf13/cobra on 8-Oct-2024 diff --git a/reference/cmd-ref/amc/ams.amc_completion_fish.md b/reference/cmd-ref/amc/ams.amc_completion_fish.md new file mode 100644 index 00000000..d17e703c --- /dev/null +++ b/reference/cmd-ref/amc/ams.amc_completion_fish.md @@ -0,0 +1,35 @@ +## ams.amc completion fish + +Generate the autocompletion script for fish + +### Synopsis + +Generate the autocompletion script for the fish shell. + +To load completions in your current shell session: + + ams.amc completion fish | source + +To load completions for every new session, execute once: + + ams.amc completion fish > ~/.config/fish/completions/ams.amc.fish + +You will need to start a new shell for this setup to take effect. + + +``` +ams.amc completion fish [flags] +``` + +### Options + +``` + -h, --help help for fish + --no-descriptions disable completion descriptions +``` + +### SEE ALSO + +* [ams.amc completion](ams.amc_completion.md) - Generate the autocompletion script for the specified shell + +###### Auto generated by spf13/cobra on 8-Oct-2024 diff --git a/reference/cmd-ref/amc/ams.amc_completion_powershell.md b/reference/cmd-ref/amc/ams.amc_completion_powershell.md new file mode 100644 index 00000000..26f425fb --- /dev/null +++ b/reference/cmd-ref/amc/ams.amc_completion_powershell.md @@ -0,0 +1,32 @@ +## ams.amc completion powershell + +Generate the autocompletion script for powershell + +### Synopsis + +Generate the autocompletion script for powershell. + +To load completions in your current shell session: + + ams.amc completion powershell | Out-String | Invoke-Expression + +To load completions for every new session, add the output of the above command +to your powershell profile. + + +``` +ams.amc completion powershell [flags] +``` + +### Options + +``` + -h, --help help for powershell + --no-descriptions disable completion descriptions +``` + +### SEE ALSO + +* [ams.amc completion](ams.amc_completion.md) - Generate the autocompletion script for the specified shell + +###### Auto generated by spf13/cobra on 8-Oct-2024 diff --git a/reference/cmd-ref/amc/ams.amc_completion_zsh.md b/reference/cmd-ref/amc/ams.amc_completion_zsh.md new file mode 100644 index 00000000..4590ccbd --- /dev/null +++ b/reference/cmd-ref/amc/ams.amc_completion_zsh.md @@ -0,0 +1,46 @@ +## ams.amc completion zsh + +Generate the autocompletion script for zsh + +### Synopsis + +Generate the autocompletion script for the zsh shell. + +If shell completion is not already enabled in your environment you will need +to enable it. You can execute the following once: + + echo "autoload -U compinit; compinit" >> ~/.zshrc + +To load completions in your current shell session: + + source <(ams.amc completion zsh) + +To load completions for every new session, execute once: + +#### Linux: + + ams.amc completion zsh > "${fpath[1]}/_ams.amc" + +#### macOS: + + ams.amc completion zsh > $(brew --prefix)/share/zsh/site-functions/_ams.amc + +You will need to start a new shell for this setup to take effect. + + +``` +ams.amc completion zsh [flags] +``` + +### Options + +``` + -h, --help help for zsh + --no-descriptions disable completion descriptions +``` + +### SEE ALSO + +* [ams.amc completion](ams.amc_completion.md) - Generate the autocompletion script for the specified shell + +###### Auto generated by spf13/cobra on 8-Oct-2024 diff --git a/reference/cmd-ref/amc/ams.amc_config.md b/reference/cmd-ref/amc/ams.amc_config.md new file mode 100644 index 00000000..23c5acd9 --- /dev/null +++ b/reference/cmd-ref/amc/ams.amc_config.md @@ -0,0 +1,28 @@ +## ams.amc config + +Manage AMS configuration + +### Synopsis + +Manage AMS configuration. + +Get and set global configuration items for the Anbox Management Service +(AMS). + +See https://anbox-cloud.io/docs/ref/ams-configuration for a list of +available configuration items. + +### Options + +``` + -h, --help help for config +``` + +### SEE ALSO + +* [ams.amc](ams.amc.md) - Anbox Management Client +* [ams.amc config set](ams.amc_config_set.md) - Set a single configuration item +* [ams.amc config show](ams.amc_config_show.md) - Show all configuration items +* [ams.amc config trust](ams.amc_config_trust.md) - Manage trusted clients + +###### Auto generated by spf13/cobra on 8-Oct-2024 diff --git a/reference/cmd-ref/amc/ams.amc_config_set.md b/reference/cmd-ref/amc/ams.amc_config_set.md new file mode 100644 index 00000000..01b0d35a --- /dev/null +++ b/reference/cmd-ref/amc/ams.amc_config_set.md @@ -0,0 +1,32 @@ +## ams.amc config set + +Set a single configuration item + +### Synopsis + +Set a single configuration item. + +See https://anbox-cloud.io/docs/ref/ams-configuration for a list of +available configuration items. + +``` +ams.amc config set [flags] +``` + +### Examples + +``` +$ amc config set container.features enable_virtual_keyboard +``` + +### Options + +``` + -h, --help help for set +``` + +### SEE ALSO + +* [ams.amc config](ams.amc_config.md) - Manage AMS configuration + +###### Auto generated by spf13/cobra on 8-Oct-2024 diff --git a/reference/cmd-ref/amc/ams.amc_config_show.md b/reference/cmd-ref/amc/ams.amc_config_show.md new file mode 100644 index 00000000..41923f28 --- /dev/null +++ b/reference/cmd-ref/amc/ams.amc_config_show.md @@ -0,0 +1,43 @@ +## ams.amc config show + +Show all configuration items + +``` +ams.amc config show [flags] +``` + +### Examples + +``` +$ amc config show +config: + application.addons: "" + application.auto_publish: "false" + application.max_published_versions: "3" + container.default_platform: "" + container.security_updates: "true" + core.trust_password: false + gpu.type: none + images.allow_insecure: "false" + images.update_interval: 5m + images.url: "" + registry.filter: "" + registry.fingerprint: "" + registry.mode: pull + registry.update_interval: 1h + registry.url: "" + image.auth: "" + +``` + +### Options + +``` + -h, --help help for show +``` + +### SEE ALSO + +* [ams.amc config](ams.amc_config.md) - Manage AMS configuration + +###### Auto generated by spf13/cobra on 8-Oct-2024 diff --git a/reference/cmd-ref/amc/ams.amc_config_trust.md b/reference/cmd-ref/amc/ams.amc_config_trust.md new file mode 100644 index 00000000..22c79948 --- /dev/null +++ b/reference/cmd-ref/amc/ams.amc_config_trust.md @@ -0,0 +1,25 @@ +## ams.amc config trust + +Manage trusted clients + +### Synopsis + +Manage trusted clients. + +Clients must be trusted to communicate with AMS. +Add or remove client certificates to allow or prevent communication with AMS. + +### Options + +``` + -h, --help help for trust +``` + +### SEE ALSO + +* [ams.amc config](ams.amc_config.md) - Manage AMS configuration +* [ams.amc config trust add](ams.amc_config_trust_add.md) - Add a trusted client +* [ams.amc config trust list](ams.amc_config_trust_list.md) - List trusted client certificates +* [ams.amc config trust remove](ams.amc_config_trust_remove.md) - Remove trust for a client + +###### Auto generated by spf13/cobra on 8-Oct-2024 diff --git a/reference/cmd-ref/amc/ams.amc_config_trust_add.md b/reference/cmd-ref/amc/ams.amc_config_trust_add.md new file mode 100644 index 00000000..53a1d856 --- /dev/null +++ b/reference/cmd-ref/amc/ams.amc_config_trust_add.md @@ -0,0 +1,32 @@ +## ams.amc config trust add + +Add a trusted client + +### Synopsis + +Add a trusted client. + +Trust a new client to communicate with AMS by providing its certificate. + + +``` +ams.amc config trust add [flags] +``` + +### Examples + +``` +$ amc config trust add client.crt +``` + +### Options + +``` + -h, --help help for add +``` + +### SEE ALSO + +* [ams.amc config trust](ams.amc_config_trust.md) - Manage trusted clients + +###### Auto generated by spf13/cobra on 8-Oct-2024 diff --git a/reference/cmd-ref/amc/ams.amc_config_trust_list.md b/reference/cmd-ref/amc/ams.amc_config_trust_list.md new file mode 100644 index 00000000..5693669b --- /dev/null +++ b/reference/cmd-ref/amc/ams.amc_config_trust_list.md @@ -0,0 +1,41 @@ +## ams.amc config trust list + +List trusted client certificates + +### Synopsis + +List trusted client certificates. + +Formatting can be controlled with the '--format' flag. +Valid formats are 'table' (see example), 'json' and 'csv'. + +``` +ams.amc config trust list [flags] +``` + +### Examples + +``` +$ amc config trust list ++--------------+--------------------+------------------------------+------------------------------+ +| FINGERPRINT | COMMON NAME | ISSUE DATE | EXPIRY DATE | ++--------------+--------------------+------------------------------+------------------------------+ +| a1c88ffec38d | ubuntu@vm0 | May 27, 2022 at 3:09pm (UTC) | May 24, 2032 at 3:09pm (UTC) | ++--------------+--------------------+------------------------------+------------------------------+ +| a31c1ab256f3 | root@juju-3bdb58-1 | May 27, 2022 at 3:06pm (UTC) | May 24, 2032 at 3:06pm (UTC) | ++--------------+--------------------+------------------------------+------------------------------+ + +``` + +### Options + +``` + --format string Output format - 'table', 'json' or 'yaml' (default "table") + -h, --help help for list +``` + +### SEE ALSO + +* [ams.amc config trust](ams.amc_config_trust.md) - Manage trusted clients + +###### Auto generated by spf13/cobra on 8-Oct-2024 diff --git a/reference/cmd-ref/amc/ams.amc_config_trust_remove.md b/reference/cmd-ref/amc/ams.amc_config_trust_remove.md new file mode 100644 index 00000000..85208f4c --- /dev/null +++ b/reference/cmd-ref/amc/ams.amc_config_trust_remove.md @@ -0,0 +1,31 @@ +## ams.amc config trust remove + +Remove trust for a client + +### Synopsis + +Remove trust for a client. + +This client will no longer be able to communicate with AMS. + +``` +ams.amc config trust remove [flags] +``` + +### Examples + +``` +$ amc config trust remove root@juju-3bdb58-1 +``` + +### Options + +``` + -h, --help help for remove +``` + +### SEE ALSO + +* [ams.amc config trust](ams.amc_config_trust.md) - Manage trusted clients + +###### Auto generated by spf13/cobra on 8-Oct-2024 diff --git a/reference/cmd-ref/amc/ams.amc_delete.md b/reference/cmd-ref/amc/ams.amc_delete.md new file mode 100644 index 00000000..edf0ce88 --- /dev/null +++ b/reference/cmd-ref/amc/ams.amc_delete.md @@ -0,0 +1,35 @@ +## ams.amc delete + +Delete an instance + +``` +ams.amc delete [flags] +``` + +### Examples + +``` +$ amc delete bkm6mj1hpuo01q954fl0 +The following instance will be REMOVED: + - bkm6mj1hpuo01q954fl0 +Do you want to continue? [Y/n]: + +``` + +### Options + +``` + -a, --all Delete all existing instances + -f, --force Force the removal of the instance + -h, --help help for delete + --no-wait Don't wait for the delete operation to finish + -n, --node string Select only instances for the specified node (this flag only works in combination with '--all') + -t, --timeout string Maximum time to wait for the operation to complete (default "5m") + -y, --yes Assume 'yes' as answer to all prompts and run non-interactively +``` + +### SEE ALSO + +* [ams.amc](ams.amc.md) - Anbox Management Client + +###### Auto generated by spf13/cobra on 8-Oct-2024 diff --git a/reference/cmd-ref/amc/ams.amc_exec.md b/reference/cmd-ref/amc/ams.amc_exec.md new file mode 100644 index 00000000..aa505a3b --- /dev/null +++ b/reference/cmd-ref/amc/ams.amc_exec.md @@ -0,0 +1,39 @@ +## ams.amc exec + +Execute a command inside an instance + +### Synopsis + +Execute a command inside an instance. + +To use flags in your command, you must isolate the command with +the '--' separator. + +The command is executed directly using exec, so there is no shell. +Shell patterns (variables, file redirects ...) won't be understood. +If you need a shell environment, execute the shell command and +pass the actual command as an argument (see the example below). + + +``` +ams.amc exec [--] [flags] +``` + +### Examples + +``` +$ amc exec -- sh -c "cd /tmp && pwd" +``` + +### Options + +``` + -T, --force-noninteractive Disable pseudo-terminal allocation + -h, --help help for exec +``` + +### SEE ALSO + +* [ams.amc](ams.amc.md) - Anbox Management Client + +###### Auto generated by spf13/cobra on 8-Oct-2024 diff --git a/reference/cmd-ref/amc/ams.amc_image.md b/reference/cmd-ref/amc/ams.amc_image.md new file mode 100644 index 00000000..f56cdf3a --- /dev/null +++ b/reference/cmd-ref/amc/ams.amc_image.md @@ -0,0 +1,36 @@ +## ams.amc image + +Manage images + +### Synopsis + +Manage images. + +Images are the base for a container running in Anbox Cloud and contain everything +necessary to properly run an Android application in a container. + +Images can be provided manually or via an image server. You can add, update or +delete them from AMS. + +See https://anbox-cloud.io/docs/ref/provided-images and +https://anbox-cloud.io/docs/howto/manage/images for more information. + + +### Options + +``` + -h, --help help for image +``` + +### SEE ALSO + +* [ams.amc](ams.amc.md) - Anbox Management Client +* [ams.amc image add](ams.amc_image_add.md) - Add an image +* [ams.amc image delete](ams.amc_image_delete.md) - Delete an image +* [ams.amc image list](ams.amc_image_list.md) - List available images +* [ams.amc image show](ams.amc_image_show.md) - Show information about an image +* [ams.amc image switch](ams.amc_image_switch.md) - Set the default image +* [ams.amc image sync](ams.amc_image_sync.md) - Synchronizes the image with the remote image server +* [ams.amc image update](ams.amc_image_update.md) - Update an existing image + +###### Auto generated by spf13/cobra on 8-Oct-2024 diff --git a/reference/cmd-ref/amc/ams.amc_image_add.md b/reference/cmd-ref/amc/ams.amc_image_add.md new file mode 100644 index 00000000..f778c7b5 --- /dev/null +++ b/reference/cmd-ref/amc/ams.amc_image_add.md @@ -0,0 +1,37 @@ +## ams.amc image add + +Add an image + +### Synopsis + +Add an image. + +The first image you add will be marked as the default image, which means it is used +when creating an application or launching a raw container without specifying an image. +After that, you can mark a new image as the default by adding the '--default' flag. + + +``` +ams.amc image add [flags] +``` + +### Examples + +``` +$ amc image add base path/to/image +``` + +### Options + +``` + -d, --default Mark image as the default image + -h, --help help for add + -t, --timeout string Maximum time to wait for the operation to complete (default "5m") + --type string Type of image to import. Only used when a remote image is added. Valid values are: any, container, vm (default "any") +``` + +### SEE ALSO + +* [ams.amc image](ams.amc_image.md) - Manage images + +###### Auto generated by spf13/cobra on 8-Oct-2024 diff --git a/reference/cmd-ref/amc/ams.amc_image_delete.md b/reference/cmd-ref/amc/ams.amc_image_delete.md new file mode 100644 index 00000000..bd56dcb5 --- /dev/null +++ b/reference/cmd-ref/amc/ams.amc_image_delete.md @@ -0,0 +1,45 @@ +## ams.amc image delete + +Delete an image + +### Synopsis + +Delete an image. + +Deleting an image removes all of its versions. If you want to remove only a +specific version, use the '--version' flag. + +Images synchronised from the image server cannot be deleted unless you specify +the '--force'|'-f' flag. + + +``` +ams.amc image delete ( | ) [flags] +``` + +### Examples + +``` +$ amc image delete foo +The following image will be REMOVED: + - foo +Do you want to continue? [Y/n]: + +``` + +### Options + +``` + -f, --force Force the deletion of immutable images + -h, --help help for delete + -t, --timeout string Maximum time to wait for the operation to complete (default "5m") + -v, --version int Version of the image to delete. If not specified, all versions are deleted. + --vm Delete the virtual machine variant of the image + -y, --yes Assume 'yes' as answer to all prompts and run non-interactively +``` + +### SEE ALSO + +* [ams.amc image](ams.amc_image.md) - Manage images + +###### Auto generated by spf13/cobra on 8-Oct-2024 diff --git a/reference/cmd-ref/amc/ams.amc_image_list.md b/reference/cmd-ref/amc/ams.amc_image_list.md new file mode 100644 index 00000000..351c8024 --- /dev/null +++ b/reference/cmd-ref/amc/ams.amc_image_list.md @@ -0,0 +1,40 @@ +## ams.amc image list + +List available images + +### Synopsis + +List available images. + +Formatting can be controlled with the '--format' flag. +Valid formats are 'table' (see example), 'yaml', 'json' and 'csv'. + + +``` +ams.amc image list [flags] +``` + +### Examples + +``` +$ amc image list ++----------------------+------+--------+----------+----------------+---------+ +| ID | NAME | STATUS | VERSIONS | ARCHITECTURE | DEFAULT | ++----------------------+------+--------+----------+----------------+---------+ +| bkkbiaphpuo3mh78ain0 | foo | active | 1 | x86_64 | true | ++----------------------+------+--------+----------+----------------+---------+ + +``` + +### Options + +``` + --format string Output format - 'table', 'json' or 'csv' (default "table") + -h, --help help for list +``` + +### SEE ALSO + +* [ams.amc image](ams.amc_image.md) - Manage images + +###### Auto generated by spf13/cobra on 8-Oct-2024 diff --git a/reference/cmd-ref/amc/ams.amc_image_show.md b/reference/cmd-ref/amc/ams.amc_image_show.md new file mode 100644 index 00000000..5c03e04b --- /dev/null +++ b/reference/cmd-ref/amc/ams.amc_image_show.md @@ -0,0 +1,47 @@ +## ams.amc image show + +Show information about an image + +### Synopsis + +Show information about an image. + +Formatting can be controlled with the '--format' flag. +Valid formats are 'json' and 'yaml'. + +``` +ams.amc image show ( | ) [flags] +``` + +### Examples + +``` +$ amc image show foo +id: bkkbiaphpuo3mh78ain0 +name: foo +status: active +versions: + 0: + size: 2.26MB + created-at: 2019-07-12 16:45:31 +0000 UTC + status: active +used_by: +- bkmtdm9hpuo01q954fng +architecture: x86_64 +default: true + +``` + +### Options + +``` + --format string Output format - 'json' or 'yaml' (default "yaml") + -h, --help help for show + --vm Show the virtual machine image instead of a container image +``` + +### SEE ALSO + +* [ams.amc image](ams.amc_image.md) - Manage images + +###### Auto generated by spf13/cobra on 8-Oct-2024 diff --git a/reference/cmd-ref/amc/ams.amc_image_switch.md b/reference/cmd-ref/amc/ams.amc_image_switch.md new file mode 100644 index 00000000..f75e58da --- /dev/null +++ b/reference/cmd-ref/amc/ams.amc_image_switch.md @@ -0,0 +1,33 @@ +## ams.amc image switch + +Set the default image + +### Synopsis + +Set the default image. + +The default image is used when creating an application that does not have an image +specified in the application manifest, or when launching a raw container without image ID. + + +``` +ams.amc image switch [flags] +``` + +### Examples + +``` +$ amc image switch foo +``` + +### Options + +``` + -h, --help help for switch +``` + +### SEE ALSO + +* [ams.amc image](ams.amc_image.md) - Manage images + +###### Auto generated by spf13/cobra on 8-Oct-2024 diff --git a/reference/cmd-ref/amc/ams.amc_image_sync.md b/reference/cmd-ref/amc/ams.amc_image_sync.md new file mode 100644 index 00000000..6ed10ba0 --- /dev/null +++ b/reference/cmd-ref/amc/ams.amc_image_sync.md @@ -0,0 +1,34 @@ +## ams.amc image sync + +Synchronizes the image with the remote image server + +### Synopsis + +Synchronizes the image with the remote image server. + +If the image is coming from a remote image server this will trigger explicit +synchronization with the remote server. This results in the image being +downloaded to the cluster from the remote server. + + +``` +ams.amc image sync [flags] +``` + +### Examples + +``` +$ amc image sync foo +``` + +### Options + +``` + -h, --help help for sync +``` + +### SEE ALSO + +* [ams.amc image](ams.amc_image.md) - Manage images + +###### Auto generated by spf13/cobra on 8-Oct-2024 diff --git a/reference/cmd-ref/amc/ams.amc_image_update.md b/reference/cmd-ref/amc/ams.amc_image_update.md new file mode 100644 index 00000000..cc5297c3 --- /dev/null +++ b/reference/cmd-ref/amc/ams.amc_image_update.md @@ -0,0 +1,34 @@ +## ams.amc image update + +Update an existing image + +### Synopsis + +Update an existing image. + +This command replaces the specified image with the new image and bumps its version number. + + +``` +ams.amc image update ( | ) [flags] +``` + +### Examples + +``` +$ amc image update foo foo-v2.tar.xz +``` + +### Options + +``` + -d, --default Mark image as the default image + -h, --help help for update + -t, --timeout string Maximum time to wait for the operation to complete (default "5m") +``` + +### SEE ALSO + +* [ams.amc image](ams.amc_image.md) - Manage images + +###### Auto generated by spf13/cobra on 8-Oct-2024 diff --git a/reference/cmd-ref/amc/ams.amc_info.md b/reference/cmd-ref/amc/ams.amc_info.md new file mode 100644 index 00000000..e4b949ff --- /dev/null +++ b/reference/cmd-ref/amc/ams.amc_info.md @@ -0,0 +1,47 @@ +## ams.amc info + +Provide general information about the connected AMS service + +### Synopsis + +Provide general information about the connected AMS service. + +Formatting can be controlled with the '--format' flag. +Valid formats are 'json' and 'yaml'. + +``` +ams.amc info [flags] +``` + +### Examples + +``` +$ amc info +api_extensions: +- addon_backup_hook +... +- application_hooks +api_status: stable +api_version: "1.0" +auth: trusted +auth_methods: +- 2waySSL +config: + application.addons: "" +... +scheduler.strategy: spread +service_version: 1.14.0 +``` + +### Options + +``` + --format string Output format - 'json' or 'yaml' (default "yaml") + -h, --help help for info +``` + +### SEE ALSO + +* [ams.amc](ams.amc.md) - Anbox Management Client + +###### Auto generated by spf13/cobra on 8-Oct-2024 diff --git a/reference/cmd-ref/amc/ams.amc_init.md b/reference/cmd-ref/amc/ams.amc_init.md new file mode 100644 index 00000000..5ca24f22 --- /dev/null +++ b/reference/cmd-ref/amc/ams.amc_init.md @@ -0,0 +1,56 @@ +## ams.amc init + +Create an instance but do not start it immediately + +### Synopsis + +Create an instance but do not start it immediately. To start such an instance, run 'amc start '. + +``` +ams.amc init ( | ) [flags] +``` + +### Examples + +``` +$ amc init foo +``` + +### Options + +``` + -a, --addons string Comma-separated list of addons to install in the instance (raw instances only) + -c, --cpus int Number of CPU cores to be assigned for the instance (for example, 2). If not specified, the number of CPU cores specified by the instance type will be used. (default 2) + --devmode Enable developer mode for the instance (default disabled) + --disable-watchdog Disable watchdog for the instance (regular instances only) + -d, --disk-size string Disk size of the instance (for example, 5GB). If not specified, the disk size specified by the instance type will be used. + --display-density int Pixel density of the virtual display of the instance (default 240) + --display-size string Size of the virtual display of the instance in the format x (default "1280x720") + --enable-graphics Enable graphics for the instance (default: disabled) + --enable-streaming Enable streaming for the instance (default: disabled) + -f, --features string Comma-separated list of features to enable for the Anbox runtime inside the instance + --fps int Frame rate the virtual display of the instance (default 60) + -g, --gpu-slots int Number of GPU slots to be assigned for the instance (for example, 1). If not specified, the number of GPU slots specified by the instance type will be used. (default -1) + -h, --help help for init + -m, --memory string Memory to be assigned for the instance (for example, 3GB). If not specified, the memory specified by the instance type will be used. + --metrics-server string Metrics server to which the instance sends its data + --name string Name of the instance. Must be unique + --no-wait Don't wait for the instance to start before returning (default: disabled) + -n, --node string LXD node to use for creating the instance + -p, --platform string Anbox platform to use + -r, --raw If specified, create a raw instance for the specified image instead of an application instance + -s, --service stringArray Services to expose on the instance IP endpoint for external access (public or private) + --tags string Comma-separated list of tags to set for the instance + -t, --timeout string Maximum time to wait for the operation to complete (default "5m") + --userdata string String with additional user data to be pushed into the created instance + --userdata-path string Path to a file with additional user data to be pushed into the created instance + --version int Specific version of an application or image to use when creating an instance (default -1) + --vm Create a virtual machine instead of a container (default: disabled) + -v, --vpu-slots int Number of VPU slots to be assigned for the instance (for example, 1). If not specified, the number of VPU slots specified by the instance type will be used. (default -1) +``` + +### SEE ALSO + +* [ams.amc](ams.amc.md) - Anbox Management Client + +###### Auto generated by spf13/cobra on 8-Oct-2024 diff --git a/reference/cmd-ref/amc/ams.amc_launch.md b/reference/cmd-ref/amc/ams.amc_launch.md new file mode 100644 index 00000000..33b5fa52 --- /dev/null +++ b/reference/cmd-ref/amc/ams.amc_launch.md @@ -0,0 +1,75 @@ +## ams.amc launch + +Launch an instance + +### Synopsis + +Launch an instance. + +When you launch an instance, you can: + +- Enable graphics support with the '--enable-graphics' flag. +- Specify the application version to launch with the '--version' flag. +- Enable addons with the '--addons' flag. +- Enable access to the instance with the '--service' flag. +- Pass user date to the instance with the '--userdata' or '--userdata-path' + flags. + +See https://anbox-cloud.io/docs/exp/instances and +https://anbox-cloud.io/docs/howto/instance/launch for detailed +information about instances. + +``` +ams.amc launch ( | ) [flags] +``` + +### Examples + +``` +$ amc launch foo --enable-graphics + +$ amc launch foo --version 2 + +$ amc launch foo --enable-graphics --userdata '{"display_width":1920, "display_height":1080, "fps": 60}' + +$ amc launch foo --service tcp:8080 --service tcp,udp:9000-9100 --addons bar --raw +``` + +### Options + +``` + -a, --addons string Comma-separated list of addons to install in the instance (raw instances only) + -c, --cpus int Number of CPU cores to be assigned for the instance (for example, 2). If not specified, the number of CPU cores specified by the instance type will be used. (default 2) + --devmode Enable developer mode for the instance (default disabled) + --disable-watchdog Disable watchdog for the instance (regular instances only) + -d, --disk-size string Disk size of the instance (for example, 5GB). If not specified, the disk size specified by the instance type will be used. + --display-density int Pixel density of the virtual display of the instance (default 240) + --display-size string Size of the virtual display of the instance in the format x (default "1280x720") + --enable-graphics Enable graphics for the instance (default: disabled) + --enable-streaming Enable streaming for the instance (default: disabled) + -f, --features string Comma-separated list of features to enable for the Anbox runtime inside the instance + --fps int Frame rate the virtual display of the instance (default 60) + -g, --gpu-slots int Number of GPU slots to be assigned for the instance (for example, 1). If not specified, the number of GPU slots specified by the instance type will be used. (default -1) + -h, --help help for launch + -m, --memory string Memory to be assigned for the instance (for example, 3GB). If not specified, the memory specified by the instance type will be used. + --metrics-server string Metrics server to which the instance sends its data + --name string Name of the instance. Must be unique + --no-wait Don't wait for the instance to start before returning (default: disabled) + -n, --node string LXD node to use for creating the instance + -p, --platform string Anbox platform to use + -r, --raw If specified, create a raw instance for the specified image instead of an application instance + -s, --service stringArray Services to expose on the instance IP endpoint for external access (public or private) + --tags string Comma-separated list of tags to set for the instance + -t, --timeout string Maximum time to wait for the operation to complete (default "5m") + --userdata string String with additional user data to be pushed into the created instance + --userdata-path string Path to a file with additional user data to be pushed into the created instance + --version int Specific version of an application or image to use when creating an instance (default -1) + --vm Create a virtual machine instead of a container (default: disabled) + -v, --vpu-slots int Number of VPU slots to be assigned for the instance (for example, 1). If not specified, the number of VPU slots specified by the instance type will be used. (default -1) +``` + +### SEE ALSO + +* [ams.amc](ams.amc.md) - Anbox Management Client + +###### Auto generated by spf13/cobra on 8-Oct-2024 diff --git a/reference/cmd-ref/amc/ams.amc_list.md b/reference/cmd-ref/amc/ams.amc_list.md new file mode 100644 index 00000000..c3c8bd9c --- /dev/null +++ b/reference/cmd-ref/amc/ams.amc_list.md @@ -0,0 +1,61 @@ +## ams.amc list + +List instances + +### Synopsis + +List instances. + +Formatting can be controlled with the '--format' flag. +Valid formats are 'table' (see example), 'json' and 'csv'. + +You can apply filters to narrow down the list of instances. +They are of the following form: + + --filter attribute=value + +'attribute' can be one of the following: + + +--------+----------------------------------------+ + | Name | Argument type | + +--------+----------------------------------------+ + | app | string (application id or name) | + | status | string (prepared, started, error, etc) | + | node | string | + | type | string (regular/base) | + | tags | comma-separated list | + | vm | boolean (true/false) | + +--------+----------------------------------------+ + + +``` +ams.amc list [flags] +``` + +### Examples + +``` +$ amc list ++----------------------+------+------------+---------+---------+------+---------------+-----------+ +| ID | NAME |APPLICATION | TYPE | STATUS | NODE | ADDRESS | ENDPOINTS | ++----------------------+------+------------+---------+---------+------+---------------+-----------+ +| bknj0n9hpuo01q954fq0 | foo | bar | regular | running | lxd0 | 192.168.100.2 | | ++----------------------+------+------------+---------+---------+------+---------------+-----------+ + +$ amc list --filter status=error + +``` + +### Options + +``` + -f, --filter stringArray Filter the output based on conditions (for example, 'status=running') + --format string Output format -'table', 'json' or 'csv' (default "table") + -h, --help help for list +``` + +### SEE ALSO + +* [ams.amc](ams.amc.md) - Anbox Management Client + +###### Auto generated by spf13/cobra on 8-Oct-2024 diff --git a/reference/cmd-ref/amc/ams.amc_logs.md b/reference/cmd-ref/amc/ams.amc_logs.md new file mode 100644 index 00000000..39ea6cd6 --- /dev/null +++ b/reference/cmd-ref/amc/ams.amc_logs.md @@ -0,0 +1,46 @@ +## ams.amc logs + +Show runtime logs of an instance + +### Synopsis + +Show runtime logs of an instance. + +Anbox instances run a regular Ubuntu system with a nested Android container. +You can display system-level logs of the Anbox instance or the nested Android +instance. + +``` +ams.amc logs [flags] +``` + +### Examples + +``` +Show the logs of the Ubuntu instance: + +$ amc logs burp70p3p7j1icvtebig + +Show the logs of the Android container: + +$ amc logs -t android burp70p3p7j1icvtebig + +Follow the logs for new entries: + +$ amc logs -f burp70p3p7j1icvtebig + +``` + +### Options + +``` + -f, --follow Show only the most recent log entries and continuously print new entries as they are appended to the log + -h, --help help for logs + -t, --type anbox Type of logs to show - anbox or `android` (default "anbox") +``` + +### SEE ALSO + +* [ams.amc](ams.amc.md) - Anbox Management Client + +###### Auto generated by spf13/cobra on 8-Oct-2024 diff --git a/reference/cmd-ref/amc/ams.amc_node.md b/reference/cmd-ref/amc/ams.amc_node.md new file mode 100644 index 00000000..4faa2eb3 --- /dev/null +++ b/reference/cmd-ref/amc/ams.amc_node.md @@ -0,0 +1,29 @@ +## ams.amc node + +Manage nodes + +### Synopsis + +Manage nodes. + +Nodes are LXD machines that run Anbox containers and are managed by AMS. + +See https://anbox-cloud.io/docs/exp/clustering for more information. + + +### Options + +``` + -h, --help help for node +``` + +### SEE ALSO + +* [ams.amc](ams.amc.md) - Anbox Management Client +* [ams.amc node add](ams.amc_node_add.md) - Add a node to AMS +* [ams.amc node list](ams.amc_node_list.md) - List available nodes +* [ams.amc node remove](ams.amc_node_remove.md) - Remove a node +* [ams.amc node set](ams.amc_node_set.md) - Set a configuration item for a node +* [ams.amc node show](ams.amc_node_show.md) - Show information about a node + +###### Auto generated by spf13/cobra on 8-Oct-2024 diff --git a/reference/cmd-ref/amc/ams.amc_node_add.md b/reference/cmd-ref/amc/ams.amc_node_add.md new file mode 100644 index 00000000..8ee5dec8 --- /dev/null +++ b/reference/cmd-ref/amc/ams.amc_node_add.md @@ -0,0 +1,46 @@ +## ams.amc node add + +Add a node to AMS + +### Synopsis + +Add a node to AMS. + +The new node must have an accessible IP address. + +Install LXD on the node before adding it, but do not initialise the LXD instance +with the 'lxd init' command. +AMS takes care of the initialisation and configuration. + +``` +ams.amc node add
[flags] +``` + +### Examples + +``` +$ amc node new lxd0 10.48.61.89 +nodes: + - lxd0 + +``` + +### Options + +``` + -h, --help help for add + --network string Name of the network device to create on the LXD cluster (default 'amsbr0') + --network-bridge-mtu int MTU of the network bridge that is configured for LXD + --network-subnet string Network subnet for the network device on the node (default '192.168.100.1/20') + --storage-device string Storage device that the LXD node should use + --storage-pool string Existing LXD storage pool to use + --tags string Comma-separated list of tags to set for the node + --trust-password string Trust password for the remote LXD node + --unmanaged Expect the node to already be clustered +``` + +### SEE ALSO + +* [ams.amc node](ams.amc_node.md) - Manage nodes + +###### Auto generated by spf13/cobra on 8-Oct-2024 diff --git a/reference/cmd-ref/amc/ams.amc_node_list.md b/reference/cmd-ref/amc/ams.amc_node_list.md new file mode 100644 index 00000000..076a17b7 --- /dev/null +++ b/reference/cmd-ref/amc/ams.amc_node_list.md @@ -0,0 +1,57 @@ +## ams.amc node list + +List available nodes + +### Synopsis + +List available nodes. + +Formatting can be controlled with the '--format' flag. +Valid formats are 'table' (see example), 'json' and 'csv'. + +You can apply filters to narrow down the list of nodes. +They are of the following form: + + --filter attribute=value + +'attribute' can be one of the following: + + +---------------+-------------------------------+ + | Name | Argument type | + +---------------+-------------------------------+ + | master | Boolean (true/false) | + | status | string (online, offline etc.) | + +---------------+-------------------------------+ + + + +``` +ams.amc node list [flags] +``` + +### Examples + +``` +$ amc node list ++------+--------------+----------------+--------+--------------+ +| NAME | ADDRESS | PUBLIC ADDRESS | STATUS | ARCHITECTURE | ++------+--------------+----------------+--------+--------------+ +| lxd0 | 10.247.64.32 | 10.247.64.32 | online | aarch64 | ++------+--------------+----------------+--------+--------------+ + +$ amc node list --filter status=online +``` + +### Options + +``` + -f, --filter stringArray Filter the output based on conditions (for example, 'master=true') + --format string Output format - 'table', 'json' or 'csv' (default "table") + -h, --help help for list +``` + +### SEE ALSO + +* [ams.amc node](ams.amc_node.md) - Manage nodes + +###### Auto generated by spf13/cobra on 8-Oct-2024 diff --git a/reference/cmd-ref/amc/ams.amc_node_remove.md b/reference/cmd-ref/amc/ams.amc_node_remove.md new file mode 100644 index 00000000..0fcb0e54 --- /dev/null +++ b/reference/cmd-ref/amc/ams.amc_node_remove.md @@ -0,0 +1,37 @@ +## ams.amc node remove + +Remove a node + +### Synopsis + +Remove a node. + +Removing a node excludes it from the Anbox Cloud cluster and makes it unable to host containers. + +You cannot delete a node with running containers unless you specify the '--force'|'-f' flag. + + +``` +ams.amc node remove [flags] +``` + +### Examples + +``` +$ amc node remove lxd2 +``` + +### Options + +``` + -f, --force Force the removal of the node + -h, --help help for remove + --keep-in-cluster Keep the LXD node as part of the cluster and just remove it from the AMS database + -y, --yes Assume 'yes' as answer to all prompts and run non-interactively +``` + +### SEE ALSO + +* [ams.amc node](ams.amc_node.md) - Manage nodes + +###### Auto generated by spf13/cobra on 8-Oct-2024 diff --git a/reference/cmd-ref/amc/ams.amc_node_set.md b/reference/cmd-ref/amc/ams.amc_node_set.md new file mode 100644 index 00000000..51fc860b --- /dev/null +++ b/reference/cmd-ref/amc/ams.amc_node_set.md @@ -0,0 +1,33 @@ +## ams.amc node set + +Set a configuration item for a node + +### Synopsis + +Set a configuration item for a node. + +See https://anbox-cloud.io/docs/ref/ams-configuration for a list of +available configuration items. + +``` +ams.amc node set [flags] +``` + +### Examples + +``` +$ amc node set lxd0 cpus 8 +``` + +### Options + +``` + -h, --help help for set + -t, --timeout string Maximum time to wait for the operation to complete (default "5m") +``` + +### SEE ALSO + +* [ams.amc node](ams.amc_node.md) - Manage nodes + +###### Auto generated by spf13/cobra on 8-Oct-2024 diff --git a/reference/cmd-ref/amc/ams.amc_node_show.md b/reference/cmd-ref/amc/ams.amc_node_show.md new file mode 100644 index 00000000..c4629c00 --- /dev/null +++ b/reference/cmd-ref/amc/ams.amc_node_show.md @@ -0,0 +1,58 @@ +## ams.amc node show + +Show information about a node + +### Synopsis + +Show information about a node. + +Formatting can be controlled with the '--format' flag. +Valid formats are 'json' and 'yaml'. + +``` +ams.amc node show [flags] +``` + +### Examples + +``` +$ amc node show node1 +name: node1 +managed: true +status: online +unschedulable: false +architecture: x86_64 +disk: + pool: ams0 + size: 13GB +network: + address: 10.48.61.89 + bridge-mtu: 1500 +gpus: + 0: + pci-address: 00:08.0 +config: + public-address: 10.48.61.89 + cpus: 0 + cpu-allocation-rate: 4 + memory: 0B + memory-allocation-rate: 2 + gpu-slots: 0 + gpu-encoder-slots: 0 + tags: [] + +``` + +### Options + +``` + --allocations Show resource allocations + -f, --format string Output format - 'json' or 'yaml' (default "yaml") + -h, --help help for show +``` + +### SEE ALSO + +* [ams.amc node](ams.amc_node.md) - Manage nodes + +###### Auto generated by spf13/cobra on 8-Oct-2024 diff --git a/reference/cmd-ref/amc/ams.amc_remote.md b/reference/cmd-ref/amc/ams.amc_remote.md new file mode 100644 index 00000000..7d45b39e --- /dev/null +++ b/reference/cmd-ref/amc/ams.amc_remote.md @@ -0,0 +1,29 @@ +## ams.amc remote + +Interact with remote AMS daemons + +### Synopsis + +Interact with remote AMS daemons. + +AMC is a client talking to a daemon (AMS). You can configure the connection to different remote daemons. + +See https://anbox-cloud.io/docs/howto/manage/ams-access for more information. + + +### Options + +``` + -h, --help help for remote +``` + +### SEE ALSO + +* [ams.amc](ams.amc.md) - Anbox Management Client +* [ams.amc remote add](ams.amc_remote_add.md) - Add a remote +* [ams.amc remote list](ams.amc_remote_list.md) - List registered remotes +* [ams.amc remote remove](ams.amc_remote_remove.md) - Remove a registered remote +* [ams.amc remote set-default](ams.amc_remote_set-default.md) - Set default remote +* [ams.amc remote set-url](ams.amc_remote_set-url.md) - Set the URL of an existing remote + +###### Auto generated by spf13/cobra on 8-Oct-2024 diff --git a/reference/cmd-ref/amc/ams.amc_remote_add.md b/reference/cmd-ref/amc/ams.amc_remote_add.md new file mode 100644 index 00000000..1183ac15 --- /dev/null +++ b/reference/cmd-ref/amc/ams.amc_remote_add.md @@ -0,0 +1,35 @@ +## ams.amc remote add + +Add a remote + +### Synopsis + +Add a remote. + +Set a connection to a remote AMS daemon. + +If you set up a trust password on the daemon, you must provide it when running the command. + + +``` +ams.amc remote add [trust_password] [flags] +``` + +### Examples + +``` +$ amc remote add local unix:// +``` + +### Options + +``` + --accept-certificate Implicitly accept remote server certificate + -h, --help help for add +``` + +### SEE ALSO + +* [ams.amc remote](ams.amc_remote.md) - Interact with remote AMS daemons + +###### Auto generated by spf13/cobra on 8-Oct-2024 diff --git a/reference/cmd-ref/amc/ams.amc_remote_list.md b/reference/cmd-ref/amc/ams.amc_remote_list.md new file mode 100644 index 00000000..b3ba1fdf --- /dev/null +++ b/reference/cmd-ref/amc/ams.amc_remote_list.md @@ -0,0 +1,39 @@ +## ams.amc remote list + +List registered remotes + +### Synopsis + +List registered remotes. + +Formatting can be controlled with the '--format' flag. +Valid formats are 'table' (see example), 'json' and 'csv'. + +``` +ams.amc remote list [flags] +``` + +### Examples + +``` +$ amc remote list ++--------+---------+---------+ +| NAME | URL | DEFAULT | ++--------+---------+---------+ +| local | unix:// | true | ++--------+---------+---------+ + +``` + +### Options + +``` + --format string Output format - 'table', 'json' or 'csv' (default "table") + -h, --help help for list +``` + +### SEE ALSO + +* [ams.amc remote](ams.amc_remote.md) - Interact with remote AMS daemons + +###### Auto generated by spf13/cobra on 8-Oct-2024 diff --git a/reference/cmd-ref/amc/ams.amc_remote_remove.md b/reference/cmd-ref/amc/ams.amc_remote_remove.md new file mode 100644 index 00000000..55518d0c --- /dev/null +++ b/reference/cmd-ref/amc/ams.amc_remote_remove.md @@ -0,0 +1,25 @@ +## ams.amc remote remove + +Remove a registered remote + +``` +ams.amc remote remove [flags] +``` + +### Examples + +``` +$ amc remote remove foo +``` + +### Options + +``` + -h, --help help for remove +``` + +### SEE ALSO + +* [ams.amc remote](ams.amc_remote.md) - Interact with remote AMS daemons + +###### Auto generated by spf13/cobra on 8-Oct-2024 diff --git a/reference/cmd-ref/amc/ams.amc_remote_set-default.md b/reference/cmd-ref/amc/ams.amc_remote_set-default.md new file mode 100644 index 00000000..57683250 --- /dev/null +++ b/reference/cmd-ref/amc/ams.amc_remote_set-default.md @@ -0,0 +1,32 @@ +## ams.amc remote set-default + +Set default remote + +### Synopsis + +Set default remote. + +The default remote is the primary remote used for requests via AMC. + + +``` +ams.amc remote set-default [flags] +``` + +### Examples + +``` +$ amc remote set-default foo +``` + +### Options + +``` + -h, --help help for set-default +``` + +### SEE ALSO + +* [ams.amc remote](ams.amc_remote.md) - Interact with remote AMS daemons + +###### Auto generated by spf13/cobra on 8-Oct-2024 diff --git a/reference/cmd-ref/amc/ams.amc_remote_set-url.md b/reference/cmd-ref/amc/ams.amc_remote_set-url.md new file mode 100644 index 00000000..6cf567ca --- /dev/null +++ b/reference/cmd-ref/amc/ams.amc_remote_set-url.md @@ -0,0 +1,25 @@ +## ams.amc remote set-url + +Set the URL of an existing remote + +``` +ams.amc remote set-url [flags] +``` + +### Examples + +``` +$ amc remote add foo https://192.0.2.10:8444 +``` + +### Options + +``` + -h, --help help for set-url +``` + +### SEE ALSO + +* [ams.amc remote](ams.amc_remote.md) - Interact with remote AMS daemons + +###### Auto generated by spf13/cobra on 8-Oct-2024 diff --git a/reference/cmd-ref/amc/ams.amc_shell.md b/reference/cmd-ref/amc/ams.amc_shell.md new file mode 100644 index 00000000..826727ee --- /dev/null +++ b/reference/cmd-ref/amc/ams.amc_shell.md @@ -0,0 +1,33 @@ +## ams.amc shell + +Open a shell inside a running instance + +### Synopsis + +Open a shell inside a running instance. + +This command is an alias for 'amc exec -- su -l'. + + +``` +ams.amc shell [flags] +``` + +### Examples + +``` +$ amc shell cbluej507mpg272hdmo0 +root@ams-cbluej507mpg272hdmo0:~# +``` + +### Options + +``` + -h, --help help for shell +``` + +### SEE ALSO + +* [ams.amc](ams.amc.md) - Anbox Management Client + +###### Auto generated by spf13/cobra on 8-Oct-2024 diff --git a/reference/cmd-ref/amc/ams.amc_show-log.md b/reference/cmd-ref/amc/ams.amc_show-log.md new file mode 100644 index 00000000..e5066e5e --- /dev/null +++ b/reference/cmd-ref/amc/ams.amc_show-log.md @@ -0,0 +1,34 @@ +## ams.amc show-log + +Show an instance log file + +### Synopsis + +Show an instance log file. + +There are different log files that you can display. Use the following +command to get the names of the available log files: + amc show + + +``` +ams.amc show-log [flags] +``` + +### Examples + +``` +$ amc show-log bknj0n9hpuo01q954fq0 system.log +``` + +### Options + +``` + -h, --help help for show-log +``` + +### SEE ALSO + +* [ams.amc](ams.amc.md) - Anbox Management Client + +###### Auto generated by spf13/cobra on 8-Oct-2024 diff --git a/reference/cmd-ref/amc/ams.amc_show.md b/reference/cmd-ref/amc/ams.amc_show.md new file mode 100644 index 00000000..6f1907fd --- /dev/null +++ b/reference/cmd-ref/amc/ams.amc_show.md @@ -0,0 +1,47 @@ +## ams.amc show + +Show information about an instance + +### Synopsis + +Show information about an instance. + +Formatting can be controlled with the '--format' flag. +Valid formats are 'json' and 'yaml'. + +``` +ams.amc show [flags] +``` + +### Examples + +``` +$ amc show bknj0n9hpuo01q954fq0 +id: bknj0n9hpuo01q954fq0 +name: ams-bknj0n9hpuo01q954fq0 +status: running +node: lxd0 +created_at: 2019-07-17T14:27:41Z +image: + id: bkkbiaphpuo3mh78ain0 +network: + address: 192.168.100.2 + public_address: 10.48.61.89 + services: [] +stored_logs: [] +error_message: "" + +``` + +### Options + +``` + --format string Output format - 'json' or 'yaml' (default "yaml") + -h, --help help for show +``` + +### SEE ALSO + +* [ams.amc](ams.amc.md) - Anbox Management Client + +###### Auto generated by spf13/cobra on 8-Oct-2024 diff --git a/reference/cmd-ref/amc/ams.amc_start.md b/reference/cmd-ref/amc/ams.amc_start.md new file mode 100644 index 00000000..1012bb58 --- /dev/null +++ b/reference/cmd-ref/amc/ams.amc_start.md @@ -0,0 +1,43 @@ +## ams.amc start + +Start an existing instance + +### Synopsis + +Start an existing instance that has an status 'prepared', 'stopped'. + +When an Anbox instance is initialised with the 'amc init' command, it is not started automatically. +You must start it explicitly with the 'amc start' command. + +When an Anbox instance ends up with the 'error' status, you can start it again with 'amc start' command. + + +``` +ams.amc start [flags] +``` + +### Examples + +``` + Initialise an instance: + $ amc init + ceg2ukbhc8ic3ftkc990 + + Start the instance: + $ amc start ceg2ukbhc8ic3ftkc990 +``` + +### Options + +``` + -h, --help help for start + --no-wait Don't wait for the instance to start before returning (default disabled) + -t, --timeout string Maximum time to wait for the operation to complete (default "5m") + -y, --yes error Force start the instance from error state +``` + +### SEE ALSO + +* [ams.amc](ams.amc.md) - Anbox Management Client + +###### Auto generated by spf13/cobra on 8-Oct-2024 diff --git a/reference/cmd-ref/amc/ams.amc_stop.md b/reference/cmd-ref/amc/ams.amc_stop.md new file mode 100644 index 00000000..490a0b2c --- /dev/null +++ b/reference/cmd-ref/amc/ams.amc_stop.md @@ -0,0 +1,39 @@ +## ams.amc stop + +Stop a running instance + +### Synopsis + +Stop a running instance. + +If the instance is in 'running' status, you can stop it with the 'amc stop' command. + + +``` +ams.amc stop [flags] +``` + +### Examples + +``` + Launch an instance: + $ amc launch + ceg2ukbhc8ic3ftkc990 + + Stop the running instance: + $ amc stop ceg2ukbhc8ic3ftkc990 +``` + +### Options + +``` + -h, --help help for stop + --no-wait Don't wait for the instance to stop before returning (default disabled) + -t, --timeout string Maximum time to wait for the operation to complete (default "5m") +``` + +### SEE ALSO + +* [ams.amc](ams.amc.md) - Anbox Management Client + +###### Auto generated by spf13/cobra on 8-Oct-2024 diff --git a/reference/cmd-ref/amc/ams.amc_wait.md b/reference/cmd-ref/amc/ams.amc_wait.md new file mode 100644 index 00000000..fc16ce48 --- /dev/null +++ b/reference/cmd-ref/amc/ams.amc_wait.md @@ -0,0 +1,47 @@ +## ams.amc wait + +Wait for an instance to reach a specific condition + +### Synopsis + +Wait for an instance to reach a specific condition. + +You must specify one or multiple conditions with the '--condition'|'-c' flag. + +A condition is of the form 'key=value', where 'key' is a supported attribute +and 'value' defines what to wait on. + +Valid attributes: + - For applications: published, status + - For application versions: published, status + - For instances: status + +Use '--selector version=' to wait on an application version. + +``` +ams.amc wait ( | ) [flags] +``` + +### Examples + +``` +Wait for the application to be either ready or in an error state: + +$ amc wait bkhk491hpuo2c84rai9g -c status=ready -c status=error + +``` + +### Options + +``` + -c, --condition stringArray Condition of the application or instance to wait for + -h, --help help for wait + -s, --selector string Selector to filter the application or instance + -t, --timeout string Maximum time to wait for the condition (default "5m") +``` + +### SEE ALSO + +* [ams.amc](ams.amc.md) - Anbox Management Client + +###### Auto generated by spf13/cobra on 8-Oct-2024 diff --git a/reference/cmd-ref/appliance/anbox-cloud-appliance.md b/reference/cmd-ref/appliance/anbox-cloud-appliance.md new file mode 100644 index 00000000..51f61add --- /dev/null +++ b/reference/cmd-ref/appliance/anbox-cloud-appliance.md @@ -0,0 +1,40 @@ +## anbox-cloud-appliance + +Anbox Cloud Appliance, bringing Android at scale to any cloud + +### Synopsis + +Command-Line client for the Anbox Cloud Appliance + +The Anbox Cloud Appliance is a small scale version of Canonical’s Anbox Cloud, intended +for rapid prototyping of Android-in-the-Cloud solutions. The AMI offers a development +sandbox for corporate innovation labs and startups building disruptive mobile cloud +computing ideas. Game streaming, cloud-based mobile application management, mobile device +virtualization, cost-effective mobile app testing, and more exciting use cases are now +accessible to you. + +Anbox Cloud Appliance puts an emphasis on your productivity. It provides a +developer-friendly CLI and a simple web UI to manage and operate Android cloud apps at +the scale of your lab. Upload your Android apps, configure and virtualise Android devices +and stream graphical output in real time to any web or mobile client. Unleash your +creativity to invent new mobile user experiences with Anbox Cloud Appliance. + + +### Options + +``` + -h, --help help for anbox-cloud-appliance +``` + +### SEE ALSO + +* [anbox-cloud-appliance buginfo](anbox-cloud-appliance_buginfo.md) - Collection information for effective bug reports +* [anbox-cloud-appliance completion](anbox-cloud-appliance_completion.md) - Generate the autocompletion script for the specified shell +* [anbox-cloud-appliance config](anbox-cloud-appliance_config.md) - Managed the Anbox Cloud Appliance configuration +* [anbox-cloud-appliance daemon](anbox-cloud-appliance_daemon.md) - Run the Anbox Cloud Appliance daemon +* [anbox-cloud-appliance dashboard](anbox-cloud-appliance_dashboard.md) - Manage the dashboard of the Anbox Cloud Appliance +* [anbox-cloud-appliance init](anbox-cloud-appliance_init.md) - Initialize and configure the Anbox Cloud Appliance +* [anbox-cloud-appliance prepare-node-script](anbox-cloud-appliance_prepare-node-script.md) - Generate a shell script to prepare a machine for the Anbox Cloud Appliance +* [anbox-cloud-appliance status](anbox-cloud-appliance_status.md) - Retrieves the current status of the Anbox Cloud Appliance + +###### Auto generated by spf13/cobra on 8-Oct-2024 diff --git a/reference/cmd-ref/appliance/anbox-cloud-appliance_buginfo.md b/reference/cmd-ref/appliance/anbox-cloud-appliance_buginfo.md new file mode 100644 index 00000000..8fabd7fc --- /dev/null +++ b/reference/cmd-ref/appliance/anbox-cloud-appliance_buginfo.md @@ -0,0 +1,30 @@ +## anbox-cloud-appliance buginfo + +Collection information for effective bug reports + +### Synopsis + +Collection information for effective bug reports + +In order to provide all necessary information when reporting bugs in the +Anbox Cloud Appliance, the buginfo command combines all necessary +information in a single report which can be easily shared. with a bug +report. + +Please report bugs on https://bugs.launchpad.net/anbox-cloud + +``` +anbox-cloud-appliance buginfo [flags] +``` + +### Options + +``` + -h, --help help for buginfo +``` + +### SEE ALSO + +* [anbox-cloud-appliance](anbox-cloud-appliance.md) - Anbox Cloud Appliance, bringing Android at scale to any cloud + +###### Auto generated by spf13/cobra on 8-Oct-2024 diff --git a/reference/cmd-ref/appliance/anbox-cloud-appliance_completion.md b/reference/cmd-ref/appliance/anbox-cloud-appliance_completion.md new file mode 100644 index 00000000..7965bcd5 --- /dev/null +++ b/reference/cmd-ref/appliance/anbox-cloud-appliance_completion.md @@ -0,0 +1,25 @@ +## anbox-cloud-appliance completion + +Generate the autocompletion script for the specified shell + +### Synopsis + +Generate the autocompletion script for anbox-cloud-appliance for the specified shell. +See each sub-command's help for details on how to use the generated script. + + +### Options + +``` + -h, --help help for completion +``` + +### SEE ALSO + +* [anbox-cloud-appliance](anbox-cloud-appliance.md) - Anbox Cloud Appliance, bringing Android at scale to any cloud +* [anbox-cloud-appliance completion bash](anbox-cloud-appliance_completion_bash.md) - Generate the autocompletion script for bash +* [anbox-cloud-appliance completion fish](anbox-cloud-appliance_completion_fish.md) - Generate the autocompletion script for fish +* [anbox-cloud-appliance completion powershell](anbox-cloud-appliance_completion_powershell.md) - Generate the autocompletion script for powershell +* [anbox-cloud-appliance completion zsh](anbox-cloud-appliance_completion_zsh.md) - Generate the autocompletion script for zsh + +###### Auto generated by spf13/cobra on 8-Oct-2024 diff --git a/reference/cmd-ref/appliance/anbox-cloud-appliance_completion_bash.md b/reference/cmd-ref/appliance/anbox-cloud-appliance_completion_bash.md new file mode 100644 index 00000000..c611b874 --- /dev/null +++ b/reference/cmd-ref/appliance/anbox-cloud-appliance_completion_bash.md @@ -0,0 +1,44 @@ +## anbox-cloud-appliance completion bash + +Generate the autocompletion script for bash + +### Synopsis + +Generate the autocompletion script for the bash shell. + +This script depends on the 'bash-completion' package. +If it is not installed already, you can install it via your OS's package manager. + +To load completions in your current shell session: + + source <(anbox-cloud-appliance completion bash) + +To load completions for every new session, execute once: + +#### Linux: + + anbox-cloud-appliance completion bash > /etc/bash_completion.d/anbox-cloud-appliance + +#### macOS: + + anbox-cloud-appliance completion bash > $(brew --prefix)/etc/bash_completion.d/anbox-cloud-appliance + +You will need to start a new shell for this setup to take effect. + + +``` +anbox-cloud-appliance completion bash +``` + +### Options + +``` + -h, --help help for bash + --no-descriptions disable completion descriptions +``` + +### SEE ALSO + +* [anbox-cloud-appliance completion](anbox-cloud-appliance_completion.md) - Generate the autocompletion script for the specified shell + +###### Auto generated by spf13/cobra on 8-Oct-2024 diff --git a/reference/cmd-ref/appliance/anbox-cloud-appliance_completion_fish.md b/reference/cmd-ref/appliance/anbox-cloud-appliance_completion_fish.md new file mode 100644 index 00000000..e29997a7 --- /dev/null +++ b/reference/cmd-ref/appliance/anbox-cloud-appliance_completion_fish.md @@ -0,0 +1,35 @@ +## anbox-cloud-appliance completion fish + +Generate the autocompletion script for fish + +### Synopsis + +Generate the autocompletion script for the fish shell. + +To load completions in your current shell session: + + anbox-cloud-appliance completion fish | source + +To load completions for every new session, execute once: + + anbox-cloud-appliance completion fish > ~/.config/fish/completions/anbox-cloud-appliance.fish + +You will need to start a new shell for this setup to take effect. + + +``` +anbox-cloud-appliance completion fish [flags] +``` + +### Options + +``` + -h, --help help for fish + --no-descriptions disable completion descriptions +``` + +### SEE ALSO + +* [anbox-cloud-appliance completion](anbox-cloud-appliance_completion.md) - Generate the autocompletion script for the specified shell + +###### Auto generated by spf13/cobra on 8-Oct-2024 diff --git a/reference/cmd-ref/appliance/anbox-cloud-appliance_completion_powershell.md b/reference/cmd-ref/appliance/anbox-cloud-appliance_completion_powershell.md new file mode 100644 index 00000000..7db971d0 --- /dev/null +++ b/reference/cmd-ref/appliance/anbox-cloud-appliance_completion_powershell.md @@ -0,0 +1,32 @@ +## anbox-cloud-appliance completion powershell + +Generate the autocompletion script for powershell + +### Synopsis + +Generate the autocompletion script for powershell. + +To load completions in your current shell session: + + anbox-cloud-appliance completion powershell | Out-String | Invoke-Expression + +To load completions for every new session, add the output of the above command +to your powershell profile. + + +``` +anbox-cloud-appliance completion powershell [flags] +``` + +### Options + +``` + -h, --help help for powershell + --no-descriptions disable completion descriptions +``` + +### SEE ALSO + +* [anbox-cloud-appliance completion](anbox-cloud-appliance_completion.md) - Generate the autocompletion script for the specified shell + +###### Auto generated by spf13/cobra on 8-Oct-2024 diff --git a/reference/cmd-ref/appliance/anbox-cloud-appliance_completion_zsh.md b/reference/cmd-ref/appliance/anbox-cloud-appliance_completion_zsh.md new file mode 100644 index 00000000..4bdc0ccb --- /dev/null +++ b/reference/cmd-ref/appliance/anbox-cloud-appliance_completion_zsh.md @@ -0,0 +1,46 @@ +## anbox-cloud-appliance completion zsh + +Generate the autocompletion script for zsh + +### Synopsis + +Generate the autocompletion script for the zsh shell. + +If shell completion is not already enabled in your environment you will need +to enable it. You can execute the following once: + + echo "autoload -U compinit; compinit" >> ~/.zshrc + +To load completions in your current shell session: + + source <(anbox-cloud-appliance completion zsh) + +To load completions for every new session, execute once: + +#### Linux: + + anbox-cloud-appliance completion zsh > "${fpath[1]}/_anbox-cloud-appliance" + +#### macOS: + + anbox-cloud-appliance completion zsh > $(brew --prefix)/share/zsh/site-functions/_anbox-cloud-appliance + +You will need to start a new shell for this setup to take effect. + + +``` +anbox-cloud-appliance completion zsh [flags] +``` + +### Options + +``` + -h, --help help for zsh + --no-descriptions disable completion descriptions +``` + +### SEE ALSO + +* [anbox-cloud-appliance completion](anbox-cloud-appliance_completion.md) - Generate the autocompletion script for the specified shell + +###### Auto generated by spf13/cobra on 8-Oct-2024 diff --git a/reference/cmd-ref/appliance/anbox-cloud-appliance_config.md b/reference/cmd-ref/appliance/anbox-cloud-appliance_config.md new file mode 100644 index 00000000..9eccea64 --- /dev/null +++ b/reference/cmd-ref/appliance/anbox-cloud-appliance_config.md @@ -0,0 +1,21 @@ +## anbox-cloud-appliance config + +Managed the Anbox Cloud Appliance configuration + +### Synopsis + +Get and set global configuration items for the Anbox Cloud Appliance. + +### Options + +``` + -h, --help help for config +``` + +### SEE ALSO + +* [anbox-cloud-appliance](anbox-cloud-appliance.md) - Anbox Cloud Appliance, bringing Android at scale to any cloud +* [anbox-cloud-appliance config set](anbox-cloud-appliance_config_set.md) - Set specific configuration items for the Anbox Cloud Appliance +* [anbox-cloud-appliance config show](anbox-cloud-appliance_config_show.md) - Show the configuration of the Anbox Cloud Appliance + +###### Auto generated by spf13/cobra on 8-Oct-2024 diff --git a/reference/cmd-ref/appliance/anbox-cloud-appliance_config_set.md b/reference/cmd-ref/appliance/anbox-cloud-appliance_config_set.md new file mode 100644 index 00000000..a1434c05 --- /dev/null +++ b/reference/cmd-ref/appliance/anbox-cloud-appliance_config_set.md @@ -0,0 +1,49 @@ +## anbox-cloud-appliance config set + +Set specific configuration items for the Anbox Cloud Appliance + +### Synopsis + +Set configuration items for the Anbox Cloud Appliance + +This command allows changing the following configuration items: + +* network.public_address (IP address) +* network.location (DNS name) +* core.https_allowed_origin (HTTP origin, see https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Origin) +* core.https_allowed_headers (comma seprated list of allowed HTTP headers) +* core.https_allowed_methods (comma separate list of allowed HTTP methods) + +Multiple confiugration items can be set in a single call, e.g. + + $ sudo anbox-cloud-appliance config set \ + network.public-address=5.6.7.8 network.location=foo.bar + +Changes made are immediately effective and will require a restart +of all services the Anbox Cloud Appliance includes. Once the +configuration has been updated the command will restart all services +unless the --no-restart option is set. + + +``` +anbox-cloud-appliance config set [flags] +``` + +### Examples + +``` +$ sudo anbox-cloud-appliance config set network.public-address=1.2.3.4 +``` + +### Options + +``` + -h, --help help for set + --no-restart Do not restart the Anbox Cloud Appliance +``` + +### SEE ALSO + +* [anbox-cloud-appliance config](anbox-cloud-appliance_config.md) - Managed the Anbox Cloud Appliance configuration + +###### Auto generated by spf13/cobra on 8-Oct-2024 diff --git a/reference/cmd-ref/appliance/anbox-cloud-appliance_config_show.md b/reference/cmd-ref/appliance/anbox-cloud-appliance_config_show.md new file mode 100644 index 00000000..77da28b5 --- /dev/null +++ b/reference/cmd-ref/appliance/anbox-cloud-appliance_config_show.md @@ -0,0 +1,25 @@ +## anbox-cloud-appliance config show + +Show the configuration of the Anbox Cloud Appliance + +``` +anbox-cloud-appliance config show [flags] +``` + +### Examples + +``` +$ sudo anbox-cloud-appliance config show +``` + +### Options + +``` + -h, --help help for show +``` + +### SEE ALSO + +* [anbox-cloud-appliance config](anbox-cloud-appliance_config.md) - Managed the Anbox Cloud Appliance configuration + +###### Auto generated by spf13/cobra on 8-Oct-2024 diff --git a/reference/cmd-ref/appliance/anbox-cloud-appliance_daemon.md b/reference/cmd-ref/appliance/anbox-cloud-appliance_daemon.md new file mode 100644 index 00000000..164576c6 --- /dev/null +++ b/reference/cmd-ref/appliance/anbox-cloud-appliance_daemon.md @@ -0,0 +1,26 @@ +## anbox-cloud-appliance daemon + +Run the Anbox Cloud Appliance daemon + +``` +anbox-cloud-appliance daemon [flags] +``` + +### Examples + +``` +$ anbox-cloud-appliance daemon +``` + +### Options + +``` + --config string Path to the daemon configuration file + -h, --help help for daemon +``` + +### SEE ALSO + +* [anbox-cloud-appliance](anbox-cloud-appliance.md) - Anbox Cloud Appliance, bringing Android at scale to any cloud + +###### Auto generated by spf13/cobra on 8-Oct-2024 diff --git a/reference/cmd-ref/appliance/anbox-cloud-appliance_dashboard.md b/reference/cmd-ref/appliance/anbox-cloud-appliance_dashboard.md new file mode 100644 index 00000000..873cfaa3 --- /dev/null +++ b/reference/cmd-ref/appliance/anbox-cloud-appliance_dashboard.md @@ -0,0 +1,23 @@ +## anbox-cloud-appliance dashboard + +Manage the dashboard of the Anbox Cloud Appliance + +### Synopsis + +Manage the dashboard of the Anbox Cloud Appliance + +Provides subcommands used to manage the dasboard of the Anbox Cloud Appliance. +This includes management of users allowed to access the dashboard. + +### Options + +``` + -h, --help help for dashboard +``` + +### SEE ALSO + +* [anbox-cloud-appliance](anbox-cloud-appliance.md) - Anbox Cloud Appliance, bringing Android at scale to any cloud +* [anbox-cloud-appliance dashboard register](anbox-cloud-appliance_dashboard_register.md) - Register a new user for access to the Anbox Cloud dashboard + +###### Auto generated by spf13/cobra on 8-Oct-2024 diff --git a/reference/cmd-ref/appliance/anbox-cloud-appliance_dashboard_register.md b/reference/cmd-ref/appliance/anbox-cloud-appliance_dashboard_register.md new file mode 100644 index 00000000..772bc5f6 --- /dev/null +++ b/reference/cmd-ref/appliance/anbox-cloud-appliance_dashboard_register.md @@ -0,0 +1,52 @@ +## anbox-cloud-appliance dashboard register + +Register a new user for access to the Anbox Cloud dashboard + +### Synopsis + +Register a new user for access to the Anbox Cloud dashboard + +Access to the Anbox Cloud dashboard requires authentication. Authentication +on the dashboard is implemented via single-sign on (SSO). + +Currently the only supported SSO provider is Ubuntu (https://login.ubuntu.com/). + +To register a new user for access to the dashboard you need their email address +they have configured as the primary email address of their Ubuntu SSO account. +With that you can run the following command to generate a registration URL: + +$ sudo anbox-cloud-appliance dashboard register foo@bar.com +Visit https://10.2.9.2/?register=xxx to finish your registration + +The registration link will by default expire after one hour. + +If you run the command on a non-interactive shell only the URL will +be printed as output. This allows you to do + +$ url=$(sudo anbox-cloud-appliance dashboard register foo@bar.com) +$ echo "$url" +https://10.2.9.2/?register=xxx + + +``` +anbox-cloud-appliance dashboard register [flags] +``` + +### Examples + +``` +$ anbox-cloud-appliance dashboard register foo@bar.com +``` + +### Options + +``` + -h, --help help for register + -e, --validity string Time for which the registration URL will be valid (valid time units are 'm' (minutes) or 'h' (hours)) (default "1h") +``` + +### SEE ALSO + +* [anbox-cloud-appliance dashboard](anbox-cloud-appliance_dashboard.md) - Manage the dashboard of the Anbox Cloud Appliance + +###### Auto generated by spf13/cobra on 8-Oct-2024 diff --git a/reference/cmd-ref/appliance/anbox-cloud-appliance_init.md b/reference/cmd-ref/appliance/anbox-cloud-appliance_init.md new file mode 100644 index 00000000..12d68ee9 --- /dev/null +++ b/reference/cmd-ref/appliance/anbox-cloud-appliance_init.md @@ -0,0 +1,28 @@ +## anbox-cloud-appliance init + +Initialize and configure the Anbox Cloud Appliance + +``` +anbox-cloud-appliance init [flags] +``` + +### Examples + +``` +$ anbox-cloud-appliance init +``` + +### Options + +``` + --auto Automatic (non-interactive) mode + --force Force run, even if already initialized + -h, --help help for init + --preseed Pre-seed mode, expects YAML config from stdin +``` + +### SEE ALSO + +* [anbox-cloud-appliance](anbox-cloud-appliance.md) - Anbox Cloud Appliance, bringing Android at scale to any cloud + +###### Auto generated by spf13/cobra on 8-Oct-2024 diff --git a/reference/cmd-ref/appliance/anbox-cloud-appliance_prepare-node-script.md b/reference/cmd-ref/appliance/anbox-cloud-appliance_prepare-node-script.md new file mode 100644 index 00000000..9070e42c --- /dev/null +++ b/reference/cmd-ref/appliance/anbox-cloud-appliance_prepare-node-script.md @@ -0,0 +1,49 @@ +## anbox-cloud-appliance prepare-node-script + +Generate a shell script to prepare a machine for the Anbox Cloud Appliance + +### Synopsis + +Generate a shell script to prepare a machine for the Anbox Cloud Appliance + +The command generates a shell script which needs to be executed outside +of the snap execution environment to install additional dependency and +adjust system configuration. + +Please carefully review the script before execution! It will install +additional kernel modules and GPU drivers and apply configuration +changes to tune these for Anbox Cloud. + +You can show the script by running + + $ anbox-cloud-appliance prepare-node-script + +and directly execute it after reviewing the content by + + $ anbox-cloud-appliance prepare-node-script | sudo bash -ex + +Once the script has finished all preparation is completed. + + +``` +anbox-cloud-appliance prepare-node-script [flags] +``` + +### Examples + +``` +$ anbox-cloud-appliance prepare-node-script +``` + +### Options + +``` + --force-nvidia Force including NVIDIA GPU driver installation steps even if no GPU is detected + -h, --help help for prepare-node-script +``` + +### SEE ALSO + +* [anbox-cloud-appliance](anbox-cloud-appliance.md) - Anbox Cloud Appliance, bringing Android at scale to any cloud + +###### Auto generated by spf13/cobra on 8-Oct-2024 diff --git a/reference/cmd-ref/appliance/anbox-cloud-appliance_status.md b/reference/cmd-ref/appliance/anbox-cloud-appliance_status.md new file mode 100644 index 00000000..ca10176a --- /dev/null +++ b/reference/cmd-ref/appliance/anbox-cloud-appliance_status.md @@ -0,0 +1,20 @@ +## anbox-cloud-appliance status + +Retrieves the current status of the Anbox Cloud Appliance + +``` +anbox-cloud-appliance status [flags] +``` + +### Options + +``` + --format string Output format (yaml|json) (default "yaml") (default "yaml") + -h, --help help for status +``` + +### SEE ALSO + +* [anbox-cloud-appliance](anbox-cloud-appliance.md) - Anbox Cloud Appliance, bringing Android at scale to any cloud + +###### Auto generated by spf13/cobra on 8-Oct-2024