blob: b9a8213cef14541816b7dbcd3e66f60341f50f51 [file] [log] [blame]
|Build Status| |Appveyor Build Status| |License| |PyPI release| |Python Versions| |Wheel|
|Contributors| |Open Pull Requests| |Closed Pull Requests|
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 <>`__.
ARIA is `available on PyPI <>`__.
ARIA requires Python 2.6/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 Ubuntu14.04, Ubuntu16.04)::
apt-get install -y python-dev gcc libffi-dev libssl-dev
pip install aria[ssh]
**Centos** (tested on Centos6.6, Centos7)::
yum install -y python-devel gcc libffi-devel openssl-devel
pip install aria[ssh]
pacman -Syu --noconfirm python2 gcc libffi openssl
pip2 install aria[ssh]
**Windows** (tested on Win10)::
# no additional system requirements are needed
pip install aria[ssh]
To install ``pip``, either use your distro's package management system, or run::
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.
aria service-templates store examples/hello-world/helloworld.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
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 <#user-content-resources>`__
- `ARIA homepage <>`__
- `ARIA wiki <>`__
- `Issue tracker <>`__
- Dev mailing list:
- User mailing list:
Subscribe by sending a mail to ``<group>`` (e.g.
````). See information on how to subscribe to mailing
lists `here <>`__.
For past correspondence, see the
`dev mailing list archive <>`__.
ARIA is licensed under the
`Apache License 2.0 <>`__.
.. |Build Status| image::
.. |Appveyor Build Status| image::
.. |License| image::
.. |PyPI release| image::
.. |Python Versions| image::
.. |Wheel| image::
.. |Contributors| image::
.. |Open Pull Requests| image::
.. |Closed Pull Requests| image::