From 32ba6d4095e19015af84ae7bbf8a70fcdc0a1dd9 Mon Sep 17 00:00:00 2001 From: Christian Berendt Date: Tue, 27 Sep 2016 13:59:22 +0200 Subject: [PATCH] Improve README file for monitoring-for-openstack * add install instructions * fix description-file parameter in setup.cfg Change-Id: Ie8d229ad6ec01c0714b23b46026ae941c8a42465 --- monitoring-for-openstack/README.rst | 24 ++++++++++++++++++++++-- monitoring-for-openstack/setup.cfg | 2 +- 2 files changed, 23 insertions(+), 3 deletions(-) diff --git a/monitoring-for-openstack/README.rst b/monitoring-for-openstack/README.rst index 7b98860..d626c7b 100644 --- a/monitoring-for-openstack/README.rst +++ b/monitoring-for-openstack/README.rst @@ -1,5 +1,25 @@ ======================== -monitoring-for-openstack +Monitoring for OpenStack ======================== -Set of Python scripts to help monitoring of OpenStack services. +This is a set of Python scripts to help with the monitoring of +OpenStack services. + +Installation +============ + +* Clone the osops-tools-monitoring repository:: + + git clone https://github.com/openstack/osops-tools-monitoring + +* Change to the ``monitoring-for-openstack`` directory:: + + cd osops-tools-monitoring/monitoring-for-openstack + +* Install the requirements:: + + pip install -r requirements.txt + +* Install the ``monitoring-for-openstack`` scripts:: + + python setup.py install diff --git a/monitoring-for-openstack/setup.cfg b/monitoring-for-openstack/setup.cfg index 4116cd6..a333aa8 100644 --- a/monitoring-for-openstack/setup.cfg +++ b/monitoring-for-openstack/setup.cfg @@ -2,7 +2,7 @@ name = monitoring-for-openstack version = 1.0.1 summary = OpenStack monitoring tools -description-file = README.md +description-file = README.rst author = OpenStack author-email = openstack-dev@lists.openstack.org classifier =