Repository: incubator-ariatosca Updated Branches: refs/heads/ARIA-166-update-readme 9e8e2f079 -> f1710a2d4
review fixes Project: http://git-wip-us.apache.org/repos/asf/incubator-ariatosca/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-ariatosca/commit/f1710a2d Tree: http://git-wip-us.apache.org/repos/asf/incubator-ariatosca/tree/f1710a2d Diff: http://git-wip-us.apache.org/repos/asf/incubator-ariatosca/diff/f1710a2d Branch: refs/heads/ARIA-166-update-readme Commit: f1710a2d43a5d70343fb5f6d83c80a437824bc1a Parents: 9e8e2f0 Author: Ran Ziv <r...@gigaspaces.com> Authored: Mon Jun 12 18:44:47 2017 +0300 Committer: Ran Ziv <r...@gigaspaces.com> Committed: Mon Jun 12 18:44:47 2017 +0300 ---------------------------------------------------------------------- README.md | 46 ++++++++++++++++++++++++++-------------------- 1 file changed, 26 insertions(+), 20 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-ariatosca/blob/f1710a2d/README.md ---------------------------------------------------------------------- diff --git a/README.md b/README.md index ba0a4ae..cd30387 100644 --- a/README.md +++ b/README.md @@ -12,11 +12,16 @@ ARIA [![Closed Pull Requests](https://img.shields.io/github/issues-pr-closed-raw/apache/incubator-ariatosca.svg?style=plastic)](https://github.com/apache/incubator-ariatosca/pulls?q=is%3Apr+is%3Aclosed) -[ARIA](http://ariatosca.incubator.apache.org/) is a an open-source, lightweight, library and CLI for orchestration that open-source projects can consume to build TOSCA-based orchestration solutions for resources and services orchestration. It supports NFV and hybrid Cloud scenarios. +What is ARIA? +---------------- + +[ARIA](http://ariatosca.incubator.apache.org/) is a an open-source, [TOSCA](https://www.oasis-open.org/committees/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 test and run your applications, from template to deployment. +With ARIA, you can utilize TOSCA's cloud portability out-of-the-box, to develop, test and run your applications. + +ARIA is an incubation project under the Apache Software Foundation. Installation @@ -24,20 +29,6 @@ Installation ARIA is [available on PyPI](https://pypi.python.org/pypi/ariatosca). -ARIA requires Python 2.6/2.7. Python 3+ is not currently supported. - -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 - - To install ARIA directly from PyPI (using a `wheel`), use: pip install aria @@ -47,13 +38,27 @@ To install ARIA from source, download the source tarball from [PyPI](https://pyp 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. - <br> Note that for the `pip install` commands mentioned above, you must use a privileged user, or use virtualenv. +<br><br><br> + +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. Getting Started @@ -61,11 +66,11 @@ Getting Started This section will describe how to run a simple "Hello World" example. -First, provide ARIA with your service-template, naming it `my-service-template`: +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, naming it `my-service`: +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 @@ -104,6 +109,7 @@ Resources * Dev mailing list: dev@ariatosca.incubator.apache.org * User mailing list: u...@ariatosca.incubator.apache.org +Subscribe by sending a mail to `<group>-subscr...@ariatosca.incubator.apache.org` (e.g. `dev-subscr...@ariatosca.incubator.apache.org`). See information on how to subscribe to mailing list [here](https://www.apache.org/foundation/mailinglists.html). For past correspondence, see the [dev mailing list archive](http://mail-archives.apache.org/mod_mbox/incubator-ariatosca-dev/).