refactoring documentation
Change-Id: I47ac167a3d96497fe4211e8a24ec97d0d32db35c
This commit is contained in:
David TARDIVEL
265
doc/source/deploy/configuration.rst
Normal file
265
doc/source/deploy/configuration.rst
Normal file
@@ -0,0 +1,265 @@
|
||||
..
|
||||
|
||||
===================
|
||||
Configuring Watcher
|
||||
===================
|
||||
|
||||
This document is continually updated and reflects the latest
|
||||
available code of the Watcher service.
|
||||
|
||||
Service overview
|
||||
================
|
||||
|
||||
The Watcher service is a collection of modules 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 module (`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 of Ceilometer project to collect real-time metering data.
|
||||
|
||||
.. _`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 modules 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 modules.
|
||||
|
||||
It assumes that the Identity, Image, Compute, and Networking services
|
||||
have already been set up.
|
||||
|
||||
|
||||
|
||||
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 ``service`` project and
|
||||
give the user the ``admin`` role:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
$ keystone user-create --name=watcher --pass=WATCHER_PASSWORD --email=watcher@example.com
|
||||
$ keystone user-role-add --user=watcher --tenant=service --role=admin
|
||||
$ keystone user-role-add --user=watcher --tenant=admin --role=admin
|
||||
|
||||
or
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
$ openstack user create --password WATCHER_PASSWORD --enable --email watcher@example.com watcher
|
||||
$ openstack role add --project services --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
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
$ openstack service create --name watcher infra-optim
|
||||
|
||||
#. Create the endpoints by replacing YOUR_REGION and WATCHER_API_IP with your region and your
|
||||
Watcher Service's API node IP address (or FQDN):
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
$ keystone endpoint-create \
|
||||
--service-id=the_service_id_above \
|
||||
--publicurl=http://WATCHER_API_IP:9322 \
|
||||
--internalurl=http://WATCHER_API_IP:9322 \
|
||||
--adminurl=http://WATCHER_API_IP:9322
|
||||
|
||||
or
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
$ openstack endpoint create --region YOUR_REGION watcher public http://WATCHER_API_IP:9322
|
||||
$ openstack endpoint create --region YOUR_REGION watcher admin http://WATCHER_API_IP:9322
|
||||
$ openstack endpoint create --region YOUR_REGION watcher internal http://WATCHER_API_IP:9322
|
||||
|
||||
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_influxdb_collector]`` - influxDB driver configuration
|
||||
* ``[watcher_messaging]`` -Messaging driver configuration
|
||||
* ``[watcher_metrics_collector]`` - Metric collector driver configuration
|
||||
* ``[watcher_metrics_collector]`` - Metric collector driver configuration
|
||||
* ``[watcher_strategies]`` - Strategy 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
|
||||
address of the RabbitMQ server.::
|
||||
|
||||
[DEFAULT]
|
||||
...
|
||||
# The RabbitMQ broker address where a single node is used
|
||||
# (string value)
|
||||
rabbit_host=RABBIT_HOST
|
||||
|
||||
# The RabbitMQ userid (string value)
|
||||
#rabbit_userid=guest
|
||||
|
||||
# The RabbitMQ password (string value)
|
||||
#rabbit_password=guest
|
||||
|
||||
# The RabbitMQ virtual host (string value)
|
||||
#rabbit_virtual_host=/
|
||||
|
||||
#. 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::
|
||||
|
||||
[DEFAULT]
|
||||
...
|
||||
# Method to use for authentication: noauth or keystone.
|
||||
# (string value)
|
||||
auth_strategy=keystone
|
||||
|
||||
...
|
||||
[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
|
||||
Reference in New Issue
Block a user