3640fc4a0b
Following the change in Watcher, this patchset updates the Watcher CLI to support this change. Also it updates README.rst to pass python 3.4 ascii-tests. Change-Id: Idfcf99ee3d6b5b7342f1bbc4f726e6edd82fc77c Closes-Bug: #1548377 Related-Bug: #1554347
119 lines
3.0 KiB
ReStructuredText
119 lines
3.0 KiB
ReStructuredText
====================
|
|
python-watcherclient
|
|
====================
|
|
|
|
Client for resource optimization service for OpenStack.
|
|
|
|
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
|
|
* Wiki: http://wiki.openstack.org/wiki/Watcher
|
|
* Source: http://git.openstack.org/cgit/openstack/python-watcher
|
|
* Bugs: http://bugs.launchpad.net/watcher
|
|
|
|
Installation
|
|
============
|
|
|
|
Install the prerequisite packages
|
|
---------------------------------
|
|
|
|
On Ubuntu (tested on 14.04-64)
|
|
|
|
.. code::
|
|
|
|
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)
|
|
|
|
.. code::
|
|
|
|
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)
|
|
|
|
.. code::
|
|
|
|
sudo zypper install gcc git libmysqlclient-devel libopenssl-devel postgresql-devel python-devel python-pip
|
|
|
|
Install the Watcher client
|
|
--------------------------
|
|
|
|
You can install the Watcher CLI with the following command:
|
|
|
|
.. code::
|
|
|
|
pip install python-watcherclient
|
|
|
|
|
|
Configuration
|
|
=============
|
|
|
|
Create a **creds** file containing your Openstack credentials:
|
|
|
|
.. code::
|
|
|
|
export OS_IDENTITY_API_VERSION=3
|
|
export OS_AUTH_URL=http://<your-keystone-server>:5000/v3
|
|
export OS_PROJECT_DOMAIN_ID=default
|
|
export OS_USER_DOMAIN_ID=default
|
|
export OS_USERNAME=admin
|
|
export OS_PASSWORD=<your-password>
|
|
export OS_PROJECT_NAME=<your-project-name>
|
|
|
|
Source these credentials into your current shell session:
|
|
|
|
.. code::
|
|
|
|
# source creds
|
|
|
|
You should be able to launch the following command which gets the list of previously created Audit Templates:
|
|
|
|
.. code::
|
|
|
|
# watcher audit-template-list
|
|
+------+------+
|
|
| UUID | Name |
|
|
+------+------+
|
|
+------+------+
|
|
|
|
You can view the entire list of available Watcher commands and options using this command:
|
|
|
|
.. code::
|
|
|
|
# watcher help
|
|
|
|
|
|
Troubleshootings
|
|
================
|
|
|
|
If any watcher command fails, you can obtain more details with the **--debug** option :
|
|
|
|
.. code::
|
|
|
|
# watcher --debug audit-template-list
|
|
|
|
Install the openstack CLI :
|
|
|
|
.. code::
|
|
|
|
# pip install python-openstackclient
|
|
|
|
Make sure that your Openstack credentials are correct. If so, you should be able to verify that the watcher user has been declared in your Openstack keystone :
|
|
|
|
.. code::
|
|
|
|
# openstack user list
|
|
|
|
and that the watcher endpoints have been declared as well :
|
|
|
|
.. code::
|
|
|
|
# openstack endpoint list
|