About the AGILITY CLI tool
The agility command-line interface (CLI) tool is for managing and performing various operations related to the AGILITY platform. The CLI tool has several commands, subcommands, and options that can be used to interact with different components of the AGILITY system.
These commands are used during installation and configuration. Go to the AGILITY Onboarding page for step-by-step guidance.
Note: Inside the VM run this tool as root user.
sudo su -
[root@ip-172-31-48-37 ~]# agility --help
Usage: agility [OPTIONS] COMMAND [ARGS]...
Options:
--help Show this message and exit.
Commands:
backup Manage backups (VM Only).
ingress Manage ingress settings.
license Manage AGILITY license.
monitoring Manage AGILITY Monitoring Stack.
proxy Manage proxy configuration.
telemetry Manage telemetry settings.
upgrade Upgrade AGILITY components.
[root@ip-172-31-48-37 ~]#In case of errors or other problems, please check the Installation troubleshooting document.
The options available in the CLI tool:
Commands
backup
Manage backups (VM Only).
Sub Command: local
Manage local (internal) backups.
| | | |
|---|
create | Create a new backup. | [--namespace] TEXT: Namespace in which agility is installed. Default is 'agility'.
[--full] Perform a full backup. Default behavior if neither --full nor --diff is specified.
[--diff] Perform a differential (delta) backup.
| agility backup s3 create
|
restore | Restore DB In-Place from a local backup. | [--namespace] TEXT: Namespace in which AGILITY is installed. Default is 'agility'.
[--time] TEXT: Point-in-Time Recovery (PITR) to restore the database to. Format: 'YYYY-MM-DD HH:mm:ss-TZ'.
[--auto-accept] Automatically accept the restore operation without prompting.
| agility backup local restore
|
status | Show the available backups status. | [--namespace] TEXT: Namespace in which agility is installed. Default agility.
[--debug] Shows more details.
| agility backup local status
|
Subcommand: s3
Manage S3 bucket backups.
| | | |
|---|
clone | Clone the DB from another S3 backup. | [--namespace] TEXT: Namespace in which agility is installed. Default agility.
[--bucket-name] TEXT: Specify the S3 bucket name.
[--endpoint] TEXT: Specify the S3 endpoint.
[--path] TEXT: Specify the S3 path.
[--region] TEXT: Specify the S3 region.
[--access-key-id] TEXT: Specify the S3 Access Key ID.
[--secret-access-key] TEXT: Specify the S3 Secret Access Key.
[--timeout] Restore job timeout. Default 600 (seg).
[--auto-accept] Automatically accept the clone operation without prompting.
| Recommended:
agility backup s3 clone Complete:
agility backup s3 clone --bucket-name=my-bucket --endpoint=s3.us-east-1.amazonaws.com --path=/backups-old --access-key-id=XXXX --secret-access-key=YYYYY --region=us-east-1 |
create | Create a new backup. | [--namespace] TEXT: Namespace in which agility is installed. Default is 'agility'.
[--full] Perform a full backup. Default behavior if neither --full nor --diff is specified.
[--diff] Perform a differential (delta) backup.
| agility backup s3 create
|
restore | Restore DB from a S3 bucket backup. | [--namespace] TEXT: Namespace in which AGILITY is installed. Default is 'agility'.
[--time] TEXT: Point-in-Time Recovery (PITR) to restore the database to. Format: 'YYYY-MM-DD HH:mm:ss-TZ'.
[--auto-accept] Automatically accept the restore operation without prompting.
| agility backup s3 restore
|
status | Show the available backups status. | [--namespace] TEXT: Namespace in which agility is installed. Default agility.
[--debug] Reveals sensitive information.
| agility backup s3 status
|
settings | Configure S3 bucket backup settings. | | |
Subcommand: settings
Configure S3 bucket backup settings.
Subcommand | Description | Options | Example |
apply | Apply S3 bucket backups settings. | [--namespace] TEXT: Namespace in which agility is installed. Default agility.
[--bucket-name] TEXT: Specify the S3 bucket name.
[--endpoint] TEXT: Specify the S3 endpoint. [--path] TEXT: Specify the S3 path.
[--region] TEXT: Specify the S3 region.
[--retention-count] INTEGER: Specify the full backups retention count.
[--full-schedule] TEXT: Specify the full backup schedule.
[--differential-schedule] TEXT: Specify the differential backup schedule.
[--access-key-id] TEXT: Specify the S3 Access Key ID.
[--secret-access-key] TEXT: Specify the S3 Secret Access Key.
[--auto-accept] Automatically accept the restore operation without prompting.
| Recommended: agility backup s3 settings apply
Complete:
agility backup s3 settings apply --bucket-name=my-bucket --retention-count=10 --full-schedule="0 0 * * *" --differential-schedule="0 * * * *" --endpoint=http://s3.us-east-1.amazonaws.com --path=/backups --access-key-id=XXXX --secret-access-key=YYYYY --region=us-east-1 |
delete | Delete the existing backup settings. | [--namespace] TEXT: Namespace in which agility is installed. Default agility.
[--auto-accept] Automatically accept the delete operation without prompting.
| agility backup s3 settings delete
|
list | List S3 bucket backup settings. | [--namespace] TEXT: Namespace in which agility is installed. Default agility.
[--sensitive] Reveals sensitive information.
| agility backup s3 settings list
|
license
Manage AGILITY license.
| | | |
|---|
upload | Upload AGILITY license. | --file TEXT: AGILITY license file path.
--text TEXT: AGILITY license content as text.
[--namespace] TEXT: Namespace in which AGILITY is installed. Default is 'agility'.
| agility license upload --file agility.lic
|
status | Get AGILITY license status. | [--namespace] TEXT: Namespace in which AGILITY is installed. Default is 'agility'.
| agility license status
|
ingress
Manage ingress settings.
Sub Command: tls
Manage TLS configuration.
| | | |
|---|
set | Set Ingress TLS for the specified host | --host TEXT: Specify the host for TLS configuration (required).
--cert TEXT: Specify the certificate filename (required).
--key TEXT: Specify the key filename (required).
[--agility-namespace] TEXT: Namespace in which agility is installed. Default 'agility'.
[--monitoring-namespace] TEXT: Namespace in which monitoring is installed. Default 'monitoring'.
| agility ingress tls set --host example.com --cert tls.crt --key tls.key
|
reset | Reset ingress configuration | | agility ingress tls reset
|
monitoring
Manage AGILITY Monitoring Stack.
| | | |
|---|
install | Install or upgrade AGILITY Monitoring Stack. | [--version]: Specify the version to install/upgrade. Default 1.0.6.
[--namespace] TEXT: Namespace in which monitoring is installed. Default 'monitoring'.
| agility monitoring install
|
uninstall | Uninstall AGILITY Monitoring Stack. | [--namespace] TEXT: Namespace in which monitoring is installed. Default 'monitoring'.
[--auto-accept]: Auto accept all the questions (y). (default: False)
| agility monitoring uninstall
|
For the non cli (manual Helm) installation details please refer to AGILITY Monitoring
proxy
Manage proxy configuration.
| | | |
|---|
set | Set the proxy configuration. | --http-proxy: Specify the HTTP proxy (required).
--https-proxy: Specify the HTTPS proxy (required).
[--no-proxy]: Specify the hosts to exclude from the proxy.
[--namespace] TEXT: Namespace (default: agility)
[--cv] TEXT: ContinuosValidation (default: agility)
| agility proxy set --http-proxy http://proxy.example.com --https-proxy https://proxy.example.com --no-proxy localhost,127.0.0.1
|
reset | Remove the proxy configuration. | [--namespace] TEXT: Namespace (default: agility)
[--cv] TEXT: ContinuosValidation (default: agility)
| agility proxy reset
|
Subcommand | Description | Options | Example |
set | Set the proxy configuration. | --http-proxy: Specify the HTTP proxy (required).
--https-proxy: Specify the HTTPS proxy (required).
[--no-proxy]: Specify the hosts to exclude from the proxy.
| agility proxy set --http-proxy http://proxy.example.com --https-proxy https://proxy.example.com --no-proxy localhost,127.0.0.1
|
reset | Remove the proxy configuration. | | agility proxy reset
|
telemetry
Manage telemetry settings.
Subcommand: local
Local monitoring (agility-monitoring) stack telemetry data.
Subcommand | Description | Options | Example |
enable | Enable local usage data collection. | [--agility-namespace] TEXT: Namespace in which AGILITY is installed (default: agility).
[--monitoring-namespace] TEXT: Namespace in which monitoring is installed (default: monitoring).
[--auto-accept]: Auto accept all the questions (y). (default: False)
| agility telemetry local enable --auto-accept
|
disable | Disable local usage data collection. | [--agility-namespace] TEXT: Namespace in which AGILITY is installed (default: agility).
[--monitoring-namespace] TEXT: Namespace in which monitoring is installed (default: monitoring).
[--auto-accept]: Auto accept all the questions (y). (default: False)
| agility telemetry local disable --auto-accept
|
status | Show local usage data collection details. | [--agility-namespace] TEXT: Namespace in which AGILITY is installed (default: agility).
[--monitoring-namespace] TEXT: Namespace in which monitoring is installed (default: monitoring).
[--auto-accept]: Auto accept all the questions (y). (default: False)
| agility telemetry local status
|
Subcommand: remote
Anonymous usage data collection to B-Yond.
Subcommand | Description | Options | Example |
enable | Enable anonymous usage data collection. | [--namespace] TEXT: Namespace in which AGILITY is installed (default: agility).
[--auto-accept]: Auto accept all the questions (y). (default: False)
| agility telemetry remote enable --auto-accept
|
disable | Disable anonymous usage data collection. | [--namespace] TEXT: Namespace in which AGILITY is installed (default: agility).
[--auto-accept]: Auto accept all the questions (y). (default: False)
| agility telemetry remote disable --auto-accept
|
status | Show anonymous usage data collection details. | [--namespace] TEXT: Namespace in which AGILITY is installed (default: agility).
[--auto-accept]: Auto accept all the questions (y). (default: False)
| agility telemetry remote status
|
Subcommand: customer
Export Agility data to a compliant Open Telemetry collector.
| | | |
|---|
enable | Enable data collection to customer open telemetry collector. | [--namespace] TEXT: Namespace in which AGILITY is installed (default: agility)
--endpoint TEXT Endpoint of the OpenTelemetry Collector.
--port TEXT Port of the OpenTelemetry Collector.
| agility telemetry customer enable --endpoint customer-otel.example.com --port 4317
|
disable | Disable data collection to customer open telemetry collector. | [--namespace] TEXT: Namespace in which AGILITY is installed (default: agility).
| agility telemetry customer disable --auto-accept
|
status | Show status of data collection to customer open telemetry collector. | | agility telemetry customer status
|
upgrade
Upgrade AGILITY components.
Subcommand | Description | Options | Example |
agility | Upgrade the AGILITY component. | --version TEXT: Specify the version for upgrade (required).
[--namespace] TEXT: Namespace (default: agility).
| agility upgrade agility --version 3.78.0
|
agility-services | Upgrade the AGILITY Services component. | --version TEXT: Specify the version for upgrade (required).
[--namespace] TEXT: Namespace (default: agility).
| agility upgrade agility-services --version 3.78.0
|
agility-system | Upgrade the AGILITY System component. | --version TEXT: Specify the version for upgrade (required).
[--namespace] TEXT: Namespace for AGILITY System (default: kube-system) (default: kube-system).
| agility upgrade agility-system --version 3.78.0
|
all | Upgrade all components with the same version. | --all-version TEXT: Specify the version for upgrade. All components with the same version (required).
[--namespace] TEXT: Namespace for AGILITY and AGILITY Services (default: agility)
--sys-namespace TEXT: Namespace for AGILITY System (default: kube-system).
| agility upgrade all --all-version 3.78.0 --namespace agility --sys-namespace kube-system
|