Update project maturity status
[multicloud/azure.git] / azure / aria / aria-extension-cloudify / README.md
1 ## Cloudify ARIA Extensions
2
3 This repository provides ARIA with support for running Cloudify-based plugins.
4 Using an adapter that serves as a translation layer between the Cloudify and ARIA APIs, ARIA is able to make use of plugins that were designed to work with Cloudify.
5 ### Installation
6
7 1. clone the repository
8
9 `git clone https://github.com/cloudify-cosmo/aria-extension-cloudify.git`
10
11 2. install the requirements:
12
13 `pip install -r requirements.txt`
14
15 3. install Cloudify ARIA extensions. This installs the adapter, and it should be done in the same environment in which ARIA is installed:
16
17 `pip install .`
18
19
20 4. (optional, for developing purposes) install the test requirements:
21
22 `pip install -r aria_extension_tests/requirements.txt`
23
24 Using the adapter, ARIA is expected to support any Cloudify plugin. However, depending on their implementation, some plugins may not work out-of-the-box with ARIA, and small adapter modifications may be need.
25
26 Specifically, The [Cloudify AWS Plugin](https://github.com/cloudify-cosmo/cloudify-aws-plugin) 1.4.10 and the [Cloudify Openstack Plugin](https://github.com/cloudify-cosmo/cloudify-openstack-plugin) 2.0.1 were explicitly translated and tested using the adapter. Newer versions are expected to work as well.
27
28 #### Installing a plugin
29 In order to use any Cloudify plugin, you'll need to install it using a `.wgn` ([wagon](https://github.com/cloudify-cosmo/wagon)) file. For CentOS or RHEL, you can obtain the plugin `.wgn` from the [Cloudify plugin downloads page](http://cloudify.co/downloads/plugin-packages.html).
30
31 After obtaining the `.wgn`, you can install the plugin:
32
33 `aria plugins install <path to .wgn>`
34
35 Another, more generic way, of obtaining a plugin `.wgn` is to create it from source. Here's an example, using the AWS plugin:
36
37 1. clone/download the Cloudify AWS Plugin:
38
39 `git clone https://github.com/cloudify-cosmo/cloudify-aws-plugin.git`
40
41 2. (optional) if you want to install a specific version of the plugin, checkout the corresponding tag.
42
43 `git checkout <version number>`
44
45 3. create a `.wgn` file from the repository:
46
47 `wagon create <path to plugin repository>`