Welcome to aria-cli’s documentation!¶
The documention here includes reference for the various aria
subcommands. For general usage, please refer
to the documentation located at getcloudify.org.
Contents:
Commands¶
- There are two flags that can be used for all operations:
--verbose
prints the traceback and prints the events in verbose mode (a full event json)--debug
sets all loggers to debug mode.
- Inputs and Parameters
- All commands that accept inputs or paramaters (e.g. “aria execute” ) expect the value to represent a dictionary. Valid formats are:
- A path to the YAML file
- A string formatted as YAML
- A string formatted as “key1=value1;key2=value2”
aria¶
Manages ARIA in different Cloud Environments
usage: aria [-h] [--version]
{execute,install-plugins,instances,init,create-requirements,outputs,validate}
...
- Options:
--version show version information and exit - Sub-commands:
- execute
Execute a workflow locally
usage: aria execute [-h] [--allow-custom-parameters] [-p PARAMETERS] [--task-retries TASK_RETRIES] -w WORKFLOW [--task-thread-pool-size TASK_THREAD_POOL_SIZE] [--task-retry-interval TASK_RETRY_INTERVAL] [-v] [--debug]
- Options:
--allow-custom-parameters=False A flag for allowing the passing of custom parameters (parameters which were not defined in the workflow’s schema in the blueprint) to the execution -p={}, --parameters={} Parameters for the workflow execution (formatted as YAML or as “key1=value1;key2=value2”) --task-retries=0 How many times should a task be retried in case it fails -w, --workflow The workflow to execute locally --task-thread-pool-size=1 The size of the thread pool size to execute tasks in --task-retry-interval=1 How many seconds to wait before each task is retried -v=False, --verbose=False Set verbose output --debug=False Set debug output
- install-plugins
Installs the necessary plugins for a given blueprint
usage: aria install-plugins [-h] -p BLUEPRINT_PATH [-v] [--debug]
- Options:
-p, --blueprint-path Path to a blueprint -v=False, --verbose=False Set verbose output --debug=False Set debug output
- instances
Display node instances
usage: aria instances [-h] [--node-id NODE_ID] [-v] [--debug]
- Options:
--node-id Only display node instances of this node id -v=False, --verbose=False Set verbose output --debug=False Set debug output
- init
Init a local workflow execution environment in in the current working directory
usage: aria init [-h] [--install-plugins] -p BLUEPRINT_PATH [-i INPUTS] [-v] [--debug]
- Options:
--install-plugins=False Install necessary plugins of the given blueprint. -p, --blueprint-path Path to a blueprint -i, --inputs Inputs file/string for the local workflow creation (formatted as YAML or as “key1=value1;key2=value2”) -v=False, --verbose=False Set verbose output --debug=False Set debug output
- create-requirements
Creates a PIP compliant requirements file for the given blueprint
usage: aria create-requirements [-h] [-o REQUIREMENTS_OUTPUT] -p BLUEPRINT_PATH [-v] [--debug]
- Options:
-o, --output Path to a file that will hold the requirements of the blueprint -p, --blueprint-path Path to a blueprint -v=False, --verbose=False Set verbose output --debug=False Set debug output
- outputs
Display outputs
usage: aria outputs [-h] [-v] [--debug]
- Options:
-v=False, --verbose=False Set verbose output --debug=False Set debug output
- validate
command for validating a blueprint
usage: aria validate [-h] -p BLUEPRINT_FILE [-v] [--debug]
- Options:
-p, --blueprint-path Path to the application’s blueprint file -v=False, --verbose=False Set verbose output --debug=False Set debug output