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

doc/source/admin/index.rst

@@ -0,0 +1,10 @@
+.. toctree::
+   :maxdepth: 2
+
+   apache-mod-wsgi
+   conf-files
+   configuration
+   gmr
+   policy
+   ways-to-install
+   ../strategies/index

doc/source/admin/ways-to-install.rst

@@ -4,12 +4,13 @@
 
           https://creativecommons.org/licenses/by/3.0/
 
-==================
-Installing Watcher
-==================
+=======================
+Ways to install Watcher
+=======================
 
-This document describes how to install Watcher in order to use it. If you are
-intending to develop on or with Watcher, please read :doc:`../dev/environment`.
+This document describes some ways to install Watcher in order to use it.
+If you are intending to develop on or with Watcher,
+please read :doc:`../dev/environment`.
 
 Prerequisites
 -------------

doc/source/contributor/index.rst

@@ -0,0 +1,8 @@
+.. toctree::
+   :maxdepth: 1
+
+  environment
+  devstack
+  notifications
+  testing
+  rally_link

doc/source/contributor/plugin/index.rst

@@ -0,0 +1,11 @@
+.. toctree::
+   :maxdepth: 1
+
+   base-setup
+   action-plugin
+   cdmc-plugin
+   goal-plugin
+   planner-plugin
+   scoring-engine-plugin
+   strategy-plugin
+   plugins

doc/source/index.rst

@@ -43,7 +43,7 @@ Introduction
 
   glossary
   architecture
-  dev/contributing
+  contributor/contributing
 
 
 Getting Started
@@ -52,14 +52,14 @@ Getting Started
 .. toctree::
   :maxdepth: 1
 
-  dev/environment
-  dev/devstack
-  deploy/configuration
-  deploy/conf-files
-  deploy/apache-mod-wsgi
-  dev/notifications
-  dev/testing
-  dev/rally_link
+  contributor/index
+
+Installation
+------------
+.. toctree::
+  :maxdepth: 2
+
+  install/index
 
 API References
 --------------
@@ -67,7 +67,7 @@ API References
 .. toctree::
   :maxdepth: 1
 
-  webapi/v1
+  webapi/index
 
 Plugins
 -------
@@ -75,30 +75,23 @@ Plugins
 .. toctree::
   :maxdepth: 1
 
-  dev/plugin/base-setup
-  dev/plugin/goal-plugin
-  dev/plugin/scoring-engine-plugin
-  dev/plugin/strategy-plugin
-  dev/plugin/cdmc-plugin
-  dev/plugin/action-plugin
-  dev/plugin/planner-plugin
-  dev/plugins
-
+  contributor/plugin/index
 
 Admin Guide
 ===========
 
-Introduction
-------------
-
 .. toctree::
   :maxdepth: 1
 
-  deploy/installation
-  deploy/user-guide
-  deploy/policy
-  deploy/gmr
-  strategies/strategies
+  admin/index
+
+User Guide
+==========
+
+.. toctree::
+  :maxdepth: 2
+
+  user/index
 
 Watcher Manual Pages
 ====================
@@ -107,7 +100,7 @@ Watcher Manual Pages
    :glob:
    :maxdepth: 1
 
-   man/*
+   man/index
 
 .. # NOTE(mriedem): This is the section where we hide things that we don't
    # actually want in the table of contents but sphinx build would fail if

doc/source/install/common_configure.rst

@@ -0,0 +1,71 @@
+2. Edit the ``/etc/watcher/watcher.conf`` file and complete the following
+   actions:
+
+   * In the ``[database]`` section, configure database access:
+
+     .. code-block:: ini
+
+        [database]
+        ...
+        connection = mysql+pymysql://watcher:WATCHER_DBPASS@controller/watcher?charset=utf8
+
+   * In the `[DEFAULT]` section, configure the transport url for RabbitMQ message broker.
+
+     .. code-block:: ini
+
+        [DEFAULT]
+        ...
+        control_exchange = watcher
+        transport_url = rabbit://openstack:RABBIT_PASS@controller
+
+     Replace the RABBIT_PASS with the password you chose for OpenStack user in RabbitMQ.
+
+   * In the `[keystone_authtoken]` section, configure Identity service access.
+
+     .. code-block:: ini
+
+        [keystone_authtoken]
+        ...
+        auth_uri = http://controller:5000
+        auth_url = http://controller:35357
+        memcached_servers = controller:11211
+        auth_type = password
+        project_domain_name = default
+        user_domain_name = default
+        project_name = service
+        username = watcher
+        password = WATCHER_PASS
+
+     Replace WATCHER_PASS with the password you chose for the watcher user in the Identity service.
+
+   * Watcher interacts with other OpenStack projects via project clients, in order to instantiate these
+     clients, Watcher requests new session from Identity service. In the `[watcher_client_auth]` section,
+     configure the identity service access to interact with other OpenStack project clients.
+
+     .. code-block:: ini
+
+        [watcher_client_auth]
+        ...
+        auth_type = password
+        auth_url = http://controller:35357
+        username = watcher
+        password = WATCHER_PASS
+        project_domain_name = default
+        user_domain_name = default
+        project_name = service
+
+     Replace WATCHER_PASS with the password you chose for the watcher user in the Identity service.
+
+   * In the `[oslo_messaging_notifications]` section, configure the messaging driver.
+
+     .. code-block:: ini
+
+        [oslo_messaging_notifications]
+        ...
+        driver = messagingv2
+
+3. Populate watcher database:
+
+   .. code-block:: ini
+
+     su -s /bin/sh -c "watcher-db-manage" watcher

doc/source/install/common_prerequisites.rst

@@ -0,0 +1,139 @@
+Prerequisites
+-------------
+
+Before you install and configure the Infrastructure Optimization service,
+you must create a database, service credentials, and API endpoints.
+
+1. Create the database, complete these steps:
+
+   * Use the database access client to connect to the database
+     server as the ``root`` user:
+
+     .. code-block:: console
+
+        $ mysql -u root -p
+
+   * Create the ``watcher`` database:
+
+     .. code-block:: console
+
+        CREATE DATABASE watcher CHARACTER SET utf8;
+
+   * Grant proper access to the ``watcher`` database:
+
+     .. code-block:: console
+
+        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.
+
+     .. code-block:: console
+
+        exit;
+
+2. Source the ``admin`` credentials to gain access to
+   admin-only CLI commands:
+
+   .. code-block:: console
+
+      $ . admin-openrc
+
+3. To create the service credentials, complete these steps:
+
+   * Create the ``watcher`` user:
+
+     .. code-block:: console
+
+        $ 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:
+
+     .. code-block:: console
+
+        $ openstack role add --project service --user watcher admin
+
+     .. note::
+
+        This command produces no output.
+
+   * Create the watcher service entities:
+
+     .. code-block:: console
+
+        $ openstack service create --name watcher --description "Infrastructure Optimization" infra-optim
+          +-------------+----------------------------------+
+          | Field       | Value                            |
+          +-------------+----------------------------------+
+          | description | Infrastructure Optimization      |
+          | enabled     | True                             |
+          | id          | d854f6fff0a64f77bda8003c8dedfada |
+          | name        | watcher                          |
+          | type        | infra-optim                      |
+          +-------------+----------------------------------+
+
+
+4. Create the Infrastructure Optimization service API endpoints:
+
+   .. code-block:: console
+
+      $ 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           |
+        +--------------+----------------------------------+

doc/source/install/get_started.rst

@@ -0,0 +1,27 @@
+============================================
+Infrastructure Optimization service overview
+============================================
+The Infrastructure Optimization service provides flexible and scalable
+optimization service for multi-tenant OpenStack based clouds.
+
+The Infrastructure Optimization service consists of the following components:
+
+``watcher`` command-line client
+  A CLI to communicate with ``watcher-api`` to optimize the cloud.
+
+``watcher-api`` service
+  An OpenStack-native REST API that accepts and responds to end-user calls
+  by processing them and forwarding to appropriate underlying watcher
+  services via AMQP.
+
+``watcher-decision-engine`` service
+  It runs audit and return an action plan to achieve optimization goal
+  specified by the end-user in audit.
+
+``watcher-applier`` service
+  It executes action plan built by watcher-decision-engine. It interacts with
+  other OpenStack components like nova to execute the given action
+  plan.
+
+``watcher-dashboard``
+  Watcher UI implemented as a plugin for the OpenStack Dashboard.

doc/source/install/index.rst

@@ -0,0 +1,39 @@
+===================================
+Infrastructure Optimization service
+===================================
+
+.. toctree::
+   :maxdepth: 2
+
+   get_started.rst
+   install.rst
+   verify.rst
+   next-steps.rst
+
+The Infrastructure Optimization service (watcher) provides
+flexible and scalable resource optimization service for
+multi-tenant OpenStack-based clouds.
+
+Watcher provides a complete optimization loop including
+everything from a metrics receiver, complex event processor
+and profiler, optimization processor and an action plan
+applier. This provides a robust framework to realize a wide
+range of cloud optimization goals, including the reduction
+of data center operating costs, increased system performance
+via intelligent virtual machine migration, increased energy
+efficiency—and more!
+
+Watcher also supports a pluggable architecture by which custom
+optimization algorithms, data metrics and data profilers can be
+developed and inserted into the Watcher framework.
+
+Check the documentation for watcher optimization strategies at
+https://docs.openstack.org/developer/watcher/strategies
+
+Check watcher glossary at
+https://docs.openstack.org/developer/watcher/glossary.html
+
+
+This chapter assumes a working setup of OpenStack following the
+`OpenStack Installation Tutorial
+<https://docs.openstack.org/project-install-guide/ocata/>`_.

doc/source/install/install-obs.rst

@@ -0,0 +1,35 @@
+.. _install-obs:
+
+
+Install and configure for openSUSE and SUSE Linux Enterprise
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+This section describes how to install and configure the Infrastructure
+Optimization service for openSUSE Leap 42.1 and
+SUSE Linux Enterprise Server 12 SP1.
+
+.. include:: common_prerequisites.rst
+
+Install and configure components
+--------------------------------
+
+#. Install the packages:
+
+   .. code-block:: console
+
+      # zypper --quiet --non-interactive install
+
+.. include:: common_configure.rst
+
+
+Finalize installation
+---------------------
+
+Start the Infrastructure Optimization services and configure them to start when
+the system boots:
+
+.. code-block:: console
+
+   # systemctl enable openstack-watcher-api.service
+
+   # systemctl start openstack-watcher-api.service

doc/source/install/install-rdo.rst

@@ -0,0 +1,38 @@
+.. _install-rdo:
+
+Install and configure for Red Hat Enterprise Linux and CentOS
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+
+This section describes how to install and configure the Infrastructure
+Optimization service for Red Hat Enterprise Linux 7 and CentOS 7.
+
+.. include:: common_prerequisites.rst
+
+Install and configure components
+--------------------------------
+
+1. Install the packages:
+
+   .. code-block:: console
+
+      # sudo yum install openstack-watcher-api openstack-watcher-applier \
+        openstack-watcher-decision-engine
+
+.. include:: common_configure.rst
+
+Finalize installation
+---------------------
+
+Start the Infrastructure Optimization services and configure them to start when
+the system boots:
+
+.. code-block:: console
+
+   # systemctl enable openstack-watcher-api.service \
+     openstack-watcher-decision-engine.service \
+     openstack-watcher-applier.service
+
+   # systemctl start openstack-watcher-api.service \
+     openstack-watcher-decision-engine.service \
+     openstack-watcher-applier.service

doc/source/install/install-ubuntu.rst

@@ -0,0 +1,34 @@
+.. _install-ubuntu:
+
+Install and configure for Ubuntu
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+This section describes how to install and configure the Infrastructure
+Optimization service for Ubuntu 14.04 (LTS).
+
+.. include:: common_prerequisites.rst
+
+Install and configure components
+--------------------------------
+
+1. Install the packages:
+
+   .. code-block:: console
+
+      # apt install watcher-api watcher-decision-engine \
+        watcher-applier
+
+      # apt install python-watcherclient
+
+.. include:: common_configure.rst
+
+Finalize installation
+---------------------
+
+Restart the Infrastructure Optimization services:
+
+.. code-block:: console
+
+   # service watcher-api restart
+   # service watcher-decision-engine restart
+   # service watcher-applier restart

doc/source/install/install.rst

@@ -0,0 +1,20 @@
+.. _install:
+
+Install and configure
+~~~~~~~~~~~~~~~~~~~~~
+
+This section describes how to install and configure the Infrastructure
+Optimization service, code-named watcher, on the controller node.
+
+This section assumes that you already have a working OpenStack
+environment with at least the following components installed:
+Identity Service, Compute Service, Telemetry data collection service.
+
+Note that installation and configuration vary by distribution.
+
+.. toctree::
+   :maxdepth: 2
+
+   install-obs.rst
+   install-rdo.rst
+   install-ubuntu.rst

doc/source/install/next-steps.rst

@@ -0,0 +1,9 @@
+.. _next-steps:
+
+Next steps
+~~~~~~~~~~
+
+Your OpenStack environment now includes the watcher service.
+
+To add additional services, see
+https://docs.openstack.org/project-install-guide/ocata/.

doc/source/install/verify.rst

@@ -0,0 +1,119 @@
+.. _verify:
+
+Verify operation
+~~~~~~~~~~~~~~~~
+
+Verify operation of the Infrastructure Optimization service.
+
+.. note::
+
+   Perform these commands on the controller node.
+
+1. Source the ``admin`` project credentials to gain access to
+   admin-only CLI commands:
+
+   .. code-block:: console
+
+      $ . admin-openrc
+
+2. List service components to verify successful launch and registration
+   of each process:
+
+   .. code-block:: console
+
+      $ openstack optimize service list
+        +----+-------------------------+------------+--------+
+        | ID | Name                    | Host       | Status |
+        +----+-------------------------+------------+--------+
+        |  1 | watcher-decision-engine | controller | ACTIVE |
+        |  2 | watcher-applier         | controller | ACTIVE |
+        +----+-------------------------+------------+--------+
+
+3. List goals and strategies:
+
+   .. code-block:: console
+
+      $ openstack optimize goal list
+        +--------------------------------------+----------------------+----------------------+
+        | UUID                                 | Name                 | Display name         |
+        +--------------------------------------+----------------------+----------------------+
+        | a8cd6d1a-008b-4ff0-8dbc-b30493fcc5b9 | dummy                | Dummy goal           |
+        | 03953f2f-02d0-42b5-9a12-7ba500a54395 | workload_balancing   | Workload Balancing   |
+        | de0f8714-984b-4d6b-add1-9cad8120fbce | server_consolidation | Server Consolidation |
+        | f056bc80-c6d1-40dc-b002-938ccade9385 | thermal_optimization | Thermal Optimization |
+        | e7062856-892e-4f0f-b84d-b828464b3fd0 | airflow_optimization | Airflow Optimization |
+        | 1f038da9-b36c-449f-9f04-c225bf3eb478 | unclassified         | Unclassified         |
+        +--------------------------------------+----------------------+----------------------+
+
+      $ openstack optimize strategy list
+      +--------------------------------------+---------------------------+---------------------------------------------+----------------------+
+      | UUID                                 | Name                      | Display name                                | Goal                 |
+      +--------------------------------------+---------------------------+---------------------------------------------+----------------------+
+      | 98ae84c8-7c9b-4cbd-8d9c-4bd7c6b106eb | dummy                     | Dummy strategy                              | dummy                |
+      | 02a170b6-c72e-479d-95c0-8a4fdd4cc1ef | dummy_with_scorer         | Dummy Strategy using sample Scoring Engines | dummy                |
+      | 8bf591b8-57e5-4a9e-8c7d-c37bda735a45 | outlet_temperature        | Outlet temperature based strategy           | thermal_optimization |
+      | 8a0810fb-9d9a-47b9-ab25-e442878abc54 | vm_workload_consolidation | VM Workload Consolidation Strategy          | server_consolidation |
+      | 1718859c-3eb5-45cb-9220-9cb79fe42fa5 | basic                     | Basic offline consolidation                 | server_consolidation |
+      | b5e7f5f1-4824-42c7-bb52-cf50724f67bf | workload_stabilization    | Workload stabilization                      | workload_balancing   |
+      | f853d71e-9286-4df3-9d3e-8eaf0f598e07 | workload_balance          | Workload Balance Migration Strategy         | workload_balancing   |
+      | 58bdfa89-95b5-4630-adf6-fd3af5ff1f75 | uniform_airflow           | Uniform airflow migration strategy          | airflow_optimization |
+      | 66fde55d-a612-4be9-8cb0-ea63472b420b | dummy_with_resize         | Dummy strategy with resize                  | dummy                |
+      +--------------------------------------+---------------------------+---------------------------------------------+----------------------+
+
+4. Run an action plan by creating an audit with dummy goal:
+
+   .. code-block:: console
+
+      $ openstack optimize audit create --goal dummy
+        +--------------+--------------------------------------+
+        | Field        | Value                                |
+        +--------------+--------------------------------------+
+        | UUID         | e94d4826-ad4e-44df-ad93-dff489fde457 |
+        | Created At   | 2017-05-23T11:46:58.763394+00:00     |
+        | Updated At   | None                                 |
+        | Deleted At   | None                                 |
+        | State        | PENDING                              |
+        | Audit Type   | ONESHOT                              |
+        | Parameters   | {}                                   |
+        | Interval     | None                                 |
+        | Goal         | dummy                                |
+        | Strategy     | auto                                 |
+        | Audit Scope  | []                                   |
+        | Auto Trigger | False                                |
+        +--------------+--------------------------------------+
+
+      $ openstack optimize audit list
+        +--------------------------------------+------------+-----------+-------+----------+--------------+
+        | UUID                                 | Audit Type | State     | Goal  | Strategy | Auto Trigger |
+        +--------------------------------------+------------+-----------+-------+----------+--------------+
+        | e94d4826-ad4e-44df-ad93-dff489fde457 | ONESHOT    | SUCCEEDED | dummy | auto     | False        |
+        +--------------------------------------+------------+-----------+-------+----------+--------------+
+
+      $ openstack optimize actionplan list
+        +--------------------------------------+--------------------------------------+-------------+------------+-----------------+
+        | UUID                                 | Audit                                | State       | Updated At | Global efficacy |
+        +--------------------------------------+--------------------------------------+-------------+------------+-----------------+
+        | ba9ce6b3-969c-4b8e-bb61-ae24e8630f81 | e94d4826-ad4e-44df-ad93-dff489fde457 | RECOMMENDED | None       | None            |
+        +--------------------------------------+--------------------------------------+-------------+------------+-----------------+
+
+     $ openstack optimize actionplan start ba9ce6b3-969c-4b8e-bb61-ae24e8630f81
+       +---------------------+--------------------------------------+
+       | Field               | Value                                |
+       +---------------------+--------------------------------------+
+       | UUID                | ba9ce6b3-969c-4b8e-bb61-ae24e8630f81 |
+       | Created At          | 2017-05-23T11:46:58+00:00            |
+       | Updated At          | 2017-05-23T11:53:12+00:00            |
+       | Deleted At          | None                                 |
+       | Audit               | e94d4826-ad4e-44df-ad93-dff489fde457 |
+       | Strategy            | dummy                                |
+       | State               | ONGOING                              |
+       | Efficacy indicators | []                                   |
+       | Global efficacy     | {}                                   |
+       +---------------------+--------------------------------------+
+
+     $ openstack optimize actionplan list
+     +--------------------------------------+--------------------------------------+-----------+---------------------------+-----------------+
+     | UUID                                 | Audit                                | State     | Updated At                | Global efficacy |
+     +--------------------------------------+--------------------------------------+-----------+---------------------------+-----------------+
+     | ba9ce6b3-969c-4b8e-bb61-ae24e8630f81 | e94d4826-ad4e-44df-ad93-dff489fde457 | SUCCEEDED | 2017-05-23T11:53:16+00:00 | None            |
+     +--------------------------------------+--------------------------------------+-----------+---------------------------+-----------------+

doc/source/man/index.rst

@@ -0,0 +1,10 @@
+.. toctree::
+   :glob:
+   :maxdepth: 1
+
+   footer.rst
+   general-options
+   watcher-api
+   watcher-applier
+   watcher-db-manage
+   watcher-decision-engine

doc/source/strategies/basic-server-consolidation.rst

@@ -57,7 +57,7 @@ Planner
 
 Default Watcher's planner:
 
-    .. watcher-term:: watcher.decision_engine.planner.default.DefaultPlanner
+    .. watcher-term:: watcher.decision_engine.planner.weight.WeightPlanner
 
 Configuration
 -------------

doc/source/strategies/outlet_temp_control.rst

@@ -61,7 +61,7 @@ Planner
 
 Default Watcher's planner:
 
-    .. watcher-term:: watcher.decision_engine.planner.default.DefaultPlanner
+    .. watcher-term:: watcher.decision_engine.planner.weight.WeightPlanner
 
 Configuration
 -------------

doc/source/strategies/uniform_airflow.rst

@@ -59,7 +59,7 @@ Planner
 
 Default Watcher's planner:
 
-    .. watcher-term:: watcher.decision_engine.planner.default.DefaultPlanner
+    .. watcher-term:: watcher.decision_engine.planner.weight.WeightPlanner
 
 Configuration
 -------------

doc/source/strategies/vm_workload_consolidation.rst

@@ -67,7 +67,7 @@ Planner
 
 Default Watcher's planner:
 
-    .. watcher-term:: watcher.decision_engine.planner.default.DefaultPlanner
+    .. watcher-term:: watcher.decision_engine.planner.weight.WeightPlanner
 
 
 Configuration

doc/source/strategies/workload-stabilization.rst

@@ -58,7 +58,7 @@ Planner
 
 Default Watcher's planner:
 
-    .. watcher-term:: watcher.decision_engine.planner.default.DefaultPlanner
+    .. watcher-term:: watcher.decision_engine.planner.weight.WeightPlanner
 
 Configuration
 -------------

doc/source/strategies/workload_balance.rst

@@ -56,7 +56,7 @@ Planner
 
 Default Watcher's planner:
 
-    .. watcher-term:: watcher.decision_engine.planner.default.DefaultPlanner
+    .. watcher-term:: watcher.decision_engine.planner.weight.WeightPlanner
 
 Configuration
 -------------

doc/source/user/index.rst

@@ -0,0 +1,4 @@
+.. toctree::
+   :maxdepth: 2
+
+   user-guide

doc/source/webapi/index.rst

@@ -0,0 +1,4 @@
+.. toctree::
+   :maxdepth: 1
+
+   v1

doc/source/webapi/v1.rst

@@ -20,6 +20,17 @@ Goals
 .. autotype:: watcher.api.controllers.v1.goal.Goal
    :members:
 
+Strategies
+==========
+
+.. rest-controller:: watcher.api.controllers.v1.strategy:StrategiesController
+   :webprefix: /v1/strategies
+
+.. autotype:: watcher.api.controllers.v1.strategy.StrategyCollection
+   :members:
+
+.. autotype:: watcher.api.controllers.v1.strategy.Strategy
+   :members:
 
 Audit Templates
 ===============