azure/aria/aria-extension-cloudify/src/aria/README.rst

   1 ARIA
   2 ====
   3
   4 |Build Status| |Appveyor Build Status| |License| |PyPI release| |Python Versions| |Wheel|
   5 |Contributors| |Open Pull Requests| |Closed Pull Requests|
   6
   7
   8 What is ARIA?
   9 -------------
  10
  11 `ARIA <http://ariatosca.incubator.apache.org/>`__ is a an open-source,
  12 `TOSCA <https://www.oasis-open.org/committees/tosca/>`__-based, lightweight library and CLI for
  13 orchestration and for consumption by projects building TOSCA-based solutions for resources and
  14 services orchestration.
  15
  16 ARIA can be utilized by any organization that wants to implement TOSCA-based orchestration in its
  17 solutions, whether a multi-cloud enterprise application, or an NFV or SDN solution for multiple
  18 virtual infrastructure managers.
  19
  20 With ARIA, you can utilize TOSCA's cloud portability out-of-the-box, to develop, test and run your
  21 applications, from template to deployment.
  22
  23 ARIA is an incubation project under the `Apache Software Foundation <https://www.apache.org/>`__.
  24
  25
  26 Installation
  27 ------------
  28
  29 ARIA is `available on PyPI <https://pypi.python.org/pypi/apache-ariatosca>`__.
  30
  31 ARIA requires Python 2.6/2.7. Python 3 is currently not supported.
  32
  33 To install ARIA directly from PyPI (using a ``wheel``), use::
  34
  35     pip install --upgrade pip setuptools
  36     pip install apache-ariatosca
  37
  38 To install ARIA from source, download the source tarball from
  39 `PyPI <https://pypi.python.org/pypi/apache-ariatosca>`__, extract and ``cd`` into the extract dir,
  40 and run::
  41
  42     pip install --upgrade pip setuptools
  43     pip install .
  44
  45 | The source package comes along with relevant examples, documentation, ``requirements.txt`` (for
  46 | installing specifically the frozen dependencies' versions with which ARIA was tested) and more.
  47 |
  48 | ARIA has additional optional dependencies. These are required for running operations over SSH.
  49 | Below are instructions on how to install these dependencies, including required system
  50 | dependencies per OS.
  51 |
  52 | Note: These dependencies may have varying licenses which may not be compatible with Apache license
  53 | 2.0.
  54
  55 **Ubuntu/Debian** (tested on Ubuntu 14.04, Ubuntu 16.04)::
  56
  57     apt-get install -y python-dev gcc libffi-dev libssl-dev
  58     pip install apache-ariatosca[ssh]
  59
  60 **CentOS/Fedora** (tested on CentOS 6.6, CentOS 7)::
  61
  62     yum install -y python-devel gcc libffi-devel openssl-devel
  63     pip install apache-ariatosca[ssh]
  64
  65 **Archlinux**::
  66
  67     pacman -Syu --noconfirm python2 gcc libffi openssl
  68     pip2 install apache-ariatosca[ssh]
  69
  70 **Windows** (tested on Windows 10)::
  71
  72     # no additional system requirements are needed
  73     pip install apache-ariatosca[ssh]
  74
  75 **MacOS**::
  76
  77     # TODO
  78
  79
  80
  81 To install ``pip``, either use your operating system's package management system, or run::
  82
  83     wget http://bootstrap.pypa.io/get-pip.py
  84     python get-pip.py
  85
  86
  87
  88 Getting Started
  89 ---------------
  90
  91 This section will describe how to run a simple "Hello World" example.
  92
  93 First, provide ARIA with the ARIA "hello world" service-template and name it (e.g.
  94 ``my-service-template``)::
  95
  96     aria service-templates store examples/hello-world/hello-world.yaml my-service-template
  97
  98 Now create a service based on this service-template and name it (e.g. ``my-service``)::
  99
 100     aria services create my-service -t my-service-template
 101
 102 Finally, start an ``install`` workflow execution on ``my-service`` like so::
 103
 104     aria executions start install -s my-service
 105
 106 You should now have a simple web-server running on your local machine. You can try visiting
 107 ``http://localhost:9090`` to view your deployed application.
 108
 109 To uninstall and clean your environment, follow these steps::
 110
 111     aria executions start uninstall -s my-service
 112     aria services delete my-service
 113     aria service-templates delete my-service-template
 114
 115
 116 Contribution
 117 ------------
 118
 119 You are welcome and encouraged to participate and contribute to the ARIA project.
 120
 121 Please see our guide to
 122 `Contributing to ARIA
 123 <https://cwiki.apache.org/confluence/display/ARIATOSCA/Contributing+to+ARIA>`__.
 124
 125 Feel free to also provide feedback on the mailing lists (see `Resources <#user-content-resources>`__
 126 section).
 127
 128
 129 Resources
 130 ---------
 131
 132 - `ARIA homepage <http://ariatosca.incubator.apache.org/>`__
 133 - `ARIA wiki <https://cwiki.apache.org/confluence/display/AriaTosca>`__
 134 -  `Issue tracker <https://issues.apache.org/jira/browse/ARIA>`__
 135
 136 - Dev mailing list: dev@ariatosca.incubator.apache.org
 137 - User mailing list: user@ariatosca.incubator.apache.org
 138
 139 Subscribe by sending a mail to ``<group>-subscribe@ariatosca.incubator.apache.org`` (e.g.
 140 ``dev-subscribe@ariatosca.incubator.apache.org``). See information on how to subscribe to mailing
 141 lists `here <https://www.apache.org/foundation/mailinglists.html>`__.
 142
 143 For past correspondence, see the
 144 `dev mailing list archive <https://lists.apache.org/list.html?dev@ariatosca.apache.org>`__.
 145
 146
 147 License
 148 -------
 149
 150 ARIA is licensed under the
 151 `Apache License 2.0 <https://github.com/apache/incubator-ariatosca/blob/master/LICENSE>`__.
 152
 153 .. |Build Status| image:: https://img.shields.io/travis/apache/incubator-ariatosca/master.svg
 154    :target: https://travis-ci.org/apache/incubator-ariatosca
 155 .. |Appveyor Build Status| image:: https://img.shields.io/appveyor/ci/ApacheSoftwareFoundation/incubator-ariatosca/master.svg
 156    :target: https://ci.appveyor.com/project/ApacheSoftwareFoundation/incubator-ariatosca/history
 157 .. |License| image:: https://img.shields.io/github/license/apache/incubator-ariatosca.svg
 158    :target: http://www.apache.org/licenses/LICENSE-2.0
 159 .. |PyPI release| image:: https://img.shields.io/pypi/v/apache-ariatosca.svg
 160    :target: https://pypi.python.org/pypi/apache-ariatosca
 161 .. |Python Versions| image:: https://img.shields.io/pypi/pyversions/apache-ariatosca.svg
 162 .. |Wheel| image:: https://img.shields.io/pypi/wheel/apache-ariatosca.svg
 163 .. |Contributors| image:: https://img.shields.io/github/contributors/apache/incubator-ariatosca.svg
 164 .. |Open Pull Requests| image:: https://img.shields.io/github/issues-pr/apache/incubator-ariatosca.svg
 165    :target: https://github.com/apache/incubator-ariatosca/pulls
 166 .. |Closed Pull Requests| image:: https://img.shields.io/github/issues-pr-closed-raw/apache/incubator-ariatosca.svg
 167    :target: https://github.com/apache/incubator-ariatosca/pulls?q=is%3Apr+is%3Aclosed