Merge "listen to 'compute.instance.resize.confirm.end' event"

Closes-Bug: #1728477
Change-Id: I39a2672df842b62177fd0c4dbec7b92b398cfb96

.gitignore

@@ -4,8 +4,7 @@
 *.so
 
 # Packages
-*.egg
-*.egg-info
+*.egg*
 dist
 build
 eggs
@@ -25,6 +24,7 @@ pip-log.txt
 .coverage*
 .tox
 nosetests.xml
+.stestr/
 .testrepository
 .venv
 .idea
@@ -43,9 +43,11 @@ output/*/index.html
 
 # Sphinx
 doc/build
-doc/source/api
+doc/source/api/*
 doc/source/samples
-doc/source/watcher.conf.sample
+doc/source/_static/*.sample
+!doc/source/api/index.rst
+!doc/source/api/v1.rst
 
 # pbr generates these
 AUTHORS
@@ -71,3 +73,6 @@ releasenotes/build
 
 # Desktop Service Store
 *.DS_Store
+
+# Autogenerated sample config file
+etc/watcher/watcher.conf.sample

.stestr.conf

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

.zuul.yaml

@@ -0,0 +1,39 @@
+- project:
+    name: openstack/watcher
+    check:
+      jobs:
+        - watcher-tempest-multinode
+        - legacy-rally-dsvm-watcher-rally
+
+- job:
+    name: watcher-tempest-base-multinode
+    parent: legacy-dsvm-base-multinode
+    run: playbooks/legacy/watcher-tempest-base-multinode/run.yaml
+    post-run: playbooks/legacy/watcher-tempest-base-multinode/post.yaml
+    timeout: 4200
+    required-projects:
+      - openstack-infra/devstack-gate
+      - openstack/python-openstackclient
+      - openstack/python-watcherclient
+      - openstack/watcher
+      - openstack/watcher-tempest-plugin
+    nodeset: legacy-ubuntu-xenial-2-node
+
+- job:
+    name: watcher-tempest-multinode
+    parent: watcher-tempest-base-multinode
+    voting: false
+
+- job:
+    # This job is used by python-watcherclient repo
+    name: watcherclient-tempest-functional
+    parent: legacy-dsvm-base
+    run: playbooks/legacy/watcherclient-tempest-functional/run.yaml
+    post-run: playbooks/legacy/watcherclient-tempest-functional/post.yaml
+    timeout: 4200
+    required-projects:
+      - openstack-dev/devstack
+      - openstack-infra/devstack-gate
+      - openstack/python-openstackclient
+      - openstack/python-watcherclient
+      - openstack/watcher

README.rst

@@ -28,4 +28,4 @@ migration, increased energy efficiency-and more!
 * Wiki: https://wiki.openstack.org/wiki/Watcher
 * Source:  https://github.com/openstack/watcher
 * Bugs: https://bugs.launchpad.net/watcher
-* Documentation: https://docs.openstack.org/developer/watcher/
+* Documentation: https://docs.openstack.org/watcher/latest/

devstack/lib/watcher

@@ -235,7 +235,7 @@ function init_watcher {
         recreate_database watcher
 
         # Create watcher schema
-        $WATCHER_BIN_DIR/watcher-db-manage --config-file $WATCHER_CONF upgrade head
+        $WATCHER_BIN_DIR/watcher-db-manage --config-file $WATCHER_CONF upgrade
     fi
     create_watcher_cache_dir
 }

devstack/local.conf.controller

@@ -24,13 +24,6 @@ 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 git://git.openstack.org/openstack/watcher-dashboard
 
@@ -42,11 +35,12 @@ enable_plugin ceilometer git://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
 
 # Enable the Gnocchi plugin
-enable_plugin gnocchi https://git.openstack.org/openstack/gnocchi
+enable_plugin gnocchi https://github.com/gnocchixyz/gnocchi
 
 LOGFILE=$DEST/logs/stack.sh.log
 LOGDAYS=2

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..."
-source $DEST/watcher/devstack/lib/watcher
+. $DEST/watcher/devstack/lib/watcher
 
 # Show all of defined environment variables
 (set -o posix; set)

doc/ext/term.py

@@ -22,7 +22,7 @@ from docutils import nodes
 from docutils.parsers import rst
 from docutils import statemachine
 
-from watcher.version import version_info
+from watcher.version import version_string
 
 
 class BaseWatcherDirective(rst.Directive):
@@ -169,4 +169,4 @@ class WatcherFunc(BaseWatcherDirective):
 def setup(app):
     app.add_directive('watcher-term', WatcherTerm)
     app.add_directive('watcher-func', WatcherFunc)
-    return {'version': version_info.version_string()}
+    return {'version': version_string}

doc/notification_samples/action-cancel-end.json

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

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

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

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

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

@@ -0,0 +1,55 @@
+{
+  "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,6 +23,7 @@
       "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,6 +8,7 @@
       "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,6 +15,7 @@
         "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",
@@ -29,7 +30,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,6 +45,7 @@
         "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",
@@ -57,7 +58,7 @@
           "state": "PENDING"
         }
       },
-      "global_efficacy": {},
+      "global_efficacy": [],
       "state": "ONGOING"
     }
   },

doc/notification_samples/action_plan-execution-start.json

@@ -15,6 +15,7 @@
         "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",
@@ -29,7 +30,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,6 +6,7 @@
       "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,6 +2,7 @@
   "priority": "INFO",
   "payload": {
     "watcher_object.data": {
+      "name": "my_audit",
       "audit_type": "ONESHOT",
       "parameters": {
         "para2": "hello",

doc/notification_samples/audit-delete.json

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

doc/notification_samples/audit-planner-end.json

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

doc/notification_samples/audit-planner-error.json

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

doc/notification_samples/audit-planner-start.json

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

doc/notification_samples/audit-strategy-end.json

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

doc/notification_samples/audit-strategy-error.json

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

doc/notification_samples/audit-strategy-start.json

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

doc/notification_samples/audit-update.json

@@ -4,6 +4,7 @@
   "payload": {
     "watcher_object.name": "AuditUpdatePayload",
     "watcher_object.data": {
+      "name": "my_audit",
       "strategy_uuid": "75234dfe-87e3-4f11-a0e0-3c3305d86a39",
       "strategy": {
         "watcher_object.name": "StrategyPayload",

doc/source/admin/index.rst

@@ -0,0 +1,12 @@
+===================
+Administrator Guide
+===================
+
+.. toctree::
+   :maxdepth: 2
+
+   apache-mod-wsgi
+   gmr
+   policy
+   ways-to-install
+   ../strategies/index

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

@@ -4,12 +4,13 @@
 
           https://creativecommons.org/licenses/by/3.0/
 
-==================
-Installing Watcher
-==================
+=======================
+Ways to install Watcher
+=======================
 
-This document describes how to install Watcher in order to use it. If you are
-intending to develop on or with Watcher, please read :doc:`../dev/environment`.
+This document describes some ways to install Watcher in order to use it.
+If you are intending to develop on or with Watcher,
+please read :doc:`../contributor/environment`.
 
 Prerequisites
 -------------
@@ -77,9 +78,10 @@ Install the Watcher modules dependencies:
 
     # pip install -r requirements.txt
 
-From here, refer to :doc:`configuration` to declare Watcher as a new service
-into Keystone and to configure its different modules. Once configured, you
-should be able to run the Watcher services by issuing these commands:
+From here, refer to :doc:`../configuration/configuring` to declare Watcher
+as a new service into Keystone and to configure its different modules.
+Once configured, you should be able to run the Watcher services by issuing
+these commands:
 
 .. code-block:: bash
 
@@ -107,7 +109,7 @@ installed on your system.
 
 Once installed, you still need to declare Watcher as a new service into
 Keystone and to configure its different modules, which you can find described
-in :doc:`configuration`.
+in :doc:`../configuration/configuring`.
 
 
 Installing from packages: Debian (experimental)
@@ -124,9 +126,9 @@ Here is single Dockerfile snippet you can use to run your Docker container:
     MAINTAINER David TARDIVEL <david.tardivel@b-com.com>
 
     RUN  apt-get update
-    RUN  apt-get dist-upgrade -y
-    RUN  apt-get install -y vim  net-tools
-    RUN  apt-get install -yt experimental watcher-api
+    RUN  apt-get dist-upgrade
+    RUN  apt-get install vim  net-tools
+    RUN  apt-get install experimental watcher-api
 
     CMD ["/usr/bin/watcher-api"]
 

doc/source/api/index.rst

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

doc/source/api/v1.rst

@@ -20,6 +20,17 @@ Goals
 .. autotype:: watcher.api.controllers.v1.goal.Goal
    :members:
 
+Strategies
+==========
+
+.. rest-controller:: watcher.api.controllers.v1.strategy:StrategiesController
+   :webprefix: /v1/strategies
+
+.. autotype:: watcher.api.controllers.v1.strategy.StrategyCollection
+   :members:
+
+.. autotype:: watcher.api.controllers.v1.strategy.Strategy
+   :members:
 
 Audit Templates
 ===============
@@ -75,3 +86,15 @@ Actions
 
 .. autotype:: watcher.api.controllers.v1.action.Action
    :members:
+
+Scoring Engine
+==============
+
+.. rest-controller:: watcher.api.controllers.v1.scoring_engine:ScoringEngineController
+   :webprefix: /v1/scoring_engine
+
+.. autotype:: watcher.api.controllers.v1.scoring_engine.ScoringEngineCollection
+   :members:
+
+.. autotype:: watcher.api.controllers.v1.scoring_engine.ScoringEngine
+   :members:

doc/source/architecture.rst

@@ -119,7 +119,7 @@ The watcher command-line interface (CLI) can be used to interact with the
 Watcher system in order to control it or to know its current status.
 
 Please, read `the detailed documentation about Watcher CLI
-<https://factory.b-com.com/www/watcher/doc/python-watcherclient/>`_.
+<https://docs.openstack.org/python-watcherclient/latest/cli/>`_.
 
 .. _archi_watcher_dashboard_definition:
 
@@ -130,7 +130,7 @@ The Watcher Dashboard can be used to interact with the Watcher system through
 Horizon in order to control it or to know its current status.
 
 Please, read `the detailed documentation about Watcher Dashboard
-<http://docs.openstack.org/developer/watcher-dashboard/>`_.
+<https://docs.openstack.org/watcher-dashboard/latest>`_.
 
 .. _archi_watcher_database_definition:
 
@@ -170,7 +170,7 @@ Unless specified, it then selects the most appropriate :ref:`strategy
 goal.
 
 The :ref:`Strategy <strategy_definition>` is then dynamically loaded (via
-`stevedore <http://docs.openstack.org/developer/stevedore/>`_). The
+`stevedore <https://docs.openstack.org/stevedore/latest>`_). The
 :ref:`Watcher Decision Engine <watcher_decision_engine_definition>` executes
 the strategy.
 

doc/source/conf.py

@@ -31,8 +31,7 @@ sys.path.insert(0, os.path.abspath('./'))
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
 extensions = [
-    'oslo_config.sphinxconfiggen',
-    'oslosphinx',
+    'oslo_config.sphinxext',
     'sphinx.ext.autodoc',
     'sphinx.ext.viewcode',
     'sphinxcontrib.httpdomain',
@@ -41,10 +40,14 @@ extensions = [
     'wsmeext.sphinxext',
     'ext.term',
     'ext.versioned_notifications',
+    'oslo_config.sphinxconfiggen',
+    'openstackdocstheme',
 ]
 
 wsme_protocols = ['restjson']
-config_generator_config_file = '../../etc/watcher/watcher-config-generator.conf'
+config_generator_config_file = [(
+    '../../etc/watcher/oslo-config-generator/watcher.conf',
+    '_static/watcher')]
 sample_config_basename = 'watcher'
 
 # autodoc generation is a bit aggressive and a nuisance when doing heavy
@@ -69,7 +72,7 @@ copyright = u'OpenStack Foundation'
 # The full version, including alpha/beta/rc tags.
 release = watcher_version.version_info.release_string()
 # The short X.Y version.
-version = watcher_version.version_info.version_string()
+version = watcher_version.version_string
 
 # A list of ignored prefixes for module index sorting.
 modindex_common_prefix = ['watcher.']
@@ -92,6 +95,8 @@ add_function_parentheses = True
 # unit titles (such as .. function::).
 add_module_names = True
 
+suppress_warnings = ['app.add_directive']
+
 # The name of the Pygments (syntax highlighting) style to use.
 pygments_style = 'sphinx'
 
@@ -117,12 +122,20 @@ man_pages = [
 # Sphinx are currently 'default' and 'sphinxdoc'.
 # html_theme_path = ["."]
 # html_theme = '_theme'
+html_theme = 'openstackdocs'
 # html_static_path = ['static']
-html_theme_options = {'incubating': True}
+# html_theme_options = {}
 
 # Output file base name for HTML help builder.
 htmlhelp_basename = '%sdoc' % project
 
+html_last_updated_fmt = '%Y-%m-%d %H:%M'
+
+#openstackdocstheme options
+repository_name = 'openstack/watcher'
+bug_project = 'watcher'
+bug_tag = ''
+
 # Grouping the document tree into LaTeX files. List of tuples
 # (source start file, target name, title, author, documentclass
 # [howto/manual]).

doc/source/config-generator.conf

@@ -1 +0,0 @@
-../../etc/watcher/watcher-config-generator.conf

doc/source/configuration/configuring.rst

@@ -15,7 +15,7 @@ Service overview
 ================
 
 The Watcher system is a collection of services that provides support to
-optimize your IAAS platform. The Watcher service may, depending upon
+optimize your IaaS platform. The Watcher service may, depending upon
 configuration, interact with several other OpenStack services. This includes:
 
 - the OpenStack Identity service (`keystone`_) for request authentication and
@@ -27,7 +27,7 @@ configuration, interact with several other OpenStack services. This includes:
 
 The Watcher service includes the following components:
 
-- ``watcher-decision-engine``: runs audit on part of your IAAS and return an
+- ``watcher-decision-engine``: runs audit on part of your IaaS and return an
   action plan in order to optimize resource placement.
 - ``watcher-api``: A RESTful API that processes application requests by sending
   them to the watcher-decision-engine over RPC.
@@ -349,7 +349,7 @@ so that the watcher service is configured for your needs.
     [nova_client]
 
     # Version of Nova API to use in novaclient. (string value)
-    #api_version = 2
+    #api_version = 2.53
     api_version = 2.1
 
 #. Create the Watcher Service database tables::
@@ -366,15 +366,14 @@ Configure Nova compute
 Please check your hypervisor configuration to correctly handle
 `instance migration`_.
 
-.. _`instance migration`: http://docs.openstack.org/admin-guide/compute-live-migration-usage.html
+.. _`instance migration`: https://docs.openstack.org/nova/latest/admin/migration.html
 
 Configure Measurements
 ======================
 
 You can configure and install Ceilometer by following the documentation below :
 
-#. http://docs.openstack.org/developer/ceilometer
-#. http://docs.openstack.org/kilo/install-guide/install/apt/content/ceilometer-nova.html
+#. https://docs.openstack.org/ceilometer/latest
 
 The built-in strategy 'basic_consolidation' provided by watcher requires
 "**compute.node.cpu.percent**" and "**cpu_util**" measurements to be collected
@@ -386,13 +385,13 @@ the OpenStack site.
 You can use 'ceilometer meter-list' to list the available meters.
 
 For more information:
-http://docs.openstack.org/developer/ceilometer/measurements.html
+https://docs.openstack.org/ceilometer/latest/admin/telemetry-measurements.html
 
 Ceilometer is designed to collect measurements from OpenStack services and from
 other external components. If you would like to add new meters to the currently
 existing ones, you need to follow the documentation below:
 
-#. http://docs.openstack.org/developer/ceilometer/new_meters.html
+#. https://docs.openstack.org/ceilometer/latest/contributor/new_meters.html#meters
 
 The Ceilometer collector uses a pluggable storage system, meaning that you can
 pick any database system you prefer.
@@ -430,6 +429,26 @@ to Watcher receives Nova notifications in ``watcher_notifications`` as well.
   * Restart the Nova services.
 
 
+Configure Cinder Notifications
+==============================
+
+Watcher can also consume notifications generated by the Cinder services, in
+order to build or update, in real time, its cluster data model related to
+storage resources. To do so, you have to update the Cinder configuration
+file on controller and volume nodes, in order to let Watcher receive Cinder
+notifications in a dedicated ``watcher_notifications`` channel.
+
+  * In the file ``/etc/cinder/cinder.conf``, update the section
+    ``[oslo_messaging_notifications]``, by redefining the list of topics
+    into which Cinder services will publish events ::
+
+      [oslo_messaging_notifications]
+      driver = messagingv2
+      topics = notifications,watcher_notifications
+
+  * Restart the Cinder services.
+
+
 Workers
 =======
 

doc/source/configuration/index.rst

@@ -0,0 +1,5 @@
+.. toctree::
+   :maxdepth: 1
+
+   configuring
+   watcher

doc/source/configuration/watcher.rst

@@ -0,0 +1,11 @@
+.. _watcher_sample_configuration_files:
+
+------------
+watcher.conf
+------------
+
+The ``watcher.conf`` file contains most of the options to configure the
+Watcher services.
+
+.. show-options::
+   :config-file: etc/watcher/oslo-config-generator/watcher.conf

doc/source/contributor/contributing.rst

@@ -24,8 +24,8 @@ signed OpenStack's contributor's agreement.
 
 .. seealso::
 
-   * http://docs.openstack.org/infra/manual/developers.html
-   * http://wiki.openstack.org/CLA
+   * https://docs.openstack.org/infra/manual/developers.html
+   * https://wiki.openstack.org/CLA
 
 LaunchPad Project
 -----------------
@@ -37,22 +37,22 @@ notifications of important events.
 
 .. seealso::
 
-   * http://launchpad.net
-   * http://launchpad.net/watcher
-   * http://launchpad.net/~openstack
+   * https://launchpad.net
+   * https://launchpad.net/watcher
+   * https://launchpad.net/~openstack
 
 
 Project Hosting Details
 -----------------------
 
 Bug tracker
-    http://launchpad.net/watcher
+    https://launchpad.net/watcher
 
 Mailing list (prefix subjects with ``[watcher]`` for faster responses)
-    http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
+    https://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
 
 Wiki
-    http://wiki.openstack.org/Watcher
+    https://wiki.openstack.org/Watcher
 
 Code Hosting
     https://git.openstack.org/cgit/openstack/watcher
@@ -64,8 +64,9 @@ IRC Channel
     ``#openstack-watcher`` (changelog_)
 
 Weekly Meetings
-    on Wednesdays at 14:00 UTC on even weeks, 9:00 UTC on odd weeks, in the
-    ``#openstack-meeting-4`` IRC channel (`meetings logs`_)
+    On Wednesdays at 14:00 UTC on even weeks in the ``#openstack-meeting-4``
+    IRC channel, 13:00 UTC on odd weeks in the ``#openstack-meeting-alt``
+    IRC channel (`meetings logs`_)
 
 .. _changelog: http://eavesdrop.openstack.org/irclogs/%23openstack-watcher/
 .. _meetings logs:  http://eavesdrop.openstack.org/meetings/watcher/

doc/source/contributor/devstack.rst

@@ -24,8 +24,8 @@ Watcher plugin::
 For more detailed instructions, see `Detailed DevStack Instructions`_. Check
 out the `DevStack documentation`_ for more information regarding DevStack.
 
-.. _PluginModelDocs: http://docs.openstack.org/developer/devstack/plugins.html
-.. _DevStack documentation: http://docs.openstack.org/developer/devstack/
+.. _PluginModelDocs: https://docs.openstack.org/devstack/latest/plugins.html
+.. _DevStack documentation: https://docs.openstack.org/devstack/latest
 
 Detailed DevStack Instructions
 ==============================
@@ -37,7 +37,7 @@ Detailed DevStack Instructions
    needed (i.e., no computes are needed if you want to just experiment with
    the Watcher services). These servers can be VMs running on your local
    machine via VirtualBox if you prefer. DevStack currently recommends that
-   you use Ubuntu 14.04 LTS. The servers should also have connections to the
+   you use Ubuntu 16.04 LTS. The servers should also have connections to the
    same network such that they are all able to communicate with one another.
 
 #. For each server, clone the DevStack repository and create the stack user::

doc/source/contributor/environment.rst

@@ -4,7 +4,7 @@
 
           https://creativecommons.org/licenses/by/3.0/
 
-.. _watcher_developement_environment:
+.. _watcher_development_environment:
 
 =========================================
 Set up a development environment manually
@@ -17,7 +17,7 @@ To install Watcher from packaging, refer instead to Watcher `User
 Documentation`_.
 
 .. _`Git Repository`: https://git.openstack.org/cgit/openstack/watcher
-.. _`User Documentation`: https://docs.openstack.org/developer/watcher/
+.. _`User Documentation`: https://docs.openstack.org/watcher/latest/
 
 Prerequisites
 =============
@@ -25,7 +25,7 @@ Prerequisites
 This document assumes you are using Ubuntu or Fedora, and that you have the
 following tools available on your system:
 
-- Python_ 2.7 and 3.4
+- Python_ 2.7 and 3.5
 - git_
 - setuptools_
 - pip_
@@ -69,21 +69,21 @@ itself.
 
 These dependencies can be installed from PyPi_ using the Python tool pip_.
 
-.. _PyPi: http://pypi.python.org/
-.. _pip: http://pypi.python.org/pypi/pip
+.. _PyPi: https://pypi.python.org/
+.. _pip: https://pypi.python.org/pypi/pip
 
 However, your system *may* need additional dependencies that `pip` (and by
 extension, PyPi) cannot satisfy. These dependencies should be installed
 prior to using `pip`, and the installation method may vary depending on
 your platform.
 
-* Ubuntu 14.04::
+* Ubuntu 16.04::
 
     $ sudo apt-get install python-dev libssl-dev libmysqlclient-dev libffi-dev
 
-* Fedora 19+::
+* Fedora 24+::
 
-    $ sudo yum install openssl-devel libffi-devel mysql-devel
+    $ sudo dnf install redhat-rpm-config gcc python-devel libxml2-devel
 
 * CentOS 7::
 
@@ -125,7 +125,7 @@ You can re-activate this virtualenv for your current shell using:
 
 For more information on virtual environments, see virtualenv_.
 
-.. _virtualenv: http://www.virtualenv.org/
+.. _virtualenv: https://www.virtualenv.org/
 
 
 
@@ -194,7 +194,7 @@ still need to configure the following sections:
   message bus
 
 So if you need some more details on how to configure one or more of these
-sections, please do have a look at :doc:`../deploy/configuration` before
+sections, please do have a look at :doc:`../configuration/configuring` before
 continuing.
 
 
@@ -240,7 +240,7 @@ To run the Watcher Applier service, use:
     (watcher) $ watcher-applier
 
 Default configuration of these services are available into ``/etc/watcher``
-directory. See :doc:`../deploy/configuration` for details on how Watcher is
+directory. See :doc:`../configuration/configuring` for details on how Watcher is
 configured. By default, Watcher is configured with SQL backends.
 
 

doc/source/contributor/index.rst

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

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

@@ -178,7 +178,7 @@ Here below is how you would proceed to register ``DummyAction`` using pbr_:
     watcher_actions =
         dummy = thirdparty.dummy:DummyAction
 
-.. _pbr: http://docs.openstack.org/developer/pbr/
+.. _pbr: https://docs.openstack.org/pbr/latest
 
 
 Using action plugins
@@ -217,3 +217,11 @@ which is only able to process the Watcher built-in actions. Therefore, you will
 either have to use an existing third-party planner or :ref:`implement another
 planner <implement_planner_plugin>` that will be able to take into account your
 new action plugin.
+
+
+Test your new action
+====================
+
+In order to test your new action via a manual test or a Tempest test, you can
+use the  :py:class:`~.Actuator` strategy and pass it one or more actions to
+execute. This way, you can isolate your action to see if it works as expected.

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

@@ -22,7 +22,7 @@ Pre-requisites
 We assume that you have set up a working Watcher development environment. So if
 this not already the case, you can check out our documentation which explains
 how to set up a :ref:`development environment
-<watcher_developement_environment>`.
+<watcher_development_environment>`.
 
 .. _development environment:
 
@@ -34,7 +34,7 @@ First off, we need to create the project structure. To do so, we can use
 generate the skeleton of our project::
 
     $ virtualenv thirdparty
-    $ source thirdparty/bin/activate
+    $ . thirdparty/bin/activate
     $ pip install cookiecutter
     $ cookiecutter https://github.com/openstack-dev/cookiecutter
 

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

@@ -28,6 +28,8 @@ In order to create a new cluster data model collector, you have to:
 - Implement its :py:meth:`~.BaseClusterDataModelCollector.execute` abstract
   method to return your entire cluster data model that this method should
   build.
+- Implement its :py:meth:`~.BaseClusterDataModelCollector.audit_scope_handler`
+  abstract property to return your audit scope handler.
 - Implement its :py:meth:`~.Goal.notification_endpoints` abstract property to
   return the list of all the :py:class:`~.base.NotificationEndpoint` instances
   that will be responsible for handling incoming notifications in order to
@@ -57,6 +59,10 @@ Here is an example showing how you can write a plugin called
             # Do something here...
             return model
 
+        @property
+        def audit_scope_handler(self):
+            return None
+
         @property
         def notification_endpoints(self):
             return []
@@ -135,6 +141,10 @@ class method as followed:
             # Do something here...
             return model
 
+        @property
+        def audit_scope_handler(self):
+            return None
+
         @property
         def notification_endpoints(self):
             return []
@@ -198,7 +208,7 @@ Here below is how to register ``DummyClusterDataModelCollector`` using pbr_:
     watcher_cluster_data_model_collectors =
         dummy = thirdparty.dummy:DummyClusterDataModelCollector
 
-.. _pbr: http://docs.openstack.org/developer/pbr/
+.. _pbr: http://docs.openstack.org/pbr/latest
 
 
 Add new notification endpoints

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

@@ -123,10 +123,11 @@ Here below is how you would proceed to register ``NewGoal`` using pbr_:
         new_goal = thirdparty.new:NewGoal
 
 
-To get a better understanding on how to implement a more advanced goal,
-have a look at the :py:class:`~.ServerConsolidation` class.
+To get a better understanding on how to implement a more advanced goal, have
+a look at the
+:py:class:`watcher.decision_engine.goal.goals.ServerConsolidation` class.
 
-.. _pbr: http://docs.openstack.org/developer/pbr/
+.. _pbr: https://docs.openstack.org/pbr/latest
 
 .. _implement_efficacy_specification:
 

doc/source/contributor/plugin/index.rst

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

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

@@ -145,7 +145,7 @@ Here below is how you would proceed to register ``DummyPlanner`` using pbr_:
     watcher_planners =
         dummy = third_party.dummy:DummyPlanner
 
-.. _pbr: http://docs.openstack.org/developer/pbr/
+.. _pbr: https://docs.openstack.org/pbr/latest
 
 
 Using planner plugins

doc/source/contributor/plugin/scoring-engine-plugin.rst

@@ -37,7 +37,8 @@ Create a new scoring engine plugin
 
 In order to create a new scoring engine you have to:
 
-- Extend the :py:class:`~.ScoringEngine` class
+- Extend the :py:class:`watcher.decision_engine.scoring.base.ScoringEngine`
+  class
 - Implement its :py:meth:`~.ScoringEngine.get_name` method to return the
   **unique** ID of the new scoring engine you want to create. This unique ID
   should be the same as the name of :ref:`the entry point we will declare later
@@ -124,7 +125,8 @@ scoring engine deployed as a web service on external servers:
 Abstract Plugin Class
 =====================
 
-Here below is the abstract :py:class:`~.ScoringEngine` class:
+Here below is the abstract
+:py:class:`watcher.decision_engine.scoring.base.ScoringEngine` class:
 
 .. autoclass:: watcher.decision_engine.scoring.base.ScoringEngine
     :members:
@@ -188,7 +190,7 @@ the :py:class:`~.DummyScoringContainer` and the way it is configured in
     watcher_scoring_engine_containers =
         new_scoring_container = thirdparty.new:NewContainer
 
-.. _pbr: http://docs.openstack.org/developer/pbr/
+.. _pbr: https://docs.openstack.org/pbr/latest/
 
 
 Using scoring engine plugins

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

@@ -219,7 +219,7 @@ Here below is how you would proceed to register ``NewStrategy`` using pbr_:
 To get a better understanding on how to implement a more advanced strategy,
 have a look at the :py:class:`~.BasicConsolidation` class.
 
-.. _pbr: http://docs.openstack.org/developer/pbr/
+.. _pbr: https://docs.openstack.org/pbr/latest
 
 Using strategy plugins
 ======================
@@ -264,11 +264,11 @@ requires new metrics not covered by Ceilometer, you can add them through a
 
 
 .. _`Helper`: https://github.com/openstack/watcher/blob/master/watcher/decision_engine/cluster/history/ceilometer.py
-.. _`Ceilometer developer guide`: http://docs.openstack.org/developer/ceilometer/architecture.html#storing-the-data
-.. _`Ceilometer`: http://docs.openstack.org/developer/ceilometer/
+.. _`Ceilometer developer guide`: https://docs.openstack.org/ceilometer/latest/contributor/architecture.html#storing-accessing-the-data
+.. _`Ceilometer`: https://docs.openstack.org/ceilometer/latest
 .. _`Monasca`: https://github.com/openstack/monasca-api/blob/master/docs/monasca-api-spec.md
-.. _`here`: http://docs.openstack.org/developer/ceilometer/install/dbreco.html#choosing-a-database-backend
-.. _`Ceilometer plugin`: http://docs.openstack.org/developer/ceilometer/plugins.html
+.. _`here`: https://docs.openstack.org/ceilometer/latest/contributor/install/dbreco.html#choosing-a-database-backend
+.. _`Ceilometer plugin`: https://docs.openstack.org/ceilometer/latest/contributor/plugins.html
 .. _`Ceilosca`: https://github.com/openstack/monasca-ceilometer/blob/master/ceilosca/ceilometer/storage/impl_monasca.py
 
 Read usage metrics using the Watcher Datasource Helper

doc/source/contributor/testing.rst

@@ -41,10 +41,18 @@ you can run the desired test::
     $ workon watcher
     (watcher) $ tox -e py27 -- -r watcher.tests.api
 
-.. _os-testr: http://docs.openstack.org/developer/os-testr/
+.. _os-testr: https://docs.openstack.org/os-testr/latest
 
 When you're done, deactivate the virtualenv::
 
     $ deactivate
 
-.. include:: ../../../watcher_tempest_plugin/README.rst
+.. _tempest_tests:
+
+Tempest tests
+=============
+
+Tempest tests for Watcher has been migrated to the external repo
+`watcher-tempest-plugin`_.
+
+.. _watcher-tempest-plugin: https://github.com/openstack/watcher-tempest-plugin

doc/source/deploy/conf-files.rst

@@ -1,14 +0,0 @@
-.. _watcher_sample_configuration_files:
-
-==================================
-Watcher sample configuration files
-==================================
-
-watcher.conf
-~~~~~~~~~~~~
-
-The ``watcher.conf`` file contains most of the options to configure the
-Watcher services.
-
-.. literalinclude:: ../watcher.conf.sample
-   :language: ini

doc/source/glossary.rst

@@ -65,6 +65,14 @@ Audit
 
 .. _audit_template_definition:
 
+Audit Scope
+===========
+
+An Audit Scope is a set of audited resources. Audit Scope should be defined
+in each Audit Template (which contains the Audit settings).
+
+.. _audit_scope_definition:
+
 Audit Template
 ==============
 
@@ -75,7 +83,7 @@ Audit Template
 Availability Zone
 =================
 
-Please, read `the official OpenStack definition of an Availability Zone <http://docs.openstack.org/developer/nova/aggregates.html#availability-zones-azs>`_.
+Please, read `the official OpenStack definition of an Availability Zone <https://docs.openstack.org/nova/latest/user/aggregates.html#availability-zones-azs>`_.
 
 .. _cluster_definition:
 
@@ -107,15 +115,8 @@ Cluster Data Model (CDM)
 Controller Node
 ===============
 
-A controller node is a machine that typically runs the following core OpenStack
-services:
-
--  Keystone: for identity and service management
--  Cinder scheduler: for volumes management
--  Glance controller: for image management
--  Neutron controller: for network management
--  Nova controller: for global compute resources management with services
-   such as nova-scheduler, nova-conductor and nova-network.
+Please, read `the official OpenStack definition of a Controller Node
+<https://docs.openstack.org/nova/latest/install/overview.html#controller>`_.
 
 In many configurations, Watcher will reside on a controller node even if it
 can potentially be hosted on a dedicated machine.
@@ -126,7 +127,7 @@ Compute node
 ============
 
 Please, read `the official OpenStack definition of a Compute Node
-<http://docs.openstack.org/ops-guide/arch-compute-nodes.html>`_.
+<https://docs.openstack.org/nova/latest/install/overview.html#compute>`_.
 
 .. _customer_definition:
 
@@ -159,7 +160,7 @@ Host Aggregate
 ==============
 
 Please, read `the official OpenStack definition of a Host Aggregate
-<http://docs.openstack.org/developer/nova/aggregates.html>`_.
+<https://docs.openstack.org/nova/latest/user/aggregates.html>`_.
 
 .. _instance_definition:
 
@@ -198,18 +199,18 @@ the Watcher system can act on.
 Here are some examples of
 :ref:`Managed resource types <managed_resource_definition>`:
 
--  `Nova Host Aggregates <http://docs.openstack.org/developer/heat/template_guide/openstack.html#OS::Nova::HostAggregate>`_
--  `Nova Servers <http://docs.openstack.org/developer/heat/template_guide/openstack.html#OS::Nova::Server>`_
--  `Cinder Volumes <http://docs.openstack.org/developer/heat/template_guide/openstack.html#OS::Cinder::Volume>`_
--  `Neutron Routers <http://docs.openstack.org/developer/heat/template_guide/openstack.html#OS::Neutron::Router>`_
--  `Neutron Networks <http://docs.openstack.org/developer/heat/template_guide/openstack.html#OS::Neutron::Net>`_
--  `Neutron load-balancers <http://docs.openstack.org/developer/heat/template_guide/openstack.html#OS::Neutron::LoadBalancer>`_
--  `Sahara Hadoop Cluster <http://docs.openstack.org/developer/heat/template_guide/openstack.html#OS::Sahara::Cluster>`_
+-  `Nova Host Aggregates <https://docs.openstack.org/heat/latest/template_guide/openstack.html#OS::Nova::HostAggregate>`_
+-  `Nova Servers <https://docs.openstack.org/heat/latest/template_guide/openstack.html#OS::Nova::Server>`_
+-  `Cinder Volumes <https://docs.openstack.org/heat/latest/template_guide/openstack.html#OS::Cinder::Volume>`_
+-  `Neutron Routers <https://docs.openstack.org/heat/latest/template_guide/openstack.html#OS::Neutron::Router>`_
+-  `Neutron Networks <https://docs.openstack.org/heat/latest/template_guide/openstack.html#OS::Neutron::Net>`_
+-  `Neutron load-balancers <https://docs.openstack.org/heat/latest/template_guide/openstack.html#OS::Neutron::LoadBalancer>`_
+-  `Sahara Hadoop Cluster <https://docs.openstack.org/heat/latest/template_guide/openstack.html#OS::Sahara::Cluster>`_
 -  ...
 
-It can be any of the `the official list of available resource types defined in
+It can be any of `the official list of available resource types defined in
 OpenStack for HEAT
-<http://docs.openstack.org/developer/heat/template_guide/openstack.html>`_.
+<https://docs.openstack.org/heat/latest/template_guide/openstack.html>`_.
 
 .. _efficacy_indicator_definition:
 

doc/source/image_src/plantuml/action_plan_state_machine.txt

@@ -7,7 +7,9 @@ ONGOING --> FAILED: Something failed while executing\nthe Action Plan in the Wat
 ONGOING --> SUCCEEDED: The Watcher Applier executed\nthe Action Plan successfully
 FAILED --> DELETED : Administrator removes\nAction Plan
 SUCCEEDED --> DELETED : Administrator removes\nAction Plan
-ONGOING --> CANCELLED : Administrator cancels\nAction Plan
+ONGOING --> CANCELLING : Administrator cancels\nAction Plan
+CANCELLING --> CANCELLED : The Watcher Applier cancelled\nthe Action Plan successfully
+CANCELLING --> FAILED : Something failed while cancelling\nthe Action Plan in the Watcher Applier
 RECOMMENDED --> CANCELLED : Administrator cancels\nAction Plan
 RECOMMENDED --> SUPERSEDED : The Watcher Decision Engine supersedes\nAction Plan
 PENDING --> CANCELLED : Administrator cancels\nAction Plan

doc/source/image_src/plantuml/watcher_db_schema_diagram.txt

@@ -75,7 +75,7 @@ table(action_plans) {
     foreign_key("strategy_id : Integer")
     uuid : String[36]
     state : String[20], nullable
-    global_efficacy : JSONEncodedDict, nullable
+    global_efficacy : JSONEncodedList, nullable
 
     created_at : DateTime
     updated_at : DateTime

doc/source/images/architecture.svg

@@ -13,7 +13,7 @@
    height="210mm"
    id="svg4946"
    version="1.1"
-   inkscape:version="0.48.4 r9939"
+   inkscape:version="0.91 r13725"
    sodipodi:docname="architecture.svg">
   <defs
      id="defs4948">
@@ -325,6 +325,48 @@
          style="fill:#ffffff;fill-rule:evenodd;stroke:#000000;stroke-width:1pt"
          transform="matrix(-0.8,0,0,-0.8,4.8,0)" />
     </marker>
+    <marker
+       inkscape:stockid="EmptyTriangleInL"
+       orient="auto"
+       refY="0"
+       refX="0"
+       id="EmptyTriangleInL-5"
+       style="overflow:visible">
+      <path
+         inkscape:connector-curvature="0"
+         id="path7091-3"
+         d="m 5.77,0 -8.65,5 0,-10 8.65,5 z"
+         style="fill:#ffffff;fill-rule:evenodd;stroke:#000000;stroke-width:1pt"
+         transform="matrix(-0.8,0,0,-0.8,4.8,0)" />
+    </marker>
+    <marker
+       inkscape:stockid="EmptyTriangleInL"
+       orient="auto"
+       refY="0"
+       refX="0"
+       id="EmptyTriangleInL-6"
+       style="overflow:visible">
+      <path
+         inkscape:connector-curvature="0"
+         id="path7091-2"
+         d="m 5.77,0 -8.65,5 0,-10 8.65,5 z"
+         style="fill:#ffffff;fill-rule:evenodd;stroke:#000000;stroke-width:1pt"
+         transform="matrix(-0.8,0,0,-0.8,4.8,0)" />
+    </marker>
+    <marker
+       inkscape:stockid="EmptyTriangleInL"
+       orient="auto"
+       refY="0"
+       refX="0"
+       id="EmptyTriangleInL-12"
+       style="overflow:visible">
+      <path
+         inkscape:connector-curvature="0"
+         id="path7091-70"
+         d="m 5.77,0 -8.65,5 0,-10 8.65,5 z"
+         style="fill:#ffffff;fill-rule:evenodd;stroke:#000000;stroke-width:1pt"
+         transform="matrix(-0.8,0,0,-0.8,4.8,0)" />
+    </marker>
   </defs>
   <sodipodi:namedview
      inkscape:document-units="mm"
@@ -333,17 +375,21 @@
      borderopacity="1.0"
      inkscape:pageopacity="0.0"
      inkscape:pageshadow="2"
-     inkscape:zoom="4"
-     inkscape:cx="261.24633"
+     inkscape:zoom="1.4142136"
+     inkscape:cx="665.19215"
      inkscape:cy="108.90512"
-     inkscape:current-layer="g5356"
+     inkscape:current-layer="g4866-2-3"
      id="namedview4950"
-     showgrid="false"
-     inkscape:window-width="1846"
-     inkscape:window-height="1053"
-     inkscape:window-x="1911"
-     inkscape:window-y="37"
-     inkscape:window-maximized="1" />
+     showgrid="true"
+     inkscape:window-width="1211"
+     inkscape:window-height="698"
+     inkscape:window-x="65"
+     inkscape:window-y="24"
+     inkscape:window-maximized="1">
+    <inkscape:grid
+       type="xygrid"
+       id="grid4203" />
+  </sodipodi:namedview>
   <metadata
      id="metadata4952">
     <rdf:RDF>
@@ -363,6 +409,12 @@
     <g
        id="g5356"
        transform="translate(-15.096057,-107.16694)">
+      <path
+         sodipodi:nodetypes="cc"
+         inkscape:connector-curvature="0"
+         id="path3284-4-2-3-77-5-9"
+         d="m 813.66791,753.1462 0,-92.21768"
+         style="display:inline;fill:none;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;marker-start:url(#EmptyTriangleInL-6)" />
       <rect
          y="377.8927"
          x="96.920677"
@@ -410,7 +462,7 @@
            sodipodi:cy="358.94418"
            sodipodi:rx="70.677063"
            sodipodi:ry="70.677063"
-           d="m 394.67978,358.94418 c 0,39.03387 -31.6432,70.67707 -70.67706,70.67707 -39.03387,0 -70.67707,-31.6432 -70.67707,-70.67707 0,-39.03386 31.6432,-70.67706 70.67707,-70.67706 39.03386,0 70.67706,31.6432 70.67706,70.67706 z"
+           d="m 394.67978,358.94418 a 70.677063,70.677063 0 0 1 -70.67706,70.67707 70.677063,70.677063 0 0 1 -70.67707,-70.67707 70.677063,70.677063 0 0 1 70.67707,-70.67706 70.677063,70.677063 0 0 1 70.67706,70.67706 z"
            transform="matrix(0.36664048,0,0,0.36664048,0.86684619,-80.697844)" />
         <g
            id="g5262">
@@ -536,29 +588,29 @@
       </g>
       <rect
          y="754.5235"
-         x="225.29219"
+         x="231.29219"
          height="42.939091"
          width="118.56741"
          id="rect4267-4-7-7-3-3"
-         style="fill:#ffffff;stroke:#000000;stroke-width:1;stroke-opacity:1;display:inline" />
+         style="display:inline;fill:#ffffff;stroke:#000000;stroke-width:1;stroke-opacity:1" />
       <text
          sodipodi:linespacing="125%"
          id="text5037-4-6-9-1-4"
          y="783.03412"
-         x="284.34656"
-         style="font-size:20.86613655px;font-style:normal;font-weight:normal;text-align:center;line-height:125%;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#000000;fill-opacity:1;stroke:none;display:inline;font-family:Sans"
+         x="290.34656"
+         style="font-style:normal;font-weight:normal;font-size:20.86613655px;line-height:125%;font-family:Sans;text-align:center;letter-spacing:0px;word-spacing:0px;text-anchor:middle;display:inline;fill:#000000;fill-opacity:1;stroke:none"
          xml:space="preserve"><tspan
            id="tspan5184-3-5-2-1"
            style="font-size:20px;text-align:center;text-anchor:middle"
            y="783.03412"
-           x="284.34656"
+           x="290.34656"
            sodipodi:role="line">ceilometer</tspan></text>
       <g
-         transform="matrix(1.7775787,0,0,1.7775787,593.58186,304.14299)"
+         transform="matrix(1.7775787,0,0,1.7775787,599.58186,304.14299)"
          id="g4982"
          style="display:inline">
         <rect
-           style="fill:#ffffff;stroke:#000000;stroke-width:0.562563;stroke-opacity:1;display:inline"
+           style="display:inline;fill:#ffffff;stroke:#000000;stroke-width:0.562563;stroke-opacity:1"
            id="rect4267-4-7-7-3-3-1"
            width="66.701637"
            height="24.155943"
@@ -566,7 +618,7 @@
            y="253.36743" />
         <text
            xml:space="preserve"
-           style="font-size:11.73851585px;font-style:normal;font-weight:normal;text-align:center;line-height:125%;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#000000;fill-opacity:1;stroke:none;display:inline;font-family:Sans"
+           style="font-style:normal;font-weight:normal;font-size:11.73851585px;line-height:125%;font-family:Sans;text-align:center;letter-spacing:0px;word-spacing:0px;text-anchor:middle;display:inline;fill:#000000;fill-opacity:1;stroke:none"
            x="-100.86156"
            y="268.36258"
            id="text5037-4-6-9-1-4-3"
@@ -620,12 +672,6 @@
              style="font-size:11.2512598px;text-align:center;text-anchor:middle"
              id="tspan5022">drivers</tspan></text>
       </g>
-      <path
-         sodipodi:nodetypes="cc"
-         inkscape:connector-curvature="0"
-         id="path5110"
-         d="m 376.75141,726.9703 -57.95106,0"
-         style="fill:none;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;display:inline" />
       <g
          transform="matrix(1.7775787,0,0,1.7775787,704.59677,780.35846)"
          id="g5267"
@@ -863,8 +909,8 @@
          sodipodi:nodetypes="cc"
          inkscape:connector-curvature="0"
          id="path5110-9"
-         d="m 472.18905,726.66568 221.85496,0"
-         style="fill:none;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;display:inline" />
+         d="m 472.18905,726.66568 331.45651,0"
+         style="display:inline;fill:none;stroke:#000000;stroke-width:1.22230256px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1" />
       <path
          sodipodi:nodetypes="cc"
          inkscape:connector-curvature="0"
@@ -907,8 +953,8 @@
          sodipodi:nodetypes="cc"
          inkscape:connector-curvature="0"
          id="path3284-4-2-3-4-6"
-         d="m 540.57926,651.7922 179.16488,0"
-         style="fill:none;stroke:#000000;stroke-width:1;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:1.99999999, 1.99999999;stroke-dashoffset:0;marker-start:url(#TriangleInL);display:inline" />
+         d="m 543.75943,651.7922 280.63651,0"
+         style="display:inline;fill:none;stroke:#000000;stroke-width:1.25154257;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:2.50308524, 2.50308524;stroke-dashoffset:0;stroke-opacity:1;marker-start:url(#TriangleInL)" />
       <rect
          y="262.01205"
          x="451.89563"
@@ -1052,8 +1098,8 @@
          sodipodi:nodetypes="cc"
          inkscape:connector-curvature="0"
          id="path5112-89"
-         d="m 328.87061,655.34778 0,71.7093"
-         style="fill:none;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;display:inline" />
+         d="m 324.87061,655.34778 0,71.7093"
+         style="display:inline;fill:none;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1" />
       <path
          sodipodi:nodetypes="cc"
          inkscape:connector-curvature="0"
@@ -1178,7 +1224,7 @@
            sodipodi:role="line">extensions</tspan></text>
       <path
          transform="translate(68.397849,130.15566)"
-         d="m 519.41589,367.58817 c 0,4.01434 -2.01125,7.2686 -4.49224,7.2686 -2.481,0 -4.49225,-3.25426 -4.49225,-7.2686 0,-4.01434 2.01125,-7.26861 4.49225,-7.26861 2.48099,0 4.49224,3.25427 4.49224,7.26861 z"
+         d="m 519.41589,367.58817 a 4.4922457,7.2686057 0 0 1 -4.49224,7.2686 4.4922457,7.2686057 0 0 1 -4.49225,-7.2686 4.4922457,7.2686057 0 0 1 4.49225,-7.26861 4.4922457,7.2686057 0 0 1 4.49224,7.26861 z"
          sodipodi:ry="7.2686057"
          sodipodi:rx="4.4922457"
          sodipodi:cy="367.58817"
@@ -1188,7 +1234,7 @@
          sodipodi:type="arc" />
       <path
          transform="matrix(0.36538461,0,0,0.36538461,397.30905,368.17877)"
-         d="m 521.38126,368.43045 c 0,4.03162 -3.26828,7.2999 -7.2999,7.2999 -4.03162,0 -7.2999,-3.26828 -7.2999,-7.2999 0,-4.03162 3.26828,-7.2999 7.2999,-7.2999 4.03162,0 7.2999,3.26828 7.2999,7.2999 z"
+         d="m 521.38126,368.43045 a 7.2998991,7.2998991 0 0 1 -7.2999,7.2999 7.2998991,7.2998991 0 0 1 -7.2999,-7.2999 7.2998991,7.2998991 0 0 1 7.2999,-7.2999 7.2998991,7.2998991 0 0 1 7.2999,7.2999 z"
          sodipodi:ry="7.2998991"
          sodipodi:rx="7.2998991"
          sodipodi:cy="368.43045"
@@ -1198,7 +1244,7 @@
          sodipodi:type="arc" />
       <path
          transform="matrix(0.36538461,0,0,0.36538461,-27.122619,99.964199)"
-         d="m 521.38126,368.43045 c 0,4.03162 -3.26828,7.2999 -7.2999,7.2999 -4.03162,0 -7.2999,-3.26828 -7.2999,-7.2999 0,-4.03162 3.26828,-7.2999 7.2999,-7.2999 4.03162,0 7.2999,3.26828 7.2999,7.2999 z"
+         d="m 521.38126,368.43045 a 7.2998991,7.2998991 0 0 1 -7.2999,7.2999 7.2998991,7.2998991 0 0 1 -7.2999,-7.2999 7.2998991,7.2998991 0 0 1 7.2999,-7.2999 7.2998991,7.2998991 0 0 1 7.2999,7.2999 z"
          sodipodi:ry="7.2998991"
          sodipodi:rx="7.2998991"
          sodipodi:cy="368.43045"
@@ -1214,7 +1260,7 @@
          style="fill:none;stroke:#000000;stroke-width:1;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:3.99999997, 1.99999998, 0.99999999, 1.99999998;stroke-dashoffset:0;marker-start:none;display:inline" />
       <path
          transform="matrix(0.36538461,0,0,0.36538461,396.74123,268.71562)"
-         d="m 521.38126,368.43045 c 0,4.03162 -3.26828,7.2999 -7.2999,7.2999 -4.03162,0 -7.2999,-3.26828 -7.2999,-7.2999 0,-4.03162 3.26828,-7.2999 7.2999,-7.2999 4.03162,0 7.2999,3.26828 7.2999,7.2999 z"
+         d="m 521.38126,368.43045 a 7.2998991,7.2998991 0 0 1 -7.2999,7.2999 7.2998991,7.2998991 0 0 1 -7.2999,-7.2999 7.2998991,7.2998991 0 0 1 7.2999,-7.2999 7.2998991,7.2998991 0 0 1 7.2999,7.2999 z"
          sodipodi:ry="7.2998991"
          sodipodi:rx="7.2998991"
          sodipodi:cy="368.43045"
@@ -1224,7 +1270,7 @@
          sodipodi:type="arc" />
       <path
          transform="matrix(0.36538461,0,0,0.36538461,428.69747,559.36511)"
-         d="m 521.38126,368.43045 c 0,4.03162 -3.26828,7.2999 -7.2999,7.2999 -4.03162,0 -7.2999,-3.26828 -7.2999,-7.2999 0,-4.03162 3.26828,-7.2999 7.2999,-7.2999 4.03162,0 7.2999,3.26828 7.2999,7.2999 z"
+         d="m 521.38126,368.43045 a 7.2998991,7.2998991 0 0 1 -7.2999,7.2999 7.2998991,7.2998991 0 0 1 -7.2999,-7.2999 7.2998991,7.2998991 0 0 1 7.2999,-7.2999 7.2998991,7.2998991 0 0 1 7.2999,7.2999 z"
          sodipodi:ry="7.2998991"
          sodipodi:rx="7.2998991"
          sodipodi:cy="368.43045"
@@ -1234,7 +1280,7 @@
          sodipodi:type="arc" />
       <path
          transform="matrix(0.36538461,0,0,0.36538461,531.88959,559.36511)"
-         d="m 521.38126,368.43045 c 0,4.03162 -3.26828,7.2999 -7.2999,7.2999 -4.03162,0 -7.2999,-3.26828 -7.2999,-7.2999 0,-4.03162 3.26828,-7.2999 7.2999,-7.2999 4.03162,0 7.2999,3.26828 7.2999,7.2999 z"
+         d="m 521.38126,368.43045 a 7.2998991,7.2998991 0 0 1 -7.2999,7.2999 7.2998991,7.2998991 0 0 1 -7.2999,-7.2999 7.2998991,7.2998991 0 0 1 7.2999,-7.2999 7.2998991,7.2998991 0 0 1 7.2999,7.2999 z"
          sodipodi:ry="7.2998991"
          sodipodi:rx="7.2998991"
          sodipodi:cy="368.43045"
@@ -1250,7 +1296,7 @@
          style="fill:none;stroke:#000000;stroke-width:1;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:1.99999998, 1.99999998;stroke-dashoffset:0;marker-start:none;display:inline" />
       <path
          transform="matrix(0.36538461,0,0,0.36538461,748.91653,525.25993)"
-         d="m 521.38126,368.43045 c 0,4.03162 -3.26828,7.2999 -7.2999,7.2999 -4.03162,0 -7.2999,-3.26828 -7.2999,-7.2999 0,-4.03162 3.26828,-7.2999 7.2999,-7.2999 4.03162,0 7.2999,3.26828 7.2999,7.2999 z"
+         d="m 521.38126,368.43045 a 7.2998991,7.2998991 0 0 1 -7.2999,7.2999 7.2998991,7.2998991 0 0 1 -7.2999,-7.2999 7.2998991,7.2998991 0 0 1 7.2999,-7.2999 7.2998991,7.2998991 0 0 1 7.2999,7.2999 z"
          sodipodi:ry="7.2998991"
          sodipodi:rx="7.2998991"
          sodipodi:cy="368.43045"
@@ -1260,7 +1306,7 @@
          sodipodi:type="arc" />
       <path
          transform="matrix(0.36538461,0,0,0.36538461,748.91653,495.84628)"
-         d="m 521.38126,368.43045 c 0,4.03162 -3.26828,7.2999 -7.2999,7.2999 -4.03162,0 -7.2999,-3.26828 -7.2999,-7.2999 0,-4.03162 3.26828,-7.2999 7.2999,-7.2999 4.03162,0 7.2999,3.26828 7.2999,7.2999 z"
+         d="m 521.38126,368.43045 a 7.2998991,7.2998991 0 0 1 -7.2999,7.2999 7.2998991,7.2998991 0 0 1 -7.2999,-7.2999 7.2998991,7.2998991 0 0 1 7.2999,-7.2999 7.2998991,7.2998991 0 0 1 7.2999,7.2999 z"
          sodipodi:ry="7.2998991"
          sodipodi:rx="7.2998991"
          sodipodi:cy="368.43045"
@@ -1313,7 +1359,7 @@
       </g>
       <path
          transform="matrix(0.36538461,0,0,0.36538461,396.74122,268.71562)"
-         d="m 521.38126,368.43045 c 0,4.03162 -3.26828,7.2999 -7.2999,7.2999 -4.03162,0 -7.2999,-3.26828 -7.2999,-7.2999 0,-4.03162 3.26828,-7.2999 7.2999,-7.2999 4.03162,0 7.2999,3.26828 7.2999,7.2999 z"
+         d="m 521.38126,368.43045 a 7.2998991,7.2998991 0 0 1 -7.2999,7.2999 7.2998991,7.2998991 0 0 1 -7.2999,-7.2999 7.2998991,7.2998991 0 0 1 7.2999,-7.2999 7.2998991,7.2998991 0 0 1 7.2999,7.2999 z"
          sodipodi:ry="7.2998991"
          sodipodi:rx="7.2998991"
          sodipodi:cy="368.43045"
@@ -1323,7 +1369,7 @@
          sodipodi:type="arc" />
       <path
          transform="matrix(0.36538461,0,0,0.36538461,-27.122619,74.87915)"
-         d="m 521.38126,368.43045 c 0,4.03162 -3.26828,7.2999 -7.2999,7.2999 -4.03162,0 -7.2999,-3.26828 -7.2999,-7.2999 0,-4.03162 3.26828,-7.2999 7.2999,-7.2999 4.03162,0 7.2999,3.26828 7.2999,7.2999 z"
+         d="m 521.38126,368.43045 a 7.2998991,7.2998991 0 0 1 -7.2999,7.2999 7.2998991,7.2998991 0 0 1 -7.2999,-7.2999 7.2998991,7.2998991 0 0 1 7.2999,-7.2999 7.2998991,7.2998991 0 0 1 7.2999,7.2999 z"
          sodipodi:ry="7.2998991"
          sodipodi:rx="7.2998991"
          sodipodi:cy="368.43045"
@@ -1339,7 +1385,7 @@
          style="fill:none;stroke:#000000;stroke-width:1;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:3.99999997, 1.99999998, 0.99999999, 1.99999998;stroke-dashoffset:0;marker-start:url(#TriangleInL);display:inline" />
       <path
          transform="matrix(0.36538461,0,0,0.36538461,422.9095,223.59883)"
-         d="m 521.38126,368.43045 c 0,4.03162 -3.26828,7.2999 -7.2999,7.2999 -4.03162,0 -7.2999,-3.26828 -7.2999,-7.2999 0,-4.03162 3.26828,-7.2999 7.2999,-7.2999 4.03162,0 7.2999,3.26828 7.2999,7.2999 z"
+         d="m 521.38126,368.43045 a 7.2998991,7.2998991 0 0 1 -7.2999,7.2999 7.2998991,7.2998991 0 0 1 -7.2999,-7.2999 7.2998991,7.2998991 0 0 1 7.2999,-7.2999 7.2998991,7.2998991 0 0 1 7.2999,7.2999 z"
          sodipodi:ry="7.2998991"
          sodipodi:rx="7.2998991"
          sodipodi:cy="368.43045"
@@ -1351,15 +1397,87 @@
          sodipodi:nodetypes="cc"
          inkscape:connector-curvature="0"
          id="path3284-4-2-3-40"
-         d="m 319.30136,753.47677 0,-27.00021"
-         style="fill:none;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;marker-start:url(#EmptyTriangleInL);display:inline" />
+         d="m 325.23661,753.47677 0,-27.00021"
+         style="display:inline;fill:none;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;marker-start:url(#EmptyTriangleInL)" />
       <path
          sodipodi:nodetypes="cc"
          inkscape:connector-curvature="0"
          id="path3284-4-2-3-8"
-         d="m 376.2546,753.65849 0,-27.00021"
-         style="fill:none;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;marker-start:url(#EmptyTriangleInL);display:inline" />
+         d="m 414.2546,753.65849 0,-27.00021"
+         style="display:inline;fill:none;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;marker-start:url(#EmptyTriangleInL)" />
+      <rect
+         y="754.5235"
+         x="102.92204"
+         height="42.939091"
+         width="118.56741"
+         id="rect4267-4-7-7-3-3-3"
+         style="display:inline;fill:#ffffff;stroke:#000000;stroke-width:1;stroke-opacity:1" />
+      <text
+         sodipodi:linespacing="125%"
+         id="text5037-4-6-9-1-4-6"
+         y="783.03412"
+         x="160.34656"
+         style="font-style:normal;font-weight:normal;font-size:20.86613655px;line-height:125%;font-family:Sans;text-align:center;letter-spacing:0px;word-spacing:0px;text-anchor:middle;display:inline;fill:#000000;fill-opacity:1;stroke:none"
+         xml:space="preserve"><tspan
+           id="tspan5184-3-5-2-1-7"
+           style="font-size:20px;text-align:center;text-anchor:middle"
+           y="783.03412"
+           x="160.34656"
+           sodipodi:role="line">gnocchi</tspan></text>
+      <path
+         sodipodi:nodetypes="cc"
+         inkscape:connector-curvature="0"
+         id="path3284-4-2-3-40-5"
+         d="m 191.30136,753.47677 0,-27.00021"
+         style="display:inline;fill:none;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;marker-start:url(#EmptyTriangleInL-5)" />
+      <path
+         sodipodi:nodetypes="cc"
+         inkscape:connector-curvature="0"
+         id="path5110-9-6"
+         d="m 192.18905,726.66568 221.85496,0"
+         style="display:inline;fill:none;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1" />
+      <g
+         id="g4866-2-3"
+         style="display:inline"
+         transform="matrix(1.7775787,0,0,1.7775787,991.15946,596.08131)">
+        <rect
+           style="display:inline;fill:#ffffff;stroke:#000000;stroke-width:0.562563;stroke-opacity:1"
+           id="rect4267-4-7-7-6"
+           width="49.81258"
+           height="24.243191"
+           x="-116.67716"
+           y="88.977051" />
+        <text
+           xml:space="preserve"
+           style="font-style:normal;font-weight:normal;font-size:11.73851585px;line-height:125%;font-family:Sans;text-align:center;letter-spacing:0px;word-spacing:0px;text-anchor:middle;display:inline;fill:#000000;fill-opacity:1;stroke:none"
+           x="-91.899979"
+           y="104.01585"
+           id="text5037-4-6-9-7"
+           sodipodi:linespacing="125%"><tspan
+             sodipodi:role="line"
+             x="-91.899979"
+             y="104.01585"
+             style="font-size:11.2512598px;text-align:center;text-anchor:middle"
+             id="tspan5184-3-5-5">cinder</tspan></text>
+      </g>
+      <path
+         sodipodi:nodetypes="cc"
+         inkscape:connector-curvature="0"
+         id="path3284-4-2-3-4-9-3"
+         d="m 824.37881,651.58554 0,102.98987"
+         style="display:inline;fill:none;stroke:#000000;stroke-width:1;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:1.99999999, 1.99999999;stroke-dashoffset:0;stroke-opacity:1;marker-start:none" />
+      <circle
+         r="2.6672709"
+         cy="693.98395"
+         cx="823.72699"
+         id="path13407-89-5"
+         style="color:#000000;display:inline;overflow:visible;visibility:visible;fill:#ececec;fill-opacity:1;fill-rule:nonzero;stroke:#000000;stroke-width:1;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1;marker:none;enable-background:accumulate" />
+      <path
+         sodipodi:nodetypes="cc"
+         inkscape:connector-curvature="0"
+         id="path3284-4-2-3-7-9"
+         d="m 804.16781,752.35205 0,-26.2061"
+         style="display:inline;fill:none;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;marker-start:url(#EmptyTriangleInL-12)" />
     </g>
   </g>
 </svg>
-

doc/source/index.rst

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

doc/source/install/common_configure.rst

@@ -39,12 +39,12 @@
      Replace WATCHER_PASS with the password you chose for the watcher user in the Identity service.
 
    * Watcher interacts with other OpenStack projects via project clients, in order to instantiate these
-     clients, Watcher requests new session from Identity service. In the `[watcher_client_auth]` section,
+     clients, Watcher requests new session from Identity service. In the `[watcher_clients_auth]` section,
      configure the identity service access to interact with other OpenStack project clients.
 
      .. code-block:: ini
 
-        [watcher_client_auth]
+        [watcher_clients_auth]
         ...
         auth_type = password
         auth_url = http://controller:35357
@@ -56,6 +56,16 @@
 
      Replace WATCHER_PASS with the password you chose for the watcher user in the Identity service.
 
+   * In the `[api]` section, configure host option.
+
+     .. code-block:: ini
+
+        [api]
+        ...
+        host = controller
+
+     Replace controller with the IP address of the management network interface on your controller node, typically 10.0.0.11 for the first node in the example architecture.
+
    * In the `[oslo_messaging_notifications]` section, configure the messaging driver.
 
      .. code-block:: ini
@@ -68,4 +78,4 @@
 
    .. code-block:: ini
 
-     su -s /bin/sh -c "watcher-db-manage" watcher
+     su -s /bin/sh -c "watcher-db-manage --config-file /etc/watcher/watcher.conf upgrade"

doc/source/install/common_prerequisites.rst

@@ -15,13 +15,13 @@ you must create a database, service credentials, and API endpoints.
 
    * Create the ``watcher`` database:
 
-     .. code-block:: none
+     .. code-block:: console
 
         CREATE DATABASE watcher CHARACTER SET utf8;
 
    * Grant proper access to the ``watcher`` database:
 
-     .. code-block:: none
+     .. code-block:: console
 
         GRANT ALL PRIVILEGES ON watcher.* TO 'watcher'@'localhost' \
           IDENTIFIED BY 'WATCHER_DBPASS';
@@ -32,7 +32,7 @@ you must create a database, service credentials, and API endpoints.
 
    * Exit the database access client.
 
-     .. code-block:: none
+     .. code-block:: console
 
         exit;
 

doc/source/install/index.rst

@@ -23,17 +23,17 @@ of data center operating costs, increased system performance
 via intelligent virtual machine migration, increased energy
 efficiency—and more!
 
-watcher also supports a pluggable architecture by which custom
+Watcher also supports a pluggable architecture by which custom
 optimization algorithms, data metrics and data profilers can be
 developed and inserted into the Watcher framework.
 
-check the documentation for watcher optimization strategies at
-https://docs.openstack.org/developer/watcher/strategies
+Check the documentation for watcher optimization strategies at
+https://docs.openstack.org/watcher/latest/strategies/index.html
 
-check watcher glossary at
-https://docs.openstack.org/developer/watcher/glossary.html
+Check watcher glossary at
+https://docs.openstack.org/watcher/latest/glossary.html
 
 
 This chapter assumes a working setup of OpenStack following the
 `OpenStack Installation Tutorial
-<https://docs.openstack.org/project-install-guide/ocata/>`_.
+<https://docs.openstack.org/pike/install/>`_.

doc/source/install/install-rdo.rst

@@ -4,8 +4,8 @@ Install and configure for Red Hat Enterprise Linux and CentOS
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 
-This section describes how to install and configure the Infrastructure Optimization service
-for Red Hat Enterprise Linux 7 and CentOS 7.
+This section describes how to install and configure the Infrastructure
+Optimization service for Red Hat Enterprise Linux 7 and CentOS 7.
 
 .. include:: common_prerequisites.rst
 

doc/source/install/install-ubuntu.rst

@@ -3,8 +3,8 @@
 Install and configure for Ubuntu
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-This section describes how to install and configure the Infrastructure Optimization
-service for Ubuntu 14.04 (LTS).
+This section describes how to install and configure the Infrastructure
+Optimization service for Ubuntu 14.04 (LTS).
 
 .. include:: common_prerequisites.rst
 

doc/source/install/install.rst

@@ -3,8 +3,8 @@
 Install and configure
 ~~~~~~~~~~~~~~~~~~~~~
 
-This section describes how to install and configure the
-Infrastructure Optimization service, code-named watcher, on the controller node.
+This section describes how to install and configure the Infrastructure
+Optimization service, code-named watcher, on the controller node.
 
 This section assumes that you already have a working OpenStack
 environment with at least the following components installed:
@@ -15,6 +15,5 @@ Note that installation and configuration vary by distribution.
 .. toctree::
    :maxdepth: 2
 
-   install-obs.rst
    install-rdo.rst
    install-ubuntu.rst

doc/source/install/next-steps.rst

@@ -6,4 +6,4 @@ Next steps
 Your OpenStack environment now includes the watcher service.
 
 To add additional services, see
-https://docs.openstack.org/project-install-guide/ocata/.
+https://docs.openstack.org/pike/install/.

doc/source/man/index.rst

@@ -0,0 +1,8 @@
+.. toctree::
+   :glob:
+   :maxdepth: 1
+
+   watcher-api
+   watcher-applier
+   watcher-db-manage
+   watcher-decision-engine

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

@@ -5,7 +5,7 @@ Basic Offline Server Consolidation
 Synopsis
 --------
 
-**display name**: ``basic``
+**display name**: ``Basic offline consolidation``
 
 **goal**: ``server_consolidation``
 
@@ -26,7 +26,7 @@ metric                       service name plugins comment
 ``cpu_util``                 ceilometer_  none
 ============================ ============ ======= =======
 
-.. _ceilometer: http://docs.openstack.org/admin-guide/telemetry-measurements.html#openstack-compute
+.. _ceilometer: https://docs.openstack.org/ceilometer/latest/admin/telemetry-measurements.html#openstack-compute
 
 Cluster data model
 ******************
@@ -57,7 +57,7 @@ Planner
 
 Default Watcher's planner:
 
-    .. watcher-term:: watcher.decision_engine.planner.default.DefaultPlanner
+    .. watcher-term:: watcher.decision_engine.planner.weight.WeightPlanner
 
 Configuration
 -------------

doc/source/strategies/outlet_temp_control.rst

@@ -5,7 +5,7 @@ Outlet Temperature Based Strategy
 Synopsis
 --------
 
-**display name**: ``outlet_temperature``
+**display name**: ``Outlet temperature based strategy``
 
 **goal**: ``thermal_optimization``
 
@@ -33,7 +33,7 @@ metric                                    service name plugins comment
 ``hardware.ipmi.node.outlet_temperature`` ceilometer_  IPMI
 ========================================= ============ ======= =======
 
-.. _ceilometer: http://docs.openstack.org/admin-guide/telemetry-measurements.html#ipmi-based-meters
+.. _ceilometer: https://docs.openstack.org/ceilometer/latest/admin/telemetry-measurements.html#ipmi-based-meters
 
 Cluster data model
 ******************
@@ -61,7 +61,7 @@ Planner
 
 Default Watcher's planner:
 
-    .. watcher-term:: watcher.decision_engine.planner.default.DefaultPlanner
+    .. watcher-term:: watcher.decision_engine.planner.weight.WeightPlanner
 
 Configuration
 -------------

doc/source/strategies/saving_energy.rst

@@ -0,0 +1,100 @@
+======================
+Saving Energy Strategy
+======================
+
+Synopsis
+--------
+
+**display name**: ``Saving Energy Strategy``
+
+**goal**: ``saving_energy``
+
+    .. watcher-term:: watcher.decision_engine.strategy.strategies.saving_energy
+
+Requirements
+------------
+
+This feature will use Ironic to do the power on/off actions, therefore
+this feature requires that the ironic component is configured.
+And the compute node should be managed by Ironic.
+
+Ironic installation: https://docs.openstack.org/ironic/latest/install/index.html
+
+Cluster data model
+******************
+
+Default Watcher's Compute cluster data model:
+
+    .. watcher-term:: watcher.decision_engine.model.collector.nova.NovaClusterDataModelCollector
+
+Actions
+*******
+
+    .. list-table::
+       :widths: 30 30
+       :header-rows: 1
+
+       * - action
+         - description
+       * - ``change_node_power_state``
+         - .. watcher-term:: watcher.applier.actions.change_node_power_state.ChangeNodePowerState
+
+Planner
+*******
+
+Default Watcher's planner:
+
+    .. watcher-term:: watcher.decision_engine.planner.weight.WeightPlanner
+
+
+Configuration
+-------------
+
+Strategy parameter is:
+
+====================== ====== ======= ======================================
+parameter              type   default          description
+                              Value
+====================== ====== ======= ======================================
+``free_used_percent``  Number  10.0   a rational number, which describes the
+                                      the quotient of
+                                      min_free_hosts_num/nodes_with_VMs_num
+``min_free_hosts_num`` Int      1     an int number describes minimum free
+                                      compute nodes
+====================== ====== ======= ======================================
+
+
+Efficacy Indicator
+------------------
+
+Energy saving strategy efficacy indicator is unclassified.
+https://github.com/openstack/watcher/blob/master/watcher/decision_engine/goal/goals.py#L215-L218
+
+Algorithm
+---------
+
+For more information on the Energy Saving Strategy please refer to:http://specs.openstack.org/openstack/watcher-specs/specs/pike/implemented/energy-saving-strategy.html
+
+How to use it ?
+---------------
+step1: Add compute nodes info into ironic node management
+
+.. code-block:: shell
+
+    $ ironic node-create  -d pxe_ipmitool -i ipmi_address=10.43.200.184 \
+      ipmi_username=root  -i ipmi_password=nomoresecret -e compute_node_id=3
+
+step 2: Create audit to do optimization
+
+.. code-block:: shell
+
+    $ openstack optimize audittemplate create \
+      at1 saving_energy --strategy saving_energy
+
+    $ openstack optimize audit create -a at1
+
+External Links
+--------------
+
+*Spec URL*
+http://specs.openstack.org/openstack/watcher-specs/specs/pike/implemented/energy-saving-strategy.html

doc/source/strategies/strategy-template.rst

@@ -33,7 +33,7 @@ power                   ceilometer_  kwapi_  one point every 60s
 ======================= ============ ======= =======
 
 
-.. _ceilometer: http://docs.openstack.org/admin-guide/telemetry-measurements.html#openstack-compute
+.. _ceilometer: https://docs.openstack.org/ceilometer/latest/admin/telemetry-measurements.html#openstack-compute
 .. _monasca: https://github.com/openstack/monasca-agent/blob/master/docs/Libvirt.md
 .. _kwapi: https://kwapi.readthedocs.io/en/latest/index.html
 

doc/source/strategies/uniform_airflow.rst

@@ -5,7 +5,7 @@ Uniform Airflow Migration Strategy
 Synopsis
 --------
 
-**display name**: ``uniform_airflow``
+**display name**: ``Uniform airflow migration strategy``
 
 **goal**: ``airflow_optimization``
 
@@ -59,7 +59,7 @@ Planner
 
 Default Watcher's planner:
 
-    .. watcher-term:: watcher.decision_engine.planner.default.DefaultPlanner
+    .. watcher-term:: watcher.decision_engine.planner.weight.WeightPlanner
 
 Configuration
 -------------

doc/source/strategies/vm_workload_consolidation.rst

@@ -5,7 +5,7 @@ VM Workload Consolidation Strategy
 Synopsis
 --------
 
-**display name**: ``vm_workload_consolidation``
+**display name**: ``VM Workload Consolidation Strategy``
 
 **goal**: ``vm_consolidation``
 
@@ -22,7 +22,7 @@ The *vm_workload_consolidation* strategy requires the following metrics:
 ============================ ============ ======= =======
 metric                       service name plugins comment
 ============================ ============ ======= =======
-``memory``             	     ceilometer_  none
+``memory``                   ceilometer_  none
 ``disk.root.size``           ceilometer_  none
 ============================ ============ ======= =======
 
@@ -32,11 +32,11 @@ the strategy if available:
 ============================ ============ ======= =======
 metric                       service name plugins comment
 ============================ ============ ======= =======
-``memory.usage``             ceilometer_  none
+``memory.resident``          ceilometer_  none
 ``cpu_util``                 ceilometer_  none
 ============================ ============ ======= =======
 
-.. _ceilometer: http://docs.openstack.org/admin-guide/telemetry-measurements.html#openstack-compute
+.. _ceilometer: https://docs.openstack.org/ceilometer/latest/admin/telemetry-measurements.html#openstack-compute
 
 Cluster data model
 ******************
@@ -67,7 +67,7 @@ Planner
 
 Default Watcher's planner:
 
-    .. watcher-term:: watcher.decision_engine.planner.default.DefaultPlanner
+    .. watcher-term:: watcher.decision_engine.planner.weight.WeightPlanner
 
 
 Configuration

doc/source/strategies/workload-stabilization.rst

@@ -5,7 +5,7 @@ Watcher Overload standard deviation algorithm
 Synopsis
 --------
 
-**display name**: ``workload_stabilization``
+**display name**: ``Workload stabilization``
 
 **goal**: ``workload_balancing``
 
@@ -28,7 +28,7 @@ metric                       service name plugins comment
 ``memory.resident``          ceilometer_  none
 ============================ ============ ======= =======
 
-.. _ceilometer: http://docs.openstack.org/admin-guide/telemetry-measurements.html#openstack-compute
+.. _ceilometer: https://docs.openstack.org/ceilometer/latest/admin/telemetry-measurements.html#openstack-compute
 .. _SNMP: http://docs.openstack.org/admin-guide/telemetry-measurements.html
 
 Cluster data model
@@ -58,7 +58,7 @@ Planner
 
 Default Watcher's planner:
 
-    .. watcher-term:: watcher.decision_engine.planner.default.DefaultPlanner
+    .. watcher-term:: watcher.decision_engine.planner.weight.WeightPlanner
 
 Configuration
 -------------
@@ -100,7 +100,7 @@ parameter            type   default Value         description
                                                   into which the samples are
                                                   grouped for aggregation.
                                                   Watcher uses only the last
-                                                  period of all recieved ones.
+                                                  period of all received ones.
 ==================== ====== ===================== =============================
 
 .. |metrics| replace:: ["cpu_util", "memory.resident"]

doc/source/strategies/workload_balance.rst

@@ -5,7 +5,7 @@ Workload Balance Migration Strategy
 Synopsis
 --------
 
-**display name**: ``workload_balance``
+**display name**: ``Workload Balance Migration Strategy``
 
 **goal**: ``workload_balancing``
 
@@ -25,9 +25,10 @@ The *workload_balance* strategy requires the following metrics:
 metric                  service name plugins comment
 ======================= ============ ======= =======
 ``cpu_util``            ceilometer_  none
+``memory.resident``     ceilometer_  none
 ======================= ============ ======= =======
 
-.. _ceilometer: http://docs.openstack.org/admin-guide/telemetry-measurements.html#openstack-compute
+.. _ceilometer: https://docs.openstack.org/ceilometer/latest/admin/telemetry-measurements.html#openstack-compute
 
 
 Cluster data model
@@ -56,7 +57,7 @@ Planner
 
 Default Watcher's planner:
 
-    .. watcher-term:: watcher.decision_engine.planner.default.DefaultPlanner
+    .. watcher-term:: watcher.decision_engine.planner.weight.WeightPlanner
 
 Configuration
 -------------
@@ -66,6 +67,9 @@ Strategy parameters are:
 ============== ====== ============= ====================================
 parameter      type   default Value description
 ============== ====== ============= ====================================
+``metrics``    String 'cpu_util'    Workload balance base on cpu or ram
+                                    utilization. choice: ['cpu_util',
+                                    'memory.resident']
 ``threshold``  Number 25.0          Workload threshold for migration
 ``period``     Number 300           Aggregate time period of ceilometer
 ============== ====== ============= ====================================
@@ -90,7 +94,7 @@ How to use it ?
       at1 workload_balancing --strategy workload_balance
 
     $ openstack optimize audit create -a at1 -p threshold=26.0 \
-            -p period=310
+            -p period=310 -p metrics=cpu_util
 
 External Links
 --------------

doc/source/user/index.rst

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

doc/source/user/user-guide.rst

@@ -11,7 +11,7 @@ Watcher User Guide
 ==================
 
 See the
-`architecture page <http://docs.openstack.org/developer/watcher/architecture.html>`_
+`architecture page <https://docs.openstack.org/watcher/latest/architecture.html>`_
 for an architectural overview of the different components of Watcher and how
 they fit together.
 
@@ -39,10 +39,10 @@ named ``watcher``, or by using the `OpenStack CLI`_ ``openstack``.
 If you want to deploy Watcher in Horizon, please refer to the `Watcher Horizon
 plugin installation guide`_.
 
-.. _`installation guide`: http://docs.openstack.org/developer/python-watcherclient
-.. _`Watcher Horizon plugin installation guide`: http://docs.openstack.org/developer/watcher-dashboard/deploy/installation.html
-.. _`OpenStack CLI`: http://docs.openstack.org/developer/python-openstackclient/man/openstack.html
-.. _`Watcher CLI`: http://docs.openstack.org/developer/python-watcherclient/index.html
+.. _`installation guide`: https://docs.openstack.org/python-watcherclient/latest
+.. _`Watcher Horizon plugin installation guide`: https://docs.openstack.org/watcher-dashboard/latest/install/installation.html
+.. _`OpenStack CLI`: https://docs.openstack.org/python-openstackclient/latest/cli/man/openstack.html
+.. _`Watcher CLI`: https://docs.openstack.org/python-watcherclient/latest/cli/index.html
 
 Seeing what the Watcher CLI can do ?
 ------------------------------------

install-guide/source/conf.py

@@ -1,301 +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.
-
-# 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.
-
-import os
-# import sys
-
-
-import openstackdocstheme
-
-# If extensions (or modules to document with autodoc) are in another directory,
-# add these directories to sys.path here. If the directory is relative to the
-# documentation root, use os.path.abspath to make it absolute, like shown here.
-# sys.path.insert(0, os.path.abspath('.'))
-
-# -- General configuration ------------------------------------------------
-
-# If your documentation needs a minimal Sphinx version, state it here.
-# needs_sphinx = '1.0'
-
-# Add any Sphinx extension module names here, as strings. They can be
-# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
-# ones.
-# TODO(ajaeger): enable PDF building, for example add 'rst2pdf.pdfbuilder'
-# extensions =
-
-# Add any paths that contain templates here, relative to this directory.
-# templates_path = ['_templates']
-
-# The suffix of source filenames.
-source_suffix = '.rst'
-
-# The encoding of source files.
-# source_encoding = 'utf-8-sig'
-
-# The master toctree document.
-master_doc = 'index'
-
-# General information about the project.
-project = u'Installation Guide for Infrastructure Optimization Service'
-bug_tag = u'install-guide'
-copyright = u'2016, OpenStack contributors'
-
-# The version info for the project you're documenting, acts as replacement for
-# |version| and |release|, also used in various other places throughout the
-# built documents.
-#
-# The short X.Y version.
-version = '0.1'
-# The full version, including alpha/beta/rc tags.
-release = '0.1'
-
-# A few variables have to be set for the log-a-bug feature.
-#   giturl: The location of conf.py on Git. Must be set manually.
-#   gitsha: The SHA checksum of the bug description. Automatically extracted
-#           from git log.
-#   bug_tag: Tag for categorizing the bug. Must be set manually.
-# These variables are passed to the logabug code via html_context.
-giturl = u'http://git.openstack.org/cgit/openstack/watcher/tree/install-guide/source'  # noqa
-git_cmd = "/usr/bin/git log | head -n1 | cut -f2 -d' '"
-gitsha = os.popen(git_cmd).read().strip('\n')
-html_context = {"gitsha": gitsha, "bug_tag": bug_tag,
-                "giturl": giturl,
-                "bug_project": "watcher"}
-
-# The language for content autogenerated by Sphinx. Refer to documentation
-# for a list of supported languages.
-# language = None
-
-# There are two options for replacing |today|: either, you set today to some
-# non-false value, then it is used:
-# today = ''
-# Else, today_fmt is used as the format for a strftime call.
-# today_fmt = '%B %d, %Y'
-
-# List of patterns, relative to source directory, that match files and
-# directories to ignore when looking for source files.
-exclude_patterns = ["common_prerequisites.rst", "common_configure.rst"]
-
-# The reST default role (used for this markup: `text`) to use for all
-# documents.
-# default_role = None
-
-# If true, '()' will be appended to :func: etc. cross-reference text.
-# add_function_parentheses = True
-
-# If true, the current module name will be prepended to all description
-# unit titles (such as .. function::).
-# add_module_names = True
-
-# If true, sectionauthor and moduleauthor directives will be shown in the
-# output. They are ignored by default.
-# show_authors = False
-
-# The name of the Pygments (syntax highlighting) style to use.
-pygments_style = 'sphinx'
-
-# A list of ignored prefixes for module index sorting.
-# modindex_common_prefix = []
-
-# If true, keep warnings as "system message" paragraphs in the built documents.
-# keep_warnings = False
-
-
-# -- Options for HTML output ----------------------------------------------
-
-# The theme to use for HTML and HTML Help pages.  See the documentation for
-# a list of builtin themes.
-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 = {}
-
-# Add any paths that contain custom themes here, relative to this directory.
-html_theme_path = [openstackdocstheme.get_html_theme_path()]
-
-# The name for this set of Sphinx documents.  If None, it defaults to
-# "<project> v<release> documentation".
-# html_title = None
-
-# A shorter title for the navigation bar.  Default is the same as html_title.
-# html_short_title = None
-
-# The name of an image file (relative to this directory) to place at the top
-# of the sidebar.
-# html_logo = None
-
-# The name of an image file (within the static path) to use as favicon of the
-# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
-# pixels large.
-# html_favicon = None
-
-# Add any paths that contain custom static files (such as style sheets) here,
-# relative to this directory. They are copied after the builtin static files,
-# so a file named "default.css" will overwrite the builtin "default.css".
-# html_static_path = []
-
-# Add any extra paths that contain custom files (such as robots.txt or
-# .htaccess) here, relative to this directory. These files are copied
-# directly to the root of the documentation.
-# html_extra_path = []
-
-# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
-# using the given strftime format.
-# So that we can enable "log-a-bug" links from each output HTML page, this
-# variable must be set to a format that includes year, month, day, hours and
-# minutes.
-html_last_updated_fmt = '%Y-%m-%d %H:%M'
-
-
-# If true, SmartyPants will be used to convert quotes and dashes to
-# typographically correct entities.
-# html_use_smartypants = True
-
-# Custom sidebar templates, maps document names to template names.
-# html_sidebars = {}
-
-# Additional templates that should be rendered to pages, maps page names to
-# template names.
-# html_additional_pages = {}
-
-# If false, no module index is generated.
-# html_domain_indices = True
-
-# If false, no index is generated.
-html_use_index = False
-
-# If true, the index is split into individual pages for each letter.
-# html_split_index = False
-
-# If true, links to the reST sources are added to the pages.
-html_show_sourcelink = False
-
-# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
-# html_show_sphinx = True
-
-# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
-# html_show_copyright = True
-
-# If true, an OpenSearch description file will be output, and all pages will
-# contain a <link> tag referring to it.  The value of this option must be the
-# base URL from which the finished HTML is served.
-# html_use_opensearch = ''
-
-# This is the file name suffix for HTML files (e.g. ".xhtml").
-# html_file_suffix = None
-
-# Output file base name for HTML help builder.
-htmlhelp_basename = 'install-guide'
-
-# If true, publish source files
-html_copy_source = False
-
-# -- Options for LaTeX output ---------------------------------------------
-
-latex_elements = {
-    # The paper size ('letterpaper' or 'a4paper').
-    # 'papersize': 'letterpaper',
-
-    # The font size ('10pt', '11pt' or '12pt').
-    # 'pointsize': '10pt',
-
-    # Additional stuff for the LaTeX preamble.
-    # 'preamble': '',
-}
-
-# Grouping the document tree into LaTeX files. List of tuples
-# (source start file, target name, title,
-#  author, documentclass [howto, manual, or own class]).
-latex_documents = [
-    ('index', 'InstallGuide.tex', u'Install Guide',
-     u'OpenStack contributors', 'manual'),
-]
-
-# The name of an image file (relative to this directory) to place at the top of
-# the title page.
-# latex_logo = None
-
-# For "manual" documents, if this is true, then toplevel headings are parts,
-# not chapters.
-# latex_use_parts = False
-
-# If true, show page references after internal links.
-# latex_show_pagerefs = False
-
-# If true, show URL addresses after external links.
-# latex_show_urls = False
-
-# Documents to append as an appendix to all manuals.
-# latex_appendices = []
-
-# If false, no module index is generated.
-# latex_domain_indices = True
-
-
-# -- Options for manual page output ---------------------------------------
-
-# One entry per manual page. List of tuples
-# (source start file, name, description, authors, manual section).
-man_pages = [
-    ('index', 'installguide', u'Install Guide',
-     [u'OpenStack contributors'], 1)
-]
-
-# If true, show URL addresses after external links.
-# man_show_urls = False
-
-
-# -- Options for Texinfo output -------------------------------------------
-
-# Grouping the document tree into Texinfo files. List of tuples
-# (source start file, target name, title, author,
-#  dir menu entry, description, category)
-texinfo_documents = [
-    ('index', 'InstallGuide', u'Install Guide',
-     u'OpenStack contributors', 'InstallGuide',
-     'This guide shows OpenStack end users how to install '
-     'an OpenStack cloud.', 'Miscellaneous'),
-]
-
-# Documents to append as an appendix to all manuals.
-# texinfo_appendices = []
-
-# If false, no module index is generated.
-# texinfo_domain_indices = True
-
-# How to display URL addresses: 'footnote', 'no', or 'inline'.
-# texinfo_show_urls = 'footnote'
-
-# If true, do not generate a @detailmenu in the "Top" node's menu.
-# texinfo_no_detailmenu = False
-
-# -- Options for Internationalization output ------------------------------
-locale_dirs = ['locale/']
-
-# -- Options for PDF output --------------------------------------------------
-
-pdf_documents = [
-    ('index', u'InstallGuide', u'Install Guide',
-     u'OpenStack contributors')
-]

install-guide/source/install-obs.rst

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

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

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

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

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

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

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

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

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

rally-jobs/README.rst

@@ -27,16 +27,16 @@ Structure
 Useful links
 ------------
 
-* How to install: http://docs.openstack.org/developer/rally/install.html
+* How to install: https://docs.openstack.org/rally/latest/install_and_upgrade/install.html
 
-* How to set Rally up and launch your first scenario:  https://rally.readthedocs.io/en/latest/tutorial/step_1_setting_up_env_and_running_benchmark_from_samples.html
+* How to set Rally up and launch your first scenario: https://rally.readthedocs.io/en/latest/tutorial/step_1_setting_up_env_and_running_benchmark_from_samples.html
 
-* More about Rally: https://rally.readthedocs.org/en/latest/
+* More about Rally: https://docs.openstack.org/rally/latest/
 
-* Rally release notes: https://rally.readthedocs.org/en/latest/release_notes.html
+* Rally project info and release notes: https://docs.openstack.org/rally/latest/project_info/index.html
 
-* How to add rally-gates: https://rally.readthedocs.org/en/latest/gates.html
+* How to add rally-gates: https://docs.openstack.org/rally/latest/quick_start/gates.html#gate-jobs
 
-* About plugins:  https://rally.readthedocs.org/en/latest/plugins.html
+* About plugins: https://docs.openstack.org/rally/latest/plugins/index.html
 
-* Plugin samples: https://github.com/openstack/rally/tree/master/samples/plugins
+* Plugin samples: https://github.com/openstack/rally/tree/master/samples/

releasenotes/notes/action-versioned-notifications-api-ff94fc0f401292d0.yaml

@@ -0,0 +1,3 @@
+---
+features:
+  - Add notifications related to Action object.

releasenotes/notes/add-power-on-off-a77673d482568a8b.yaml

@@ -0,0 +1,3 @@
+---
+features:
+  - Add action for compute node power on/off