94f10da25e
Change ID Ie027df023e6133f3188e57b42846083f28c282bd integrated the oslo_messaging_rabbit configuration into Watcher. This commit is an update of the Watcher configuration documentation section, to take into account new parameters for messaging RabbitMQ broker. Change-Id: I9aa60c7dd264b4e8535e41ae2f98083985b87b0f
303 lines
11 KiB
ReStructuredText
303 lines
11 KiB
ReStructuredText
..
|
|
|
|
===================
|
|
Configuring Watcher
|
|
===================
|
|
|
|
This document is continually updated and reflects the latest
|
|
available code of the Watcher service.
|
|
|
|
Service overview
|
|
================
|
|
|
|
The Watcher system is a collection of services that provides support to
|
|
optimize your IAAS plateform. The Watcher service may, depending upon
|
|
configuration, interact with several other OpenStack services. This includes:
|
|
|
|
- the OpenStack Identity service (`keystone`_) for request authentication and
|
|
to locate other OpenStack services
|
|
- the OpenStack Telemetry service (`ceilometer`_) for consuming the resources
|
|
metrics
|
|
- the OpenStack Compute service (`nova`_) works with the Watcher service and
|
|
acts as a user-facing API for instance migration.
|
|
|
|
The Watcher service includes the following components:
|
|
|
|
- ``watcher-decision-engine``: runs audit on part of your IAAS and return an
|
|
action plan in order to optimize resource placement.
|
|
- ``watcher-api``: A RESTful API that processes application requests by sending
|
|
them to the watcher-decision-engine over RPC.
|
|
- ``watcher-applier``: applies the action plan.
|
|
- `python-watcherclient`_: A command-line interface (CLI) for interacting with
|
|
the Watcher service.
|
|
|
|
Additionally, the Bare Metal service has certain external dependencies, which
|
|
are very similar to other OpenStack services:
|
|
|
|
- A database to store audit and action plan information and state. You can set
|
|
the database back-end type and location.
|
|
- A queue. A central hub for passing messages, such as `RabbitMQ`_.
|
|
|
|
Optionally, one may wish to utilize the following associated projects for
|
|
additional functionality:
|
|
|
|
- `watcher metering`_: an alternative to collect and push metrics to the
|
|
Telemetry service.
|
|
|
|
.. _`keystone`: https://github.com/openstack/keystone
|
|
.. _`ceilometer`: https://github.com/openstack/ceilometer
|
|
.. _`nova`: https://github.com/openstack/nova
|
|
.. _`python-watcherclient`: https://github.com/openstack/python-watcherclient
|
|
.. _`watcher metering`: https://github.com/b-com/watcher-metering
|
|
.. _`RabbitMQ`: https://www.rabbitmq.com/
|
|
|
|
Install and configure prerequisites
|
|
===================================
|
|
|
|
You can configure Watcher services to run on separate nodes or the same node.
|
|
In this guide, the components run on one node, typically the Controller node.
|
|
|
|
This section shows you how to install and configure the services.
|
|
|
|
It assumes that the Identity, Image, Compute, and Networking services
|
|
have already been set up.
|
|
|
|
.. _identity-service_configuration:
|
|
|
|
Configure the Identity service for the Watcher service
|
|
------------------------------------------------------
|
|
|
|
#. Create the Watcher service user (eg ``watcher``). The service uses this to
|
|
authenticate with the Identity Service. Use the
|
|
``KEYSTONE_SERVICE_PROJECT_NAME`` project (named ``service`` by default in
|
|
devstack) and give the user the ``admin`` role:
|
|
|
|
.. code-block:: bash
|
|
|
|
$ keystone user-create --name=watcher --pass=WATCHER_PASSWORD \
|
|
--email=watcher@example.com \
|
|
--tenant=KEYSTONE_SERVICE_PROJECT_NAME
|
|
$ keystone user-role-add --user=watcher \
|
|
--tenant=KEYSTONE_SERVICE_PROJECT_NAME --role=admin
|
|
$ keystone user-role-add --user=watcher --tenant=admin --role=admin
|
|
|
|
or (by using python-openstackclient 1.8.0+)
|
|
|
|
.. code-block:: bash
|
|
|
|
$ openstack user create --password WATCHER_PASSWORD --enable \
|
|
--email watcher@example.com watcher \
|
|
--project=KEYSTONE_SERVICE_PROJECT_NAME
|
|
$ openstack role add --project KEYSTONE_SERVICE_PROJECT_NAME \
|
|
--user watcher admin
|
|
$ openstack role add --user watcher --project admin admin
|
|
|
|
|
|
#. You must register the Watcher Service with the Identity Service so that
|
|
other OpenStack services can locate it. To register the service:
|
|
|
|
.. code-block:: bash
|
|
|
|
$ keystone service-create --name=watcher --type=infra-optim \
|
|
--description="Infrastructure Optimization service"
|
|
|
|
or (by using python-openstackclient 1.8.0+)
|
|
|
|
.. code-block:: bash
|
|
|
|
$ openstack service create --name watcher infra-optim \
|
|
--description="Infrastructure Optimization service"
|
|
|
|
#. Create the endpoints by replacing YOUR_REGION and
|
|
``WATCHER_API_[PUBLIC|ADMIN|INTERNAL]_IP`` with your region and your
|
|
Watcher Service's API node IP addresses (or FQDN):
|
|
|
|
.. code-block:: bash
|
|
|
|
$ keystone endpoint-create \
|
|
--service-id=the_service_id_above \
|
|
--publicurl=http://WATCHER_API_PUBLIC_IP:9322 \
|
|
--internalurl=http://WATCHER_API_INTERNAL_IP:9322 \
|
|
--adminurl=http://WATCHER_API_ADMIN_IP:9322
|
|
|
|
or (by using python-openstackclient 1.8.0+)
|
|
|
|
.. code-block:: bash
|
|
|
|
$ openstack endpoint create --region YOUR_REGION watcher \
|
|
--publicurl http://WATCHER_API_PUBLIC_IP:9322 \
|
|
--internalurl http://WATCHER_API_INTERNAL_IP:9322 \
|
|
--adminurl http://WATCHER_API_ADMIN_IP:9322
|
|
|
|
.. _watcher-db_configuration:
|
|
|
|
Set up the database for Watcher
|
|
-------------------------------
|
|
|
|
The Watcher service stores information in a database. This guide uses the
|
|
MySQL database that is used by other OpenStack services.
|
|
|
|
#. In MySQL, create a ``watcher`` database that is accessible by the
|
|
``watcher`` user. Replace WATCHER_DBPASSWORD
|
|
with the actual password::
|
|
|
|
$ mysql -u root -p
|
|
|
|
mysql> CREATE DATABASE watcher CHARACTER SET utf8;
|
|
mysql> GRANT ALL PRIVILEGES ON watcher.* TO 'watcher'@'localhost' \
|
|
IDENTIFIED BY 'WATCHER_DBPASSWORD';
|
|
mysql> GRANT ALL PRIVILEGES ON watcher.* TO 'watcher'@'%' \
|
|
IDENTIFIED BY 'WATCHER_DBPASSWORD';
|
|
|
|
|
|
Configure the Watcher service
|
|
=============================
|
|
|
|
The Watcher service is configured via its configuration file. This file
|
|
is typically located at ``/etc/watcher/watcher.conf``.
|
|
|
|
The configuration file is organized into the following sections:
|
|
|
|
* ``[DEFAULT]`` - General configuration
|
|
* ``[api]`` - API server configuration
|
|
* ``[database]`` - SQL driver configuration
|
|
* ``[keystone_authtoken]`` - Keystone Authentication plugin configuration
|
|
* ``[watcher_applier]`` - Watcher Applier module configuration
|
|
* ``[watcher_decision_engine]`` - Watcher Decision Engine module configuration
|
|
* ``[watcher_goals]`` - Goals mapping configuration
|
|
* ``[watcher_strategies]`` - Strategy configuration
|
|
* ``[oslo_messaging_rabbit]`` - Oslo Messaging RabbitMQ driver configuration
|
|
|
|
The Watcher configuration file is expected to be named
|
|
``watcher.conf``. When starting Watcher, you can specify a different
|
|
configuration file to use with ``--config-file``. If you do **not** specify a
|
|
configuration file, Watcher will look in the following directories for a
|
|
configuration file, in order:
|
|
|
|
* ``~/.watcher/``
|
|
* ``~/``
|
|
* ``/etc/watcher/``
|
|
* ``/etc/``
|
|
|
|
|
|
Although some configuration options are mentioned here, it is recommended that
|
|
you review all the `available options
|
|
<https://git.openstack.org/cgit/openstack/watcher/tree/etc/watcher/watcher.conf.sample>`_
|
|
so that the watcher service is configured for your needs.
|
|
|
|
#. The Watcher Service stores information in a database. This guide uses the
|
|
MySQL database that is used by other OpenStack services.
|
|
|
|
Configure the location of the database via the ``connection`` option. In the
|
|
following, replace WATCHER_DBPASSWORD with the password of your ``watcher``
|
|
user, and replace DB_IP with the IP address where the DB server is located::
|
|
|
|
[database]
|
|
...
|
|
|
|
# The SQLAlchemy connection string used to connect to the
|
|
# database (string value)
|
|
#connection=<None>
|
|
connection = mysql://watcher:WATCHER_DBPASSWORD@DB_IP/watcher?charset=utf8
|
|
|
|
#. Configure the Watcher Service to use the RabbitMQ message broker by
|
|
setting one or more of these options. Replace RABBIT_HOST with the
|
|
IP address of the RabbitMQ server, RABBITMQ_USER and RABBITMQ_PASSWORD
|
|
by the RabbitMQ server login credentials ::
|
|
|
|
[DEFAULT]
|
|
|
|
# The messaging driver to use, defaults to rabbit. Other drivers
|
|
# include qpid and zmq. (string value)
|
|
#rpc_backend = rabbit
|
|
|
|
# The default exchange under which topics are scoped. May be
|
|
# overridden by an exchange name specified in the transport_url
|
|
# option. (string value)
|
|
control_exchange = watcher
|
|
|
|
...
|
|
|
|
[oslo_messaging_rabbit]
|
|
|
|
# The username used by the message broker (string value)
|
|
rabbit_userid = RABBITMQ_USER
|
|
|
|
# The password of user used by the message broker (string value)
|
|
rabbit_password = RABBITMQ_PASSWORD
|
|
|
|
# The host where the message brokeris installed (string value)
|
|
rabbit_host = RABBIT_HOST
|
|
|
|
# The port used bythe message broker (string value)
|
|
#rabbit_port = 5672
|
|
|
|
|
|
#. Configure the Watcher Service to use these credentials with the Identity
|
|
Service. Replace IDENTITY_IP with the IP of the Identity server, and
|
|
replace WATCHER_PASSWORD with the password you chose for the ``watcher``
|
|
user in the Identity Service::
|
|
|
|
[keystone_authtoken]
|
|
|
|
# Complete public Identity API endpoint (string value)
|
|
#auth_uri=<None>
|
|
auth_uri=http://IDENTITY_IP:5000/v3
|
|
|
|
# Complete admin Identity API endpoint. This should specify the
|
|
# unversioned root endpoint e.g. https://localhost:35357/ (string
|
|
# value)
|
|
#identity_uri = <None>
|
|
identity_uri = http://IDENTITY_IP:5000
|
|
|
|
# Keystone account username (string value)
|
|
#admin_user=<None>
|
|
admin_user=watcher
|
|
|
|
# Keystone account password (string value)
|
|
#admin_password=<None>
|
|
admin_password=WATCHER_DBPASSWORD
|
|
|
|
# Keystone service account tenant name to validate user tokens
|
|
# (string value)
|
|
#admin_tenant_name=admin
|
|
admin_tenant_name=KEYSTONE_SERVICE_PROJECT_NAME
|
|
|
|
# Directory used to cache files related to PKI tokens (string
|
|
# value)
|
|
#signing_dir=<None>
|
|
|
|
#. Create the Watcher Service database tables::
|
|
|
|
$ watcher-db-manage --config-file /etc/watcher/watcher.conf create_schema
|
|
|
|
#. Start the Watcher Service::
|
|
|
|
$ watcher-api && watcher-decision-engine && watcher-applier
|
|
|
|
Configure Nova compute
|
|
======================
|
|
|
|
Please check your hypervisor configuration to correctly handle
|
|
`instance migration`_.
|
|
|
|
.. _`instance migration`: http://docs.openstack.org/admin-guide-cloud/compute-configuring-migrations.html
|
|
|
|
Configure Ceilometer
|
|
====================
|
|
|
|
The default strategy 'basic_consolidation' provided by watcher requires
|
|
Ceilometer to collect the "compute.node.cpu.*." and "cpu_util" measurements
|
|
|
|
#. Add/Update the following lines into the /etc/nova/nova.conf configuration file:
|
|
|
|
|
|
.. code-block:: bash
|
|
|
|
$ compute_available_monitors=nova.compute.monitors.all_monitors
|
|
$ compute_monitors=ComputeDriverCPUMonitor
|
|
|
|
#. Restart the Nova compute service and the Nova scheduler after completing the above configuration.
|
|
|
|
#. For more information: `Integrating your metrics plug-in with Nova <http://www-01.ibm.com/support/knowledgecenter/SS8MU9_2.2.0/Admin/tasks/integratingplugin.dita>`_
|