Merge "Fix TypeError in LOG.debug"

Change-Id: I4a4050081d0a22cc66fdb311ef676d0ba802bb72
Closes-Bug: #1785962

.gitignore

@@ -23,9 +23,7 @@ pip-log.txt
 # Unit test / coverage reports
 .coverage*
 .tox
-nosetests.xml
 .stestr/
-.testrepository
 .venv
 .idea
 

.stestr.conf

@@ -1,4 +1,4 @@
 [DEFAULT]
-test_path=${OS_TEST_PATH:-./watcher/tests}
+test_path=./watcher/tests
 top_dir=./
 

.testr.conf

@@ -1,7 +0,0 @@
-[DEFAULT]
-test_command=OS_STDOUT_CAPTURE=${OS_STDOUT_CAPTURE:-1} \
-             OS_STDERR_CAPTURE=${OS_STDERR_CAPTURE:-1} \
-             OS_TEST_TIMEOUT=${OS_TEST_TIMEOUT:-160} \
-             ${PYTHON:-python} -m subunit.run discover -t ./ ${OS_TEST_PATH:-./watcher/tests} $LISTOPT $IDOPTION
-test_id_option=--load-list $IDFILE
-test_list_option=--list

.zuul.yaml

@@ -1,38 +1,156 @@
 - project:
     check:
       jobs:
-        - watcher-tempest-multinode
-        - legacy-rally-dsvm-watcher-rally
+        - watcher-tempest-functional
+        - watcher-tempest-dummy_optim
+        - watcher-tempest-actuator
+        - watcher-tempest-basic_optim
+        - watcher-tempest-workload_balancing
+        - watcherclient-tempest-functional
+        - watcher-tempest-zone_migration
+        - openstack-tox-lower-constraints
+    gate:
+      jobs:
+        - watcher-tempest-functional
+        - openstack-tox-lower-constraints
 
 - job:
-    name: watcher-tempest-base-multinode
-    parent: legacy-dsvm-base-multinode
-    run: playbooks/legacy/watcher-tempest-base-multinode/run.yaml
-    post-run: playbooks/legacy/watcher-tempest-base-multinode/post.yaml
-    timeout: 4200
+    name: watcher-tempest-dummy_optim
+    parent: watcher-tempest-multinode
+    voting: false
+    vars:
+      tempest_test_regex: 'watcher_tempest_plugin.tests.scenario.test_execute_dummy_optim'
+
+- job:
+    name: watcher-tempest-actuator
+    parent: watcher-tempest-multinode
+    voting: false
+    vars:
+      tempest_test_regex: 'watcher_tempest_plugin.tests.scenario.test_execute_actuator'
+
+- job:
+    name: watcher-tempest-basic_optim
+    parent: watcher-tempest-multinode
+    voting: false
+    vars:
+      tempest_test_regex: 'watcher_tempest_plugin.tests.scenario.test_execute_basic_optim'
+
+- job:
+    name: watcher-tempest-workload_balancing
+    parent: watcher-tempest-multinode
+    voting: false
+    vars:
+      tempest_test_regex: 'watcher_tempest_plugin.tests.scenario.test_execute_workload_balancing'
+
+- job:
+    name: watcher-tempest-zone_migration
+    parent: watcher-tempest-multinode
+    voting: false
+    vars:
+      tempest_test_regex: 'watcher_tempest_plugin.tests.scenario.test_execute_zone_migration'
+
+- job:
+    name: watcher-tempest-multinode
+    parent: watcher-tempest-functional
+    nodeset: openstack-two-node
+    pre-run: playbooks/pre.yaml
+    run: playbooks/orchestrate-tempest.yaml
+    roles:
+      - zuul: openstack/tempest
+    group-vars:
+      subnode:
+        devstack_local_conf:
+          post-config:
+            $NOVA_CONF:
+              libvirt:
+                live_migration_uri: 'qemu+ssh://root@%s/system'
+            $WATCHER_CONF:
+              watcher_cluster_data_model_collectors.compute:
+                period: 120
+              watcher_cluster_data_model_collectors.baremetal:
+                period: 120
+              watcher_cluster_data_model_collectors.storage:
+                period: 120
+        devstack_services:
+          watcher-api: false
+          watcher-decision-engine: true
+          watcher-applier: false
+          # We need to add TLS support for watcher plugin
+          tls-proxy: false
+          ceilometer: false
+          ceilometer-acompute: false
+          ceilometer-acentral: false
+          ceilometer-anotification: false
+          watcher: false
+          gnocchi-api: false
+          gnocchi-metricd: false
+          rabbit: false
+          mysql: false
+    vars:
+      devstack_local_conf:
+        post-config:
+          $NOVA_CONF:
+            libvirt:
+              live_migration_uri: 'qemu+ssh://root@%s/system'
+          $WATCHER_CONF:
+              watcher_cluster_data_model_collectors.compute:
+                period: 120
+              watcher_cluster_data_model_collectors.baremetal:
+                period: 120
+              watcher_cluster_data_model_collectors.storage:
+                period: 120
+        test-config:
+          $TEMPEST_CONFIG:
+            compute:
+              min_compute_nodes: 2
+            compute-feature-enabled:
+              live_migration: true
+              block_migration_for_live_migration: true
+      devstack_plugins:
+        ceilometer: https://git.openstack.org/openstack/ceilometer
+
+- job:
+    name: watcher-tempest-functional
+    parent: devstack-tempest
+    timeout: 7200
     required-projects:
+      - openstack/ceilometer
       - openstack-infra/devstack-gate
       - openstack/python-openstackclient
       - openstack/python-watcherclient
       - openstack/watcher
       - openstack/watcher-tempest-plugin
-    nodeset: legacy-ubuntu-xenial-2-node
+      - openstack/tempest
+    vars:
+      devstack_plugins:
+        watcher: https://git.openstack.org/openstack/watcher
+      devstack_services:
+        tls-proxy: false
+        watcher-api: true
+        watcher-decision-engine: true
+        watcher-applier: true
+        tempest: true
+        s-account: false
+        s-container: false
+        s-object: false
+        s-proxy: false
+      devstack_localrc:
+        TEMPEST_PLUGINS: '/opt/stack/watcher-tempest-plugin'
+      tempest_test_regex: 'watcher_tempest_plugin.tests.api'
+      tox_envlist: all
+      tox_environment:
+        # Do we really need to set this? It's cargo culted
+        PYTHONUNBUFFERED: 'true'
+      zuul_copy_output:
+        /etc/hosts: logs
 
 - job:
-    name: watcher-tempest-multinode
-    parent: watcher-tempest-base-multinode
-    voting: false
-
-- job:
-    # This job is used by python-watcherclient repo
+    # This job is used in python-watcherclient repo
     name: watcherclient-tempest-functional
-    parent: legacy-dsvm-base
-    run: playbooks/legacy/watcherclient-tempest-functional/run.yaml
-    post-run: playbooks/legacy/watcherclient-tempest-functional/post.yaml
+    parent: watcher-tempest-functional
     timeout: 4200
-    required-projects:
-      - openstack-dev/devstack
-      - openstack-infra/devstack-gate
-      - openstack/python-openstackclient
-      - openstack/python-watcherclient
-      - openstack/watcher
+    vars:
+      tempest_concurrency: 1
+      devstack_localrc:
+        TEMPEST_PLUGINS: '/opt/stack/python-watcherclient'
+      tempest_test_regex: 'watcherclient.tests.functional'

HACKING.rst

@@ -8,4 +8,4 @@
 watcher Style Commandments
 ==========================
 
-Read the OpenStack Style Commandments https://docs.openstack.org/developer/hacking/
+Read the OpenStack Style Commandments https://docs.openstack.org/hacking/latest/

README.rst

@@ -2,8 +2,8 @@
 Team and repository tags
 ========================
 
-.. image:: https://governance.openstack.org/badges/watcher.svg
-    :target: https://governance.openstack.org/reference/tags/index.html
+.. image:: https://governance.openstack.org/tc/badges/watcher.svg
+    :target: https://governance.openstack.org/tc/reference/tags/index.html
 
 .. Change things from this point on
 
@@ -22,10 +22,11 @@ service for multi-tenant OpenStack-based clouds.
 Watcher 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!
+migration, increased energy efficiency and more!
 
 * Free software: Apache license
 * Wiki: https://wiki.openstack.org/wiki/Watcher
-* Source:  https://github.com/openstack/watcher
+* Source: https://github.com/openstack/watcher
 * Bugs: https://bugs.launchpad.net/watcher
 * Documentation: https://docs.openstack.org/watcher/latest/
+* Release notes: https://docs.openstack.org/releasenotes/watcher/

api-ref/source/conf.py

@@ -0,0 +1,90 @@
+# Licensed under the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License. You may obtain
+# a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+# License for the specific language governing permissions and limitations
+# under the License.
+#
+# nova documentation build configuration file, created by
+# sphinx-quickstart on Sat May  1 15:17:47 2010.
+#
+# This file is execfile()d with the current directory set to
+# its containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+from watcher import version as watcher_version
+
+
+extensions = [
+    'openstackdocstheme',
+    'os_api_ref',
+]
+
+# -- General configuration ----------------------------------------------------
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
+
+# The suffix of source filenames.
+source_suffix = '.rst'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'Infrastructure Optimization API Reference'
+copyright = u'2010-present, OpenStack Foundation'
+
+# openstackdocstheme options
+repository_name = 'openstack/watcher'
+bug_project = 'watcher'
+bug_tag = ''
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The full version, including alpha/beta/rc tags.
+release = watcher_version.version_info.release_string()
+# The short X.Y version.
+version = watcher_version.version_string
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# -- Options for HTML output --------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  Major themes that come with
+# Sphinx are currently 'default' and 'sphinxdoc'.
+html_theme = 'openstackdocs'
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further.  For a list of options available for each theme, see the
+# documentation.
+html_theme_options = {
+    "sidebar_mode": "toc",
+}
+
+# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
+# using the given strftime format.
+html_last_updated_fmt = '%Y-%m-%d %H:%M'
+
+# -- Options for LaTeX output -------------------------------------------------
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title, author, documentclass
+# [howto/manual]).
+latex_documents = [
+    ('index', 'Watcher.tex', u'Infrastructure Optimization API Reference',
+     u'OpenStack Foundation', 'manual'),
+]

api-ref/source/index.rst

@@ -0,0 +1,16 @@
+:tocdepth: 2
+
+===========
+Watcher API
+===========
+
+.. rest_expand_all::
+
+.. include:: watcher-api-v1-audittemplates.inc
+.. include:: watcher-api-v1-audits.inc
+.. include:: watcher-api-v1-actionplans.inc
+.. include:: watcher-api-v1-actions.inc
+.. include:: watcher-api-v1-goals.inc
+.. include:: watcher-api-v1-strategies.inc
+.. include:: watcher-api-v1-services.inc
+.. include:: watcher-api-v1-scoring_engines.inc

api-ref/source/parameters.yaml

@@ -0,0 +1,433 @@
+# Path
+action_ident:
+  description: |
+    The UUID of the Action.
+  in: path
+  required: true
+  type: string
+actionplan_ident:
+  description: |
+    The UUID of the Action Plan.
+  in: path
+  required: true
+  type: string
+audit_ident:
+  description: |
+    The UUID or name of the Audit.
+  in: path
+  required: true
+  type: string
+audittemplate_ident:
+  description: |
+    The UUID or name of the Audit Template.
+  in: path
+  required: true
+  type: string
+goal_ident:
+  description: |
+    The UUID or name of the Goal.
+  in: path
+  required: true
+  type: string
+scoring_engine_ident:
+  description: |
+    The UUID or name of the Scoring Engine.
+  in: path
+  required: true
+  type: string
+service_ident:
+  description: |
+    The ID or name of the Service.
+  in: path
+  required: true
+  type: string
+strategy_ident:
+  description: |
+    The UUID or name of the Strategy.
+  in: path
+  required: true
+  type: string
+
+# Query body
+limit:
+  description: |
+    Requests a page size of items. Returns a number of items up to a ``limit``
+    value. Use the limit parameter to make an initial limited request and use
+    the ID of the last-seen item from the response as the ``marker`` parameter
+    value in a subsequent limited request.
+  in: query
+  required: false
+  type: integer
+marker:
+  description: |
+    The ID of the last-seen item. Use the ``limit`` parameter to make an
+    initial limited request and use the ID of the last-seen item from the
+    response as the ``marker`` parameter value in a subsequent limited request.
+  in: query
+  required: false
+  type: string
+r_action_plan:
+  description: |
+    UUID of the action plan used for filtering.
+  in: query
+  required: false
+  type: string
+r_audit:
+  description: |
+    Optional UUID of an audit, to get only actions for that audit.
+  in: query
+  required: false
+  type: string
+r_goal:
+  description: |
+    The UUID or name of the Goal.
+  in: query
+  required: false
+  type: string
+r_strategy:
+  description: |
+    The UUID or name of the Strategy.
+  in: query
+  required: false
+  type: string
+sort_dir:
+  description: |
+    Sorts the response by the requested sort direction.
+    A valid value is ``asc`` (ascending) or ``desc`` (descending).
+    Default is ``asc``.
+  in: query
+  required: false
+  type: string
+sort_key:
+  description: |
+    Sorts the response by the this attribute value. Default is ``id``.
+  in: query
+  required: false
+  type: string
+
+# variables in the API response body
+
+# Action
+action_action_plan_uuid:
+  description: |
+    The action plan this action belongs to.
+  in: body
+  required: true
+  type: string
+action_description:
+  description: |
+    Action description.
+  in: body
+  required: true
+  type: string
+action_input_parameters:
+  description: |
+    Input parameters which are used by appropriate action type. For example,
+    ``migration`` action takes into account such parameters as
+    ``migration_type``, ``destination_node``, ``resource_id`` and
+    ``source_node``. To see a list of supported action types and their input
+    parameters visit `Action plugins page <https://docs.openstack.org/watcher/latest/contributor/plugin/plugins.html#actions>`_.
+  in: body
+  required: true
+  type: JSON
+action_parents:
+  description: |
+    UUIDs of parent actions.
+  in: body
+  required: true
+  type: array
+action_state:
+  description: |
+    State of Action.
+  in: body
+  required: true
+  type: string
+action_type:
+  description: |
+    Action type based on specific API action. Actions in Watcher are
+    pluggable, to see a list of supported action types visit
+    `Action plugins page <https://docs.openstack.org/watcher/latest/contributor/plugin/plugins.html#actions>`_.
+  in: body
+  required: true
+  type: string
+
+# Action Plan
+actionplan_audit_uuid:
+  description: |
+    The UUID of the audit this acton plan belongs to.
+  in: body
+  required: false
+  type: string
+actionplan_efficacy_indicators:
+  description: |
+    The list of efficacy indicators associated to this action plan.
+  in: body
+  required: false
+  type: array
+actionplan_global_efficacy:
+  description: |
+    The global efficacy of this action plan.
+  in: body
+  required: false
+  type: array
+actionplan_state:
+  description: |
+    State of this action plan. To get more information about states and
+    action plan's lifecycle, visit `Action Plan State Machine page <https://docs.openstack.org/watcher/latest/architecture.html#action-plan-state-machine>`_.
+  in: body
+  required: false
+  type: string
+
+# Audit
+audit_autotrigger:
+  description: |
+    Autoexecute action plan once audit is succeeded.
+  in: body
+  required: false
+  type: boolean
+audit_goal:
+  description: |
+    The UUID or name of the Goal.
+  in: body
+  required: false
+  type: string
+audit_interval:
+  description: |
+    Time interval between audit's execution.
+    Can be set either in seconds or cron syntax.
+    Should be defined only for CONTINUOUS audits.
+  in: body
+  required: false
+  type: string
+audit_name:
+  description: |
+    Name of this audit.
+  in: body
+  required: false
+  type: string
+audit_next_run_time:
+  description: |
+    The next time audit launch. Defined only for CONTINUOUS audits.
+  in: body
+  required: false
+  type: string
+audit_parameters:
+  description: |
+    The strategy parameters for this audit.
+  in: body
+  required: false
+  type: JSON
+audit_state:
+  description: |
+    State of this audit. To get more information about states and
+    audit's lifecycle, visit `Audit State Machine page <https://docs.openstack.org/watcher/latest/architecture.html#audit-state-machine>`_.
+  in: body
+  required: true
+  type: string
+audit_strategy:
+  description: |
+    The UUID or name of the Strategy.
+  in: body
+  required: false
+  type: string
+audit_type:
+  description: |
+    Type of this audit. Can be either ONESHOT or CONTINUOUS.
+  in: body
+  required: true
+  type: string
+
+# Audit Template
+audittemplate_description:
+  description: |
+    Short description of the Audit Template.
+  in: body
+  required: false
+  type: string
+audittemplate_goal:
+  description: |
+    The UUID or name of the Goal.
+  in: body
+  required: true
+  type: string
+audittemplate_name:
+  description: |
+    The name of the Audit template.
+  in: body
+  required: true
+  type: string
+audittemplate_scope:
+  description: |
+    Audit Scope.
+  in: body
+  required: false
+  type: JSON
+audittemplate_strategy:
+  description: |
+    The UUID or name of the Strategy.
+  in: body
+  required: false
+  type: string
+
+created_at:
+  description: |
+    The date and time when the resource was created. The date and time
+    stamp format is `ISO 8601 <https://en.wikipedia.org/wiki/ISO_8601>`_
+  in: body
+  required: true
+  type: string
+deleted_at:
+  description: |
+    The date and time when the resource was deleted. The date and time
+    stamp format is `ISO 8601 <https://en.wikipedia.org/wiki/ISO_8601>`_
+  in: body
+  required: true
+  type: string
+
+# Goal
+goal_display_name:
+  description: |
+    Localized name of the goal.
+  in: body
+  required: true
+  type: string
+goal_efficacy_specification:
+  description: |
+    Efficacy specifications as result of stategy's execution.
+  in: body
+  required: true
+  type: array
+goal_name:
+  description: |
+    Name of the goal.
+  in: body
+  required: true
+  type: string
+goal_uuid:
+  description: |
+    Unique UUID for this goal.
+  in: body
+  required: true
+  type: string
+
+links:
+  description: |
+    A list of relative links. Includes the self and bookmark links.
+  in: body
+  required: true
+  type: array
+
+# Scoring Engine
+scoring_engine_description:
+  description: |
+    A human readable description of the Scoring Engine.
+  in: body
+  required: true
+  type: string
+scoring_engine_metainfo:
+  description: |
+    A metadata associated with the scoring engine
+  in: body
+  required: true
+  type: string
+scoring_engine_name:
+  description: |
+    The name of the scoring engine.
+  in: body
+  required: true
+  type: string
+# Service
+service_host:
+  description: |
+    Name of host where service is placed on.
+  in: body
+  required: true
+  type: string
+service_id:
+  description: |
+    ID of service.
+  in: body
+  required: true
+  type: integer
+service_last_seen_up:
+  description: |
+    Time when Watcher service sent latest heartbeat.
+  in: body
+  required: true
+  type: string
+service_name:
+  description: |
+    Name of service like ``watcher-applier``.
+  in: body
+  required: true
+  type: string
+service_status:
+  description: |
+    State of service. It can be either in ACTIVE or FAILED state.
+  in: body
+  required: true
+  type: string
+
+# Strategy
+strategy_check_comment:
+  description: |
+    Requirement comment.
+  in: body
+  required: true
+  type: string
+strategy_check_mandatory:
+  description: |
+    Whether this requirement mandatory or not.
+  in: body
+  required: true
+  type: boolean
+strategy_check_state:
+  description: |
+    State of requirement for Strategy.
+  in: body
+  required: true
+  type: string or JSON
+strategy_check_type:
+  description: |
+    Type of requirement for Strategy.
+  in: body
+  required: true
+  type: string
+strategy_display_name:
+  description: |
+    Localized name of the strategy.
+  in: body
+  required: true
+  type: string
+strategy_name:
+  description: |
+    Name of the strategy.
+  in: body
+  required: true
+  type: string
+strategy_parameters_spec:
+  description: |
+    Parameters specifications for this strategy.
+  in: body
+  required: true
+  type: JSON
+strategy_uuid:
+  description: |
+    Unique UUID for this strategy.
+  in: body
+  required: true
+  type: string
+
+updated_at:
+  description: |
+    The date and time when the resource was updated. The date and time
+    stamp format is `ISO 8601 <https://en.wikipedia.org/wiki/ISO_8601>`_
+  in: body
+  required: true
+  type: string
+uuid:
+  description: |
+    The UUID for the resource.
+  in: body
+  required: true
+  type: string

api-ref/source/samples/actionplan-cancel-request-cancelling.json

@@ -0,0 +1,7 @@
+[
+    {
+        "op": "replace",
+        "value": "CANCELLING",
+        "path": "/state"
+    }
+]

api-ref/source/samples/actionplan-cancel-request-pending.json

@@ -0,0 +1,7 @@
+[
+    {
+        "op": "replace",
+        "value": "CANCELLED",
+        "path": "/state"
+    }
+]

api-ref/source/samples/actionplan-list-detailed-response.json

@@ -0,0 +1,26 @@
+{
+    "action_plans": [
+        {
+            "state": "ONGOING",
+            "efficacy_indicators": [],
+            "strategy_uuid": "7dae0eea-9df7-42b8-bb3e-313958ff2242",
+            "global_efficacy": [],
+            "links": [
+                {
+                    "rel": "self",
+                    "href": "http://controller:9322/v1/action_plans/4cbc4ede-0d25-481b-b86e-998dbbd4f8bf"
+                },
+                {
+                    "rel": "bookmark",
+                    "href": "http://controller:9322/action_plans/4cbc4ede-0d25-481b-b86e-998dbbd4f8bf"
+                }
+            ],
+            "updated_at": "2018-04-10T11:59:52.640067+00:00",
+            "strategy_name": "dummy_with_resize",
+            "deleted_at": null,
+            "uuid": "4cbc4ede-0d25-481b-b86e-998dbbd4f8bf",
+            "audit_uuid": "7d100b05-0a86-491f-98a7-f93da19b272a",
+            "created_at": "2018-04-10T11:59:52.640067+00:00"
+        }
+    ]
+}

api-ref/source/samples/actionplan-list-response.json

@@ -0,0 +1,24 @@
+{
+    "action_plans": [
+        {
+            "state": "ONGOING",
+            "efficacy_indicators": [],
+            "strategy_uuid": "7dae0eea-9df7-42b8-bb3e-313958ff2242",
+            "global_efficacy": [],
+            "links": [
+                {
+                    "rel": "self",
+                    "href": "http://controller:9322/v1/action_plans/4cbc4ede-0d25-481b-b86e-998dbbd4f8bf"
+                },
+                {
+                    "rel": "bookmark",
+                    "href": "http://controller:9322/action_plans/4cbc4ede-0d25-481b-b86e-998dbbd4f8bf"
+                }
+            ],
+            "updated_at": "2018-04-10T11:59:52.640067+00:00",
+            "strategy_name": "dummy_with_resize",
+            "uuid": "4cbc4ede-0d25-481b-b86e-998dbbd4f8bf",
+            "audit_uuid": "7d100b05-0a86-491f-98a7-f93da19b272a"
+        }
+    ]
+}

api-ref/source/samples/actionplan-show-response.json

@@ -0,0 +1,20 @@
+{
+    "state": "ONGOING",
+    "efficacy_indicators": [],
+    "strategy_uuid": "7dae0eea-9df7-42b8-bb3e-313958ff2242",
+    "global_efficacy": [],
+    "links": [
+        {
+            "rel": "self",
+            "href": "http://controller:9322/v1/action_plans/4cbc4ede-0d25-481b-b86e-998dbbd4f8bf"
+        },
+        {
+            "rel": "bookmark",
+            "href": "http://controller:9322/action_plans/4cbc4ede-0d25-481b-b86e-998dbbd4f8bf"
+        }
+    ],
+    "updated_at": "2018-04-10T11:59:52.640067+00:00",
+    "strategy_name": "dummy_with_resize",
+    "uuid": "4cbc4ede-0d25-481b-b86e-998dbbd4f8bf",
+    "audit_uuid": "7d100b05-0a86-491f-98a7-f93da19b272a"
+}

api-ref/source/samples/actionplan-start-response.json

@@ -0,0 +1,22 @@
+{
+    "state": "PENDING",
+    "efficacy_indicators": [],
+    "strategy_uuid": "7dae0eea-9df7-42b8-bb3e-313958ff2242",
+    "global_efficacy": [],
+    "links": [
+        {
+            "rel": "self",
+            "href": "http://controller:9322/v1/action_plans/4cbc4ede-0d25-481b-b86e-998dbbd4f8bf"
+        },
+        {
+            "rel": "bookmark",
+            "href": "http://controller:9322/action_plans/4cbc4ede-0d25-481b-b86e-998dbbd4f8bf"
+        }
+    ],
+    "updated_at": "2018-04-10T11:59:41.602430+00:00",
+    "strategy_name": "dummy_with_resize",
+    "uuid": "4cbc4ede-0d25-481b-b86e-998dbbd4f8bf",
+    "audit_uuid": "7d100b05-0a86-491f-98a7-f93da19b272a",
+    "created_at": "2018-04-10T11:59:12.592729+00:00",
+    "deleted_at": null
+}

api-ref/source/samples/actions-list-detailed-response.json

@@ -0,0 +1,30 @@
+{
+    "actions": [
+        {
+            "state": "PENDING",
+            "description": "Wait for a given interval in seconds.",
+            "parents": [
+                "8119d16e-b419-4729-b015-fc04c4e45783"
+            ],
+            "links": [
+                {
+                    "rel": "self",
+                    "href": "http://controller:9322/v1/actions/7182a988-e6c4-4152-a0d6-067119475c83"
+                },
+                {
+                    "rel": "bookmark",
+                    "href": "http://controller:9322/actions/7182a988-e6c4-4152-a0d6-067119475c83"
+                }
+            ],
+            "action_plan_uuid": "c6bba9ed-a7eb-4370-9993-d873e5e22cba",
+            "uuid": "7182a988-e6c4-4152-a0d6-067119475c83",
+            "deleted_at": null,
+            "updated_at": null,
+            "input_parameters": {
+                "duration": 3.2
+            },
+            "action_type": "sleep",
+            "created_at": "2018-03-26T11:56:08.235226+00:00"
+        }
+    ]
+}

api-ref/source/samples/actions-list-response.json

@@ -0,0 +1,23 @@
+{
+    "actions": [
+        {
+            "state": "PENDING",
+            "parents": [
+                "8119d16e-b419-4729-b015-fc04c4e45783"
+            ],
+            "links": [
+                {
+                    "rel": "self",
+                    "href": "http://controller:9322/v1/actions/7182a988-e6c4-4152-a0d6-067119475c83"
+                },
+                {
+                    "rel": "bookmark",
+                    "href": "http://controller:9322/actions/7182a988-e6c4-4152-a0d6-067119475c83"
+                }
+            ],
+            "action_plan_uuid": "c6bba9ed-a7eb-4370-9993-d873e5e22cba",
+            "uuid": "7182a988-e6c4-4152-a0d6-067119475c83",
+            "action_type": "sleep"
+        }
+    ]
+}

api-ref/source/samples/actions-show-response.json

@@ -0,0 +1,26 @@
+{
+    "state": "SUCCEEDED",
+    "description": "Logging a NOP message",
+    "parents": [
+        "b4529294-1de6-4302-b57a-9b5d5dc363c6"
+    ],
+    "links": [
+        {
+            "rel": "self",
+            "href": "http://controller:9322/v1/actions/54acc7a0-91b0-46ea-a5f7-4ae2b9df0b0a"
+        },
+        {
+            "rel": "bookmark",
+            "href": "http://controller:9322/actions/54acc7a0-91b0-46ea-a5f7-4ae2b9df0b0a"
+        }
+    ],
+    "action_plan_uuid": "4cbc4ede-0d25-481b-b86e-998dbbd4f8bf",
+    "uuid": "54acc7a0-91b0-46ea-a5f7-4ae2b9df0b0a",
+    "deleted_at": null,
+    "updated_at": "2018-04-10T11:59:44.026973+00:00",
+    "input_parameters": {
+        "message": "Welcome"
+    },
+    "action_type": "nop",
+    "created_at": "2018-04-10T11:59:12.725147+00:00"
+}

api-ref/source/samples/audit-cancel-request.json

@@ -0,0 +1,7 @@
+[
+    {
+        "op": "replace",
+        "value": "CANCELLED",
+        "path": "/state"
+    }
+]

api-ref/source/samples/audit-cancel-response.json

@@ -0,0 +1,51 @@
+{
+    "interval": "*/2 * * * *",
+    "strategy_uuid": "6b3b3902-8508-4cb0-bb85-67f32866b086",
+    "goal_uuid": "e1a5a45b-f251-47cf-9c5f-fa1e66e1286a",
+    "name": "audit1",
+    "parameters": {
+        "host_choice": "retry",
+        "instance_metrics": {
+            "cpu_util": "compute.node.cpu.percent",
+            "memory.resident": "hardware.memory.used"
+        },
+        "granularity": 300,
+        "weights": {
+            "cpu_util_weight": 1.0,
+            "memory.resident_weight": 1.0
+        },
+        "retry_count": 1,
+        "metrics": [
+            "cpu_util"
+        ],
+        "periods": {
+            "instance": 720,
+            "node": 600
+        },
+        "thresholds": {
+            "cpu_util": 0.2,
+            "memory.resident": 0.2
+        }
+    },
+    "auto_trigger": false,
+    "uuid": "65a5da84-5819-4aea-8278-a28d2b489028",
+    "goal_name": "workload_balancing",
+    "scope": [],
+    "created_at": "2018-04-06T07:27:27.820460+00:00",
+    "deleted_at": null,
+    "state": "CANCELLED",
+    "audit_type": "CONTINUOUS",
+    "links": [
+        {
+            "rel": "self",
+            "href": "http://controller:9322/v1/audits/65a5da84-5819-4aea-8278-a28d2b489028"
+        },
+        {
+            "rel": "bookmark",
+            "href": "http://controller:9322/audits/65a5da84-5819-4aea-8278-a28d2b489028"
+        }
+    ],
+    "strategy_name": "workload_stabilization",
+    "next_run_time": "2018-04-06T11:56:00",
+    "updated_at": "2018-04-06T11:54:01.266447+00:00"
+}

api-ref/source/samples/audit-create-request-continuous.json

@@ -0,0 +1,12 @@
+{
+    "auto_trigger": false,
+    "audit_template_uuid": "76fddfee-a9c4-40b0-8da0-c19ad6904f09",
+    "name": "test_audit",
+    "parameters": {
+        "metrics": [
+            "cpu_util"
+        ]
+    },
+    "audit_type": "CONTINUOUS",
+    "interval": "*/2 * * * *"
+}

api-ref/source/samples/audit-create-request-oneshot.json

@@ -0,0 +1,5 @@
+{
+    "audit_type": "ONESHOT",
+    "auto_trigger": false,
+    "audit_template_uuid": "5e70a156-ced7-4012-b1c6-88fcb02ee0c1"
+}

api-ref/source/samples/audit-create-response.json

@@ -0,0 +1,51 @@
+{
+    "interval": "*/2 * * * *",
+    "strategy_uuid": "6b3b3902-8508-4cb0-bb85-67f32866b086",
+    "goal_uuid": "e1a5a45b-f251-47cf-9c5f-fa1e66e1286a",
+    "name": "test_audit",
+    "parameters": {
+        "host_choice": "retry",
+        "granularity": 300,
+        "thresholds": {
+            "cpu_util": 0.2,
+            "memory.resident": 0.2
+        },
+        "periods": {
+            "node": 600,
+            "instance": 720
+        },
+        "retry_count": 1,
+        "metrics": [
+            "cpu_util"
+        ],
+        "weights": {
+            "cpu_util_weight": 1.0,
+            "memory.resident_weight": 1.0
+        },
+        "instance_metrics": {
+            "cpu_util": "compute.node.cpu.percent",
+            "memory.resident": "hardware.memory.used"
+        }
+    },
+    "auto_trigger": false,
+    "uuid": "65a5da84-5819-4aea-8278-a28d2b489028",
+    "goal_name": "workload_balancing",
+    "scope": [],
+    "created_at": "2018-04-06T07:27:27.820460+00:00",
+    "deleted_at": null,
+    "state": "PENDING",
+    "audit_type": "CONTINUOUS",
+    "links": [
+        {
+            "rel": "self",
+            "href": "http://controller:9322/v1/audits/65a5da84-5819-4aea-8278-a28d2b489028"
+        },
+        {
+            "rel": "bookmark",
+            "href": "http://controller:9322/audits/65a5da84-5819-4aea-8278-a28d2b489028"
+        }
+    ],
+    "strategy_name": "workload_stabilization",
+    "next_run_time": null,
+    "updated_at": null
+}

api-ref/source/samples/audit-list-detailed-response.json

@@ -0,0 +1,55 @@
+{
+    "audits": [
+        {
+            "interval": "*/2 * * * *",
+            "strategy_uuid": "6b3b3902-8508-4cb0-bb85-67f32866b086",
+            "goal_uuid": "e1a5a45b-f251-47cf-9c5f-fa1e66e1286a",
+            "name": "test_audit",
+            "parameters": {
+                "host_choice": "retry",
+                "instance_metrics": {
+                    "cpu_util": "compute.node.cpu.percent",
+                    "memory.resident": "hardware.memory.used"
+                },
+                "granularity": 300,
+                "weights": {
+                    "cpu_util_weight": 1.0,
+                    "memory.resident_weight": 1.0
+                },
+                "retry_count": 1,
+                "metrics": [
+                    "cpu_util"
+                ],
+                "periods": {
+                    "instance": 720,
+                    "node": 600
+                },
+                "thresholds": {
+                    "cpu_util": 0.2,
+                    "memory.resident": 0.2
+                }
+            },
+            "auto_trigger": false,
+            "uuid": "65a5da84-5819-4aea-8278-a28d2b489028",
+            "goal_name": "workload_balancing",
+            "scope": [],
+            "created_at": "2018-04-06T07:27:27.820460+00:00",
+            "deleted_at": null,
+            "state": "ONGOING",
+            "audit_type": "CONTINUOUS",
+            "links": [
+                {
+                    "rel": "self",
+                    "href": "http://controller:9322/v1/audits/65a5da84-5819-4aea-8278-a28d2b489028"
+                },
+                {
+                    "rel": "bookmark",
+                    "href": "http://controller:9322/audits/65a5da84-5819-4aea-8278-a28d2b489028"
+                }
+            ],
+            "strategy_name": "workload_stabilization",
+            "next_run_time": "2018-04-06T09:46:00",
+            "updated_at": "2018-04-06T09:44:01.604146+00:00"
+        }
+    ]
+}

api-ref/source/samples/audit-list-response.json

@@ -0,0 +1,28 @@
+{
+    "audits": [
+        {
+            "interval": null,
+            "strategy_uuid": "e311727b-b9b3-43ef-a5f7-8bd7ea80df25",
+            "goal_uuid": "4690f8ba-18ff-45c1-99e9-159556d23810",
+            "name": "dummy-2018-03-26T11:56:07.950400",
+            "auto_trigger": false,
+            "uuid": "ccc69a5f-114e-46f4-b15e-a77eaa337b01",
+            "goal_name": "dummy",
+            "scope": [],
+            "state": "SUCCEEDED",
+            "audit_type": "ONESHOT",
+            "links": [
+                {
+                    "rel": "self",
+                    "href": "http://controller:9322/v1/audits/ccc69a5f-114e-46f4-b15e-a77eaa337b01"
+                },
+                {
+                    "rel": "bookmark",
+                    "href": "http://controller:9322/audits/ccc69a5f-114e-46f4-b15e-a77eaa337b01"
+                }
+            ],
+            "strategy_name": "dummy",
+            "next_run_time": null
+        }
+    ]
+}

api-ref/source/samples/audit-show-response.json

@@ -0,0 +1,51 @@
+{
+    "interval": "*/2 * * * *",
+    "strategy_uuid": "6b3b3902-8508-4cb0-bb85-67f32866b086",
+    "goal_uuid": "e1a5a45b-f251-47cf-9c5f-fa1e66e1286a",
+    "name": "test_audit",
+    "parameters": {
+        "host_choice": "retry",
+        "instance_metrics": {
+            "cpu_util": "compute.node.cpu.percent",
+            "memory.resident": "hardware.memory.used"
+        },
+        "granularity": 300,
+        "weights": {
+            "cpu_util_weight": 1.0,
+            "memory.resident_weight": 1.0
+        },
+        "retry_count": 1,
+        "metrics": [
+            "cpu_util"
+        ],
+        "periods": {
+            "instance": 720,
+            "node": 600
+        },
+        "thresholds": {
+            "cpu_util": 0.2,
+            "memory.resident": 0.2
+        }
+    },
+    "auto_trigger": false,
+    "uuid": "65a5da84-5819-4aea-8278-a28d2b489028",
+    "goal_name": "workload_balancing",
+    "scope": [],
+    "created_at": "2018-04-06T07:27:27.820460+00:00",
+    "deleted_at": null,
+    "state": "ONGOING",
+    "audit_type": "CONTINUOUS",
+    "links": [
+        {
+            "rel": "self",
+            "href": "http://controller:9322/v1/audits/65a5da84-5819-4aea-8278-a28d2b489028"
+        },
+        {
+            "rel": "bookmark",
+            "href": "http://controller:9322/audits/65a5da84-5819-4aea-8278-a28d2b489028"
+        }
+    ],
+    "strategy_name": "workload_stabilization",
+    "next_run_time": "2018-04-06T11:56:00",
+    "updated_at": "2018-04-06T11:54:01.266447+00:00"
+}

api-ref/source/samples/audit-update-request.json

@@ -0,0 +1,12 @@
+[
+    {
+        "value": "CANCELLED",
+        "path": "/state",
+        "op": "replace"
+    },
+    {
+        "value": "audit1",
+        "path": "/name",
+        "op": "replace"
+    }
+]

api-ref/source/samples/audit-update-response.json

@@ -0,0 +1,51 @@
+{
+    "interval": "*/2 * * * *",
+    "strategy_uuid": "6b3b3902-8508-4cb0-bb85-67f32866b086",
+    "goal_uuid": "e1a5a45b-f251-47cf-9c5f-fa1e66e1286a",
+    "name": "audit1",
+    "parameters": {
+        "host_choice": "retry",
+        "instance_metrics": {
+            "cpu_util": "compute.node.cpu.percent",
+            "memory.resident": "hardware.memory.used"
+        },
+        "granularity": 300,
+        "weights": {
+            "cpu_util_weight": 1.0,
+            "memory.resident_weight": 1.0
+        },
+        "retry_count": 1,
+        "metrics": [
+            "cpu_util"
+        ],
+        "periods": {
+            "instance": 720,
+            "node": 600
+        },
+        "thresholds": {
+            "cpu_util": 0.2,
+            "memory.resident": 0.2
+        }
+    },
+    "auto_trigger": false,
+    "uuid": "65a5da84-5819-4aea-8278-a28d2b489028",
+    "goal_name": "workload_balancing",
+    "scope": [],
+    "created_at": "2018-04-06T07:27:27.820460+00:00",
+    "deleted_at": null,
+    "state": "CANCELLED",
+    "audit_type": "CONTINUOUS",
+    "links": [
+        {
+            "rel": "self",
+            "href": "http://controller:9322/v1/audits/65a5da84-5819-4aea-8278-a28d2b489028"
+        },
+        {
+            "rel": "bookmark",
+            "href": "http://controller:9322/audits/65a5da84-5819-4aea-8278-a28d2b489028"
+        }
+    ],
+    "strategy_name": "workload_stabilization",
+    "next_run_time": "2018-04-06T11:56:00",
+    "updated_at": "2018-04-06T11:54:01.266447+00:00"
+}

api-ref/source/samples/audittemplate-create-request-full.json

@@ -0,0 +1,7 @@
+{
+    "name": "at2",
+    "goal": "dummy",
+    "strategy": "dummy",
+    "description": "the second audit template",
+    "scope": []
+}

api-ref/source/samples/audittemplate-create-request-minimal.json

@@ -0,0 +1,4 @@
+{
+    "name": "at2",
+    "goal": "dummy"
+}

api-ref/source/samples/audittemplate-create-response.json

@@ -0,0 +1,23 @@
+{
+    "description": null,
+    "strategy_uuid": null,
+    "goal_uuid": "4690f8ba-18ff-45c1-99e9-159556d23810",
+    "name": "at3",
+    "uuid": "b4041d8c-85d7-4224-851d-649fe48b7196",
+    "goal_name": "dummy",
+    "scope": [],
+    "created_at": "2018-04-04T08:38:33.110432+00:00",
+    "deleted_at": null,
+    "links": [
+        {
+            "rel": "self",
+            "href": "http://controller:9322/v1/audit_templates/b4041d8c-85d7-4224-851d-649fe48b7196"
+        },
+        {
+            "rel": "bookmark",
+            "href": "http://controller:9322/audit_templates/b4041d8c-85d7-4224-851d-649fe48b7196"
+        }
+    ],
+    "strategy_name": null,
+    "updated_at": null
+}

api-ref/source/samples/audittemplate-list-detailed-response.json

@@ -0,0 +1,23 @@
+{
+    "audit_templates":[
+        {
+            "strategy_uuid": null,
+            "goal_uuid": "4690f8ba-18ff-45c1-99e9-159556d23810",
+            "name": "at3",
+            "links": [
+                {
+                    "rel": "self",
+                    "href": "http://controller:9322/v1/audit_templates/b4041d8c-85d7-4224-851d-649fe48b7196"
+                },
+                {
+                    "rel": "bookmark", "href":
+                    "http://controller:9322/audit_templates/b4041d8c-85d7-4224-851d-649fe48b7196"
+                }
+            ],
+            "strategy_name": null,
+            "uuid": "b4041d8c-85d7-4224-851d-649fe48b7196",
+            "goal_name": "dummy", "scope": [],
+            "description": null
+        }
+    ]
+}

api-ref/source/samples/audittemplate-list-response.json

@@ -0,0 +1,22 @@
+{
+    "audit_templates":[
+        {
+            "strategy_uuid": null,
+            "goal_uuid": "4690f8ba-18ff-45c1-99e9-159556d23810",
+            "name": "at3",
+            "links": [
+                {
+                    "rel": "self",
+                    "href": "http://controller:9322/v1/audit_templates/b4041d8c-85d7-4224-851d-649fe48b7196"
+                },
+                {
+                    "rel": "bookmark", "href":
+                    "http://controller:9322/audit_templates/b4041d8c-85d7-4224-851d-649fe48b7196"
+                }
+            ],
+            "strategy_name": null,
+            "uuid": "b4041d8c-85d7-4224-851d-649fe48b7196",
+            "goal_name": "dummy", "scope": []
+        }
+    ]
+}

api-ref/source/samples/audittemplate-show-response.json

@@ -0,0 +1,23 @@
+{
+    "description": "test 1",
+    "strategy_uuid": null,
+    "goal_uuid": "4690f8ba-18ff-45c1-99e9-159556d23810",
+    "name": "at1",
+    "uuid": "0d100c27-14af-4962-86fb-f6079287c9c6",
+    "goal_name": "dummy",
+    "scope": [],
+    "created_at": "2018-04-04T07:48:36.175472+00:00",
+    "deleted_at": null,
+    "links": [
+        {
+            "rel": "self",
+            "href": "http://controller:9322/v1/audit_templates/0d100c27-14af-4962-86fb-f6079287c9c6"
+        },
+        {
+            "rel": "bookmark",
+            "href": "http://controller:9322/audit_templates/0d100c27-14af-4962-86fb-f6079287c9c6"
+        }
+    ],
+    "strategy_name": null,
+    "updated_at": "2018-04-05T07:57:55.803650+00:00"
+}

api-ref/source/samples/audittemplate-update-request.json

@@ -0,0 +1,7 @@
+[
+    {
+        "op": "replace",
+        "value": "PENDING",
+        "path": "/state"
+    }
+]

api-ref/source/samples/audittemplate-update-response.json

@@ -0,0 +1,23 @@
+{
+    "description": "test 1",
+    "strategy_uuid": null,
+    "goal_uuid": "4690f8ba-18ff-45c1-99e9-159556d23810",
+    "name": "at11",
+    "uuid": "0d100c27-14af-4962-86fb-f6079287c9c6",
+    "goal_name": "dummy",
+    "scope": [],
+    "created_at": "2018-04-04T07:48:36.175472+00:00",
+    "deleted_at": null,
+    "links": [
+        {
+            "rel": "self",
+            "href": "http://controller:9322/v1/audit_templates/0d100c27-14af-4962-86fb-f6079287c9c6"
+        },
+        {
+            "rel": "bookmark",
+            "href": "http://controller:9322/audit_templates/0d100c27-14af-4962-86fb-f6079287c9c6"
+        }
+    ],
+    "strategy_name": null,
+    "updated_at": "2018-04-05T07:57:42.139127+00:00"
+}

api-ref/source/samples/goal-list-response.json

@@ -0,0 +1,55 @@
+{
+    "goals": [
+        {
+            "efficacy_specification": [],
+            "uuid": "e1a5a45b-f251-47cf-9c5f-fa1e66e1286a",
+            "links": [
+                {
+                    "rel": "self",
+                    "href": "http://controller:9322/v1/goals/e1a5a45b-f251-47cf-9c5f-fa1e66e1286a"
+                },
+                {
+                    "rel": "bookmark",
+                    "href": "http://controller:9322/goals/e1a5a45b-f251-47cf-9c5f-fa1e66e1286a"
+                }
+            ],
+            "name": "workload_balancing",
+            "display_name": "Workload Balancing"
+        },
+        {
+            "efficacy_specification": [
+                {
+                    "description": "The total number of enabled compute nodes.",
+                    "schema": "Range(min=0, max=None, min_included=True, max_included=True, msg=None)",
+                    "name": "compute_nodes_count",
+                    "unit": null
+                },
+                {
+                    "description": "The number of compute nodes to be released.",
+                    "schema": "Range(min=0, max=None, min_included=True, max_included=True, msg=None)",
+                    "name": "released_compute_nodes_count",
+                    "unit": null
+                },
+                {
+                    "description": "The number of VM migrations to be performed.",
+                    "schema": "Range(min=0, max=None, min_included=True, max_included=True, msg=None)",
+                    "name": "instance_migrations_count",
+                    "unit": null
+                }
+            ],
+            "uuid": "cb9afa5e-aec7-4a8c-9261-c15c33f2262b",
+            "links": [
+                {
+                    "rel": "self",
+                    "href": "http://controller:9322/v1/goals/cb9afa5e-aec7-4a8c-9261-c15c33f2262b"
+                },
+                {
+                    "rel": "bookmark",
+                    "href": "http://controller:9322/goals/cb9afa5e-aec7-4a8c-9261-c15c33f2262b"
+                }
+            ],
+            "name": "server_consolidation",
+            "display_name": "Server Consolidation"
+        }
+    ]
+}

api-ref/source/samples/goal-show-response.json

@@ -0,0 +1,19 @@
+{
+    "efficacy_specification": [],
+    "name": "saving_energy",
+    "links": [
+        {
+            "rel": "self",
+            "href": "http://controller:9322/v1/goals/6f52889a-9dd4-4dbb-8e70-39b56c4836cc"
+        },
+        {
+            "rel": "bookmark",
+            "href": "http://controller:9322/goals/6f52889a-9dd4-4dbb-8e70-39b56c4836cc"
+        }
+    ],
+    "uuid": "6f52889a-9dd4-4dbb-8e70-39b56c4836cc",
+    "updated_at": null,
+    "display_name": "Saving Energy",
+    "created_at": "2018-03-26T11:55:24.365584+00:00",
+    "deleted_at": null
+}

api-ref/source/samples/scoring_engine-list-detailed-response.json

@@ -0,0 +1,20 @@
+{
+    "scoring_engines": [
+        {
+            "description": "Dummy Scorer calculating the average value",
+            "uuid": "5a44f007-55b1-423c-809f-6a274a9bd93b",
+            "links": [
+                {
+                    "rel": "self",
+                    "href": "http://controller:9322/v1/scoring_engines/5a44f007-55b1-423c-809f-6a274a9bd93b"
+                },
+                {
+                    "rel": "bookmark",
+                    "href": "http://controller:9322/scoring_engines/5a44f007-55b1-423c-809f-6a274a9bd93b"
+                }
+            ],
+            "name": "dummy_avg_scorer",
+            "metainfo": ""
+        }
+    ]
+}

api-ref/source/samples/scoring_engine-list-response.json

@@ -0,0 +1,19 @@
+{
+    "scoring_engines": [
+        {
+            "description": "Dummy Scorer calculating the average value",
+            "uuid": "5a44f007-55b1-423c-809f-6a274a9bd93b",
+            "links": [
+                {
+                    "rel": "self",
+                    "href": "http://controller:9322/v1/scoring_engines/5a44f007-55b1-423c-809f-6a274a9bd93b"
+                },
+                {
+                    "rel": "bookmark",
+                    "href": "http://controller:9322/scoring_engines/5a44f007-55b1-423c-809f-6a274a9bd93b"
+                }
+            ],
+            "name": "dummy_avg_scorer"
+        }
+    ]
+}

api-ref/source/samples/scoring_engine-show-response.json

@@ -0,0 +1,16 @@
+{
+    "description": "Dummy Scorer calculating the maximum value",
+    "uuid": "1ac42282-4e77-473e-898b-62ea007f1deb",
+    "links": [
+        {
+            "rel": "self",
+            "href": "http://controller:9322/v1/scoring_engines/1ac42282-4e77-473e-898b-62ea007f1deb"
+        },
+        {
+            "rel": "bookmark",
+            "href": "http://controller:9322/scoring_engines/1ac42282-4e77-473e-898b-62ea007f1deb"
+        }
+    ],
+    "name": "dummy_max_scorer",
+    "metainfo": ""
+}

api-ref/source/samples/service-list-detailed-response.json

@@ -0,0 +1,24 @@
+{
+    "services": [
+        {
+            "status": "ACTIVE",
+            "name": "watcher-applier",
+            "host": "controller",
+            "links": [
+                {
+                    "rel": "self",
+                    "href": "http://controller:9322/v1/services/1"
+                },
+                {
+                    "rel": "bookmark",
+                    "href": "http://controller:9322/services/1"
+                }
+            ],
+            "id": 1,
+            "deleted_at": null,
+            "updated_at": "2018-04-26T08:52:37.652895+00:00",
+            "last_seen_up": "2018-04-26T08:52:37.648572",
+            "created_at": "2018-03-26T11:55:24.075093+00:00"
+        }
+    ]
+}

api-ref/source/samples/service-list-response.json

@@ -0,0 +1,36 @@
+{
+    "services": [
+        {
+            "id": 1,
+            "status": "ACTIVE",
+            "name": "watcher-applier",
+            "host": "controller",
+            "links": [
+                {
+                    "rel": "self",
+                    "href": "http://controller:9322/v1/services/1"
+                },
+                {
+                    "rel": "bookmark",
+                    "href": "http://controller:9322/services/1"
+                }
+            ]
+        },
+        {
+            "id": 2,
+            "status": "ACTIVE",
+            "name": "watcher-decision-engine",
+            "host": "controller",
+            "links": [
+                {
+                    "rel": "self",
+                    "href": "http://controller:9322/v1/services/2"
+                },
+                {
+                    "rel": "bookmark",
+                    "href": "http://controller:9322/services/2"
+                }
+            ]
+        }
+    ]
+}

api-ref/source/samples/service-show-response.json

@@ -0,0 +1,20 @@
+{
+    "status": "ACTIVE",
+    "name": "watcher-applier",
+    "host": "controller",
+    "links": [
+        {
+            "rel": "self",
+            "href": "http://controller:9322/v1/services/1"
+        },
+        {
+            "rel": "bookmark",
+            "href": "http://controller:9322/services/1"
+        }
+    ],
+    "id": 1,
+    "deleted_at": null,
+    "updated_at": "2018-04-26T09:45:37.653061+00:00",
+    "last_seen_up": "2018-04-26T09:45:37.649314",
+    "created_at": "2018-03-26T11:55:24.075093+00:00"
+}

api-ref/source/samples/strategy-list-detailed-response.json

@@ -0,0 +1,35 @@
+{
+    "strategies": [
+        {
+            "goal_uuid": "cb9afa5e-aec7-4a8c-9261-c15c33f2262b",
+            "name": "vm_workload_consolidation",
+            "links": [
+                {
+                    "rel": "self",
+                    "href": "http://controller:9322/v1/strategies/6382b2d7-259e-487d-88db-78c852ffea54"
+                },
+                {
+                    "rel": "bookmark",
+                    "href": "http://controller:9322/strategies/6382b2d7-259e-487d-88db-78c852ffea54"
+                }
+            ],
+            "parameters_spec": {
+                "properties": {
+                    "granularity": {
+                        "default": 300,
+                        "type": "number",
+                        "description": "The time between two measures in an aggregated timeseries of a metric."
+                    },
+                    "period": {
+                        "default": 3600,
+                        "type": "number",
+                        "description": "The time interval in seconds for getting statistic aggregation"
+                    }
+                }
+            },
+            "uuid": "6382b2d7-259e-487d-88db-78c852ffea54",
+            "goal_name": "server_consolidation",
+            "display_name": "VM Workload Consolidation Strategy"
+        }
+    ]
+}

api-ref/source/samples/strategy-list-response.json

@@ -0,0 +1,21 @@
+{
+    "strategies": [
+        {
+            "goal_uuid": "4690f8ba-18ff-45c1-99e9-159556d23810",
+            "name": "dummy",
+            "links": [
+                {
+                    "rel": "self",
+                    "href": "http://controller:9322/v1/strategies/e311727b-b9b3-43ef-a5f7-8bd7ea80df25"
+                },
+                {
+                    "rel": "bookmark",
+                    "href": "http://controller:9322/strategies/e311727b-b9b3-43ef-a5f7-8bd7ea80df25"
+                }
+            ],
+            "uuid": "e311727b-b9b3-43ef-a5f7-8bd7ea80df25",
+            "goal_name": "dummy",
+            "display_name": "Dummy strategy"
+        }
+    ]
+}

api-ref/source/samples/strategy-show-response.json

@@ -0,0 +1,33 @@
+{
+    "goal_uuid": "4690f8ba-18ff-45c1-99e9-159556d23810",
+    "name": "dummy",
+    "links": [
+        {
+            "rel": "self",
+            "href": "http://controller:9322/v1/strategies/e311727b-b9b3-43ef-a5f7-8bd7ea80df25"
+        },
+        {
+            "rel": "bookmark",
+            "href": "http://controller:9322/strategies/e311727b-b9b3-43ef-a5f7-8bd7ea80df25"
+        }
+    ],
+    "parameters_spec": {
+        "properties": {
+            "para2": {
+                "default": "hello",
+                "type": "string",
+                "description": "string parameter example"
+            },
+            "para1": {
+                "maximum": 10.2,
+                "type": "number",
+                "minimum": 1.0,
+                "description": "number parameter example",
+                "default": 3.2
+            }
+        }
+    },
+    "uuid": "e311727b-b9b3-43ef-a5f7-8bd7ea80df25",
+    "goal_name": "dummy",
+    "display_name": "Dummy strategy"
+}

api-ref/source/samples/strategy-state-response.json

@@ -0,0 +1,49 @@
+[
+    {
+        "state": "gnocchi: available",
+        "comment": "",
+        "mandatory": true,
+        "type": "Datasource"
+    },
+    {
+        "state": [
+            {
+                "compute.node.cpu.percent": "available"
+            },
+            {
+                "cpu_util": "available"
+            },
+            {
+                "memory.resident": "available"
+            },
+            {
+                "hardware.memory.used": "available"
+            }
+        ],
+        "comment": "",
+        "mandatory": false,
+        "type": "Metrics"
+    },
+    {
+        "state": [
+            {
+                "compute_model": "available"
+            },
+            {
+                "storage_model": "not available"
+            },
+            {
+                "baremetal_model": "not available"
+            }
+        ],
+        "comment": "",
+        "mandatory": true,
+        "type": "CDM"
+    },
+    {
+        "state": "workload_stabilization",
+        "mandatory": "",
+        "comment": "",
+        "type": "Name"
+    }
+]

api-ref/source/watcher-api-v1-actionplans.inc

@@ -0,0 +1,254 @@
+.. -*- rst -*-
+
+============
+Action Plans
+============
+
+An ``Action Plan`` specifies a flow of ``Actions`` that should be executed
+in order to satisfy a given ``Goal``. It also contains an estimated
+``global efficacy`` alongside a set of ``efficacy indicators``.
+
+An ``Action Plan`` is generated by Watcher when an ``Audit`` is successful
+which implies that the ``Strategy`` which was used has found a ``Solution``
+to achieve the ``Goal`` of this ``Audit``.
+
+In the default implementation of Watcher, an action plan is composed of
+a graph of linked ``Actions``. Each action may have parent actions, which
+should be executed prior to child action.
+
+Start Action Plan
+=================
+
+.. rest_method::  POST /v1/action_plans/{actionplan_ident}/start
+
+Starts a created Action Plan resource.
+
+Normal response codes: 200
+
+Error codes: 400,404
+
+Request
+-------
+
+.. rest_parameters:: parameters.yaml
+
+   - actionplan_ident: actionplan_ident
+
+Response
+--------
+
+The list and example below are representative of the response as of API
+version 1:
+
+.. rest_parameters:: parameters.yaml
+
+    - uuid: uuid
+    - state: actionplan_state
+    - audit_uuid: actionplan_audit_uuid
+    - strategy_uuid: strategy_uuid
+    - strategy_name: strategy_name
+    - efficacy_indicators: actionplan_efficacy_indicators
+    - global_efficacy: actionplan_global_efficacy
+    - links: links
+
+**Example JSON representation of an Action Plan:**
+
+.. literalinclude:: samples/actionplan-start-response.json
+   :language: javascript
+
+List Action Plan
+================
+
+.. rest_method::  GET /v1/action_plans
+
+Returns a list of Action Plan resources.
+
+Normal response codes: 200
+
+Error codes: 400,401
+
+Request
+-------
+
+.. rest_parameters:: parameters.yaml
+
+   - audit_uuid: r_audit
+   - strategy: r_strategy
+   - limit: limit
+   - marker: marker
+   - sort_dir: sort_dir
+   - sort_key: sort_key
+
+Response
+--------
+
+.. rest_parameters:: parameters.yaml
+
+    - uuid: uuid
+    - state: actionplan_state
+    - audit_uuid: actionplan_audit_uuid
+    - strategy_uuid: strategy_uuid
+    - strategy_name: strategy_name
+    - efficacy_indicators: actionplan_efficacy_indicators
+    - global_efficacy: actionplan_global_efficacy
+    - links: links
+
+**Example JSON representation of an Action Plan:**
+
+.. literalinclude:: samples/actionplan-list-response.json
+   :language: javascript
+
+List Action Plan detailed
+=========================
+
+.. rest_method::  GET /v1/action_plans/detail
+
+Returns a list of Action Plan resources with complete details.
+
+Normal response codes: 200
+
+Error codes: 400,401
+
+Request
+-------
+
+.. rest_parameters:: parameters.yaml
+
+   - audit_uuid: r_audit
+   - strategy: r_strategy
+   - limit: limit
+   - marker: marker
+   - sort_dir: sort_dir
+   - sort_key: sort_key
+
+Response
+--------
+
+.. rest_parameters:: parameters.yaml
+
+    - deleted_at: deleted_at
+    - updated_at: updated_at
+    - created_at: created_at
+    - uuid: uuid
+    - state: actionplan_state
+    - audit_uuid: actionplan_audit_uuid
+    - strategy_uuid: strategy_uuid
+    - strategy_name: strategy_name
+    - efficacy_indicators: actionplan_efficacy_indicators
+    - global_efficacy: actionplan_global_efficacy
+    - links: links
+
+**Example JSON representation of an Action Plan:**
+
+.. literalinclude:: samples/actionplan-list-detailed-response.json
+   :language: javascript
+
+Show Action Plan
+================
+
+.. rest_method::  GET /v1/action_plans/{actionplan_ident}
+
+Shows details for an Action Plan.
+
+Normal response codes: 200
+
+Error codes: 404
+
+Request
+-------
+
+.. rest_parameters:: parameters.yaml
+
+   - actionplan_ident: actionplan_ident
+
+Response
+--------
+
+.. rest_parameters:: parameters.yaml
+
+    - uuid: uuid
+    - state: actionplan_state
+    - audit_uuid: actionplan_audit_uuid
+    - strategy_uuid: strategy_uuid
+    - strategy_name: strategy_name
+    - efficacy_indicators: actionplan_efficacy_indicators
+    - global_efficacy: actionplan_global_efficacy
+    - links: links
+
+**Example JSON representation of an Audit:**
+
+.. literalinclude:: samples/actionplan-show-response.json
+   :language: javascript
+
+Cancel Action Plan
+==================
+
+.. rest_method::  PATCH /v1/action_plans/{actionplan_ident}
+
+Cancels a created Action Plan resource.
+
+.. note:
+    If Action Plan is in ONGOING state, then ``state`` attribute should be
+    replaced with ``CANCELLING`` value. Otherwise, ``CANCELLED`` is to be
+    used.
+
+Normal response codes: 200
+
+Error codes: 400,404
+
+Request
+-------
+
+.. rest_parameters:: parameters.yaml
+
+   - actionplan_ident: actionplan_ident
+
+**Example Action Plan ONGOING cancelling request:**
+
+.. literalinclude:: samples/actionplan-cancel-request-cancelling.json
+   :language: javascript
+
+**Example Action Plan PENDING cancelling request:**
+
+.. literalinclude:: samples/actionplan-cancel-request-pending.json
+   :language: javascript
+
+Response
+--------
+
+The list and example below are representative of the response as of API
+version 1:
+
+.. rest_parameters:: parameters.yaml
+
+    - uuid: uuid
+    - state: actionplan_state
+    - audit_uuid: actionplan_audit_uuid
+    - strategy_uuid: strategy_uuid
+    - strategy_name: strategy_name
+    - efficacy_indicators: actionplan_efficacy_indicators
+    - global_efficacy: actionplan_global_efficacy
+    - links: links
+
+**Example JSON representation of an Action Plan:**
+
+.. literalinclude:: samples/actionplan-start-response.json
+   :language: javascript
+
+Delete Action Plan
+==================
+
+.. rest_method::  DELETE /v1/action_plans/{actionplan_ident}
+
+Deletes an Action Plan. Action Plan can be deleted only from SUCCEEDED, RECOMMENDED, FAILED, SUPERSEDED, CANCELLED states.
+
+Normal response codes: 204
+
+Error codes: 404
+
+Request
+-------
+
+.. rest_parameters:: parameters.yaml
+
+   - actionplan_ident: actionplan_ident

api-ref/source/watcher-api-v1-actions.inc

@@ -0,0 +1,155 @@
+.. -*- rst -*-
+
+=======
+Actions
+=======
+
+An ``Action`` is what enables Watcher to transform the current state of a
+``Cluster`` after an ``Audit``.
+
+An ``Action`` is an atomic task which changes the current state of a target
+Managed resource of the OpenStack ``Cluster`` such as:
+
+-  Live migration of an instance from one compute node to another compute
+   node with Nova
+-  Changing the power level of a compute node (ACPI level, ...)
+-  Changing the current state of a compute node (enable or disable) with Nova
+
+In most cases, an ``Action`` triggers some concrete commands on an existing
+OpenStack module (Nova, Neutron, Cinder, Ironic, etc.).
+
+An ``Action`` has a life-cycle and its current state may be one of the
+following:
+
+-  **PENDING** : the ``Action`` has not been executed yet by the
+   ``Watcher Applier``.
+-  **ONGOING** : the ``Action`` is currently being processed by the
+   ``Watcher Applier``.
+-  **SUCCEEDED** : the ``Action`` has been executed successfully
+-  **FAILED** : an error occurred while trying to execute the ``Action``.
+-  **DELETED** : the ``Action`` is still stored in the ``Watcher database``
+   but is not returned any more through the Watcher APIs.
+-  **CANCELLED** : the ``Action`` was in **PENDING** or **ONGOING** state and
+   was cancelled by the ``Administrator``
+
+``Actions`` are created by ``Watcher Planner`` as result of Audit's execution.
+``Action`` can't be created, modified or deleted by user.
+
+List Action
+===========
+
+.. rest_method::  GET /v1/actions
+
+Returns a list of Action resources.
+
+Normal response codes: 200
+
+Error codes: 400,401
+
+Request
+-------
+
+.. rest_parameters:: parameters.yaml
+
+   - action_plan_uuid: r_action_plan
+   - audit_uuid: r_audit
+   - limit: limit
+   - marker: marker
+   - sort_dir: sort_dir
+   - sort_key: sort_key
+
+Response
+--------
+
+.. rest_parameters:: parameters.yaml
+
+    - uuid: uuid
+    - action_type: action_type
+    - state: action_state
+    - action_plan_uuid: action_action_plan_uuid
+    - parents: action_parents
+    - links: links
+
+**Example JSON representation of an Action:**
+
+.. literalinclude:: samples/actions-list-response.json
+   :language: javascript
+
+List Action Detailed
+====================
+
+.. rest_method::  GET /v1/actions/detail
+
+Returns a list of Action resources with complete details.
+
+Normal response codes: 200
+
+Error codes: 400,401
+
+Request
+-------
+
+.. rest_parameters:: parameters.yaml
+
+   - action_plan_uuid: r_action_plan
+   - audit_uuid: r_audit
+   - limit: limit
+   - marker: marker
+   - sort_dir: sort_dir
+   - sort_key: sort_key
+
+Response
+--------
+
+.. rest_parameters:: parameters.yaml
+
+    - uuid: uuid
+    - action_type: action_type
+    - state: action_state
+    - action_plan_uuid: action_action_plan_uuid
+    - parents: action_parents
+    - description: action_description
+    - input_parameters: action_input_parameters
+    - links: links
+
+**Example JSON representation of an Action:**
+
+.. literalinclude:: samples/actions-list-detailed-response.json
+   :language: javascript
+
+Show Action
+===========
+
+.. rest_method::  GET /v1/actions/{action_ident}
+
+Shows details for an Action.
+
+Normal response codes: 200
+
+Error codes: 404
+
+Request
+-------
+
+.. rest_parameters:: parameters.yaml
+
+   - action_ident: action_ident
+
+Response
+--------
+
+.. rest_parameters:: parameters.yaml
+
+    - uuid: uuid
+    - action_type: action_type
+    - state: action_state
+    - action_plan_uuid: action_action_plan_uuid
+    - parents: action_parents
+    - description: action_description
+    - input_parameters: action_input_parameters
+    - links: links
+
+**Example JSON representation of an Action:**
+
+.. literalinclude:: samples/actions-show-response.json
+   :language: javascript

api-ref/source/watcher-api-v1-audits.inc

@@ -0,0 +1,349 @@
+.. -*- rst -*-
+
+======
+Audits
+======
+
+There are creating, listing, updating and deleting methods of Watcher Audit
+resources which are implemented via the ``/v1/audits`` resource.
+
+In the Watcher system, an ``Audit`` is a request for optimizing a ``Cluster``.
+
+The optimization is done in order to satisfy one ``Goal`` on a given
+``Cluster``.
+
+For each ``Audit``, the Watcher system generates an ``Action Plan``.
+
+Create Audit
+============
+
+.. rest_method::  POST /v1/audits
+
+Creates a new Audit resource.
+
+Mandatory attribute to be supplied: ``audit_type``.
+
+``Audit`` can be created either based on existed ``Audit Template`` or by
+itself. In the first case, there also should be supplied
+``audit_template_uuid``. If ``Audit`` is created without ``Audit Template``,
+``goal`` should be provided.
+
+.. warning::
+    **Only ``audit_template_uuid`` can be used to create audit so far.**
+    It should be fixed during the ``Rocky`` cycle.
+
+Normal response codes: 201
+
+Error codes: 400,404
+
+Request
+-------
+
+.. rest_parameters:: parameters.yaml
+
+   - audit_template_uuid: audittemplate_name
+   - audit_type: audit_type
+   - name: audit_name
+   - goal: audit_goal
+   - strategy: audit_strategy
+   - parameters: audit_parameters
+   - interval: audit_interval
+   - scope: audittemplate_scope
+   - auto_trigger: audit_autotrigger
+
+**Example ONESHOT Audit creation request:**
+
+.. literalinclude:: samples/audit-create-request-oneshot.json
+   :language: javascript
+
+**Example CONTINUOUS Audit creation request with a specified strategy:**
+
+.. literalinclude:: samples/audit-create-request-continuous.json
+   :language: javascript
+
+Response
+--------
+
+The list and example below are representative of the response as of API
+version 1:
+
+.. rest_parameters:: parameters.yaml
+
+    - uuid: uuid
+    - name: audit_name
+    - audit_type: audit_type
+    - strategy_uuid: strategy_uuid
+    - strategy_name: strategy_name
+    - goal_uuid: goal_uuid
+    - goal_name: goal_name
+    - interval: audit_interval
+    - next_run_time: audit_next_run_time
+    - parameters: audit_parameters
+    - auto_trigger: audit_autotrigger
+    - state: audit_state
+    - scope: audittemplate_scope
+    - links: links
+
+**Example JSON representation of an Audit:**
+
+.. literalinclude:: samples/audit-create-response.json
+   :language: javascript
+
+List Audit
+==========
+
+.. rest_method::  GET /v1/audits
+
+Returns a list of Audit resources.
+
+Normal response codes: 200
+
+Error codes: 400,401
+
+Request
+-------
+
+.. rest_parameters:: parameters.yaml
+
+   - goal: r_goal
+   - strategy: r_strategy
+   - limit: limit
+   - marker: marker
+   - sort_dir: sort_dir
+   - sort_key: sort_key
+
+Response
+--------
+
+.. rest_parameters:: parameters.yaml
+
+    - uuid: uuid
+    - name: audit_name
+    - audit_type: audit_type
+    - strategy_uuid: strategy_uuid
+    - strategy_name: strategy_name
+    - goal_uuid: goal_uuid
+    - goal_name: goal_name
+    - interval: audit_interval
+    - next_run_time: audit_next_run_time
+    - auto_trigger: audit_autotrigger
+    - state: audit_state
+    - scope: audittemplate_scope
+    - links: links
+
+**Example JSON representation of an Audit:**
+
+.. literalinclude:: samples/audit-list-response.json
+   :language: javascript
+
+List Audit Detailed
+===================
+
+.. rest_method::  GET /v1/audits/detail
+
+Returns a list of Audit resources with complete details.
+
+Normal response codes: 200
+
+Error codes: 400,401
+
+Request
+-------
+
+.. rest_parameters:: parameters.yaml
+
+   - goal: r_goal
+   - strategy: r_strategy
+   - limit: limit
+   - marker: marker
+   - sort_dir: sort_dir
+   - sort_key: sort_key
+
+Response
+--------
+
+.. rest_parameters:: parameters.yaml
+
+    - uuid: uuid
+    - name: audit_name
+    - audit_type: audit_type
+    - strategy_uuid: strategy_uuid
+    - strategy_name: strategy_name
+    - goal_uuid: goal_uuid
+    - goal_name: goal_name
+    - interval: audit_interval
+    - next_run_time: audit_next_run_time
+    - parameters: audit_parameters
+    - auto_trigger: audit_autotrigger
+    - state: audit_state
+    - scope: audittemplate_scope
+    - links: links
+
+**Example JSON representation of an Audit:**
+
+.. literalinclude:: samples/audit-list-detailed-response.json
+   :language: javascript
+
+Show Audit
+==========
+
+.. rest_method::  GET /v1/audits/{audit_ident}
+
+Shows details for an Audit.
+
+Normal response codes: 200
+
+Error codes: 404
+
+Request
+-------
+
+.. rest_parameters:: parameters.yaml
+
+   - audit_ident: audit_ident
+
+Response
+--------
+
+.. rest_parameters:: parameters.yaml
+
+    - uuid: uuid
+    - name: audit_name
+    - audit_type: audit_type
+    - strategy_uuid: strategy_uuid
+    - strategy_name: strategy_name
+    - goal_uuid: goal_uuid
+    - goal_name: goal_name
+    - interval: audit_interval
+    - next_run_time: audit_next_run_time
+    - parameters: audit_parameters
+    - auto_trigger: audit_autotrigger
+    - state: audit_state
+    - scope: audittemplate_scope
+    - links: links
+
+**Example JSON representation of an Audit:**
+
+.. literalinclude:: samples/audit-show-response.json
+   :language: javascript
+
+Cancel Audit
+============
+
+.. rest_method::  PATCH /v1/audits/{audit_ident}
+
+Cancels an ONGOING Audit resource.
+
+Normal response codes: 200
+
+Error codes: 400,404
+
+Request
+-------
+
+.. rest_parameters:: parameters.yaml
+
+   - audit_ident: audit_ident
+
+**Example Audit cancelling request:**
+
+.. literalinclude:: samples/audit-cancel-request.json
+   :language: javascript
+
+Response
+--------
+
+The list and example below are representative of the response as of API
+version 1:
+
+.. rest_parameters:: parameters.yaml
+
+    - uuid: uuid
+    - name: audit_name
+    - audit_type: audit_type
+    - strategy_uuid: strategy_uuid
+    - strategy_name: strategy_name
+    - goal_uuid: goal_uuid
+    - goal_name: goal_name
+    - interval: audit_interval
+    - next_run_time: audit_next_run_time
+    - parameters: audit_parameters
+    - auto_trigger: audit_autotrigger
+    - state: audit_state
+    - scope: audittemplate_scope
+    - links: links
+
+**Example JSON representation of an Audit:**
+
+.. literalinclude:: samples/audit-cancel-response.json
+   :language: javascript
+
+Update Audit
+============
+
+.. rest_method::  PATCH /v1/audits/{audit_ident}
+
+Updates an Audit with the given information.
+
+.. note:
+    ``audit_type`` shouldn't be changed by PATCH method.
+
+Normal response codes: 200
+
+Error codes: 400,404
+
+Request
+-------
+
+.. rest_parameters:: parameters.yaml
+
+   - audit_ident: audit_ident
+
+**Example PATCH document updating Audit:**
+
+.. literalinclude:: samples/audit-update-request.json
+   :language: javascript
+
+Response
+--------
+
+.. rest_parameters:: parameters.yaml
+
+    - uuid: uuid
+    - name: audit_name
+    - audit_type: audit_type
+    - strategy_uuid: strategy_uuid
+    - strategy_name: strategy_name
+    - goal_uuid: goal_uuid
+    - goal_name: goal_name
+    - interval: audit_interval
+    - next_run_time: audit_next_run_time
+    - parameters: audit_parameters
+    - auto_trigger: audit_autotrigger
+    - state: audit_state
+    - scope: audittemplate_scope
+    - links: links
+
+**Example JSON representation of an Audit:**
+
+.. literalinclude:: samples/audit-update-response.json
+   :language: javascript
+
+Delete Audit
+============
+
+.. rest_method::  DELETE /v1/audits/{audit_ident}
+
+Deletes an Audit. Audit can be deleted only from FAILED, SUCCEEDED, CANCELLED,
+SUSPENDED states.
+
+Normal response codes: 204
+
+Error codes: 404
+
+Request
+-------
+
+.. rest_parameters:: parameters.yaml
+
+   - audit_ident: audit_ident

api-ref/source/watcher-api-v1-audittemplates.inc

@@ -0,0 +1,257 @@
+.. -*- rst -*-
+
+===============
+Audit Templates
+===============
+
+There are creating, listing, updating and deleting methods of Watcher Audit
+Template resources which are implemented via the ``/v1/audit_templates``
+resource.
+
+An Audit may be launched several times with the same settings
+(Goal, thresholds, ...). Therefore it makes sense to save those settings in
+some sort of Audit preset object, which is known as an Audit Template.
+
+An Audit Template contains at least the Goal of the Audit.
+
+Create Audit Template
+=====================
+
+.. rest_method::  POST /v1/audit_templates
+
+Creates a new Audit Template resource.
+
+It requires ``name`` and ``goal`` attributes to be supplied in the request
+body.
+
+Normal response codes: 201
+
+Error codes: 400,404,409
+
+Request
+-------
+
+.. rest_parameters:: parameters.yaml
+
+   - name: audittemplate_name
+   - goal: audittemplate_goal
+   - strategy: audittemplate_strategy
+   - description: audittemplate_description
+   - scope: audittemplate_scope
+
+**Example Audit Template creation request without a specified strategy:**
+
+.. literalinclude:: samples/audittemplate-create-request-minimal.json
+   :language: javascript
+
+**Example Audit Template creation request with a specified strategy:**
+
+.. literalinclude:: samples/audittemplate-create-request-full.json
+   :language: javascript
+
+Response
+--------
+
+The list and example below are representative of the response as of API
+version 1:
+
+.. rest_parameters:: parameters.yaml
+
+    - uuid: uuid
+    - name: audittemplate_name
+    - description: audittemplate_description
+    - strategy_uuid: strategy_uuid
+    - strategy_name: strategy_name
+    - goal_uuid: goal_uuid
+    - goal_name: goal_name
+    - scope: audittemplate_scope
+    - links: links
+
+**Example JSON representation of an Audit Template:**
+
+.. literalinclude:: samples/audittemplate-create-response.json
+   :language: javascript
+
+List Audit Template
+===================
+
+.. rest_method::  GET /v1/audit_templates
+
+Returns a list of Audit Template resources.
+
+Normal response codes: 200
+
+Error codes: 400,401
+
+Request
+-------
+
+.. rest_parameters:: parameters.yaml
+
+   - goal: r_goal
+   - strategy: r_strategy
+   - limit: limit
+   - marker: marker
+   - sort_dir: sort_dir
+   - sort_key: sort_key
+
+Response
+--------
+
+.. rest_parameters:: parameters.yaml
+
+    - uuid: uuid
+    - name: audittemplate_name
+    - strategy_uuid: strategy_uuid
+    - strategy_name: strategy_name
+    - goal_uuid: goal_uuid
+    - goal_name: goal_name
+    - scope: audittemplate_scope
+    - links: links
+
+**Example JSON representation of an Audit Template:**
+
+.. literalinclude:: samples/audittemplate-list-response.json
+   :language: javascript
+
+List Audit Template Detailed
+============================
+
+.. rest_method::  GET /v1/audit_templates/detail
+
+Returns a list of Audit Template resources with complete details.
+
+Normal response codes: 200
+
+Error codes: 400,401
+
+Request
+-------
+
+.. rest_parameters:: parameters.yaml
+
+   - goal: r_goal
+   - strategy: r_strategy
+   - limit: limit
+   - marker: marker
+   - sort_dir: sort_dir
+   - sort_key: sort_key
+
+Response
+--------
+
+.. rest_parameters:: parameters.yaml
+
+    - uuid: uuid
+    - name: audittemplate_name
+    - strategy_uuid: strategy_uuid
+    - strategy_name: strategy_name
+    - goal_uuid: goal_uuid
+    - goal_name: goal_name
+    - scope: audittemplate_scope
+    - links: links
+    - description: audittemplate_description
+
+**Example JSON representation of an Audit Template:**
+
+.. literalinclude:: samples/audittemplate-list-detailed-response.json
+   :language: javascript
+
+Show Audit Template
+===================
+
+.. rest_method::  GET /v1/audit_templates/{audittemplate_ident}
+
+Shows details for an Audit Template.
+
+Normal response codes: 200
+
+Error codes: 404
+
+Request
+-------
+
+.. rest_parameters:: parameters.yaml
+
+   - audittemplate_ident: audittemplate_ident
+
+Response
+--------
+
+.. rest_parameters:: parameters.yaml
+
+    - uuid: uuid
+    - name: audittemplate_name
+    - strategy_uuid: strategy_uuid
+    - strategy_name: strategy_name
+    - goal_uuid: goal_uuid
+    - goal_name: goal_name
+    - scope: audittemplate_scope
+    - links: links
+    - description: audittemplate_description
+
+**Example JSON representation of an Audit Template:**
+
+.. literalinclude:: samples/audittemplate-show-response.json
+   :language: javascript
+
+Update Audit Template
+=====================
+
+.. rest_method::  PATCH /v1/audit_templates/{audittemplate_ident}
+
+Updates an Audit Template with the given information.
+
+Normal response codes: 200
+
+Error codes: 400,404
+
+Request
+-------
+
+.. rest_parameters:: parameters.yaml
+
+   - audittemplate_ident: audittemplate_ident
+
+**Example PATCH document updating Audit Template:**
+
+.. literalinclude:: samples/audittemplate-update-request.json
+   :language: javascript
+
+Response
+--------
+
+.. rest_parameters:: parameters.yaml
+
+    - uuid: uuid
+    - name: audittemplate_name
+    - strategy_uuid: strategy_uuid
+    - strategy_name: strategy_name
+    - goal_uuid: goal_uuid
+    - goal_name: goal_name
+    - scope: audittemplate_scope
+    - links: links
+    - description: audittemplate_description
+
+**Example JSON representation of an Audit Template:**
+
+.. literalinclude:: samples/audittemplate-update-response.json
+   :language: javascript
+
+Delete Audit Template
+=====================
+
+.. rest_method::  DELETE /v1/audit_templates/{audittemplate_ident}
+
+Deletes an Audit Template.
+
+Normal response codes: 204
+
+Error codes: 404
+
+Request
+-------
+
+.. rest_parameters:: parameters.yaml
+
+   - audittemplate_ident: audittemplate_ident

api-ref/source/watcher-api-v1-goals.inc

@@ -0,0 +1,126 @@
+.. -*- rst -*-
+
+=====
+Goals
+=====
+
+A ``Goal`` is a human readable, observable and measurable end result having
+one objective to be achieved.
+
+Here are some examples of ``Goals``:
+
+-  minimize the energy consumption
+-  minimize the number of compute nodes (consolidation)
+-  balance the workload among compute nodes
+-  minimize the license cost (some softwares have a licensing model which is
+   based on the number of sockets or cores where the software is deployed)
+-  find the most appropriate moment for a planned maintenance on a
+   given group of host (which may be an entire availability zone):
+   power supply replacement, cooling system replacement, hardware
+   modification, ...
+
+List Goal
+=========
+
+.. rest_method::  GET /v1/goals
+
+Returns a list of Goal resources.
+
+Normal response codes: 200
+
+Error codes: 400,401
+
+Request
+-------
+
+.. rest_parameters:: parameters.yaml
+
+   - limit: limit
+   - sort_dir: sort_dir
+   - sort_key: sort_key
+
+Response
+--------
+
+.. rest_parameters:: parameters.yaml
+
+    - uuid: uuid
+    - efficacy_specification: goal_efficacy_specification
+    - name: goal_name
+    - display_name: goal_display_name
+    - links: links
+
+**Example JSON representation of a Goal:**
+
+.. literalinclude:: samples/goal-list-response.json
+   :language: javascript
+
+List Goal Detailed
+==================
+
+.. rest_method::  GET /v1/goals/detail
+
+Returns a list of Goal resources with complete details.
+
+Normal response codes: 200
+
+Error codes: 400,401
+
+Request
+-------
+
+.. rest_parameters:: parameters.yaml
+
+   - limit: limit
+   - sort_dir: sort_dir
+   - sort_key: sort_key
+
+Response
+--------
+
+.. rest_parameters:: parameters.yaml
+
+    - uuid: uuid
+    - efficacy_specification: goal_efficacy_specification
+    - name: goal_name
+    - display_name: goal_display_name
+    - links: links
+
+**Example JSON representation of a Goal:**
+
+.. literalinclude:: samples/goal-list-response.json
+   :language: javascript
+
+Show Goal
+=========
+
+.. rest_method::  GET /v1/goals/{goal_ident}
+
+Shows details for an Goal.
+
+Normal response codes: 200
+
+Error codes: 404
+
+Request
+-------
+
+.. rest_parameters:: parameters.yaml
+
+   - goal_ident: goal_ident
+
+Response
+--------
+
+.. rest_parameters:: parameters.yaml
+
+    - uuid: uuid
+    - efficacy_specification: goal_efficacy_specification
+    - name: goal_name
+    - display_name: goal_display_name
+    - links: links
+
+**Example JSON representation of a Goal:**
+
+.. literalinclude:: samples/goal-show-response.json
+   :language: javascript

api-ref/source/watcher-api-v1-scoring_engines.inc

@@ -0,0 +1,120 @@
+.. -*- rst -*-
+
+===============
+Scoring Engines
+===============
+
+A ``Scoring Engine`` is an executable that has a well-defined input, a
+well-defined output, and performs a purely mathematical task. That is,
+the calculation does not depend on the environment in which it is running - it
+would produce the same result anywhere.
+
+Because there might be multiple algorithms used to build a particular data
+model (and therefore a scoring engine), the usage of scoring engine might
+vary. A metainfo field is supposed to contain any information which might
+be needed by the user of a given scoring engine.
+
+List Scoring Engine
+===================
+
+.. rest_method::  GET /v1/scoring_engines
+
+Returns a list of Scoring Engine resources.
+
+Normal response codes: 200
+
+Error codes: 400,401
+
+Request
+-------
+
+.. rest_parameters:: parameters.yaml
+
+   - limit: limit
+   - sort_dir: sort_dir
+   - sort_key: sort_key
+
+Response
+--------
+
+.. rest_parameters:: parameters.yaml
+
+    - uuid: uuid
+    - name: scoring_engine_name
+    - description: scoring_engine_description
+    - links: links
+
+**Example JSON representation of a Scoring Engine:**
+
+.. literalinclude:: samples/scoring_engine-list-response.json
+   :language: javascript
+
+List Scoring Engine Detailed
+============================
+
+.. rest_method::  GET /v1/scoring_engines/detail
+
+Returns a list of Scoring Engine resources with complete details.
+
+Normal response codes: 200
+
+Error codes: 400,401
+
+Request
+-------
+
+.. rest_parameters:: parameters.yaml
+
+   - limit: limit
+   - sort_dir: sort_dir
+   - sort_key: sort_key
+
+Response
+--------
+
+.. rest_parameters:: parameters.yaml
+
+    - uuid: uuid
+    - name: scoring_engine_name
+    - description: scoring_engine_description
+    - metainfo: scoring_engine_metainfo
+    - links: links
+
+**Example JSON representation of a Scoring Engine:**
+
+.. literalinclude:: samples/scoring_engine-list-detailed-response.json
+   :language: javascript
+
+Show Scoring Engine
+===================
+
+.. rest_method::  GET /v1/scoring_engines/{scoring_engine_ident}
+
+Shows details for a Scoring Engine resource.
+
+Normal response codes: 200
+
+Error codes: 404
+
+Request
+-------
+
+.. rest_parameters:: parameters.yaml
+
+   - scoring_engine_ident: scoring_engine_ident
+
+Response
+--------
+
+.. rest_parameters:: parameters.yaml
+
+    - uuid: uuid
+    - name: scoring_engine_name
+    - description: scoring_engine_description
+    - metainfo: scoring_engine_metainfo
+    - links: links
+
+**Example JSON representation of a Scoring Engine:**
+
+.. literalinclude:: samples/scoring_engine-show-response.json
+   :language: javascript

api-ref/source/watcher-api-v1-services.inc

@@ -0,0 +1,116 @@
+.. -*- rst -*-
+
+========
+Services
+========
+
+This resource represents Watcher services, their states and hosts they are
+placed on.
+
+List Service
+============
+
+.. rest_method::  GET /v1/services
+
+Returns a list of Service resources.
+
+Normal response codes: 200
+
+Error codes: 400,401
+
+Request
+-------
+
+.. rest_parameters:: parameters.yaml
+
+   - limit: limit
+   - sort_dir: sort_dir
+   - sort_key: sort_key
+
+Response
+--------
+
+.. rest_parameters:: parameters.yaml
+
+    - id: service_id
+    - name: service_name
+    - host: service_host
+    - status: service_status
+    - links: links
+
+**Example JSON representation of a Service:**
+
+.. literalinclude:: samples/service-list-response.json
+   :language: javascript
+
+List Service Detailed
+=====================
+
+.. rest_method::  GET /v1/services/detail
+
+Returns a list of Service resources with complete details.
+
+Normal response codes: 200
+
+Error codes: 400,401
+
+Request
+-------
+
+.. rest_parameters:: parameters.yaml
+
+   - limit: limit
+   - sort_dir: sort_dir
+   - sort_key: sort_key
+
+Response
+--------
+
+.. rest_parameters:: parameters.yaml
+
+    - id: service_id
+    - name: service_name
+    - host: service_host
+    - status: service_status
+    - last_seen_up: service_last_seen_up
+    - links: links
+
+**Example JSON representation of a Service:**
+
+.. literalinclude:: samples/service-list-detailed-response.json
+   :language: javascript
+
+Show Service
+============
+
+.. rest_method::  GET /v1/services/{service_ident}
+
+Shows details for a Service resource.
+
+Normal response codes: 200
+
+Error codes: 404
+
+Request
+-------
+
+.. rest_parameters:: parameters.yaml
+
+   - service_ident: service_ident
+
+Response
+--------
+
+.. rest_parameters:: parameters.yaml
+
+    - id: service_id
+    - name: service_name
+    - host: service_host
+    - status: service_status
+    - last_seen_up: service_last_seen_up
+    - links: links
+
+**Example JSON representation of a Service:**
+
+.. literalinclude:: samples/service-show-response.json
+   :language: javascript

api-ref/source/watcher-api-v1-strategies.inc

@@ -0,0 +1,164 @@
+.. -*- rst -*-
+
+==========
+Strategies
+==========
+
+A ``Strategy`` is an algorithm implementation which is able to find a
+``Solution`` for a given ``Goal``. To get more information about strategies
+that are shipped along with Watcher, visit `strategies page`_.
+
+There may be several potential strategies which are able to achieve the same
+``Goal``. This is why it is possible to configure which specific ``Strategy``
+should be used for each goal.
+
+Some strategies may provide better optimization results but may take more time
+to find an optimal ``Solution``.
+
+.. _`strategies page`: https://docs.openstack.org/watcher/latest/strategies/index.html
+
+List Strategy
+=============
+
+.. rest_method::  GET /v1/strategies
+
+Returns a list of Strategy resources.
+
+Normal response codes: 200
+
+Error codes: 400,401
+
+Request
+-------
+
+.. rest_parameters:: parameters.yaml
+
+   - goal: r_goal
+   - limit: limit
+   - sort_dir: sort_dir
+   - sort_key: sort_key
+
+Response
+--------
+
+.. rest_parameters:: parameters.yaml
+
+    - uuid: uuid
+    - name: strategy_name
+    - display_name: strategy_display_name
+    - goal_name: goal_name
+    - goal_uuid: goal_uuid
+    - links: links
+
+**Example JSON representation of a Strategy:**
+
+.. literalinclude:: samples/strategy-list-response.json
+   :language: javascript
+
+List Strategy Detailed
+======================
+
+.. rest_method::  GET /v1/strategies/detail
+
+Returns a list of Strategy resources with complete details.
+
+Normal response codes: 200
+
+Error codes: 400,401
+
+Request
+-------
+
+.. rest_parameters:: parameters.yaml
+
+   - goal: r_goal
+   - limit: limit
+   - sort_dir: sort_dir
+   - sort_key: sort_key
+
+Response
+--------
+
+.. rest_parameters:: parameters.yaml
+
+    - uuid: uuid
+    - name: strategy_name
+    - display_name: strategy_display_name
+    - parameters_spec: strategy_parameters_spec
+    - goal_name: goal_name
+    - goal_uuid: goal_uuid
+    - links: links
+
+**Example JSON representation of a Strategy:**
+
+.. literalinclude:: samples/strategy-list-detailed-response.json
+   :language: javascript
+
+Show Strategy
+=============
+
+.. rest_method::  GET /v1/strategies/{strategy_ident}
+
+Shows details for a Strategy resource.
+
+Normal response codes: 200
+
+Error codes: 404
+
+Request
+-------
+
+.. rest_parameters:: parameters.yaml
+
+   - strategy_ident: strategy_ident
+
+Response
+--------
+
+.. rest_parameters:: parameters.yaml
+
+    - uuid: uuid
+    - name: strategy_name
+    - display_name: strategy_display_name
+    - parameters_spec: strategy_parameters_spec
+    - goal_name: goal_name
+    - goal_uuid: goal_uuid
+    - links: links
+
+**Example JSON representation of a Strategy:**
+
+.. literalinclude:: samples/strategy-show-response.json
+   :language: javascript
+
+Show Strategy State
+===================
+
+.. rest_method::  GET /v1/strategies/{strategy_ident}/state
+
+Retrieve an information about strategy requirements.
+
+Normal response codes: 200
+
+Error codes: 404
+
+Request
+-------
+
+.. rest_parameters:: parameters.yaml
+
+   - strategy_ident: strategy_ident
+
+Response
+--------
+
+.. rest_parameters:: parameters.yaml
+
+    - state: strategy_check_state
+    - comment: strategy_check_comment
+    - mandatory: strategy_check_mandatory
+    - type: strategy_check_type
+
+**Example JSON representation of a Strategy:**
+
+.. literalinclude:: samples/strategy-state-response.json
+   :language: javascript

devstack/lib/watcher

@@ -177,16 +177,20 @@ function create_watcher_conf {
     iniset $WATCHER_CONF DEFAULT debug "$ENABLE_DEBUG_LOG_LEVEL"
     iniset $WATCHER_CONF DEFAULT control_exchange watcher
 
+    iniset_rpc_backend watcher $WATCHER_CONF
+
     iniset $WATCHER_CONF database connection $(database_connection_url watcher)
     iniset $WATCHER_CONF api host "$WATCHER_SERVICE_HOST"
-    iniset $WATCHER_CONF api port "$WATCHER_SERVICE_PORT"
+
+    if is_service_enabled tls-proxy; then
+        iniset $WATCHER_CONF api port "$WATCHER_SERVICE_PORT_INT"
+        # iniset $WATCHER_CONF api enable_ssl_api "True"
+    else
+        iniset $WATCHER_CONF api port "$WATCHER_SERVICE_PORT"
+    fi
 
     iniset $WATCHER_CONF oslo_policy policy_file $WATCHER_POLICY_YAML
 
-    iniset $WATCHER_CONF oslo_messaging_rabbit rabbit_userid $RABBIT_USERID
-    iniset $WATCHER_CONF oslo_messaging_rabbit rabbit_password $RABBIT_PASSWORD
-    iniset $WATCHER_CONF oslo_messaging_rabbit rabbit_host $RABBIT_HOST
-
     iniset $WATCHER_CONF oslo_messaging_notifications driver "messagingv2"
 
     iniset $NOVA_CONF oslo_messaging_notifications topics "notifications,watcher_notifications"
@@ -297,8 +301,7 @@ function start_watcher_api {
 
     # Start proxies if enabled
     if is_service_enabled tls-proxy; then
-        start_tls_proxy '*' $WATCHER_SERVICE_PORT $WATCHER_SERVICE_HOST $WATCHER_SERVICE_PORT_INT &
-        start_tls_proxy '*' $EC2_SERVICE_PORT $WATCHER_SERVICE_HOST $WATCHER_SERVICE_PORT_INT &
+        start_tls_proxy watcher '*' $WATCHER_SERVICE_PORT $WATCHER_SERVICE_HOST $WATCHER_SERVICE_PORT_INT
     fi
 }
 

doc/ext/versioned_notifications.py

@@ -20,7 +20,7 @@ It is used via a single directive in the .rst file
 
 """
 
-from sphinx.util.compat import Directive
+from docutils.parsers.rst import Directive
 from docutils import nodes
 
 from watcher.notifications import base as notification

doc/source/admin/policy.rst

@@ -131,6 +131,16 @@ The actions that may have a rule enforced on them are:
   * ``GET /v1/actions/<ACTION_UUID>``
 
 
+* ``service:get_all``, ``service:detail`` - List available Watcher services
+
+  * ``GET /v1/services``
+  * ``GET /v1/services/detail``
+
+* ``service:get`` - Retrieve a specific Watcher service entity
+
+  * ``GET /v1/services/<SERVICE_ID>``
+
+
 
 To limit an action to a particular role or roles, you list the roles like so ::
 

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

@@ -19,7 +19,7 @@ The source install instructions specifically avoid using platform specific
 packages, instead using the source for the code and the Python Package Index
 (PyPi_).
 
-.. _PyPi: https://pypi.python.org/pypi
+.. _PyPi: https://pypi.org/
 
 It's expected that your system already has python2.7_, latest version of pip_,
 and git_ available.
@@ -30,7 +30,7 @@ and git_ available.
 
 Your system shall also have some additional system libraries:
 
-  On Ubuntu (tested on 14.04LTS):
+  On Ubuntu (tested on 16.04LTS):
 
   .. code-block:: bash
 

doc/source/conf.py

@@ -42,6 +42,7 @@ extensions = [
     'ext.versioned_notifications',
     'oslo_config.sphinxconfiggen',
     'openstackdocstheme',
+    'sphinx.ext.napoleon',
 ]
 
 wsme_protocols = ['restjson']

doc/source/configuration/configuring.rst

@@ -19,11 +19,17 @@ optimize your IaaS platform. 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
+  to locate other OpenStack services.
+- the OpenStack Telemetry service (`ceilometer`_) for collecting the resources
+  metrics.
+- the time series database (`gnocchi`_) 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 OpenStack Bare Metal service (`ironic`_) works with the Watcher service
+  and allows to manage power state of nodes.
+- the OpenStack Block Storage service (`cinder`_) works with the Watcher
+  service and as an API for volume node migration.
 
 The Watcher service includes the following components:
 
@@ -53,6 +59,9 @@ additional functionality:
 .. _`keystone`: https://github.com/openstack/keystone
 .. _`ceilometer`: https://github.com/openstack/ceilometer
 .. _`nova`: https://github.com/openstack/nova
+.. _`gnocchi`: https://github.com/gnocchixyz/gnocchi
+.. _`ironic`: https://github.com/openstack/ironic
+.. _`cinder`: https://github.com/openstack/cinder
 .. _`python-watcherclient`: https://github.com/openstack/python-watcherclient
 .. _`watcher-dashboard`: https://github.com/openstack/watcher-dashboard
 .. _`watcher metering`: https://github.com/b-com/watcher-metering
@@ -129,10 +138,14 @@ Configure the Identity service for the Watcher service
 
     .. 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
+      $ openstack endpoint create --region YOUR_REGION
+        watcher public http://WATCHER_API_PUBLIC_IP:9322
+
+      $ openstack endpoint create --region YOUR_REGION
+        watcher internal http://WATCHER_API_INTERNAL_IP:9322
+
+      $ openstack endpoint create --region YOUR_REGION
+        watcher admin http://WATCHER_API_ADMIN_IP:9322
 
 .. _watcher-db_configuration:
 
@@ -217,7 +230,7 @@ so that the watcher service is configured for your needs.
     # The SQLAlchemy connection string used to connect to the
     # database (string value)
     #connection=<None>
-    connection = mysql://watcher:WATCHER_DBPASSWORD@DB_IP/watcher?charset=utf8
+    connection = mysql+pymysql://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
@@ -235,21 +248,8 @@ so that the watcher service is configured for your needs.
     # 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
+    # ...
+    transport_url = rabbit://RABBITMQ_USER:RABBITMQ_PASSWORD@RABBIT_HOST
 
 
 #. Watcher API shall validate the token provided by every incoming request,
@@ -273,7 +273,7 @@ so that the watcher service is configured for your needs.
 
         # Authentication URL (unknown value)
         #auth_url = <None>
-        auth_url = http://IDENTITY_IP:35357
+        auth_url = http://IDENTITY_IP:5000
 
         # Username (unknown value)
         # Deprecated group/name - [DEFAULT]/username
@@ -319,7 +319,7 @@ so that the watcher service is configured for your needs.
 
         # Authentication URL (unknown value)
         #auth_url = <None>
-        auth_url = http://IDENTITY_IP:35357
+        auth_url = http://IDENTITY_IP:5000
 
         # Username (unknown value)
         # Deprecated group/name - [DEFAULT]/username
@@ -349,7 +349,7 @@ so that the watcher service is configured for your needs.
     [nova_client]
 
     # Version of Nova API to use in novaclient. (string value)
-    #api_version = 2.53
+    #api_version = 2.56
     api_version = 2.1
 
 #. Create the Watcher Service database tables::

doc/source/configuration/index.rst

@@ -1,5 +1,9 @@
+===================
+Configuration Guide
+===================
+
 .. toctree::
-   :maxdepth: 1
+   :maxdepth: 2
 
    configuring
    watcher

doc/source/contributor/contributing.rst

@@ -39,7 +39,7 @@ notifications of important events.
 
    * https://launchpad.net
    * https://launchpad.net/watcher
-   * https://launchpad.net/~openstack
+   * https://launchpad.net/openstack
 
 
 Project Hosting Details
@@ -49,7 +49,7 @@ Bug tracker
     https://launchpad.net/watcher
 
 Mailing list (prefix subjects with ``[watcher]`` for faster responses)
-    https://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
+    http://lists.openstack.org/pipermail/openstack-dev/
 
 Wiki
     https://wiki.openstack.org/Watcher
@@ -65,7 +65,7 @@ IRC Channel
 
 Weekly Meetings
     On Wednesdays at 14:00 UTC on even weeks in the ``#openstack-meeting-4``
-    IRC channel, 13:00 UTC on odd weeks in the ``#openstack-meeting-alt``
+    IRC channel, 08:00 UTC on odd weeks in the ``#openstack-meeting-alt``
     IRC channel (`meetings logs`_)
 
 .. _changelog: http://eavesdrop.openstack.org/irclogs/%23openstack-watcher/

doc/source/contributor/environment.rst

@@ -37,7 +37,7 @@ different version of the above, please document your configuration here!
 
 .. _Python: https://www.python.org/
 .. _git: https://git-scm.com/
-.. _setuptools: https://pypi.python.org/pypi/setuptools
+.. _setuptools: https://pypi.org/project/setuptools
 .. _virtualenvwrapper: https://virtualenvwrapper.readthedocs.io/en/latest/install.html
 
 Getting the latest code
@@ -69,8 +69,8 @@ itself.
 
 These dependencies can be installed from PyPi_ using the Python tool pip_.
 
-.. _PyPi: https://pypi.python.org/
-.. _pip: https://pypi.python.org/pypi/pip
+.. _PyPi: https://pypi.org/
+.. _pip: https://pypi.org/project/pip
 
 However, your system *may* need additional dependencies that `pip` (and by
 extension, PyPi) cannot satisfy. These dependencies should be installed
@@ -123,9 +123,10 @@ You can re-activate this virtualenv for your current shell using:
 
     $ workon watcher
 
-For more information on virtual environments, see virtualenv_.
+For more information on virtual environments, see virtualenv_ and
+virtualenvwrapper_.
 
-.. _virtualenv: https://www.virtualenv.org/
+.. _virtualenv: https://pypi.org/project/virtualenv/
 
 
 
@@ -192,6 +193,8 @@ still need to configure the following sections:
   :ref:`Identity service <identity-service_configuration>` i.e. Keystone
 - The ``[watcher_messaging]`` section to configure the OpenStack AMQP-based
   message bus
+- The ``watcher_clients_auth`` section to configure Keystone client to access
+  related OpenStack projects
 
 So if you need some more details on how to configure one or more of these
 sections, please do have a look at :doc:`../configuration/configuring` before

doc/source/contributor/plugin/base-setup.rst

@@ -79,7 +79,7 @@ requirements.txt file::
 
 .. _cookiecutter: https://github.com/audreyr/cookiecutter
 .. _OpenStack cookiecutter: https://github.com/openstack-dev/cookiecutter
-.. _python-watcher: https://pypi.python.org/pypi/python-watcher
+.. _python-watcher: https://pypi.org/project/python-watcher
 
 Implementing a plugin for Watcher
 =================================

doc/source/contributor/plugin/cdmc-plugin.rst

@@ -208,7 +208,7 @@ Here below is how to register ``DummyClusterDataModelCollector`` using pbr_:
     watcher_cluster_data_model_collectors =
         dummy = thirdparty.dummy:DummyClusterDataModelCollector
 
-.. _pbr: http://docs.openstack.org/pbr/latest
+.. _pbr: https://docs.openstack.org/pbr/latest/
 
 
 Add new notification endpoints

doc/source/contributor/testing.rst

@@ -31,7 +31,7 @@ the following::
     (watcher) $ tox -e pep8
 
 .. _tox: https://tox.readthedocs.org/
-.. _Gerrit: http://review.openstack.org/
+.. _Gerrit: https://review.openstack.org/
 
 You may pass options to the test programs using positional arguments. To run a
 specific unit test, you can pass extra options to `os-testr`_ after putting

doc/source/glossary.rst

@@ -274,7 +274,7 @@ In OpenStack Identity, a :ref:`project <project_definition>` must be owned by a
 specific domain.
 
 Please, read `the official OpenStack definition of a Project
-<http://docs.openstack.org/glossary/content/glossary.html>`_.
+<https://docs.openstack.org/doc-contrib-guide/common/glossary.html>`_.
 
 .. _scoring_engine_definition:
 

doc/source/index.rst

@@ -15,7 +15,7 @@ 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!
+migration, increased energy efficiency and more!
 
 Watcher project consists of several source code repositories:
 
@@ -54,22 +54,6 @@ Getting Started
 
   contributor/index
 
-API References
---------------
-
-.. toctree::
-  :maxdepth: 1
-
-  api/index
-
-Plugins
--------
-
-.. toctree::
-  :maxdepth: 1
-
-  contributor/plugin/index
-
 Installation
 ============
 .. toctree::
@@ -77,14 +61,6 @@ Installation
 
   install/index
 
-Watcher Configuration Options
-=============================
-
-.. toctree::
-  :maxdepth: 2
-
-  configuration/index
-
 Admin Guide
 ===========
 
@@ -101,6 +77,30 @@ User Guide
 
   user/index
 
+API References
+--------------
+
+.. toctree::
+  :maxdepth: 1
+
+  api/index
+
+Plugins
+-------
+
+.. toctree::
+  :maxdepth: 1
+
+  contributor/plugin/index
+
+Watcher Configuration Options
+=============================
+
+.. toctree::
+  :maxdepth: 2
+
+  configuration/index
+
 Watcher Manual Pages
 ====================
 

doc/source/install/common_configure.rst

@@ -26,8 +26,8 @@
 
         [keystone_authtoken]
         ...
-        auth_uri = http://controller:5000
-        auth_url = http://controller:35357
+        www_authenticate_uri = http://controller:5000
+        auth_url = http://controller:5000
         memcached_servers = controller:11211
         auth_type = password
         project_domain_name = default
@@ -47,7 +47,7 @@
         [watcher_clients_auth]
         ...
         auth_type = password
-        auth_url = http://controller:35357
+        auth_url = http://controller:5000
         username = watcher
         password = WATCHER_PASS
         project_domain_name = default

doc/source/install/index.rst

@@ -10,7 +10,7 @@ Infrastructure Optimization service
    verify.rst
    next-steps.rst
 
-The Infrastructure Optimization service (watcher) provides
+The Infrastructure Optimization service (Watcher) provides
 flexible and scalable resource optimization service for
 multi-tenant OpenStack-based clouds.
 
@@ -21,17 +21,17 @@ 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!
+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/watcher/latest/strategies/index.html
+`Strategies <https://docs.openstack.org/watcher/latest/strategies/index.html>`_.
 
-Check watcher glossary at
-https://docs.openstack.org/watcher/latest/glossary.html
+Check watcher glossary at `Glossary
+<https://docs.openstack.org/watcher/latest/glossary.html>`_.
 
 
 This chapter assumes a working setup of OpenStack following the

doc/source/man/watcher-api.rst

@@ -7,9 +7,7 @@ Service for the Watcher API
 ---------------------------
 
 :Author: openstack@lists.launchpad.net
-:Date:
 :Copyright: OpenStack Foundation
-:Version:
 :Manual section: 1
 :Manual group: cloud computing
 

doc/source/man/watcher-applier.rst

@@ -7,9 +7,7 @@ Service for the Watcher Applier
 -------------------------------
 
 :Author: openstack@lists.launchpad.net
-:Date:
 :Copyright: OpenStack Foundation
-:Version:
 :Manual section: 1
 :Manual group: cloud computing
 

doc/source/man/watcher-db-manage.rst

@@ -241,10 +241,9 @@ purge
   The maximum number of database objects we expect to be deleted. If exceeded,
   this will prevent any deletion.
 
-.. option:: -t, --audit-template
+.. option:: -t, --goal
 
-  Either the UUID or name of the soft deleted audit template to purge. This
-  will also include any related objects with it.
+  Either the UUID or name of the goal to purge.
 
 .. option:: -e, --exclude-orphans
 

doc/source/man/watcher-decision-engine.rst

@@ -7,9 +7,7 @@ Service for the Watcher Decision Engine
 ---------------------------------------
 
 :Author: openstack@lists.launchpad.net
-:Date:
 :Copyright: OpenStack Foundation
-:Version:
 :Manual section: 1
 :Manual group: cloud computing
 

doc/source/strategies/actuation.rst

@@ -9,7 +9,7 @@ Synopsis
 
 **goal**: ``unclassified``
 
-    .. watcher-term:: watcher.decision_engine.strategy.strategies.actuation
+    .. watcher-term:: watcher.decision_engine.strategy.strategies.actuation.Actuator
 
 Requirements
 ------------

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

@@ -9,7 +9,7 @@ Synopsis
 
 **goal**: ``server_consolidation``
 
-    .. watcher-term:: watcher.decision_engine.strategy.strategies.basic_consolidation
+    .. watcher-term:: watcher.decision_engine.strategy.strategies.basic_consolidation.BasicConsolidation
 
 Requirements
 ------------

doc/source/strategies/host_maintenance.rst

@@ -0,0 +1,94 @@
+===========================
+Host Maintenance Strategy
+===========================
+
+Synopsis
+--------
+
+**display name**: ``Host Maintenance Strategy``
+
+**goal**: ``cluster_maintaining``
+
+    .. watcher-term:: watcher.decision_engine.strategy.strategies.host_maintenance.HostMaintenance
+
+Requirements
+------------
+
+None.
+
+Metrics
+*******
+
+None
+
+Cluster data model
+******************
+
+Default Watcher's Compute cluster data model:
+
+    .. watcher-term:: watcher.decision_engine.model.collector.nova.NovaClusterDataModelCollector
+
+Actions
+*******
+
+Default Watcher's actions:
+
+    .. list-table::
+       :widths: 30 30
+       :header-rows: 1
+
+       * - action
+         - description
+       * - ``migration``
+         - .. watcher-term:: watcher.applier.actions.migration.Migrate
+       * - ``change_nova_service_state``
+         - .. watcher-term:: watcher.applier.actions.change_nova_service_state.ChangeNovaServiceState
+
+Planner
+*******
+
+Default Watcher's planner:
+
+    .. watcher-term:: watcher.decision_engine.planner.weight.WeightPlanner
+
+Configuration
+-------------
+
+Strategy parameters are:
+
+==================== ====== ====================================
+parameter            type   default Value description
+==================== ====== ====================================
+``maintenance_node`` String The name of the compute node which
+                            need maintenance. Required.
+``backup_node``      String The name of the compute node which
+                            will backup the maintenance node.
+                            Optional.
+==================== ====== ====================================
+
+Efficacy Indicator
+------------------
+
+None
+
+Algorithm
+---------
+
+For more information on the Host Maintenance Strategy please refer
+to: https://specs.openstack.org/openstack/watcher-specs/specs/queens/approved/cluster-maintenance-strategy.html
+
+How to use it ?
+---------------
+
+.. code-block:: shell
+
+    $ openstack optimize audit create \
+      -g cluster_maintaining -s host_maintenance \
+      -p maintenance_node=compute01 \
+      -p backup_node=compute02 \
+      --auto-trigger
+
+External Links
+--------------
+
+None.

doc/source/strategies/noisy_neighbor.rst

@@ -0,0 +1,97 @@
+==============
+Noisy neighbor
+==============
+
+Synopsis
+--------
+
+**display name**: ``Noisy Neighbor``
+
+**goal**: ``noisy_neighbor``
+
+    .. watcher-term:: watcher.decision_engine.strategy.strategies.noisy_neighbor.NoisyNeighbor
+
+Requirements
+------------
+
+Metrics
+*******
+
+The *noisy_neighbor* strategy requires the following metrics:
+
+============================ ============ ======= =======================
+metric                       service name plugins comment
+============================ ============ ======= =======================
+``cpu_l3_cache``             ceilometer_  none     Intel CMT_ is required
+============================ ============ ======= =======================
+
+.. _CMT: http://www.intel.com/content/www/us/en/architecture-and-technology/resource-director-technology.html
+.. _ceilometer: https://docs.openstack.org/ceilometer/latest/admin/telemetry-measurements.html#openstack-compute
+
+Cluster data model
+******************
+
+Default Watcher's Compute cluster data model:
+
+    .. watcher-term:: watcher.decision_engine.model.collector.nova.NovaClusterDataModelCollector
+
+Actions
+*******
+
+Default Watcher's actions:
+
+    .. list-table::
+       :widths: 30 30
+       :header-rows: 1
+
+       * - action
+         - description
+       * - ``migration``
+         - .. watcher-term:: watcher.applier.actions.migration.Migrate
+
+Planner
+*******
+
+Default Watcher's planner:
+
+    .. watcher-term:: watcher.decision_engine.planner.weight.WeightPlanner
+
+Configuration
+-------------
+
+Strategy parameter is:
+
+==================== ====== ============= ============================
+parameter            type   default       Value description
+==================== ====== ============= ============================
+``cache_threshold``  Number 35.0          Performance drop in L3_cache
+                                          threshold for migration
+==================== ====== ============= ============================
+
+
+Efficacy Indicator
+------------------
+
+None
+
+Algorithm
+---------
+
+For more information on the noisy neighbor strategy please refer to:
+http://specs.openstack.org/openstack/watcher-specs/specs/pike/implemented/noisy_neighbor_strategy.html
+
+How to use it ?
+---------------
+
+.. code-block:: shell
+
+    $ openstack optimize audittemplate create \
+      at1 noisy_neighbor --strategy noisy_neighbor
+
+    $ openstack optimize audit create -a at1 \
+      -p cache_threshold=45.0
+
+External Links
+--------------
+
+None

doc/source/strategies/outlet_temp_control.rst

@@ -9,11 +9,7 @@ Synopsis
 
 **goal**: ``thermal_optimization``
 
-Outlet (Exhaust Air) temperature is a new thermal telemetry which can be
-used to measure the host's thermal/workload status. This strategy makes
-decisions to migrate workloads to the hosts with good thermal condition
-(lowest outlet temperature) when the outlet temperature of source hosts
-reach a configurable threshold.
+    .. watcher-term:: watcher.decision_engine.strategy.strategies.outlet_temp_control
 
 Requirements
 ------------

doc/source/strategies/saving_energy.rst

@@ -9,7 +9,7 @@ Synopsis
 
 **goal**: ``saving_energy``
 
-    .. watcher-term:: watcher.decision_engine.strategy.strategies.saving_energy
+    .. watcher-term:: watcher.decision_engine.strategy.strategies.saving_energy.SavingEnergy
 
 Requirements
 ------------
@@ -67,13 +67,13 @@ parameter              type   default          description
 Efficacy Indicator
 ------------------
 
-Energy saving strategy efficacy indicator is unclassified.
-https://github.com/openstack/watcher/blob/master/watcher/decision_engine/goal/goals.py#L215-L218
+None
 
 Algorithm
 ---------
 
-For more information on the Energy Saving Strategy please refer to:http://specs.openstack.org/openstack/watcher-specs/specs/pike/implemented/energy-saving-strategy.html
+For more information on the Energy Saving Strategy please refer to:
+http://specs.openstack.org/openstack/watcher-specs/specs/pike/implemented/energy-saving-strategy.html
 
 How to use it ?
 ---------------
@@ -91,10 +91,10 @@ step 2: Create audit to do optimization
     $ openstack optimize audittemplate create \
       at1 saving_energy --strategy saving_energy
 
-    $ openstack optimize audit create -a at1
+    $ openstack optimize audit create -a at1 \
+      -p free_used_percent=20.0
 
 External Links
 --------------
 
-*Spec URL*
-http://specs.openstack.org/openstack/watcher-specs/specs/pike/implemented/energy-saving-strategy.html
+None

doc/source/strategies/storage_capacity_balance.rst

@@ -0,0 +1,87 @@
+========================
+Storage capacity balance
+========================
+
+Synopsis
+--------
+
+**display name**: ``Storage Capacity Balance Strategy``
+
+**goal**: ``workload_balancing``
+
+    .. watcher-term:: watcher.decision_engine.strategy.strategies.storage_capacity_balance.StorageCapacityBalance
+
+Requirements
+------------
+
+Metrics
+*******
+
+None
+
+Cluster data model
+******************
+
+Storage cluster data model is required:
+
+    .. watcher-term:: watcher.decision_engine.model.collector.cinder.CinderClusterDataModelCollector
+
+Actions
+*******
+
+Default Watcher's actions:
+
+    .. list-table::
+       :widths: 25 35
+       :header-rows: 1
+
+       * - action
+         - description
+       * - ``volume_migrate``
+         - .. watcher-term:: watcher.applier.actions.volume_migration.VolumeMigrate
+
+Planner
+*******
+
+Default Watcher's planner:
+
+    .. watcher-term:: watcher.decision_engine.planner.weight.WeightPlanner
+
+Configuration
+-------------
+
+Strategy parameter is:
+
+==================== ====== ============= =====================================
+parameter            type   default       Value description
+==================== ====== ============= =====================================
+``volume_threshold`` Number 80.0          Volume threshold for capacity balance
+==================== ====== ============= =====================================
+
+
+Efficacy Indicator
+------------------
+
+None
+
+Algorithm
+---------
+
+For more information on the storage capacity balance strategy please refer to:
+http://specs.openstack.org/openstack/watcher-specs/specs/queens/implemented/storage-capacity-balance.html
+
+How to use it ?
+---------------
+
+.. code-block:: shell
+
+    $ openstack optimize audittemplate create \
+      at1 workload_balancing --strategy storage_capacity_balance
+
+    $ openstack optimize audit create -a at1 \
+      -p volume_threshold=85.0
+
+External Links
+--------------
+
+None

doc/source/strategies/uniform_airflow.rst

@@ -9,7 +9,7 @@ Synopsis
 
 **goal**: ``airflow_optimization``
 
-.. watcher-term:: watcher.decision_engine.strategy.strategies.uniform_airflow
+    .. watcher-term:: watcher.decision_engine.strategy.strategies.uniform_airflow.UniformAirflow
 
 Requirements
 ------------

doc/source/strategies/vm_workload_consolidation.rst

@@ -9,7 +9,7 @@ Synopsis
 
 **goal**: ``vm_consolidation``
 
-    .. watcher-term:: watcher.decision_engine.strategy.strategies.vm_workload_consolidation
+    .. watcher-term:: watcher.decision_engine.strategy.strategies.vm_workload_consolidation.VMWorkloadConsolidation
 
 Requirements
 ------------

doc/source/strategies/workload-stabilization.rst

@@ -9,7 +9,7 @@ Synopsis
 
 **goal**: ``workload_balancing``
 
-    .. watcher-term:: watcher.decision_engine.strategy.strategies.workload_stabilization
+    .. watcher-term:: watcher.decision_engine.strategy.strategies.workload_stabilization.WorkloadStabilization
 
 Requirements
 ------------

doc/source/strategies/workload_balance.rst

@@ -9,7 +9,7 @@ Synopsis
 
 **goal**: ``workload_balancing``
 
-.. watcher-term:: watcher.decision_engine.strategy.strategies.workload_balance
+    .. watcher-term:: watcher.decision_engine.strategy.strategies.workload_balance.WorkloadBalance
 
 Requirements
 ------------

doc/source/strategies/zone_migration.rst

@@ -9,7 +9,7 @@ Synopsis
 
 **goal**: ``hardware_maintenance``
 
-    .. watcher-term:: watcher.decision_engine.strategy.strategies.zone_migration
+    .. watcher-term:: watcher.decision_engine.strategy.strategies.zone_migration.ZoneMigration
 
 Requirements
 ------------

doc/source/user/user-guide.rst

@@ -39,6 +39,22 @@ named ``watcher``, or by using the `OpenStack CLI`_ ``openstack``.
 If you want to deploy Watcher in Horizon, please refer to the `Watcher Horizon
 plugin installation guide`_.
 
+.. note::
+
+   Notice, that in this guide we'll use `OpenStack CLI`_ as major interface.
+   Nevertheless, you can use `Watcher CLI`_ in the same way. It can be
+   achieved by replacing
+
+   .. code:: bash
+
+     $ openstack optimize ...
+
+   with
+
+   .. code:: bash
+
+     $ watcher ...
+
 .. _`installation guide`: https://docs.openstack.org/python-watcherclient/latest
 .. _`Watcher Horizon plugin installation guide`: https://docs.openstack.org/watcher-dashboard/latest/install/installation.html
 .. _`OpenStack CLI`: https://docs.openstack.org/python-openstackclient/latest/cli/man/openstack.html
@@ -51,10 +67,6 @@ watcher binary without options.
 
 .. code:: bash
 
-  $ watcher help
-
-or::
-
   $ openstack help optimize
 
 How do I run an audit of my cluster ?
@@ -64,10 +76,6 @@ First, you need to find the :ref:`goal <goal_definition>` you want to achieve:
 
 .. code:: bash
 
-  $ watcher goal list
-
-or::
-
   $ openstack optimize goal list
 
 .. note::
@@ -81,10 +89,6 @@ An :ref:`audit template <audit_template_definition>` defines an optimization
 
 .. code:: bash
 
-  $ watcher audittemplate create my_first_audit_template <your_goal>
-
-or::
-
   $ openstack optimize audittemplate create my_first_audit_template <your_goal>
 
 Although optional, you may want to actually set a specific strategy for your
@@ -93,10 +97,6 @@ following command:
 
 .. code:: bash
 
-  $ watcher strategy list --goal <your_goal_uuid_or_name>
-
-or::
-
   $ openstack optimize strategy list --goal <your_goal_uuid_or_name>
 
 You can use the following command to check strategy details including which
@@ -104,21 +104,12 @@ parameters of which format it supports:
 
 .. code:: bash
 
-  $ watcher strategy show <your_strategy>
-
-or::
-
   $ openstack optimize strategy show <your_strategy>
 
 The command to create your audit template would then be:
 
 .. code:: bash
 
-  $ watcher audittemplate create my_first_audit_template <your_goal> \
-    --strategy <your_strategy>
-
-or::
-
   $ openstack optimize audittemplate create my_first_audit_template <your_goal> \
     --strategy <your_strategy>
 
@@ -133,10 +124,6 @@ audit) that you want to use.
 
 .. code:: bash
 
-  $ watcher audittemplate list
-
-or::
-
   $ openstack optimize audittemplate list
 
 - Start an audit based on this :ref:`audit template
@@ -144,10 +131,6 @@ or::
 
 .. code:: bash
 
-  $ watcher audit create -a <your_audit_template>
-
-or::
-
   $ openstack optimize audit create -a <your_audit_template>
 
 If your_audit_template was created by --strategy <your_strategy>, and it
@@ -156,11 +139,6 @@ format), your can append `-p` to input required parameters:
 
 .. code:: bash
 
-  $ watcher audit create -a <your_audit_template> \
-    -p <your_strategy_para1>=5.5 -p <your_strategy_para2>=hi
-
-or::
-
   $ openstack optimize audit create -a <your_audit_template> \
     -p <your_strategy_para1>=5.5 -p <your_strategy_para2>=hi
 
@@ -173,19 +151,13 @@ Input parameter could cause audit creation failure, when:
 Watcher service will compute an :ref:`Action Plan <action_plan_definition>`
 composed of a list of potential optimization :ref:`actions <action_definition>`
 (instance migration, disabling of a compute node, ...) according to the
-:ref:`goal <goal_definition>` to achieve. You can see all of the goals
-available in section ``[watcher_strategies]`` of the Watcher service
-configuration file.
+:ref:`goal <goal_definition>` to achieve.
 
 - Wait until the Watcher audit has produced a new :ref:`action plan
   <action_plan_definition>`, and get it:
 
 .. code:: bash
 
-  $ watcher actionplan list --audit <the_audit_uuid>
-
-or::
-
   $ openstack optimize actionplan list --audit <the_audit_uuid>
 
 - Have a look on the list of optimization :ref:`actions <action_definition>`
@@ -193,10 +165,6 @@ or::
 
 .. code:: bash
 
-  $ watcher action list --action-plan <the_action_plan_uuid>
-
-or::
-
   $ openstack optimize action list --action-plan <the_action_plan_uuid>
 
 Once you have learned how to create an :ref:`Action Plan
@@ -207,10 +175,6 @@ cluster:
 
 .. code:: bash
 
-  $ watcher actionplan start <the_action_plan_uuid>
-
-or::
-
   $ openstack optimize actionplan start <the_action_plan_uuid>
 
 You can follow the states of the :ref:`actions <action_definition>` by
@@ -218,19 +182,11 @@ periodically calling:
 
 .. code:: bash
 
-  $ watcher action list
-
-or::
-
   $ openstack optimize action list
 
 You can also obtain more detailed information about a specific action:
 
 .. code:: bash
 
-  $ watcher action show <the_action_uuid>
-
-or::
-
   $ openstack optimize action show <the_action_uuid>
 

lower-constraints.txt

@@ -0,0 +1,163 @@
+alabaster==0.7.10
+alembic==0.9.8
+amqp==2.2.2
+appdirs==1.4.3
+APScheduler==3.5.1
+asn1crypto==0.24.0
+automaton==1.14.0
+Babel==2.5.3
+bandit==1.4.0
+beautifulsoup4==4.6.0
+cachetools==2.0.1
+certifi==2018.1.18
+cffi==1.11.5
+chardet==3.0.4
+cliff==2.11.0
+cmd2==0.8.1
+contextlib2==0.5.5
+coverage==4.5.1
+croniter==0.3.20
+cryptography==2.1.4
+debtcollector==1.19.0
+decorator==4.2.1
+deprecation==2.0
+doc8==0.8.0
+docutils==0.14
+dogpile.cache==0.6.5
+dulwich==0.19.0
+enum34==1.1.6
+enum-compat==0.0.2
+eventlet==0.20.0
+extras==1.0.0
+fasteners==0.14.1
+fixtures==3.0.0
+flake8==2.5.5
+freezegun==0.3.10
+future==0.16.0
+futurist==1.6.0
+gitdb2==2.0.3
+GitPython==2.1.8
+gnocchiclient==7.0.1
+greenlet==0.4.13
+hacking==0.12.0
+idna==2.6
+imagesize==1.0.0
+iso8601==0.1.12
+Jinja2==2.10
+jmespath==0.9.3
+jsonpatch==1.21
+jsonpointer==2.0
+jsonschema==2.6.0
+keystoneauth1==3.4.0
+keystonemiddleware==4.21.0
+kombu==4.1.0
+linecache2==1.0.0
+logutils==0.3.5
+lxml==4.1.1
+Mako==1.0.7
+MarkupSafe==1.0
+mccabe==0.2.1
+mock==2.0.0
+monotonic==1.4
+mox3==0.25.0
+msgpack==0.5.6
+munch==2.2.0
+netaddr==0.7.19
+netifaces==0.10.6
+networkx==1.11
+openstackdocstheme==1.20.0
+openstacksdk==0.12.0
+os-api-ref===1.4.0
+os-client-config==1.29.0
+os-service-types==1.2.0
+os-testr==1.0.0
+osc-lib==1.10.0
+oslo.cache==1.29.0
+oslo.concurrency==3.26.0
+oslo.config==5.2.0
+oslo.context==2.20.0
+oslo.db==4.35.0
+oslo.i18n==3.20.0
+oslo.log==3.37.0
+oslo.messaging==5.36.0
+oslo.middleware==3.35.0
+oslo.policy==1.34.0
+oslo.reports==1.27.0
+oslo.serialization==2.25.0
+oslo.service==1.30.0
+oslo.utils==3.36.0
+oslo.versionedobjects==1.32.0
+oslotest==3.3.0
+packaging==17.1
+Paste==2.0.3
+PasteDeploy==1.5.2
+pbr==3.1.1
+pecan==1.2.1
+pep8==1.5.7
+pika==0.10.0
+pika-pool==0.1.3
+prettytable==0.7.2
+psutil==5.4.3
+pycadf==2.7.0
+pycparser==2.18
+pyflakes==0.8.1
+Pygments==2.2.0
+pyinotify==0.9.6
+pyOpenSSL==17.5.0
+pyparsing==2.2.0
+pyperclip==1.6.0
+python-ceilometerclient==2.9.0
+python-cinderclient==3.5.0
+python-dateutil==2.7.0
+python-editor==1.0.3
+python-glanceclient==2.9.1
+python-ironicclient==2.3.0
+python-keystoneclient==3.15.0
+python-mimeparse==1.6.0
+python-monascaclient==1.12.0
+python-neutronclient==6.7.0
+python-novaclient==10.1.0
+python-openstackclient==3.14.0
+python-subunit==1.2.0
+pytz==2018.3
+PyYAML==3.12
+reno==2.7.0
+repoze.lru==0.7
+requests==2.18.4
+requestsexceptions==1.4.0
+restructuredtext-lint==1.1.3
+rfc3986==1.1.0
+Routes==2.4.1
+simplegeneric==0.8.1
+simplejson==3.13.2
+six==1.11.0
+smmap2==2.0.3
+snowballstemmer==1.2.1
+Sphinx==1.6.5
+sphinxcontrib-httpdomain==1.6.1
+sphinxcontrib-pecanwsme==0.8.0
+sphinxcontrib-websupport==1.0.1
+SQLAlchemy==1.2.5
+sqlalchemy-migrate==0.11.0
+sqlparse==0.2.4
+statsd==3.2.2
+stestr==2.0.0
+stevedore==1.28.0
+taskflow==3.1.0
+Tempita==0.5.2
+tenacity==4.9.0
+testresources==2.0.1
+testscenarios==0.5.0
+testtools==2.3.0
+traceback2==1.4.0
+tzlocal==1.5.1
+ujson==1.35
+unittest2==1.1.0
+urllib3==1.22
+vine==1.1.4
+waitress==1.1.0
+warlock==1.3.0
+WebOb==1.7.4
+WebTest==2.0.29
+wrapt==1.10.11
+WSME==0.9.2

playbooks/legacy/watcher-tempest-base-multinode/post.yaml

@@ -1,15 +0,0 @@
-- hosts: primary
-  tasks:
-
-    - name: Copy files from {{ ansible_user_dir }}/workspace/ on node
-      synchronize:
-        src: '{{ ansible_user_dir }}/workspace/'
-        dest: '{{ zuul.executor.log_root }}'
-        mode: pull
-        copy_links: true
-        verify_host: true
-        rsync_opts:
-          - --include=/logs/**
-          - --include=*/
-          - --exclude=*
-          - --prune-empty-dirs

playbooks/legacy/watcher-tempest-base-multinode/run.yaml

@@ -1,67 +0,0 @@
-- hosts: primary
-  name: Legacy Watcher tempest base multinode
-  tasks:
-
-    - name: Ensure legacy workspace directory
-      file:
-        path: '{{ ansible_user_dir }}/workspace'
-        state: directory
-
-    - shell:
-        cmd: |
-          set -e
-          set -x
-          cat > clonemap.yaml << EOF
-          clonemap:
-            - name: openstack-infra/devstack-gate
-              dest: devstack-gate
-          EOF
-          /usr/zuul-env/bin/zuul-cloner -m clonemap.yaml --cache-dir /opt/git \
-              git://git.openstack.org \
-              openstack-infra/devstack-gate
-        executable: /bin/bash
-        chdir: '{{ ansible_user_dir }}/workspace'
-      environment: '{{ zuul | zuul_legacy_vars }}'
-
-    - shell:
-        cmd: |
-          set -e
-          set -x
-          cat << 'EOF' >>"/tmp/dg-local.conf"
-          [[local|localrc]]
-          TEMPEST_PLUGINS='/opt/stack/new/watcher-tempest-plugin'
-          enable_plugin ceilometer git://git.openstack.org/openstack/ceilometer
-          # Enable watcher devstack plugin.
-          enable_plugin watcher git://git.openstack.org/openstack/watcher
-
-          EOF
-        executable: /bin/bash
-        chdir: '{{ ansible_user_dir }}/workspace'
-      environment: '{{ zuul | zuul_legacy_vars }}'
-
-    - shell:
-        cmd: |
-          set -e
-          set -x
-
-          export DEVSTACK_SUBNODE_CONFIG=" "
-          export PYTHONUNBUFFERED=true
-          export DEVSTACK_GATE_TEMPEST=1
-          export DEVSTACK_GATE_NEUTRON=1
-          export DEVSTACK_GATE_TOPOLOGY="multinode"
-          export PROJECTS="openstack/watcher $PROJECTS"
-          export PROJECTS="openstack/python-watcherclient $PROJECTS"
-          export PROJECTS="openstack/watcher-tempest-plugin $PROJECTS"
-
-          export DEVSTACK_GATE_TEMPEST_REGEX="watcher_tempest_plugin"
-
-          export BRANCH_OVERRIDE=default
-          if [ "$BRANCH_OVERRIDE" != "default" ] ; then
-              export OVERRIDE_ZUUL_BRANCH=$BRANCH_OVERRIDE
-          fi
-
-          cp devstack-gate/devstack-vm-gate-wrap.sh ./safe-devstack-vm-gate-wrap.sh
-          ./safe-devstack-vm-gate-wrap.sh
-        executable: /bin/bash
-        chdir: '{{ ansible_user_dir }}/workspace'
-      environment: '{{ zuul | zuul_legacy_vars }}'

playbooks/legacy/watcherclient-tempest-functional/post.yaml

@@ -1,80 +0,0 @@
-- hosts: primary
-  tasks:
-
-    - name: Copy files from {{ ansible_user_dir }}/workspace/ on node
-      synchronize:
-        src: '{{ ansible_user_dir }}/workspace/'
-        dest: '{{ zuul.executor.log_root }}'
-        mode: pull
-        copy_links: true
-        verify_host: true
-        rsync_opts:
-          - --include=**/*nose_results.html
-          - --include=*/
-          - --exclude=*
-          - --prune-empty-dirs
-
-    - name: Copy files from {{ ansible_user_dir }}/workspace/ on node
-      synchronize:
-        src: '{{ ansible_user_dir }}/workspace/'
-        dest: '{{ zuul.executor.log_root }}'
-        mode: pull
-        copy_links: true
-        verify_host: true
-        rsync_opts:
-          - --include=**/*testr_results.html.gz
-          - --include=*/
-          - --exclude=*
-          - --prune-empty-dirs
-
-    - name: Copy files from {{ ansible_user_dir }}/workspace/ on node
-      synchronize:
-        src: '{{ ansible_user_dir }}/workspace/'
-        dest: '{{ zuul.executor.log_root }}'
-        mode: pull
-        copy_links: true
-        verify_host: true
-        rsync_opts:
-          - --include=/.testrepository/tmp*
-          - --include=*/
-          - --exclude=*
-          - --prune-empty-dirs
-
-    - name: Copy files from {{ ansible_user_dir }}/workspace/ on node
-      synchronize:
-        src: '{{ ansible_user_dir }}/workspace/'
-        dest: '{{ zuul.executor.log_root }}'
-        mode: pull
-        copy_links: true
-        verify_host: true
-        rsync_opts:
-          - --include=**/*testrepository.subunit.gz
-          - --include=*/
-          - --exclude=*
-          - --prune-empty-dirs
-
-    - name: Copy files from {{ ansible_user_dir }}/workspace/ on node
-      synchronize:
-        src: '{{ ansible_user_dir }}/workspace/'
-        dest: '{{ zuul.executor.log_root }}/tox'
-        mode: pull
-        copy_links: true
-        verify_host: true
-        rsync_opts:
-          - --include=/.tox/*/log/*
-          - --include=*/
-          - --exclude=*
-          - --prune-empty-dirs
-
-    - name: Copy files from {{ ansible_user_dir }}/workspace/ on node
-      synchronize:
-        src: '{{ ansible_user_dir }}/workspace/'
-        dest: '{{ zuul.executor.log_root }}'
-        mode: pull
-        copy_links: true
-        verify_host: true
-        rsync_opts:
-          - --include=/logs/**
-          - --include=*/
-          - --exclude=*
-          - --prune-empty-dirs

playbooks/legacy/watcherclient-tempest-functional/run.yaml

@@ -1,64 +0,0 @@
-- hosts: all
-  name: Legacy watcherclient-dsvm-functional
-  tasks:
-
-    - name: Ensure legacy workspace directory
-      file:
-        path: '{{ ansible_user_dir }}/workspace'
-        state: directory
-
-    - shell:
-        cmd: |
-          set -e
-          set -x
-          cat > clonemap.yaml << EOF
-          clonemap:
-            - name: openstack-infra/devstack-gate
-              dest: devstack-gate
-          EOF
-          /usr/zuul-env/bin/zuul-cloner -m clonemap.yaml --cache-dir /opt/git \
-              git://git.openstack.org \
-              openstack-infra/devstack-gate
-        executable: /bin/bash
-        chdir: '{{ ansible_user_dir }}/workspace'
-      environment: '{{ zuul | zuul_legacy_vars }}'
-
-    - shell:
-        cmd: |
-          set -e
-          set -x
-          cat << 'EOF' >>"/tmp/dg-local.conf"
-          [[local|localrc]]
-          enable_plugin watcher git://git.openstack.org/openstack/watcher
-
-          EOF
-        executable: /bin/bash
-        chdir: '{{ ansible_user_dir }}/workspace'
-      environment: '{{ zuul | zuul_legacy_vars }}'
-
-    - shell:
-        cmd: |
-          set -e
-          set -x
-          ENABLED_SERVICES=tempest
-          ENABLED_SERVICES+=,watcher-api,watcher-decision-engine,watcher-applier
-          export ENABLED_SERVICES
-
-          export PYTHONUNBUFFERED=true
-          export BRANCH_OVERRIDE=default
-          export PROJECTS="openstack/watcher $PROJECTS"
-          export DEVSTACK_PROJECT_FROM_GIT=python-watcherclient
-          if [ "$BRANCH_OVERRIDE" != "default" ] ; then
-              export OVERRIDE_ZUUL_BRANCH=$BRANCH_OVERRIDE
-          fi
-          function post_test_hook {
-              # Configure and run functional tests
-              $BASE/new/python-watcherclient/watcherclient/tests/functional/hooks/post_test_hook.sh
-          }
-          export -f post_test_hook
-
-          cp devstack-gate/devstack-vm-gate-wrap.sh ./safe-devstack-vm-gate-wrap.sh
-          ./safe-devstack-vm-gate-wrap.sh
-        executable: /bin/bash
-        chdir: '{{ ansible_user_dir }}/workspace'
-      environment: '{{ zuul | zuul_legacy_vars }}'

playbooks/orchestrate-tempest.yaml

@@ -0,0 +1,14 @@
+- hosts: all
+  # This is the default strategy, however since orchestrate-devstack requires
+  # "linear", it is safer to enforce it in case this is running in an
+  # environment configured with a different default strategy.
+  strategy: linear
+  roles:
+    - orchestrate-devstack
+
+- hosts: tempest
+  roles:
+    - setup-tempest-run-dir
+    - setup-tempest-data-dir
+    - acl-devstack-files
+    - run-tempest

playbooks/pre.yaml

@@ -0,0 +1,3 @@
+- hosts: all
+  roles:
+    - add-hostnames-to-hosts

rally-jobs/README.rst

@@ -29,7 +29,7 @@ Useful links
 
 * How to install: https://docs.openstack.org/rally/latest/install_and_upgrade/install.html
 
-* How to set Rally up and launch your first scenario: https://rally.readthedocs.io/en/latest/tutorial/step_1_setting_up_env_and_running_benchmark_from_samples.html
+* How to set Rally up and launch your first scenario: https://rally.readthedocs.io/en/latest/quick_start/tutorial/step_1_setting_up_env_and_running_benchmark_from_samples.html
 
 * More about Rally: https://docs.openstack.org/rally/latest/
 

releasenotes/notes/add-ha-support-b9042255e5b76e42.yaml

@@ -0,0 +1,6 @@
+---
+features:
+  - Watcher services can be launched in HA mode. From now on Watcher Decision
+    Engine and Watcher Applier services may be deployed on different nodes to
+    run in active-active or active-passive mode. Any ONGOING Audits or Action Plans
+    will be CANCELLED if service they are executed on is restarted.

releasenotes/notes/add-name-for-audit-0df1f39f00736f06.yaml

@@ -0,0 +1,4 @@
+---
+features:
+  - Audits have 'name' field now, that is more friendly to end users.
+    Audit's name can't exceed 63 characters.

releasenotes/notes/bp-audit-scope-exclude-project-511a7720aac00dff.yaml

@@ -0,0 +1,6 @@
+---
+features:
+  - |
+    Feature to exclude instances from audit scope based on project_id is added.
+    Now instances from particular project in OpenStack can be excluded from audit
+    defining scope in audit templates.