Replace openstack.org git:// URLs with https://

This is a mechanically generated change to replace openstack.org
git:// URLs with https:// equivalents.

This is in aid of a planned future move of the git hosting
infrastructure to a self-hosted instance of gitea (https://gitea.io),
which does not support the git wire protocol at this stage.

This update should result in no functional change.

For more information see the thread at

 http://lists.openstack.org/pipermail/openstack-discuss/2019-March/003825.html

Change-Id: I5ffcaf509ec6901f7e221a4312cc6b0577090440

.gitignore

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

.gitreview

@@ -1,4 +1,5 @@
 [gerrit]
-host=review.opendev.org
+host=review.openstack.org
 port=29418
 project=openstack/watcher.git
+defaultbranch=stable/pike

.stestr.conf

@@ -1,4 +0,0 @@
-[DEFAULT]
-test_path=./watcher/tests
-top_dir=./
-

.testr.conf

@@ -0,0 +1,7 @@
+[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,207 +1,9 @@
 - project:
-    queue: watcher
     templates:
+      - openstack-python-jobs
+      - openstack-python35-jobs
+      - publish-openstack-sphinx-docs
       - check-requirements
-      - openstack-cover-jobs
-      - openstack-python3-zed-jobs
-      - publish-openstack-docs-pti
-      - release-notes-jobs-python3
-    check:
-      jobs:
-        - watcher-tempest-functional
-        - watcher-grenade
-        - watcher-tempest-strategies
-        - watcher-tempest-actuator
-        - watcherclient-tempest-functional
-        - watcher-tempest-functional-ipv6-only
+      - release-notes-jobs
     gate:
-      jobs:
-        - watcher-tempest-functional
-        - watcher-tempest-functional-ipv6-only
-
-- job:
-    name: watcher-tempest-dummy_optim
-    parent: watcher-tempest-multinode
-    vars:
-      tempest_test_regex: watcher_tempest_plugin.tests.scenario.test_execute_dummy_optim
-
-- job:
-    name: watcher-tempest-actuator
-    parent: watcher-tempest-multinode
-    vars:
-      tempest_test_regex: watcher_tempest_plugin.tests.scenario.test_execute_actuator
-
-- job:
-    name: watcher-tempest-basic_optim
-    parent: watcher-tempest-multinode
-    vars:
-      tempest_test_regex: watcher_tempest_plugin.tests.scenario.test_execute_basic_optim
-
-- job:
-    name: watcher-tempest-vm_workload_consolidation
-    parent: watcher-tempest-multinode
-    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
-    vars:
-      tempest_test_regex: watcher_tempest_plugin.tests.scenario.test_execute_workload_balancing
-
-- job:
-    name: watcher-tempest-zone_migration
-    parent: watcher-tempest-multinode
-    vars:
-      tempest_test_regex: watcher_tempest_plugin.tests.scenario.test_execute_zone_migration
-
-- job:
-    name: watcher-tempest-host_maintenance
-    parent: watcher-tempest-multinode
-    vars:
-      tempest_test_regex: watcher_tempest_plugin.tests.scenario.test_execute_host_maintenance
-
-- job:
-    name: watcher-tempest-storage_balance
-    parent: watcher-tempest-multinode
-    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-tempest-strategies
-    parent: watcher-tempest-multinode
-    vars:
-      tempest_concurrency: 1
-      tempest_test_regex: watcher_tempest_plugin.tests.scenario.test_execute_strategies
-
-- job:
-    name: watcher-tempest-multinode
-    parent: watcher-tempest-functional
-    nodeset: openstack-two-node-focal
-    roles:
-      - zuul: openstack/tempest
-    group-vars:
-      subnode:
-        devstack_local_conf:
-          post-config:
-            $WATCHER_CONF:
-              watcher_cluster_data_model_collectors.compute:
-                period: 120
-              watcher_cluster_data_model_collectors.baremetal:
-                period: 120
-              watcher_cluster_data_model_collectors.storage:
-                period: 120
-        devstack_services:
-          watcher-api: false
-          watcher-decision-engine: true
-          watcher-applier: false
-          ceilometer: false
-          ceilometer-acompute: false
-          ceilometer-acentral: false
-          ceilometer-anotification: false
-          watcher: false
-          gnocchi-api: false
-          gnocchi-metricd: false
-          rabbit: false
-          mysql: false
-    vars:
-      devstack_local_conf:
-        post-config:
-          $WATCHER_CONF:
-            watcher_cluster_data_model_collectors.compute:
-              period: 120
-            watcher_cluster_data_model_collectors.baremetal:
-              period: 120
-            watcher_cluster_data_model_collectors.storage:
-              period: 120
-        test-config:
-          $TEMPEST_CONFIG:
-            compute:
-              min_compute_nodes: 2
-              min_microversion: 2.56
-            compute-feature-enabled:
-              live_migration: true
-              block_migration_for_live_migration: true
-            placement:
-              min_microversion: 1.29
-      devstack_plugins:
-        ceilometer: https://opendev.org/openstack/ceilometer
-
-- job:
-    name: watcher-tempest-functional
-    parent: devstack-tempest
-    timeout: 7200
-    required-projects: &base_required_projects
-      - openstack/ceilometer
-      - openstack/python-openstackclient
-      - openstack/python-watcherclient
-      - openstack/watcher
-      - openstack/watcher-tempest-plugin
-      - openstack/tempest
-    vars: &base_vars
-      devstack_plugins:
-        watcher: https://opendev.org/openstack/watcher
-      devstack_services:
-        watcher-api: true
-        watcher-decision-engine: true
-        watcher-applier: true
-        tempest: true
-        s-account: false
-        s-container: false
-        s-object: false
-        s-proxy: false
-      tempest_plugins:
-        - watcher-tempest-plugin
-      tempest_test_regex: watcher_tempest_plugin.tests.api
-      tox_envlist: all
-      zuul_copy_output:
-        /etc/hosts: logs
-
-- job:
-    name: watcher-tempest-functional-ipv6-only
-    parent: devstack-tempest-ipv6
-    description: |
-      Watcher devstack tempest tests job for IPv6-only deployment
-    required-projects: *base_required_projects
-    vars: *base_vars
-
-- job:
-    name: watcher-grenade
-    parent: grenade
-    required-projects:
-      - openstack/watcher
-      - openstack/python-watcherclient
-      - openstack/watcher-tempest-plugin
-    vars: *base_vars
-    irrelevant-files:
-      - ^(test-|)requirements.txt$
-      - ^.*\.rst$
-      - ^api-ref/.*$
-      - ^doc/.*$
-      - ^watcher/hacking/.*$
-      - ^watcher/tests/.*$
-      - ^releasenotes/.*$
-      - ^setup.cfg$
-      - ^tools/.*$
-      - ^tox.ini$
-
-- job:
-    # This job is used in python-watcherclient repo
-    name: watcherclient-tempest-functional
-    parent: watcher-tempest-functional
-    timeout: 4200
-    vars:
-      tempest_concurrency: 1
-      tempest_test_regex: watcher_tempest_plugin.tests.client_functional
+      queue: watcher

HACKING.rst

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

README.rst

@@ -1,9 +1,9 @@
-=======
-Watcher
-=======
+========================
+Team and repository tags
+========================
 
-.. image:: https://governance.openstack.org/tc/badges/watcher.svg
-    :target: https://governance.openstack.org/tc/reference/tags/index.html
+.. image:: https://governance.openstack.org/badges/watcher.svg
+    :target: https://governance.openstack.org/reference/tags/index.html
 
 .. Change things from this point on
 
@@ -13,17 +13,19 @@ Watcher
 
           https://creativecommons.org/licenses/by/3.0/
 
+=======
+Watcher
+=======
+
 OpenStack Watcher provides a flexible and scalable resource optimization
 service for multi-tenant OpenStack-based clouds.
 Watcher provides a robust framework to realize a wide range of cloud
 optimization goals, including the reduction of data center
 operating costs, increased system performance via intelligent virtual machine
-migration, increased energy efficiency and more!
+migration, increased energy efficiency-and more!
 
 * Free software: Apache license
 * Wiki: https://wiki.openstack.org/wiki/Watcher
-* Source: https://opendev.org/openstack/watcher
+* Source:  https://github.com/openstack/watcher
 * Bugs: https://bugs.launchpad.net/watcher
 * Documentation: https://docs.openstack.org/watcher/latest/
-* Release notes: https://docs.openstack.org/releasenotes/watcher/
-* Design specifications: https://specs.openstack.org/openstack/watcher-specs/

api-ref/source/conf.py

@@ -1,75 +0,0 @@
-# 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.
-
-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
-openstackdocs_repo_name = 'openstack/watcher'
-openstackdocs_auto_name = False
-openstackdocs_bug_project = 'watcher'
-openstackdocs_bug_tag = ''
-
-# The name of the Pygments (syntax highlighting) style to use.
-pygments_style = 'native'
-
-# -- 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",
-}
-
-# -- 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

@@ -1,19 +0,0 @@
-: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
-.. include:: watcher-api-v1-datamodel.inc
-.. include:: watcher-api-v1-webhooks.inc

api-ref/source/parameters.yaml

@@ -1,655 +0,0 @@
-# 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
-r_type:
-  description: |
-    Type of data model user want to list. Default type is compute.
-    Supported values: compute.
-    Future support values: storage, baremetal.
-  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_force:
-  description: |
-    Launch audit even if action plan is ongoing.
-  in: body
-  required: false
-  type: boolean
-  min_version: 1.2
-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
-
-# Data Model Node
-node_disk:
-  description: |
-    The Disk of the node(in GiB).
-  in: body
-  required: true
-  type: integer
-node_disk_ratio:
-  description: |
-    The Disk Ratio of the node.
-  in: body
-  required: true
-  type: float
-node_hostname:
-  description: |
-    The Host Name of the node.
-  in: body
-  required: true
-  type: string
-node_memory:
-  description: |
-    The Memory of the node(in MiB).
-  in: body
-  required: true
-  type: integer
-node_memory_ratio:
-  description: |
-    The Memory Ratio of the node.
-  in: body
-  required: true
-  type: float
-node_state:
-  description: |
-    The State of the node. The value is up or down.
-  in: body
-  required: true
-  type: string
-node_uuid:
-  description: |
-    The Unique UUID of the node.
-  in: body
-  required: true
-  type: string
-node_vcpu_ratio:
-  description: |
-    The Vcpu ratio of the node.
-  in: body
-  required: true
-  type: float
-node_vcpus:
-  description: |
-    The Vcpu of the node.
-  in: body
-  required: true
-  type: integer
-
-# 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
-
-# Data Model Server
-server_disk:
-  description: |
-    The Disk of the server.
-  in: body
-  required: true
-  type: integer
-server_memory:
-  description: |
-    The Memory of server.
-  in: body
-  required: true
-  type: integer
-server_name:
-  description: |
-    The Name of the server.
-  in: body
-  required: true
-  type: string
-server_state:
-  description: |
-    The State of the server.
-  in: body
-  required: true
-  type: string
-server_uuid:
-  description: |
-    The Unique UUID of the server.
-  in: body
-  required: true
-  type: string
-server_vcpus:
-  description: |
-    The Vcpu of the server.
-  in: body
-  required: true
-  type: integer
-# Service
-service_host:
-  description: |
-    The Name of host where service is placed on.
-  in: body
-  required: true
-  type: string
-service_id:
-  description: |
-    The ID of service.
-  in: body
-  required: true
-  type: integer
-service_last_seen_up:
-  description: |
-    The Time when Watcher service sent latest heartbeat.
-  in: body
-  required: true
-  type: string
-service_name:
-  description: |
-    The Name of service like ``watcher-applier``.
-  in: body
-  required: true
-  type: string
-service_status:
-  description: |
-    The 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

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

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

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

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

@@ -1,27 +0,0 @@
-{
-    "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

@@ -1,24 +0,0 @@
-{
-    "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

@@ -1,21 +0,0 @@
-{
-    "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

@@ -1,23 +0,0 @@
-{
-    "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

@@ -1,30 +0,0 @@
-{
-    "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

@@ -1,23 +0,0 @@
-{
-    "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

@@ -1,26 +0,0 @@
-{
-    "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

@@ -1,30 +0,0 @@
-{
-  "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

@@ -1,80 +0,0 @@
-{
-  "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

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

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

@@ -1,55 +0,0 @@
-{
-    "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,
-    "force": 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

@@ -1,15 +0,0 @@
-{
-    "auto_trigger": false,
-    "force": 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

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

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

@@ -1,55 +0,0 @@
-{
-    "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,
-    "force": 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

@@ -1,59 +0,0 @@
-{
-    "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,
-	    "force": 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

@@ -1,28 +0,0 @@
-{
-    "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

@@ -1,55 +0,0 @@
-{
-    "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,
-    "force": 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

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

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

@@ -1,55 +0,0 @@
-{
-    "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,
-    "force": 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

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

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

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

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

@@ -1,23 +0,0 @@
-{
-    "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

@@ -1,23 +0,0 @@
-{
-    "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

@@ -1,22 +0,0 @@
-{
-    "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

@@ -1,23 +0,0 @@
-{
-    "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

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

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

@@ -1,23 +0,0 @@
-{
-    "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/datamodel-list-response.json

@@ -1,38 +0,0 @@
-{
-    "context": [
-        {
-            "server_uuid": "1bf91464-9b41-428d-a11e-af691e5563bb",
-            "server_name": "chenke-test1",
-            "server_vcpus": "1",
-            "server_memory": "512",
-            "server_disk": "1",
-            "server_state": "active",
-            "node_uuid": "253e5dd0-9384-41ab-af13-4f2c2ce26112",
-            "node_hostname": "localhost.localdomain",
-            "node_vcpus": "4",
-            "node_vcpu_ratio": "16.0",
-            "node_memory": "16383",
-            "node_memory_ratio": "1.5",
-            "node_disk": "37"
-            "node_disk_ratio": "1.0",
-            "node_state": "up",
-        },
-        {
-            "server_uuid": "e2cb5f6f-fa1d-4ba2-be1e-0bf02fa86ba4",
-            "server_name": "chenke-test2",
-            "server_vcpus": "1",
-            "server_memory": "512",
-            "server_disk": "1",
-            "server_state": "active",
-            "node_uuid": "253e5dd0-9384-41ab-af13-4f2c2ce26112",
-            "node_hostname": "localhost.localdomain",
-            "node_vcpus": "4",
-            "node_vcpu_ratio": "16.0",
-            "node_memory": "16383",
-            "node_memory_ratio": "1.5",
-            "node_disk": "37"
-            "node_disk_ratio": "1.0",
-            "node_state": "up",
-        }
-    ]
-}

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

@@ -1,55 +0,0 @@
-{
-    "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

@@ -1,19 +0,0 @@
-{
-    "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

@@ -1,20 +0,0 @@
-{
-    "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

@@ -1,19 +0,0 @@
-{
-    "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

@@ -1,16 +0,0 @@
-{
-    "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

@@ -1,24 +0,0 @@
-{
-    "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

@@ -1,36 +0,0 @@
-{
-    "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

@@ -1,20 +0,0 @@
-{
-    "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

@@ -1,35 +0,0 @@
-{
-    "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

@@ -1,21 +0,0 @@
-{
-    "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

@@ -1,33 +0,0 @@
-{
-    "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

@@ -1,49 +0,0 @@
-[
-    {
-        "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

@@ -1,258 +0,0 @@
-.. -*- 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

@@ -1,155 +0,0 @@
-.. -*- 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

@@ -1,367 +0,0 @@
-.. -*- 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
-   - force: audit_force
-
-**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
-    - force: audit_force
-
-**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
-    - force: audit_force
-
-**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
-    - force: audit_force
-
-**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
-    - force: audit_force
-
-**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
-    - force: audit_force
-
-**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

@@ -1,257 +0,0 @@
-.. -*- 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-datamodel.inc

@@ -1,57 +0,0 @@
-.. -*- rst -*-
-
-==========
-Data Model
-==========
-
-.. versionadded:: 1.3
-
-``Data Model`` is very important for Watcher to generate resource
-optimization solutions. Users can easily view the data model by the
-API.
-
-
-List Data Model
-===============
-
-.. rest_method::  GET /v1/data_model
-
-Returns the information about Data Model.
-
-Normal response codes: 200
-
-Error codes: 400,401,406
-
-Request
--------
-
-.. rest_parameters:: parameters.yaml
-
-   - audit: r_audit
-   - type: r_type
-
-Response
---------
-
-.. rest_parameters:: parameters.yaml
-
-    - server_uuid: server_uuid
-    - server_name: server_name
-    - server_vcpus: server_vcpus
-    - server_memory: server_memory
-    - server_disk: server_disk
-    - server_state: server_state
-    - node_uuid: node_uuid
-    - node_hostname: node_hostname
-    - node_vcpus: node_vcpus
-    - node_vcpu_ratio: node_vcpu_ratio
-    - node_memory: node_memory
-    - node_memory_ratio: node_memory_ratio
-    - node_disk: node_disk
-    - node_disk_ratio: node_disk_ratio
-    - node_state: node_state
-
-**Example JSON representation of a Data Model:**
-
-.. literalinclude:: samples/datamodel-list-response.json
-   :language: javascript

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

@@ -1,126 +0,0 @@
-.. -*- 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

@@ -1,120 +0,0 @@
-.. -*- 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

@@ -1,116 +0,0 @@
-.. -*- 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

@@ -1,164 +0,0 @@
-.. -*- 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-v1-webhooks.inc

@@ -1,26 +0,0 @@
-.. -*- rst -*-
-
-========
-Webhooks
-========
-
-.. versionadded:: 1.4
-
-Triggers an event based Audit.
-
-
-Trigger EVENT Audit
-===================
-
-.. rest_method::  POST /v1/webhooks/{audit_ident}
-
-Normal response codes: 202
-
-Error codes: 400,404
-
-Request
--------
-
-.. rest_parameters:: parameters.yaml
-
-   - audit_ident: audit_ident

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

@@ -1,81 +0,0 @@
-.. -*- 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

babel.cfg

@@ -0,0 +1,2 @@
+[python: **.py]
+

devstack/lib/watcher

@@ -42,28 +42,19 @@ WATCHER_AUTH_CACHE_DIR=${WATCHER_AUTH_CACHE_DIR:-/var/cache/watcher}
 
 WATCHER_CONF_DIR=/etc/watcher
 WATCHER_CONF=$WATCHER_CONF_DIR/watcher.conf
-WATCHER_POLICY_YAML=$WATCHER_CONF_DIR/policy.yaml.sample
+WATCHER_POLICY_JSON=$WATCHER_CONF_DIR/policy.json
 
 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
 
-# Support entry points installation of console scripts
-if [[ -d $WATCHER_DIR/bin ]]; then
-    WATCHER_BIN_DIR=$WATCHER_DIR/bin
-else
-    WATCHER_BIN_DIR=$(get_python_exec_prefix)
-fi
-
-# There are 2 modes, which is "uwsgi" which runs with an apache
-# proxy uwsgi in front of it, or "mod_wsgi", which runs in
-# apache. mod_wsgi is deprecated, don't use it.
-WATCHER_USE_WSGI_MODE=${WATCHER_USE_WSGI_MODE:-$WSGI_MODE}
-WATCHER_UWSGI=$WATCHER_BIN_DIR/watcher-api-wsgi
-WATCHER_UWSGI_CONF=$WATCHER_CONF_DIR/watcher-uwsgi.ini
+WATCHER_USE_MOD_WSGI=$(trueorfalse True WATCHER_USE_MOD_WSGI)
 
 if is_suse; then
     WATCHER_WSGI_DIR=${WATCHER_WSGI_DIR:-/srv/www/htdocs/watcher}
@@ -71,15 +62,16 @@ else
     WATCHER_WSGI_DIR=${WATCHER_WSGI_DIR:-/var/www/watcher}
 fi
 # Public facing bits
-WATCHER_SERVICE_HOST=${WATCHER_SERVICE_HOST:-$SERVICE_HOST}
+WATCHER_SERVICE_HOST=${WATCHER_SERVICE_HOST:-$HOST_IP}
 WATCHER_SERVICE_PORT=${WATCHER_SERVICE_PORT:-9322}
 WATCHER_SERVICE_PORT_INT=${WATCHER_SERVICE_PORT_INT:-19322}
 WATCHER_SERVICE_PROTOCOL=${WATCHER_SERVICE_PROTOCOL:-$SERVICE_PROTOCOL}
 
-if [[ "$WATCHER_USE_WSGI_MODE" == "uwsgi" ]]; then
-    WATCHER_API_URL="$WATCHER_SERVICE_PROTOCOL://$WATCHER_SERVICE_HOST/infra-optim"
+# Support entry points installation of console scripts
+if [[ -d $WATCHER_DIR/bin ]]; then
+    WATCHER_BIN_DIR=$WATCHER_DIR/bin
 else
-    WATCHER_API_URL="$WATCHER_SERVICE_PROTOCOL://$WATCHER_SERVICE_HOST:$WATCHER_SERVICE_PORT"
+    WATCHER_BIN_DIR=$(get_python_exec_prefix)
 fi
 
 # Entry Points
@@ -104,9 +96,7 @@ function _cleanup_watcher_apache_wsgi {
 # runs that a clean run would need to clean up
 function cleanup_watcher {
     sudo rm -rf $WATCHER_STATE_PATH $WATCHER_AUTH_CACHE_DIR
-    if [[ "$WATCHER_USE_WSGI_MODE" == "uwsgi" ]]; then
-        remove_uwsgi_config "$WATCHER_UWSGI_CONF" "$WATCHER_UWSGI"
-    else
+    if [[ "$WATCHER_USE_MOD_WSGI" == "True" ]]; then
         _cleanup_watcher_apache_wsgi
     fi
 }
@@ -116,25 +106,7 @@ function configure_watcher {
     # Put config files in ``/etc/watcher`` for everyone to find
     sudo install -d -o $STACK_USER $WATCHER_CONF_DIR
 
-    local project=watcher
-    local project_uc
-    project_uc=$(echo watcher|tr a-z A-Z)
-    local conf_dir="${project_uc}_CONF_DIR"
-    # eval conf dir to get the variable
-    conf_dir="${!conf_dir}"
-    local project_dir="${project_uc}_DIR"
-    # eval project dir to get the variable
-    project_dir="${!project_dir}"
-    local sample_conf_dir="${project_dir}/etc/${project}"
-    local sample_policy_dir="${project_dir}/etc/${project}/policy.d"
-    local sample_policy_generator="${project_dir}/etc/${project}/oslo-policy-generator/watcher-policy-generator.conf"
-
-    # first generate policy.yaml
-    oslopolicy-sample-generator --config-file $sample_policy_generator
-    # then optionally copy over policy.d
-    if [[ -d $sample_policy_dir ]]; then
-        cp -r $sample_policy_dir $conf_dir/policy.d
-    fi
+    install_default_policy watcher
 
     # Rebuild the config file from scratch
     create_watcher_conf
@@ -152,32 +124,29 @@ function create_watcher_accounts {
         "infra-optim" "Watcher Infrastructure Optimization Service")
     get_or_create_endpoint $watcher_service \
         "$REGION_NAME" \
-        "$WATCHER_API_URL"\
-        "$WATCHER_API_URL"\
-        "$WATCHER_API_URL"
+        "$WATCHER_SERVICE_PROTOCOL://$WATCHER_SERVICE_HOST:$WATCHER_SERVICE_PORT" \
+        "$WATCHER_SERVICE_PROTOCOL://$WATCHER_SERVICE_HOST:$WATCHER_SERVICE_PORT" \
+        "$WATCHER_SERVICE_PROTOCOL://$WATCHER_SERVICE_HOST:$WATCHER_SERVICE_PORT"
 }
 
 # _config_watcher_apache_wsgi() - Set WSGI config files of watcher
 function _config_watcher_apache_wsgi {
     local watcher_apache_conf
-    if [[ "$WATCHER_USE_WSGI_MODE" == "mod_wsgi" ]]; then
-        local service_port=$WATCHER_SERVICE_PORT
-        if is_service_enabled tls-proxy; then
-            service_port=$WATCHER_SERVICE_PORT_INT
-            service_protocol="http"
-        fi
+    if [[ "$WATCHER_USE_MOD_WSGI" == "True" ]]; then
         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%|$service_port|g;
+            s|%WATCHER_SERVICE_PORT%|$WATCHER_SERVICE_PORT|g;
             s|%WATCHER_WSGI_DIR%|$WATCHER_WSGI_DIR|g;
             s|%USER%|$STACK_USER|g;
             s|%APIWORKERS%|$API_WORKERS|g;
             s|%APACHE_NAME%|$APACHE_NAME|g;
         " -i $watcher_apache_conf
         enable_apache_site watcher-api
+        tail_log watcher-access /var/log/$APACHE_NAME/watcher-api-access.log
+        tail_log watcher-api /var/log/$APACHE_NAME/watcher-api.log
    fi
 
 }
@@ -190,26 +159,21 @@ function create_watcher_conf {
     iniset $WATCHER_CONF DEFAULT debug "$ENABLE_DEBUG_LOG_LEVEL"
     iniset $WATCHER_CONF DEFAULT control_exchange watcher
 
-    iniset_rpc_backend watcher $WATCHER_CONF
-
     iniset $WATCHER_CONF database connection $(database_connection_url watcher)
-    iniset $WATCHER_CONF api host "$(ipv6_unquote $WATCHER_SERVICE_HOST)"
+    iniset $WATCHER_CONF api host "$WATCHER_SERVICE_HOST"
+    iniset $WATCHER_CONF api port "$WATCHER_SERVICE_PORT"
 
-    if is_service_enabled tls-proxy; then
-        iniset $WATCHER_CONF api host "$(ipv6_unquote $WATCHER_SERVICE_HOST)"
-        iniset $WATCHER_CONF api port "$WATCHER_SERVICE_PORT_INT"
-        # iniset $WATCHER_CONF api enable_ssl_api "True"
-    else
-        if [[ "$WATCHER_USE_WSGI_MODE" == "mod_wsgi" ]]; then
-            iniset $WATCHER_CONF api host "$(ipv6_unquote $WATCHER_SERVICE_HOST)"
-            iniset $WATCHER_CONF api port "$WATCHER_SERVICE_PORT"
-        fi
-    fi
+    iniset $WATCHER_CONF oslo_policy policy_file $WATCHER_POLICY_JSON
 
-    iniset $WATCHER_CONF oslo_policy policy_file $WATCHER_POLICY_YAML
+    iniset $WATCHER_CONF oslo_messaging_rabbit rabbit_userid $RABBIT_USERID
+    iniset $WATCHER_CONF oslo_messaging_rabbit rabbit_password $RABBIT_PASSWORD
+    iniset $WATCHER_CONF oslo_messaging_rabbit rabbit_host $RABBIT_HOST
 
     iniset $WATCHER_CONF oslo_messaging_notifications driver "messagingv2"
 
+    iniset $NOVA_CONF oslo_messaging_notifications topics "notifications,watcher_notifications"
+    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"
 
@@ -229,12 +193,15 @@ function create_watcher_conf {
     fi
 
     # Format logging
-    setup_logging $WATCHER_CONF
+    if [ "$LOG_COLOR" == "True" ] && [ "$SYSLOG" == "False" ]; then
+        setup_colorized_logging $WATCHER_CONF DEFAULT
+    else
+        # Show user_name and project_name instead of user_id and project_id
+        iniset $WATCHER_CONF DEFAULT logging_context_format_string "%(asctime)s.%(msecs)03d %(levelname)s %(name)s [%(request_id)s %(project_domain)s %(user_name)s %(project_name)s] %(instance)s%(message)s"
+    fi
 
     #config apache files
-    if [[ "$WATCHER_USE_WSGI_MODE" == "uwsgi" ]]; then
-        write_uwsgi_config "$WATCHER_UWSGI_CONF" "$WATCHER_UWSGI" "/infra-optim"
-    else
+    if [[ "$WATCHER_USE_MOD_WSGI" == "True" ]]; then
         _config_watcher_apache_wsgi
     fi
     # Register SSL certificates if provided
@@ -246,6 +213,10 @@ function create_watcher_conf {
 
         iniset $WATCHER_CONF DEFAULT enabled_ssl_apis "$WATCHER_ENABLED_APIS"
     fi
+
+    if is_service_enabled ceilometer; then
+        iniset $WATCHER_CONF watcher_messaging notifier_driver "messaging"
+    fi
 }
 
 # create_watcher_cache_dir() - Part of the init_watcher() process
@@ -281,7 +252,7 @@ function install_watcherclient {
 function install_watcher {
     git_clone $WATCHER_REPO $WATCHER_DIR $WATCHER_BRANCH
     setup_develop $WATCHER_DIR
-    if [[ "$WATCHER_USE_WSGI_MODE" == "mod_wsgi" ]]; then
+    if [[ "$WATCHER_USE_MOD_WSGI" == "True" ]]; then
         install_apache_wsgi
     fi
 }
@@ -292,29 +263,25 @@ function start_watcher_api {
 
     local service_port=$WATCHER_SERVICE_PORT
     local service_protocol=$WATCHER_SERVICE_PROTOCOL
-    local watcher_url
     if is_service_enabled tls-proxy; then
         service_port=$WATCHER_SERVICE_PORT_INT
         service_protocol="http"
     fi
-    if [[ "$WATCHER_USE_WSGI_MODE" == "uwsgi" ]]; then
-        run_process "watcher-api" "$(which uwsgi) --procname-prefix watcher-api --ini $WATCHER_UWSGI_CONF"
-        watcher_url=$service_protocol://$SERVICE_HOST/infra-optim
-    else
-        watcher_url=$service_protocol://$SERVICE_HOST:$service_port
-        enable_apache_site watcher-api
+    if [[ "$WATCHER_USE_MOD_WSGI" == "True" ]]; then
         restart_apache_server
-        # 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
+    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 $watcher_url; then
+    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_SERVICE_PORT $WATCHER_SERVICE_HOST $WATCHER_SERVICE_PORT_INT &
+        start_tls_proxy '*' $EC2_SERVICE_PORT $WATCHER_SERVICE_HOST $WATCHER_SERVICE_PORT_INT &
+    fi
 }
 
 # start_watcher() - Start running processes, including screen
@@ -327,11 +294,10 @@ function start_watcher {
 
 # stop_watcher() - Stop running processes (non-screen)
 function stop_watcher {
-    if [[ "$WATCHER_USE_WSGI_MODE" == "uwsgi" ]]; then
-        stop_process watcher-api
-    else
+    if [[ "$WATCHER_USE_MOD_WSGI" == "True" ]]; then
         disable_apache_site watcher-api
-        restart_apache_server
+    else
+        stop_process watcher-api
     fi
     for serv in watcher-decision-engine watcher-applier; do
         stop_process $serv

devstack/local.conf.compute

@@ -10,7 +10,6 @@ SERVICE_PASSWORD=$ADMIN_PASSWORD
 SERVICE_TOKEN=azertytoken
 
 HOST_IP=192.168.42.2 # Change this to this compute node's IP address
-#HOST_IPV6=2001:db8::7
 FLAT_INTERFACE=eth0
 
 FIXED_RANGE=10.254.1.0/24 # Change this to whatever your network is
@@ -31,12 +30,12 @@ ENABLED_SERVICES=n-cpu,n-api-meta,c-vol,q-agt,placement-client
 NOVA_VNC_ENABLED=True
 NOVNCPROXY_URL="http://$SERVICE_HOST:6080/vnc_auto.html"
 VNCSERVER_LISTEN=0.0.0.0
-VNCSERVER_PROXYCLIENT_ADDRESS=$HOST_IP # or HOST_IPV6
+VNCSERVER_PROXYCLIENT_ADDRESS=$HOST_IP
 
 NOVA_INSTANCES_PATH=/opt/stack/data/instances
 
 # Enable the Ceilometer plugin for the compute agent
-enable_plugin ceilometer https://opendev.org/openstack/ceilometer
+enable_plugin ceilometer https://git.openstack.org/openstack/ceilometer
 disable_service ceilometer-acentral,ceilometer-collector,ceilometer-api
 
 LOGFILE=$DEST/logs/stack.sh.log
@@ -45,9 +44,6 @@ LOGDAYS=2
 [[post-config|$NOVA_CONF]]
 [DEFAULT]
 compute_monitors=cpu.virt_driver
+notify_on_state_change = vm_and_task_state
 [notifications]
-# Enable both versioned and unversioned notifications. Watcher only
-# uses versioned notifications but ceilometer uses unversioned. We
-# can change this to just versioned when ceilometer handles versioned
-# notifications from nova: https://bugs.launchpad.net/ceilometer/+bug/1665449
-notification_format=both
+notify_on_state_change = vm_and_task_state

devstack/local.conf.controller

@@ -10,7 +10,6 @@ SERVICE_PASSWORD=$ADMIN_PASSWORD
 SERVICE_TOKEN=azertytoken
 
 HOST_IP=192.168.42.1 # Change this to your controller node IP address
-#HOST_IPV6=2001:db8::7
 FLAT_INTERFACE=eth0
 
 FIXED_RANGE=10.254.1.0/24 # Change this to whatever your network is
@@ -25,18 +24,24 @@ MULTI_HOST=1
 # This is the controller node, so disable nova-compute
 disable_service n-cpu
 
+# Disable nova-network and use neutron instead
+disable_service n-net
+ENABLED_SERVICES+=,q-svc,q-dhcp,q-meta,q-agt,q-l3,neutron
+
+# Enable remote console access
+enable_service n-cauth
+
 # Enable the Watcher Dashboard plugin
-enable_plugin watcher-dashboard https://opendev.org/openstack/watcher-dashboard
+enable_plugin watcher-dashboard https://git.openstack.org/openstack/watcher-dashboard
 
 # Enable the Watcher plugin
-enable_plugin watcher https://opendev.org/openstack/watcher
+enable_plugin watcher https://git.openstack.org/openstack/watcher
 
 # Enable the Ceilometer plugin
-enable_plugin ceilometer https://opendev.org/openstack/ceilometer
+enable_plugin ceilometer https://git.openstack.org/openstack/ceilometer
 
 # This is the controller node, so disable the ceilometer compute agent
 disable_service ceilometer-acompute
-
 # Enable the ceilometer api explicitly(bug:1667678)
 enable_service ceilometer-api
 
@@ -49,9 +54,6 @@ LOGDAYS=2
 [[post-config|$NOVA_CONF]]
 [DEFAULT]
 compute_monitors=cpu.virt_driver
+notify_on_state_change = vm_and_task_state
 [notifications]
-# Enable both versioned and unversioned notifications. Watcher only
-# uses versioned notifications but ceilometer uses unversioned. We
-# can change this to just versioned when ceilometer handles versioned
-# notifications from nova: https://bugs.launchpad.net/ceilometer/+bug/1665449
-notification_format=both
+notify_on_state_change = vm_and_task_state

devstack/override-defaults

@@ -1,9 +0,0 @@
-# Plug-in overrides
-# https://docs.openstack.org/devstack/latest/plugins.html#plugin-interface
-
-# Enable both versioned and unversioned notifications. Watcher only
-# uses versioned notifications but ceilometer uses unversioned. We
-# can change this to just versioned when ceilometer handles
-# versioned notifications from nova:
-# https://bugs.launchpad.net/ceilometer/+bug/1665449
-NOVA_NOTIFICATION_FORMAT=both

devstack/plugin.sh

@@ -7,7 +7,7 @@ _XTRACE_WATCHER_PLUGIN=$(set +o | grep xtrace)
 set -o xtrace
 
 echo_summary "watcher's plugin.sh was called..."
-. $DEST/watcher/devstack/lib/watcher
+source $DEST/watcher/devstack/lib/watcher
 
 # Show all of defined environment variables
 (set -o posix; set)

devstack/settings

@@ -3,9 +3,6 @@
 # Make sure rabbit is enabled
 enable_service rabbit
 
-# Make sure mysql is enabled
-enable_service mysql
-
 # Enable Watcher services
 enable_service watcher-api
 enable_service watcher-decision-engine

devstack/upgrade/from_rocky/upgrade-watcher

@@ -1,15 +0,0 @@
-#!/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

@@ -1,126 +0,0 @@
-#!/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

@@ -1,18 +0,0 @@
-register_project_for_upgrade watcher
-register_db_to_save watcher
-
-devstack_localrc base enable_plugin watcher https://opendev.org/openstack/watcher $BASE_DEVSTACK_BRANCH
-devstack_localrc target enable_plugin watcher https://opendev.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
-
-# Enable both versioned and unversioned notifications. Watcher only
-# uses versioned notifications but ceilometer uses unversioned. We
-# can change this to just versioned when ceilometer handles
-# versioned notifications from nova:
-# https://bugs.launchpad.net/ceilometer/+bug/1665449
-devstack_localrc base NOVA_NOTIFICATION_FORMAT=both

devstack/upgrade/shutdown.sh

@@ -1,24 +0,0 @@
-#!/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

@@ -1,83 +0,0 @@
-#!/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 $TARGET_DEVSTACK_DIR/lib/keystone
-
-source $TOP_DIR/openrc admin admin
-
-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
-
-if [[ ! -f "$WATCHER_UWSGI_CONF" ]] && [[ "$WATCHER_USE_WSGI_MODE" == "uwsgi" ]]
-then write_uwsgi_config "$WATCHER_UWSGI_CONF" "$WATCHER_UWSGI" "/infra-optim"
-     endpoints=$(openstack endpoint list --service watcher -c ID -f value)
-     for id in $endpoints; do
-         openstack endpoint delete $id
-     done
-     create_watcher_accounts
-fi
-
-# 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/ext/term.py

@@ -13,6 +13,8 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+from __future__ import unicode_literals
+
 import importlib
 import inspect
 
@@ -20,7 +22,7 @@ from docutils import nodes
 from docutils.parsers import rst
 from docutils import statemachine
 
-from watcher.version import version_string
+from watcher.version import version_info
 
 
 class BaseWatcherDirective(rst.Directive):
@@ -167,4 +169,4 @@ class WatcherFunc(BaseWatcherDirective):
 def setup(app):
     app.add_directive('watcher-term', WatcherTerm)
     app.add_directive('watcher-func', WatcherFunc)
-    return {'version': version_string}
+    return {'version': version_info.version_string()}

doc/ext/versioned_notifications.py

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

doc/notification_samples/action-cancel-end.json

@@ -1,41 +0,0 @@
-{
-  "priority": "INFO",
-  "payload": {
-    "watcher_object.namespace": "watcher",
-    "watcher_object.version": "1.0",
-    "watcher_object.name": "ActionCancelPayload",
-    "watcher_object.data": {
-      "uuid": "10a47dd1-4874-4298-91cf-eff046dbdb8d",
-      "input_parameters": {
-        "param2": 2,
-        "param1": 1
-      },
-      "fault": null,
-      "created_at": "2016-10-18T09:52:05Z",
-      "updated_at": null,
-      "state": "CANCELLED",
-      "action_plan": {
-        "watcher_object.namespace": "watcher",
-        "watcher_object.version": "1.0",
-        "watcher_object.name": "TerseActionPlanPayload",
-        "watcher_object.data": {
-          "uuid": "76be87bd-3422-43f9-93a0-e85a577e3061",
-          "global_efficacy": [],
-          "created_at": "2016-10-18T09:52:05Z",
-          "updated_at": null,
-          "state": "CANCELLING",
-          "audit_uuid": "10a47dd1-4874-4298-91cf-eff046dbdb8d",
-          "strategy_uuid": "cb3d0b58-4415-4d90-b75b-1e96878730e3",
-          "deleted_at": null
-        }
-      },
-      "parents": [],
-      "action_type": "nop",
-      "deleted_at": null
-    }
-  },
-  "event_type": "action.cancel.end",
-  "publisher_id": "infra-optim:node0",
-  "timestamp": "2017-01-01 00:00:00.000000",
-  "message_id": "530b409c-9b6b-459b-8f08-f93dbfeb4d41"
-}

doc/notification_samples/action-cancel-error.json

@@ -1,51 +0,0 @@
-{
-  "priority": "ERROR",
-  "payload": {
-    "watcher_object.namespace": "watcher",
-    "watcher_object.version": "1.0",
-    "watcher_object.name": "ActionCancelPayload",
-    "watcher_object.data": {
-      "uuid": "10a47dd1-4874-4298-91cf-eff046dbdb8d",
-      "input_parameters": {
-        "param2": 2,
-        "param1": 1
-      },
-      "fault": {
-        "watcher_object.namespace": "watcher",
-        "watcher_object.version": "1.0",
-        "watcher_object.name": "ExceptionPayload",
-        "watcher_object.data": {
-          "module_name": "watcher.tests.notifications.test_action_notification",
-          "exception": "WatcherException",
-          "exception_message": "TEST",
-          "function_name": "test_send_action_cancel_with_error"
-        }
-      },
-      "created_at": "2016-10-18T09:52:05Z",
-      "updated_at": null,
-      "state": "FAILED",
-      "action_plan": {
-        "watcher_object.namespace": "watcher",
-        "watcher_object.version": "1.0",
-        "watcher_object.name": "TerseActionPlanPayload",
-        "watcher_object.data": {
-          "uuid": "76be87bd-3422-43f9-93a0-e85a577e3061",
-          "global_efficacy": [],
-          "created_at": "2016-10-18T09:52:05Z",
-          "updated_at": null,
-          "state": "CANCELLING",
-          "audit_uuid": "10a47dd1-4874-4298-91cf-eff046dbdb8d",
-          "strategy_uuid": "cb3d0b58-4415-4d90-b75b-1e96878730e3",
-          "deleted_at": null
-        }
-      },
-      "parents": [],
-      "action_type": "nop",
-      "deleted_at": null
-    }
-  },
-  "event_type": "action.cancel.error",
-  "publisher_id": "infra-optim:node0",
-  "timestamp": "2017-01-01 00:00:00.000000",
-  "message_id": "530b409c-9b6b-459b-8f08-f93dbfeb4d41"
-}

doc/notification_samples/action-cancel-start.json

@@ -1,41 +0,0 @@
-{
-  "priority": "INFO",
-  "payload": {
-    "watcher_object.namespace": "watcher",
-    "watcher_object.version": "1.0",
-    "watcher_object.name": "ActionCancelPayload",
-    "watcher_object.data": {
-      "uuid": "10a47dd1-4874-4298-91cf-eff046dbdb8d",
-      "input_parameters": {
-        "param2": 2,
-        "param1": 1
-      },
-      "fault": null,
-      "created_at": "2016-10-18T09:52:05Z",
-      "updated_at": null,
-      "state": "CANCELLING",
-      "action_plan": {
-        "watcher_object.namespace": "watcher",
-        "watcher_object.version": "1.0",
-        "watcher_object.name": "TerseActionPlanPayload",
-        "watcher_object.data": {
-          "uuid": "76be87bd-3422-43f9-93a0-e85a577e3061",
-          "global_efficacy": [],
-          "created_at": "2016-10-18T09:52:05Z",
-          "updated_at": null,
-          "state": "CANCELLING",
-          "audit_uuid": "10a47dd1-4874-4298-91cf-eff046dbdb8d",
-          "strategy_uuid": "cb3d0b58-4415-4d90-b75b-1e96878730e3",
-          "deleted_at": null
-        }
-      },
-      "parents": [],
-      "action_type": "nop",
-      "deleted_at": null
-    }
-  },
-  "event_type": "action.cancel.start",
-  "publisher_id": "infra-optim:node0",
-  "timestamp": "2017-01-01 00:00:00.000000",
-  "message_id": "530b409c-9b6b-459b-8f08-f93dbfeb4d41"
-}

doc/notification_samples/action-execution-end.json

@@ -20,7 +20,7 @@
         "watcher_object.name": "TerseActionPlanPayload",
         "watcher_object.data": {
           "uuid": "76be87bd-3422-43f9-93a0-e85a577e3061",
-          "global_efficacy": [],
+          "global_efficacy": {},
           "created_at": "2016-10-18T09:52:05Z",
           "updated_at": null,
           "state": "ONGOING",

doc/notification_samples/action-execution-error.json

@@ -30,7 +30,7 @@
         "watcher_object.name": "TerseActionPlanPayload",
         "watcher_object.data": {
           "uuid": "76be87bd-3422-43f9-93a0-e85a577e3061",
-          "global_efficacy":[],
+          "global_efficacy": {},
           "created_at": "2016-10-18T09:52:05Z",
           "updated_at": null,
           "state": "ONGOING",

doc/notification_samples/action-execution-start.json

@@ -20,7 +20,7 @@
         "watcher_object.name": "TerseActionPlanPayload",
         "watcher_object.data": {
           "uuid": "76be87bd-3422-43f9-93a0-e85a577e3061",
-          "global_efficacy": [],
+          "global_efficacy": {},
           "created_at": "2016-10-18T09:52:05Z",
           "updated_at": null,
           "state": "ONGOING",

doc/notification_samples/action_plan-cancel-end.json

@@ -1,55 +0,0 @@
-{
-  "event_type": "action_plan.cancel.end",
-  "payload": {
-    "watcher_object.namespace": "watcher",
-    "watcher_object.name": "ActionPlanCancelPayload",
-    "watcher_object.version": "1.0",
-    "watcher_object.data": {
-      "created_at": "2016-10-18T09:52:05Z",
-      "deleted_at": null,
-      "audit_uuid": "10a47dd1-4874-4298-91cf-eff046dbdb8d",
-      "audit": {
-        "watcher_object.namespace": "watcher",
-        "watcher_object.name": "TerseAuditPayload",
-        "watcher_object.version": "1.0",
-        "watcher_object.data": {
-          "created_at": "2016-10-18T09:52:05Z",
-          "deleted_at": null,
-          "uuid": "10a47dd1-4874-4298-91cf-eff046dbdb8d",
-          "goal_uuid": "bc830f84-8ae3-4fc6-8bc6-e3dd15e8b49a",
-          "strategy_uuid": "75234dfe-87e3-4f11-a0e0-3c3305d86a39",
-          "scope": [],
-          "audit_type": "ONESHOT",
-          "state": "SUCCEEDED",
-          "parameters": {},
-          "interval": null,
-          "updated_at": null
-        }
-      },
-      "uuid": "76be87bd-3422-43f9-93a0-e85a577e3061",
-      "fault": null,
-      "state": "CANCELLED",
-      "global_efficacy": [],
-      "strategy_uuid": "cb3d0b58-4415-4d90-b75b-1e96878730e3",
-      "strategy": {
-        "watcher_object.namespace": "watcher",
-        "watcher_object.name": "StrategyPayload",
-        "watcher_object.version": "1.0",
-        "watcher_object.data": {
-          "created_at": "2016-10-18T09:52:05Z",
-          "deleted_at": null,
-          "name": "TEST",
-          "uuid": "cb3d0b58-4415-4d90-b75b-1e96878730e3",
-          "parameters_spec": {},
-          "display_name": "test strategy",
-          "updated_at": null
-        }
-      },
-      "updated_at": null
-    }
-  },
-  "priority": "INFO",
-  "message_id": "3984dc2b-8aef-462b-a220-8ae04237a56e",
-  "timestamp": "2016-10-18 09:52:05.219414",
-  "publisher_id": "infra-optim:node0"
-}

doc/notification_samples/action_plan-cancel-error.json

@@ -1,65 +0,0 @@
-{
-  "event_type": "action_plan.cancel.error",
-  "publisher_id": "infra-optim:node0",
-  "priority": "ERROR",
-  "message_id": "9a45c5ae-0e21-4300-8fa0-5555d52a66d9",
-  "payload": {
-    "watcher_object.version": "1.0",
-    "watcher_object.namespace": "watcher",
-    "watcher_object.name": "ActionPlanCancelPayload",
-    "watcher_object.data": {
-      "fault": {
-        "watcher_object.version": "1.0",
-        "watcher_object.namespace": "watcher",
-        "watcher_object.name": "ExceptionPayload",
-        "watcher_object.data": {
-          "exception_message": "TEST",
-          "module_name": "watcher.tests.notifications.test_action_plan_notification",
-          "function_name": "test_send_action_plan_cancel_with_error",
-          "exception": "WatcherException"
-        }
-      },
-      "uuid": "76be87bd-3422-43f9-93a0-e85a577e3061",
-      "created_at": "2016-10-18T09:52:05Z",
-      "strategy_uuid": "cb3d0b58-4415-4d90-b75b-1e96878730e3",
-      "strategy": {
-        "watcher_object.version": "1.0",
-        "watcher_object.namespace": "watcher",
-        "watcher_object.name": "StrategyPayload",
-        "watcher_object.data": {
-          "uuid": "cb3d0b58-4415-4d90-b75b-1e96878730e3",
-          "created_at": "2016-10-18T09:52:05Z",
-          "name": "TEST",
-          "updated_at": null,
-          "display_name": "test strategy",
-          "parameters_spec": {},
-          "deleted_at": null
-        }
-      },
-      "updated_at": null,
-      "deleted_at": null,
-      "audit_uuid": "10a47dd1-4874-4298-91cf-eff046dbdb8d",
-      "audit": {
-        "watcher_object.version": "1.0",
-        "watcher_object.namespace": "watcher",
-        "watcher_object.name": "TerseAuditPayload",
-        "watcher_object.data": {
-          "parameters": {},
-          "uuid": "10a47dd1-4874-4298-91cf-eff046dbdb8d",
-          "goal_uuid": "bc830f84-8ae3-4fc6-8bc6-e3dd15e8b49a",
-          "strategy_uuid": "75234dfe-87e3-4f11-a0e0-3c3305d86a39",
-          "created_at": "2016-10-18T09:52:05Z",
-          "scope": [],
-          "updated_at": null,
-          "audit_type": "ONESHOT",
-          "interval": null,
-          "deleted_at": null,
-          "state": "SUCCEEDED"
-        }
-      },
-      "global_efficacy": [],
-      "state": "CANCELLING"
-    }
-  },
-  "timestamp": "2016-10-18 09:52:05.219414"
-}

doc/notification_samples/action_plan-cancel-start.json

@@ -1,55 +0,0 @@
-{
-  "event_type": "action_plan.cancel.start",
-  "payload": {
-    "watcher_object.namespace": "watcher",
-    "watcher_object.name": "ActionPlanCancelPayload",
-    "watcher_object.version": "1.0",
-    "watcher_object.data": {
-      "created_at": "2016-10-18T09:52:05Z",
-      "deleted_at": null,
-      "audit_uuid": "10a47dd1-4874-4298-91cf-eff046dbdb8d",
-      "audit": {
-        "watcher_object.namespace": "watcher",
-        "watcher_object.name": "TerseAuditPayload",
-        "watcher_object.version": "1.0",
-        "watcher_object.data": {
-          "created_at": "2016-10-18T09:52:05Z",
-          "deleted_at": null,
-          "uuid": "10a47dd1-4874-4298-91cf-eff046dbdb8d",
-          "goal_uuid": "bc830f84-8ae3-4fc6-8bc6-e3dd15e8b49a",
-          "strategy_uuid": "75234dfe-87e3-4f11-a0e0-3c3305d86a39",
-          "scope": [],
-          "audit_type": "ONESHOT",
-          "state": "SUCCEEDED",
-          "parameters": {},
-          "interval": null,
-          "updated_at": null
-        }
-      },
-      "uuid": "76be87bd-3422-43f9-93a0-e85a577e3061",
-      "fault": null,
-      "state": "CANCELLING",
-      "global_efficacy": [],
-      "strategy_uuid": "cb3d0b58-4415-4d90-b75b-1e96878730e3",
-      "strategy": {
-        "watcher_object.namespace": "watcher",
-        "watcher_object.name": "StrategyPayload",
-        "watcher_object.version": "1.0",
-        "watcher_object.data": {
-          "created_at": "2016-10-18T09:52:05Z",
-          "deleted_at": null,
-          "name": "TEST",
-          "uuid": "cb3d0b58-4415-4d90-b75b-1e96878730e3",
-          "parameters_spec": {},
-          "display_name": "test strategy",
-          "updated_at": null
-        }
-      },
-      "updated_at": null
-    }
-  },
-  "priority": "INFO",
-  "message_id": "3984dc2b-8aef-462b-a220-8ae04237a56e",
-  "timestamp": "2016-10-18 09:52:05.219414",
-  "publisher_id": "infra-optim:node0"
-}

doc/notification_samples/action_plan-create.json

@@ -23,7 +23,6 @@
       "audit": {
         "watcher_object.version": "1.0",
         "watcher_object.data": {
-          "name": "my_audit",
           "audit_type": "ONESHOT",
           "scope": [],
           "uuid": "10a47dd1-4874-4298-91cf-eff046dbdb8d",

doc/notification_samples/action_plan-delete.json

@@ -8,7 +8,6 @@
       "audit_uuid": "10a47dd1-4874-4298-91cf-eff046dbdb8d",
       "audit": {
         "watcher_object.data": {
-          "name": "my_audit",
           "uuid": "10a47dd1-4874-4298-91cf-eff046dbdb8d",
           "goal_uuid": "bc830f84-8ae3-4fc6-8bc6-e3dd15e8b49a",
           "strategy_uuid": "75234dfe-87e3-4f11-a0e0-3c3305d86a39",

doc/notification_samples/action_plan-execution-end.json

@@ -15,7 +15,6 @@
         "watcher_object.data": {
           "created_at": "2016-10-18T09:52:05Z",
           "deleted_at": null,
-          "name": "my_audit",
           "uuid": "10a47dd1-4874-4298-91cf-eff046dbdb8d",
           "goal_uuid": "bc830f84-8ae3-4fc6-8bc6-e3dd15e8b49a",
           "strategy_uuid": "75234dfe-87e3-4f11-a0e0-3c3305d86a39",
@@ -30,7 +29,7 @@
       "uuid": "76be87bd-3422-43f9-93a0-e85a577e3061",
       "fault": null,
       "state": "ONGOING",
-      "global_efficacy": [],
+      "global_efficacy": {},
       "strategy_uuid": "cb3d0b58-4415-4d90-b75b-1e96878730e3",
       "strategy": {
         "watcher_object.namespace": "watcher",

doc/notification_samples/action_plan-execution-error.json

@@ -45,7 +45,6 @@
         "watcher_object.name": "TerseAuditPayload",
         "watcher_object.data": {
           "parameters": {},
-          "name": "my_audit",
           "uuid": "10a47dd1-4874-4298-91cf-eff046dbdb8d",
           "goal_uuid": "bc830f84-8ae3-4fc6-8bc6-e3dd15e8b49a",
           "strategy_uuid": "75234dfe-87e3-4f11-a0e0-3c3305d86a39",
@@ -58,7 +57,7 @@
           "state": "PENDING"
         }
       },
-      "global_efficacy": [],
+      "global_efficacy": {},
       "state": "ONGOING"
     }
   },

doc/notification_samples/action_plan-execution-start.json

@@ -15,7 +15,6 @@
         "watcher_object.data": {
           "created_at": "2016-10-18T09:52:05Z",
           "deleted_at": null,
-          "name": "my_audit",
           "uuid": "10a47dd1-4874-4298-91cf-eff046dbdb8d",
           "goal_uuid": "bc830f84-8ae3-4fc6-8bc6-e3dd15e8b49a",
           "strategy_uuid": "75234dfe-87e3-4f11-a0e0-3c3305d86a39",
@@ -30,7 +29,7 @@
       "uuid": "76be87bd-3422-43f9-93a0-e85a577e3061",
       "fault": null,
       "state": "ONGOING",
-      "global_efficacy": [],
+      "global_efficacy": {},
       "strategy_uuid": "cb3d0b58-4415-4d90-b75b-1e96878730e3",
       "strategy": {
         "watcher_object.namespace": "watcher",

doc/notification_samples/action_plan-update.json

@@ -6,7 +6,6 @@
       "audit": {
         "watcher_object.version": "1.0",
         "watcher_object.data": {
-          "name": "my_audit",
           "audit_type": "ONESHOT",
           "scope": [],
           "created_at": "2016-10-18T09:52:05Z",

doc/notification_samples/audit-create.json

@@ -2,7 +2,6 @@
   "priority": "INFO",
   "payload": {
     "watcher_object.data": {
-      "name": "my_audit",
       "audit_type": "ONESHOT",
       "parameters": {
         "para2": "hello",

doc/notification_samples/audit-delete.json

@@ -2,7 +2,6 @@
   "priority": "INFO",
   "payload": {
     "watcher_object.data": {
-      "name": "my_audit",
       "audit_type": "ONESHOT",
       "parameters": {
         "para2": "hello",

doc/notification_samples/audit-planner-end.json

@@ -2,7 +2,6 @@
   "priority": "INFO",
   "payload": {
     "watcher_object.data": {
-      "name": "my_audit",
       "audit_type": "ONESHOT",
       "parameters": {
         "para2": "hello",

doc/notification_samples/audit-planner-error.json

@@ -2,7 +2,6 @@
   "priority": "ERROR",
   "payload": {
     "watcher_object.data": {
-      "name": "my_audit",
       "audit_type": "ONESHOT",
       "parameters": {
         "para2": "hello",

doc/notification_samples/audit-planner-start.json

@@ -2,7 +2,6 @@
   "priority": "INFO",
   "payload": {
     "watcher_object.data": {
-      "name": "my_audit",
       "audit_type": "ONESHOT",
       "parameters": {
         "para2": "hello",

doc/notification_samples/audit-strategy-end.json

@@ -2,7 +2,6 @@
   "priority": "INFO",
   "payload": {
     "watcher_object.data": {
-      "name": "my_audit",
       "audit_type": "ONESHOT",
       "parameters": {
         "para2": "hello",

doc/notification_samples/audit-strategy-error.json

@@ -2,7 +2,6 @@
   "priority": "ERROR",
   "payload": {
     "watcher_object.data": {
-      "name": "my_audit",
       "audit_type": "ONESHOT",
       "parameters": {
         "para2": "hello",

doc/notification_samples/audit-strategy-start.json

@@ -2,7 +2,6 @@
   "priority": "INFO",
   "payload": {
     "watcher_object.data": {
-      "name": "my_audit",
       "audit_type": "ONESHOT",
       "parameters": {
         "para2": "hello",