{"id":20111813,"url":"https://github.com/openstack/python-watcherclient","last_synced_at":"2025-09-03T17:42:54.571Z","repository":{"id":32893502,"uuid":"36488036","full_name":"openstack/python-watcherclient","owner":"openstack","description":"Client for resource optimization service for OpenStack. Mirror of code maintained at opendev.org.","archived":false,"fork":false,"pushed_at":"2024-05-08T14:56:49.000Z","size":645,"stargazers_count":18,"open_issues_count":0,"forks_count":1,"subscribers_count":9,"default_branch":"master","last_synced_at":"2024-05-09T18:50:23.188Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://opendev.org/openstack/python-watcherclient","language":"Python","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":"aspnet/Antiforgery","license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/openstack.png","metadata":{"files":{"readme":"README.rst","changelog":null,"contributing":"CONTRIBUTING.rst","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2015-05-29T07:17:06.000Z","updated_at":"2024-05-09T18:50:23.189Z","dependencies_parsed_at":"2024-02-10T09:28:07.414Z","dependency_job_id":"eabfbf8a-859e-4742-b270-34b905ca4768","html_url":"https://github.com/openstack/python-watcherclient","commit_stats":null,"previous_names":[],"tags_count":58,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openstack%2Fpython-watcherclient","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openstack%2Fpython-watcherclient/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openstack%2Fpython-watcherclient/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openstack%2Fpython-watcherclient/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/openstack","download_url":"https://codeload.github.com/openstack/python-watcherclient/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":224499851,"owners_count":17321605,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-13T18:17:47.448Z","updated_at":"2024-11-13T18:17:47.962Z","avatar_url":"https://github.com/openstack.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"========================\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 \u003chttps://docs.openstack.org/python-openstackclient/latest/\u003e`_\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://\u003cyour-keystone-server\u003e: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=\u003cyour-password\u003e\n   export OS_PROJECT_NAME=\u003cyour-project-name\u003e\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","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenstack%2Fpython-watcherclient","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fopenstack%2Fpython-watcherclient","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenstack%2Fpython-watcherclient/lists"}