Merge "Fix damodel list return None error When has a compute node"

Reason:
When there is a compute node but no virtual machine,
the command 'watcher datamodel list' should display
the information of the compute node instead of return None.

Change-Id: Id5ff7f08ac8a9883af9f0313785b756d813ed5a2
Closes-Bug: #1844948

.gitreview

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

.zuul.yaml

@@ -4,54 +4,45 @@
       - openstack-cover-jobs
       - openstack-lower-constraints-jobs
       - openstack-python-jobs
-      - openstack-python35-jobs
-      - openstack-python36-jobs
+      - openstack-python3-train-jobs
       - publish-openstack-docs-pti
       - release-notes-jobs-python3
     check:
       jobs:
         - watcher-tempest-functional
         - watcher-grenade
-        - watcher-tempest-dummy_optim
+        - watcher-tempest-strategies
         - watcher-tempest-actuator
-        - watcher-tempest-basic_optim
-        - watcher-tempest-vm_workload_consolidation
-        - watcher-tempest-workload_balancing
         - watcherclient-tempest-functional
-        - watcher-tempest-zone_migration
-        - watcher-tempest-host_maintenance
-        - watcher-tempest-storage_balance
         - watcher-tls-test
+        - watcher-tempest-functional-ipv6-only
     gate:
       queue: watcher
       jobs:
         - watcher-tempest-functional
+        - watcher-tempest-functional-ipv6-only
 
 - job:
     name: watcher-tempest-dummy_optim
     parent: watcher-tempest-multinode
-    voting: false
     vars:
       tempest_test_regex: watcher_tempest_plugin.tests.scenario.test_execute_dummy_optim
 
 - job:
     name: watcher-tempest-actuator
     parent: watcher-tempest-multinode
-    voting: false
     vars:
       tempest_test_regex: watcher_tempest_plugin.tests.scenario.test_execute_actuator
 
 - job:
     name: watcher-tempest-basic_optim
     parent: watcher-tempest-multinode
-    voting: false
     vars:
       tempest_test_regex: watcher_tempest_plugin.tests.scenario.test_execute_basic_optim
 
 - job:
     name: watcher-tempest-vm_workload_consolidation
     parent: watcher-tempest-multinode
-    voting: false
     vars:
       tempest_test_regex: watcher_tempest_plugin.tests.scenario.test_execute_vm_workload_consolidation
       devstack_local_conf:
@@ -63,28 +54,24 @@
 - job:
     name: watcher-tempest-workload_balancing
     parent: watcher-tempest-multinode
-    voting: false
     vars:
       tempest_test_regex: watcher_tempest_plugin.tests.scenario.test_execute_workload_balancing
 
 - job:
     name: watcher-tempest-zone_migration
     parent: watcher-tempest-multinode
-    voting: false
     vars:
       tempest_test_regex: watcher_tempest_plugin.tests.scenario.test_execute_zone_migration
 
 - job:
     name: watcher-tempest-host_maintenance
     parent: watcher-tempest-multinode
-    voting: false
     vars:
       tempest_test_regex: watcher_tempest_plugin.tests.scenario.test_execute_host_maintenance
 
 - job:
     name: watcher-tempest-storage_balance
     parent: watcher-tempest-multinode
-    voting: false
     vars:
       tempest_test_regex: watcher_tempest_plugin.tests.scenario.test_execute_storage_balance
       devstack_local_conf:
@@ -95,6 +82,13 @@
             volume-feature-enabled:
               multi_backend: true
 
+- job:
+    name: watcher-tempest-strategies
+    parent: watcher-tempest-multinode
+    vars:
+      tempest_concurrency: 1
+      tempest_test_regex: watcher_tempest_plugin.tests.scenario.test_execute_strategies
+
 - job:
     name: watcher-tls-test
     parent: watcher-tempest-multinode
@@ -109,7 +103,7 @@
 - job:
     name: watcher-tempest-multinode
     parent: watcher-tempest-functional
-    nodeset: openstack-two-node
+    nodeset: openstack-two-node-bionic
     roles:
       - zuul: openstack/tempest
     group-vars:
@@ -152,27 +146,30 @@
           $TEMPEST_CONFIG:
             compute:
               min_compute_nodes: 2
+              min_microversion: 2.56
             compute-feature-enabled:
               live_migration: true
               block_migration_for_live_migration: true
+            placement:
+              min_microversion: 1.29
       devstack_plugins:
-        ceilometer: https://git.openstack.org/openstack/ceilometer
+        ceilometer: https://opendev.org/openstack/ceilometer
 
 - job:
     name: watcher-tempest-functional
     parent: devstack-tempest
     timeout: 7200
-    required-projects:
+    required-projects: &base_required_projects
       - openstack/ceilometer
-      - openstack-infra/devstack-gate
+      - openstack/devstack-gate
       - openstack/python-openstackclient
       - openstack/python-watcherclient
       - openstack/watcher
       - openstack/watcher-tempest-plugin
       - openstack/tempest
-    vars:
+    vars: &base_vars
       devstack_plugins:
-        watcher: https://git.openstack.org/openstack/watcher
+        watcher: https://opendev.org/openstack/watcher
       devstack_services:
         tls-proxy: false
         watcher-api: true
@@ -193,6 +190,14 @@
       zuul_copy_output:
         /etc/hosts: logs
 
+- job:
+    name: watcher-tempest-functional-ipv6-only
+    parent: devstack-tempest-ipv6
+    description: |
+      Watcher devstack tempest tests job for IPv6-only deployment
+    required-projects: *base_required_projects
+    vars: *base_vars
+
 - job:
     name: watcher-grenade
     parent: legacy-dsvm-base
@@ -211,8 +216,8 @@
       - ^tools/.*$
       - ^tox.ini$
     required-projects:
-      - openstack-dev/grenade
-      - openstack-infra/devstack-gate
+      - openstack/grenade
+      - openstack/devstack-gate
       - openstack/watcher
       - openstack/python-watcherclient
       - openstack/watcher-tempest-plugin
@@ -221,7 +226,6 @@
     # This job is used in python-watcherclient repo
     name: watcherclient-tempest-functional
     parent: watcher-tempest-functional
-    voting: false
     timeout: 4200
     vars:
       tempest_concurrency: 1

README.rst

@@ -26,7 +26,8 @@ migration, increased energy efficiency and more!
 
 * Free software: Apache license
 * Wiki: https://wiki.openstack.org/wiki/Watcher
-* Source: https://github.com/openstack/watcher
+* Source: https://opendev.org/openstack/watcher
 * Bugs: https://bugs.launchpad.net/watcher
 * Documentation: https://docs.openstack.org/watcher/latest/
 * Release notes: https://docs.openstack.org/releasenotes/watcher/
+* Design specifications: https://specs.openstack.org/openstack/watcher-specs/

api-ref/source/index.rst

@@ -15,3 +15,4 @@ Watcher API
 .. include:: watcher-api-v1-strategies.inc
 .. include:: watcher-api-v1-services.inc
 .. include:: watcher-api-v1-scoring_engines.inc
+.. include:: watcher-api-v1-datamodel.inc

api-ref/source/parameters.yaml

@@ -129,6 +129,14 @@ r_strategy:
   in: query
   required: false
   type: string
+r_type:
+  description: |
+    Type of data model user want to list. Default type is compute.
+    Supported values: compute.
+    Future support values: storage, baremetal.
+  in: query
+  required: false
+  type: string
 sort_dir:
   description: |
     Sorts the response by the requested sort direction.
@@ -245,6 +253,13 @@ audit_endtime_resp:
   required: false
   type: string
   min_version: 1.1
+audit_force:
+  description: |
+    Launch audit even if action plan is ongoing.
+  in: body
+  required: false
+  type: boolean
+  min_version: 1.2
 audit_goal:
   description: |
     The UUID or name of the Goal.
@@ -404,6 +419,62 @@ links:
   required: true
   type: array
 
+# Data Model Node
+node_disk:
+  description: |
+    The Disk of the node(in GiB).
+  in: body
+  required: true
+  type: integer
+node_disk_ratio:
+  description: |
+    The Disk Ratio of the node.
+  in: body
+  required: true
+  type: float
+node_hostname:
+  description: |
+    The Host Name of the node.
+  in: body
+  required: true
+  type: string
+node_memory:
+  description: |
+    The Memory of the node(in MiB).
+  in: body
+  required: true
+  type: integer
+node_memory_ratio:
+  description: |
+    The Memory Ratio of the node.
+  in: body
+  required: true
+  type: float
+node_state:
+  description: |
+    The State of the node. The value is up or down.
+  in: body
+  required: true
+  type: string
+node_uuid:
+  description: |
+    The Unique UUID of the node.
+  in: body
+  required: true
+  type: string
+node_vcpu_ratio:
+  description: |
+    The Vcpu ratio of the node.
+  in: body
+  required: true
+  type: float
+node_vcpus:
+  description: |
+    The Vcpu of the node.
+  in: body
+  required: true
+  type: integer
+
 # Scoring Engine
 scoring_engine_description:
   description: |
@@ -423,34 +494,72 @@ scoring_engine_name:
   in: body
   required: true
   type: string
+
+# Data Model Server
+server_disk:
+  description: |
+    The Disk of the server.
+  in: body
+  required: true
+  type: integer
+server_memory:
+  description: |
+    The Memory of server.
+  in: body
+  required: true
+  type: integer
+server_name:
+  description: |
+    The Name of the server.
+  in: body
+  required: true
+  type: string
+server_state:
+  description: |
+    The State of the server.
+  in: body
+  required: true
+  type: string
+server_uuid:
+  description: |
+    The Unique UUID of the server.
+  in: body
+  required: true
+  type: string
+server_vcpus:
+  description: |
+    The Vcpu of the server.
+  in: body
+  required: true
+  type: integer
 # Service
 service_host:
   description: |
-    Name of host where service is placed on.
+    The Name of host where service is placed on.
   in: body
   required: true
   type: string
 service_id:
   description: |
-    ID of service.
+    The ID of service.
   in: body
   required: true
   type: integer
 service_last_seen_up:
   description: |
-    Time when Watcher service sent latest heartbeat.
+    The Time when Watcher service sent latest heartbeat.
   in: body
   required: true
   type: string
 service_name:
   description: |
-    Name of service like ``watcher-applier``.
+    The Name of service like ``watcher-applier``.
   in: body
   required: true
   type: string
 service_status:
   description: |
-    State of service. It can be either in ACTIVE or FAILED state.
+    The State of service. It can be either in ACTIVE or FAILED state.
   in: body
   required: true
   type: string

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

@@ -28,6 +28,7 @@
         }
     },
     "auto_trigger": false,
+    "force": false,
     "uuid": "65a5da84-5819-4aea-8278-a28d2b489028",
     "goal_name": "workload_balancing",
     "scope": [],

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

@@ -1,5 +1,6 @@
 {
     "auto_trigger": false,
+    "force": false,
     "audit_template_uuid": "76fddfee-a9c4-40b0-8da0-c19ad6904f09",
     "name": "test_audit",
     "parameters": {

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

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

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

@@ -28,6 +28,7 @@
         }
     },
     "auto_trigger": false,
+    "force": false,
     "uuid": "65a5da84-5819-4aea-8278-a28d2b489028",
     "goal_name": "workload_balancing",
     "scope": [],

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

@@ -30,6 +30,7 @@
                 }
             },
             "auto_trigger": false,
+	    "force": false,
             "uuid": "65a5da84-5819-4aea-8278-a28d2b489028",
             "goal_name": "workload_balancing",
             "scope": [],

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

@@ -28,6 +28,7 @@
         }
     },
     "auto_trigger": false,
+    "force": false,
     "uuid": "65a5da84-5819-4aea-8278-a28d2b489028",
     "goal_name": "workload_balancing",
     "scope": [],

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

@@ -28,6 +28,7 @@
         }
     },
     "auto_trigger": false,
+    "force": false,
     "uuid": "65a5da84-5819-4aea-8278-a28d2b489028",
     "goal_name": "workload_balancing",
     "scope": [],

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

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

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

@@ -47,6 +47,7 @@ Request
    - auto_trigger: audit_autotrigger
    - start_time: audit_starttime_req
    - end_time: audit_endtime_req
+   - force: audit_force
 
 **Example ONESHOT Audit creation request:**
 
@@ -83,6 +84,7 @@ version 1:
     - hostname: audit_hostname
     - start_time: audit_starttime_resp
     - end_time: audit_endtime_resp
+    - force: audit_force
 
 **Example JSON representation of an Audit:**
 
@@ -181,6 +183,7 @@ Response
     - hostname: audit_hostname
     - start_time: audit_starttime_resp
     - end_time: audit_endtime_resp
+    - force: audit_force
 
 **Example JSON representation of an Audit:**
 
@@ -227,6 +230,7 @@ Response
     - hostname: audit_hostname
     - start_time: audit_starttime_resp
     - end_time: audit_endtime_resp
+    - force: audit_force
 
 **Example JSON representation of an Audit:**
 
@@ -281,6 +285,7 @@ version 1:
     - hostname: audit_hostname
     - start_time: audit_starttime_resp
     - end_time: audit_endtime_resp
+    - force: audit_force
 
 **Example JSON representation of an Audit:**
 
@@ -335,6 +340,7 @@ Response
     - hostname: audit_hostname
     - start_time: audit_starttime_resp
     - end_time: audit_endtime_resp
+    - force: audit_force
 
 **Example JSON representation of an Audit:**
 

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

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

devstack/lib/watcher

@@ -51,7 +51,19 @@ if is_ssl_enabled_service "watcher" || is_service_enabled tls-proxy; then
     WATCHER_SERVICE_PROTOCOL="https"
 fi
 
-WATCHER_USE_MOD_WSGI=$(trueorfalse True WATCHER_USE_MOD_WSGI)
+# Support entry points installation of console scripts
+if [[ -d $WATCHER_DIR/bin ]]; then
+    WATCHER_BIN_DIR=$WATCHER_DIR/bin
+else
+    WATCHER_BIN_DIR=$(get_python_exec_prefix)
+fi
+
+# There are 2 modes, which is "uwsgi" which runs with an apache
+# proxy uwsgi in front of it, or "mod_wsgi", which runs in
+# apache. mod_wsgi is deprecated, don't use it.
+WATCHER_USE_WSGI_MODE=${WATCHER_USE_WSGI_MODE:-$WSGI_MODE}
+WATCHER_UWSGI=$WATCHER_BIN_DIR/watcher-api-wsgi
+WATCHER_UWSGI_CONF=$WATCHER_CONF_DIR/watcher-uwsgi.ini
 
 if is_suse; then
     WATCHER_WSGI_DIR=${WATCHER_WSGI_DIR:-/srv/www/htdocs/watcher}
@@ -59,16 +71,15 @@ else
     WATCHER_WSGI_DIR=${WATCHER_WSGI_DIR:-/var/www/watcher}
 fi
 # Public facing bits
-WATCHER_SERVICE_HOST=${WATCHER_SERVICE_HOST:-$HOST_IP}
+WATCHER_SERVICE_HOST=${WATCHER_SERVICE_HOST:-$SERVICE_HOST}
 WATCHER_SERVICE_PORT=${WATCHER_SERVICE_PORT:-9322}
 WATCHER_SERVICE_PORT_INT=${WATCHER_SERVICE_PORT_INT:-19322}
 WATCHER_SERVICE_PROTOCOL=${WATCHER_SERVICE_PROTOCOL:-$SERVICE_PROTOCOL}
 
-# Support entry points installation of console scripts
-if [[ -d $WATCHER_DIR/bin ]]; then
-    WATCHER_BIN_DIR=$WATCHER_DIR/bin
+if [[ "$WATCHER_USE_WSGI_MODE" == "uwsgi" ]]; then
+    WATCHER_API_URL="$WATCHER_SERVICE_PROTOCOL://$WATCHER_SERVICE_HOST/infra-optim"
 else
-    WATCHER_BIN_DIR=$(get_python_exec_prefix)
+    WATCHER_API_URL="$WATCHER_SERVICE_PROTOCOL://$WATCHER_SERVICE_HOST:$WATCHER_SERVICE_PORT"
 fi
 
 # Entry Points
@@ -93,7 +104,9 @@ function _cleanup_watcher_apache_wsgi {
 # runs that a clean run would need to clean up
 function cleanup_watcher {
     sudo rm -rf $WATCHER_STATE_PATH $WATCHER_AUTH_CACHE_DIR
-    if [[ "$WATCHER_USE_MOD_WSGI" == "True" ]]; then
+    if [[ "$WATCHER_USE_WSGI_MODE" == "uwsgi" ]]; then
+        remove_uwsgi_config "$WATCHER_UWSGI_CONF" "$WATCHER_UWSGI"
+    else
         _cleanup_watcher_apache_wsgi
     fi
 }
@@ -139,15 +152,15 @@ function create_watcher_accounts {
         "infra-optim" "Watcher Infrastructure Optimization Service")
     get_or_create_endpoint $watcher_service \
         "$REGION_NAME" \
-        "$WATCHER_SERVICE_PROTOCOL://$WATCHER_SERVICE_HOST:$WATCHER_SERVICE_PORT" \
-        "$WATCHER_SERVICE_PROTOCOL://$WATCHER_SERVICE_HOST:$WATCHER_SERVICE_PORT" \
-        "$WATCHER_SERVICE_PROTOCOL://$WATCHER_SERVICE_HOST:$WATCHER_SERVICE_PORT"
+        "$WATCHER_API_URL"\
+        "$WATCHER_API_URL"\
+        "$WATCHER_API_URL"
 }
 
 # _config_watcher_apache_wsgi() - Set WSGI config files of watcher
 function _config_watcher_apache_wsgi {
     local watcher_apache_conf
-    if [[ "$WATCHER_USE_MOD_WSGI" == "True" ]]; then
+    if [[ "$WATCHER_USE_WSGI_MODE" == "mod_wsgi" ]]; then
         local service_port=$WATCHER_SERVICE_PORT
         if is_service_enabled tls-proxy; then
             service_port=$WATCHER_SERVICE_PORT_INT
@@ -165,8 +178,6 @@ function _config_watcher_apache_wsgi {
             s|%APACHE_NAME%|$APACHE_NAME|g;
         " -i $watcher_apache_conf
         enable_apache_site watcher-api
-        tail_log watcher-access /var/log/$APACHE_NAME/watcher-api-access.log
-        tail_log watcher-api /var/log/$APACHE_NAME/watcher-api.log
    fi
 
 }
@@ -182,13 +193,17 @@ function create_watcher_conf {
     iniset_rpc_backend watcher $WATCHER_CONF
 
     iniset $WATCHER_CONF database connection $(database_connection_url watcher)
-    iniset $WATCHER_CONF api host "$WATCHER_SERVICE_HOST"
+    iniset $WATCHER_CONF api host "$(ipv6_unquote $WATCHER_SERVICE_HOST)"
 
     if is_service_enabled tls-proxy; then
+        iniset $WATCHER_CONF api host "$(ipv6_unquote $WATCHER_SERVICE_HOST)"
         iniset $WATCHER_CONF api port "$WATCHER_SERVICE_PORT_INT"
         # iniset $WATCHER_CONF api enable_ssl_api "True"
     else
-        iniset $WATCHER_CONF api port "$WATCHER_SERVICE_PORT"
+        if [[ "$WATCHER_USE_WSGI_MODE" == "mod_wsgi" ]]; then
+            iniset $WATCHER_CONF api host "$(ipv6_unquote $WATCHER_SERVICE_HOST)"
+            iniset $WATCHER_CONF api port "$WATCHER_SERVICE_PORT"
+        fi
     fi
 
     iniset $WATCHER_CONF oslo_policy policy_file $WATCHER_POLICY_YAML
@@ -214,15 +229,12 @@ function create_watcher_conf {
     fi
 
     # Format logging
-    if [ "$LOG_COLOR" == "True" ] && [ "$SYSLOG" == "False" ]; then
-        setup_colorized_logging $WATCHER_CONF DEFAULT
-    else
-        # Show user_name and project_name instead of user_id and project_id
-        iniset $WATCHER_CONF DEFAULT logging_context_format_string "%(asctime)s.%(msecs)03d %(levelname)s %(name)s [%(request_id)s %(project_domain)s %(user_name)s %(project_name)s] %(instance)s%(message)s"
-    fi
+    setup_logging $WATCHER_CONF
 
     #config apache files
-    if [[ "$WATCHER_USE_MOD_WSGI" == "True" ]]; then
+    if [[ "$WATCHER_USE_WSGI_MODE" == "uwsgi" ]]; then
+        write_uwsgi_config "$WATCHER_UWSGI_CONF" "$WATCHER_UWSGI" "/infra-optim"
+    else
         _config_watcher_apache_wsgi
     fi
     # Register SSL certificates if provided
@@ -234,10 +246,6 @@ function create_watcher_conf {
 
         iniset $WATCHER_CONF DEFAULT enabled_ssl_apis "$WATCHER_ENABLED_APIS"
     fi
-
-    if is_service_enabled ceilometer; then
-        iniset $WATCHER_CONF watcher_messaging notifier_driver "messaging"
-    fi
 }
 
 # create_watcher_cache_dir() - Part of the init_watcher() process
@@ -273,7 +281,7 @@ function install_watcherclient {
 function install_watcher {
     git_clone $WATCHER_REPO $WATCHER_DIR $WATCHER_BRANCH
     setup_develop $WATCHER_DIR
-    if [[ "$WATCHER_USE_MOD_WSGI" == "True" ]]; then
+    if [[ "$WATCHER_USE_WSGI_MODE" == "mod_wsgi" ]]; then
         install_apache_wsgi
     fi
 }
@@ -284,24 +292,26 @@ function start_watcher_api {
 
     local service_port=$WATCHER_SERVICE_PORT
     local service_protocol=$WATCHER_SERVICE_PROTOCOL
+    local watcher_url
     if is_service_enabled tls-proxy; then
         service_port=$WATCHER_SERVICE_PORT_INT
         service_protocol="http"
     fi
-    if [[ "$WATCHER_USE_MOD_WSGI" == "True" ]]; then
+    if [[ "$WATCHER_USE_WSGI_MODE" == "uwsgi" ]]; then
+        run_process "watcher-api" "$WATCHER_BIN_DIR/uwsgi --ini $WATCHER_UWSGI_CONF"
+        watcher_url=$service_protocol://$SERVICE_HOST/infra-optim
+    else
+        watcher_url=$service_protocol://$SERVICE_HOST:$service_port
         enable_apache_site watcher-api
         restart_apache_server
-    else
-        run_process watcher-api "$WATCHER_BIN_DIR/watcher-api --config-file $WATCHER_CONF"
-    fi
-
-    # Start proxies if enabled
-    if is_service_enabled tls-proxy; then
-        start_tls_proxy watcher '*' $WATCHER_SERVICE_PORT $WATCHER_SERVICE_HOST $WATCHER_SERVICE_PORT_INT
+        # Start proxies if enabled
+        if is_service_enabled tls-proxy; then
+            start_tls_proxy watcher '*' $WATCHER_SERVICE_PORT $WATCHER_SERVICE_HOST $WATCHER_SERVICE_PORT_INT
+        fi
     fi
 
     echo "Waiting for watcher-api to start..."
-    if ! wait_for_service $SERVICE_TIMEOUT $service_protocol://$WATCHER_SERVICE_HOST:$service_port; then
+    if ! wait_for_service $SERVICE_TIMEOUT $watcher_url; then
         die $LINENO "watcher-api did not start"
     fi
 
@@ -317,11 +327,11 @@ function start_watcher {
 
 # stop_watcher() - Stop running processes (non-screen)
 function stop_watcher {
-    if [[ "$WATCHER_USE_MOD_WSGI" == "True" ]]; then
+    if [[ "$WATCHER_USE_WSGI_MODE" == "uwsgi" ]]; then
+        stop_process watcher-api
+    else
         disable_apache_site watcher-api
         restart_apache_server
-    else
-        stop_process watcher-api
     fi
     for serv in watcher-decision-engine watcher-applier; do
         stop_process $serv

devstack/local.conf.compute

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

devstack/local.conf.controller

@@ -10,6 +10,7 @@ SERVICE_PASSWORD=$ADMIN_PASSWORD
 SERVICE_TOKEN=azertytoken
 
 HOST_IP=192.168.42.1 # Change this to your controller node IP address
+#HOST_IPV6=2001:db8::7
 FLAT_INTERFACE=eth0
 
 FIXED_RANGE=10.254.1.0/24 # Change this to whatever your network is
@@ -25,13 +26,13 @@ MULTI_HOST=1
 disable_service n-cpu
 
 # Enable the Watcher Dashboard plugin
-enable_plugin watcher-dashboard git://git.openstack.org/openstack/watcher-dashboard
+enable_plugin watcher-dashboard https://opendev.org/openstack/watcher-dashboard
 
 # Enable the Watcher plugin
-enable_plugin watcher git://git.openstack.org/openstack/watcher
+enable_plugin watcher https://opendev.org/openstack/watcher
 
 # Enable the Ceilometer plugin
-enable_plugin ceilometer git://git.openstack.org/openstack/ceilometer
+enable_plugin ceilometer https://opendev.org/openstack/ceilometer
 
 # This is the controller node, so disable the ceilometer compute agent
 disable_service ceilometer-acompute
@@ -48,3 +49,9 @@ LOGDAYS=2
 [[post-config|$NOVA_CONF]]
 [DEFAULT]
 compute_monitors=cpu.virt_driver
+[notifications]
+# Enable both versioned and unversioned notifications. Watcher only
+# uses versioned notifications but ceilometer uses unversioned. We
+# can change this to just versioned when ceilometer handles versioned
+# notifications from nova: https://bugs.launchpad.net/ceilometer/+bug/1665449
+notification_format=both

devstack/override-defaults

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

devstack/upgrade/settings

@@ -1,11 +1,18 @@
 register_project_for_upgrade watcher
 register_db_to_save watcher
 
-devstack_localrc base enable_plugin watcher https://git.openstack.org/openstack/watcher stable/rocky
-devstack_localrc target enable_plugin watcher https://git.openstack.org/openstack/watcher
+devstack_localrc base enable_plugin watcher https://opendev.org/openstack/watcher $BASE_DEVSTACK_BRANCH
+devstack_localrc target enable_plugin watcher https://opendev.org/openstack/watcher
 
 devstack_localrc base enable_service watcher-api watcher-decision-engine watcher-applier
 devstack_localrc target enable_service watcher-api watcher-decision-engine watcher-applier
 
 BASE_RUN_SMOKE=False
 TARGET_RUN_SMOKE=False
+
+# Enable both versioned and unversioned notifications. Watcher only
+# uses versioned notifications but ceilometer uses unversioned. We
+# can change this to just versioned when ceilometer handles
+# versioned notifications from nova:
+# https://bugs.launchpad.net/ceilometer/+bug/1665449
+devstack_localrc base NOVA_NOTIFICATION_FORMAT=both

devstack/upgrade/upgrade.sh

@@ -40,6 +40,10 @@ set -o errexit
 source $TARGET_DEVSTACK_DIR/stackrc
 source $TARGET_DEVSTACK_DIR/lib/apache
 source $TARGET_DEVSTACK_DIR/lib/tls
+source $TARGET_DEVSTACK_DIR/lib/keystone
+
+source $TOP_DIR/openrc admin admin
+
 source $(dirname $(dirname $BASH_SOURCE))/settings
 source $(dirname $(dirname $BASH_SOURCE))/plugin.sh
 
@@ -56,6 +60,15 @@ install_watcher
 # calls upgrade-watcher for specific release
 upgrade_project watcher $RUN_DIR $BASE_DEVSTACK_BRANCH $TARGET_DEVSTACK_BRANCH
 
+if [[ ! -f "$WATCHER_UWSGI_CONF" ]] && [[ "$WATCHER_USE_WSGI_MODE" == "uwsgi" ]]
+then write_uwsgi_config "$WATCHER_UWSGI_CONF" "$WATCHER_UWSGI" "/infra-optim"
+     endpoints=$(openstack endpoint list --service watcher -c ID -f value)
+     for id in $endpoints; do
+         openstack endpoint delete $id
+     done
+     create_watcher_accounts
+fi
+
 # Migrate the database
 watcher-db-manage upgrade || die $LINO "DB migration error"
 

doc/requirements.txt

@@ -2,8 +2,10 @@
 # of appearance. Changing the order has an impact on the overall integration
 # process, which may cause wedges in the gate later.
 openstackdocstheme>=1.20.0 # Apache-2.0
-sphinx>=1.6.5,!=1.6.6,!=1.6.7 # BSD
+sphinx>=1.6.5,!=1.6.6,!=1.6.7,<2.0.0;python_version=='2.7' # BSD
+sphinx>=1.6.5,!=1.6.6,!=1.6.7,!=2.1.0;python_version>='3.4' # BSD
 sphinxcontrib-pecanwsme>=0.8.0 # Apache-2.0
+sphinxcontrib-svg2pdfconverter>=0.1.0 # BSD
 reno>=2.7.0 # Apache-2.0
 sphinxcontrib-apidoc>=0.2.0  # BSD
 os-api-ref>=1.4.0 # Apache-2.0

doc/source/admin/index.rst

@@ -10,3 +10,4 @@ Administrator Guide
    policy
    ways-to-install
    ../strategies/index
+   ../datasources/index

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

@@ -51,7 +51,7 @@ Clone the Watcher repository:
 
 .. code-block:: bash
 
-    $ git clone https://git.openstack.org/openstack/watcher.git
+    $ git clone https://opendev.org/openstack/watcher.git
     $ cd watcher
 
 Install the Watcher modules:
@@ -92,7 +92,7 @@ these commands:
 By default, this will show logging on the console from which it was started.
 Once started, you can use the `Watcher Client`_ to play with Watcher service.
 
-.. _`Watcher Client`: https://git.openstack.org/cgit/openstack/python-watcherclient
+.. _`Watcher Client`: https://opendev.org/openstack/python-watcherclient
 
 Installing from packages: PyPI
 --------------------------------

doc/source/architecture.rst

@@ -479,4 +479,4 @@ change to a new value:
 
 
 
-.. _Watcher API: https://developer.openstack.org/api-ref/resource-optimization/
+.. _Watcher API: https://docs.openstack.org/api-ref/resource-optimization/

doc/source/conf.py

@@ -32,7 +32,6 @@ sys.path.insert(0, os.path.abspath('./'))
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
 extensions = [
     'oslo_config.sphinxext',
-    'sphinxcontrib.apidoc',
     'sphinx.ext.viewcode',
     'sphinxcontrib.httpdomain',
     'sphinxcontrib.pecanwsme.rest',
@@ -43,6 +42,7 @@ extensions = [
     'oslo_config.sphinxconfiggen',
     'openstackdocstheme',
     'sphinx.ext.napoleon',
+    'sphinxcontrib.rsvgconverter',
 ]
 
 wsme_protocols = ['restjson']
@@ -51,22 +51,6 @@ config_generator_config_file = [(
     '_static/watcher')]
 sample_config_basename = 'watcher'
 
-# autodoc generation is a bit aggressive and a nuisance when doing heavy
-# text edit cycles.
-# execute "export SPHINX_DEBUG=1" in your terminal to disable
-
-# sphinxcontrib.apidoc options
-apidoc_module_dir = '../../watcher'
-apidoc_output_dir = 'api'
-apidoc_excluded_paths = [
-    'tests/*',
-    'db',
-    'decision_engine',
-    'doc',
-    'objects',
-]
-apidoc_separate_modules = True
-
 # The suffix of source filenames.
 source_suffix = '.rst'
 
@@ -154,10 +138,21 @@ bug_tag = ''
 # [howto/manual]).
 latex_documents = [
     ('index',
-     '%s.tex' % project,
+     'doc-watcher.tex',
      u'%s Documentation' % project,
      u'OpenStack Foundation', 'manual'),
 ]
 
+# If false, no module index is generated.
+latex_domain_indices = False
+
+latex_elements = {
+    'makeindex': '',
+    'printindex': '',
+    'preamble': r'\setcounter{tocdepth}{3}',
+}
+
+# Disable usage of xindy https://bugzilla.redhat.com/show_bug.cgi?id=1643664
+latex_use_xindy = False
 # Example configuration for intersphinx: refer to the Python standard library.
 # intersphinx_mapping = {'http://docs.python.org/': None}

doc/source/configuration/configuring.rst

@@ -178,7 +178,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://opendev.org/openstack/watcher.git
     $ cd watcher/
     $ tox -e genconfig
     $ vi etc/watcher/watcher.conf.sample

doc/source/contributor/contributing.rst

@@ -55,18 +55,17 @@ Wiki
     https://wiki.openstack.org/Watcher
 
 Code Hosting
-    https://git.openstack.org/cgit/openstack/watcher
+    https://opendev.org/openstack/watcher
 
 Code Review
-    https://review.openstack.org/#/q/status:open+project:openstack/watcher,n,z
+    https://review.opendev.org/#/q/status:open+project:openstack/watcher,n,z
 
 IRC Channel
     ``#openstack-watcher`` (changelog_)
 
 Weekly Meetings
-    On Wednesdays at 14:00 UTC on even weeks in the ``#openstack-meeting-4``
-    IRC channel, 08:00 UTC on odd weeks in the ``#openstack-meeting-alt``
-    IRC channel (`meetings logs`_)
+    Bi-weekly, on Wednesdays at 08:00 UTC on odd weeks in the
+    ``#openstack-meeting-alt`` IRC channel (`meetings logs`_)
 
 .. _changelog: http://eavesdrop.openstack.org/irclogs/%23openstack-watcher/
 .. _meetings logs:  http://eavesdrop.openstack.org/meetings/watcher/

doc/source/contributor/devstack.rst

@@ -19,7 +19,7 @@ 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://opendev.org/openstack/watcher
 
 For more detailed instructions, see `Detailed DevStack Instructions`_. Check
 out the `DevStack documentation`_ for more information regarding DevStack.
@@ -27,6 +27,36 @@ out the `DevStack documentation`_ for more information regarding DevStack.
 .. _PluginModelDocs: https://docs.openstack.org/devstack/latest/plugins.html
 .. _DevStack documentation: https://docs.openstack.org/devstack/latest
 
+Quick Devstack Instructions with Datasources
+============================================
+
+Watcher requires a datasource to collect metrics from compute nodes and
+instances in order to execute most strategies. To enable this a
+`[[local|localrc]]` to setup DevStack for some of the supported datasources
+is provided. These examples specify the minimal configuration parameters to
+get both Watcher and the datasource working but can be expanded is desired.
+
+Gnocchi
+-------
+
+With the Gnocchi datasource most of the metrics for compute nodes and
+instances will work with the provided configuration but metrics that
+require Ironic such as `host_airflow and` `host_power` will still be
+unavailable as well as `instance_l3_cpu_cache`::
+
+        [[local|localrc]]
+        enable_plugin watcher https://opendev.org/openstack/watcher
+
+        enable_plugin ceilometer https://opendev.org/openstack/ceilometer.git
+        CEILOMETER_BACKEND=gnocchi
+
+        enable_plugin aodh https://opendev.org/openstack/aodh
+        enable_plugin panko https://opendev.org/openstack/panko
+
+        [[post-config|$NOVA_CONF]]
+        [DEFAULT]
+        compute_monitors=cpu.virt_driver
+
 Detailed DevStack Instructions
 ==============================
 
@@ -44,7 +74,7 @@ Detailed DevStack Instructions
 
        sudo apt-get update
        sudo apt-get install git
-       git clone https://git.openstack.org/openstack-dev/devstack
+       git clone https://opendev.org/openstack/devstack.git
        sudo ./devstack/tools/create-stack-user.sh
 
    Now you have a stack user that is used to run the DevStack processes. You
@@ -56,7 +86,7 @@ Detailed DevStack Instructions
 
        sudo su stack
        cd ~
-       git clone https://git.openstack.org/openstack-dev/devstack
+       git clone https://opendev.org/openstack/devstack.git
 
 #. For each compute node, copy the provided `local.conf.compute`_ example file
    to the compute node's system at ~/devstack/local.conf. Make sure the

doc/source/contributor/environment.rst

@@ -16,7 +16,7 @@ for development purposes.
 To install Watcher from packaging, refer instead to Watcher `User
 Documentation`_.
 
-.. _`Git Repository`: https://git.openstack.org/cgit/openstack/watcher
+.. _`Git Repository`: https://opendev.org/openstack/watcher
 .. _`User Documentation`: https://docs.openstack.org/watcher/latest/
 
 Prerequisites
@@ -47,7 +47,7 @@ Make a clone of the code from our `Git repository`:
 
 .. code-block:: bash
 
-    $ git clone https://git.openstack.org/openstack/watcher.git
+    $ git clone https://opendev.org/openstack/watcher.git
 
 When that is complete, you can:
 
@@ -99,7 +99,7 @@ useful to keep a clean environment for working on Watcher.
 .. code-block:: bash
 
     $ mkvirtualenv watcher
-    $ git clone https://git.openstack.org/openstack/watcher
+    $ git clone https://opendev.org/openstack/watcher.git
 
     # Use 'python setup.py' to link Watcher into Python's site-packages
     $ cd watcher && python setup.py install

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

@@ -285,8 +285,15 @@ The following code snippet shows how datasource_backend is defined:
     @property
     def datasource_backend(self):
         if not self._datasource_backend:
+
+            # Load the global preferred datasources order but override it
+            # if the strategy has a specific datasources config
+            datasources = CONF.watcher_datasources
+            if self.config.datasources:
+                datasources = self.config
+
             self._datasource_backend = ds_manager.DataSourceManager(
-                config=self.config,
+                config=datasources,
                 osc=self.osc
             ).get_backend(self.DATASOURCE_METRICS)
         return self._datasource_backend

doc/source/contributor/testing.rst

@@ -18,7 +18,7 @@ should download the latest `watcher`_ from the github. To run the same unit
 tests that are executing onto `Gerrit`_ which includes ``py35``, ``py27`` and
 ``pep8``, you can issue the following command::
 
-    $ git clone https://git.openstack.org/openstack/watcher
+    $ git clone https://opendev.org/openstack/watcher
     $ cd watcher
     $ pip install tox
     $ tox
@@ -31,8 +31,8 @@ the following::
     $ tox -e pep8
 
 .. _tox: https://tox.readthedocs.org/
-.. _watcher: https://git.openstack.org/cgit/openstack/watcher
-.. _Gerrit: https://review.openstack.org/
+.. _watcher: https://opendev.org/openstack/watcher
+.. _Gerrit: https://review.opendev.org/
 
 If you only want to run specific unit test code and don't like to waste time
 waiting for all unit tests to execute, you can add parameters ``--`` followed
@@ -48,4 +48,4 @@ Tempest tests
 Tempest tests for Watcher has been migrated to the external repo
 `watcher-tempest-plugin`_.
 
-.. _watcher-tempest-plugin: https://git.openstack.org/cgit/openstack/watcher-tempest-plugin
+.. _watcher-tempest-plugin: https://opendev.org/openstack/watcher-tempest-plugin

doc/source/datasources/grafana.rst

@@ -0,0 +1,426 @@
+==================
+Grafana datasource
+==================
+
+Synopsis
+--------
+
+Grafana can interface with many different types of storage backends that
+Grafana calls datasources_. Since the term datasources causes significant
+confusion by overlapping definitions used in Watcher these **datasources are
+called projects instead**. Some examples of supported projects are InfluxDB
+or Elasticsearch while others might be more familiar such as Monasca or
+Gnocchi. The Grafana datasource provides the functionality to retrieve metrics
+from Grafana for different projects. This functionality is achieved by using
+the proxy interface exposed in Grafana to communicate with Grafana projects
+directly.
+
+Background
+**********
+
+Since queries to retrieve metrics from Grafana are proxied to the project the
+format of these queries will change significantly depending on the type of
+project. The structure of the projects themselves will also change
+significantly as they are structured by users and administrators. For instance,
+some developers might decide to store metrics about compute_nodes in MySQL and
+use the UUID as primary key while others use InfluxDB and use the hostname as
+primary key. Furthermore, datasources in Watcher should return metrics in
+specific units strictly defined in the baseclass_ depending on how the units
+are stored in the projects they might require conversion before being returned.
+The flexible configuration parameters of the Grafana datasource allow to
+specify exactly how the deployment is configured and this will enable to
+correct retrieval of metrics and with the correct units.
+
+.. _datasources: https://grafana.com/plugins?type=datasource
+.. _baseclass: https://github.com/openstack/watcher/blob/584eeefdc8/watcher/datasources/base.py
+
+Requirements
+------------
+
+The use of the Grafana datasource requires a reachable Grafana endpoint and an
+authentication token for access to the desired projects. The projects behind
+Grafana will need to contain the metrics for compute_nodes_ or instances_ and
+these need to be identifiable by an attribute of the Watcher datamodel_ for
+instance hostname or UUID.
+
+.. _compute_nodes: https://opendev.org/openstack/watcher/src/branch/master/watcher/decision_engine/model/element/node.py
+.. _instances: https://opendev.org/openstack/watcher/src/branch/master/watcher/decision_engine/model/element/instance.py
+.. _datamodel: https://opendev.org/openstack/watcher/src/branch/master/watcher/decision_engine/model/element
+
+Limitations
+***********
+
+* Only the InfluxDB project is currently supported [#f1]_.
+* All metrics must be retrieved from the same Grafana endpoint (same URL).
+* All metrics must be retrieved with the same authentication token.
+
+.. [#f1] A base class for projects is available_ and easily extensible.
+.. _available: https://review.opendev.org/#/c/649341/24/watcher/datasources/grafana_translator/base.py
+
+Configuration
+-------------
+
+Several steps are required in order to use the Grafana datasource, Most steps
+are related configuring Watcher to match the deployed Grafana setup such as
+queries proxied to the project or the type of project for any given metric.
+Most of the configuration can either be supplied via the traditional
+configuration file or in a `special yaml`_ file.
+
+.. _special yaml: https://specs.openstack.org/openstack/watcher-specs/specs/train/approved/file-based-metricmap.html
+
+token
+*****
+
+First step is to generate an access token with access to the required projects.
+This can be done from the api_ or from the web interface_. Tokens generated
+from the web interface will have the same access to projects as the user that
+created them while using the cli allows to generate a key for a specific
+role.The token will only be displayed once so store it well. This token will go
+into the configuration file later and this parameter can not be placed in the
+yaml.
+
+.. _api: https://grafana.com/docs/http_api/auth/#create-api-key
+.. _interface: https://grafana.com/docs/http_api/auth/#create-api-token
+
+base_url
+********
+
+Next step is supplying the base url of the Grafana endpoint. The base url
+parameter will need to specify the type of http protocol and the use of
+plain text http is strongly discouraged due to the transmission of the access
+token. Additionally the path to the proxy interface needs to be supplied as
+well in case Grafana is placed in a sub directory of the web server. An example
+would be: `https://mygrafana.org/api/datasource/proxy/` were
+`/api/datasource/proxy` is the default path without any subdirectories.
+Likewise, this parameter can not be placed in the yaml.
+
+To prevent many errors from occurring and potentially filing the logs files it
+is advised to specify the desired datasource in the configuration as it would
+prevent the datasource manager from having to iterate and try possible
+datasources with the launch of each audit. To do this specify `datasources` in
+the `[watcher_datasources]` group.
+
+The current configuration that is required to be placed in the traditional
+configuration file would look like the following:
+
+.. code-block:: shell
+
+    [grafana_client]
+    token = 0JLbF0oB4R3Q2Fl337Gh4Df5VN12D3adBE3f==
+    base_url = https://mygranfa.org/api/datasource/proxy
+
+    [watcher_datasources]
+    datasources = grafana
+
+metric parameters
+*****************
+
+The last five remaining configuration parameters can all be placed both in the
+traditional configuration file or in the yaml, however, it is not advised to
+mix and match but in the case it does occur the yaml would override the
+settings from the traditional configuration file. All five of these parameters
+are dictionaries mapping specific metrics to a configuration parameter. For
+instance the `project_id_map` will specify the specific project id in Grafana
+to be used. The parameters are named as follow:
+
+* project_id_map
+* database_map
+* translator_map
+* attribute_map
+* query_map
+
+These five parameters are named differently if configured using the yaml
+configuration file. The parameters are named as follows and are in
+identical order as to the list of the traditional configuration file:
+
+* project
+* db
+* translator
+* attribute
+* query
+
+When specified in the yaml the parameters are no longer dictionaries instead
+each parameter needs to be defined per metric as sub-parameters. Examples of
+these parameters configured for both the yaml and traditional configuration
+are described at the end of this document.
+
+project_id
+**********
+
+The project id's can only be determined by someone with the admin role in
+Grafana as that role is required to open the list of projects. The list of
+projects can be found on `/datasources` in the web interface but
+unfortunately it does not immediately display the project id. To display
+the id one can best hover the mouse over the projects and the url will show the
+project id's for example `/datasources/edit/7563`. Alternatively the entire
+list of projects can be retrieved using the `REST api`_. To easily make
+requests to the REST api a tool such as Postman can be used.
+
+.. _REST api: https://grafana.com/docs/http_api/data_source/#get-all-datasources
+
+database
+********
+
+The database is the parameter for the schema / database that is actually
+defined in the project. For instance, if the project would be based on MySQL
+this is were the name of schema used within the MySQL server would be
+specified. For many different projects it is possible to list all the databases
+currently available. Tools like Postman can be used to list all the available
+databases per project. For InfluxDB based projects this would be with the
+following path and query, however be sure to construct these request in Postman
+as the header needs to contain the authorization token:
+
+.. code-block:: shell
+
+    https://URL.DOMAIN/api/datasources/proxy/PROJECT_ID/query?q=SHOW%20DATABASES
+
+translator
+**********
+
+Each translator is for a specific type of project will have a uniquely
+identifiable name and the baseclass allows to easily support new types of
+projects such as elasticsearch or prometheus. Currently only InfluxDB based
+projects are supported as a result the only valid value for this parameter is `
+influxdb`.
+
+attribute
+*********
+
+The attribute parameter specifies which attribute to use from Watcher's
+data model in order to construct the query. The available attributes differ
+per type of object in the data model but the following table shows the
+attributes for ComputeNodes, Instances and IronicNodes.
+
++-----------------+-----------------+--------------------+
+| ComputeNode     | Instance        | IronicNode         |
++=================+=================+====================+
+| uuid            | uuid            | uuid               |
++-----------------+-----------------+--------------------+
+| id              | name            | human_id           |
++-----------------+-----------------+--------------------+
+| hostname        | project_id      | power_state        |
++-----------------+-----------------+--------------------+
+| status          | watcher_exclude | maintenance        |
++-----------------+-----------------+--------------------+
+| disabled_reason | locked          | maintenance_reason |
++-----------------+-----------------+--------------------+
+| state           | metadata        | extra              |
++-----------------+-----------------+--------------------+
+| memory          | state           |                    |
++-----------------+-----------------+--------------------+
+| disk            | memory          |                    |
++-----------------+-----------------+--------------------+
+| disk_capacity   | disk            |                    |
++-----------------+-----------------+--------------------+
+| vcpus           | disk_capacity   |                    |
++-----------------+-----------------+--------------------+
+|                 | vcpus           |                    |
++-----------------+-----------------+--------------------+
+
+Many if not all of these attributes map to attributes of the objects that are
+fetched from clients such as Nova. To see how these attributes are put into the
+data model the following source files can be analyzed for Nova_ and Ironic_.
+
+.. _Nova: https://opendev.org/openstack/watcher/src/branch/master/watcher/decision_engine/model/collector/nova.py#L304
+.. _Ironic: https://opendev.org/openstack/watcher/src/branch/master/watcher/decision_engine/model/collector/ironic.py#L85
+
+query
+*****
+
+The query is the single most important parameter it will be passed to the
+project and should return the desired metric for the specific host and return
+the value in the correct unit. The units for all available metrics are
+documented in the `datasource baseclass`_. This might mean the query specified
+in this parameter is responsible for converting the unit. The following query
+demonstrates how such a conversion could be achieved and demonstrates the
+conversion from bytes to megabytes.
+
+.. code-block:: shell
+
+    SELECT value/1000000 FROM memory...
+
+Queries will be formatted using the .format string method within Python. This
+format will currently have give attributes exposed to it labeled `{0}` to
+`{4}`. Every occurrence of these characters within the string will be replaced
+with the specific attribute.
+
+- {0} is the aggregate typically `mean`, `min`, `max` but `count` is also
+  supported.
+- {1} is the attribute as specified in the attribute parameter.
+- {2} is the period of time to aggregate data over in seconds.
+- {3} is the granularity or the interval between data points in seconds.
+- {4} is translator specific and in the case of InfluxDB it will be used for
+  retention_periods.
+
+**InfluxDB**
+
+Constructing the queries or rather anticipating how the results should look to
+be correctly interpreted by Watcher can be a challenge. The following json
+example demonstrates how what the result should look like and the query used to
+get this result.
+
+.. code-block:: json
+
+    {
+    "results": [
+        {
+            "statement_id": 0,
+            "series": [
+                {
+                    "name": "vmstats",
+                    "tags": {
+                        "host": "autoserver01"
+                    },
+                    "columns": [
+                        "time",
+                        "mean"
+                    ],
+                    "values": [
+                        [
+                            1560848284284,
+                            7680000
+                        ]
+                    ]
+                }
+            ]
+        }
+    ]
+    }
+
+.. code-block:: shell
+
+    SELECT {0}("{0}_value") FROM "vmstats" WHERE host =~ /^{1}$/ AND
+    "type_instance" =~ /^mem$/ AND time >= now() - {2}s GROUP BY host
+
+.. _datasource baseclass: https://opendev.org/openstack/watcher/src/branch/master/watcher/datasources/base.py
+
+Example configuration
+---------------------
+
+The example configurations will show both how to achieve the entire
+configuration in the config file or use a combination of the regular file and
+yaml. Using yaml to define all the parameters for each metric is recommended
+since it has better human readability and supports mutli-line option
+definitions.
+
+Configuration file
+******************
+
+**It is important to note that the line breaks shown in between assignments of
+parameters can not be used in the actual configuration and these are simply here
+for readability reasons.**
+
+.. code-block:: shell
+
+    [grafana_client]
+    # Authentication token to gain access (string value)
+    # Note: This option can be changed without restarting.
+    token = eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk==
+
+    # first part of the url (including https:// or http://) up until project id
+    # part. Example: https://secure.org/api/datasource/proxy/ (string value)
+    # Note: This option can be changed without restarting.
+    base_url = https://monitoring-grafana.com/api/datasources/proxy/
+
+    # Project id as in url (integer value)
+    # Note: This option can be changed without restarting.
+    project_id_map = host_cpu_usage:1337,host_ram_usage:6969,
+    instance_cpu_usage:1337,instance_ram_usage:9696
+
+    # Mapping of grafana databases to datasource metrics. (dict value)
+    # Note: This option can be changed without restarting.
+    database_map = host_cpu_usage:monit_production,
+    host_ram_usage:monit_production,instance_cpu_usage:prod_cloud,
+    instance_ram_usage:prod_cloud
+
+    translator_map = host_cpu_usage:influxdb,host_ram_usage:influxdb,
+    instance_cpu_usage:influxdb,instance_ram_usage:influxdb
+
+    attribute_map = host_cpu_usage:hostname,host_ram_usage:hostname,
+    instance_cpu_usage:name,instance_ram_usage:name
+
+    query_map = host_cpu_usage:SELECT 100-{0}("{0}_value") FROM {4}.cpu WHERE
+    ("host" =~ /^{1}$/ AND "type_instance" =~/^idle$/ AND time > now()-{2}s),
+    host_ram_usage:SELECT {0}("{0}_value")/1000000 FROM {4}.memory WHERE
+     ("host" =~ /^{1}$/) AND "type_instance" =~ /^used$/ AND time >= now()-{2}s
+     GROUP BY "type_instance",instance_cpu_usage:SELECT {0}("{0}_value") FROM
+     "vmstats" WHERE host =~ /^{1}$/ AND "type_instance" =~ /^cpu$/ AND time >=
+     now() - {2}s GROUP BY host,instance_ram_usage:SELECT {0}("{0}_value") FROM
+     "vmstats" WHERE host =~ /^{1}$/ AND "type_instance" =~ /^mem$/ AND time >=
+     now() - {2}s GROUP BY host
+
+    [grafana_translators]
+
+    retention_periods = one_week:10080,one_month:302400,five_years:525600
+
+    [watcher_datasources]
+    datasources = grafana
+
+yaml
+****
+
+When using the yaml configuration file some parameters still need to be defined
+using the regular configuration such as the path for the yaml file these
+parameters are detailed below:
+
+.. code-block:: shell
+
+    [grafana_client]
+    token = eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk==
+
+    base_url = https://monitoring-grafana.com/api/datasources/proxy/
+
+    [watcher_datasources]
+    datasources = grafana
+
+    [watcher_decision_engine]
+    metric_map_path = /etc/watcher/metric_map.yaml
+
+Using the yaml allows to more effectively define the parameters per metric with
+greater human readability due to the availability of multi line options. These
+multi line options are demonstrated in the query parameters.
+
+.. code-block:: yaml
+
+  grafana:
+    host_cpu_usage:
+      project: 1337
+      db: monit_production
+      translator: influxdb
+      attribute: hostname
+      query: >
+          SELECT 100-{0}("{0}_value") FROM {4}.cpu
+          WHERE ("host" =~ /^{1}$/ AND "type_instance" =~/^idle$/ AND
+          time > now()-{2}s)
+    host_ram_usage:
+      project: 6969
+      db: monit_production
+      translator: influxdb
+      attribute: hostname
+      query: >
+          SELECT {0}("{0}_value")/1000000 FROM {4}.memory WHERE
+           ("host" =~ /^{1}$/) AND "type_instance" =~ /^used$/ AND time >=
+           now()-{2}s GROUP BY "type_instance"
+    instance_cpu_usage:
+      project: 1337
+      db: prod_cloud
+      translator: influxdb
+      attribute: name
+      query: >
+          SELECT {0}("{0}_value") FROM
+           "vmstats" WHERE host =~ /^{1}$/ AND "type_instance" =~ /^cpu$/ AND
+           time >= now() - {2}s GROUP BY host
+    instance_ram_usage:
+      project: 9696
+      db: prod_cloud
+      translator: influxdb
+      attribute: name
+      query: >
+          SELECT {0}("{0}_value") FROM
+           "vmstats" WHERE host =~ /^{1}$/ AND "type_instance" =~ /^mem$/ AND
+           time >= now() - {2}s GROUP BY host
+
+External Links
+--------------
+
+- `List of Grafana datasources <https://grafana.com/plugins?type=datasource>`_

doc/source/datasources/index.rst

@@ -0,0 +1,8 @@
+Datasources
+===========
+
+.. toctree::
+   :glob:
+   :maxdepth: 1
+
+   ./*

doc/source/glossary.rst

@@ -8,7 +8,7 @@
 Glossary
 ========
 
-.. glossary::
+.. _glossary:
    :sorted:
 
 This page explains the different terms used in the Watcher system.

doc/source/index.rst

@@ -28,9 +28,9 @@ The documentation provided here is continually kept up-to-date based
 on the latest code, and may not represent the state of the project at any
 specific prior release.
 
-.. _watcher: https://git.openstack.org/cgit/openstack/watcher/
-.. _python-watcherclient: https://git.openstack.org/cgit/openstack/python-watcherclient/
-.. _watcher-dashboard: https://git.openstack.org/cgit/openstack/watcher-dashboard/
+.. _watcher: https://opendev.org/openstack/watcher/
+.. _python-watcherclient: https://opendev.org/openstack/python-watcherclient/
+.. _watcher-dashboard: https://opendev.org/openstack/watcher-dashboard/
 
 Developer Guide
 ===============
@@ -83,7 +83,7 @@ API References
 .. toctree::
   :maxdepth: 1
 
-  API Reference <https://developer.openstack.org/api-ref/resource-optimization/>
+  API Reference <https://docs.openstack.org/api-ref/resource-optimization/>
   Watcher API Microversion History </contributor/api_microversion_history>
 
 Plugins
@@ -111,19 +111,12 @@ Watcher Manual Pages
 
    man/index
 
-.. # NOTE(mriedem): This is the section where we hide things that we don't
-   # actually want in the table of contents but sphinx build would fail if
-   # they aren't in the toctree somewhere. For example, we hide api/autoindex
-   # since that's already covered with modindex below.
-.. toctree::
-   :hidden:
-
-   api/modules
 
+.. only:: html
 
 Indices and tables
 ==================
 
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`
+   * :ref:`genindex`
+   * :ref:`modindex`
+   * :ref:`search`

doc/source/man/watcher-status.rst

@@ -78,6 +78,10 @@ Upgrade
 
   **History of Checks**
 
-  **1.12.0 (Stein)**
+  **2.0.0 (Stein)**
 
   * Sample check to be filled in with checks as they are added in Stein.
+
+  **3.0.0 (Train)**
+
+  * A check was added to enforce the minimum required version of nova API used.

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

@@ -19,12 +19,16 @@ Metrics
 
 The *basic* strategy requires the following metrics:
 
-============================ ============ ======= =======
+============================ ============ ======= ===========================
 metric                       service name plugins comment
-============================ ============ ======= =======
-``compute.node.cpu.percent`` ceilometer_  none
-``cpu_util``                 ceilometer_  none
-============================ ============ ======= =======
+============================ ============ ======= ===========================
+``compute.node.cpu.percent`` ceilometer_  none    need to set the
+                                                  ``compute_monitors`` option
+                                                  to ``cpu.virt_driver`` in
+                                                  the nova.conf.
+``cpu_util``                 ceilometer_  none    cpu_util has been removed
+                                                  since Stein.
+============================ ============ ======= ===========================
 
 .. _ceilometer: https://docs.openstack.org/ceilometer/latest/admin/telemetry-measurements.html#openstack-compute
 

doc/source/strategies/node_resource_consolidation.rst

@@ -0,0 +1,95 @@
+====================================
+Node Resource Consolidation Strategy
+====================================
+
+Synopsis
+--------
+
+**display name**: ``Node Resource Consolidation Strategy``
+
+**goal**: ``Server Consolidation``
+
+    .. watcher-term:: watcher.decision_engine.strategy.strategies.node_resource_consolidation.NodeResourceConsolidation
+
+Requirements
+------------
+
+None.
+
+Metrics
+*******
+
+None
+
+Cluster data model
+******************
+
+Default Watcher's Compute cluster data model:
+
+    .. watcher-term:: watcher.decision_engine.model.collector.nova.NovaClusterDataModelCollector
+
+Actions
+*******
+
+Default Watcher's actions:
+
+    .. list-table::
+       :widths: 30 30
+       :header-rows: 1
+
+       * - action
+         - description
+       * - ``migration``
+         - .. watcher-term:: watcher.applier.actions.migration.Migrate
+       * - ``change_nova_service_state``
+         - .. watcher-term:: watcher.applier.actions.change_nova_service_state.ChangeNovaServiceState
+
+Planner
+*******
+
+Default Watcher's planner:
+
+    .. watcher-term:: watcher.decision_engine.planner.weight.WeightPlanner
+
+Configuration
+-------------
+
+Strategy parameters are:
+
+==================== ====== =======================================
+parameter            type   default Value description
+==================== ====== =======================================
+``host_choice``      String The way to select the server migration
+                            destination node, The value auto means
+                            that Nova schedular selects the
+                            destination node, and specify means
+                            the strategy specifies the destination.
+==================== ====== =======================================
+
+Efficacy Indicator
+------------------
+
+None
+
+Algorithm
+---------
+
+For more information on the Node Resource Consolidation Strategy please refer
+to: https://specs.openstack.org/openstack/watcher-specs/specs/train/approved/node-resource-consolidation.html
+
+How to use it ?
+---------------
+
+.. code-block:: shell
+
+    $ openstack optimize audittemplate create \
+      at1 server_consolidation \
+      --strategy node_resource_consolidation
+
+    $ openstack optimize audit create \
+      -a at1 -p host_choice=auto
+
+External Links
+--------------
+
+None.

doc/source/strategies/vm_workload_consolidation.rst

@@ -19,14 +19,15 @@ Metrics
 
 The *vm_workload_consolidation* strategy requires the following metrics:
 
-============================ ============ ======= =======
+============================ ============ ======= =========================
 metric                       service name plugins comment
-============================ ============ ======= =======
-``cpu_util``                 ceilometer_  none
+============================ ============ ======= =========================
+``cpu_util``                 ceilometer_  none    cpu_util has been removed
+                                                  since Stein.
 ``memory.resident``          ceilometer_  none
 ``memory``                   ceilometer_  none
 ``disk.root.size``           ceilometer_  none
-============================ ============ ======= =======
+============================ ============ ======= =========================
 
 .. _ceilometer: https://docs.openstack.org/ceilometer/latest/admin/telemetry-measurements.html#openstack-compute
 

doc/source/strategies/workload-stabilization.rst

@@ -19,17 +19,21 @@ Metrics
 
 The *workload_stabilization* strategy requires the following metrics:
 
-============================ ============ ======= =======
+============================ ============ ======= =============================
 metric                       service name plugins comment
-============================ ============ ======= =======
-``compute.node.cpu.percent`` ceilometer_  none
+============================ ============ ======= =============================
+``compute.node.cpu.percent`` ceilometer_  none    need to set the
+                                                  ``compute_monitors`` option
+                                                  to ``cpu.virt_driver`` in the
+                                                  nova.conf.
 ``hardware.memory.used``     ceilometer_  SNMP_
-``cpu_util``                 ceilometer_  none
+``cpu_util``                 ceilometer_  none    cpu_util has been removed
+                                                  since Stein.
 ``memory.resident``          ceilometer_  none
-============================ ============ ======= =======
+============================ ============ ======= =============================
 
 .. _ceilometer: https://docs.openstack.org/ceilometer/latest/admin/telemetry-measurements.html#openstack-compute
-.. _SNMP: http://docs.openstack.org/admin-guide/telemetry-measurements.html
+.. _SNMP: https://docs.openstack.org/ceilometer/latest/admin/telemetry-measurements.html#snmp-based-meters
 
 Cluster data model
 ******************

doc/source/strategies/workload_balance.rst

@@ -21,12 +21,13 @@ Metrics
 
 The *workload_balance* strategy requires the following metrics:
 
-======================= ============ ======= =======
+======================= ============ ======= =========================
 metric                  service name plugins comment
-======================= ============ ======= =======
-``cpu_util``            ceilometer_  none
+======================= ============ ======= =========================
+``cpu_util``            ceilometer_  none    cpu_util has been removed
+                                             since Stein.
 ``memory.resident``     ceilometer_  none
-======================= ============ ======= =======
+======================= ============ ======= =========================
 
 .. _ceilometer: https://docs.openstack.org/ceilometer/latest/admin/telemetry-measurements.html#openstack-compute
 

doc/source/user/user-guide.rst

@@ -55,7 +55,7 @@ plugin installation guide`_.
 
      $ watcher ...
 
-.. _`installation guide`: https://docs.openstack.org/python-watcherclient/latest
+.. _`installation guide`: https://docs.openstack.org/watcher/latest/install/
 .. _`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

etc/apache2/watcher

@@ -16,7 +16,7 @@ Listen 9322
 
 <VirtualHost *:9322>
     WSGIDaemonProcess watcher-api user=stack group=stack processes=2 threads=2 display-name=%{GROUP}
-    WSGIScriptAlias / /opt/stack/watcher/watcher/api/app.wsgi
+    WSGIScriptAlias / /usr/local/bin/watcher-api-wsgi
     WSGIProcessGroup watcher-api
 
     ErrorLog /var/log/httpd/watcher_error.log

lower-constraints.txt

@@ -6,7 +6,6 @@ APScheduler==3.5.1
 asn1crypto==0.24.0
 automaton==1.14.0
 Babel==2.5.3
-bandit==1.4.0
 beautifulsoup4==4.6.0
 cachetools==2.0.1
 certifi==2018.1.18
@@ -34,7 +33,7 @@ fixtures==3.0.0
 flake8==2.5.5
 freezegun==0.3.10
 future==0.16.0
-futurist==1.6.0
+futurist==1.8.0
 gitdb2==2.0.3
 GitPython==2.1.8
 gnocchiclient==7.0.1
@@ -73,14 +72,15 @@ os-client-config==1.29.0
 os-service-types==1.2.0
 os-testr==1.0.0
 osc-lib==1.10.0
+os-resource-classes==0.4.0
 oslo.cache==1.29.0
 oslo.concurrency==3.26.0
 oslo.config==5.2.0
-oslo.context==2.20.0
+oslo.context==2.21.0
 oslo.db==4.35.0
 oslo.i18n==3.20.0
 oslo.log==3.37.0
-oslo.messaging==5.36.0
+oslo.messaging==8.1.2
 oslo.middleware==3.35.0
 oslo.policy==1.34.0
 oslo.reports==1.27.0
@@ -94,7 +94,7 @@ packaging==17.1
 Paste==2.0.3
 PasteDeploy==1.5.2
 pbr==3.1.1
-pecan==1.2.1
+pecan==1.3.2
 pep8==1.5.7
 pika==0.10.0
 pika-pool==0.1.3
@@ -113,12 +113,12 @@ python-cinderclient==3.5.0
 python-dateutil==2.7.0
 python-editor==1.0.3
 python-glanceclient==2.9.1
-python-ironicclient==2.3.0
+python-ironicclient==2.5.0
 python-keystoneclient==3.15.0
 python-mimeparse==1.6.0
 python-monascaclient==1.12.0
 python-neutronclient==6.7.0
-python-novaclient==10.1.0
+python-novaclient==14.1.0
 python-openstackclient==3.14.0
 python-subunit==1.2.0
 pytz==2018.3
@@ -159,7 +159,7 @@ urllib3==1.22
 vine==1.1.4
 waitress==1.1.0
 warlock==1.3.0
-WebOb==1.7.4
+WebOb==1.8.5
 WebTest==2.0.29
 wrapt==1.10.11
 WSME==0.9.2

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

@@ -13,12 +13,12 @@
           set -x
           cat > clonemap.yaml << EOF
           clonemap:
-            - name: openstack-infra/devstack-gate
+            - name: openstack/devstack-gate
               dest: devstack-gate
           EOF
           /usr/zuul-env/bin/zuul-cloner -m clonemap.yaml --cache-dir /opt/git \
-              git://git.openstack.org \
-              openstack-infra/devstack-gate
+              https://opendev.org \
+              openstack/devstack-gate
         executable: /bin/bash
         chdir: '{{ ansible_user_dir }}/workspace'
       environment: '{{ zuul | zuul_legacy_vars }}'
@@ -29,13 +29,13 @@
           set -x
           export PYTHONUNBUFFERED=true
 
-          export PROJECTS="openstack-dev/grenade $PROJECTS"
+          export PROJECTS="openstack/grenade $PROJECTS"
           export PROJECTS="openstack/watcher $PROJECTS"
           export PROJECTS="openstack/watcher-tempest-plugin $PROJECTS"
           export PROJECTS="openstack/python-watcherclient $PROJECTS"
           export DEVSTACK_PROJECT_FROM_GIT="python-watcherclient $DEVSTACK_PROJECT_FROM_GIT"
 
-          export GRENADE_PLUGINRC="enable_grenade_plugin watcher https://git.openstack.org/openstack/watcher"
+          export GRENADE_PLUGINRC="enable_grenade_plugin watcher https://opendev.org/openstack/watcher"
           export DEVSTACK_LOCAL_CONFIG+=$'\n'"export TEMPEST_PLUGINS='/opt/stack/new/watcher-tempest-plugin'"
 
           export DEVSTACK_GATE_TEMPEST_NOTESTS=1

releasenotes/notes/add-force-field-to-audit-4bcaeedfe27233ad.yaml

@@ -0,0 +1,7 @@
+---
+features:
+  - |
+    Add force field to Audit. User can set --force to enable the new option when
+    launching audit. If force is True, audit will be executed despite of ongoing
+    actionplan. The new audit may create a wrong actionplan if they use the same
+    data model.

releasenotes/notes/api-call-retry-fef741ac684c58dd.yaml

@@ -0,0 +1,9 @@
+---
+features:
+  - |
+    API calls while building the Compute data model will be retried upon
+    failure. The amount of failures allowed before giving up and the time before
+    reattempting are configurable. The `api_call_retries` and
+    `api_query_timeout` parameters in the `[collector]` group can be used to
+    adjust these paremeters. 10 retries with a 1 second time in between
+    reattempts is the default.

releasenotes/notes/datasource-query-retry-00cba5f7e68aec39.yaml

@@ -0,0 +1,17 @@
+---
+features:
+  - |
+    All datasources can now be configured to retry retrieving a metric upon
+    encountering an error. Between each attempt will be a set amount of time
+    which can be adjusted from the configuration. These configuration
+    options can be found in the `[watcher_datasources]` group and are named
+    `query_max_retries` and `query_timeout`.
+upgrade:
+  - |
+    If Gnocchi was configured to have a custom amount of retries and or a
+    custom timeout then the configuration needs to moved into the
+    `[watcher_datasources]` group instead of the `[gnocchi_client]` group.
+deprecations:
+  - |
+    The configuration options for query retries in `[gnocchi_client]` are
+    deprecated and the option in `[watcher_datasources]` should now be used.

releasenotes/notes/file-based-metric-map-c2af62b5067895df.yaml

@@ -0,0 +1,11 @@
+---
+features:
+  - |
+    Allow using file to override metric map. Override the metric map of
+    each datasource as soon as it is created by the manager. This override
+    comes from a file whose path is provided by a setting in config file.
+    The setting is `watcher_decision_engine/metric_map_path`.  The file
+    contains a map per datasource whose keys are the metric names as
+    recognized by watcher and the value is the real name of the metric
+    in the datasource. This setting defaults to `/etc/watcher/metric_map.yaml`,
+    and presence of this file is optional.

releasenotes/notes/formal-datasource-interface-implementation-222769d55a127d33.yaml

@@ -0,0 +1,17 @@
+---
+features:
+  - |
+    Improved interface for datasource baseclass that better defines expected
+    values and types for parameters and return types of all abstract methods.
+    This allows all strategies to work with every datasource provided the
+    metrics are configured for that given datasource.
+deprecations:
+  - |
+    The new strategy baseclass has significant changes in method parameters
+    and any out-of-tree strategies will have to be adopted.
+  - |
+    Several strategies have changed the `node` parameter to `compute_node` to
+    be better aligned with terminology. These strategies include
+    `basic_consolidation` and `workload_stabilzation`. The `node` parameter
+    will remain supported during Train release and will be removed in the
+    subsequent release.

releasenotes/notes/global-datasource-preference-3ab47b4be09ff3a5.yaml

@@ -0,0 +1,11 @@
+---
+features:
+  - |
+    Watcher now supports configuring which datasource to use and in which
+    order. This configuration is done by specifying datasources in the
+    watcher_datasources section:
+
+    - ``[watcher_datasources] datasources = gnocchi,monasca,ceilometer``
+
+    Specific strategies can override this order and use datasources which
+    are not listed in the global preference.

releasenotes/notes/grafana-datasource-b672367c23ffa0c6.yaml

@@ -0,0 +1,10 @@
+---
+features:
+  - |
+    Grafana has been added as datasource that can be used for collecting
+    metrics. The configuration options allow to specify what metrics and how
+    they are stored in grafana so that no matter how Grafana is configured it
+    can still be used. The configuration can be done via the typical
+    configuration file but it is recommended to configure most options in the
+    yaml file for metrics. For a complete walkthrough on configuring Grafana
+    see: https://docs.openstack.org/watcher/latest/datasources/grafana.html

releasenotes/notes/improve-compute-data-model-b427c85e4ed2b6fb.yaml

@@ -0,0 +1,23 @@
+---
+features:
+  - |
+    Watcher can get resource information such as total, allocation ratio and
+    reserved information from Placement API.
+    Now we add some new fields to the Watcher Data Model:
+
+    * vcpu_reserved: The amount of cpu a node has reserved for its own use.
+    * vcpu_ratio: CPU allocation ratio.
+    * memory_mb_reserved: The amount of memory a node has reserved for
+      its own use.
+    * memory_ratio: Memory allocation ratio.
+    * disk_gb_reserved: The amount of disk a node has reserved for its own use.
+    * disk_ratio: Disk allocation ratio.
+
+    We also add some new propeties:
+
+    * vcpu_capacity: The amount of vcpu, take allocation ratio into account,
+      but do not include reserved.
+    * memory_mb_capacity: The amount of memory, take allocation ratio into
+      account, but do not include reserved.
+    * disk_gb_capacity: The amount of disk, take allocation ratio into
+      account, but do not include reserved.

releasenotes/notes/min-required-nova-train-71f124192d88ae52.yaml

@@ -0,0 +1,8 @@
+---
+upgrade:
+  - |
+    The minimum required version of the ``[nova_client]/api_version`` value
+    is now enforced to be ``2.56`` which is available since the Queens version
+    of the nova compute service.
+
+    A ``watcher-status upgrade check`` has been added for this.

releasenotes/notes/node-resource-consolidation-73bc0c0abfeb0b03.yaml

@@ -0,0 +1,7 @@
+---
+features:
+  - |
+    Added strategy "node resource consolidation". This
+    strategy is used to centralize VMs to as few nodes
+    as possible by VM migration. User can set an input
+    parameter to decide how to select the destination node.

releasenotes/notes/show-datamodel-api-6945b744fd5d25d5.yaml

@@ -0,0 +1,12 @@
+---
+features:
+  - |
+    Add show data model api for Watcher. New in version 1.3.
+    User can use 'openstack optimize datamodel list'
+    command to view the current data model information in memory.
+    User can also add '--audit <Audit_UUID>' to view specific data model
+    in memory filted by the scope in audit.
+    User can also add '--detail' to view detailed information about current data model.
+    User can also add '--type <type>' to specify the type of data model.
+    Default type is 'compute'. In the future, type 'storage' and 'baremetal'
+    will be supported.

releasenotes/notes/support-keystoneclient-option-b30d1ff45f86a2e7.yaml

@@ -0,0 +1,5 @@
+---
+features:
+  - |
+    Add keystone_client Group for user to configure 'interface' and 'region_name'
+    by watcher.conf. The default value of 'interface' is 'admin'.

releasenotes/notes/support-placement-api-58ce6bef1bbbe98a.yaml

@@ -0,0 +1,8 @@
+---
+features:
+  - |
+    Added Placement API helper to Watcher. Now Watcher can get information
+    about resource providers, it can be used for the data model and strategies.
+    Config group placement_client with options 'api_version', 'interface' and
+    'region_name' is also added. The default values for 'api_version' and
+    'interface' are 1.29 and 'public', respectively.

releasenotes/notes/uwsgi-support-8dcea6961e56dad0.yaml

@@ -0,0 +1,12 @@
+---
+upgrade:
+  - |
+    An Watcher API WSGI application script ``watcher-api-wsgi`` is now
+    available. It is auto-generated by ``pbr`` and allows to run the API
+    service using WSGI server (for example Nginx and uWSGI).
+deprecations:
+  - |
+    Using ``watcher/api/app.wsgi`` script is deprecated and it will be removed
+    in U release.
+    Please switch to automatically generated ``watcher-api-wsgi`` script
+    instead.

releasenotes/notes/watcher-planner-selector-84d77549d46f362a.yaml

@@ -0,0 +1,5 @@
+---
+features:
+  - Now Watcher strategy can select specific planner
+    beyond default. Strategy can set planner property
+    to specify its own planner.

releasenotes/source/index.rst

@@ -21,6 +21,7 @@ Contents:
    :maxdepth: 1
 
    unreleased
+   stein
    rocky
    queens
    pike

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

@@ -0,0 +1,33 @@
+# Gérald LONLAS <g.lonlas@gmail.com>, 2016. #zanata
+msgid ""
+msgstr ""
+"Project-Id-Version: python-watcher\n"
+"Report-Msgid-Bugs-To: \n"
+"POT-Creation-Date: 2019-03-22 02:21+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 4.3.3\n"
+"Plural-Forms: nplurals=2; plural=(n > 1)\n"
+
+msgid "0.29.0"
+msgstr "0.29.0"
+
+msgid "Contents:"
+msgstr "Contenu :"
+
+msgid "Current Series Release Notes"
+msgstr "Note de la release actuelle"
+
+msgid "New Features"
+msgstr "Nouvelles fonctionnalités"
+
+msgid "Newton Series Release Notes"
+msgstr "Note de release pour Newton"
+
+msgid "Welcome to watcher's Release Notes documentation!"
+msgstr "Bienvenue dans la documentation de la note de Release de Watcher"

releasenotes/source/stein.rst

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

requirements.txt

@@ -6,18 +6,19 @@ apscheduler>=3.5.1 # MIT License
 enum34>=1.1.6;python_version=='2.7' or python_version=='2.6' or python_version=='3.3' # BSD
 jsonpatch>=1.21 # BSD
 keystoneauth1>=3.4.0 # Apache-2.0
-jsonschema<3.0.0,>=2.6.0 # MIT
+jsonschema>=2.6.0 # MIT
 keystonemiddleware>=4.21.0 # Apache-2.0
 lxml>=4.1.1 # BSD
 croniter>=0.3.20 # MIT License
+os-resource-classes>=0.4.0
 oslo.concurrency>=3.26.0 # Apache-2.0
 oslo.cache>=1.29.0 # Apache-2.0
 oslo.config>=5.2.0 # Apache-2.0
-oslo.context>=2.20.0 # Apache-2.0
+oslo.context>=2.21.0 # Apache-2.0
 oslo.db>=4.35.0 # Apache-2.0
 oslo.i18n>=3.20.0 # Apache-2.0
 oslo.log>=3.37.0 # Apache-2.0
-oslo.messaging>=5.36.0 # Apache-2.0
+oslo.messaging>=8.1.2 # Apache-2.0
 oslo.policy>=1.34.0 # Apache-2.0
 oslo.reports>=1.27.0 # Apache-2.0
 oslo.serialization>=2.25.0 # Apache-2.0
@@ -27,7 +28,7 @@ oslo.utils>=3.36.0 # Apache-2.0
 oslo.versionedobjects>=1.32.0 # Apache-2.0
 PasteDeploy>=1.5.2 # MIT
 pbr>=3.1.1 # Apache-2.0
-pecan>=1.2.1 # BSD
+pecan>=1.3.2 # BSD
 PrettyTable<0.8,>=0.7.2 # BSD
 gnocchiclient>=7.0.1 # Apache-2.0
 python-ceilometerclient>=2.9.0 # Apache-2.0
@@ -36,14 +37,17 @@ python-glanceclient>=2.9.1 # Apache-2.0
 python-keystoneclient>=3.15.0 # Apache-2.0
 python-monascaclient>=1.12.0 # Apache-2.0
 python-neutronclient>=6.7.0 # Apache-2.0
-python-novaclient>=10.1.0 # Apache-2.0
+python-novaclient>=14.1.0 # Apache-2.0
 python-openstackclient>=3.14.0 # Apache-2.0
-python-ironicclient>=2.3.0 # Apache-2.0
+python-ironicclient>=2.5.0 # Apache-2.0
 six>=1.11.0 # MIT
 SQLAlchemy>=1.2.5 # MIT
 stevedore>=1.28.0 # Apache-2.0
 taskflow>=3.1.0 # Apache-2.0
-WebOb>=1.7.4 # MIT
+WebOb>=1.8.5 # MIT
 WSME>=0.9.2 # MIT
-networkx>=1.11 # BSD
+# NOTE(fdegir): NetworkX 2.3 dropped support for Python 2
+networkx>=1.11,<2.3;python_version<'3.0'  # BSD
+networkx>=1.11;python_version>='3.4' # BSD
 microversion_parse>=0.2.1 # Apache-2.0
+futurist>=1.8.0 # Apache-2.0

setup.cfg

@@ -16,7 +16,8 @@ classifier =
     Programming Language :: Python :: 2
     Programming Language :: Python :: 2.7
     Programming Language :: Python :: 3
-    Programming Language :: Python :: 3.5
+    Programming Language :: Python :: 3.6
+    Programming Language :: Python :: 3.7
 
 [files]
 packages =
@@ -46,6 +47,9 @@ console_scripts =
     watcher-sync = watcher.cmd.sync:main
     watcher-status = watcher.cmd.status:main
 
+wsgi_scripts =
+    watcher-api-wsgi = watcher.api.wsgi:initialize_wsgi_app
+
 watcher.database.migration_backend =
     sqlalchemy = watcher.db.sqlalchemy.migration
 
@@ -83,6 +87,7 @@ watcher_strategies =
     storage_capacity_balance = watcher.decision_engine.strategy.strategies.storage_capacity_balance:StorageCapacityBalance
     zone_migration = watcher.decision_engine.strategy.strategies.zone_migration:ZoneMigration
     host_maintenance = watcher.decision_engine.strategy.strategies.host_maintenance:HostMaintenance
+    node_resource_consolidation = watcher.decision_engine.strategy.strategies.node_resource_consolidation:NodeResourceConsolidation
 
 watcher_actions =
     migrate = watcher.applier.actions.migration:Migrate
@@ -99,6 +104,7 @@ watcher_workflow_engines =
 watcher_planners =
     weight = watcher.decision_engine.planner.weight:WeightPlanner
     workload_stabilization  = watcher.decision_engine.planner.workload_stabilization:WorkloadStabilizationPlanner
+    node_resource_consolidation  = watcher.decision_engine.planner.node_resource_consolidation:NodeResourceConsolidationPlanner
 
 watcher_cluster_data_model_collectors =
     compute = watcher.decision_engine.model.collector.nova:NovaClusterDataModelCollector

test-requirements.txt

@@ -13,4 +13,4 @@ testscenarios>=0.5.0 # Apache-2.0/BSD
 testtools>=2.3.0 # MIT
 stestr>=2.0.0 # Apache-2.0
 os-api-ref>=1.4.0 # Apache-2.0
-bandit>=1.1.0 # Apache-2.0
+bandit>=1.6.0 # Apache-2.0

tox.ini

@@ -1,16 +1,19 @@
 [tox]
 minversion = 2.0
-envlist = py35,py27,pep8
+envlist = py36,py37,py27,pep8
 skipsdist = True
 
 [testenv]
 usedevelop = True
 whitelist_externals = find
                       rm
-install_command = pip install -c{env:UPPER_CONSTRAINTS_FILE:https://git.openstack.org/cgit/openstack/requirements/plain/upper-constraints.txt} {opts} {packages}
+install_command = pip install {opts} {packages}
 setenv =
    VIRTUAL_ENV={envdir}
-deps = -r{toxinidir}/test-requirements.txt
+deps =
+    -c{env:UPPER_CONSTRAINTS_FILE:https://releases.openstack.org/constraints/upper/master}
+    -r{toxinidir}/test-requirements.txt
+    -r{toxinidir}/requirements.txt
 commands =
   rm -f .testrepository/times.dbm
   find . -type f -name "*.py[c|o]" -delete
@@ -22,11 +25,16 @@ basepython = python3
 commands =
     doc8 doc/source/ CONTRIBUTING.rst HACKING.rst README.rst
     flake8
-    bandit -r watcher -x tests -n5 -ll -s B320
+    bandit -r watcher -x watcher/tests/* -n5 -ll -s B320
 
 [testenv:venv]
 basepython = python3
 setenv = PYTHONHASHSEED=0
+deps =
+    -c{env:UPPER_CONSTRAINTS_FILE:https://releases.openstack.org/constraints/upper/master}
+    -r{toxinidir}/doc/requirements.txt
+    -r{toxinidir}/test-requirements.txt
+    -r{toxinidir}/requirements.txt
 commands = {posargs}
 
 [testenv:cover]
@@ -44,7 +52,9 @@ commands =
 basepython = python3
 setenv = PYTHONHASHSEED=0
 deps = -r{toxinidir}/doc/requirements.txt
-commands = sphinx-build -W -b html doc/source doc/build/html
+commands =
+  rm -fr doc/build doc/source/api/ .autogenerated
+  sphinx-build -W -b html doc/source doc/build/html
 
 [testenv:api-ref]
 basepython = python3
@@ -90,6 +100,18 @@ extension=.rst
 # todo: stop ignoring doc/source/man when https://bugs.launchpad.net/doc8/+bug/1502391 is fixed
 ignore-path=doc/source/image_src,doc/source/man,doc/source/api
 
+[testenv:pdf-docs]
+basepython = python3
+envdir = {toxworkdir}/docs
+deps = {[testenv:docs]deps}
+whitelist_externals =
+  rm
+  make
+commands =
+  rm -rf doc/build/pdf
+  sphinx-build -W -b latex doc/source doc/build/pdf
+  make -C doc/build/pdf
+
 [testenv:releasenotes]
 basepython = python3
 deps = -r{toxinidir}/doc/requirements.txt
@@ -98,7 +120,7 @@ commands = sphinx-build -a -W -E -d releasenotes/build/doctrees -b html releasen
 [testenv:bandit]
 basepython = python3
 deps = -r{toxinidir}/test-requirements.txt
-commands = bandit -r watcher -x tests -n5 -ll -s B320
+commands = bandit -r watcher -x watcher/tests/* -n5 -ll -s B320
 
 [testenv:lower-constraints]
 basepython = python3

watcher/api/app.wsgi

@@ -16,24 +16,9 @@
 Use this file for deploying the API service under Apache2 mod_wsgi.
 """
 
-import sys
 
-from oslo_config import cfg
-import oslo_i18n as i18n
-from oslo_log import log
+# This script is deprecated and it will be removed in U release.
+# Please switch to automatically generated watcher-api-wsgi script instead.
+from watcher.api import wsgi
 
-from watcher.api import app
-from watcher.common import service
-
-
-CONF = cfg.CONF
-
-i18n.install('watcher')
-
-service.prepare_service(sys.argv)
-
-LOG = log.getLogger(__name__)
-LOG.debug("Configuration:")
-CONF.log_opt_values(LOG, log.DEBUG)
-
-application = app.VersionSelectorApplication()
+application = wsgi.initialize_wsgi_app(show_deprecated=True)

watcher/api/controllers/rest_api_version_history.rst

@@ -25,3 +25,8 @@ was requested.
 Added the parameters ``start_time`` and ``end_time`` to
 create audit request. Supported for start and end time of continuous
 audits.
+
+1.2
+---
+Added ``force`` into create audit request. If ``force`` is true,
+audit will be executed despite of ongoing actionplan.

watcher/api/controllers/v1/__init__.py

@@ -35,6 +35,7 @@ from watcher.api.controllers.v1 import action
 from watcher.api.controllers.v1 import action_plan
 from watcher.api.controllers.v1 import audit
 from watcher.api.controllers.v1 import audit_template
+from watcher.api.controllers.v1 import data_model
 from watcher.api.controllers.v1 import goal
 from watcher.api.controllers.v1 import scoring_engine
 from watcher.api.controllers.v1 import service
@@ -114,6 +115,9 @@ class V1(APIBase):
     audits = [link.Link]
     """Links to the audits resource"""
 
+    data_model = [link.Link]
+    """Links to the data model resource"""
+
     actions = [link.Link]
     """Links to the actions resource"""
 
@@ -158,6 +162,13 @@ class V1(APIBase):
                                          'audits', '',
                                          bookmark=True)
                      ]
+        v1.data_model = [link.Link.make_link('self', pecan.request.host_url,
+                                             'data_model', ''),
+                         link.Link.make_link('bookmark',
+                                             pecan.request.host_url,
+                                             'data_model', '',
+                                             bookmark=True)
+                         ]
         v1.actions = [link.Link.make_link('self', pecan.request.host_url,
                                           'actions', ''),
                       link.Link.make_link('bookmark',
@@ -202,6 +213,7 @@ class Controller(rest.RestController):
     scoring_engines = scoring_engine.ScoringEngineController()
     services = service.ServicesController()
     strategies = strategy.StrategiesController()
+    data_model = data_model.DataModelController()
 
     @wsme_pecan.wsexpose(V1)
     def get(self):

watcher/api/controllers/v1/action.py

@@ -117,9 +117,9 @@ class Action(base.APIBase):
     uuid = wtypes.wsattr(types.uuid, readonly=True)
     """Unique UUID for this action"""
 
-    action_plan_uuid = wsme.wsproperty(types.uuid, _get_action_plan_uuid,
-                                       _set_action_plan_uuid,
-                                       mandatory=True)
+    action_plan_uuid = wtypes.wsproperty(types.uuid, _get_action_plan_uuid,
+                                         _set_action_plan_uuid,
+                                         mandatory=True)
     """The action plan this action belongs to """
 
     state = wtypes.text
@@ -137,7 +137,7 @@ class Action(base.APIBase):
     parents = wtypes.wsattr(types.jsontype, readonly=True)
     """UUIDs of parent actions"""
 
-    links = wsme.wsattr([link.Link], readonly=True)
+    links = wtypes.wsattr([link.Link], readonly=True)
     """A list containing a self link and associated action links"""
 
     def __init__(self, **kwargs):

watcher/api/controllers/v1/action_plan.py

@@ -95,7 +95,7 @@ class ActionPlanPatchType(types.JsonPatchType):
     @staticmethod
     def _validate_state(patch):
         serialized_patch = {'path': patch.path, 'op': patch.op}
-        if patch.value is not wsme.Unset:
+        if patch.value is not wtypes.Unset:
             serialized_patch['value'] = patch.value
         # todo: use state machines to handle state transitions
         state_value = patch.value
@@ -214,19 +214,20 @@ class ActionPlan(base.APIBase):
     uuid = wtypes.wsattr(types.uuid, readonly=True)
     """Unique UUID for this action plan"""
 
-    audit_uuid = wsme.wsproperty(types.uuid, _get_audit_uuid, _set_audit_uuid,
-                                 mandatory=True)
+    audit_uuid = wtypes.wsproperty(types.uuid, _get_audit_uuid,
+                                   _set_audit_uuid,
+                                   mandatory=True)
     """The UUID of the audit this port belongs to"""
 
-    strategy_uuid = wsme.wsproperty(
+    strategy_uuid = wtypes.wsproperty(
         wtypes.text, _get_strategy_uuid, _set_strategy_uuid, mandatory=False)
     """Strategy UUID the action plan refers to"""
 
-    strategy_name = wsme.wsproperty(
+    strategy_name = wtypes.wsproperty(
         wtypes.text, _get_strategy_name, _set_strategy_name, mandatory=False)
     """The name of the strategy this action plan refers to"""
 
-    efficacy_indicators = wsme.wsproperty(
+    efficacy_indicators = wtypes.wsproperty(
         types.jsontype, _get_efficacy_indicators, _set_efficacy_indicators,
         mandatory=True)
     """The list of efficacy indicators associated to this action plan"""
@@ -237,10 +238,10 @@ class ActionPlan(base.APIBase):
     state = wtypes.text
     """This action plan state"""
 
-    links = wsme.wsattr([link.Link], readonly=True)
+    links = wtypes.wsattr([link.Link], readonly=True)
     """A list containing a self link and associated action links"""
 
-    hostname = wsme.wsattr(wtypes.text, mandatory=False)
+    hostname = wtypes.wsattr(wtypes.text, mandatory=False)
     """Hostname the actionplan is running on"""
 
     def __init__(self, **kwargs):

watcher/api/controllers/v1/audit.py

@@ -71,8 +71,10 @@ def hide_fields_in_newer_versions(obj):
     matches or exceeds the versions when these fields were introduced.
     """
     if not api_utils.allow_start_end_audit_time():
-        obj.start_time = wsme.Unset
-        obj.end_time = wsme.Unset
+        obj.start_time = wtypes.Unset
+        obj.end_time = wtypes.Unset
+    if not api_utils.allow_force():
+        obj.force = wtypes.Unset
 
 
 class AuditPostType(wtypes.Base):
@@ -87,12 +89,12 @@ class AuditPostType(wtypes.Base):
 
     audit_type = wtypes.wsattr(wtypes.text, mandatory=True)
 
-    state = wsme.wsattr(wtypes.text, readonly=True,
-                        default=objects.audit.State.PENDING)
+    state = wtypes.wsattr(wtypes.text, readonly=True,
+                          default=objects.audit.State.PENDING)
 
     parameters = wtypes.wsattr({wtypes.text: types.jsontype}, mandatory=False,
                                default={})
-    interval = wsme.wsattr(types.interval_or_cron, mandatory=False)
+    interval = wtypes.wsattr(types.interval_or_cron, mandatory=False)
 
     scope = wtypes.wsattr(types.jsontype, readonly=True)
 
@@ -100,9 +102,11 @@ class AuditPostType(wtypes.Base):
 
     hostname = wtypes.wsattr(wtypes.text, readonly=True, mandatory=False)
 
-    start_time = wsme.wsattr(datetime.datetime, mandatory=False)
+    start_time = wtypes.wsattr(datetime.datetime, mandatory=False)
 
-    end_time = wsme.wsattr(datetime.datetime, mandatory=False)
+    end_time = wtypes.wsattr(datetime.datetime, mandatory=False)
+
+    force = wtypes.wsattr(bool, mandatory=False)
 
     def as_audit(self, context):
         audit_type_values = [val.value for val in objects.audit.AuditType]
@@ -130,7 +134,7 @@ class AuditPostType(wtypes.Base):
 
         if not api_utils.allow_start_end_audit_time():
             for field in ('start_time', 'end_time'):
-                if getattr(self, field) not in (wsme.Unset, None):
+                if getattr(self, field) not in (wtypes.Unset, None):
                     raise exception.NotAcceptable()
 
         # If audit_template_uuid was provided, we will provide any
@@ -192,7 +196,8 @@ class AuditPostType(wtypes.Base):
             scope=self.scope,
             auto_trigger=self.auto_trigger,
             start_time=self.start_time,
-            end_time=self.end_time)
+            end_time=self.end_time,
+            force=self.force)
 
 
 class AuditPatchType(types.JsonPatchType):
@@ -316,49 +321,53 @@ class Audit(base.APIBase):
     state = wtypes.text
     """This audit state"""
 
-    goal_uuid = wsme.wsproperty(
+    goal_uuid = wtypes.wsproperty(
         wtypes.text, _get_goal_uuid, _set_goal_uuid, mandatory=True)
     """Goal UUID the audit refers to"""
 
-    goal_name = wsme.wsproperty(
+    goal_name = wtypes.wsproperty(
         wtypes.text, _get_goal_name, _set_goal_name, mandatory=False)
     """The name of the goal this audit refers to"""
 
-    strategy_uuid = wsme.wsproperty(
+    strategy_uuid = wtypes.wsproperty(
         wtypes.text, _get_strategy_uuid, _set_strategy_uuid, mandatory=False)
     """Strategy UUID the audit refers to"""
 
-    strategy_name = wsme.wsproperty(
+    strategy_name = wtypes.wsproperty(
         wtypes.text, _get_strategy_name, _set_strategy_name, mandatory=False)
     """The name of the strategy this audit refers to"""
 
     parameters = {wtypes.text: types.jsontype}
     """The strategy parameters for this audit"""
 
-    links = wsme.wsattr([link.Link], readonly=True)
+    links = wtypes.wsattr([link.Link], readonly=True)
     """A list containing a self link and associated audit links"""
 
-    interval = wsme.wsattr(wtypes.text, mandatory=False)
+    interval = wtypes.wsattr(wtypes.text, mandatory=False)
     """Launch audit periodically (in seconds)"""
 
-    scope = wsme.wsattr(types.jsontype, mandatory=False)
+    scope = wtypes.wsattr(types.jsontype, mandatory=False)
     """Audit Scope"""
 
-    auto_trigger = wsme.wsattr(bool, mandatory=False, default=False)
+    auto_trigger = wtypes.wsattr(bool, mandatory=False, default=False)
     """Autoexecute action plan once audit is succeeded"""
 
-    next_run_time = wsme.wsattr(datetime.datetime, mandatory=False)
+    next_run_time = wtypes.wsattr(datetime.datetime, mandatory=False)
     """The next time audit launch"""
 
-    hostname = wsme.wsattr(wtypes.text, mandatory=False)
+    hostname = wtypes.wsattr(wtypes.text, mandatory=False)
     """Hostname the audit is running on"""
 
-    start_time = wsme.wsattr(datetime.datetime, mandatory=False)
+    start_time = wtypes.wsattr(datetime.datetime, mandatory=False)
     """The start time for continuous audit launch"""
 
-    end_time = wsme.wsattr(datetime.datetime, mandatory=False)
+    end_time = wtypes.wsattr(datetime.datetime, mandatory=False)
     """The end time that stopping continuous audit"""
 
+    force = wsme.wsattr(bool, mandatory=False, default=False)
+    """Allow Action Plan of this Audit be executed in parallel
+       with other Action Plan"""
+
     def __init__(self, **kwargs):
         self.fields = []
         fields = list(objects.Audit.fields)

watcher/api/controllers/v1/audit_template.py

@@ -342,29 +342,29 @@ class AuditTemplate(base.APIBase):
     description = wtypes.wsattr(wtypes.text, mandatory=False)
     """Short description of this audit template"""
 
-    goal_uuid = wsme.wsproperty(
+    goal_uuid = wtypes.wsproperty(
         wtypes.text, _get_goal_uuid, _set_goal_uuid, mandatory=True)
     """Goal UUID the audit template refers to"""
 
-    goal_name = wsme.wsproperty(
+    goal_name = wtypes.wsproperty(
         wtypes.text, _get_goal_name, _set_goal_name, mandatory=False)
     """The name of the goal this audit template refers to"""
 
-    strategy_uuid = wsme.wsproperty(
+    strategy_uuid = wtypes.wsproperty(
         wtypes.text, _get_strategy_uuid, _set_strategy_uuid, mandatory=False)
     """Strategy UUID the audit template refers to"""
 
-    strategy_name = wsme.wsproperty(
+    strategy_name = wtypes.wsproperty(
         wtypes.text, _get_strategy_name, _set_strategy_name, mandatory=False)
     """The name of the strategy this audit template refers to"""
 
-    audits = wsme.wsattr([link.Link], readonly=True)
+    audits = wtypes.wsattr([link.Link], readonly=True)
     """Links to the collection of audits contained in this audit template"""
 
-    links = wsme.wsattr([link.Link], readonly=True)
+    links = wtypes.wsattr([link.Link], readonly=True)
     """A list containing a self link and associated audit template links"""
 
-    scope = wsme.wsattr(types.jsontype, mandatory=False)
+    scope = wtypes.wsattr(types.jsontype, mandatory=False)
     """Audit Scope"""
 
     def __init__(self, **kwargs):

watcher/api/controllers/v1/data_model.py

@@ -0,0 +1,68 @@
+# -*- encoding: utf-8 -*-
+# Copyright (c) 2019 ZTE Corporation
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+# implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+"""
+An Interface for users and admin to List Data Model.
+"""
+
+import pecan
+from pecan import rest
+from wsme import types as wtypes
+import wsmeext.pecan as wsme_pecan
+
+from watcher.api.controllers.v1 import types
+from watcher.common import exception
+from watcher.common import policy
+from watcher.decision_engine import rpcapi
+
+
+class DataModelController(rest.RestController):
+    """REST controller for data model"""
+    def __init__(self):
+        super(DataModelController, self).__init__()
+
+    from_data_model = False
+    """A flag to indicate if the requests to this controller are coming
+    from the top-level resource DataModel."""
+
+    @wsme_pecan.wsexpose(wtypes.text, wtypes.text, types.uuid)
+    def get_all(self, data_model_type='compute', audit_uuid=None):
+        """Retrieve information about the given data model.
+
+        :param data_model_type: The type of data model user wants to list.
+                                Supported values: compute.
+                                Future support values: storage, baremetal.
+                                The default value is compute.
+        :param audit_uuid: The UUID of the audit,  used to filter data model
+                           by the scope in audit.
+        """
+        if self.from_data_model:
+            raise exception.OperationNotPermitted
+        allowed_data_model_type = [
+            'compute',
+            ]
+        if data_model_type not in allowed_data_model_type:
+            raise exception.DataModelTypeNotFound(
+                data_model_type=data_model_type)
+        context = pecan.request.context
+        de_client = rpcapi.DecisionEngineAPI()
+        policy.enforce(context, 'data_model:get_all',
+                       action='data_model:get_all')
+        rpc_all_data_model = de_client.get_data_model_info(
+            context,
+            data_model_type,
+            audit_uuid)
+        return rpc_all_data_model

watcher/api/controllers/v1/goal.py

@@ -34,7 +34,6 @@ Here are some examples of :ref:`Goals <goal_definition>`:
 
 import pecan
 from pecan import rest
-import wsme
 from wsme import types as wtypes
 import wsmeext.pecan as wsme_pecan
 
@@ -77,7 +76,7 @@ class Goal(base.APIBase):
     efficacy_specification = wtypes.wsattr(types.jsontype, readonly=True)
     """Efficacy specification for this goal"""
 
-    links = wsme.wsattr([link.Link], readonly=True)
+    links = wtypes.wsattr([link.Link], readonly=True)
     """A list containing a self link and associated audit template links"""
 
     def __init__(self, **kwargs):

watcher/api/controllers/v1/scoring_engine.py

@@ -29,7 +29,6 @@ be needed by the user of a given scoring engine.
 
 import pecan
 from pecan import rest
-import wsme
 from wsme import types as wtypes
 import wsmeext.pecan as wsme_pecan
 
@@ -73,7 +72,7 @@ class ScoringEngine(base.APIBase):
     metainfo = wtypes.text
     """A metadata associated with the scoring engine"""
 
-    links = wsme.wsattr([link.Link], readonly=True)
+    links = wtypes.wsattr([link.Link], readonly=True)
     """A list containing a self link and associated action links"""
 
     def __init__(self, **kwargs):

watcher/api/controllers/v1/service.py

@@ -26,7 +26,6 @@ from oslo_log import log
 from oslo_utils import timeutils
 import pecan
 from pecan import rest
-import wsme
 from wsme import types as wtypes
 import wsmeext.pecan as wsme_pecan
 
@@ -93,7 +92,7 @@ class Service(base.APIBase):
         else:
             self._status = objects.service.ServiceStatus.ACTIVE
 
-    id = wsme.wsattr(int, readonly=True)
+    id = wtypes.wsattr(int, readonly=True)
     """ID for this service."""
 
     name = wtypes.text
@@ -102,13 +101,13 @@ class Service(base.APIBase):
     host = wtypes.text
     """Host where service is placed on."""
 
-    last_seen_up = wsme.wsattr(datetime.datetime, readonly=True)
+    last_seen_up = wtypes.wsattr(datetime.datetime, readonly=True)
     """Time when Watcher service sent latest heartbeat."""
 
-    status = wsme.wsproperty(wtypes.text, _get_status, _set_status,
-                             mandatory=True)
+    status = wtypes.wsproperty(wtypes.text, _get_status, _set_status,
+                               mandatory=True)
 
-    links = wsme.wsattr([link.Link], readonly=True)
+    links = wtypes.wsattr([link.Link], readonly=True)
     """A list containing a self link."""
 
     def __init__(self, **kwargs):

watcher/api/controllers/v1/strategy.py

@@ -29,7 +29,6 @@ to find an optimal :ref:`Solution <solution_definition>`.
 
 import pecan
 from pecan import rest
-import wsme
 from wsme import types as wtypes
 import wsmeext.pecan as wsme_pecan
 
@@ -109,15 +108,15 @@ class Strategy(base.APIBase):
     display_name = wtypes.text
     """Localized name of the strategy"""
 
-    links = wsme.wsattr([link.Link], readonly=True)
+    links = wtypes.wsattr([link.Link], readonly=True)
     """A list containing a self link and associated goal links"""
 
-    goal_uuid = wsme.wsproperty(wtypes.text, _get_goal_uuid, _set_goal_uuid,
-                                mandatory=True)
+    goal_uuid = wtypes.wsproperty(wtypes.text, _get_goal_uuid, _set_goal_uuid,
+                                  mandatory=True)
     """The UUID of the goal this audit refers to"""
 
-    goal_name = wsme.wsproperty(wtypes.text, _get_goal_name, _set_goal_name,
-                                mandatory=False)
+    goal_name = wtypes.wsproperty(wtypes.text, _get_goal_name, _set_goal_name,
+                                  mandatory=False)
     """The name of the goal this audit refers to"""
 
     parameters_spec = {wtypes.text: types.jsontype}

watcher/api/controllers/v1/utils.py

@@ -165,3 +165,12 @@ def allow_start_end_audit_time():
     audits.
     """
     return pecan.request.version.minor >= versions.MINOR_1_START_END_TIMING
+
+
+def allow_force():
+    """Check if we should support optional force attribute for Audit.
+
+    Version 1.2 of the API added support for forced audits that allows to
+    launch audit when other action plan is ongoing.
+    """
+    return pecan.request.version.minor >= versions.MINOR_2_FORCE

watcher/api/controllers/v1/versions.py

@@ -22,11 +22,13 @@ BASE_VERSION = 1
 #
 # v1.0: corresponds to Rocky API
 # v1.1: Add start/end time for continuous audit
+# v1.2: Add force field to audit
 
 MINOR_0_ROCKY = 0
 MINOR_1_START_END_TIMING = 1
+MINOR_2_FORCE = 2
 
-MINOR_MAX_VERSION = MINOR_1_START_END_TIMING
+MINOR_MAX_VERSION = MINOR_2_FORCE
 
 # String representations of the minor and maximum versions
 _MIN_VERSION_STRING = '{}.{}'.format(BASE_VERSION, MINOR_0_ROCKY)

watcher/api/scheduling.py

@@ -34,9 +34,8 @@ LOG = log.getLogger(__name__)
 
 class APISchedulingService(scheduling.BackgroundSchedulerService):
 
-    def __init__(self, gconfig=None, **options):
+    def __init__(self, gconfig={}, **options):
         self.services_status = {}
-        gconfig = None or {}
         super(APISchedulingService, self).__init__(gconfig, **options)
 
     def get_services_status(self, context):

watcher/api/wsgi.py

@@ -0,0 +1,41 @@
+# Licensed under the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License. You may obtain
+# a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+# License for the specific language governing permissions and limitations
+# under the License.
+"""WSGI script for Watcher API, installed by pbr."""
+
+import sys
+
+from oslo_config import cfg
+import oslo_i18n as i18n
+from oslo_log import log
+
+from watcher.api import app
+from watcher.common import service
+
+
+CONF = cfg.CONF
+LOG = log.getLogger(__name__)
+
+
+def initialize_wsgi_app(show_deprecated=False):
+    i18n.install('watcher')
+
+    service.prepare_service(sys.argv)
+
+    LOG.debug("Configuration:")
+    CONF.log_opt_values(LOG, log.DEBUG)
+
+    if show_deprecated:
+        LOG.warning("Using watcher/api/app.wsgi is deprecated and it will "
+                    "be removed in U release. Please use automatically "
+                    "generated watcher-api-wsgi instead.")
+
+    return app.VersionSelectorApplication()

watcher/applier/actions/base.py

@@ -131,11 +131,8 @@ class BaseAction(loadable.Loadable):
         raise NotImplementedError()
 
     def validate_parameters(self):
-        try:
-            jsonschema.validate(self.input_parameters, self.schema)
-            return True
-        except jsonschema.ValidationError as e:
-            raise e
+        jsonschema.validate(self.input_parameters, self.schema)
+        return True
 
     @abc.abstractmethod
     def get_description(self):

watcher/applier/actions/change_nova_service_state.py

@@ -50,6 +50,7 @@ class ChangeNovaServiceState(base.BaseAction):
 
     STATE = 'state'
     REASON = 'disabled_reason'
+    RESOURCE_NAME = 'resource_name'
 
     @property
     def schema(self):
@@ -60,6 +61,10 @@ class ChangeNovaServiceState(base.BaseAction):
                     'type': 'string',
                     "minlength": 1
                 },
+                'resource_name': {
+                    'type': 'string',
+                    "minlength": 1
+                },
                 'state': {
                     'type': 'string',
                     'enum': [element.ServiceState.ONLINE.value,
@@ -78,7 +83,7 @@ class ChangeNovaServiceState(base.BaseAction):
 
     @property
     def host(self):
-        return self.resource_id
+        return self.input_parameters.get(self.RESOURCE_NAME)
 
     @property
     def state(self):

watcher/applier/actions/migration.py

@@ -87,6 +87,10 @@ class Migrate(base.BaseAction):
                                 "([a-fA-F0-9]){4}-([a-fA-F0-9]){4}-"
                                 "([a-fA-F0-9]){12}$")
                 },
+                'resource_name': {
+                    'type': 'string',
+                    "minlength": 1
+                },
                 'source_node': {
                     'type': 'string',
                     "minLength": 1
@@ -182,7 +186,7 @@ class Migrate(base.BaseAction):
         return self.migrate(destination=self.destination_node)
 
     def revert(self):
-        return self.migrate(destination=self.source_node)
+        LOG.info('Migrate action do not revert!')
 
     def abort(self):
         nova = nova_helper.NovaHelper(osc=self.osc)

watcher/applier/actions/volume_migration.py

@@ -87,6 +87,10 @@ class VolumeMigrate(base.BaseAction):
                                 "([a-fA-F0-9]){4}-([a-fA-F0-9]){4}-"
                                 "([a-fA-F0-9]){12}$")
                 },
+                'resource_name': {
+                    'type': 'string',
+                    "minlength": 1
+                },
                 'migration_type': {
                     'type': 'string',
                     "enum": ["swap", "retype", "migrate"]
@@ -109,11 +113,8 @@ class VolumeMigrate(base.BaseAction):
         }
 
     def validate_parameters(self):
-        try:
-            jsonschema.validate(self.input_parameters, self.schema)
-            return True
-        except jsonschema.ValidationError as e:
-            raise e
+        jsonschema.validate(self.input_parameters, self.schema)
+        return True
 
     @property
     def volume_id(self):

watcher/applier/messaging/trigger.py

@@ -16,7 +16,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-from concurrent import futures
+import futurist
 
 from oslo_config import cfg
 from oslo_log import log
@@ -31,7 +31,7 @@ class TriggerActionPlan(object):
     def __init__(self, applier_manager):
         self.applier_manager = applier_manager
         workers = CONF.watcher_applier.workers
-        self.executor = futures.ThreadPoolExecutor(max_workers=workers)
+        self.executor = futurist.GreenThreadPoolExecutor(max_workers=workers)
 
     def do_launch_action_plan(self, context, action_plan_uuid):
         try:

watcher/applier/workflow_engine/default.py

@@ -91,7 +91,7 @@ class DefaultWorkFlowEngine(base.BaseWorkFlowEngine):
             # default although we still want to leave the possibility for
             # the users to change it.
             # The current implementation uses graph with linked actions.
-            # todo(jed) add olso conf for retry and name
+            # todo(jed) add oslo conf for retry and name
             self.execution_rule = self.get_execution_rule(actions)
             flow = gf.Flow("watcher_flow")
             actions_uuid = {}
@@ -106,7 +106,7 @@ class DefaultWorkFlowEngine(base.BaseWorkFlowEngine):
                               decider=self.decider)
 
             e = engines.load(
-                flow, engine='parallel',
+                flow, executor='greenthreaded', engine='parallel',
                 max_workers=self.config.max_workers)
             e.run()
 

watcher/cmd/__init__.py

@@ -0,0 +1,20 @@
+#
+# Licensed under the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License. You may obtain
+# a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+# License for the specific language governing permissions and limitations
+# under the License.
+
+# NOTE(licanwei): Do eventlet monkey patching here, instead of in
+# common/service.py.  This allows the API service to run without monkey
+# patching under Apache (which uses its own concurrency model). Mixing
+# concurrency models can cause undefined behavior and potentially API timeouts.
+import eventlet
+
+eventlet.monkey_patch()

watcher/cmd/status.py

@@ -15,8 +15,10 @@
 import sys
 
 from oslo_upgradecheck import upgradecheck
+import six
 
 from watcher._i18n import _
+from watcher.common import clients
 from watcher import conf
 
 CONF = conf.CONF
@@ -30,17 +32,18 @@ class Checks(upgradecheck.UpgradeCommands):
     and added to _upgrade_checks tuple.
     """
 
-    def _sample_check(self):
-        """This is sample check added to test the upgrade check framework
-
-        It needs to be removed after adding any real upgrade check
-        """
-        return upgradecheck.Result(upgradecheck.Code.SUCCESS, 'Sample detail')
+    def _minimum_nova_api_version(self):
+        """Checks the minimum required version of nova_client.api_version"""
+        try:
+            clients.check_min_nova_api_version(CONF.nova_client.api_version)
+        except ValueError as e:
+            return upgradecheck.Result(
+                upgradecheck.Code.FAILURE, six.text_type(e))
+        return upgradecheck.Result(upgradecheck.Code.SUCCESS)
 
     _upgrade_checks = (
-        # Sample check added for now.
-        # Whereas in future real checks must be added here in tuple
-        (_('Sample Check'), _sample_check),
+        # Added in Train.
+        (_('Minimum Nova API Version'), _minimum_nova_api_version),
     )
 
 

watcher/common/clients.py

@@ -10,31 +10,52 @@
 # License for the specific language governing permissions and limitations
 # under the License.
 
+from oslo_config import cfg
 
 from cinderclient import client as ciclient
 from glanceclient import client as glclient
 from gnocchiclient import client as gnclient
 from ironicclient import client as irclient
+from keystoneauth1 import adapter as ka_adapter
 from keystoneauth1 import loading as ka_loading
 from keystoneclient import client as keyclient
 from monascaclient import client as monclient
 from neutronclient.neutron import client as netclient
+from novaclient import api_versions as nova_api_versions
 from novaclient import client as nvclient
 
 from watcher.common import exception
 
-from watcher import conf
-
 try:
     from ceilometerclient import client as ceclient
     HAS_CEILCLIENT = True
 except ImportError:
     HAS_CEILCLIENT = False
 
-CONF = conf.CONF
+CONF = cfg.CONF
 
 _CLIENTS_AUTH_GROUP = 'watcher_clients_auth'
 
+# NOTE(mriedem): This is the minimum required version of the nova API for
+# watcher features to work. If new features are added which require new
+# versions, they should perform version discovery and be backward compatible
+# for at least one release before raising the minimum required version.
+MIN_NOVA_API_VERSION = '2.56'
+
+
+def check_min_nova_api_version(config_version):
+    """Validates the minimum required nova API version.
+
+    :param config_version: The configured [nova_client]/api_version value
+    :raises: ValueError if the configured version is less than the required
+        minimum
+    """
+    min_required = nova_api_versions.APIVersion(MIN_NOVA_API_VERSION)
+    if nova_api_versions.APIVersion(config_version) < min_required:
+        raise ValueError('Invalid nova_client.api_version %s. %s or '
+                         'greater is required.' % (config_version,
+                                                   MIN_NOVA_API_VERSION))
+
 
 class OpenStackClients(object):
     """Convenience class to create and cache client instances."""
@@ -53,6 +74,7 @@ class OpenStackClients(object):
         self._monasca = None
         self._neutron = None
         self._ironic = None
+        self._placement = None
 
     def _get_keystone_session(self):
         auth = ka_loading.load_auth_from_conf_options(CONF,
@@ -77,8 +99,16 @@ class OpenStackClients(object):
 
     @exception.wrap_keystone_exception
     def keystone(self):
-        if not self._keystone:
-            self._keystone = keyclient.Client(session=self.session)
+        if self._keystone:
+            return self._keystone
+        keystone_interface = self._get_client_option('keystone',
+                                                     'interface')
+        keystone_region_name = self._get_client_option('keystone',
+                                                       'region_name')
+        self._keystone = keyclient.Client(
+            interface=keystone_interface,
+            region_name=keystone_region_name,
+            session=self.session)
 
         return self._keystone
 
@@ -88,6 +118,9 @@ class OpenStackClients(object):
             return self._nova
 
         novaclient_version = self._get_client_option('nova', 'api_version')
+
+        check_min_nova_api_version(novaclient_version)
+
         nova_endpoint_type = self._get_client_option('nova', 'endpoint_type')
         nova_region_name = self._get_client_option('nova', 'region_name')
         self._nova = nvclient.Client(novaclient_version,
@@ -227,7 +260,31 @@ class OpenStackClients(object):
         endpoint_type = self._get_client_option('ironic', 'endpoint_type')
         ironic_region_name = self._get_client_option('ironic', 'region_name')
         self._ironic = irclient.get_client(ironicclient_version,
-                                           os_endpoint_type=endpoint_type,
+                                           interface=endpoint_type,
                                            region_name=ironic_region_name,
                                            session=self.session)
         return self._ironic
+
+    @exception.wrap_keystone_exception
+    def placement(self):
+        if self._placement:
+            return self._placement
+
+        placement_version = self._get_client_option('placement',
+                                                    'api_version')
+        placement_interface = self._get_client_option('placement',
+                                                      'interface')
+        placement_region_name = self._get_client_option('placement',
+                                                        'region_name')
+        # Set accept header on every request to ensure we notify placement
+        # service of our response body media type preferences.
+        headers = {'accept': 'application/json'}
+        self._placement = ka_adapter.Adapter(
+            session=self.session,
+            service_type='placement',
+            default_microversion=placement_version,
+            interface=placement_interface,
+            region_name=placement_region_name,
+            additional_headers=headers)
+
+        return self._placement

watcher/common/config.py

@@ -21,12 +21,15 @@ from watcher.common import rpc
 from watcher import version
 
 
-def parse_args(argv, default_config_files=None):
+def parse_args(argv, default_config_files=None, default_config_dirs=None):
     default_config_files = (default_config_files or
                             cfg.find_config_files(project='watcher'))
+    default_config_dirs = (default_config_dirs or
+                           cfg.find_config_dirs(project='watcher'))
     rpc.set_defaults(control_exchange='watcher')
     cfg.CONF(argv[1:],
-             project='python-watcher',
+             project='watcher',
              version=version.version_info.release_string(),
+             default_config_dirs=default_config_dirs,
              default_config_files=default_config_files)
     rpc.init(cfg.CONF)

watcher/common/exception.py

@@ -26,16 +26,15 @@ import functools
 import sys
 
 from keystoneclient import exceptions as keystone_exceptions
+from oslo_config import cfg
 from oslo_log import log
 import six
 
 from watcher._i18n import _
 
-from watcher import conf
-
 LOG = log.getLogger(__name__)
 
-CONF = conf.CONF
+CONF = cfg.CONF
 
 
 def wrap_keystone_exception(func):
@@ -211,6 +210,10 @@ class InvalidIntervalOrCron(Invalid):
     msg_fmt = _("Expected an interval or cron syntax but received %(name)s")
 
 
+class DataModelTypeNotFound(ResourceNotFound):
+    msg_fmt = _("The %(data_model_type)s data model could not be found")
+
+
 class GoalNotFound(ResourceNotFound):
     msg_fmt = _("Goal %(goal)s could not be found")
 
@@ -236,11 +239,6 @@ class AuditTemplateAlreadyExists(Conflict):
                 "already exists")
 
 
-class AuditTemplateReferenced(Invalid):
-    msg_fmt = _("AuditTemplate %(audit_template)s is referenced by one or "
-                "multiple audits")
-
-
 class AuditTypeNotFound(Invalid):
     msg_fmt = _("Audit type %(audit_type)s could not be found")
 
@@ -360,26 +358,10 @@ class IllegalArgumentException(WatcherException):
     msg_fmt = _('Illegal argument')
 
 
-class NoSuchMetric(WatcherException):
-    msg_fmt = _('No such metric')
-
-
-class NoDataFound(WatcherException):
-    msg_fmt = _('No rows were returned')
-
-
 class AuthorizationFailure(WatcherException):
     msg_fmt = _('%(client)s connection failed. Reason: %(reason)s')
 
 
-class KeystoneFailure(WatcherException):
-    msg_fmt = _("Keystone API endpoint is missing")
-
-
-class MetricCollectorNotDefined(WatcherException):
-    msg_fmt = _("The metrics resource collector is not defined")
-
-
 class ClusterStateStale(WatcherException):
     msg_fmt = _("The cluster state is stale")
 
@@ -392,10 +374,6 @@ class ClusterStateNotDefined(WatcherException):
     msg_fmt = _("The cluster state is not defined")
 
 
-class CapacityNotDefined(WatcherException):
-    msg_fmt = _("The capacity %(capacity)s is not defined for '%(resource)s'")
-
-
 class NoAvailableStrategyForGoal(WatcherException):
     msg_fmt = _("No strategy could be found to achieve the '%(goal)s' goal.")
 
@@ -410,10 +388,6 @@ class GlobalEfficacyComputationError(WatcherException):
                 "goal using the '%(strategy)s' strategy.")
 
 
-class NoMetricValuesForInstance(WatcherException):
-    msg_fmt = _("No values returned by %(resource_id)s for %(metric_name)s.")
-
-
 class UnsupportedDataSource(UnsupportedError):
     msg_fmt = _("Datasource %(datasource)s is not supported "
                 "by strategy %(strategy)s")
@@ -423,6 +397,16 @@ class DataSourceNotAvailable(WatcherException):
     msg_fmt = _("Datasource %(datasource)s is not available.")
 
 
+class MetricNotAvailable(WatcherException):
+    """Indicate that a metric is not configured or does not exists"""
+    msg_fmt = _('Metric: %(metric)s not available')
+
+
+class NoDatasourceAvailable(WatcherException):
+    """No datasources have been configured"""
+    msg_fmt = _('No datasources available')
+
+
 class NoSuchMetricForHost(WatcherException):
     msg_fmt = _("No %(metric)s metric for %(host)s found.")
 
@@ -467,6 +451,11 @@ class InstanceNotFound(ComputeResourceNotFound):
     msg_fmt = _("The instance '%(name)s' could not be found")
 
 
+class InstanceNotMapped(ComputeResourceNotFound):
+    msg_fmt = _("The mapped compute node for instance '%(uuid)s' "
+                "could not be found.")
+
+
 class ComputeNodeNotFound(ComputeResourceNotFound):
     msg_fmt = _("The compute node %(name)s could not be found")
 

watcher/common/nova_helper.py

@@ -27,7 +27,6 @@ import novaclient.exceptions as nvexceptions
 
 from watcher.common import clients
 from watcher.common import exception
-from watcher.common import utils
 from watcher import conf
 
 LOG = log.getLogger(__name__)
@@ -46,39 +45,92 @@ class NovaHelper(object):
         self.glance = self.osc.glance()
 
     def get_compute_node_list(self):
-        return self.nova.hypervisors.list()
+        hypervisors = self.nova.hypervisors.list()
+        # filter out baremetal nodes from hypervisors
+        compute_nodes = [node for node in hypervisors if
+                         node.hypervisor_type != 'ironic']
+        return compute_nodes
 
-    def get_compute_node_by_id(self, node_id):
-        """Get compute node by ID (*not* UUID)"""
-        # We need to pass an object with an 'id' attribute to make it work
-        return self.nova.hypervisors.get(utils.Struct(id=node_id))
+    def get_compute_node_by_name(self, node_name, servers=False,
+                                 detailed=False):
+        """Search for a hypervisor (compute node) by hypervisor_hostname
 
-    def get_compute_node_by_name(self, node_name, servers=False):
-        return self.nova.hypervisors.search(node_name, servers)
+        :param node_name: The hypervisor_hostname to search
+        :param servers: If true, include information about servers per
+            hypervisor
+        :param detailed: If true, include information about the compute service
+            per hypervisor (requires microversion 2.53)
+        """
+        return self.nova.hypervisors.search(node_name, servers=servers,
+                                            detailed=detailed)
 
     def get_compute_node_by_hostname(self, node_hostname):
-        """Get compute node by hostname"""
-        try:
-            hypervisors = [hv for hv in self.get_compute_node_list()
-                           if hv.service['host'] == node_hostname]
-            if len(hypervisors) != 1:
-                # TODO(hidekazu)
-                # this may occur if VMware vCenter driver is used
-                raise exception.ComputeNodeNotFound(name=node_hostname)
-            else:
-                compute_nodes = self.nova.hypervisors.search(
-                    hypervisors[0].hypervisor_hostname)
-                if len(compute_nodes) != 1:
-                    raise exception.ComputeNodeNotFound(name=node_hostname)
+        """Get compute node by hostname
 
-                return self.get_compute_node_by_id(compute_nodes[0].id)
+        :param node_hostname: Compute service hostname
+        :returns: novaclient.v2.hypervisors.Hypervisor object if found
+        :raises: ComputeNodeNotFound if no hypervisor is found for the compute
+            service hostname or there was an error communicating with nova
+        """
+        try:
+            # This is a fuzzy match on hypervisor_hostname so we could get back
+            # more than one compute node. If so, match on the compute service
+            # hostname.
+            compute_nodes = self.get_compute_node_by_name(
+                node_hostname, detailed=True)
+            for cn in compute_nodes:
+                if cn.service['host'] == node_hostname:
+                    return cn
+            raise exception.ComputeNodeNotFound(name=node_hostname)
         except Exception as exc:
             LOG.exception(exc)
             raise exception.ComputeNodeNotFound(name=node_hostname)
 
-    def get_instance_list(self):
-        return self.nova.servers.list(search_opts={'all_tenants': True},
-                                      limit=-1)
+    def get_compute_node_by_uuid(self, node_uuid):
+        """Get compute node by uuid
+
+        :param node_uuid: hypervisor id as uuid after microversion 2.53
+        :returns: novaclient.v2.hypervisors.Hypervisor object if found
+        """
+        return self.nova.hypervisors.get(node_uuid)
+
+    def get_instance_list(self, filters=None, marker=None, limit=-1):
+        """List servers for all tenants with details.
+
+        This always gets servers with the all_tenants=True filter.
+
+        :param filters: Dict of additional filters (optional).
+        :param marker: Get servers that appear later in the server
+                       list than that represented by this server id (optional).
+        :param limit: Maximum number of servers to return (optional).
+                      If limit == -1, all servers will be returned,
+                      note that limit == -1 will have a performance
+                      penalty. For details, please see:
+                      https://bugs.launchpad.net/watcher/+bug/1834679
+        :returns: list of novaclient Server objects
+        """
+        search_opts = {'all_tenants': True}
+        if filters:
+            search_opts.update(filters)
+        return self.nova.servers.list(search_opts=search_opts,
+                                      marker=marker,
+                                      limit=limit)
+
+    def get_instance_by_uuid(self, instance_uuid):
+        return [instance for instance in
+                self.nova.servers.list(search_opts={"all_tenants": True,
+                                                    "uuid": instance_uuid})]
+
+    def get_instance_by_name(self, instance_name):
+        return [instance for instance in
+                self.nova.servers.list(search_opts={"all_tenants": True,
+                                                    "name": instance_name})]
+
+    def get_instances_by_node(self, host):
+        return [instance for instance in
+                self.nova.servers.list(search_opts={"all_tenants": True,
+                                                    "host": host},
+                                       limit=-1)]
 
     def get_flavor_list(self):
         return self.nova.flavors.list(**{'is_public': None})
@@ -167,13 +219,6 @@ class NovaHelper(object):
                 {'instance': instance_id, 'host': host_name})
 
             previous_status = getattr(instance, 'status')
-
-            if (dest_hostname and
-                    not self._check_nova_api_version(self.nova, "2.56")):
-                LOG.error("For migrating a given dest_hostname,"
-                          "Nova API version must be 2.56 or higher")
-                return False
-
             instance.migrate(host=dest_hostname)
             instance = self.nova.servers.get(instance_id)
 
@@ -313,8 +358,8 @@ class NovaHelper(object):
                 if host_name != new_hostname and instance.status == 'ACTIVE':
                     LOG.debug(
                         "Live migration succeeded : "
-                        "instance %s is now on host '%s'.", (
-                            instance_id, new_hostname))
+                        "instance %(instance)s is now on host '%(host)s'.",
+                        {'instance': instance_id, 'host': new_hostname})
                     return True
                 else:
                     return False
@@ -664,22 +709,6 @@ class NovaHelper(object):
 
         return network_id
 
-    def get_instance_by_uuid(self, instance_uuid):
-        return [instance for instance in
-                self.nova.servers.list(search_opts={"all_tenants": True,
-                                                    "uuid": instance_uuid})]
-
-    def get_instance_by_name(self, instance_name):
-        return [instance for instance in
-                self.nova.servers.list(search_opts={"all_tenants": True,
-                                                    "name": instance_name})]
-
-    def get_instances_by_node(self, host):
-        return [instance for instance in
-                self.nova.servers.list(search_opts={"all_tenants": True,
-                                                    "host": host},
-                                       limit=-1)]
-
     def get_hostname(self, instance):
         return str(getattr(instance, 'OS-EXT-SRV-ATTR:host'))
 

watcher/common/placement_helper.py

@@ -0,0 +1,179 @@
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+# implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+from oslo_config import cfg
+from oslo_log import log as logging
+
+from watcher.common import clients
+
+CONF = cfg.CONF
+LOG = logging.getLogger(__name__)
+
+
+class PlacementHelper(object):
+
+    def __init__(self, osc=None):
+        """:param osc: an OpenStackClients instance"""
+        self.osc = osc if osc else clients.OpenStackClients()
+        self._placement = self.osc.placement()
+
+    def get(self, url):
+        return self._placement.get(url, raise_exc=False)
+
+    @staticmethod
+    def get_error_msg(resp):
+        json_resp = resp.json()
+        # https://docs.openstack.org/api-ref/placement/#errors
+        if 'errors' in json_resp:
+            error_msg = json_resp['errors'][0].get('detail')
+        else:
+            error_msg = resp.text
+
+        return error_msg
+
+    def get_resource_providers(self, rp_name=None):
+        """Calls the placement API for a resource provider record.
+
+        :param rp_name: Name of the resource provider, if None,
+                 list all resource providers.
+        :return: A list of resource providers information
+                 or None if the resource provider doesn't exist.
+        """
+        url = '/resource_providers'
+        if rp_name:
+            url += '?name=%s' % rp_name
+        resp = self.get(url)
+        if resp.status_code == 200:
+            json_resp = resp.json()
+            return json_resp['resource_providers']
+
+        if rp_name:
+            msg = "Failed to get resource provider %(name)s. "
+        else:
+            msg = "Failed to get all resource providers. "
+        msg += "Got %(status_code)d: %(err_text)s."
+        args = {
+            'name': rp_name,
+            'status_code': resp.status_code,
+            'err_text': self.get_error_msg(resp),
+        }
+        LOG.error(msg, args)
+
+    def get_inventories(self, rp_uuid):
+        """Calls the placement API to get resource inventory information.
+
+        :param rp_uuid: UUID of the resource provider to get.
+        :return: A dictionary of inventories keyed by resource classes.
+        """
+        url = '/resource_providers/%s/inventories' % rp_uuid
+        resp = self.get(url)
+        if resp.status_code == 200:
+            json = resp.json()
+            return json['inventories']
+        msg = ("Failed to get resource provider %(rp_uuid)s inventories. "
+               "Got %(status_code)d: %(err_text)s.")
+        args = {
+            'rp_uuid': rp_uuid,
+            'status_code': resp.status_code,
+            'err_text': self.get_error_msg(resp),
+        }
+        LOG.error(msg, args)
+
+    def get_provider_traits(self, rp_uuid):
+        """Queries the placement API for a resource provider's traits.
+
+        :param rp_uuid: UUID of the resource provider to grab traits for.
+        :return: A list of traits.
+        """
+        resp = self.get("/resource_providers/%s/traits" % rp_uuid)
+
+        if resp.status_code == 200:
+            json = resp.json()
+            return json['traits']
+        msg = ("Failed to get resource provider %(rp_uuid)s traits. "
+               "Got %(status_code)d: %(err_text)s.")
+        args = {
+            'rp_uuid': rp_uuid,
+            'status_code': resp.status_code,
+            'err_text': self.get_error_msg(resp),
+        }
+        LOG.error(msg, args)
+
+    def get_allocations_for_consumer(self, consumer_uuid):
+        """Retrieves the allocations for a specific consumer.
+
+        :param consumer_uuid: the UUID of the consumer resource.
+        :return: A dictionary of allocation records keyed by resource
+                 provider uuid.
+        """
+        url = '/allocations/%s' % consumer_uuid
+        resp = self.get(url)
+        if resp.status_code == 200:
+            json = resp.json()
+            return json['allocations']
+        msg = ("Failed to get allocations for consumer %(c_uuid). "
+               "Got %(status_code)d: %(err_text)s.")
+        args = {
+            'c_uuid': consumer_uuid,
+            'status_code': resp.status_code,
+            'err_text': self.get_error_msg(resp),
+        }
+        LOG.error(msg, args)
+
+    def get_usages_for_resource_provider(self, rp_uuid):
+        """Retrieves the usages for a specific provider.
+
+        :param rp_uuid: The UUID of the provider.
+        :return: A dictionary that describes how much each class of
+                 resource is being consumed on this resource provider.
+        """
+        url = '/resource_providers/%s/usages' % rp_uuid
+        resp = self.get(url)
+        if resp.status_code == 200:
+            json = resp.json()
+            return json['usages']
+        msg = ("Failed to get resource provider %(rp_uuid)s usages. "
+               "Got %(status_code)d: %(err_text)s.")
+        args = {
+            'rp_uuid': rp_uuid,
+            'status_code': resp.status_code,
+            'err_text': self.get_error_msg(resp),
+        }
+        LOG.error(msg, args)
+
+    def get_candidate_providers(self, resources):
+        """Returns a dictionary of resource provider summaries.
+
+        :param resources: A comma-separated list of strings indicating
+                  an amount of resource of a specified class that
+                  providers in each allocation request must collectively
+                  have the capacity and availability to serve:
+                  resources=VCPU:4,DISK_GB:64,MEMORY_MB:2048
+        :returns: A dict, keyed by resource provider UUID, which can
+                  provide the required resources.
+        """
+        url = "/allocation_candidates?%s" % resources
+        resp = self.get(url)
+        if resp.status_code == 200:
+            data = resp.json()
+            return data['provider_summaries']
+
+        args = {
+            'resource_request': resources,
+            'status_code': resp.status_code,
+            'err_text': self.get_error_msg(resp),
+        }
+        msg = ("Failed to get allocation candidates from placement "
+               "API for resources: %(resource_request)s\n"
+               "Got %(status_code)d: %(err_text)s.")
+        LOG.error(msg, args)

watcher/common/policies/__init__.py

@@ -17,6 +17,7 @@ from watcher.common.policies import action_plan
 from watcher.common.policies import audit
 from watcher.common.policies import audit_template
 from watcher.common.policies import base
+from watcher.common.policies import data_model
 from watcher.common.policies import goal
 from watcher.common.policies import scoring_engine
 from watcher.common.policies import service
@@ -30,6 +31,7 @@ def list_rules():
         action_plan.list_rules(),
         audit.list_rules(),
         audit_template.list_rules(),
+        data_model.list_rules(),
         goal.list_rules(),
         scoring_engine.list_rules(),
         service.list_rules(),

watcher/common/policies/data_model.py

@@ -0,0 +1,37 @@
+# Copyright 2019 ZTE Corporation.
+#
+#    Licensed under the Apache License, Version 2.0 (the "License"); you may
+#    not use this file except in compliance with the License. You may obtain
+#    a copy of the License at
+#
+#         http://www.apache.org/licenses/LICENSE-2.0
+#
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+#    WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+#    License for the specific language governing permissions and limitations
+#    under the License.
+
+from oslo_policy import policy
+
+from watcher.common.policies import base
+
+DATA_MODEL = 'data_model:%s'
+
+rules = [
+    policy.DocumentedRuleDefault(
+        name=DATA_MODEL % 'get_all',
+        check_str=base.RULE_ADMIN_API,
+        description='List data model.',
+        operations=[
+            {
+                'path': '/v1/data_model',
+                'method': 'GET'
+            }
+        ]
+    ),
+]
+
+
+def list_rules():
+    return rules

watcher/common/scheduling.py

@@ -17,14 +17,41 @@
 # limitations under the License.
 
 from apscheduler import events
+from apscheduler.executors.pool import BasePoolExecutor
 from apscheduler.schedulers import background
+import futurist
 from oslo_service import service
 
 job_events = events
 
 
+class GreenThreadPoolExecutor(BasePoolExecutor):
+    """Green thread pool
+
+    An executor that runs jobs in a green thread pool.
+    Plugin alias: ``threadpool``
+    :param max_workers: the maximum number of spawned threads.
+    """
+
+    def __init__(self, max_workers=10):
+        pool = futurist.GreenThreadPoolExecutor(int(max_workers))
+        super(GreenThreadPoolExecutor, self).__init__(pool)
+
+executors = {
+    'default': GreenThreadPoolExecutor(),
+}
+
+
 class BackgroundSchedulerService(service.ServiceBase,
                                  background.BackgroundScheduler):
+    def __init__(self, gconfig={}, **options):
+        if options is None:
+            options = {'executors': executors}
+        else:
+            if 'executors' not in options.keys():
+                options['executors'] = executors
+        super(BackgroundSchedulerService, self).__init__(
+            gconfig, **options)
 
     def start(self):
         """Start service."""