CLI¶
aria¶
ARIA’s Command Line Interface.
To activate bash-completion run:
eval "$(_ARIA_COMPLETE=source aria)"
ARIA’s working directory resides by default in “~/.aria”. To change it, set the environment variable ARIA_WORKDIR to something else (e.g. “/tmp/”).
aria [OPTIONS] COMMAND [ARGS]...
Options
-
-v,--verbose¶ Show verbose output; you can supply this up to three times (i.e. -vvv)
-
--version¶ Display the version and exit
aria reset¶
Reset ARIA working directory
Deletes installed plugins, service templates, services, executions, and logs. The user configuration will remain intact unless the –reset_config flag has been set as well, in which case the entire ARIA working directory shall be removed.
aria reset [OPTIONS]
Options
-
-f,--force¶ Confirmation for resetting ARIA’s working directory
-
--reset-config¶ Reset ARIA’s user configuration
-
-v,--verbose¶ Show verbose output; you can supply this up to three times (i.e. -vvv)
aria plugins¶
Manage plugins
aria plugins [OPTIONS] COMMAND [ARGS]...
Options
-
-v,--verbose¶ Show verbose output; you can supply this up to three times (i.e. -vvv)
install¶
Install a plugin
A valid plugin is a wagon (http://github.com/cloudify-cosmo/wagon) in the ZIP format (suffix may also be .wgn).
PLUGIN_PATH is the path to the wagon archive.
aria plugins install [OPTIONS] PLUGIN_PATH
Options
-
-v,--verbose¶ Show verbose output; you can supply this up to three times (i.e. -vvv)
Arguments
-
PLUGIN_PATH¶ Required argument
list¶
List all installed plugins
aria plugins list [OPTIONS]
Options
-
--sort-by<sort_by>¶ Key for sorting the list
-
--descending¶ Sort list in descending order [default: False]
-
-v,--verbose¶ Show verbose output; you can supply this up to three times (i.e. -vvv)
show¶
Show information for an installed plugin
PLUGIN_ID is the unique installed plugin ID in this ARIA instance.
aria plugins show [OPTIONS] PLUGIN_ID
Options
-
-v,--verbose¶ Show verbose output; you can supply this up to three times (i.e. -vvv)
Arguments
-
PLUGIN_ID¶ Required argument
validate¶
Validate a plugin archive
A valid plugin is a wagon (http://github.com/cloudify-cosmo/wagon) in the ZIP format (suffix may also be .wgn).
PLUGIN_PATH is the path to the wagon archive.
aria plugins validate [OPTIONS] PLUGIN_PATH
Options
-
-v,--verbose¶ Show verbose output; you can supply this up to three times (i.e. -vvv)
Arguments
-
PLUGIN_PATH¶ Required argument
aria service_templates¶
Manage service templates
aria service_templates [OPTIONS] COMMAND [ARGS]...
Options
-
-v,--verbose¶ Show verbose output; you can supply this up to three times (i.e. -vvv)
create-archive¶
Create a CSAR archive from a service template source
SERVICE_TEMPLATE_PATH is the path to the service template source.
DESTINATION is the path to the created CSAR archive.
aria service_templates create-archive [OPTIONS] SERVICE_TEMPLATE_PATH
DESTINATION
Options
-
-v,--verbose¶ Show verbose output; you can supply this up to three times (i.e. -vvv)
Arguments
-
SERVICE_TEMPLATE_PATH¶ Required argument
-
DESTINATION¶ Required argument
delete¶
Delete a stored service template
SERVICE_TEMPLATE_NAME is the unique name of the stored service template.
aria service_templates delete [OPTIONS] SERVICE_TEMPLATE_NAME
Options
-
-v,--verbose¶ Show verbose output; you can supply this up to three times (i.e. -vvv)
Arguments
-
SERVICE_TEMPLATE_NAME¶ Required argument
inputs¶
Show stored service template inputs
SERVICE_TEMPLATE_NAME is the unique name of the stored service template.
aria service_templates inputs [OPTIONS] SERVICE_TEMPLATE_NAME
Options
-
-v,--verbose¶ Show verbose output; you can supply this up to three times (i.e. -vvv)
Arguments
-
SERVICE_TEMPLATE_NAME¶ Required argument
list¶
List all stored service templates
aria service_templates list [OPTIONS]
Options
-
--sort-by<sort_by>¶ Key for sorting the list
-
--descending¶ Sort list in descending order [default: False]
-
-v,--verbose¶ Show verbose output; you can supply this up to three times (i.e. -vvv)
show¶
Show information for a stored service template
SERVICE_TEMPLATE_NAME is the unique name of the stored service template.
aria service_templates show [OPTIONS] SERVICE_TEMPLATE_NAME
Options
-
-v,--verbose¶ Show verbose output; you can supply this up to three times (i.e. -vvv)
-
-f,--full¶ Show full information. Cannot be used together with -t, –types (only one mode is possible).
-
-t,--types¶ Show only the type hierarchies. Cannot be used together with -f, –full (only one mode is possible).
-
-j,--json¶ Show in JSON format (implies –full). Cannot be used together with -y, –yaml (only one format is possible).
-
-y,--yaml¶ Show in YAML format (implies –full). Cannot be used together with -j, –json (only one format is possible).
Arguments
-
SERVICE_TEMPLATE_NAME¶ Required argument
store¶
Parse and store a service template archive
SERVICE_TEMPLATE_PATH is the path to the service template archive.
SERVICE_TEMPLATE_NAME is the unique name to give to the service template in storage.
aria service_templates store [OPTIONS] SERVICE_TEMPLATE_PATH
SERVICE_TEMPLATE_NAME
Options
-
-n,--service-template-filename<service_template_filename>¶ The name of the archive’s main service template file (only relevant if uploading a non-CSAR archive)
-
-v,--verbose¶ Show verbose output; you can supply this up to three times (i.e. -vvv)
Arguments
-
SERVICE_TEMPLATE_PATH¶ Required argument
-
SERVICE_TEMPLATE_NAME¶ Required argument
validate¶
Validate a service template archive
SERVICE_TEMPLATE_PATH is the path to the service template archive.
aria service_templates validate [OPTIONS] SERVICE_TEMPLATE
Options
-
-n,--service-template-filename<service_template_filename>¶ The name of the archive’s main service template file (only relevant if uploading a non-CSAR archive)
-
-v,--verbose¶ Show verbose output; you can supply this up to three times (i.e. -vvv)
Arguments
-
SERVICE_TEMPLATE¶ Required argument
aria node_templates¶
Manages stored service templates’ node templates
aria node_templates [OPTIONS] COMMAND [ARGS]...
Options
-
-v,--verbose¶ Show verbose output; you can supply this up to three times (i.e. -vvv)
list¶
List stored node templates
If SERVICE_TEMPLATE_NAME is provided, list node templates for that stored service template. Otherwise, list node templates for all service templates.
aria node_templates list [OPTIONS]
Options
-
-t,--service-template-name<service_template_name>¶ The unique identifier for the service
-
--sort-by<sort_by>¶ Key for sorting the list
-
--descending¶ Sort list in descending order [default: False]
-
-v,--verbose¶ Show verbose output; you can supply this up to three times (i.e. -vvv)
aria services¶
Manage services
aria services [OPTIONS] COMMAND [ARGS]...
Options
-
-v,--verbose¶ Show verbose output; you can supply this up to three times (i.e. -vvv)
create¶
Create a service
SERVICE_NAME is the unique name to give to the service.
aria services create [OPTIONS] [SERVICE_NAME]
Options
-
-t,--service-template-name<service_template_name>¶ The unique identifier for the service [required]
-
-i,--inputs<inputs>¶ Inputs for the service (can be provided as wildcard based paths (“inp?.yaml”, “/my_inputs/”, etc.) to YAML files, a JSON string or as “key1=value1;key2=value2”); this argument can be used multiple times
-
-v,--verbose¶ Show verbose output; you can supply this up to three times (i.e. -vvv)
Arguments
-
SERVICE_NAME¶ Optional argument
delete¶
Delete a service
SERVICE_NAME is the unique name of the service.
aria services delete [OPTIONS] SERVICE_NAME
Options
-
-f,--force¶ Delete the service even if it has available nodes
-
-v,--verbose¶ Show verbose output; you can supply this up to three times (i.e. -vvv)
Arguments
-
SERVICE_NAME¶ Required argument
inputs¶
Show service inputs
SERVICE_NAME is the unique name of the service.
aria services inputs [OPTIONS] SERVICE_NAME
Options
-
-v,--verbose¶ Show verbose output; you can supply this up to three times (i.e. -vvv)
Arguments
-
SERVICE_NAME¶ Required argument
list¶
List services
If –service-template-name is provided, list services based on that service template. Otherwise, list all services.
aria services list [OPTIONS]
Options
-
-t,--service-template-name<service_template_name>¶ The unique identifier for the service
-
--sort-by<sort_by>¶ Key for sorting the list
-
--descending¶ Sort list in descending order [default: False]
-
-v,--verbose¶ Show verbose output; you can supply this up to three times (i.e. -vvv)
outputs¶
Show service outputs
SERVICE_NAME is the unique name of the service.
aria services outputs [OPTIONS] SERVICE_NAME
Options
-
-v,--verbose¶ Show verbose output; you can supply this up to three times (i.e. -vvv)
Arguments
-
SERVICE_NAME¶ Required argument
show¶
Show information for a service
SERVICE_NAME is the unique name of the service.
aria services show [OPTIONS] SERVICE_NAME
Options
-
-v,--verbose¶ Show verbose output; you can supply this up to three times (i.e. -vvv)
-
-f,--full¶ Show full information. Cannot be used together with -g, –graph (only one mode is possible).
-
-g,--graph¶ Show only the node graph. Cannot be used together with -f, –full (only one mode is possible).
-
-j,--json¶ Show in JSON format (implies –full). Cannot be used together with -y, –yaml (only one format is possible).
-
-y,--yaml¶ Show in YAML format (implies –full). Cannot be used together with -j, –json (only one format is possible).
Arguments
-
SERVICE_NAME¶ Required argument
aria nodes¶
Manage services’ nodes
aria nodes [OPTIONS] COMMAND [ARGS]...
Options
-
-v,--verbose¶ Show verbose output; you can supply this up to three times (i.e. -vvv)
list¶
List nodes
If SERVICE_NAME is provided, list nodes for that service. Otherwise, list nodes for all services.
aria nodes list [OPTIONS]
Options
-
-s,--service-name<service_name>¶ The unique identifier for the service
-
--sort-by<sort_by>¶ Key for sorting the list
-
--descending¶ Sort list in descending order [default: False]
-
-v,--verbose¶ Show verbose output; you can supply this up to three times (i.e. -vvv)
aria workflows¶
Manage service workflows
aria workflows [OPTIONS] COMMAND [ARGS]...
list¶
List service workflows
SERVICE_NAME is the unique name of the service.
aria workflows list [OPTIONS]
Options
-
-s,--service-name<service_name>¶ The unique identifier for the service [required]
-
-v,--verbose¶ Show verbose output; you can supply this up to three times (i.e. -vvv)
show¶
Show information for a service workflow
SERVICE_NAME is the unique name of the service.
WORKFLOW_NAME is the unique name of the workflow within the service (e.g. “uninstall”).
aria workflows show [OPTIONS] WORKFLOW_NAME
Options
-
-s,--service-name<service_name>¶ The unique identifier for the service [required]
-
-v,--verbose¶ Show verbose output; you can supply this up to three times (i.e. -vvv)
Arguments
-
WORKFLOW_NAME¶ Required argument
aria executions¶
Manage executions
aria executions [OPTIONS] COMMAND [ARGS]...
Options
-
-v,--verbose¶ Show verbose output; you can supply this up to three times (i.e. -vvv)
list¶
List executions
If SERVICE_NAME is provided, list executions on that service. Otherwise, list executions on all services.
aria executions list [OPTIONS]
Options
-
-s,--service-name<service_name>¶ The unique identifier for the service
-
--sort-by<sort_by>¶ Key for sorting the list
-
--descending¶ Sort list in descending order [default: False]
-
-v,--verbose¶ Show verbose output; you can supply this up to three times (i.e. -vvv)
resume¶
Resume a stopped execution
EXECUTION_ID is the unique ID of the execution.
aria executions resume [OPTIONS] EXECUTION_ID
Options
-
--dry¶ Execute a workflow dry run (prints operations information without causing side effects)
-
--retry-failed-tasks¶ Retry tasks that failed in the previous execution attempt
-
-m,--mark-pattern<mark_pattern>¶ Mark a regular expression pattern in the logs
-
-v,--verbose¶ Show verbose output; you can supply this up to three times (i.e. -vvv)
Arguments
-
EXECUTION_ID¶ Required argument
show¶
Show information for an execution
EXECUTION_ID is the unique ID of the execution.
aria executions show [OPTIONS] EXECUTION_ID
Options
-
-v,--verbose¶ Show verbose output; you can supply this up to three times (i.e. -vvv)
Arguments
-
EXECUTION_ID¶ Required argument
start¶
Start a workflow on a service
SERVICE_NAME is the unique name of the service.
WORKFLOW_NAME is the unique name of the workflow within the service (e.g. “uninstall”).
aria executions start [OPTIONS] WORKFLOW_NAME
Options
-
-s,--service-name<service_name>¶ The unique identifier for the service [required]
-
-i,--inputs<inputs>¶ Inputs for the execution (can be provided as wildcard based paths (“inp?.yaml”, “/my_inputs/”, etc.) to YAML files, a JSON string or as “key1=value1;key2=value2”); this argument can be used multiple times
-
--dry¶ Execute a workflow dry run (prints operations information without causing side effects)
-
--task-max-attempts<task_max_attempts>¶ How many times should a task be attempted in case of failures [default: 30]
-
--task-retry-interval<task_retry_interval>¶ How long of a minimal interval should occur between task retry attempts [default: 30]
-
-m,--mark-pattern<mark_pattern>¶ Mark a regular expression pattern in the logs
-
-v,--verbose¶ Show verbose output; you can supply this up to three times (i.e. -vvv)
Arguments
-
WORKFLOW_NAME¶ Required argument
aria logs¶
Manage logs of workflow executions
aria logs [OPTIONS] COMMAND [ARGS]...
Options
-
-v,--verbose¶ Show verbose output; you can supply this up to three times (i.e. -vvv)
delete¶
Delete logs of an execution
EXECUTION_ID is the unique ID of the execution.
aria logs delete [OPTIONS] EXECUTION_ID
Options
-
-v,--verbose¶ Show verbose output; you can supply this up to three times (i.e. -vvv)
Arguments
-
EXECUTION_ID¶ Required argument
list¶
List logs for an execution
EXECUTION_ID is the unique ID of the execution.
aria logs list [OPTIONS] EXECUTION_ID
Options
-
-v,--verbose¶ Show verbose output; you can supply this up to three times (i.e. -vvv)
-
-m,--mark-pattern<mark_pattern>¶ Mark a regular expression pattern in the logs
Arguments
-
EXECUTION_ID¶ Required argument