Merge "Zuul: Remove project name"

Zuul no longer requires the project-name for in-repo configuration.
Omitting it makes forking or renaming projects easier.

Change-Id: Ib3be82015be1d6853c44cf53faacb238237ad701

.gitignore

@@ -24,6 +24,7 @@ pip-log.txt
 .coverage*
 .tox
 nosetests.xml
+.stestr/
 .testrepository
 .venv
 .idea

.stestr.conf

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

.zuul.yaml

@@ -0,0 +1,38 @@
+- project:
+    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

devstack/lib/watcher

@@ -42,7 +42,7 @@ WATCHER_AUTH_CACHE_DIR=${WATCHER_AUTH_CACHE_DIR:-/var/cache/watcher}
 
 WATCHER_CONF_DIR=/etc/watcher
 WATCHER_CONF=$WATCHER_CONF_DIR/watcher.conf
-WATCHER_POLICY_JSON=$WATCHER_CONF_DIR/policy.json
+WATCHER_POLICY_YAML=$WATCHER_CONF_DIR/policy.yaml.sample
 
 WATCHER_DEVSTACK_DIR=$WATCHER_DIR/devstack
 WATCHER_DEVSTACK_FILES_DIR=$WATCHER_DEVSTACK_DIR/files
@@ -106,7 +106,25 @@ function configure_watcher {
     # Put config files in ``/etc/watcher`` for everyone to find
     sudo install -d -o $STACK_USER $WATCHER_CONF_DIR
 
-    install_default_policy watcher
+    local project=watcher
+    local project_uc
+    project_uc=$(echo watcher|tr a-z A-Z)
+    local conf_dir="${project_uc}_CONF_DIR"
+    # eval conf dir to get the variable
+    conf_dir="${!conf_dir}"
+    local project_dir="${project_uc}_DIR"
+    # eval project dir to get the variable
+    project_dir="${!project_dir}"
+    local sample_conf_dir="${project_dir}/etc/${project}"
+    local sample_policy_dir="${project_dir}/etc/${project}/policy.d"
+    local sample_policy_generator="${project_dir}/etc/${project}/oslo-policy-generator/watcher-policy-generator.conf"
+
+    # first generate policy.yaml
+    oslopolicy-sample-generator --config-file $sample_policy_generator
+    # then optionally copy over policy.d
+    if [[ -d $sample_policy_dir ]]; then
+        cp -r $sample_policy_dir $conf_dir/policy.d
+    fi
 
     # Rebuild the config file from scratch
     create_watcher_conf
@@ -163,7 +181,7 @@ function create_watcher_conf {
     iniset $WATCHER_CONF api host "$WATCHER_SERVICE_HOST"
     iniset $WATCHER_CONF api port "$WATCHER_SERVICE_PORT"
 
-    iniset $WATCHER_CONF oslo_policy policy_file $WATCHER_POLICY_JSON
+    iniset $WATCHER_CONF oslo_policy policy_file $WATCHER_POLICY_YAML
 
     iniset $WATCHER_CONF oslo_messaging_rabbit rabbit_userid $RABBIT_USERID
     iniset $WATCHER_CONF oslo_messaging_rabbit rabbit_password $RABBIT_PASSWORD

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)

devstack/settings

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

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/ways-to-install.rst

@@ -126,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

@@ -1,3 +1,7 @@
+==================================================
+OpenStack Infrastructure Optimization Service APIs
+==================================================
+
 .. toctree::
    :maxdepth: 1
 

doc/source/api/v1.rst

@@ -86,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

@@ -72,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.']

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.
@@ -200,8 +200,8 @@ configuration file, in order:
 
 
 Although some configuration options are mentioned here, it is recommended that
-you review all the `available options
-<https://git.openstack.org/cgit/openstack/watcher/tree/etc/watcher/watcher.conf.sample>`_
+you review all the :ref:`available options
+<watcher_sample_configuration_files>`
 so that the watcher service is configured for your needs.
 
 #. The Watcher Service stores information in a database. This guide uses the
@@ -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/measurements.html#new-measurements
 
 The Ceilometer collector uses a pluggable storage system, meaning that you can
 pick any database system you prefer.

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

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
@@ -69,8 +69,8 @@ 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
@@ -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/
 
 
 

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

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 []

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

@@ -127,7 +127,7 @@ 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/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

@@ -190,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
 ======================
@@ -263,12 +263,12 @@ requires new metrics not covered by Ceilometer, you can add them through a
 `Ceilometer plugin`_.
 
 
-.. _`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/
+.. _`Helper`: https://github.com/openstack/watcher/blob/master/watcher/datasource/ceilometer.py
+.. _`Ceilometer developer guide`: https://docs.openstack.org/ceilometer/latest/contributor/architecture.html#storing-accessing-the-data
+.. _`Ceilometer`: https://docs.openstack.org/ceilometer/latest
 .. _`Monasca`: https://github.com/openstack/monasca-api/blob/master/docs/monasca-api-spec.md
-.. _`here`: 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/glossary.rst

@@ -83,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:
 
@@ -115,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.
@@ -134,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:
 
@@ -167,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:
 
@@ -206,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:
 
@@ -274,7 +267,7 @@ the same goal and same workload of the :ref:`Cluster <cluster_definition>`.
 Project
 =======
 
-:ref:`Projects <project_definition>` represent the base unit of “ownership”
+:ref:`Projects <project_definition>` represent the base unit of "ownership"
 in OpenStack, in that all :ref:`resources <managed_resource_definition>` in
 OpenStack should be owned by a specific :ref:`project <project_definition>`.
 In OpenStack Identity, a :ref:`project <project_definition>` must be owned by a

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/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 --config-file /etc/watcher/watcher.conf create_schema"
+     su -s /bin/sh -c "watcher-db-manage --config-file /etc/watcher/watcher.conf upgrade"

doc/source/install/index.rst

@@ -36,4 +36,4 @@ 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/queens/install/>`_.

doc/source/install/install-obs.rst

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

doc/source/install/install.rst

@@ -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/queens/install/.

doc/source/strategies/actuation.rst

@@ -0,0 +1,86 @@
+=============
+Actuator
+=============
+
+Synopsis
+--------
+
+**display name**: ``Actuator``
+
+**goal**: ``unclassified``
+
+    .. watcher-term:: watcher.decision_engine.strategy.strategies.actuation
+
+Requirements
+------------
+
+Metrics
+*******
+
+None
+
+Cluster data model
+******************
+
+None
+
+Actions
+*******
+
+Default Watcher's actions.
+
+Planner
+*******
+
+Default Watcher's planner:
+
+    .. watcher-term:: watcher.decision_engine.planner.weight.WeightPlanner
+
+Configuration
+-------------
+
+Strategy parameters are:
+
+==================== ====== ===================== =============================
+parameter            type   default Value         description
+==================== ====== ===================== =============================
+``actions``          array  None                  Actions to be executed.
+==================== ====== ===================== =============================
+
+The elements of actions array are:
+
+==================== ====== ===================== =============================
+parameter            type   default Value         description
+==================== ====== ===================== =============================
+``action_type``      string None                  Action name defined in
+                                                  setup.cfg(mandatory)
+``resource_id``      string None                  Resource_id of the action.
+``input_parameters`` object None                  Input_parameters of the
+                                                  action(mandatory).
+==================== ====== ===================== =============================
+
+Efficacy Indicator
+------------------
+
+None
+
+Algorithm
+---------
+
+This strategy create an action plan with a predefined set of actions.
+
+How to use it ?
+---------------
+
+.. code-block:: shell
+
+    $ openstack optimize audittemplate create \
+      at1 unclassified --strategy actuator
+
+    $ openstack optimize audit create -a at1 \
+      -p actions='[{"action_type": "migrate", "resource_id": "56a40802-6fde-4b59-957c-c84baec7eaed", "input_parameters": {"migration_type": "live", "source_node": "s01"}}]'
+
+External Links
+--------------
+
+None

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
 ******************

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
 ******************

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``
 

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``
 
@@ -36,7 +36,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
 ******************

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
@@ -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
@@ -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/strategies/zone_migration.rst

@@ -0,0 +1,154 @@
+==============
+Zone migration
+==============
+
+Synopsis
+--------
+
+**display name**: ``Zone migration``
+
+**goal**: ``hardware_maintenance``
+
+    .. watcher-term:: watcher.decision_engine.strategy.strategies.zone_migration
+
+Requirements
+------------
+
+Metrics
+*******
+
+None
+
+Cluster data model
+******************
+
+Default Watcher's Compute cluster data model:
+
+    .. watcher-term:: watcher.decision_engine.model.collector.nova.NovaClusterDataModelCollector
+
+Storage cluster data model is also required:
+
+    .. watcher-term:: watcher.decision_engine.model.collector.cinder.CinderClusterDataModelCollector
+
+Actions
+*******
+
+
+Default Watcher's actions:
+
+    .. list-table::
+       :widths: 30 30
+       :header-rows: 1
+
+       * - action
+         - description
+       * - ``migrate``
+         - .. watcher-term:: watcher.applier.actions.migration.Migrate
+       * - ``volume_migrate``
+         - .. watcher-term:: watcher.applier.actions.volume_migration.VolumeMigrate
+
+Planner
+*******
+
+Default Watcher's planner:
+
+    .. watcher-term:: watcher.decision_engine.planner.weight.WeightPlanner
+
+Configuration
+-------------
+
+Strategy parameters are:
+
+======================== ======== ============= ==============================
+parameter                type     default Value description
+======================== ======== ============= ==============================
+``compute_nodes``        array    None          Compute nodes to migrate.
+``storage_pools``        array    None          Storage pools to migrate.
+``parallel_total``       integer  6             The number of actions to be
+                                                run in parallel in total.
+``parallel_per_node``    integer  2             The number of actions to be
+                                                run in parallel per compute
+                                                node.
+``parallel_per_pool``    integer  2             The number of actions to be
+                                                run in parallel per storage
+                                                pool.
+``priority``             object   None          List prioritizes instances
+                                                and volumes.
+``with_attached_volume`` boolean  False         False: Instances will migrate
+                                                after all volumes migrate.
+                                                True: An instance will migrate
+                                                after the attached volumes
+                                                migrate.
+======================== ======== ============= ==============================
+
+The elements of compute_nodes array are:
+
+============= ======= =============== =============================
+parameter     type    default Value   description
+============= ======= =============== =============================
+``src_node``  string    None          Compute node from which
+                                      instances migrate(mandatory).
+``dst_node``  string    None          Compute node to which
+                                      instances migrate.
+============= ======= =============== =============================
+
+The elements of storage_pools array are:
+
+============= ======= =============== ==============================
+parameter     type    default Value   description
+============= ======= =============== ==============================
+``src_pool``  string    None          Storage pool from which
+                                      volumes migrate(mandatory).
+``dst_pool``  string    None          Storage pool to which
+                                      volumes migrate.
+``src_type``  string    None          Source volume type(mandatory).
+``dst_type``  string    None          Destination volume type
+                                      (mandatory).
+============= ======= =============== ==============================
+
+The elements of priority object are:
+
+================ ======= =============== ======================
+parameter        type    default Value   description
+================ ======= =============== ======================
+``project``      array   None            Project names.
+``compute_node`` array   None            Compute node names.
+``storage_pool`` array   None            Storage pool names.
+``compute``      enum    None            Instance attributes.
+                                         |compute|
+``storage``      enum    None            Volume attributes.
+                                         |storage|
+================ ======= =============== ======================
+
+.. |compute| replace:: ["vcpu_num", "mem_size", "disk_size", "created_at"]
+.. |storage| replace:: ["size", "created_at"]
+
+Efficacy Indicator
+------------------
+
+.. watcher-func::
+  :format: literal_block
+
+  watcher.decision_engine.goal.efficacy.specs.HardwareMaintenance.get_global_efficacy_indicator
+
+Algorithm
+---------
+
+For more information on the zone migration strategy please refer
+to: http://specs.openstack.org/openstack/watcher-specs/specs/queens/implemented/zone-migration-strategy.html
+
+How to use it ?
+---------------
+
+.. code-block:: shell
+
+    $ openstack optimize audittemplate create \
+      at1 hardware_maintenance --strategy zone_migration
+
+    $ openstack optimize audit create -a at1 \
+      -p compute_nodes='[{"src_node": "s01", "dst_node": "d01"}]'
+
+External Links
+--------------
+
+None

doc/source/user/user-guide.rst

@@ -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 ?
 ------------------------------------

etc/watcher/oslo-policy-generator/watcher-policy-generator.conf

@@ -0,0 +1,3 @@
+[DEFAULT]
+output_file = /etc/watcher/policy.yaml.sample
+namespace = watcher

etc/watcher/policy.json

@@ -1,45 +0,0 @@
-{
-    "admin_api": "role:admin or role:administrator",
-    "show_password": "!",
-    "default": "rule:admin_api",
-
-    "action:detail": "rule:default",
-    "action:get": "rule:default",
-    "action:get_all": "rule:default",
-
-    "action_plan:delete": "rule:default",
-    "action_plan:detail": "rule:default",
-    "action_plan:get": "rule:default",
-    "action_plan:get_all": "rule:default",
-    "action_plan:update": "rule:default",
-
-    "audit:create": "rule:default",
-    "audit:delete": "rule:default",
-    "audit:detail": "rule:default",
-    "audit:get": "rule:default",
-    "audit:get_all": "rule:default",
-    "audit:update": "rule:default",
-
-    "audit_template:create": "rule:default",
-    "audit_template:delete": "rule:default",
-    "audit_template:detail": "rule:default",
-    "audit_template:get": "rule:default",
-    "audit_template:get_all": "rule:default",
-    "audit_template:update": "rule:default",
-
-    "goal:detail": "rule:default",
-    "goal:get": "rule:default",
-    "goal:get_all": "rule:default",
-
-    "scoring_engine:detail": "rule:default",
-    "scoring_engine:get": "rule:default",
-    "scoring_engine:get_all": "rule:default",
-
-    "strategy:detail": "rule:default",
-    "strategy:get": "rule:default",
-    "strategy:get_all": "rule:default",
-
-    "service:detail": "rule:default",
-    "service:get": "rule:default",
-    "service:get_all": "rule:default"
-}

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/audit-scoper-for-storage-data-model-cdccc803542d22db.yaml

@@ -0,0 +1,5 @@
+---
+features:
+  - |
+    Adds audit scoper for storage data model, now watcher users can specify
+    audit scope for storage CDM in the same manner as compute scope.

releasenotes/notes/build-baremetal-data-model-in-watcher-3023453a47b61dab.yaml

@@ -0,0 +1,4 @@
+---
+features:
+  - |
+    Adds baremetal data model in Watcher

releasenotes/notes/cdm-scoping-8d9c307bad46bfa1.yaml

@@ -0,0 +1,6 @@
+---
+features:
+  - |
+    Each CDM collector can have its own CDM scoper now. This changed Scope
+    JSON schema definition for the audit template POST data. Please see audit
+    template create help message in python-watcherclient.

releasenotes/notes/check-strategy-requirements-66f9e9262412f8ec.yaml

@@ -0,0 +1,6 @@
+---
+features:
+  - Added a way to check state of strategy before audit's execution.
+    Administrator can use "watcher strategy state <strategy_name>" command
+    to get information about metrics' availability, datasource's availability
+    and CDM's availability.

releasenotes/notes/noisy-neighbor-strategy-a71342740b59dddc.yaml

@@ -1,5 +1,5 @@
 ---
 features:
   - Added strategy to identify and migrate a Noisy Neighbor - a low priority VM
-    that negatively affects peformance of a high priority VM by over utilizing
+    that negatively affects performance of a high priority VM by over utilizing
     Last Level Cache.

releasenotes/notes/storage-workload-balance-0ecabbc1791e6894.yaml

@@ -0,0 +1,4 @@
+---
+features:
+  - |
+    Added storage capacity balance strategy.

releasenotes/notes/workload-balance-base-on-cpu-or-ram-util-3ff4ee968c32b2ed.yaml

@@ -0,0 +1,7 @@
+---
+features:
+  - Existing workload_balance strategy based on
+    the VM workloads of CPU. This feature improves
+    the strategy. By the input parameter "metrics",
+    it makes decision to migrate a VM base on CPU
+    or memory utilization.

releasenotes/notes/zone-migration-strategy-10f7656a2a01e607.yaml

@@ -0,0 +1,6 @@
+---
+features:
+  - |
+    Added strategy "Zone migration" and it's goal "Hardware maintenance".
+    The strategy migrates many instances and volumes efficiently with
+    minimum downtime automatically.

releasenotes/source/conf.py

@@ -22,8 +22,8 @@
 # All configuration values have a default; values that are commented out
 # serve to show the default.
 
-import sys, os
-from watcher import version as watcher_version
+import os
+import sys
 
 # 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
@@ -56,14 +56,11 @@ master_doc = 'index'
 project = u'watcher'
 copyright = u'2016, Watcher developers'
 
-# 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.
-#
+# Release notes are version independent
 # The short X.Y version.
-version = watcher_version.version_info.release_string()
+version = ''
 # The full version, including alpha/beta/rc tags.
-release = watcher_version.version_info.version_string()
+release = ''
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

releasenotes/source/index.rst

@@ -21,6 +21,7 @@ Contents:
    :maxdepth: 1
 
    unreleased
+   pike
    ocata
    newton
 

releasenotes/source/locale/en_GB/LC_MESSAGES/releasenotes.po

@@ -0,0 +1,398 @@
+# Andi Chandler <andi@gowling.com>, 2017. #zanata
+# Andi Chandler <andi@gowling.com>, 2018. #zanata
+msgid ""
+msgstr ""
+"Project-Id-Version: watcher\n"
+"Report-Msgid-Bugs-To: \n"
+"POT-Creation-Date: 2018-01-26 00:18+0000\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+"PO-Revision-Date: 2018-01-27 12:50+0000\n"
+"Last-Translator: Andi Chandler <andi@gowling.com>\n"
+"Language-Team: English (United Kingdom)\n"
+"Language: en-GB\n"
+"X-Generator: Zanata 3.9.6\n"
+"Plural-Forms: nplurals=2; plural=(n != 1)\n"
+
+msgid "0.29.0"
+msgstr "0.29.0"
+
+msgid "0.34.0"
+msgstr "0.34.0"
+
+msgid "1.0.0"
+msgstr "1.0.0"
+
+msgid "1.1.0"
+msgstr "1.1.0"
+
+msgid "1.3.0"
+msgstr "1.3.0"
+
+msgid "1.4.0"
+msgstr "1.4.0"
+
+msgid "1.4.1"
+msgstr "1.4.1"
+
+msgid "1.5.0"
+msgstr "1.5.0"
+
+msgid "1.6.0"
+msgstr "1.6.0"
+
+msgid "1.7.0"
+msgstr "1.7.0"
+
+msgid "Add a service supervisor to watch Watcher deamons."
+msgstr "Add a service supervisor to watch Watcher daemons."
+
+msgid "Add action for compute node power on/off"
+msgstr "Add action for compute node power on/off"
+
+msgid ""
+"Add description property for dynamic action. Admin can see detail "
+"information of any specify action."
+msgstr ""
+"Add description property for dynamic action. Admin can see detail "
+"information of any specify action."
+
+msgid "Add notifications related to Action object."
+msgstr "Add notifications related to Action object."
+
+msgid "Add notifications related to Action plan object."
+msgstr "Add notifications related to Action plan object."
+
+msgid "Add notifications related to Audit object."
+msgstr "Add notifications related to Audit object."
+
+msgid "Add notifications related to Service object."
+msgstr "Add notifications related to Service object."
+
+msgid ""
+"Add superseded state for an action plan if the cluster data model has "
+"changed after it has been created."
+msgstr ""
+"Add superseded state for an action plan if the cluster data model has "
+"changed after it has been created."
+
+msgid "Added SUSPENDED audit state"
+msgstr "Added SUSPENDED audit state"
+
+msgid ""
+"Added a generic scoring engine module, which will standarize interactions "
+"with scoring engines through the common API. It is possible to use the "
+"scoring engine by different Strategies, which improve the code and data "
+"model re-use."
+msgstr ""
+"Added a generic scoring engine module, which will standardise interactions "
+"with scoring engines through the common API. It is possible to use the "
+"scoring engine by different Strategies, which improve the code and data "
+"model re-use."
+
+msgid ""
+"Added a new strategy based on the airflow of servers. This strategy makes "
+"decisions to migrate VMs to make the airflow uniform."
+msgstr ""
+"Added a new strategy based on the airflow of servers. This strategy makes "
+"decisions to migrate VMs to make the airflow uniform."
+
+msgid ""
+"Added a standard way to both declare and fetch configuration options so that "
+"whenever the administrator generates the Watcher configuration sample file, "
+"it contains the configuration options of the plugins that are currently "
+"available."
+msgstr ""
+"Added a standard way to both declare and fetch configuration options so that "
+"whenever the administrator generates the Watcher configuration sample file, "
+"it contains the configuration options of the plugins that are currently "
+"available."
+
+msgid ""
+"Added a strategy based on the VM workloads of hypervisors. This strategy "
+"makes decisions to migrate workloads to make the total VM workloads of each "
+"hypervisor balanced, when the total VM workloads of hypervisor reaches "
+"threshold."
+msgstr ""
+"Added a strategy based on the VM workloads of hypervisors. This strategy "
+"makes decisions to migrate workloads to make the total VM workloads of each "
+"hypervisor balanced, when the total VM workloads of hypervisor reaches "
+"threshold."
+
+msgid ""
+"Added a strategy that monitors if there is a higher load on some hosts "
+"compared to other hosts in the cluster and re-balances the work across hosts "
+"to minimize the standard deviation of the loads in the cluster."
+msgstr ""
+"Added a strategy that monitors if there is a higher load on some hosts "
+"compared to other hosts in the cluster and re-balances the work across hosts "
+"to minimise the standard deviation of the loads in the cluster."
+
+msgid ""
+"Added a way to add a new action without having to amend the source code of "
+"the default planner."
+msgstr ""
+"Added a way to add a new action without having to amend the source code of "
+"the default planner."
+
+msgid ""
+"Added a way to check state of strategy before audit's execution. "
+"Administrator can use \"watcher strategy state <strategy_name>\" command to "
+"get information about metrics' availability, datasource's availability and "
+"CDM's availability."
+msgstr ""
+"Added a way to check state of strategy before audit's execution. "
+"Administrator can use \"watcher strategy state <strategy_name>\" command to "
+"get information about metrics' availability, datasource's availability and "
+"CDM's availability."
+
+msgid ""
+"Added a way to compare the efficacy of different strategies for a give "
+"optimization goal."
+msgstr ""
+"Added a way to compare the efficacy of different strategies for a give "
+"optimisation goal."
+
+msgid ""
+"Added a way to create periodic audit to be able to optimize continuously the "
+"cloud infrastructure."
+msgstr ""
+"Added a way to create periodic audit to be able to continuously optimise the "
+"cloud infrastructure."
+
+msgid ""
+"Added a way to return the of available goals depending on which strategies "
+"have been deployed on the node where the decison engine is running."
+msgstr ""
+"Added a way to return the of available goals depending on which strategies "
+"have been deployed on the node where the decision engine is running."
+
+msgid ""
+"Added an in-memory cache of the cluster model built up and kept fresh via "
+"notifications from services of interest in addition to periodic syncing "
+"logic."
+msgstr ""
+"Added an in-memory cache of the cluster model built up and kept fresh via "
+"notifications from services of interest in addition to periodic syncing "
+"logic."
+
+msgid ""
+"Added binding between apscheduler job and Watcher decision engine service. "
+"It will allow to provide HA support in the future."
+msgstr ""
+"Added binding between apscheduler job and Watcher decision engine service. "
+"It will allow to provide HA support in the future."
+
+msgid "Added cinder cluster data model"
+msgstr "Added cinder cluster data model"
+
+msgid ""
+"Added gnocchi support as data source for metrics. Administrator can change "
+"data source for each strategy using config file."
+msgstr ""
+"Added Gnocchi support as data source for metrics. Administrator can change "
+"data source for each strategy using config file."
+
+msgid "Added policies to handle user rights to access Watcher API."
+msgstr "Added policies to handle user rights to access Watcher API."
+
+msgid "Added storage capacity balance strategy."
+msgstr "Added storage capacity balance strategy."
+
+msgid ""
+"Added strategy \"Zone migration\" and it's goal \"Hardware maintenance\". "
+"The strategy migrates many instances and volumes efficiently with minimum "
+"downtime automatically."
+msgstr ""
+"Added strategy \"Zone migration\" and it's goal \"Hardware maintenance\". "
+"The strategy migrates many instances and volumes efficiently with minimum "
+"downtime automatically."
+
+msgid ""
+"Added strategy to identify and migrate a Noisy Neighbor - a low priority VM "
+"that negatively affects peformance of a high priority VM by over utilizing "
+"Last Level Cache."
+msgstr ""
+"Added strategy to identify and migrate a Noisy Neighbour - a low priority VM "
+"that negatively affects performance of a high priority VM by over utilising "
+"Last Level Cache."
+
+msgid ""
+"Added the functionality to filter out instances which have metadata field "
+"'optimize' set to False. For now, this is only available for the "
+"basic_consolidation strategy (if \"check_optimize_metadata\" configuration "
+"option is enabled)."
+msgstr ""
+"Added the functionality to filter out instances which have metadata field "
+"'optimize' set to False. For now, this is only available for the "
+"basic_consolidation strategy (if \"check_optimize_metadata\" configuration "
+"option is enabled)."
+
+msgid "Added using of JSONSchema instead of voluptuous to validate Actions."
+msgstr "Added using of JSONSchema instead of voluptuous to validate Actions."
+
+msgid "Added volume migrate action"
+msgstr "Added volume migrate action"
+
+msgid ""
+"Adds audit scoper for storage data model, now watcher users can specify "
+"audit scope for storage CDM in the same manner as compute scope."
+msgstr ""
+"Adds audit scoper for storage data model, now watcher users can specify "
+"audit scope for storage CDM in the same manner as compute scope."
+
+msgid "Adds baremetal data model in Watcher"
+msgstr "Adds baremetal data model in Watcher"
+
+msgid ""
+"Allow decision engine to pass strategy parameters, like optimization "
+"threshold, to selected strategy, also strategy to provide parameters info to "
+"end user."
+msgstr ""
+"Allow decision engine to pass strategy parameters, like optimisation "
+"threshold, to selected strategy, also strategy to provide parameters info to "
+"end user."
+
+msgid "Centralize all configuration options for Watcher."
+msgstr "Centralise all configuration options for Watcher."
+
+msgid "Contents:"
+msgstr "Contents:"
+
+msgid ""
+"Copy all audit templates parameters into audit instead of having a reference "
+"to the audit template."
+msgstr ""
+"Copy all audit templates parameters into audit instead of having a reference "
+"to the audit template."
+
+msgid "Current Series Release Notes"
+msgstr "Current Series Release Notes"
+
+msgid ""
+"Each CDM collector can have its own CDM scoper now. This changed Scope JSON "
+"schema definition for the audit template POST data. Please see audit "
+"template create help message in python-watcherclient."
+msgstr ""
+"Each CDM collector can have its own CDM scoper now. This changed Scope JSON "
+"schema definition for the audit template POST data. Please see audit "
+"template create help message in python-watcherclient."
+
+msgid ""
+"Enhancement of vm_workload_consolidation strategy by using 'memory.resident' "
+"metric in place of 'memory.usage', as memory.usage shows the memory usage "
+"inside guest-os and memory.resident represents volume of RAM used by "
+"instance on host machine."
+msgstr ""
+"Enhancement of vm_workload_consolidation strategy by using 'memory.resident' "
+"metric in place of 'memory.usage', as memory.usage shows the memory usage "
+"inside guest-os and memory.resident represents volume of RAM used by "
+"instance on host machine."
+
+msgid ""
+"Existing workload_balance strategy based on the VM workloads of CPU. This "
+"feature improves the strategy. By the input parameter \"metrics\", it makes "
+"decision to migrate a VM base on CPU or memory utilization."
+msgstr ""
+"Existing workload_balance strategy based on the VM workloads of CPU. This "
+"feature improves the strategy. By the input parameter \"metrics\", it makes "
+"decision to migrate a VM base on CPU or memory utilisation."
+
+msgid "New Features"
+msgstr "New Features"
+
+msgid "Newton Series Release Notes"
+msgstr "Newton Series Release Notes"
+
+msgid "Ocata Series Release Notes"
+msgstr "Ocata Series Release Notes"
+
+msgid "Pike Series Release Notes"
+msgstr "Pike Series Release Notes"
+
+msgid ""
+"Provide a notification mechanism into Watcher that supports versioning. "
+"Whenever a Watcher object is created, updated or deleted, a versioned "
+"notification will, if it's relevant, be automatically sent to notify in "
+"order to allow an event-driven style of architecture within Watcher. "
+"Moreover, it will also give other services and/or 3rd party softwares (e.g. "
+"monitoring solutions or rules engines) the ability to react to such events."
+msgstr ""
+"Provide a notification mechanism into Watcher that supports versioning. "
+"Whenever a Watcher object is created, updated or deleted, a versioned "
+"notification will, if it's relevant, be automatically sent to notify in "
+"order to allow an event-driven style of architecture within Watcher. "
+"Moreover, it will also give other services and/or 3rd party software (e.g. "
+"monitoring solutions or rules engines) the ability to react to such events."
+
+msgid ""
+"Provides a generic way to define the scope of an audit. The set of audited "
+"resources will be called \"Audit scope\" and will be defined in each audit "
+"template (which contains the audit settings)."
+msgstr ""
+"Provides a generic way to define the scope of an audit. The set of audited "
+"resources will be called \"Audit scope\" and will be defined in each audit "
+"template (which contains the audit settings)."
+
+msgid ""
+"The graph model describes how VMs are associated to compute hosts. This "
+"allows for seeing relationships upfront between the entities and hence can "
+"be used to identify hot/cold spots in the data center and influence a "
+"strategy decision."
+msgstr ""
+"The graph model describes how VMs are associated to compute hosts. This "
+"allows for seeing relationships upfront between the entities and hence can "
+"be used to identify hot/cold spots in the data centre and influence a "
+"strategy decision."
+
+msgid ""
+"There is new ability to create Watcher continuous audits with cron interval. "
+"It means you may use, for example, optional argument '--interval \"\\*/5 \\* "
+"\\* \\* \\*\"' to launch audit every 5 minutes. These jobs are executed on a "
+"best effort basis and therefore, we recommend you to use a minimal cron "
+"interval of at least one minute."
+msgstr ""
+"There is new ability to create Watcher continuous audits with cron interval. "
+"It means you may use, for example, optional argument '--interval \"\\*/5 \\* "
+"\\* \\* \\*\"' to launch audit every 5 minutes. These jobs are executed on a "
+"best effort basis and therefore, we recommend you to use a minimal cron "
+"interval of at least one minute."
+
+msgid ""
+"Watcher can continuously optimize the OpenStack cloud for a specific "
+"strategy or goal by triggering an audit periodically which generates an "
+"action plan and run it automatically."
+msgstr ""
+"Watcher can continuously optimise the OpenStack cloud for a specific "
+"strategy or goal by triggering an audit periodically which generates an "
+"action plan and run it automatically."
+
+msgid ""
+"Watcher can now run specific actions in parallel improving the performances "
+"dramatically when executing an action plan."
+msgstr ""
+"Watcher can now run specific actions in parallel improving the performance "
+"dramatically when executing an action plan."
+
+msgid "Watcher database can now be upgraded thanks to Alembic."
+msgstr "Watcher database can now be upgraded thanks to Alembic."
+
+msgid ""
+"Watcher supports multiple metrics backend and relies on Ceilometer and "
+"Monasca."
+msgstr ""
+"Watcher supports multiple metrics backend and relies on Ceilometer and "
+"Monasca."
+
+msgid "Welcome to watcher's Release Notes documentation!"
+msgstr "Welcome to watcher's Release Notes documentation!"
+
+msgid ""
+"all Watcher objects have been refactored to support OVO (oslo."
+"versionedobjects) which was a prerequisite step in order to implement "
+"versioned notifications."
+msgstr ""
+"all Watcher objects have been refactored to support OVO (oslo."
+"versionedobjects) which was a prerequisite step in order to implement "
+"versioned notifications."

releasenotes/source/locale/fr/LC_MESSAGES/releasenotes.po

@@ -1,33 +0,0 @@
-# Gérald LONLAS <g.lonlas@gmail.com>, 2016. #zanata
-msgid ""
-msgstr ""
-"Project-Id-Version: watcher 1.0.1.dev51\n"
-"Report-Msgid-Bugs-To: \n"
-"POT-Creation-Date: 2017-03-21 11:57+0000\n"
-"MIME-Version: 1.0\n"
-"Content-Type: text/plain; charset=UTF-8\n"
-"Content-Transfer-Encoding: 8bit\n"
-"PO-Revision-Date: 2016-10-22 06:44+0000\n"
-"Last-Translator: Gérald LONLAS <g.lonlas@gmail.com>\n"
-"Language-Team: French\n"
-"Language: fr\n"
-"X-Generator: Zanata 3.9.6\n"
-"Plural-Forms: nplurals=2; plural=(n > 1)\n"
-
-msgid "0.29.0"
-msgstr "0.29.0"
-
-msgid "Contents:"
-msgstr "Contenu :"
-
-msgid "Current Series Release Notes"
-msgstr "Note de la release actuelle"
-
-msgid "New Features"
-msgstr "Nouvelles fonctionnalités"
-
-msgid "Newton Series Release Notes"
-msgstr "Note de release pour Newton"
-
-msgid "Welcome to watcher's Release Notes documentation!"
-msgstr "Bienvenue dans la documentation de la note de Release de Watcher"

releasenotes/source/pike.rst

@@ -0,0 +1,6 @@
+===================================
+ Pike Series Release Notes
+===================================
+
+.. release-notes::
+   :branch: stable/pike

requirements.txt

@@ -2,48 +2,48 @@
 # of appearance. Changing the order has an impact on the overall integration
 # process, which may cause wedges in the gate later.
 
-apscheduler # MIT License
-enum34;python_version=='2.7' or python_version=='2.6' or python_version=='3.3' # BSD
-jsonpatch>=1.1 # BSD
-keystoneauth1>=3.1.0 # Apache-2.0
-jsonschema!=2.5.0,<3.0.0,>=2.0.0 # MIT
-keystonemiddleware>=4.12.0 # Apache-2.0
-lxml!=3.7.0,>=2.3 # BSD
+apscheduler>=3.0.5 # MIT License
+enum34>=1.0.4;python_version=='2.7' or python_version=='2.6' or python_version=='3.3' # BSD
+jsonpatch!=1.20,>=1.16 # BSD
+keystoneauth1>=3.3.0 # Apache-2.0
+jsonschema<3.0.0,>=2.6.0 # MIT
+keystonemiddleware>=4.17.0 # Apache-2.0
+lxml!=3.7.0,>=3.4.1 # BSD
 croniter>=0.3.4 # MIT License
-oslo.concurrency>=3.8.0 # Apache-2.0
-oslo.cache>=1.5.0 # Apache-2.0
-oslo.config!=4.3.0,!=4.4.0,>=4.0.0 # Apache-2.0
-oslo.context>=2.14.0 # Apache-2.0
-oslo.db>=4.24.0 # Apache-2.0
-oslo.i18n!=3.15.2,>=2.1.0 # Apache-2.0
-oslo.log>=3.22.0 # Apache-2.0
-oslo.messaging!=5.25.0,>=5.24.2 # Apache-2.0
-oslo.policy>=1.23.0 # Apache-2.0
-oslo.reports>=0.6.0 # Apache-2.0
-oslo.serialization!=2.19.1,>=1.10.0 # Apache-2.0
-oslo.service>=1.10.0 # Apache-2.0
-oslo.utils>=3.20.0 # Apache-2.0
-oslo.versionedobjects>=1.17.0 # Apache-2.0
+oslo.concurrency>=3.25.0 # Apache-2.0
+oslo.cache>=1.26.0 # Apache-2.0
+oslo.config>=5.1.0 # Apache-2.0
+oslo.context>=2.19.2 # Apache-2.0
+oslo.db>=4.27.0 # Apache-2.0
+oslo.i18n>=3.15.3 # Apache-2.0
+oslo.log>=3.36.0 # Apache-2.0
+oslo.messaging>=5.29.0 # Apache-2.0
+oslo.policy>=1.30.0 # Apache-2.0
+oslo.reports>=1.18.0 # Apache-2.0
+oslo.serialization!=2.19.1,>=2.18.0 # Apache-2.0
+oslo.service!=1.28.1,>=1.24.0 # Apache-2.0
+oslo.utils>=3.33.0 # Apache-2.0
+oslo.versionedobjects>=1.31.2 # Apache-2.0
 PasteDeploy>=1.5.0 # MIT
 pbr!=2.1.0,>=2.0.0 # Apache-2.0
 pecan!=1.0.2,!=1.0.3,!=1.0.4,!=1.2,>=1.0.0 # BSD
 PrettyTable<0.8,>=0.7.1 # BSD
 voluptuous>=0.8.9 # BSD License
-gnocchiclient>=2.7.0 # Apache-2.0
+gnocchiclient>=3.3.1 # Apache-2.0
 python-ceilometerclient>=2.5.0 # Apache-2.0
-python-cinderclient>=3.1.0 # Apache-2.0
+python-cinderclient>=3.3.0 # Apache-2.0
 python-glanceclient>=2.8.0 # Apache-2.0
 python-keystoneclient>=3.8.0 # Apache-2.0
 python-monascaclient>=1.7.0 # Apache-2.0
 python-neutronclient>=6.3.0 # Apache-2.0
-python-novaclient>=9.0.0 # Apache-2.0
-python-openstackclient!=3.10.0,>=3.3.0 # Apache-2.0
-python-ironicclient>=1.14.0 # Apache-2.0
-six>=1.9.0 # MIT
+python-novaclient>=9.1.0 # Apache-2.0
+python-openstackclient>=3.12.0 # Apache-2.0
+python-ironicclient>=2.2.0 # Apache-2.0
+six>=1.10.0 # MIT
 SQLAlchemy!=1.1.5,!=1.1.6,!=1.1.7,!=1.1.8,>=1.0.10 # MIT
 stevedore>=1.20.0 # Apache-2.0
-taskflow>=2.7.0 # Apache-2.0
+taskflow>=2.16.0 # Apache-2.0
 WebOb>=1.7.1 # MIT
-WSME>=0.8 # MIT
-networkx>=1.10 # BSD
+WSME>=0.8.0 # MIT
+networkx<2.0,>=1.10 # BSD
 

setup.cfg

@@ -21,7 +21,6 @@ classifier =
 [files]
 packages =
     watcher
-    watcher_tempest_plugin
 data_files =
     etc/ = etc/*
 
@@ -33,6 +32,12 @@ setup-hooks =
 oslo.config.opts =
     watcher = watcher.conf.opts:list_opts
 
+oslo.policy.policies =
+    watcher = watcher.common.policies:list_rules
+
+oslo.policy.enforcer =
+    watcher = watcher.common.policy:get_enforcer
+
 console_scripts =
     watcher-api = watcher.cmd.api:main
     watcher-db-manage = watcher.cmd.dbmanage:main
@@ -40,9 +45,6 @@ console_scripts =
     watcher-applier = watcher.cmd.applier:main
     watcher-sync = watcher.cmd.sync:main
 
-tempest.test_plugins =
-    watcher_tests = watcher_tempest_plugin.plugin:WatcherTempestPlugin
-
 watcher.database.migration_backend =
     sqlalchemy = watcher.db.sqlalchemy.migration
 
@@ -55,6 +57,7 @@ watcher_goals =
     airflow_optimization = watcher.decision_engine.goal.goals:AirflowOptimization
     noisy_neighbor = watcher.decision_engine.goal.goals:NoisyNeighborOptimization
     saving_energy = watcher.decision_engine.goal.goals:SavingEnergy
+    hardware_maintenance = watcher.decision_engine.goal.goals:HardwareMaintenance
 
 watcher_scoring_engines =
     dummy_scorer = watcher.decision_engine.scoring.dummy_scorer:DummyScorer
@@ -75,6 +78,8 @@ watcher_strategies =
     workload_balance = watcher.decision_engine.strategy.strategies.workload_balance:WorkloadBalance
     uniform_airflow = watcher.decision_engine.strategy.strategies.uniform_airflow:UniformAirflow
     noisy_neighbor = watcher.decision_engine.strategy.strategies.noisy_neighbor:NoisyNeighbor
+    storage_capacity_balance = watcher.decision_engine.strategy.strategies.storage_capacity_balance:StorageCapacityBalance
+    zone_migration = watcher.decision_engine.strategy.strategies.zone_migration:ZoneMigration
 
 watcher_actions =
     migrate = watcher.applier.actions.migration:Migrate
@@ -95,16 +100,15 @@ watcher_planners =
 watcher_cluster_data_model_collectors =
     compute = watcher.decision_engine.model.collector.nova:NovaClusterDataModelCollector
     storage = watcher.decision_engine.model.collector.cinder:CinderClusterDataModelCollector
+    baremetal = watcher.decision_engine.model.collector.ironic:BaremetalClusterDataModelCollector
 
 
 [pbr]
-warnerrors = true
 autodoc_index_modules = true
 autodoc_exclude_modules =
     watcher.db.sqlalchemy.alembic.env
     watcher.db.sqlalchemy.alembic.versions.*
     watcher.tests.*
-    watcher_tempest_plugin.*
     watcher.doc
 
 

test-requirements.txt

@@ -3,25 +3,24 @@
 # process, which may cause wedges in the gate later.
 
 coverage!=4.4,>=4.0 # Apache-2.0
-doc8 # Apache-2.0
+doc8>=0.6.0 # Apache-2.0
 freezegun>=0.3.6 # Apache-2.0
 hacking!=0.13.0,<0.14,>=0.12.0 # Apache-2.0
-mock>=2.0 # BSD
-oslotest>=1.10.0 # Apache-2.0
-os-testr>=0.8.0 # Apache-2.0
-python-subunit>=0.0.18 # Apache-2.0/BSD
+mock>=2.0.0 # BSD
+oslotest>=3.2.0 # Apache-2.0
+os-testr>=1.0.0 # Apache-2.0
 testrepository>=0.0.18 # Apache-2.0/BSD
 testscenarios>=0.4 # Apache-2.0/BSD
-testtools>=1.4.0 # MIT
+testtools>=2.2.0 # MIT
 
 # Doc requirements
-openstackdocstheme>=1.16.0 # Apache-2.0
-sphinx>=1.6.2 # BSD
-sphinxcontrib-pecanwsme>=0.8 # Apache-2.0
+openstackdocstheme>=1.18.1 # Apache-2.0
+sphinx!=1.6.6,>=1.6.2 # BSD
+sphinxcontrib-pecanwsme>=0.8.0 # Apache-2.0
 
 
 # releasenotes
-reno!=2.3.1,>=1.8.0 # Apache-2.0
+reno>=2.5.0 # Apache-2.0
 
 # bandit
 bandit>=1.1.0 # Apache-2.0

tox.ini

@@ -14,7 +14,7 @@ deps = -r{toxinidir}/test-requirements.txt
 commands =
   rm -f .testrepository/times.dbm
   find . -type f -name "*.py[c|o]" -delete
-  ostestr --concurrency=6 {posargs}
+  stestr run {posargs}
 passenv = http_proxy HTTP_PROXY https_proxy HTTPS_PROXY no_proxy NO_PROXY
 
 [testenv:pep8]
@@ -46,7 +46,12 @@ sitepackages = False
 commands =
     oslo-config-generator --config-file etc/watcher/oslo-config-generator/watcher.conf
 
+[testenv:genpolicy]
+commands =
+    oslopolicy-sample-generator --config-file etc/watcher/oslo-policy-generator/watcher-policy-generator.conf
+
 [flake8]
+filename = *.py,app.wsgi
 show-source=True
 ignore= H105,E123,E226,N320,H202
 builtins= _

watcher/api/app.wsgi

@@ -37,4 +37,3 @@ LOG.debug("Configuration:")
 CONF.log_opt_values(LOG, log.DEBUG)
 
 application = app.VersionSelectorApplication()
-

watcher/api/controllers/v1/action.py

@@ -341,7 +341,7 @@ class ActionsController(rest.RestController):
 
     @wsme_pecan.wsexpose(Action, body=Action, status_code=201)
     def post(self, action):
-        """Create a new action.
+        """Create a new action(forbidden).
 
         :param action: a action within the request body.
         """
@@ -364,7 +364,7 @@ class ActionsController(rest.RestController):
     @wsme.validate(types.uuid, [ActionPatchType])
     @wsme_pecan.wsexpose(Action, types.uuid, body=[ActionPatchType])
     def patch(self, action_uuid, patch):
-        """Update an existing action.
+        """Update an existing action(forbidden).
 
         :param action_uuid: UUID of a action.
         :param patch: a json PATCH document to apply to this action.
@@ -401,7 +401,7 @@ class ActionsController(rest.RestController):
 
     @wsme_pecan.wsexpose(None, types.uuid, status_code=204)
     def delete(self, action_uuid):
-        """Delete a action.
+        """Delete a action(forbidden).
 
         :param action_uuid: UUID of a action.
         """

watcher/api/controllers/v1/action_plan.py

@@ -460,6 +460,15 @@ class ActionPlansController(rest.RestController):
         policy.enforce(context, 'action_plan:delete', action_plan,
                        action='action_plan:delete')
 
+        allowed_states = (ap_objects.State.SUCCEEDED,
+                          ap_objects.State.RECOMMENDED,
+                          ap_objects.State.FAILED,
+                          ap_objects.State.SUPERSEDED,
+                          ap_objects.State.CANCELLED)
+        if action_plan.state not in allowed_states:
+            raise exception.DeleteError(
+                state=action_plan.state)
+
         action_plan.soft_delete()
 
     @wsme.validate(types.uuid, [ActionPlanPatchType])

watcher/api/controllers/v1/audit.py

@@ -37,6 +37,8 @@ import wsme
 from wsme import types as wtypes
 import wsmeext.pecan as wsme_pecan
 
+from oslo_log import log
+
 from watcher._i18n import _
 from watcher.api.controllers import base
 from watcher.api.controllers import link
@@ -49,9 +51,13 @@ from watcher.common import utils
 from watcher.decision_engine import rpcapi
 from watcher import objects
 
+LOG = log.getLogger(__name__)
+
 
 class AuditPostType(wtypes.Base):
 
+    name = wtypes.wsattr(wtypes.text, mandatory=False)
+
     audit_template_uuid = wtypes.wsattr(types.uuid, mandatory=False)
 
     goal = wtypes.wsattr(wtypes.text, mandatory=False)
@@ -111,7 +117,30 @@ class AuditPostType(wtypes.Base):
                         setattr(self, k, at_attr)
                     except AttributeError:
                         pass
+
+        # Note: If audit name was not provided, used a default name
+        if not self.name:
+            if self.strategy:
+                strategy = objects.Strategy.get(context, self.strategy)
+                self.name = "%s-%s" % (strategy.name,
+                                       datetime.datetime.utcnow().isoformat())
+            elif self.audit_template_uuid:
+                audit_template = objects.AuditTemplate.get(
+                    context, self.audit_template_uuid)
+                self.name = "%s-%s" % (audit_template.name,
+                                       datetime.datetime.utcnow().isoformat())
+            else:
+                goal = objects.Goal.get(context, self.goal)
+                self.name = "%s-%s" % (goal.name,
+                                       datetime.datetime.utcnow().isoformat())
+        # No more than 63 characters
+        if len(self.name) > 63:
+            LOG.warning("Audit: %s length exceeds 63 characters",
+                        self.name)
+            self.name = self.name[0:63]
+
         return Audit(
+            name=self.name,
             audit_type=self.audit_type,
             parameters=self.parameters,
             goal_id=self.goal,
@@ -146,10 +175,10 @@ class AuditPatchType(types.JsonPatchType):
 
 
 class Audit(base.APIBase):
-    """API representation of a audit.
+    """API representation of an audit.
 
     This class enforces type checking and value constraints, and converts
-    between the internal object model and the API representation of a audit.
+    between the internal object model and the API representation of an audit.
     """
     _goal_uuid = None
     _goal_name = None
@@ -233,6 +262,9 @@ class Audit(base.APIBase):
     uuid = types.uuid
     """Unique UUID for this audit"""
 
+    name = wtypes.text
+    """Name of this audit"""
+
     audit_type = wtypes.text
     """Type of this audit"""
 
@@ -241,19 +273,19 @@ class Audit(base.APIBase):
 
     goal_uuid = wsme.wsproperty(
         wtypes.text, _get_goal_uuid, _set_goal_uuid, mandatory=True)
-    """Goal UUID the audit template refers to"""
+    """Goal UUID the audit refers to"""
 
     goal_name = wsme.wsproperty(
         wtypes.text, _get_goal_name, _set_goal_name, mandatory=False)
-    """The name of the goal this audit template refers to"""
+    """The name of the goal this audit refers to"""
 
     strategy_uuid = wsme.wsproperty(
         wtypes.text, _get_strategy_uuid, _set_strategy_uuid, mandatory=False)
-    """Strategy UUID the audit template refers to"""
+    """Strategy UUID the audit refers to"""
 
     strategy_name = wsme.wsproperty(
         wtypes.text, _get_strategy_name, _set_strategy_name, mandatory=False)
-    """The name of the strategy this audit template refers to"""
+    """The name of the strategy this audit refers to"""
 
     parameters = {wtypes.text: types.jsontype}
     """The strategy parameters for this audit"""
@@ -301,7 +333,7 @@ class Audit(base.APIBase):
     @staticmethod
     def _convert_with_links(audit, url, expand=True):
         if not expand:
-            audit.unset_fields_except(['uuid', 'audit_type', 'state',
+            audit.unset_fields_except(['uuid', 'name', 'audit_type', 'state',
                                        'goal_uuid', 'interval', 'scope',
                                        'strategy_uuid', 'goal_name',
                                        'strategy_name', 'auto_trigger',
@@ -324,6 +356,7 @@ class Audit(base.APIBase):
     @classmethod
     def sample(cls, expand=True):
         sample = cls(uuid='27e3153e-d5bf-4b7e-b517-fb518e17f34c',
+                     name='My Audit',
                      audit_type='ONESHOT',
                      state='PENDING',
                      created_at=datetime.datetime.utcnow(),
@@ -483,17 +516,17 @@ class AuditsController(rest.RestController):
                                            resource_url,
                                            goal=goal)
 
-    @wsme_pecan.wsexpose(Audit, types.uuid)
-    def get_one(self, audit_uuid):
+    @wsme_pecan.wsexpose(Audit, wtypes.text)
+    def get_one(self, audit):
         """Retrieve information about the given audit.
 
-        :param audit_uuid: UUID of a audit.
+        :param audit: UUID or name of an audit.
         """
         if self.from_audits:
             raise exception.OperationNotPermitted
 
         context = pecan.request.context
-        rpc_audit = api_utils.get_resource('Audit', audit_uuid)
+        rpc_audit = api_utils.get_resource('Audit', audit)
         policy.enforce(context, 'audit:get', rpc_audit, action='audit:get')
 
         return Audit.convert_with_links(rpc_audit)
@@ -502,7 +535,7 @@ class AuditsController(rest.RestController):
     def post(self, audit_p):
         """Create a new audit.
 
-        :param audit_p: a audit within the request body.
+        :param audit_p: an audit within the request body.
         """
         context = pecan.request.context
         policy.enforce(context, 'audit:create',
@@ -532,7 +565,7 @@ class AuditsController(rest.RestController):
 
         if no_schema and audit.parameters:
             raise exception.Invalid(_('Specify parameters but no predefined '
-                                      'strategy for audit template, or no '
+                                      'strategy for audit, or no '
                                       'parameter spec in predefined strategy'))
 
         audit_dict = audit.as_dict()
@@ -551,11 +584,11 @@ class AuditsController(rest.RestController):
         return Audit.convert_with_links(new_audit)
 
     @wsme.validate(types.uuid, [AuditPatchType])
-    @wsme_pecan.wsexpose(Audit, types.uuid, body=[AuditPatchType])
-    def patch(self, audit_uuid, patch):
+    @wsme_pecan.wsexpose(Audit, wtypes.text, body=[AuditPatchType])
+    def patch(self, audit, patch):
         """Update an existing audit.
 
-        :param audit_uuid: UUID of a audit.
+        :param audit: UUID or name of an audit.
         :param patch: a json PATCH document to apply to this audit.
         """
         if self.from_audits:
@@ -563,7 +596,7 @@ class AuditsController(rest.RestController):
 
         context = pecan.request.context
         audit_to_update = api_utils.get_resource(
-            'Audit', audit_uuid, eager=True)
+            'Audit', audit, eager=True)
         policy.enforce(context, 'audit:update', audit_to_update,
                        action='audit:update')
 
@@ -600,16 +633,23 @@ class AuditsController(rest.RestController):
         audit_to_update.save()
         return Audit.convert_with_links(audit_to_update)
 
-    @wsme_pecan.wsexpose(None, types.uuid, status_code=204)
-    def delete(self, audit_uuid):
-        """Delete a audit.
+    @wsme_pecan.wsexpose(None, wtypes.text, status_code=204)
+    def delete(self, audit):
+        """Delete an audit.
 
-        :param audit_uuid: UUID of a audit.
+        :param audit: UUID or name of an audit.
         """
         context = pecan.request.context
         audit_to_delete = api_utils.get_resource(
-            'Audit', audit_uuid, eager=True)
+            'Audit', audit, eager=True)
         policy.enforce(context, 'audit:update', audit_to_delete,
                        action='audit:update')
 
+        initial_state = audit_to_delete.state
+        new_state = objects.audit.State.DELETED
+        if not objects.audit.AuditStateTransitionManager(
+                ).check_transition(initial_state, new_state):
+            raise exception.DeleteError(
+                state=initial_state)
+
         audit_to_delete.soft_delete()

watcher/api/controllers/v1/audit_template.py

@@ -51,6 +51,8 @@ import wsme
 from wsme import types as wtypes
 import wsmeext.pecan as wsme_pecan
 
+from oslo_log import log
+
 from watcher._i18n import _
 from watcher.api.controllers import base
 from watcher.api.controllers import link
@@ -61,9 +63,11 @@ from watcher.common import context as context_utils
 from watcher.common import exception
 from watcher.common import policy
 from watcher.common import utils as common_utils
-from watcher.decision_engine.scope import default
+from watcher.decision_engine.loading import default as default_loading
 from watcher import objects
 
+LOG = log.getLogger(__name__)
+
 
 class AuditTemplatePostType(wtypes.Base):
     _ctx = context_utils.make_context()
@@ -94,6 +98,27 @@ class AuditTemplatePostType(wtypes.Base):
             scope=self.scope,
         )
 
+    @staticmethod
+    def _build_schema():
+        SCHEMA = {
+            "$schema": "http://json-schema.org/draft-04/schema#",
+            "type": "array",
+            "items": {
+                "type": "object",
+                "properties": AuditTemplatePostType._get_schemas(),
+                "additionalProperties": False
+            }
+        }
+        return SCHEMA
+
+    @staticmethod
+    def _get_schemas():
+        collectors = default_loading.ClusterDataModelCollectorLoader(
+            ).list_available()
+        schemas = {k: c.SCHEMA for k, c
+                   in collectors.items() if hasattr(c, "SCHEMA")}
+        return schemas
+
     @staticmethod
     def validate(audit_template):
         available_goals = objects.Goal.list(AuditTemplatePostType._ctx)
@@ -106,23 +131,25 @@ class AuditTemplatePostType(wtypes.Base):
         else:
             raise exception.InvalidGoal(goal=audit_template.goal)
 
-        common_utils.Draft4Validator(
-            default.DefaultScope.DEFAULT_SCHEMA).validate(audit_template.scope)
+        if audit_template.scope:
+            common_utils.Draft4Validator(
+                AuditTemplatePostType._build_schema()
+                ).validate(audit_template.scope)
 
-        include_host_aggregates = False
-        exclude_host_aggregates = False
-        for rule in audit_template.scope:
-            if 'host_aggregates' in rule:
-                include_host_aggregates = True
-            elif 'exclude' in rule:
-                for resource in rule['exclude']:
-                    if 'host_aggregates' in resource:
-                        exclude_host_aggregates = True
-        if include_host_aggregates and exclude_host_aggregates:
-            raise exception.Invalid(
-                message=_(
-                    "host_aggregates can't be "
-                    "included and excluded together"))
+            include_host_aggregates = False
+            exclude_host_aggregates = False
+            for rule in audit_template.scope[0]['compute']:
+                if 'host_aggregates' in rule:
+                    include_host_aggregates = True
+                elif 'exclude' in rule:
+                    for resource in rule['exclude']:
+                        if 'host_aggregates' in resource:
+                            exclude_host_aggregates = True
+            if include_host_aggregates and exclude_host_aggregates:
+                raise exception.Invalid(
+                    message=_(
+                        "host_aggregates can't be "
+                        "included and excluded together"))
 
         if audit_template.strategy:
             available_strategies = objects.Strategy.list(
@@ -448,7 +475,7 @@ class AuditTemplatesController(rest.RestController):
                                         sort_key, sort_dir, expand=False,
                                         resource_url=None):
         api_utils.validate_search_filters(
-            filters, list(objects.audit_template.AuditTemplate.fields.keys()) +
+            filters, list(objects.audit_template.AuditTemplate.fields) +
             ["goal_uuid", "goal_name", "strategy_uuid", "strategy_name"])
         limit = api_utils.validate_limit(limit)
         api_utils.validate_sort_dir(sort_dir)

watcher/api/controllers/v1/goal.py

@@ -170,7 +170,7 @@ class GoalsController(rest.RestController):
         limit = api_utils.validate_limit(limit)
         api_utils.validate_sort_dir(sort_dir)
 
-        sort_db_key = (sort_key if sort_key in objects.Goal.fields.keys()
+        sort_db_key = (sort_key if sort_key in objects.Goal.fields
                        else None)
 
         marker_obj = None

watcher/api/controllers/v1/service.py

@@ -104,7 +104,7 @@ class Service(base.APIBase):
     def __init__(self, **kwargs):
         super(Service, self).__init__()
 
-        fields = list(objects.Service.fields.keys()) + ['status']
+        fields = list(objects.Service.fields) + ['status']
         self.fields = []
         for field in fields:
             self.fields.append(field)
@@ -194,7 +194,7 @@ class ServicesController(rest.RestController):
         limit = api_utils.validate_limit(limit)
         api_utils.validate_sort_dir(sort_dir)
 
-        sort_db_key = (sort_key if sort_key in objects.Service.fields.keys()
+        sort_db_key = (sort_key if sort_key in objects.Service.fields
                        else None)
 
         marker_obj = None

watcher/api/controllers/v1/strategy.py

@@ -41,6 +41,7 @@ from watcher.api.controllers.v1 import utils as api_utils
 from watcher.common import exception
 from watcher.common import policy
 from watcher.common import utils as common_utils
+from watcher.decision_engine import rpcapi
 from watcher import objects
 
 
@@ -205,17 +206,18 @@ class StrategiesController(rest.RestController):
 
     _custom_actions = {
         'detail': ['GET'],
+        'state': ['GET'],
     }
 
     def _get_strategies_collection(self, filters, marker, limit, sort_key,
                                    sort_dir, expand=False, resource_url=None):
         api_utils.validate_search_filters(
-            filters, list(objects.strategy.Strategy.fields.keys()) +
+            filters, list(objects.strategy.Strategy.fields) +
             ["goal_uuid", "goal_name"])
         limit = api_utils.validate_limit(limit)
         api_utils.validate_sort_dir(sort_dir)
 
-        sort_db_key = (sort_key if sort_key in objects.Strategy.fields.keys()
+        sort_db_key = (sort_key if sort_key in objects.Strategy.fields
                        else None)
 
         marker_obj = None
@@ -288,6 +290,26 @@ class StrategiesController(rest.RestController):
         return self._get_strategies_collection(
             filters, marker, limit, sort_key, sort_dir, expand, resource_url)
 
+    @wsme_pecan.wsexpose(wtypes.text, wtypes.text)
+    def state(self, strategy):
+        """Retrieve a inforamation about strategy requirements.
+
+        :param strategy: name of the strategy.
+        """
+        context = pecan.request.context
+        policy.enforce(context, 'strategy:state', action='strategy:state')
+        parents = pecan.request.path.split('/')[:-1]
+        if parents[-2] != "strategies":
+            raise exception.HTTPNotFound
+        rpc_strategy = api_utils.get_resource('Strategy', strategy)
+        de_client = rpcapi.DecisionEngineAPI()
+        strategy_state = de_client.get_strategy_info(context,
+                                                     rpc_strategy.name)
+        strategy_state.extend([{
+            'type': 'Name', 'state': rpc_strategy.name,
+            'mandatory': '', 'comment': ''}])
+        return strategy_state
+
     @wsme_pecan.wsexpose(Strategy, wtypes.text)
     def get_one(self, strategy):
         """Retrieve information about the given strategy.

watcher/api/controllers/v1/utils.py

@@ -57,7 +57,7 @@ def validate_sort_dir(sort_dir):
 def validate_search_filters(filters, allowed_fields):
     # Very lightweight validation for now
     # todo: improve this (e.g. https://www.parse.com/docs/rest/guide/#queries)
-    for filter_name in filters.keys():
+    for filter_name in filters:
         if filter_name not in allowed_fields:
             raise wsme.exc.ClientSideError(
                 _("Invalid filter: %s") % filter_name)