Merge "Move client function test to watcher-tempest-plugin"

Depends-On: https://review.openstack.org/643244
Change-Id: I463203fee608be6684a09326d189d0254696d8e0

.gitignore

@@ -23,11 +23,10 @@ pip-log.txt
 # Unit test / coverage reports
 .coverage*
 .tox
-nosetests.xml
 .stestr/
-.testrepository
 .venv
 .idea
+.testrepository/
 
 # Translations
 *.mo
@@ -76,3 +75,6 @@ releasenotes/build
 
 # Autogenerated sample config file
 etc/watcher/watcher.conf.sample
+
+# Atom
+.remote-sync.json

.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,68 +1,131 @@
 - project:
+    templates:
+      - check-requirements
+      - openstack-cover-jobs
+      - openstack-lower-constraints-jobs
+      - openstack-python-jobs
+      - openstack-python35-jobs
+      - openstack-python36-jobs
+      - publish-openstack-docs-pti
+      - release-notes-jobs-python3
     check:
       jobs:
         - watcher-tempest-functional
+        - watcher-grenade
         - watcher-tempest-dummy_optim
         - watcher-tempest-actuator
         - watcher-tempest-basic_optim
+        - watcher-tempest-vm_workload_consolidation
         - watcher-tempest-workload_balancing
         - watcherclient-tempest-functional
-        - legacy-rally-dsvm-watcher-rally
-        - openstack-tox-lower-constraints
+        - watcher-tempest-zone_migration
+        - watcher-tempest-host_maintenance
+        - watcher-tempest-storage_balance
+        - watcher-tls-test
     gate:
+      queue: watcher
       jobs:
         - watcher-tempest-functional
-        - watcher-tempest-dummy_optim
-        - watcher-tempest-actuator
-        - watcher-tempest-basic_optim
-        - watcher-tempest-workload_balancing
-        - watcherclient-tempest-functional
-        - legacy-rally-dsvm-watcher-rally
-        - openstack-tox-lower-constraints
 
 - job:
     name: watcher-tempest-dummy_optim
     parent: watcher-tempest-multinode
+    voting: false
     vars:
-      tempest_test_regex: 'watcher_tempest_plugin.tests.scenario.test_execute_dummy_optim'
+      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'
+      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'
+      tempest_test_regex: watcher_tempest_plugin.tests.scenario.test_execute_basic_optim
+
+- job:
+    name: watcher-tempest-vm_workload_consolidation
+    parent: watcher-tempest-multinode
+    voting: false
+    vars:
+      tempest_test_regex: watcher_tempest_plugin.tests.scenario.test_execute_vm_workload_consolidation
+      devstack_local_conf:
+        test-config:
+          $WATCHER_CONFIG:
+            watcher_strategies.vm_workload_consolidation:
+              datasource: ceilometer
 
 - 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'
+      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-host_maintenance
+    parent: watcher-tempest-multinode
+    voting: false
+    vars:
+      tempest_test_regex: watcher_tempest_plugin.tests.scenario.test_execute_host_maintenance
+
+- job:
+    name: watcher-tempest-storage_balance
+    parent: watcher-tempest-multinode
+    voting: false
+    vars:
+      tempest_test_regex: watcher_tempest_plugin.tests.scenario.test_execute_storage_balance
+      devstack_local_conf:
+        test-config:
+          $TEMPEST_CONFIG:
+            volume:
+              backend_names: ['BACKEND_1', 'BACKEND_2']
+            volume-feature-enabled:
+              multi_backend: true
+
+- job:
+    name: watcher-tls-test
+    parent: watcher-tempest-multinode
+    group-vars:
+      subnode:
+          devstack_services:
+            tls-proxy: true
+    vars:
+      devstack_services:
+        tls-proxy: true
 
 - job:
     name: watcher-tempest-multinode
     parent: watcher-tempest-functional
-    voting: false
     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: false
+          watcher-decision-engine: true
           watcher-applier: false
           # We need to add TLS support for watcher plugin
           tls-proxy: false
@@ -78,9 +141,13 @@
     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:
@@ -117,8 +184,8 @@
         s-object: false
         s-proxy: false
       devstack_localrc:
-        TEMPEST_PLUGINS: '/opt/stack/watcher-tempest-plugin'
-      tempest_test_regex: 'watcher_tempest_plugin.tests.api'
+        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
@@ -126,6 +193,30 @@
       zuul_copy_output:
         /etc/hosts: logs
 
+- job:
+    name: watcher-grenade
+    parent: legacy-dsvm-base
+    timeout: 10800
+    run: playbooks/legacy/grenade-devstack-watcher/run.yaml
+    post-run: playbooks/legacy/grenade-devstack-watcher/post.yaml
+    irrelevant-files:
+      - ^(test-|)requirements.txt$
+      - ^.*\.rst$
+      - ^api-ref/.*$
+      - ^doc/.*$
+      - ^watcher/hacking/.*$
+      - ^watcher/tests/.*$
+      - ^releasenotes/.*$
+      - ^setup.cfg$
+      - ^tools/.*$
+      - ^tox.ini$
+    required-projects:
+      - openstack-dev/grenade
+      - openstack-infra/devstack-gate
+      - openstack/watcher
+      - openstack/python-watcherclient
+      - openstack/watcher-tempest-plugin
+
 - job:
     # This job is used in python-watcherclient repo
     name: watcherclient-tempest-functional
@@ -134,6 +225,4 @@
     timeout: 4200
     vars:
       tempest_concurrency: 1
-      devstack_localrc:
-        TEMPEST_PLUGINS: '/opt/stack/python-watcherclient'
-      tempest_test_regex: 'watcherclient.tests.functional'
+      tempest_test_regex: watcher_tempest_plugin.tests.client_functional

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,17 @@
+:tocdepth: 2
+
+===========
+Watcher API
+===========
+
+.. rest_expand_all::
+
+.. include:: watcher-api-versions.inc
+.. 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,546 @@
+# variables in header
+header_version:
+  description: |
+    Specific API microversion used to generate this response.
+  in: header
+  required: true
+  type: string
+openstack-api-max-version:
+  description: |
+    Maximum API microversion supported by this endpoint, eg. "1.1"
+  in: header
+  required: true
+  type: string
+openstack-api-min-version:
+  description: |
+    Minimum API microversion supported by this endpoint, eg. "1.0"
+  in: header
+  required: true
+  type: string
+openstack-api-version:
+  description: >
+    A request SHOULD include this header to indicate to the Watcher API service what
+    version the client supports. The server will transform the response object into
+    compliance with the requested version, if it is supported, or return a
+    406 Not Acceptable error.
+    If this header is not supplied, the server will response with server minimum
+    supported version.
+  in: header
+  required: true
+  type: string
+openstack-request-id:
+  description: >
+    An unique ID for tracking the request. The request ID associated with the request
+    appears in the log lines for that request. By default, the middleware configuration
+    ensures that the request ID appears in the log files.
+  in: header
+  required: false
+  type: string
+
+# 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_hostname:
+  description: |
+    Hostname the actionplan is running on
+  in: body
+  required: false
+  type: string
+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: |
+    Auto execute action plan once audit is succeeded.
+  in: body
+  required: false
+  type: boolean
+audit_endtime_req:
+  description: |
+    The local time after which audit can't be executed.
+    It will be converted to UTC time by Watcher.
+  in: body
+  required: false
+  type: string
+  min_version: 1.1
+audit_endtime_resp:
+  description: |
+    The UTC time after which audit can't be executed.
+  in: body
+  required: false
+  type: string
+  min_version: 1.1
+audit_goal:
+  description: |
+    The UUID or name of the Goal.
+  in: body
+  required: false
+  type: string
+audit_hostname:
+  description: |
+    Hostname the audit is running on
+  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_starttime_req:
+  description: |
+    The local time after which audit can be executed in accordance
+    with interval. It will be converted to UTC time by Watcher.
+  in: body
+  required: false
+  type: string
+  min_version: 1.1
+audit_starttime_resp:
+  description: |
+    The UTC time after which audit can be executed in accordance with interval.
+  in: body
+  required: false
+  type: string
+  min_version: 1.1
+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 only 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
+audittemplate_uuid:
+  description: |
+    The UUID of the Audit template.
+  in: body
+  required: true
+  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
+
+# Version
+version:
+  description: |
+    Versioning of this API response, eg. "1.1".
+  in: body
+  required: true
+  type: string
+version_description:
+  description: |
+    Descriptive text about the Watcher service.
+  in: body
+  required: true
+  type: string
+version_id:
+  description: |
+    Major API version, eg, "v1"
+  in: body
+  required: true
+  type: string
+versions:
+  description: |
+    Array of information about currently supported versions.
+  in: body
+  required: true
+  type: array

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,27 @@
+{
+    "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",
+            "hostname": "controller"
+        }
+    ]
+}

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,21 @@
+{
+    "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",
+    "hostname": "controller"
+}

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

@@ -0,0 +1,23 @@
+{
+    "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,
+    "hostname": 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/api-root-response.json

@@ -0,0 +1,30 @@
+{
+  "default_version": {
+    "id": "v1",
+    "links": [
+      {
+        "href": "http://controller:9322/v1/",
+        "rel": "self"
+      }
+    ],
+    "min_version": "1.0",
+    "status": "CURRENT",
+    "max_version": "1.1"
+  },
+  "description": "Watcher is an OpenStack project which aims to improve physical resources usage through better VM placement.",
+  "name": "OpenStack Watcher API",
+  "versions": [
+    {
+      "id": "v1",
+      "links": [
+        {
+          "href": "http://controller:9322/v1/",
+          "rel": "self"
+        }
+      ],
+      "min_version": "1.0",
+      "status": "CURRENT",
+      "max_version": "1.1"
+    }
+  ]
+}

api-ref/source/samples/api-v1-root-response.json

@@ -0,0 +1,80 @@
+{
+  "scoring_engines": [
+    {
+      "href": "http://controller:9322/v1/scoring_engines/",
+      "rel": "self"
+    },
+    {
+      "href": "http://controller:9322/scoring_engines/",
+      "rel": "bookmark"
+    }
+  ],
+  "media_types": [
+    {
+      "base": "application/json",
+      "type": "application/vnd.openstack.watcher.v1+json"
+    }
+  ],
+  "links": [
+    {
+      "href": "http://controller:9322/v1/",
+      "rel": "self"
+    },
+    {
+      "href": "http://docs.openstack.org/developer/watcher/dev/api-spec-v1.html",
+      "type": "text/html",
+      "rel": "describedby"
+    }
+  ],
+  "actions": [
+    {
+      "href": "http://controller:9322/v1/actions/",
+      "rel": "self"
+    },
+    {
+      "href": "http://controller:9322/actions/",
+      "rel": "bookmark"
+    }
+  ],
+  "audit_templates": [
+    {
+      "href": "http://controller:9322/v1/audit_templates/",
+      "rel": "self"
+    },
+    {
+      "href": "http://controller:9322/audit_templates/",
+      "rel": "bookmark"
+    }
+  ],
+  "action_plans": [
+    {
+      "href": "http://controller:9322/v1/action_plans/",
+      "rel": "self"
+    },
+    {
+      "href": "http://controller:9322/action_plans/",
+      "rel": "bookmark"
+    }
+  ],
+  "services": [
+    {
+      "href": "http://controller:9322/v1/services/",
+      "rel": "self"
+    },
+    {
+      "href": "http://controller:9322/services/",
+      "rel": "bookmark"
+    }
+  ],
+  "audits": [
+    {
+      "href": "http://controller:9322/v1/audits/",
+      "rel": "self"
+    },
+    {
+      "href": "http://controller:9322/audits/",
+      "rel": "bookmark"
+    }
+  ],
+  "id": "v1"
+}

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,54 @@
+{
+    "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",
+    "hostname": "controller",
+    "start_time": null,
+    "end_time": null
+}

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

@@ -0,0 +1,14 @@
+{
+    "auto_trigger": false,
+    "audit_template_uuid": "76fddfee-a9c4-40b0-8da0-c19ad6904f09",
+    "name": "test_audit",
+    "parameters": {
+        "metrics": [
+            "cpu_util"
+        ]
+    },
+    "audit_type": "CONTINUOUS",
+    "interval": "*/2 * * * *",
+    "start_time":"2018-04-02 20:30:00",
+    "end_time": "2018-04-04 20:30:00"
+}

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,54 @@
+{
+    "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,
+    "hostname": null,
+    "start_time": null,
+    "end_time": null
+}

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

@@ -0,0 +1,58 @@
+{
+    "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",
+            "hostname": "controller",
+            "start_time": null,
+            "end_time": null
+        }
+    ]
+}

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,54 @@
+{
+    "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",
+    "hostname": "controller",
+    "start_time": null,
+    "end_time": null
+}

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,54 @@
+{
+    "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",
+    "hostname": "controller",
+    "start_time": null,
+    "end_time": null
+}

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,258 @@
+.. -*- 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
+    - hostname: actionplan_hostname
+
+**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
+    - hostname: actionplan_hostname
+
+**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
+    - hostname: actionplan_hostname
+
+**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
+    - hostname: actionplan_hostname
+
+**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,361 @@
+.. -*- 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.
+
+Normal response codes: 201
+
+Error codes: 400,404
+
+Request
+-------
+
+.. rest_parameters:: parameters.yaml
+
+   - audit_template_uuid: audittemplate_uuid
+   - audit_type: audit_type
+   - name: audit_name
+   - goal: audit_goal
+   - strategy: audit_strategy
+   - parameters: audit_parameters
+   - interval: audit_interval
+   - auto_trigger: audit_autotrigger
+   - start_time: audit_starttime_req
+   - end_time: audit_endtime_req
+
+**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
+    - hostname: audit_hostname
+    - start_time: audit_starttime_resp
+    - end_time: audit_endtime_resp
+
+**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
+    - hostname: audit_hostname
+    - start_time: audit_starttime_resp
+    - end_time: audit_endtime_resp
+
+**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
+    - hostname: audit_hostname
+    - start_time: audit_starttime_resp
+    - end_time: audit_endtime_resp
+
+**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
+    - hostname: audit_hostname
+    - start_time: audit_starttime_resp
+    - end_time: audit_endtime_resp
+
+**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
+    - hostname: audit_hostname
+    - start_time: audit_starttime_resp
+    - end_time: audit_endtime_resp
+
+**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

api-ref/source/watcher-api-versions.inc

@@ -0,0 +1,81 @@
+.. -*- rst -*-
+
+============
+API versions
+============
+
+In order to bring new features to users over time, the Watcher API
+supports versioning. There are two kinds of versions in Watcher.
+
+- ''major versions'', which have dedicated URLs.
+- ''microversions'', which can be requested using the
+  ``OpenStack-API-Version`` header.
+
+.. note:: The maximum microversion depends on release.
+  Please reference:
+  `API Microversion History
+  <https://docs.openstack.org/watcher/latest/contributor/api_microversion_history.html>`__
+  for API microversion history details.
+
+The Version API resource works differently from other API resources as they *do not*
+require authentication.
+
+If Watcher receives a request with unsupported version, it responds with a 406 Not Acceptable,
+along with the -Min- and -Max- headers that it can support.
+
+List API versions
+=================
+
+.. rest_method::  GET /
+
+This fetches all the information about all known major API versions in the
+deployment. Links to more specific information will be provided for each major
+API version, as well as information about supported min and max microversions.
+
+Normal response codes: 200
+
+Request
+-------
+
+Response Example
+----------------
+
+.. rest_parameters::  parameters.yaml
+
+    - description: version_description
+    - versions: versions
+    - version: version
+    - id: version_id
+    - links: links
+    - min_version: openstack-api-min-version
+    - max_version: openstack-api-max-version
+
+.. literalinclude:: samples/api-root-response.json
+   :language: javascript
+
+
+Show v1 API
+===========
+
+.. rest_method::  GET /v1/
+
+Show all the resources within the Watcher v1 API.
+
+Normal response codes: 200
+
+Request
+-------
+
+Response Example
+----------------
+
+.. rest_parameters::  parameters.yaml
+
+    - id: version_id
+    - links: links
+    - OpenStack-API-Version: header_version
+    - OpenStack-API-Minimum-Version: openstack-api-min-version
+    - OpenStack-API-Maximum-Version: openstack-api-max-version
+
+.. literalinclude:: samples/api-v1-root-response.json
+   :language: javascript

devstack/lib/watcher

@@ -47,9 +47,6 @@ WATCHER_POLICY_YAML=$WATCHER_CONF_DIR/policy.yaml.sample
 WATCHER_DEVSTACK_DIR=$WATCHER_DIR/devstack
 WATCHER_DEVSTACK_FILES_DIR=$WATCHER_DEVSTACK_DIR/files
 
-NOVA_CONF_DIR=/etc/nova
-NOVA_CONF=$NOVA_CONF_DIR/nova.conf
-
 if is_ssl_enabled_service "watcher" || is_service_enabled tls-proxy; then
     WATCHER_SERVICE_PROTOCOL="https"
 fi
@@ -151,12 +148,17 @@ function create_watcher_accounts {
 function _config_watcher_apache_wsgi {
     local watcher_apache_conf
     if [[ "$WATCHER_USE_MOD_WSGI" == "True" ]]; then
+        local service_port=$WATCHER_SERVICE_PORT
+        if is_service_enabled tls-proxy; then
+            service_port=$WATCHER_SERVICE_PORT_INT
+            service_protocol="http"
+        fi
         sudo mkdir -p $WATCHER_WSGI_DIR
         sudo cp $WATCHER_DIR/watcher/api/app.wsgi $WATCHER_WSGI_DIR/app.wsgi
         watcher_apache_conf=$(apache_site_config_for watcher-api)
         sudo cp $WATCHER_DEVSTACK_FILES_DIR/apache-watcher-api.template $watcher_apache_conf
         sudo sed -e "
-            s|%WATCHER_SERVICE_PORT%|$WATCHER_SERVICE_PORT|g;
+            s|%WATCHER_SERVICE_PORT%|$service_port|g;
             s|%WATCHER_WSGI_DIR%|$WATCHER_WSGI_DIR|g;
             s|%USER%|$STACK_USER|g;
             s|%APIWORKERS%|$API_WORKERS|g;
@@ -193,9 +195,6 @@ function create_watcher_conf {
 
     iniset $WATCHER_CONF oslo_messaging_notifications driver "messagingv2"
 
-    iniset $NOVA_CONF oslo_messaging_notifications topics "notifications,watcher_notifications"
-    iniset $NOVA_CONF notifications notify_on_state_change "vm_and_task_state"
-
     configure_auth_token_middleware $WATCHER_CONF watcher $WATCHER_AUTH_CACHE_DIR
     configure_auth_token_middleware $WATCHER_CONF watcher $WATCHER_AUTH_CACHE_DIR "watcher_clients_auth"
 
@@ -290,19 +289,22 @@ function start_watcher_api {
         service_protocol="http"
     fi
     if [[ "$WATCHER_USE_MOD_WSGI" == "True" ]]; then
+        enable_apache_site watcher-api
         restart_apache_server
     else
         run_process watcher-api "$WATCHER_BIN_DIR/watcher-api --config-file $WATCHER_CONF"
     fi
-    echo "Waiting for watcher-api to start..."
-    if ! wait_for_service $SERVICE_TIMEOUT $service_protocol://$WATCHER_SERVICE_HOST:$service_port; then
-        die $LINENO "watcher-api did not start"
-    fi
 
     # Start proxies if enabled
     if is_service_enabled tls-proxy; then
         start_tls_proxy watcher '*' $WATCHER_SERVICE_PORT $WATCHER_SERVICE_HOST $WATCHER_SERVICE_PORT_INT
     fi
+
+    echo "Waiting for watcher-api to start..."
+    if ! wait_for_service $SERVICE_TIMEOUT $service_protocol://$WATCHER_SERVICE_HOST:$service_port; then
+        die $LINENO "watcher-api did not start"
+    fi
+
 }
 
 # start_watcher() - Start running processes, including screen
@@ -317,6 +319,7 @@ function start_watcher {
 function stop_watcher {
     if [[ "$WATCHER_USE_MOD_WSGI" == "True" ]]; then
         disable_apache_site watcher-api
+        restart_apache_server
     else
         stop_process watcher-api
     fi

devstack/local.conf.compute

@@ -44,6 +44,3 @@ LOGDAYS=2
 [[post-config|$NOVA_CONF]]
 [DEFAULT]
 compute_monitors=cpu.virt_driver
-notify_on_state_change = vm_and_task_state
-[notifications]
-notify_on_state_change = vm_and_task_state

devstack/local.conf.controller

@@ -48,6 +48,3 @@ LOGDAYS=2
 [[post-config|$NOVA_CONF]]
 [DEFAULT]
 compute_monitors=cpu.virt_driver
-notify_on_state_change = vm_and_task_state
-[notifications]
-notify_on_state_change = vm_and_task_state

devstack/upgrade/from_rocky/upgrade-watcher

@@ -0,0 +1,15 @@
+#!/usr/bin/env bash
+
+# ``upgrade-watcher``
+
+function configure_watcher_upgrade {
+    XTRACE=$(set +o | grep xtrace)
+    set -o xtrace
+
+    # Copy release-specific files
+    sudo cp $TARGET_RELEASE_DIR/watcher/etc/watcher/watcher.conf $WATCHER_CONF_DIR/watcher.conf
+    sudo cp $TARGET_RELEASE_DIR/watcher/etc/watcher/policy.yaml.sample $WATCHER_CONF_DIR/policy.yaml.sample
+
+    # reset to previous state
+    $XTRACE
+}

devstack/upgrade/resources.sh

@@ -0,0 +1,126 @@
+#!/bin/bash
+
+set -o errexit
+
+source $GRENADE_DIR/grenaderc
+source $GRENADE_DIR/functions
+
+source $TOP_DIR/openrc admin demo
+
+set -o xtrace
+
+function _wait_for_status {
+     while :
+     do
+         state=$("${@:2}" -f value -c State)
+         [[ $state == "SUCCEEDED" ]] && break
+         if [ $state == "ERROR" ]; then
+             die $LINENO "ERROR creating audit"
+         fi
+         sleep 10
+     done
+ }
+
+function create_audit_template {
+    at_id=$(openstack optimize audittemplate create d1 dummy -s dummy -f value -c UUID)
+    resource_save watcher at_id $at_id
+ }
+
+function create_audit {
+    audit_id=$(openstack optimize audit create -s dummy -g dummy -f value -c UUID)
+    resource_save watcher audit_id $audit_id
+}
+
+function create_audit_with_autotrigger {
+    audit_at_id=$(openstack optimize audit create -s dummy -g dummy -f value -c UUID --auto-trigger)
+    resource_save watcher audit_at_id $audit_at_id
+}
+
+function verify_audit_template {
+    local at_id=$(resource_get watcher at_id)
+    openstack optimize audittemplate show $at_id
+}
+
+function verify_audit_with_autotrigger {
+    local audit_at_id=$(resource_get watcher audit_at_id)
+    _wait_for_status "SUCCEEDED" openstack optimize audit show $audit_at_id
+    local actionplan_at_id=$(openstack optimize actionplan list --audit $audit_at_id -c UUID -f value)
+    resource_save watcher actionplan_at $actionplan_at_id
+    actionplan_at_state=$(openstack optimize actionplan show $actionplan_at_id -c State -f value)
+    if [ $actionplan_at_state != "SUCCEEDED" ]; then
+        die $LINENO "ERROR executing actionplan"
+    fi
+}
+
+function verify_audit {
+    local audit_id=$(resource_get watcher audit_id)
+    _wait_for_status "SUCCEEDED" openstack optimize audit show $audit_id
+    local actionplan_id=$(openstack optimize actionplan list --audit $audit_id -c UUID -f value)
+    resource_save watcher actionplan $actionplan_id
+    actionplan_state=$(openstack optimize actionplan show $actionplan_id -c State -f value)
+    if [ $actionplan_state != "RECOMMENDED" ]; then
+        die $LINENO "ERROR creating actionplan"
+    fi
+}
+
+function verify_noapi {
+    # currently no good way
+    :
+}
+
+function delete_audit {
+  local audit_id=$(resource_get watcher audit_id)
+  local actionplan_id=$(resource_get watcher actionplan)
+  watcher actionplan delete $actionplan_id
+  openstack optimize audit delete $audit_id
+}
+
+function delete_audit_with_autotrigger {
+  local audit_at_id=$(resource_get watcher audit_at_id)
+  local actionplan_id=$(resource_get watcher actionplan_at)
+  watcher actionplan delete $actionplan_id
+  openstack optimize audit delete $audit_at_id
+}
+
+function delete_audit_template {
+  local at_id=$(resource_get watcher at_id)
+  openstack optimize audittemplate delete $at_id
+}
+
+function create {
+  create_audit_template
+  create_audit
+  create_audit_with_autotrigger
+}
+
+function verify {
+  verify_audit_template
+  verify_audit
+  verify_audit_with_autotrigger
+}
+
+function destroy {
+  delete_audit_template
+  delete_audit
+  delete_audit_with_autotrigger
+}
+
+# Dispatcher
+case $1 in
+    "create")
+        create
+        ;;
+    "verify_noapi")
+        verify_noapi
+        ;;
+    "verify")
+        verify
+        ;;
+    "destroy")
+        destroy
+        ;;
+    "force_destroy")
+        set +o errexit
+        destroy
+        ;;
+esac

devstack/upgrade/settings

@@ -0,0 +1,11 @@
+register_project_for_upgrade watcher
+register_db_to_save watcher
+
+devstack_localrc base enable_plugin watcher https://git.openstack.org/openstack/watcher stable/rocky
+devstack_localrc target enable_plugin watcher https://git.openstack.org/openstack/watcher
+
+devstack_localrc base enable_service watcher-api watcher-decision-engine watcher-applier
+devstack_localrc target enable_service watcher-api watcher-decision-engine watcher-applier
+
+BASE_RUN_SMOKE=False
+TARGET_RUN_SMOKE=False

devstack/upgrade/shutdown.sh

@@ -0,0 +1,24 @@
+#!/bin/bash
+
+set -o errexit
+
+source $GRENADE_DIR/grenaderc
+source $GRENADE_DIR/functions
+
+# We need base DevStack functions for this
+source $BASE_DEVSTACK_DIR/functions
+source $BASE_DEVSTACK_DIR/stackrc # needed for status directory
+source $BASE_DEVSTACK_DIR/lib/tls
+source $BASE_DEVSTACK_DIR/lib/apache
+
+WATCHER_DEVSTACK_DIR=$(dirname $(dirname $0))
+source $WATCHER_DEVSTACK_DIR/settings
+source $WATCHER_DEVSTACK_DIR/plugin.sh
+source $WATCHER_DEVSTACK_DIR/lib/watcher
+
+set -o xtrace
+
+stop_watcher
+
+# sanity check that service is actually down
+ensure_services_stopped watcher-api watcher-decision-engine watcher-applier

devstack/upgrade/upgrade.sh

@@ -0,0 +1,70 @@
+#!/usr/bin/env bash
+
+# ``upgrade-watcher``
+
+echo "*********************************************************************"
+echo "Begin $0"
+echo "*********************************************************************"
+
+# Clean up any resources that may be in use
+cleanup() {
+    set +o errexit
+
+    echo "********************************************************************"
+    echo "ERROR: Abort $0"
+    echo "********************************************************************"
+
+    # Kill ourselves to signal any calling process
+    trap 2; kill -2 $$
+}
+
+trap cleanup SIGHUP SIGINT SIGTERM
+
+# Keep track of the grenade directory
+RUN_DIR=$(cd $(dirname "$0") && pwd)
+
+# Source params
+source $GRENADE_DIR/grenaderc
+
+# Import common functions
+source $GRENADE_DIR/functions
+
+# This script exits on an error so that errors don't compound and you see
+# only the first error that occurred.
+set -o errexit
+
+# Upgrade watcher
+# ============
+
+# Get functions from current DevStack
+source $TARGET_DEVSTACK_DIR/stackrc
+source $TARGET_DEVSTACK_DIR/lib/apache
+source $TARGET_DEVSTACK_DIR/lib/tls
+source $(dirname $(dirname $BASH_SOURCE))/settings
+source $(dirname $(dirname $BASH_SOURCE))/plugin.sh
+
+# Print the commands being run so that we can see the command that triggers
+# an error.  It is also useful for following allowing as the install occurs.
+set -o xtrace
+
+# Save current config files for posterity
+[[ -d $SAVE_DIR/etc.watcher ]] || cp -pr $WATCHER_CONF_DIR $SAVE_DIR/etc.watcher
+
+# Install the target watcher
+install_watcher
+
+# calls upgrade-watcher for specific release
+upgrade_project watcher $RUN_DIR $BASE_DEVSTACK_BRANCH $TARGET_DEVSTACK_BRANCH
+
+# Migrate the database
+watcher-db-manage upgrade || die $LINO "DB migration error"
+
+start_watcher
+
+# Don't succeed unless the services come up
+ensure_services_started watcher-api watcher-decision-engine watcher-applier
+
+set +o xtrace
+echo "*********************************************************************"
+echo "SUCCESS: End $0"
+echo "*********************************************************************"

doc/requirements.txt

@@ -0,0 +1,9 @@
+# The order of packages is significant, because pip processes them in the order
+# of appearance. Changing the order has an impact on the overall integration
+# process, which may cause wedges in the gate later.
+openstackdocstheme>=1.20.0 # Apache-2.0
+sphinx>=1.6.5,!=1.6.6,!=1.6.7 # BSD
+sphinxcontrib-pecanwsme>=0.8.0 # Apache-2.0
+reno>=2.7.0 # Apache-2.0
+sphinxcontrib-apidoc>=0.2.0  # BSD
+os-api-ref>=1.4.0 # Apache-2.0

doc/source/admin/apache-mod-wsgi.rst

@@ -44,6 +44,6 @@ Installing API behind mod_wsgi
     Fedora/RHEL7/CentOS7:
       sudo systemctl reload httpd
 
-   Debian/Ubuntu:
-    sudo a2ensite watcher
-    sudo service apache2 reload
+    Debian/Ubuntu:
+      sudo a2ensite watcher
+      sudo service apache2 reload

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/api/index.rst

@@ -1,8 +0,0 @@
-==================================================
-OpenStack Infrastructure Optimization Service APIs
-==================================================
-
-.. toctree::
-   :maxdepth: 1
-
-   v1

doc/source/api/v1.rst

@@ -1,100 +0,0 @@
-..
-      Except where otherwise noted, this document is licensed under Creative
-      Commons Attribution 3.0 License.  You can view the license at:
-
-          https://creativecommons.org/licenses/by/3.0/
-
-====================
-RESTful Web API (v1)
-====================
-
-Goals
-=====
-
-.. rest-controller:: watcher.api.controllers.v1.goal:GoalsController
-   :webprefix: /v1/goal
-
-.. autotype:: watcher.api.controllers.v1.goal.GoalCollection
-   :members:
-
-.. autotype:: watcher.api.controllers.v1.goal.Goal
-   :members:
-
-Strategies
-==========
-
-.. rest-controller:: watcher.api.controllers.v1.strategy:StrategiesController
-   :webprefix: /v1/strategies
-
-.. autotype:: watcher.api.controllers.v1.strategy.StrategyCollection
-   :members:
-
-.. autotype:: watcher.api.controllers.v1.strategy.Strategy
-   :members:
-
-Audit Templates
-===============
-
-.. rest-controller:: watcher.api.controllers.v1.audit_template:AuditTemplatesController
-   :webprefix: /v1/audit_templates
-
-.. autotype:: watcher.api.controllers.v1.audit_template.AuditTemplateCollection
-   :members:
-
-.. autotype:: watcher.api.controllers.v1.audit_template.AuditTemplate
-   :members:
-
-Audits
-======
-
-.. rest-controller:: watcher.api.controllers.v1.audit:AuditsController
-   :webprefix: /v1/audits
-
-.. autotype:: watcher.api.controllers.v1.audit.AuditCollection
-   :members:
-
-.. autotype:: watcher.api.controllers.v1.audit.Audit
-   :members:
-
-Links
-=====
-
-.. autotype:: watcher.api.controllers.link.Link
-   :members:
-
-Action Plans
-============
-
-.. rest-controller:: watcher.api.controllers.v1.action_plan:ActionPlansController
-   :webprefix: /v1/action_plans
-
-.. autotype:: watcher.api.controllers.v1.action_plan.ActionPlanCollection
-   :members:
-
-.. autotype:: watcher.api.controllers.v1.action_plan.ActionPlan
-   :members:
-
-
-Actions
-=======
-
-.. rest-controller:: watcher.api.controllers.v1.action:ActionsController
-   :webprefix: /v1/actions
-
-.. autotype:: watcher.api.controllers.v1.action.ActionCollection
-   :members:
-
-.. autotype:: watcher.api.controllers.v1.action.Action
-   :members:
-
-Scoring Engine
-==============
-
-.. rest-controller:: watcher.api.controllers.v1.scoring_engine:ScoringEngineController
-   :webprefix: /v1/scoring_engine
-
-.. autotype:: watcher.api.controllers.v1.scoring_engine.ScoringEngineCollection
-   :members:
-
-.. autotype:: watcher.api.controllers.v1.scoring_engine.ScoringEngine
-   :members:

doc/source/architecture.rst

@@ -76,6 +76,7 @@ Watcher Applier
 This component is in charge of executing the
 :ref:`Action Plan <action_plan_definition>` built by the
 :ref:`Watcher Decision Engine <watcher_decision_engine_definition>`.
+Taskflow is the default workflow engine for Watcher.
 
 It connects to the :ref:`message bus <amqp_bus_definition>` and launches the
 :ref:`Action Plan <action_plan_definition>` whenever a triggering message is
@@ -110,6 +111,23 @@ If the :ref:`Action <action_definition>` fails, the
 previous state of the :ref:`Managed resource <managed_resource_definition>`
 (i.e. before the command was sent to the underlying OpenStack service).
 
+In Stein, added a new config option 'action_execution_rule' which is a
+dict type. Its key field is strategy name and the value is 'ALWAYS' or 'ANY'.
+'ALWAYS' means the callback function returns True as usual.
+'ANY' means the return depends on the result of previous action execution.
+The callback returns True if previous action gets failed, and the engine
+continues to run the next action. If previous action executes success,
+the callback returns False then the next action will be ignored.
+For strategies that aren't in 'action_execution_rule', the callback always
+returns True.
+Please add the next section in the watcher.conf file
+if your strategy needs this feature.
+
+::
+
+    [watcher_workflow_engines.taskflow]
+    action_execution_rule = {'your strategy name': 'ANY'}
+
 .. _archi_watcher_cli_definition:
 
 Watcher CLI
@@ -461,4 +479,4 @@ change to a new value:
 
 
 
-.. _Watcher API: webapi/v1.html
+.. _Watcher API: https://developer.openstack.org/api-ref/resource-optimization/

doc/source/conf.py

@@ -32,7 +32,7 @@ sys.path.insert(0, os.path.abspath('./'))
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
 extensions = [
     'oslo_config.sphinxext',
-    'sphinx.ext.autodoc',
+    'sphinxcontrib.apidoc',
     'sphinx.ext.viewcode',
     'sphinxcontrib.httpdomain',
     'sphinxcontrib.pecanwsme.rest',
@@ -55,6 +55,18 @@ sample_config_basename = 'watcher'
 # text edit cycles.
 # execute "export SPHINX_DEBUG=1" in your terminal to disable
 
+# sphinxcontrib.apidoc options
+apidoc_module_dir = '../../watcher'
+apidoc_output_dir = 'api'
+apidoc_excluded_paths = [
+    'tests/*',
+    'db',
+    'decision_engine',
+    'doc',
+    'objects',
+]
+apidoc_separate_modules = True
+
 # The suffix of source filenames.
 source_suffix = '.rst'
 

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:
 
@@ -146,7 +159,7 @@ MySQL database that is used by other OpenStack services.
    ``watcher`` user. Replace WATCHER_DBPASSWORD
    with the actual password::
 
-    $ mysql -u root -p
+    # mysql
 
     mysql> CREATE DATABASE watcher CHARACTER SET utf8;
     mysql> GRANT ALL PRIVILEGES ON watcher.* TO 'watcher'@'localhost' \
@@ -226,10 +239,6 @@ so that the watcher service is configured for your needs.
 
     [DEFAULT]
 
-    # The messaging driver to use, defaults to rabbit. Other drivers
-    # include qpid and zmq. (string value)
-    #rpc_backend = rabbit
-
     # The default exchange under which topics are scoped. May be
     # overridden by an exchange name specified in the transport_url
     # option. (string value)
@@ -260,7 +269,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
@@ -306,7 +315,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
@@ -336,7 +345,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::
@@ -394,26 +403,22 @@ Watcher can consume notifications generated by the Nova services, in order to
 build or update, in real time, its cluster data model related to computing
 resources.
 
-Nova publishes, by default, notifications on ``notifications`` AMQP queue
-(configurable) and ``versioned_notifications`` AMQP queue (not
-configurable). ``notifications`` queue is mainly used by ceilometer, so we can
-not use it. And some events, related to nova-compute service state, are only
-sent into the ``versioned_notifications`` queue.
+Nova emits unversioned(legacy) and versioned notifications on different
+topics. Because legacy notifications will be deprecated, Watcher consumes
+Nova versioned notifications.
 
-By default, Watcher listens to AMQP queues named ``watcher_notifications``
-and ``versioned_notifications``. So you have to update the Nova
-configuration file on controller and compute nodes, in order
-to Watcher receives Nova notifications in ``watcher_notifications`` as well.
-
-  * In the file ``/etc/nova/nova.conf``, update the section
-    ``[oslo_messaging_notifications]``, by redefining the list of topics
-    into which Nova services will publish events ::
+  * In the file ``/etc/nova/nova.conf``, the value of driver in the section
+    ``[oslo_messaging_notifications]`` can't be noop, and the value of
+    notification_format in the section ``[notifications]``
+    should be both or versioned ::
 
       [oslo_messaging_notifications]
       driver = messagingv2
-      topics = notifications,watcher_notifications
 
-  * Restart the Nova services.
+      ...
+
+      [notifications]
+      notification_format = both
 
 
 Configure Cinder Notifications

doc/source/contributor/api_microversion_history.rst

@@ -0,0 +1 @@
+.. include:: ../../../watcher/api/controllers/rest_api_version_history.rst

doc/source/contributor/contributing.rst

@@ -49,7 +49,7 @@ Bug tracker
     https://launchpad.net/watcher
 
 Mailing list (prefix subjects with ``[watcher]`` for faster responses)
-    http://lists.openstack.org/pipermail/openstack-dev/
+    http://lists.openstack.org/pipermail/openstack-discuss/
 
 Wiki
     https://wiki.openstack.org/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
@@ -126,7 +126,7 @@ You can re-activate this virtualenv for your current shell using:
 For more information on virtual environments, see virtualenv_ and
 virtualenvwrapper_.
 
-.. _virtualenv: https://pypi.python.org/pypi/virtualenv/
+.. _virtualenv: https://pypi.org/project/virtualenv/
 
 
 
@@ -193,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/strategy-plugin.rst

@@ -245,15 +245,16 @@ Querying metrics
 
 A large set of metrics, generated by OpenStack modules, can be used in your
 strategy implementation. To collect these metrics, Watcher provides a
-`Helper`_ for two data sources which are `Ceilometer`_ and `Monasca`_. If you
-wish to query metrics from a different data source, you can implement your own
-and directly use it from within your new strategy. Indeed, strategies in
-Watcher have the cluster data models decoupled from the data sources which
-means that you may keep the former while changing the latter.
-The recommended way for you to support a new data source is to implement a new
-helper that would encapsulate within separate methods the queries you need to
-perform. To then use it, you would just have to instantiate it within your
-strategy.
+`DataSourceManager`_ for two data sources which are `Ceilometer`_
+(with `Gnocchi`_ as API) and `Monasca`_. If you wish to query metrics from a
+different data source, you can implement your own and use it via
+DataSourceManager from within your new strategy. Indeed, strategies in Watcher
+have the cluster data models decoupled from the data sources which means that
+you may keep the former while changing the latter. The recommended way for you
+to support a new data source is to implement a new helper that would
+encapsulate within separate methods the queries you need to perform. To then
+use it, you would just have to add it to appropriate watcher_strategies.*
+section in config file.
 
 If you want to use Ceilometer but with your own metrics database backend,
 please refer to the `Ceilometer developer guide`_. The list of the available
@@ -263,52 +264,38 @@ requires new metrics not covered by Ceilometer, you can add them through a
 `Ceilometer plugin`_.
 
 
-.. _`Helper`: https://github.com/openstack/watcher/blob/master/watcher/datasource/ceilometer.py
+.. _`DataSourceManager`: https://github.com/openstack/watcher/blob/master/watcher/datasource/manager.py
 .. _`Ceilometer developer guide`: https://docs.openstack.org/ceilometer/latest/contributor/architecture.html#storing-accessing-the-data
 .. _`Ceilometer`: https://docs.openstack.org/ceilometer/latest
 .. _`Monasca`: https://github.com/openstack/monasca-api/blob/master/docs/monasca-api-spec.md
 .. _`here`: https://docs.openstack.org/ceilometer/latest/contributor/install/dbreco.html#choosing-a-database-backend
 .. _`Ceilometer plugin`: https://docs.openstack.org/ceilometer/latest/contributor/plugins.html
 .. _`Ceilosca`: https://github.com/openstack/monasca-ceilometer/blob/master/ceilosca/ceilometer/storage/impl_monasca.py
+.. _`Gnocchi`: https://gnocchi.xyz/
 
 Read usage metrics using the Watcher Datasource Helper
 ------------------------------------------------------
 
-The following code snippet shows how to invoke a Datasource Helper class:
+The following code snippet shows how datasource_backend is defined:
 
 .. code-block:: py
 
-    from watcher.datasource import ceilometer as ceil
-    from watcher.datasource import monasca as mon
+    from watcher.datasource import manager as ds_manager
 
     @property
-    def ceilometer(self):
-        if self._ceilometer is None:
-            self._ceilometer = ceil.CeilometerHelper(osc=self.osc)
-        return self._ceilometer
-
-    @property
-    def monasca(self):
-        if self._monasca is None:
-            self._monasca = mon.MonascaHelper(osc=self.osc)
-        return self._monasca
+    def datasource_backend(self):
+        if not self._datasource_backend:
+            self._datasource_backend = ds_manager.DataSourceManager(
+                config=self.config,
+                osc=self.osc
+            ).get_backend(self.DATASOURCE_METRICS)
+        return self._datasource_backend
 
 Using that you can now query the values for that specific metric:
 
 .. code-block:: py
 
-        if self.config.datasource == "ceilometer":
-            resource_id = "%s_%s" % (node.uuid, node.hostname)
-            return self.ceilometer.statistic_aggregation(
-                resource_id=resource_id,
-                meter_name='compute.node.cpu.percent',
-                period="7200",
-                aggregate='avg',
-            )
-        elif self.config.datasource == "monasca":
-            statistics = self.monasca.statistic_aggregation(
-                meter_name='compute.node.cpu.percent',
-                dimensions=dict(hostname=node.uuid),
-                period=7200,
-                aggregate='avg'
-            )
+    avg_meter = self.datasource_backend.statistic_aggregation(
+        instance.uuid, 'cpu_util', self.periods['instance'],
+        self.granularity,
+        aggregation=self.aggregation_method['instance'])

doc/source/contributor/testing.rst

@@ -13,39 +13,32 @@ Testing
 Unit tests
 ==========
 
-All unit tests should be run using `tox`_. To run the same unit tests that are
-executing onto `Gerrit`_ which includes ``py35``, ``py27`` and ``pep8``, you
-can issue the following command::
+All unit tests should be run using `tox`_. Before running the unit tests, you
+should download the latest `watcher`_ from the github. To run the same unit
+tests that are executing onto `Gerrit`_ which includes ``py35``, ``py27`` and
+``pep8``, you can issue the following command::
 
-    $ workon watcher
-    (watcher) $ pip install tox
-    (watcher) $ cd watcher
-    (watcher) $ tox
+    $ git clone https://git.openstack.org/openstack/watcher
+    $ cd watcher
+    $ pip install tox
+    $ tox
 
-If you want to only run one of the aforementioned, you can then issue one of
+If you only want to run one of the aforementioned, you can then issue one of
 the following::
 
-    $ workon watcher
-    (watcher) $ tox -e py35
-    (watcher) $ tox -e py27
-    (watcher) $ tox -e pep8
+    $ tox -e py35
+    $ tox -e py27
+    $ tox -e pep8
 
 .. _tox: https://tox.readthedocs.org/
+.. _watcher: https://git.openstack.org/cgit/openstack/watcher
 .. _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
-the ``--`` separator. So using the ``-r`` option followed by a regex string,
-you can run the desired test::
+If you only want to run specific unit test code and don't like to waste time
+waiting for all unit tests to execute, you can add parameters ``--`` followed
+by a regex string::
 
-    $ workon watcher
-    (watcher) $ tox -e py27 -- -r watcher.tests.api
-
-.. _os-testr: https://docs.openstack.org/os-testr/latest
-
-When you're done, deactivate the virtualenv::
-
-    $ deactivate
+    $ tox -e py27 -- watcher.tests.api
 
 .. _tempest_tests:
 
@@ -55,4 +48,4 @@ Tempest tests
 Tempest tests for Watcher has been migrated to the external repo
 `watcher-tempest-plugin`_.
 
-.. _watcher-tempest-plugin: https://github.com/openstack/watcher-tempest-plugin
+.. _watcher-tempest-plugin: https://git.openstack.org/cgit/openstack/watcher-tempest-plugin

doc/source/image_src/plantuml/audit_state_machine.txt

@@ -2,7 +2,7 @@
 
 [*] --> PENDING: Audit requested by Administrator
 PENDING --> ONGOING: Audit request is received\nby the Watcher Decision Engine
-ONGOING --> FAILED: Audit fails\n(no solution found, technical error, ...)
+ONGOING --> FAILED: Audit fails\n(Exception occurred)
 ONGOING --> SUCCEEDED: The Watcher Decision Engine\ncould find at least one Solution
 ONGOING --> SUSPENDED: Administrator wants to\nsuspend the Audit
 SUSPENDED --> ONGOING: Administrator wants to\nresume the Audit

doc/source/index.rst

@@ -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,31 @@ User Guide
 
   user/index
 
+API References
+==============
+
+.. toctree::
+  :maxdepth: 1
+
+  API Reference <https://developer.openstack.org/api-ref/resource-optimization/>
+  Watcher API Microversion History </contributor/api_microversion_history>
+
+Plugins
+-------
+
+.. toctree::
+  :maxdepth: 1
+
+  contributor/plugin/index
+
+Watcher Configuration Options
+=============================
+
+.. toctree::
+  :maxdepth: 2
+
+  configuration/index
+
 Watcher Manual Pages
 ====================
 
@@ -117,7 +118,7 @@ Watcher Manual Pages
 .. toctree::
    :hidden:
 
-   api/autoindex
+   api/modules
 
 
 Indices and tables

doc/source/install/common_configure.rst

@@ -27,7 +27,7 @@
         [keystone_authtoken]
         ...
         www_authenticate_uri = http://controller:5000
-        auth_url = http://controller:35357
+        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/common_prerequisites.rst

@@ -11,7 +11,7 @@ you must create a database, service credentials, and API endpoints.
 
      .. code-block:: console
 
-        $ mysql -u root -p
+        # mysql
 
    * Create the ``watcher`` database:
 

doc/source/install/install-ubuntu.rst

@@ -4,7 +4,7 @@ Install and configure for Ubuntu
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 This section describes how to install and configure the Infrastructure
-Optimization service for Ubuntu 14.04 (LTS).
+Optimization service for Ubuntu 16.04 (LTS).
 
 .. include:: common_prerequisites.rst
 
@@ -25,10 +25,15 @@ Install and configure components
 Finalize installation
 ---------------------
 
-Restart the Infrastructure Optimization services:
+Start the Infrastructure Optimization services and configure them to start when
+the system boots:
 
 .. code-block:: console
 
-   # service watcher-api restart
-   # service watcher-decision-engine restart
-   # service watcher-applier restart
+   # systemctl enable watcher-api.service \
+     watcher-decision-engine.service \
+     watcher-applier.service
+
+   # systemctl start watcher-api.service \
+     watcher-decision-engine.service \
+     watcher-applier.service

doc/source/man/index.rst

@@ -5,4 +5,5 @@
    watcher-api
    watcher-applier
    watcher-db-manage
-   watcher-decision-engine
+   watcher-decision-engine
+   watcher-status

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-status.rst

@@ -0,0 +1,83 @@
+==============
+watcher-status
+==============
+
+-----------------------------------------
+CLI interface for Watcher status commands
+-----------------------------------------
+
+Synopsis
+========
+
+::
+
+  watcher-status <category> <command> [<args>]
+
+Description
+===========
+
+:program:`watcher-status` is a tool that provides routines for checking the
+status of a Watcher deployment.
+
+Options
+=======
+
+The standard pattern for executing a :program:`watcher-status` command is::
+
+    watcher-status <category> <command> [<args>]
+
+Run without arguments to see a list of available command categories::
+
+    watcher-status
+
+Categories are:
+
+* ``upgrade``
+
+Detailed descriptions are below:
+
+You can also run with a category argument such as ``upgrade`` to see a list of
+all commands in that category::
+
+    watcher-status upgrade
+
+These sections describe the available categories and arguments for
+:program:`Watcher-status`.
+
+Upgrade
+~~~~~~~
+
+.. _watcher-status-checks:
+
+``watcher-status upgrade check``
+  Performs a release-specific readiness check before restarting services with
+  new code. For example, missing or changed configuration options,
+  incompatible object states, or other conditions that could lead to
+  failures while upgrading.
+
+  **Return Codes**
+
+  .. list-table::
+     :widths: 20 80
+     :header-rows: 1
+
+     * - Return code
+       - Description
+     * - 0
+       - All upgrade readiness checks passed successfully and there is nothing
+         to do.
+     * - 1
+       - At least one check encountered an issue and requires further
+         investigation. This is considered a warning but the upgrade may be OK.
+     * - 2
+       - There was an upgrade status check failure that needs to be
+         investigated. This should be considered something that stops an
+         upgrade.
+     * - 255
+       - An unexpected error occurred.
+
+  **History of Checks**
+
+  **1.12.0 (Stein)**
+
+  * Sample check to be filled in with checks as they are added in Stein.

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/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/vm_workload_consolidation.rst

@@ -22,20 +22,12 @@ The *vm_workload_consolidation* strategy requires the following metrics:
 ============================ ============ ======= =======
 metric                       service name plugins comment
 ============================ ============ ======= =======
+``cpu_util``                 ceilometer_  none
+``memory.resident``          ceilometer_  none
 ``memory``                   ceilometer_  none
 ``disk.root.size``           ceilometer_  none
 ============================ ============ ======= =======
 
-The following metrics are not required but increase the accuracy of
-the strategy if available:
-
-============================ ============ ======= =======
-metric                       service name plugins comment
-============================ ============ ======= =======
-``memory.resident``          ceilometer_  none
-``cpu_util``                 ceilometer_  none
-============================ ============ ======= =======
-
 .. _ceilometer: https://docs.openstack.org/ceilometer/latest/admin/telemetry-measurements.html#openstack-compute
 
 Cluster data model

doc/source/user/user-guide.rst

@@ -182,7 +182,7 @@ periodically calling:
 
 .. code:: bash
 
-  $ openstack optimize action list
+  $ openstack optimize action list --action-plan <the_action_plan_uuid>
 
 You can also obtain more detailed information about a specific action:
 

lower-constraints.txt

@@ -25,6 +25,7 @@ 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
@@ -56,6 +57,7 @@ lxml==4.1.1
 Mako==1.0.7
 MarkupSafe==1.0
 mccabe==0.2.1
+microversion_parse==0.2.1
 mock==2.0.0
 monotonic==1.4
 mox3==0.25.0
@@ -66,6 +68,7 @@ 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
@@ -83,6 +86,7 @@ oslo.policy==1.34.0
 oslo.reports==1.27.0
 oslo.serialization==2.25.0
 oslo.service==1.30.0
+oslo.upgradecheck==0.1.0
 oslo.utils==3.36.0
 oslo.versionedobjects==1.32.0
 oslotest==3.3.0
@@ -112,7 +116,7 @@ python-glanceclient==2.9.1
 python-ironicclient==2.3.0
 python-keystoneclient==3.15.0
 python-mimeparse==1.6.0
-python-monascaclient==1.10.0
+python-monascaclient==1.12.0
 python-neutronclient==6.7.0
 python-novaclient==10.1.0
 python-openstackclient==3.14.0
@@ -144,7 +148,6 @@ stevedore==1.28.0
 taskflow==3.1.0
 Tempita==0.5.2
 tenacity==4.9.0
-testrepository==0.0.20
 testresources==2.0.1
 testscenarios==0.5.0
 testtools==2.3.0
@@ -154,7 +157,6 @@ ujson==1.35
 unittest2==1.1.0
 urllib3==1.22
 vine==1.1.4
-voluptuous==0.11.1
 waitress==1.1.0
 warlock==1.3.0
 WebOb==1.7.4

playbooks/legacy/grenade-devstack-watcher/post.yaml

@@ -0,0 +1,15 @@
+- 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/grenade-devstack-watcher/run.yaml

@@ -0,0 +1,60 @@
+- hosts: all
+  name: legacy-grenade-dsvm-watcher
+  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
+          export PYTHONUNBUFFERED=true
+
+          export PROJECTS="openstack-dev/grenade $PROJECTS"
+          export PROJECTS="openstack/watcher $PROJECTS"
+          export PROJECTS="openstack/watcher-tempest-plugin $PROJECTS"
+          export PROJECTS="openstack/python-watcherclient $PROJECTS"
+          export DEVSTACK_PROJECT_FROM_GIT="python-watcherclient $DEVSTACK_PROJECT_FROM_GIT"
+
+          export GRENADE_PLUGINRC="enable_grenade_plugin watcher https://git.openstack.org/openstack/watcher"
+          export DEVSTACK_LOCAL_CONFIG+=$'\n'"export TEMPEST_PLUGINS='/opt/stack/new/watcher-tempest-plugin'"
+
+          export DEVSTACK_GATE_TEMPEST_NOTESTS=1
+          export DEVSTACK_GATE_GRENADE=pullup
+
+          export BRANCH_OVERRIDE=default
+          if [ "$BRANCH_OVERRIDE" != "default" ] ; then
+              export OVERRIDE_ZUUL_BRANCH=$BRANCH_OVERRIDE
+          fi
+          # Add configuration values for enabling security features in local.conf
+          function pre_test_hook {
+              if [ -f /opt/stack/old/watcher-tempest-plugin/tools/pre_test_hook.sh ] ; then
+                  . /opt/stack/old/watcher-tempest-plugin/tools/pre_test_hook.sh
+              fi
+          }
+          export -f pre_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

@@ -1,14 +0,0 @@
-- 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

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

releasenotes/notes/add-baremetal-scoper-9ef23f5fb8f0be6a.yaml

@@ -0,0 +1,3 @@
+---
+features:
+  - Baremetal Model gets Audit scoper with an ability to exclude Ironic nodes.