openstack/python-watcherclient
Code Issues Proposed changes

Update Watcher documentation in README

Browse Source 
Update the header of the README to align
description with launchpad and pypi.

Change-Id: Id724c5b314d8ac9e72ebe7e661e8ab74d6483047
Related-Bug: #1527654
This commit is contained in:
Antoine Cabot
2016-01-14 12:20:39 +01:00
parent 740dcf7bc2
commit a0f97ee02b
1 changed files with 11 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
README.rst
View File

@@ -2,16 +2,22 @@
python-watcherclient python-watcherclient
==================== ====================
Python client library for Watcher API. Client for resource optimization service for OpenStack.
Watcher takes advantage of CEP and ML algorithms/metaheuristics to improve physical resources usage through better VM placement. Watcher can improve your cloud optimization by reducing energy footprint and increasing profits. OpenStack Watcher provides a flexible and scalable resource optimization
service for multi-tenant OpenStack-based clouds.
Watcher provides a complete optimization loop—including everything from a
metrics receiver, complex event processor and profiler, optimization processor
and an action plan applier. This provides a robust framework to realize a wide
range of cloud optimization goals, including the reduction of data center
operating costs, increased system performance via intelligent virtual machine
migration, increased energy efficiency—and more!
* Free software: Apache license * Free software: Apache license
* Wiki: http://wiki.openstack.org/wiki/Watcher * Wiki: http://wiki.openstack.org/wiki/Watcher
* Source: http://git.openstack.org/cgit/openstack/python-watcher * Source: http://git.openstack.org/cgit/openstack/python-watcher
* Bugs: http://bugs.launchpad.net/watcher * Bugs: http://bugs.launchpad.net/watcher
Installation Installation
============ ============
@@ -23,13 +29,13 @@ On Ubuntu (tested on 14.04-64)
.. code:: .. code::
sudo apt-get install python-dev libssl-dev python-pip git-core libmysqlclient-dev libffi-dev sudo apt-get install python-dev libssl-dev python-pip git-core libmysqlclient-dev libffi-dev
On Fedora-based distributions e.g., Fedora/RHEL/CentOS/Scientific Linux (tested on CentOS 6.5) On Fedora-based distributions e.g., Fedora/RHEL/CentOS/Scientific Linux (tested on CentOS 6.5)
.. code:: .. code::
sudo yum install python-virtualenv openssl-devel python-pip git gcc libffi-devel mysql-devel postgresql-devel sudo yum install python-virtualenv openssl-devel python-pip git gcc libffi-devel mysql-devel postgresql-devel
On openSUSE-based distributions (SLES 12, openSUSE 13.1, Factory or Tumbleweed) On openSUSE-based distributions (SLES 12, openSUSE 13.1, Factory or Tumbleweed)
.. code:: .. code::