Alexander Chadin c7ec186576 Adapt watcher documentation for new standards

This patch set makes the following changes:

 * Add index file to each subdirectory of doc/source
 * Update doc/source/index.rst with new links
 * Move content of install-guide to the doc/source/install
 * Minor changes

Depends-On: Ifc5512c0e2373cf3387e0e0498268eab092e52bb
Change-Id: Iecb4f60efb015a56b9b37331859848b287112842

2017-07-04 15:49:24 +03:00

5.3 KiB

Raw Blame History

Prerequisites

Before you install and configure the Infrastructure Optimization service, you must create a database, service credentials, and API endpoints.

Create the database, complete these steps:
- Use the database access client to connect to the database server as the root user:
```
$ mysql -u root -p
```
- Create the watcher database:
```
CREATE DATABASE watcher CHARACTER SET utf8;
```
- Grant proper access to the watcher database:
```
GRANT ALL PRIVILEGES ON watcher.* TO 'watcher'@'localhost' \
  IDENTIFIED BY 'WATCHER_DBPASS';
GRANT ALL PRIVILEGES ON watcher.* TO 'watcher'@'%' \
  IDENTIFIED BY 'WATCHER_DBPASS';
```
  Replace WATCHER_DBPASS with a suitable password.
- Exit the database access client.
```
exit;
```
Source the admin credentials to gain access to admin-only CLI commands:
```
$ . admin-openrc
```

To create the service credentials, complete these steps:

Create the watcher user:

$ openstack user create --domain default --password-prompt watcher
  User Password:
  Repeat User Password:
  +---------------------+----------------------------------+
  | Field               | Value                            |
  +---------------------+----------------------------------+
  | domain_id           | default                          |
  | enabled             | True                             |
  | id                  | b18ee38e06034b748141beda8fc8bfad |
  | name                | watcher                          |
  | options             | {}                               |
  | password_expires_at | None                             |
  +---------------------+----------------------------------+

Add the admin role to the watcher user:
```
$ openstack role add --project service --user watcher admin
```
Note

This command produces no output.

Create the watcher service entities:

$ openstack service create --name watcher --description "Infrastructure Optimization" infra-optim
  +-------------+----------------------------------+
  | Field       | Value                            |
  +-------------+----------------------------------+
  | description | Infrastructure Optimization      |
  | enabled     | True                             |
  | id          | d854f6fff0a64f77bda8003c8dedfada |
  | name        | watcher                          |
  | type        | infra-optim                      |
  +-------------+----------------------------------+

Create the Infrastructure Optimization service API endpoints:

$ openstack endpoint create --region RegionOne \
  infra-optim public http://controller:9322
  +-------------+----------------------------------+
  | Field       | Value                            |
  +-------------+----------------------------------+
  | description | Infrastructure Optimization      |
  | enabled     | True                             |
  | id          | d854f6fff0a64f77bda8003c8dedfada |
  | name        | watcher                          |
  | type        | infra-optim                      |
  +-------------+----------------------------------+

$ openstack endpoint create --region RegionOne \
  infra-optim internal http://controller:9322
  +--------------+----------------------------------+
  | Field        | Value                            |
  +--------------+----------------------------------+
  | enabled      | True                             |
  | id           | 225aef8465ef4df48a341aaaf2b0a390 |
  | interface    | internal                         |
  | region       | RegionOne                        |
  | region_id    | RegionOne                        |
  | service_id   | d854f6fff0a64f77bda8003c8dedfada |
  | service_name | watcher                          |
  | service_type | infra-optim                      |
  | url          | http://controller:9322           |
  +--------------+----------------------------------+

$ openstack endpoint create --region RegionOne \
  infra-optim admin http://controller:9322
  +--------------+----------------------------------+
  | Field        | Value                            |
  +--------------+----------------------------------+
  | enabled      | True                             |
  | id           | 375eb5057fb546edbdf3ee4866179672 |
  | interface    | admin                            |
  | region       | RegionOne                        |
  | region_id    | RegionOne                        |
  | service_id   | d854f6fff0a64f77bda8003c8dedfada |
  | service_name | watcher                          |
  | service_type | infra-optim                      |
  | url          | http://controller:9322           |
  +--------------+----------------------------------+

5.3 KiB Raw Blame History

Prerequisites

5.3 KiB

Raw Blame History