diff --git a/.github/workflows/generate-command-reference.yml b/.github/workflows/generate-command-reference.yml index d2493b7c..f0db9377 100644 --- a/.github/workflows/generate-command-reference.yml +++ b/.github/workflows/generate-command-reference.yml @@ -3,6 +3,9 @@ on: push: workflow_dispatch: +env: + AMC_COMMAND_REFERENCE_DIR: "./reference/cmd-ref/amc-command-reference" + jobs: run-tests: runs-on: ubuntu-24.04 @@ -13,12 +16,14 @@ jobs: ubuntu-pro-token: ${{ secrets.UBUNTU_PRO_TOKEN }} - name: Checkout repo uses: actions/checkout@v4 + - name: Delete existing files + run: rm -rf $AMC_COMMAND_REFERENCE_DIR/* - name: Generate AMC command reference documentation - run: amc generate documentation -f markdown -d ./reference/cmd-ref/amc-command-reference + run: amc generate documentation -f markdown -d $AMC_COMMAND_REFERENCE_DIR - name: Commit changes if: ${{ github.ref == 'refs/heads/main' }} uses: EndBug/add-and-commit@v9 with: default_author: github_actions message: 'Generate AMC command reference documentation' - add: './reference/cmd-ref/amc-command-reference' + add: '$AMC_COMMAND_REFERENCE_DIR' diff --git a/reference/cmd-ref/amc-command-reference/.keep b/reference/cmd-ref/amc-command-reference/.keep new file mode 100644 index 00000000..e69de29b diff --git a/reference/cmd-ref/amc-command-reference/addon.md b/reference/cmd-ref/amc-command-reference/addon.md deleted file mode 100644 index 89935cca..00000000 --- a/reference/cmd-ref/amc-command-reference/addon.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -orphan: true ---- -# `addon` - -The `addon` command allows you to manage addons that are necessary for customising images. - - amc addon - -## Subcommands - -The following subcommands are available: - -### `add` - -Create an addon from the contents of the provided directory, tarball or zip archive. See {ref}`howto-create-addons` or {ref}`tut-create-addon` for more information. - - amc addon add ( | | ) --timeout=3m - -where `-t` or --`timeout` is a string value to denote the maximum wait time for the operation to complete. The default is `5m`. - -### `delete` - -Delete the specified addon. - - amc addon delete [options] - -The following options are available: - -|Option|Description| -|------|-----------| -|`-h`, `--help`| Display help information for the command. | -|`-t`, `--timeout`| String value to denote the maximum wait time for the operation to complete. The default is `5m`. | -|`-v`, `--version`| Indicates the version of the application for which the addon needs to be deleted. If a version is not mentioned, the addon is deleted for all versions of an application. | -|`-y`, `--yes`| Option for non interactive deletion, assuming 'yes' as an answer to all prompt. | - -### `list` - -List available addons along with its application details. - - amc addon list --format=(table | json |csv) - -where `--format` option controls the output format which can be in the form of a table, JSON or CSV. The default value is `table`. - -### `show` - -Display information about a specific addon, including its size and created timestamp. - - amc addon show --format=(json | yaml) - -where `--format` option controls the output format which can be either JSON or YAML. The default value is `yaml`. - -### `update` - -Update an existing addon - - amc addon update --timeout=3m - -where `-t` or `--timeout` is a string value to denote the maximum wait time for the operation to complete. The default is `5m`. diff --git a/reference/cmd-ref/amc-command-reference/application.md b/reference/cmd-ref/amc-command-reference/application.md deleted file mode 100644 index 68909b08..00000000 --- a/reference/cmd-ref/amc-command-reference/application.md +++ /dev/null @@ -1,137 +0,0 @@ ---- -orphan: true ---- -# `application` - -The `application` command allows you to manage applications using the Anbox Management Client (AMC). - - amc application - -You can also use the alias `app` instead of `application`. - -## Subcommands - -The following subcommands are available: - -### `create` - -Create an application from the contents of the directory, tarball or zip archive. - - amc application create ( | | ) [options] - -The following options are available: - -|Option|Description| -|------|-----------| -|`-h`, `--help`| Display help information for the command. | -|`-t`, `--timeout`| String value to denote the maximum wait time for the operation to complete. The default is `5m`. | -|`--vm`| Create an application using virtual machines instead of containers. | - -### `delete` - -Delete the specified application. - - amc application delete [options] - -The following options are available: - -|Option|Description| -|------|-----------| -|`-a`, `--all`| Delete all existing applications. | -|`-f`, `--force`| Force deletes of the application even if it is immutable. Applications downloaded from the registry cannot be deleted unless this flag is used. | -|`-h`, `--help`| Displays help information for the `delete` command. | -|`--no-wait`| Indicates not to wait for the delete operation to finish. | -| `-t`, `--timeout`| String value that denotes the maximum wait time for the operation to complete. The default is `5m`. | -| `-v`, `--version`| Displays the version of the application that needs to be deleted. If a version is not mentioned, the addon is deleted for all versions of an application. | -|`-y`, `--yes`| Option for non interactive deletion, assuming 'yes' as an answer to all prompt. | - -### `list` - -List all available applications. You can apply filters to see a specific list of applications. - - amc application list [options] - -You can use the alias `ls` instead of `list`. - -The following options are available: - -|Option|Description| -|------|-----------| -|`-f`, `--filter` | Filters the output based on specified attributes. The attributes can be one of these:
* `instance-type=(comma-separated list)`
* `addons=(comma-separated list)`
* `tags=(comma-separated list)`
* `published=(true/false)`
* `immutable=(true/false)`
* `status=(string)`
* `vm=(true/false)`| -|`--format`| String value that controls the output format which can either be in a table form, JSON, YAML or CSV. The default value is `table`. | -|`-h`, `--help`| Displays help information for the `list` command. | - -### `publish` - -Publish a version of the application. When an application is launched, AMS always uses the published version of the application unless otherwise mentioned. - - amc application publish --timeout=3m - -where `-t` or --`timeout` is a string value to denote the maximum wait time for the operation to complete. The default is `5m`. - -### `revoke` - -Revoke a published application version. - - amc application revoke --timeout=3m - -where `-t` or --`timeout` is a string value to denote the maximum wait time for the operation to complete. The default is `5m`. - -### `set` - -Update specific attributes of an application's manifest without creating a new version of the application. - - amc application set - -You can update the following fields: - -* `image` -* `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` - -### `show` - -Display information about an application and its versions. - - amc application show --format=json - -where `--format` controls the output formatting. The values for `--format` can be `json` or `yaml`. The output displays in YAML format by default if a format is not specified. - -### `unset` - -Reset an attribute of an application's manifest to its default value. - - amc application unset - -You can reset the following attributes: - -* `tags` -* `addons` -* `features` - -For resetting any other attribute, use the `amc application set` command and specify the attribute value. - -### `update` - -Update an existing application. Updating an application creates a new version. - - amc application update --timeout=10m - -where `-t` or --`timeout` is a string value to denote the maximum wait time for the operation to complete. The default is `5m`. - -If you don't provide a package for the update, AMS checks all possible updates by verifying the application against newer images and addons and applies pending changes as necessary. - -If you prefer specific updates to your application, use the `amc application set` command instead as it allows you to update specific fields of the application without updating the application. diff --git a/reference/cmd-ref/amc-command-reference/benchmark.md b/reference/cmd-ref/amc-command-reference/benchmark.md deleted file mode 100644 index c1424dc8..00000000 --- a/reference/cmd-ref/amc-command-reference/benchmark.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -orphan: true ---- -# `benchmark` - -The `benchmark` command allows you to benchmark your Anbox Cloud deployment. Benchmarking your deployment helps in evaluating the performance of Anbox Cloud for a well-defined workload. - - amc benchmark ( | ) [options] - -Define the workload with the following options: - -|Option|Input type|Description| Default value| -|------|-----------|-----------|-------------| -|`-d`, `--dump-data` | | Dump data collected during the benchmark, the file name containing the data is printed | | -| `-c`, `--force` | | Force remove instances | | -| `-f`, `--fps` | | Measure Frames Per Second (FPS) for all instances | | -| `--fps-threshold` | Integer | FPS threshold below which an instance will be considered slow | 30 | -| `-h`, `--help` | | Displays help information for `amc benchmark` command| | -| `-s`, `--instances-per-second` | Float | Number of instances to launch per second | 0.1 | -| `--measure-time` | String | Time spent measuring instance statistics| 1 minute | -| `--network-address` | String | Outbound network address on which the instances can reach the benchmark executor. For example: 127.0.0.1 | | -| `-n`, `--num-instances` | Integer | Number of instances to launch | 1 | -| `-p`, `--platform` | String | Anbox platform to use for the instances | `null` | -| `-r`, `--raw` | | If specified, the instance is created for the specified image instead of an application | | -|`--settle-time` | String | Settling time allowed for the instance performance measurement starts | 30 seconds | -| `--userdata` | String | Additional user data to be sent to the created instance | | - diff --git a/reference/cmd-ref/amc-command-reference/completion.md b/reference/cmd-ref/amc-command-reference/completion.md deleted file mode 100644 index 05338081..00000000 --- a/reference/cmd-ref/amc-command-reference/completion.md +++ /dev/null @@ -1,91 +0,0 @@ ---- -orphan: true ---- -# `completion` - -The `completion` command allows you to generate the auto completion script for the specified shell. - - amc completion - -## Subcommands - -The following subcommands are available: - -### `bash` - -Generate the auto completion script for `bash`. This script depends on and requires the `bash-completion` package to be installed. - - amc completion bash --no-descriptions - -where `--no-descriptions` disables completion descriptions. - -To load completions in your current shell session, use: - - source <(amc completion bash) - -To load completions for every new session, execute the following once and start a new shell for the setup to take effect: - -For Linux, - - amc completion bash > /etc/bash_completion.d/amc - -For macOS, - - amc completion bash > $(brew --prefix)/etc/bash_completion.d/amc - -### `fish` - -Generate the auto completion script for `fish`. - - amc completion fish --no-descriptions - -where `--no-descriptions` disables completion descriptions. - -To load completions in your current shell session, use: - - amc completion fish | source - -To load completions for every new session, execute the following once and start a new shell for the set to take effect: - - amc completion fish > ~/.config/fish/completions/amc.fish - -### `powershell` - -Generate the auto completion script for `powershell`. - - amc completion powershell --no-descriptions - -where `--no-descriptions` disables completion descriptions. - -To load completions in your current shell session, use: - - 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. - -### `zsh` - -Generate the auto completion script for `zsh`. - - amc completion zsh --no-descriptions - -where `--no-descriptions` disables completion descriptions. - -If shell completion is not already enabled in your environment, enable it by running the following command: - - echo "autoload -U compinit; compinit" >> ~/.zshrc - -To load completions in your current shell session: - - source <(amc completion zsh) - -To load completions for every new session, execute the following once and start a new shell for the setup to take effect: - -For Linux, - - amc completion zsh > "${fpath[1]}/_amc" - -For macOS, - - amc completion zsh > $(brew --prefix)/share/zsh/site-functions/_amc diff --git a/reference/cmd-ref/amc-command-reference/config.md b/reference/cmd-ref/amc-command-reference/config.md deleted file mode 100644 index 9569b2c8..00000000 --- a/reference/cmd-ref/amc-command-reference/config.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -orphan: true ---- -# `config` - -The `config` command helps manage the global configuration for the Anbox Management Service (AMS). See {ref}`ref-ams-configuration` for a list of -available configuration items. - - amc config - -## Subcommands - -The following subcommands are available: - -### `set` - -Update a single configuration of the AMS. - - amc config set - -### `show` - -Display all configuration of the AMS. - - amc config show - -### `trust` - -Manage trusted clients that can communicate with AMS. You can add or remove client certificates as needed to allow or block communication with AMS. - -The `amc config trust` command can be used with three subcommands - `add`, `list` and `remove`. - -The `add` command adds a new trusted client that can communicate with the AMS: - - amc config trust add - -The `list` command displays a list of trusted clients: - - amc config trust list --format=table - -where `--format` controls the output formatting. `table`, `json` and `yaml` are allowed values while `table` is the default value. - -The `remove` command removes a client from the list of trusted clients. You can also use `rm` as an alias. - - amc config trust remove - diff --git a/reference/cmd-ref/amc-command-reference/delete.md b/reference/cmd-ref/amc-command-reference/delete.md deleted file mode 100644 index 3d7ccd1c..00000000 --- a/reference/cmd-ref/amc-command-reference/delete.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -orphan: true ---- -# `delete` - -The `delete` command deletes an instance. - - amc delete [options] - -The following options are available: - -| Option | Description | -|--------|-------------| -|`-a`, `-all`| Deletes all existing instances | -|`-f`, `--force` | Forcibly removes an instance | -|`-h`, `--help` | Displays help information for the command | -|`--no-wait` | Indicates not to wait for the delete operation to finish | -|`-n`, `--node` | This option only works when used in combination with `--all` and can be used to select only instances for the specified node. Input type: String | -|`-t`, `--timeout` | Indicates the maximum time to wait for the operation to complete. The default value is `5m` | -|`-y`, `--yes` | Runs non interactively assuming `yes` for all prompts | diff --git a/reference/cmd-ref/amc-command-reference/exec.md b/reference/cmd-ref/amc-command-reference/exec.md deleted file mode 100644 index 7ed67ce3..00000000 --- a/reference/cmd-ref/amc-command-reference/exec.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -orphan: true ---- -# `exec` - -The `exec` command executes commands directly inside an instance without a shell environment. - - amc exec -- [options] - -To use flags in your command, you must isolate the command with the '--' separator. Use `-T`, `--force-noninteractive` to disable pseudo-terminal allocation. - -Remember that shell patterns will not be recognised. If you need a shell environment, execute the shell command and pass the command as an argument. For example: `amc exec -- sh -c "cd /tmp && pwd`. diff --git a/reference/cmd-ref/amc-command-reference/help.md b/reference/cmd-ref/amc-command-reference/help.md deleted file mode 100644 index c8118aa5..00000000 --- a/reference/cmd-ref/amc-command-reference/help.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -orphan: true ---- -# `help` - -The `help` command displays detailed information about the `amc` tool. - - amc help - -You can also use the `-h` or `--help` option on any command to read its command line help. diff --git a/reference/cmd-ref/amc-command-reference/image.md b/reference/cmd-ref/amc-command-reference/image.md deleted file mode 100644 index e25c666c..00000000 --- a/reference/cmd-ref/amc-command-reference/image.md +++ /dev/null @@ -1,91 +0,0 @@ ---- -orphan: true ---- -# `image` - -The `image` command manages images that contain everything necessary to properly run an Android application in an instance. - -Images can be provided manually or via an image server. You can add, update or -delete them from AMS. See {ref}`ref-provided-images` and -{ref}`howto-manage-images` for more information. - - amc image - -## Subcommands - -The following subcommands are available: - -### `add` - -Add an image. The first image that you add is marked as the default image. This default image is used when creating an application or launching a raw container without specifying an image. To set any image added after the first image as the default, add the '--default' flag. - - amc image add [options] - -The following options are available: - -|Option|Description| -|------|-----------| -| `-d`, `--default` | Marks the specified image as the default image | -| `-h`, `--help` | Displays help information for the command | -| `-t`, `--timeout` | String value that indicates the maximum time to wait for the operation to complete. The default value is `5m`. | -| `--type` | String value that denotes the type of image to import. Use only when a remote image is added. Valid values for this option are `any`, `container`, `vm`. `any` is the default value. | - -### `delete` - -Delete an image. When an image is deleted, all of its versions are removed unless otherwise specified. - - amc image delete [options] - -The following options are available: - -|Option|Description| -|------|-----------| -| `-f`, `--force` | Forcibly deletes immutable images | -| `-h`, `--help` | Displays help information for the command | -| `-t`, `--timeout` | String value that indicates the maximum time to wait for the operation to complete. The default value is `5m`. | -| `-v`, `--version` | Integer that indicates the version of the image to delete | -| `-y`, `--yes` | Runs non interactively assuming `yes` for all prompts | - -### `list` - -List all available images. - - amc image list --format=json - -where `--format` controls the output formatting. Valid values are `table`, `json` or `csv` and the default value is `table`. - -You can use the alias `ls` instead of `list`. - -### `show` - -Display information about an image - - amc image show --format=json - -where `--format` controls the output formatting. The values for `--format` can be `json` or `yaml`. The output displays in YAML format by default if a format is not specified. - -### `switch` - -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 instance. - - amc image switch - -### `sync` - -Synchronises the image with the remote image server. If the image is used from a remote image server, this command triggers explicit sync with the remote server and the image is downloaded to the cluster from the remote server. - - amc image sync - -### `update` - -Update an existing image. This command replaces the specified image with the new image and bumps its version number. - - amc image update - -The following options are available: - -|Option|Description| -|------|-----------| -|`-d`, `--default` | Marks the image as the default image | -| `-h`, `--help` | Displays help information for the command | -|`-t`, `--timeout` | String value that indicates the maximum time to wait for the operation to complete. The default value is `5m`. | diff --git a/reference/cmd-ref/amc-command-reference/info.md b/reference/cmd-ref/amc-command-reference/info.md deleted file mode 100644 index d982406f..00000000 --- a/reference/cmd-ref/amc-command-reference/info.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -orphan: true ---- -# `info` - -The `info` command displays general information about the connected AMS service. - - amc info --format=json - -where `--format` controls the output formatting. Valid values for this flag are `json` or `yaml` and `yaml` is the default value. diff --git a/reference/cmd-ref/amc-command-reference/init.md b/reference/cmd-ref/amc-command-reference/init.md deleted file mode 100644 index c819e588..00000000 --- a/reference/cmd-ref/amc-command-reference/init.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -orphan: true ---- -# `init` - -The `init` command creates an instance but does not start it immediately. - - amc init [options] - -The following options are available: - -| Option | Input type | Description | Default value | -|------|--------------|-------------|---------------| -| `-a`, `--addons` | String | Comma-separated list of addons to install in the instance. Applicable for raw instances only. | | -| `-c`, `--cpus` | Integer | Number of CPU cores to be assigned for the instance. | 2 | -| `--devmode` | | Enables developer mode for the instance. | Disabled | -| `--disable-watchdog` | | Disables watchdog for the instance. Applicable for regular instances only. | | -| `-d`, `--disk-size` | String | Disk size of the instance. | 3 GB for a container instance;
15 GB for a virtual machine instance | -| `--enable-graphics` | | Enables graphics for the instance | Disabled | -| `-f`, `--features` | String | Comma-separated list of features to enable for the Anbox runtime inside the instance | | -| `-g`, `--gpu-slots` | Integer | Number of GPU slots to be assigned for the instance. | -1 | -| `-h`, `--help` | | Displays help information for the command | | -| `-m`, `--memory` | String | Memory to be assigned for the instance | 3GB | -| `--metrics-server` | String | Metrics server to which the instance sends its data | -| `--no-wait` | | Indicates not to wait for the instance to start | Disabled | -| `-n`, `--node` | String | Indicates the LXD node to use for creating the instance | | -| `-p`, `--platform` | String | Indicates the Anbox platform to use | `null` platform | -| `-r`, `--raw` | | Creates a raw instance for the specified image instead of an application instance | | -| `-s`, `--service` | String array | Services to expose on the instance's IP endpoint for external access (public or private) | | -| `--tags` | String | Comma-separated list of tags to set for the instance | | -| `-t`, `--timeout` | | String value that indicates the maximum time to wait for the operation to complete. The default value is `5m`. | -| `--userdata` | String | Additional user data to be sent to the created instance | | -| `--userdata-path` | String | Path to a file with additional user data to be sent to the created instance | -| `--version` | Integer | Indicates the specific version of an application or image to use when creating an instance | -1 | -| `--vm` | | Creates a virtual machine instead of a container | Disabled | -| `-v`, `--vpu-slots` | Integer | Indicates the number of VPU slots to be assigned for the instance. | -1 | diff --git a/reference/cmd-ref/amc-command-reference/landing.md b/reference/cmd-ref/amc-command-reference/landing.md deleted file mode 100644 index 0938694b..00000000 --- a/reference/cmd-ref/amc-command-reference/landing.md +++ /dev/null @@ -1,40 +0,0 @@ -(ref-amc-commands)= -# AMC command reference - -The Anbox Management Client (AMC) is a command line utility offered by Anbox Cloud that interacts with the Anbox Management Service (AMS). - -Use `amc --help` or `amc --help` to display usage information for the tool and its commands. The following commands are available for use with `amc`: - -| Command | Description| -|---------|------------| -|[`addon`](addon.md) | Manage addons | -|[`application`](application.md) | Manage applications | -|[`benchmark`](benchmark.md) | Benchmark your Anbox Cloud deployment | -|[`completion`](completion.md) | Generate the auto completion script for the specified shell | -|[`config`](config.md) | Manage AMS configuration | -|[`delete`](delete.md) | Delete an instance | -|[`exec`](exec.md) | Execute a command inside an instance | -|[`help`](help.md) | Help for a command | -|[`image`](image.md) | Manage images | -|[`info`](info.md) | Provide information about connected AMS service | -|[`init`](init.md) | Initialise an instance | -|[`launch`](launch.md) | Launch an instance | -|[`list`](list.md) | List instances | -|[`logs`](logs.md) | View runtime logs of an instance | -|[`node`](node.md) | Manage nodes | -|[`remote`](remote.md) | Interact with remote AMS daemons | -|[`shell`](shell.md) | Open a shell inside a running instance | -|[`show`](show.md) | Display information about an instance | -|[`show-log`](show-log.md) | Display a particular instance's log file | -|[`start`](start.md) | Start an existing instance | -|[`stop`](stop.md) | Stop a running instance | -|[`wait`](wait.md) | Wait for an instance to reach a specific condition | - -## Options - -You can use the following options or flags with the `amc` utility: - -| Option | Description | -|--------|-------------| -|`-h`, `--help` | Display help for the `amc` utility | -|`-v`, `--version` | Display version of the AMS | diff --git a/reference/cmd-ref/amc-command-reference/launch.md b/reference/cmd-ref/amc-command-reference/launch.md deleted file mode 100644 index f921df18..00000000 --- a/reference/cmd-ref/amc-command-reference/launch.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -orphan: true ---- -# `launch` - -The `launch` command launches an instance. - - amc launch [options] - -The following options are available: - -| Option | Input type | Description | Default value | -|------|--------------|-------------|---------------| -| `-a`, `--addons` | String | Comma-separated list of addons to install in the instance. Applicable for raw instances only. | | -| `-c`, `--cpus` | Integer | Number of CPU cores to be assigned for the instance. | 2 | -| `--devmode` | | Enables developer mode for the instance. | Disabled | -| `--disable-watchdog` | | Disables watchdog for the instance. Applicable for regular instances only. | | -| `-d`, `--disk-size` | String | Disk size of the instance. | 3 GB for a container instance;
15 GB for a virtual machine instance | -| `--enable-graphics` | | Enables graphics for the instance | Disabled | -| `-f`, `--features` | String | Comma-separated list of features to enable for the Anbox runtime inside the instance | | -| `-g`, `--gpu-slots` | Integer | Number of GPU slots to be assigned for the instance. | -1 | -| `-h`, `--help` | | Displays help information for the command | | -| `-m`, `--memory` | String | Memory to be assigned for the instance | 3GB | -| `--metrics-server` | String | Metrics server to which the instance sends its data | -| `--no-wait` | | Indicates not to wait for the instance to start | Disabled | -| `-n`, `--node` | String | Indicates the LXD node to use for creating the instance | | -| `-p`, `--platform` | String | Indicates the Anbox platform to use | `null` platform | -| `-r`, `--raw` | | Creates a raw instance for the specified image instead of an application instance | | -| `-s`, `--service` | String array | Services to expose on the instance's IP endpoint for external access (public or private) | | -| `--tags` | String | Comma-separated list of tags to set for the instance | | -| `-t`, `--timeout` | | String value that indicates the maximum time to wait for the operation to complete. The default value is `5m`. | -| `--userdata` | String | Additional user data to be sent to the created instance | | -| `--userdata-path` | String | Path to a file with additional user data to be sent to the created instance | -| `--version` | Integer | Indicates the specific version of an application or image to use when creating an instance | -1 | -| `--vm` | | Creates a virtual machine instead of a container | Disabled | -| `-v`, `--vpu-slots` | Integer | Indicates the number of VPU slots to be assigned for the instance. | -1 | diff --git a/reference/cmd-ref/amc-command-reference/list.md b/reference/cmd-ref/amc-command-reference/list.md deleted file mode 100644 index 17116b2d..00000000 --- a/reference/cmd-ref/amc-command-reference/list.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -orphan: true ---- -# `list` - -The `list` command lists all the instances. - - amc list [options] - -You can also use `ls` as an alias. - -The following options are available: - -| Options | Description | -|---------|-------------| -|`-f`, `--filter`| Filters the output based on specified conditions | -| `--format` | Controls output formatting. The output format can be `table`, `json` or `csv` and the default value is `table` | -| `-h`, `--help` | Displays help information for the command | - -Usage for `--filter`: - - amc list --filter attribute=value - -where `attribute` can be one of the following: - -| Name | Argument type | -|--------|----------------------------------------| -| `app` | string (application name) | -| `status` | string (prepared, started, error, etc) | -| `node` | string | -| `type` | string (regular/base) | -| `tags` | comma-separated list | -| `vm` | boolean (true/false) | diff --git a/reference/cmd-ref/amc-command-reference/logs.md b/reference/cmd-ref/amc-command-reference/logs.md deleted file mode 100644 index 34e144c7..00000000 --- a/reference/cmd-ref/amc-command-reference/logs.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -orphan: true ---- -# `logs` - -The `logs` command shows runtime logs of an instance. You can display system-level logs of the instance or the nested Android container. - - amc logs [options] - -The following options are available: - -| Option | Description | -|--------|-------------| -|`-f`, `--follow` | Shows only the most recent log entries and continuously prints new entries as they are appended to the log | -| `-h`, `--help` | Displays help information for the command | -| `-t`, `--type` | Type of logs to show: `anbox` or `android`. The default is `anbox`. | diff --git a/reference/cmd-ref/amc-command-reference/node.md b/reference/cmd-ref/amc-command-reference/node.md deleted file mode 100644 index fe1191d3..00000000 --- a/reference/cmd-ref/amc-command-reference/node.md +++ /dev/null @@ -1,106 +0,0 @@ ---- -orphan: true ---- -# `node` - -The `node` command manage LXD nodes of the deployment that run instances with Anbox Cloud and are managed by the Anbox Management Service (AMS). See {ref}`exp-clustering` for more information. - - amc node - -## Subcommands - -The following subcommands are available: - -### `add` - -Add a node to AMS. You can also use the alias `new`. - - amc node add [options] - -There are a few prerequisites for the adding a node: - -* The new node must have an accessible IP address. -* LXD must be installed on the node before adding it but not initialised because AMS takes care of the initialisation and configuration of the node. - -The following options are available: - -| Option | Input type | Description | -|--------|------------|-------------| -|`-h`, `--help` | | Displays help information for the command | -| `--network`| String | Name of the network device to create on the LXD cluster. The default value is `amsbr0` | -| `--network-bridge-mtu` | Integer | Maximum Transmission Unit 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` | | Indicates that the node is already clustered | - - -### `list` - -List available nodes. You can also use `ls` as an alias. - - amc node list [options] - -The following options are available: - -| Options | Description | -|---------|-------------| -|`-f`, `--filter`| Filters the output based on specified conditions | -| `--format` | Controls output formatting. The output format can be `table`, `json` or `csv` and the default value is `table` | -| `-h`, `--help` | Displays help information for the command | - -Usage for `--filter`: - - amc node list --filter attribute=value - -where `attribute` can be one of the following: - -| Name | Argument type | -|---------------|-------------------------------| -| master | Boolean (true/false) | -| status | string (online, offline etc.) | - - -### `remove` - -Removes a node from the Anbox Cloud cluster thereby making it unable to host instances. - -```{note} -You cannot delete a node with running instances unless you use the `--force` flag. -``` - - amc node remove [options] - -The following options are available: - -| Options | Description | -|---------|-------------| -| `-f`, `--force` | Forcibly removes the node | -| `-h`, `--help` | Displays help information for the command | -| `--keep-in-cluster` | Removes the LXD node from the AMS database but keeps it as part of the cluster | -| `-y`, `--yes` | Run non interactively by assuming 'yes' for all prompts | - - -### `set` - -Set specific configuration for a node. See {ref}`ref-ams-configuration` for a list of available configuration items. - - amc node set [options] --timeout=10m - -where `-t` or --`timeout` is a string value to indicate the maximum wait time for the operation to complete. The default value is `5m`. - -### `show` - -Display information about a node. - - amc node show [options] - -The following options are available: - -| Option | Description | -|--------|-------------| -| `--allocations` | Shows resource allocations | -|`-f`, `--format` | Controls output formatting with values `json` or `yaml`. The default value is `yaml`. | -| `-h`, `--help` | Displays help information for the command | diff --git a/reference/cmd-ref/amc-command-reference/remote.md b/reference/cmd-ref/amc-command-reference/remote.md deleted file mode 100644 index de6e13dd..00000000 --- a/reference/cmd-ref/amc-command-reference/remote.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -orphan: true ---- -# `remote` - -The `remote` command allows interacting with remote Anbox Management Service (AMS) daemons. See {ref}`howto-access-ams-remote` for more information. - - amc remote - -## Subcommands - -The following subcommands are available: - -### `add` - -Add a remote AMS daemon. Note that if you set up a trust password on the daemon, provide the password when running the command. - - amc remote add [trust_password] --accept-certificate - -where `--accept-certificate` is to implicitly accept the remote server certificate. - -### `list` - -List registered remotes. You can also use the alias `ls`. - - amc remote list --format=json - -where `--format` is to control output formatting. The valid values are `table`, `json` and `csv`. The default format is `table`. - -### `remove` - -Remove a registered remote. - - amc remote remove - -### `set-default` - -Set the default remote which is the primary remote used for requests. - - amc remote set-default - -### `set-url` - -Set the URL of an existing remote. - - amc remote set-url diff --git a/reference/cmd-ref/amc-command-reference/shell.md b/reference/cmd-ref/amc-command-reference/shell.md deleted file mode 100644 index e0161b23..00000000 --- a/reference/cmd-ref/amc-command-reference/shell.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -orphan: true ---- -# `shell` - -The `shell` command opens a shell inside a running instance. - - amc shell - -This command is an alias for `amc exec -- bash`. diff --git a/reference/cmd-ref/amc-command-reference/show-log.md b/reference/cmd-ref/amc-command-reference/show-log.md deleted file mode 100644 index 371a548a..00000000 --- a/reference/cmd-ref/amc-command-reference/show-log.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -orphan: true ---- -# `show-log` - -The `show-log` command shows the log file of an instance. - - amc show-log - -Use the `amc show ` command to get the names of the available log files that can be viewed. diff --git a/reference/cmd-ref/amc-command-reference/show.md b/reference/cmd-ref/amc-command-reference/show.md deleted file mode 100644 index a3ee6618..00000000 --- a/reference/cmd-ref/amc-command-reference/show.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -orphan: true ---- -# `show` - -The `show` command displays information about an instance. - - amc show --format=json - -where `--format` option is to control the output formatting which can be `json` or `yaml`. diff --git a/reference/cmd-ref/amc-command-reference/start.md b/reference/cmd-ref/amc-command-reference/start.md deleted file mode 100644 index ba86bd7e..00000000 --- a/reference/cmd-ref/amc-command-reference/start.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -orphan: true ---- -# `start` - -The `start` command starts an existing instance that is in a prepared or a stopped status. This command can be used to start an instance when: -* An instance is just initialised with the `amc init` command and not started. -* An instance is in an error status. - - amc start [options] - -The following options are available: - -| Option | Description | Default value | -|--------|-------------|---------------| -| `-h`, `--help` | Displays help information for the command | -| `--no-wait` | Indicates not to wait for the instance to start | Disabled | -| `-t`, `--timeout` | Indicates the maximum time to wait for the operation to complete | 5m | -| `-y`, `--yes` | Force start the instance from error state | | diff --git a/reference/cmd-ref/amc-command-reference/stop.md b/reference/cmd-ref/amc-command-reference/stop.md deleted file mode 100644 index aa2eb8fd..00000000 --- a/reference/cmd-ref/amc-command-reference/stop.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -orphan: true ---- -# `stop` - -The `stop` command stops a running instance. - - amc stop [options] - -The following options are available: - -| Option | Description | Default value | -|--------|-------------|---------------| -| `-h`, `--help` | Displays help information for the command | -| `--no-wait` | Indicates not to wait for the instance to start | Disabled | -| `-t`, `--timeout` | Indicates the maximum time to wait for the operation to complete | 5m | diff --git a/reference/cmd-ref/amc-command-reference/wait.md b/reference/cmd-ref/amc-command-reference/wait.md deleted file mode 100644 index d0d82d32..00000000 --- a/reference/cmd-ref/amc-command-reference/wait.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -orphan: true ---- -# `wait` - -The `wait` command waits for an instance to reach a specific condition. - - amc wait ( | ) --condition [options] - -The following options are available: - -| Option | Description | Default value | -|--------|-------------|---------------| -| `-c`, `--condition` | Condition in the form of a `key=value` where `key` is a supported attribute and `value` defines what to wait on.
Valid attributes for applications and their versions are `published` and `status` and for instances `status`. | | -| `-h`, `--help` | Displays help information for the command | | -| `-s`, `--selector` | Selector to filter the application or instance.
Use `--selector version=` to wait on an application version. | | -| `-t`, `--timeout` | Indicates the maximum time to wait for the operation to complete | 5m |