README.rst

ARIA

What is ARIA?

ARIA is a an open-source, TOSCA-based, lightweight library and CLI for orchestration and for consumption by projects building TOSCA-based solutions for resources and services orchestration.

ARIA can be utilized by any organization that wants to implement TOSCA-based orchestration in its solutions, whether a multi-cloud enterprise application, or an NFV or SDN solution for multiple virtual infrastructure managers.

With ARIA, you can utilize TOSCA's cloud portability out-of-the-box, to develop, test and run your applications, from template to deployment.

ARIA is an incubation project under the Apache Software Foundation.

Installation

ARIA is available on PyPI.

ARIA requires Python 2.7. Python 3 is currently not supported.

To install ARIA directly from PyPI (using a wheel), use:

pip install --upgrade pip setuptools
pip install apache-ariatosca

To install ARIA from source, download the source tarball from PyPI, extract and cd into the extract dir, and run:

pip install --upgrade pip setuptools
pip install .

The source package comes along with relevant examples, documentation, requirements.txt (for

installing specifically the frozen dependencies' versions with which ARIA was tested) and more.

ARIA has additional optional dependencies. These are required for running operations over SSH.

Below are instructions on how to install these dependencies, including required system

dependencies per OS.

Note: These dependencies may have varying licenses which may not be compatible with Apache license

2.0.

Ubuntu/Debian (tested on Ubuntu 14.04, Ubuntu 16.04):

apt-get install -y python-dev gcc libffi-dev libssl-dev
pip install apache-ariatosca[ssh]

CentOS/Fedora (tested on CentOS 6.6, CentOS 7):

yum install -y python-devel gcc libffi-devel openssl-devel
pip install apache-ariatosca[ssh]

Arch Linux:

pacman -Syu --noconfirm python2 gcc libffi openssl
pip2 install apache-ariatosca[ssh]

Windows (tested on Windows 10):

# no additional system requirements are needed
pip install apache-ariatosca[ssh]

macOS:

# TODO

To install pip, either use your operating system's package management system, or run:

wget http://bootstrap.pypa.io/get-pip.py
python get-pip.py

Getting Started

This section will describe how to run a simple "Hello World" example.

First, provide ARIA with the ARIA "hello world" service-template and name it (e.g. my-service-template):

aria service-templates store examples/hello-world/hello-world.yaml my-service-template

Now create a service based on this service-template and name it (e.g. my-service):

aria services create my-service -t my-service-template

Finally, start an install workflow execution on my-service like so:

aria executions start install -s my-service

You should now have a simple web-server running on your local machine. You can try visiting http://localhost:9090 to view your deployed application.

To uninstall and clean your environment, follow these steps:

aria executions start uninstall -s my-service
aria services delete my-service
aria service-templates delete my-service-template

Resources

• Main site
• API and CLI documentation
• Wiki
• Releases
• Issue tracker
• Dev mailing list: [email protected]
• User mailing list: [email protected]

Subscribe by sending a mail to <group>[email protected] (e.g. [email protected]). See information on how to subscribe to mailing lists here.

For past correspondence, see the dev mailing list archive.

License

ARIA is licensed under the Apache License 2.0.

Contribution

You are welcome and encouraged to participate and contribute to the ARIA project.

Please see our guide to Contributing to ARIA.

Feel free to also provide feedback on the mailing lists (see Resources section).

Code of Conduct

The ARIA TOSCA Project follows the Apache Code of Conduct.