From 80efd5ac6b9f1e9d58f057f2435db3dd5a2da2f8 Mon Sep 17 00:00:00 2001
From: raigax9 <nishad.shah@att.com>
Date: Fri, 3 Nov 2017 15:18:02 -0400
Subject: [PATCH] Updated README for ranger and added tempest and debian
 directories

Added instructions for setting up ranger as well as added both the
tempest and debian package directories.

Change-Id: I67013aa175280ee1ce08a14b59eb4531ce9bc722
---
 README.rst                    | 57 +++++++++++++++++++++++++++++++----
 debian/test.txt               |  1 +
 ranger_tempest_tests/test.txt |  1 +
 3 files changed, 53 insertions(+), 6 deletions(-)
 create mode 100644 debian/test.txt
 create mode 100644 ranger_tempest_tests/test.txt

diff --git a/README.rst b/README.rst
index c8a88e05..442649c4 100644
--- a/README.rst
+++ b/README.rst
@@ -1,13 +1,58 @@
 ===============================
-orm
+Ranger
 ===============================
 
-Openstack  Resource Management
+Ranger is an OpenStack Resource Management tool capable of managing different types of clouds into one platform. Here are the following of what it provides:
+	- Multi-region common resource management.
+	- Light weight, stateless and interface with external self-service portals.
+	- Runs on DCP.
+	- Resource agents will run on LCP to orchestrate and keep resources in sync from a centralized repository.
 
-* TODO
+Devstack Installation
+---------------------
+1. You can include ranger repository in `local.conf` when running devstack.
+	`enable_plugin ranger git://git.openstack.org/openstack/ranger`
 
-Features
---------
+2. Make sure `MYSQL_PASSWORD` is included for creating and accessing the database.
 
-* TODO
+Before Setting Up
+-----------------
 
+Make sure ranger-agent is running before installing and running ranger since that
+is required for connecting with Openstack.
+
+Generate ranger.conf file
+-------------------------
+
+$tox -e genconfig
+
+A blank configuration file will be generated at etc/ranger.conf
+
+Installation
+------------
+
+1. Clone the repo and go to the `tools` directory.
+  $ `git clone https://git.openstack.org/openstack/ranger`
+  $ `cd ranger/tools`
+2. To make changes to the port numbers and other configurations, please go to `base_config.py` under the `orm` folder before continuing to the next steps.
+3. Run `./ranger_create_db.sh` to create the database.
+4. Run `./setup_apache.sh` to create conf files for each of the services to apache.
+5. Run `stack_orm.sh` to run ranger.
+6. If `stack_orm.sh` is not running properly, please do the following:
+	1. Go to the root of ranger.
+	2. `sudo pip install -r requirements.txt`
+	3. `sudo python setup.py develop 2>&1 | tee $root_dir/tools/install.log`
+
+Running Ranger Services
+-----------------------
+
+To run each of the services, type in these commands in order to run each of the services.
+	- Audit: `orm-audit`
+	- Uuidgen: `orm-uuidgen`
+	- RDS (Resource Distributor Service): `orm-rds`
+	- RMS (Resource Management Service): `orm-rms`
+	- FMS (Flavor Management Service): `orm-fms`
+	- CMS (Customer Management Service): `orm-cms`
+	- IMS (Image Management Service): `orm-ims`
+
+For RMS, FMS, CMS, and IMS to be running, Audit, Uuidgen, and RDS must also be running properly as well in order to use them.
diff --git a/debian/test.txt b/debian/test.txt
new file mode 100644
index 00000000..9daeafb9
--- /dev/null
+++ b/debian/test.txt
@@ -0,0 +1 @@
+test
diff --git a/ranger_tempest_tests/test.txt b/ranger_tempest_tests/test.txt
new file mode 100644
index 00000000..9daeafb9
--- /dev/null
+++ b/ranger_tempest_tests/test.txt
@@ -0,0 +1 @@
+test