.. _installation: Quick 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 watcher modules from pip:: sudo pip install python-watcher Configure Watcher ================= Configure Identity Service for Watcher -------------------------------------- #. Create the Watcher service user (eg ``watcher``) and set a password. The service uses it to authenticate with the Identity Service. Set KEYSTONE_SERVICE_PROJECT_NAME, your Keystone `service project name`_ and give the user the ``admin`` role:: keystone user-create --name=watcher --pass=WATCHER_PASSWORD --email=watcher@example.com keystone user-role-add --user=watcher --tenant=KEYSTONE_SERVICE_PROJECT_NAME --role=admin or:: openstack user create --password WATCHER_PASSWORD --enable --email watcher@example.com watcher openstack role add --project services --user watcher admin #. You must register the Watcher Service with the Identity Service so that other OpenStack services can locate it. To register the service:: keystone service-create --name=watcher --type=infra-optim --description="Infrastructure Optimization service" or:: 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 URLs:: 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:: 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 .. _`service project name`: http://docs.openstack.org/developer/keystone/configuringservices.html 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 real 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``. You can copy the file ``etc/watcher/watcher.conf.sample`` from the GIT repo to your server and update it. Although some configuration options are mentioned here, it is recommended that you review all the available options 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= 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 address of the Keystone Identity server, KEYSTONE_SERVICE_PROJECT_NAME by the Keystone service project name, and 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= 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 = identity_uri = http://IDENTITY_IP:5000 # Keystone account username (string value) #admin_user= admin_user=watcher # Keystone account password (string value) #admin_password= admin_password=WATCHER_PASSWORD # 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= #. Create the Watcher Service database tables:: watcher-db-manage --config-file /etc/watcher/watcher.conf create_schema Development installation ======================== We propose different ways to quickly install Watcher for development: * `DevStack and Docker`_ * `Virtualenv`_ .. _DevStack and Docker: ./install-devstack-docker.rst .. _Virtualenv: ./virtualenv.rst