OpenDev Migration Patch

This commit was bulk generated and pushed by the OpenDev sysadmins
as a part of the Git hosting and code review systems migration
detailed in these mailing list posts:

http://lists.openstack.org/pipermail/openstack-discuss/2019-March/003603.html
http://lists.openstack.org/pipermail/openstack-discuss/2019-April/004920.html

Attempts have been made to correct repository namespaces and
hostnames based on simple pattern matching, but it's possible some
were updated incorrectly or missed entirely. Please reach out to us
via the contact information listed at https://opendev.org/ with any
questions you may have.

.gitignore

@@ -24,6 +24,7 @@ pip-log.txt
 .coverage*
 .tox
 nosetests.xml
+.stestr/
 .testrepository
 .venv
 .idea
@@ -72,3 +73,6 @@ releasenotes/build
 
 # Desktop Service Store
 *.DS_Store
+
+# Autogenerated sample config file
+etc/watcher/watcher.conf.sample

.gitreview

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

.stestr.conf

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

.zuul.yaml

@@ -0,0 +1,45 @@
+- project:
+    templates:
+      - openstack-python-jobs
+      - openstack-python35-jobs
+      - publish-openstack-sphinx-docs
+      - check-requirements
+      - release-notes-jobs
+    check:
+      jobs:
+        - watcher-tempest-multinode
+
+    gate:
+      queue: watcher
+- 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/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/devstack
+      - openstack/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
@@ -296,6 +314,7 @@ function start_watcher {
 function stop_watcher {
     if [[ "$WATCHER_USE_MOD_WSGI" == "True" ]]; then
         disable_apache_site watcher-api
+	restart_apache_server
     else
         stop_process watcher-api
     fi

devstack/local.conf.compute

@@ -35,7 +35,7 @@ VNCSERVER_PROXYCLIENT_ADDRESS=$HOST_IP
 NOVA_INSTANCES_PATH=/opt/stack/data/instances
 
 # Enable the Ceilometer plugin for the compute agent
-enable_plugin ceilometer git://git.openstack.org/openstack/ceilometer
+enable_plugin ceilometer https://git.openstack.org/openstack/ceilometer
 disable_service ceilometer-acentral,ceilometer-collector,ceilometer-api
 
 LOGFILE=$DEST/logs/stack.sh.log

devstack/local.conf.controller

@@ -24,29 +24,23 @@ 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
+enable_plugin watcher-dashboard https://git.openstack.org/openstack/watcher-dashboard
 
 # Enable the Watcher plugin
-enable_plugin watcher git://git.openstack.org/openstack/watcher
+enable_plugin watcher https://git.openstack.org/openstack/watcher
 
 # Enable the Ceilometer plugin
-enable_plugin ceilometer git://git.openstack.org/openstack/ceilometer
+enable_plugin ceilometer https://git.openstack.org/openstack/ceilometer
 
 # This is the controller node, so disable the ceilometer compute agent
 disable_service ceilometer-acompute
+
 # Enable the ceilometer api explicitly(bug:1667678)
 enable_service ceilometer-api
 
 # 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.
@@ -165,7 +165,7 @@ You can easily generate and update a sample configuration file
 named :ref:`watcher.conf.sample <watcher_sample_configuration_files>` by using
 these following commands::
 
-    $ git clone git://git.openstack.org/openstack/watcher
+    $ git clone https://git.openstack.org/openstack/watcher
     $ cd watcher/
     $ tox -e genconfig
     $ vi etc/watcher/watcher.conf.sample
@@ -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.
@@ -430,6 +429,26 @@ to Watcher receives Nova notifications in ``watcher_notifications`` as well.
   * Restart the Nova services.
 
 
+Configure Cinder Notifications
+==============================
+
+Watcher can also consume notifications generated by the Cinder services, in
+order to build or update, in real time, its cluster data model related to
+storage resources. To do so, you have to update the Cinder configuration
+file on controller and volume nodes, in order to let Watcher receive Cinder
+notifications in a dedicated ``watcher_notifications`` channel.
+
+  * In the file ``/etc/cinder/cinder.conf``, update the section
+    ``[oslo_messaging_notifications]``, by redefining the list of topics
+    into which Cinder services will publish events ::
+
+      [oslo_messaging_notifications]
+      driver = messagingv2
+      topics = notifications,watcher_notifications
+
+  * Restart the Cinder services.
+
+
 Workers
 =======
 

doc/source/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

@@ -19,13 +19,13 @@ model. To enable the Watcher plugin with DevStack, add the following to the
 `[[local|localrc]]` section of your controller's `local.conf` to enable the
 Watcher plugin::
 
-    enable_plugin watcher git://git.openstack.org/openstack/watcher
+    enable_plugin watcher https://git.openstack.org/openstack/watcher
 
 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
@@ -25,7 +25,7 @@ Prerequisites
 This document assumes you are using Ubuntu or Fedora, and that you have the
 following tools available on your system:
 
-- Python_ 2.7 and 3.4
+- Python_ 2.7 and 3.5
 - git_
 - setuptools_
 - pip_
@@ -69,21 +69,21 @@ itself.
 
 These dependencies can be installed from PyPi_ using the Python tool pip_.
 
-.. _PyPi: http://pypi.python.org/
-.. _pip: http://pypi.python.org/pypi/pip
+.. _PyPi: https://pypi.python.org/
+.. _pip: https://pypi.python.org/pypi/pip
 
 However, your system *may* need additional dependencies that `pip` (and by
 extension, PyPi) cannot satisfy. These dependencies should be installed
 prior to using `pip`, and the installation method may vary depending on
 your platform.
 
-* Ubuntu 14.04::
+* Ubuntu 16.04::
 
     $ sudo apt-get install python-dev libssl-dev libmysqlclient-dev libffi-dev
 
-* Fedora 19+::
+* Fedora 24+::
 
-    $ sudo yum install openssl-devel libffi-devel mysql-devel
+    $ sudo dnf install redhat-rpm-config gcc python-devel libxml2-devel
 
 * CentOS 7::
 
@@ -125,7 +125,7 @@ You can re-activate this virtualenv for your current shell using:
 
 For more information on virtual environments, see virtualenv_.
 
-.. _virtualenv: http://www.virtualenv.org/
+.. _virtualenv: https://www.virtualenv.org/
 
 
 

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

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

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

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

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

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

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

@@ -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/action_plan_state_machine.txt

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

doc/source/image_src/plantuml/watcher_db_schema_diagram.txt

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

doc/source/images/architecture.svg

@@ -339,6 +339,34 @@
          style="fill:#ffffff;fill-rule:evenodd;stroke:#000000;stroke-width:1pt"
          transform="matrix(-0.8,0,0,-0.8,4.8,0)" />
     </marker>
+    <marker
+       inkscape:stockid="EmptyTriangleInL"
+       orient="auto"
+       refY="0"
+       refX="0"
+       id="EmptyTriangleInL-6"
+       style="overflow:visible">
+      <path
+         inkscape:connector-curvature="0"
+         id="path7091-2"
+         d="m 5.77,0 -8.65,5 0,-10 8.65,5 z"
+         style="fill:#ffffff;fill-rule:evenodd;stroke:#000000;stroke-width:1pt"
+         transform="matrix(-0.8,0,0,-0.8,4.8,0)" />
+    </marker>
+    <marker
+       inkscape:stockid="EmptyTriangleInL"
+       orient="auto"
+       refY="0"
+       refX="0"
+       id="EmptyTriangleInL-12"
+       style="overflow:visible">
+      <path
+         inkscape:connector-curvature="0"
+         id="path7091-70"
+         d="m 5.77,0 -8.65,5 0,-10 8.65,5 z"
+         style="fill:#ffffff;fill-rule:evenodd;stroke:#000000;stroke-width:1pt"
+         transform="matrix(-0.8,0,0,-0.8,4.8,0)" />
+    </marker>
   </defs>
   <sodipodi:namedview
      inkscape:document-units="mm"
@@ -348,13 +376,13 @@
      inkscape:pageopacity="0.0"
      inkscape:pageshadow="2"
      inkscape:zoom="1.4142136"
-     inkscape:cx="261.24633"
+     inkscape:cx="665.19215"
      inkscape:cy="108.90512"
-     inkscape:current-layer="g5356"
+     inkscape:current-layer="g4866-2-3"
      id="namedview4950"
      showgrid="true"
-     inkscape:window-width="1215"
-     inkscape:window-height="776"
+     inkscape:window-width="1211"
+     inkscape:window-height="698"
      inkscape:window-x="65"
      inkscape:window-y="24"
      inkscape:window-maximized="1">
@@ -381,6 +409,12 @@
     <g
        id="g5356"
        transform="translate(-15.096057,-107.16694)">
+      <path
+         sodipodi:nodetypes="cc"
+         inkscape:connector-curvature="0"
+         id="path3284-4-2-3-77-5-9"
+         d="m 813.66791,753.1462 0,-92.21768"
+         style="display:inline;fill:none;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;marker-start:url(#EmptyTriangleInL-6)" />
       <rect
          y="377.8927"
          x="96.920677"
@@ -875,8 +909,8 @@
          sodipodi:nodetypes="cc"
          inkscape:connector-curvature="0"
          id="path5110-9"
-         d="m 472.18905,726.66568 221.85496,0"
-         style="fill:none;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;display:inline" />
+         d="m 472.18905,726.66568 331.45651,0"
+         style="display:inline;fill:none;stroke:#000000;stroke-width:1.22230256px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1" />
       <path
          sodipodi:nodetypes="cc"
          inkscape:connector-curvature="0"
@@ -919,8 +953,8 @@
          sodipodi:nodetypes="cc"
          inkscape:connector-curvature="0"
          id="path3284-4-2-3-4-6"
-         d="m 540.57926,651.7922 179.16488,0"
-         style="fill:none;stroke:#000000;stroke-width:1;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:1.99999999, 1.99999999;stroke-dashoffset:0;marker-start:url(#TriangleInL);display:inline" />
+         d="m 543.75943,651.7922 280.63651,0"
+         style="display:inline;fill:none;stroke:#000000;stroke-width:1.25154257;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:2.50308524, 2.50308524;stroke-dashoffset:0;stroke-opacity:1;marker-start:url(#TriangleInL)" />
       <rect
          y="262.01205"
          x="451.89563"
@@ -1402,6 +1436,48 @@
          id="path5110-9-6"
          d="m 192.18905,726.66568 221.85496,0"
          style="display:inline;fill:none;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1" />
+      <g
+         id="g4866-2-3"
+         style="display:inline"
+         transform="matrix(1.7775787,0,0,1.7775787,991.15946,596.08131)">
+        <rect
+           style="display:inline;fill:#ffffff;stroke:#000000;stroke-width:0.562563;stroke-opacity:1"
+           id="rect4267-4-7-7-6"
+           width="49.81258"
+           height="24.243191"
+           x="-116.67716"
+           y="88.977051" />
+        <text
+           xml:space="preserve"
+           style="font-style:normal;font-weight:normal;font-size:11.73851585px;line-height:125%;font-family:Sans;text-align:center;letter-spacing:0px;word-spacing:0px;text-anchor:middle;display:inline;fill:#000000;fill-opacity:1;stroke:none"
+           x="-91.899979"
+           y="104.01585"
+           id="text5037-4-6-9-7"
+           sodipodi:linespacing="125%"><tspan
+             sodipodi:role="line"
+             x="-91.899979"
+             y="104.01585"
+             style="font-size:11.2512598px;text-align:center;text-anchor:middle"
+             id="tspan5184-3-5-5">cinder</tspan></text>
+      </g>
+      <path
+         sodipodi:nodetypes="cc"
+         inkscape:connector-curvature="0"
+         id="path3284-4-2-3-4-9-3"
+         d="m 824.37881,651.58554 0,102.98987"
+         style="display:inline;fill:none;stroke:#000000;stroke-width:1;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:1.99999999, 1.99999999;stroke-dashoffset:0;stroke-opacity:1;marker-start:none" />
+      <circle
+         r="2.6672709"
+         cy="693.98395"
+         cx="823.72699"
+         id="path13407-89-5"
+         style="color:#000000;display:inline;overflow:visible;visibility:visible;fill:#ececec;fill-opacity:1;fill-rule:nonzero;stroke:#000000;stroke-width:1;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1;marker:none;enable-background:accumulate" />
+      <path
+         sodipodi:nodetypes="cc"
+         inkscape:connector-curvature="0"
+         id="path3284-4-2-3-7-9"
+         d="m 804.16781,752.35205 0,-26.2061"
+         style="display:inline;fill:none;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;marker-start:url(#EmptyTriangleInL-12)" />
     </g>
   </g>
 </svg>

doc/source/install/common_configure.rst

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

doc/source/install/index.rst

@@ -10,7 +10,7 @@ Infrastructure Optimization service
    verify.rst
    next-steps.rst
 
-The Infrastructure Optimization service (watcher) provides
+The Infrastructure Optimization service (Watcher) provides
 flexible and scalable resource optimization service for
 multi-tenant OpenStack-based clouds.
 
@@ -21,7 +21,7 @@ applier. This provides a robust framework to realize a wide
 range of cloud optimization goals, including the reduction
 of data center operating costs, increased system performance
 via intelligent virtual machine migration, increased energy
-efficiency—and more!
+efficiency and more!
 
 Watcher also supports a pluggable architecture by which custom
 optimization algorithms, data metrics and data profilers can be
@@ -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``
 
@@ -22,7 +22,7 @@ The *vm_workload_consolidation* strategy requires the following metrics:
 ============================ ============ ======= =======
 metric                       service name plugins comment
 ============================ ============ ======= =======
-``memory``             	     ceilometer_  none
+``memory``                   ceilometer_  none
 ``disk.root.size``           ceilometer_  none
 ============================ ============ ======= =======
 
@@ -32,11 +32,11 @@ the strategy if available:
 ============================ ============ ======= =======
 metric                       service name plugins comment
 ============================ ============ ======= =======
-``memory.usage``             ceilometer_  none
+``memory.resident``          ceilometer_  none
 ``cpu_util``                 ceilometer_  none
 ============================ ============ ======= =======
 
-.. _ceilometer: http://docs.openstack.org/admin-guide/telemetry-measurements.html#openstack-compute
+.. _ceilometer: https://docs.openstack.org/ceilometer/latest/admin/telemetry-measurements.html#openstack-compute
 
 Cluster data model
 ******************

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/devstack-gate
+              dest: devstack-gate
+          EOF
+          /usr/zuul-env/bin/zuul-cloner -m clonemap.yaml --cache-dir /opt/git \
+              https://opendev.org \
+              openstack/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 https://opendev.org/openstack/ceilometer
+          # Enable watcher devstack plugin.
+          enable_plugin watcher https://opendev.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/devstack-gate
+              dest: devstack-gate
+          EOF
+          /usr/zuul-env/bin/zuul-cloner -m clonemap.yaml --cache-dir /opt/git \
+              https://opendev.org \
+              openstack/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 https://opendev.org/openstack/watcher
+
+          EOF
+        executable: /bin/bash
+        chdir: '{{ ansible_user_dir }}/workspace'
+      environment: '{{ zuul | zuul_legacy_vars }}'
+
+    - shell:
+        cmd: |
+          set -e
+          set -x
+          ENABLED_SERVICES=tempest
+          ENABLED_SERVICES+=,watcher-api,watcher-decision-engine,watcher-applier
+          export ENABLED_SERVICES
+
+          export PYTHONUNBUFFERED=true
+          export BRANCH_OVERRIDE=default
+          export PROJECTS="openstack/watcher $PROJECTS"
+          export DEVSTACK_PROJECT_FROM_GIT=python-watcherclient
+          if [ "$BRANCH_OVERRIDE" != "default" ] ; then
+              export OVERRIDE_ZUUL_BRANCH=$BRANCH_OVERRIDE
+          fi
+          function post_test_hook {
+              # Configure and run functional tests
+              $BASE/new/python-watcherclient/watcherclient/tests/functional/hooks/post_test_hook.sh
+          }
+          export -f post_test_hook
+
+          cp devstack-gate/devstack-vm-gate-wrap.sh ./safe-devstack-vm-gate-wrap.sh
+          ./safe-devstack-vm-gate-wrap.sh
+        executable: /bin/bash
+        chdir: '{{ ansible_user_dir }}/workspace'
+      environment: '{{ zuul | zuul_legacy_vars }}'

rally-jobs/README.rst

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

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

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

releasenotes/notes/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/audit-tag-vm-metadata-47a3e4468748853c.yaml

@@ -0,0 +1,6 @@
+---
+features:
+  - 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).

releasenotes/notes/background-jobs-ha-9d3cf3fe356f4705.yaml

@@ -0,0 +1,4 @@
+---
+features:
+  - Added binding between apscheduler job and Watcher decision engine service.
+    It will allow to provide HA support in the future.

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/change-ram-util-metric-4a3e6984b9dd968d.yaml

@@ -0,0 +1,8 @@
+---
+features:
+  - 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.

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/cron-based-continuous-audits-c3eedf28d9752b37.yaml

@@ -0,0 +1,7 @@
+---
+features:
+  - 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.

releasenotes/notes/dynamic-action-description-0e947b9e7ef2a134.yaml

@@ -0,0 +1,4 @@
+---
+features:
+  - Add description property for dynamic action. Admin can see detail information
+    of any specify action.

releasenotes/notes/gnocchi-watcher-43c25d391fbd3e9c.yaml

@@ -0,0 +1,4 @@
+---
+features:
+  - Added gnocchi support as data source for metrics. Administrator can change
+    data source for each strategy using config file.

releasenotes/notes/jsonschema-validation-79cab05d5295da00.yaml

@@ -0,0 +1,3 @@
+---
+features:
+  - Added using of JSONSchema instead of voluptuous to validate Actions.

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

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

releasenotes/notes/service-versioned-notifications-api-70367b79a565d900.yaml

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

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

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

releasenotes/notes/volume-migrate-action-fc57b0ce0e4c39ae.yaml

@@ -0,0 +1,4 @@
+---
+features:
+  - |
+    Added volume migrate action

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/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"