python-watcherclient


Namepython-watcherclient JSON
Version 4.4.0 PyPI version JSON
download
home_pagehttps://docs.openstack.org/python-watcherclient/latest/
SummaryPython client library for Watcher API
upload_time2024-03-08 15:12:37
maintainer
docs_urlNone
authorOpenStack
requires_python>=3.8
license
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            ========================
Team and repository tags
========================

.. image:: https://governance.openstack.org/tc/badges/python-watcherclient.svg
    :target: https://governance.openstack.org/tc/reference/tags/index.html

.. Change things from this point on

====================
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)

.. 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::

   sudo pip install python-watcherclient


You can also use the `OpenStack client <https://docs.openstack.org/python-openstackclient/latest/>`_
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:

.. code::

   sudo pip install python-openstackclient

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 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:

.. code::

   # watcher help

or::

   # openstack help optimize


Troubleshootings
================

If any watcher command fails, you can obtain more details with the **--debug**
option :

.. code::

   # watcher --debug audittemplate list

or::

   # openstack --debug optimize audittemplate 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




            

Raw data

            {
    "_id": null,
    "home_page": "https://docs.openstack.org/python-watcherclient/latest/",
    "name": "python-watcherclient",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": "",
    "keywords": "",
    "author": "OpenStack",
    "author_email": "openstack-discuss@lists.openstack.org",
    "download_url": "https://files.pythonhosted.org/packages/d0/c0/88ee30e2cc9211c0830ad035739e0218ed7e8028d71c193c274208f46cb9/python-watcherclient-4.4.0.tar.gz",
    "platform": null,
    "description": "========================\nTeam and repository tags\n========================\n\n.. image:: https://governance.openstack.org/tc/badges/python-watcherclient.svg\n    :target: https://governance.openstack.org/tc/reference/tags/index.html\n\n.. Change things from this point on\n\n====================\npython-watcherclient\n====================\n\nClient for resource optimization service for OpenStack.\n\nOpenStack Watcher provides a flexible and scalable resource optimization\nservice for multi-tenant OpenStack-based clouds.\nWatcher provides a complete optimization loop-including everything from a\nmetrics receiver, complex event processor and profiler, optimization processor\nand an action plan applier. This provides a robust framework to realize a wide\nrange of cloud optimization goals, including the reduction of data center\noperating costs, increased system performance via intelligent virtual machine\nmigration, increased energy efficiency and more!\n\n* Free software: Apache license\n* Wiki: https://wiki.openstack.org/wiki/Watcher\n* Source: https://opendev.org/openstack/python-watcherclient\n* Bugs: https://bugs.launchpad.net/watcher\n\nInstallation\n============\n\nInstall the prerequisite packages\n---------------------------------\n\nOn Ubuntu (tested on 14.04-64)\n\n.. code::\n\n   sudo apt-get install python-dev libssl-dev python-pip git-core libmysqlclient-dev libffi-dev\n\nOn Fedora-based distributions e.g., Fedora/RHEL/CentOS/Scientific Linux (tested on CentOS 6.5)\n\n.. code::\n\n   sudo yum install python-virtualenv openssl-devel python-pip git gcc libffi-devel mysql-devel postgresql-devel\n\nOn openSUSE-based distributions (SLES 12, openSUSE 13.1, Factory or Tumbleweed)\n\n.. code::\n\n   sudo zypper install gcc git libmysqlclient-devel libopenssl-devel postgresql-devel python-devel python-pip\n\nInstall the Watcher client\n--------------------------\n\nYou can install the Watcher CLI with the following command:\n\n.. code::\n\n   sudo pip install python-watcherclient\n\n\nYou can also use the `OpenStack client <https://docs.openstack.org/python-openstackclient/latest/>`_\nwith Watcher (our watcher plugin for OpenStack client is included in the\npython-watcherclient package). To install it, you have just to run this command:\n\n.. code::\n\n   sudo pip install python-openstackclient\n\nConfiguration\n=============\n\nCreate a **creds** file containing your OpenStack credentials:\n\n.. code::\n\n   export OS_IDENTITY_API_VERSION=3\n   export OS_AUTH_URL=http://<your-keystone-server>:5000/v3\n   export OS_PROJECT_DOMAIN_ID=default\n   export OS_USER_DOMAIN_ID=default\n   export OS_USERNAME=admin\n   export OS_PASSWORD=<your-password>\n   export OS_PROJECT_NAME=<your-project-name>\n\nSource these credentials into your current shell session:\n\n.. code::\n\n   # source creds\n\nYou should be able to launch the following command which gets the list of\npreviously created Audit Templates:\n\n.. code::\n\n   # watcher audittemplate list\n\nor::\n\n   # openstack optimize audittemplate list\n   +--------------------------------+------+----------------------+----------+\n   | UUID                           | Name | Goal                 | Strategy |\n   +--------------------------------+------+----------------------+----------+\n   +--------------------------------+------+----------------------+----------+\n\n\nYou can view the entire list of available Watcher commands and options using\nthis command:\n\n.. code::\n\n   # watcher help\n\nor::\n\n   # openstack help optimize\n\n\nTroubleshootings\n================\n\nIf any watcher command fails, you can obtain more details with the **--debug**\noption :\n\n.. code::\n\n   # watcher --debug audittemplate list\n\nor::\n\n   # openstack --debug optimize audittemplate list\n\n\nInstall the openstack CLI :\n\n.. code::\n\n   # pip install python-openstackclient\n\nMake sure that your Openstack credentials are correct. If so, you should be able\nto verify that the watcher user has been declared in your Openstack keystone :\n\n.. code::\n\n   # openstack user list\n\nand that the watcher endpoints have been declared as well :\n\n.. code::\n\n   # openstack endpoint list\n\n\n\n",
    "bugtrack_url": null,
    "license": "",
    "summary": "Python client library for Watcher API",
    "version": "4.4.0",
    "project_urls": {
        "Homepage": "https://docs.openstack.org/python-watcherclient/latest/"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "57c897056ee2425674fe4bafdf983ca6c379d5b095ec0577219efade9aaf4f45",
                "md5": "7f9c5a51c2d584f4cba89bee43daf99b",
                "sha256": "6fc826ee8c7f75f98da970d429ffb62755d527a47b6865805aa597df0806fc9a"
            },
            "downloads": -1,
            "filename": "python_watcherclient-4.4.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "7f9c5a51c2d584f4cba89bee43daf99b",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 125588,
            "upload_time": "2024-03-08T15:12:35",
            "upload_time_iso_8601": "2024-03-08T15:12:35.860057Z",
            "url": "https://files.pythonhosted.org/packages/57/c8/97056ee2425674fe4bafdf983ca6c379d5b095ec0577219efade9aaf4f45/python_watcherclient-4.4.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "d0c088ee30e2cc9211c0830ad035739e0218ed7e8028d71c193c274208f46cb9",
                "md5": "fdeec2214d3e8a78ed392f1d92b12804",
                "sha256": "2feb80612d404cc7d6cbf5f8b9c86913c3ab6a74ef8139428b16fcdec27c0fd4"
            },
            "downloads": -1,
            "filename": "python-watcherclient-4.4.0.tar.gz",
            "has_sig": false,
            "md5_digest": "fdeec2214d3e8a78ed392f1d92b12804",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 86842,
            "upload_time": "2024-03-08T15:12:37",
            "upload_time_iso_8601": "2024-03-08T15:12:37.475152Z",
            "url": "https://files.pythonhosted.org/packages/d0/c0/88ee30e2cc9211c0830ad035739e0218ed7e8028d71c193c274208f46cb9/python-watcherclient-4.4.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-03-08 15:12:37",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "python-watcherclient"
}
        
Elapsed time: 0.23376s