| commit | 22f6e9efd5300f33bee51a1c1622c22b1531bbf5 | [log] [tgz] |
|---|---|---|
| author | Ran Ziv <ran@gigaspaces.com> | Thu Jun 08 18:26:29 2017 +0300 |
| committer | Ran Ziv <ran@gigaspaces.com> | Mon Jun 12 19:08:44 2017 +0300 |
| tree | 4d1636fe67238fd9d4fba12714d794b836169bed | |
| parent | 5afa2f7fe11977593009b6da25733fa8dd61a1e9 [diff] |
ARIA-166 Update README file
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.
To install ARIA directly from PyPI (using a wheel), use:
pip install aria
To install ARIA from source, download the source tarball from PyPI, extract it, and then when inside the extracted directory, use:
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 itself is in a wheel format compatible with all platforms. Some dependencies, however, might require compilation (based on a given platform), and therefore possibly some system dependencies are required as well.
On Ubuntu or other Debian-based systems:
sudo apt install python-setuptools python-dev build-essential libssl-dev libffi-dev
On Archlinux:
sudo pacman -S python-setuptools
ARIA requires Python 2.6/2.7. Python 3+ is currently not supported.
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/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
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 section).
Dev mailing list: dev@ariatosca.incubator.apache.org
User mailing list: user@ariatosca.incubator.apache.org
Subscribe by sending a mail to <group>-subscribe@ariatosca.incubator.apache.org (e.g. dev-subscribe@ariatosca.incubator.apache.org). See information on how to subscribe to mailing list here.
For past correspondence, see the dev mailing list archive.
ARIA is licensed under the Apache License 2.0.