21b106dc15
Switch to openstackdocstheme 2.2.0. Using the version will allow especially: * Linking from HTML to PDF document * Allow parallel building of documents * Fix some rendering problems Update Sphinx version as well. Set openstackdocs_pdf_link to link to PDF file. Note that the link to the published document only works on docs.openstack.org where the PDF file is placed in the top-level html directory. The site-preview places the PDF in a pdf directory. Remove docs requirements from lower-constraints, they are not needed during install or test but only for docs building. openstackdocstheme renames some variables, so follow the renames before the next release removes them. A couple of variables are also not needed anymore, remove them. Change pygments_style to 'native' since old theme version always used 'native' and the theme now respects the setting and using 'sphinx' can lead to some strange rendering. See also http://lists.openstack.org/pipermail/openstack-discuss/2020-May/014971.html Change-Id: I58edf52ff891328b14edecc9e6e990b34cb730b7 |
||
---|---|---|
doc | ||
releasenotes/notes | ||
tools | ||
watcherclient | ||
.coveragerc | ||
.gitignore | ||
.gitreview | ||
.stestr.conf | ||
.zuul.yaml | ||
CONTRIBUTING.rst | ||
HACKING.rst | ||
LICENSE | ||
lower-constraints.txt | ||
README.rst | ||
requirements.txt | ||
setup.cfg | ||
setup.py | ||
test-requirements.txt | ||
tox.ini |
Team and repository tags
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: https://wiki.openstack.org/wiki/Watcher
- Source: https://opendev.org/openstack/python-watcherclient
- Bugs: https://bugs.launchpad.net/watcher
Installation
Install the prerequisite packages
On Ubuntu (tested on 14.04-64)
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)
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)
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:
sudo pip install python-watcherclient
You can also use the OpenStack client with Watcher (our watcher plugin for OpenStack client is included in the python-watcherclient package). To install it, you have just to run this command:
sudo pip install python-openstackclient
Configuration
Create a creds file containing your OpenStack credentials:
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:
# source creds
You should be able to launch the following command which gets the list of previously created Audit Templates:
# watcher audittemplate list
or:
# openstack optimize audittemplate list
+--------------------------------+------+----------------------+----------+
| UUID | Name | Goal | Strategy |
+--------------------------------+------+----------------------+----------+
+--------------------------------+------+----------------------+----------+
You can view the entire list of available Watcher commands and options using this command:
# watcher help
or:
# openstack help optimize
Troubleshootings
If any watcher command fails, you can obtain more details with the --debug option :
# watcher --debug audittemplate list
or:
# openstack --debug optimize audittemplate list
Install the openstack CLI :
# 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 :
# openstack user list
and that the watcher endpoints have been declared as well :
# openstack endpoint list