Compare commits
22 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
16113e255b | ||
|
|
30d6f07ceb | ||
|
|
343a65952a | ||
|
|
9af6886b0e | ||
|
|
b0ef77f5d1 | ||
|
|
f5157f2894 | ||
|
|
13331935df | ||
|
|
8d61c1a2b4 | ||
|
|
6b4b5c2fe5 | ||
|
|
62623a7f77 | ||
|
|
9d2f8d11ec | ||
|
|
f1d064c759 | ||
|
|
6cb02c18a7 | ||
|
|
37fc37e138 | ||
|
|
b68685741e | ||
|
|
6721977f74 | ||
|
|
c303ad4cdc | ||
|
|
51c9db2936 | ||
|
|
1e003d4153 | ||
|
|
bab89fd769 | ||
|
|
e1e17ab0b9 | ||
|
|
3d542472f6 |
3
.gitignore
vendored
3
.gitignore
vendored
@@ -23,7 +23,8 @@ pip-log.txt
|
||||
# Unit test / coverage reports
|
||||
.coverage*
|
||||
.tox
|
||||
.stestr/
|
||||
nosetests.xml
|
||||
.testrepository
|
||||
.venv
|
||||
.idea
|
||||
|
||||
|
||||
@@ -1,4 +1,5 @@
|
||||
[gerrit]
|
||||
host=review.openstack.org
|
||||
host=review.opendev.org
|
||||
port=29418
|
||||
project=openstack/watcher.git
|
||||
defaultbranch=stable/pike
|
||||
|
||||
@@ -1,4 +0,0 @@
|
||||
[DEFAULT]
|
||||
test_path=./watcher/tests
|
||||
top_dir=./
|
||||
|
||||
7
.testr.conf
Normal file
7
.testr.conf
Normal file
@@ -0,0 +1,7 @@
|
||||
[DEFAULT]
|
||||
test_command=OS_STDOUT_CAPTURE=${OS_STDOUT_CAPTURE:-1} \
|
||||
OS_STDERR_CAPTURE=${OS_STDERR_CAPTURE:-1} \
|
||||
OS_TEST_TIMEOUT=${OS_TEST_TIMEOUT:-160} \
|
||||
${PYTHON:-python} -m subunit.run discover -t ./ ${OS_TEST_PATH:-./watcher/tests} $LISTOPT $IDOPTION
|
||||
test_id_option=--load-list $IDFILE
|
||||
test_list_option=--list
|
||||
161
.zuul.yaml
161
.zuul.yaml
@@ -1,156 +1,9 @@
|
||||
- project:
|
||||
check:
|
||||
jobs:
|
||||
- watcher-tempest-functional
|
||||
- watcher-tempest-dummy_optim
|
||||
- watcher-tempest-actuator
|
||||
- watcher-tempest-basic_optim
|
||||
- watcher-tempest-workload_balancing
|
||||
- watcherclient-tempest-functional
|
||||
- watcher-tempest-zone_migration
|
||||
- openstack-tox-lower-constraints
|
||||
templates:
|
||||
- openstack-python-jobs
|
||||
- openstack-python35-jobs
|
||||
- publish-openstack-sphinx-docs
|
||||
- check-requirements
|
||||
- release-notes-jobs
|
||||
gate:
|
||||
jobs:
|
||||
- watcher-tempest-functional
|
||||
- openstack-tox-lower-constraints
|
||||
|
||||
- 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-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-multinode
|
||||
parent: watcher-tempest-functional
|
||||
nodeset: openstack-two-node
|
||||
pre-run: playbooks/pre.yaml
|
||||
run: playbooks/orchestrate-tempest.yaml
|
||||
roles:
|
||||
- zuul: openstack/tempest
|
||||
group-vars:
|
||||
subnode:
|
||||
devstack_local_conf:
|
||||
post-config:
|
||||
$NOVA_CONF:
|
||||
libvirt:
|
||||
live_migration_uri: 'qemu+ssh://root@%s/system'
|
||||
$WATCHER_CONF:
|
||||
watcher_cluster_data_model_collectors.compute:
|
||||
period: 120
|
||||
watcher_cluster_data_model_collectors.baremetal:
|
||||
period: 120
|
||||
watcher_cluster_data_model_collectors.storage:
|
||||
period: 120
|
||||
devstack_services:
|
||||
watcher-api: false
|
||||
watcher-decision-engine: true
|
||||
watcher-applier: false
|
||||
# We need to add TLS support for watcher plugin
|
||||
tls-proxy: false
|
||||
ceilometer: false
|
||||
ceilometer-acompute: false
|
||||
ceilometer-acentral: false
|
||||
ceilometer-anotification: false
|
||||
watcher: false
|
||||
gnocchi-api: false
|
||||
gnocchi-metricd: false
|
||||
rabbit: false
|
||||
mysql: false
|
||||
vars:
|
||||
devstack_local_conf:
|
||||
post-config:
|
||||
$NOVA_CONF:
|
||||
libvirt:
|
||||
live_migration_uri: 'qemu+ssh://root@%s/system'
|
||||
$WATCHER_CONF:
|
||||
watcher_cluster_data_model_collectors.compute:
|
||||
period: 120
|
||||
watcher_cluster_data_model_collectors.baremetal:
|
||||
period: 120
|
||||
watcher_cluster_data_model_collectors.storage:
|
||||
period: 120
|
||||
test-config:
|
||||
$TEMPEST_CONFIG:
|
||||
compute:
|
||||
min_compute_nodes: 2
|
||||
compute-feature-enabled:
|
||||
live_migration: true
|
||||
block_migration_for_live_migration: true
|
||||
devstack_plugins:
|
||||
ceilometer: https://git.openstack.org/openstack/ceilometer
|
||||
|
||||
- job:
|
||||
name: watcher-tempest-functional
|
||||
parent: devstack-tempest
|
||||
timeout: 7200
|
||||
required-projects:
|
||||
- openstack/ceilometer
|
||||
- openstack-infra/devstack-gate
|
||||
- openstack/python-openstackclient
|
||||
- openstack/python-watcherclient
|
||||
- openstack/watcher
|
||||
- openstack/watcher-tempest-plugin
|
||||
- openstack/tempest
|
||||
vars:
|
||||
devstack_plugins:
|
||||
watcher: https://git.openstack.org/openstack/watcher
|
||||
devstack_services:
|
||||
tls-proxy: false
|
||||
watcher-api: true
|
||||
watcher-decision-engine: true
|
||||
watcher-applier: true
|
||||
tempest: true
|
||||
s-account: false
|
||||
s-container: false
|
||||
s-object: false
|
||||
s-proxy: false
|
||||
devstack_localrc:
|
||||
TEMPEST_PLUGINS: '/opt/stack/watcher-tempest-plugin'
|
||||
tempest_test_regex: 'watcher_tempest_plugin.tests.api'
|
||||
tox_envlist: all
|
||||
tox_environment:
|
||||
# Do we really need to set this? It's cargo culted
|
||||
PYTHONUNBUFFERED: 'true'
|
||||
zuul_copy_output:
|
||||
/etc/hosts: logs
|
||||
|
||||
- job:
|
||||
# This job is used in python-watcherclient repo
|
||||
name: watcherclient-tempest-functional
|
||||
parent: watcher-tempest-functional
|
||||
timeout: 4200
|
||||
vars:
|
||||
tempest_concurrency: 1
|
||||
devstack_localrc:
|
||||
TEMPEST_PLUGINS: '/opt/stack/python-watcherclient'
|
||||
tempest_test_regex: 'watcherclient.tests.functional'
|
||||
queue: watcher
|
||||
|
||||
@@ -8,4 +8,4 @@
|
||||
watcher Style Commandments
|
||||
==========================
|
||||
|
||||
Read the OpenStack Style Commandments https://docs.openstack.org/hacking/latest/
|
||||
Read the OpenStack Style Commandments https://docs.openstack.org/developer/hacking/
|
||||
|
||||
@@ -2,8 +2,8 @@
|
||||
Team and repository tags
|
||||
========================
|
||||
|
||||
.. image:: https://governance.openstack.org/tc/badges/watcher.svg
|
||||
:target: https://governance.openstack.org/tc/reference/tags/index.html
|
||||
.. image:: https://governance.openstack.org/badges/watcher.svg
|
||||
:target: https://governance.openstack.org/reference/tags/index.html
|
||||
|
||||
.. Change things from this point on
|
||||
|
||||
@@ -22,11 +22,10 @@ service for multi-tenant OpenStack-based clouds.
|
||||
Watcher provides a robust framework to realize a wide range of cloud
|
||||
optimization goals, including the reduction of data center
|
||||
operating costs, increased system performance via intelligent virtual machine
|
||||
migration, increased energy efficiency and more!
|
||||
migration, increased energy efficiency-and more!
|
||||
|
||||
* Free software: Apache license
|
||||
* Wiki: https://wiki.openstack.org/wiki/Watcher
|
||||
* Source: https://github.com/openstack/watcher
|
||||
* Source: https://github.com/openstack/watcher
|
||||
* Bugs: https://bugs.launchpad.net/watcher
|
||||
* Documentation: https://docs.openstack.org/watcher/latest/
|
||||
* Release notes: https://docs.openstack.org/releasenotes/watcher/
|
||||
|
||||
@@ -1,90 +0,0 @@
|
||||
# Licensed under the Apache License, Version 2.0 (the "License"); you may
|
||||
# not use this file except in compliance with the License. You may obtain
|
||||
# a copy of the License at
|
||||
#
|
||||
# http://www.apache.org/licenses/LICENSE-2.0
|
||||
#
|
||||
# Unless required by applicable law or agreed to in writing, software
|
||||
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
||||
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
||||
# License for the specific language governing permissions and limitations
|
||||
# under the License.
|
||||
#
|
||||
# nova documentation build configuration file, created by
|
||||
# sphinx-quickstart on Sat May 1 15:17:47 2010.
|
||||
#
|
||||
# This file is execfile()d with the current directory set to
|
||||
# its containing dir.
|
||||
#
|
||||
# Note that not all possible configuration values are present in this
|
||||
# autogenerated file.
|
||||
#
|
||||
# All configuration values have a default; values that are commented out
|
||||
# serve to show the default.
|
||||
|
||||
from watcher import version as watcher_version
|
||||
|
||||
|
||||
extensions = [
|
||||
'openstackdocstheme',
|
||||
'os_api_ref',
|
||||
]
|
||||
|
||||
# -- General configuration ----------------------------------------------------
|
||||
|
||||
# Add any Sphinx extension module names here, as strings. They can be
|
||||
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
|
||||
|
||||
# The suffix of source filenames.
|
||||
source_suffix = '.rst'
|
||||
|
||||
# The master toctree document.
|
||||
master_doc = 'index'
|
||||
|
||||
# General information about the project.
|
||||
project = u'Infrastructure Optimization API Reference'
|
||||
copyright = u'2010-present, OpenStack Foundation'
|
||||
|
||||
# openstackdocstheme options
|
||||
repository_name = 'openstack/watcher'
|
||||
bug_project = 'watcher'
|
||||
bug_tag = ''
|
||||
|
||||
# The version info for the project you're documenting, acts as replacement for
|
||||
# |version| and |release|, also used in various other places throughout the
|
||||
# built documents.
|
||||
#
|
||||
# The full version, including alpha/beta/rc tags.
|
||||
release = watcher_version.version_info.release_string()
|
||||
# The short X.Y version.
|
||||
version = watcher_version.version_string
|
||||
|
||||
# The name of the Pygments (syntax highlighting) style to use.
|
||||
pygments_style = 'sphinx'
|
||||
|
||||
# -- Options for HTML output --------------------------------------------------
|
||||
|
||||
# The theme to use for HTML and HTML Help pages. Major themes that come with
|
||||
# Sphinx are currently 'default' and 'sphinxdoc'.
|
||||
html_theme = 'openstackdocs'
|
||||
|
||||
# Theme options are theme-specific and customize the look and feel of a theme
|
||||
# further. For a list of options available for each theme, see the
|
||||
# documentation.
|
||||
html_theme_options = {
|
||||
"sidebar_mode": "toc",
|
||||
}
|
||||
|
||||
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
|
||||
# using the given strftime format.
|
||||
html_last_updated_fmt = '%Y-%m-%d %H:%M'
|
||||
|
||||
# -- Options for LaTeX output -------------------------------------------------
|
||||
|
||||
# Grouping the document tree into LaTeX files. List of tuples
|
||||
# (source start file, target name, title, author, documentclass
|
||||
# [howto/manual]).
|
||||
latex_documents = [
|
||||
('index', 'Watcher.tex', u'Infrastructure Optimization API Reference',
|
||||
u'OpenStack Foundation', 'manual'),
|
||||
]
|
||||
@@ -1,16 +0,0 @@
|
||||
:tocdepth: 2
|
||||
|
||||
===========
|
||||
Watcher API
|
||||
===========
|
||||
|
||||
.. rest_expand_all::
|
||||
|
||||
.. include:: watcher-api-v1-audittemplates.inc
|
||||
.. include:: watcher-api-v1-audits.inc
|
||||
.. include:: watcher-api-v1-actionplans.inc
|
||||
.. include:: watcher-api-v1-actions.inc
|
||||
.. include:: watcher-api-v1-goals.inc
|
||||
.. include:: watcher-api-v1-strategies.inc
|
||||
.. include:: watcher-api-v1-services.inc
|
||||
.. include:: watcher-api-v1-scoring_engines.inc
|
||||
@@ -1,433 +0,0 @@
|
||||
# Path
|
||||
action_ident:
|
||||
description: |
|
||||
The UUID of the Action.
|
||||
in: path
|
||||
required: true
|
||||
type: string
|
||||
actionplan_ident:
|
||||
description: |
|
||||
The UUID of the Action Plan.
|
||||
in: path
|
||||
required: true
|
||||
type: string
|
||||
audit_ident:
|
||||
description: |
|
||||
The UUID or name of the Audit.
|
||||
in: path
|
||||
required: true
|
||||
type: string
|
||||
audittemplate_ident:
|
||||
description: |
|
||||
The UUID or name of the Audit Template.
|
||||
in: path
|
||||
required: true
|
||||
type: string
|
||||
goal_ident:
|
||||
description: |
|
||||
The UUID or name of the Goal.
|
||||
in: path
|
||||
required: true
|
||||
type: string
|
||||
scoring_engine_ident:
|
||||
description: |
|
||||
The UUID or name of the Scoring Engine.
|
||||
in: path
|
||||
required: true
|
||||
type: string
|
||||
service_ident:
|
||||
description: |
|
||||
The ID or name of the Service.
|
||||
in: path
|
||||
required: true
|
||||
type: string
|
||||
strategy_ident:
|
||||
description: |
|
||||
The UUID or name of the Strategy.
|
||||
in: path
|
||||
required: true
|
||||
type: string
|
||||
|
||||
# Query body
|
||||
limit:
|
||||
description: |
|
||||
Requests a page size of items. Returns a number of items up to a ``limit``
|
||||
value. Use the limit parameter to make an initial limited request and use
|
||||
the ID of the last-seen item from the response as the ``marker`` parameter
|
||||
value in a subsequent limited request.
|
||||
in: query
|
||||
required: false
|
||||
type: integer
|
||||
marker:
|
||||
description: |
|
||||
The ID of the last-seen item. Use the ``limit`` parameter to make an
|
||||
initial limited request and use the ID of the last-seen item from the
|
||||
response as the ``marker`` parameter value in a subsequent limited request.
|
||||
in: query
|
||||
required: false
|
||||
type: string
|
||||
r_action_plan:
|
||||
description: |
|
||||
UUID of the action plan used for filtering.
|
||||
in: query
|
||||
required: false
|
||||
type: string
|
||||
r_audit:
|
||||
description: |
|
||||
Optional UUID of an audit, to get only actions for that audit.
|
||||
in: query
|
||||
required: false
|
||||
type: string
|
||||
r_goal:
|
||||
description: |
|
||||
The UUID or name of the Goal.
|
||||
in: query
|
||||
required: false
|
||||
type: string
|
||||
r_strategy:
|
||||
description: |
|
||||
The UUID or name of the Strategy.
|
||||
in: query
|
||||
required: false
|
||||
type: string
|
||||
sort_dir:
|
||||
description: |
|
||||
Sorts the response by the requested sort direction.
|
||||
A valid value is ``asc`` (ascending) or ``desc`` (descending).
|
||||
Default is ``asc``.
|
||||
in: query
|
||||
required: false
|
||||
type: string
|
||||
sort_key:
|
||||
description: |
|
||||
Sorts the response by the this attribute value. Default is ``id``.
|
||||
in: query
|
||||
required: false
|
||||
type: string
|
||||
|
||||
# variables in the API response body
|
||||
|
||||
# Action
|
||||
action_action_plan_uuid:
|
||||
description: |
|
||||
The action plan this action belongs to.
|
||||
in: body
|
||||
required: true
|
||||
type: string
|
||||
action_description:
|
||||
description: |
|
||||
Action description.
|
||||
in: body
|
||||
required: true
|
||||
type: string
|
||||
action_input_parameters:
|
||||
description: |
|
||||
Input parameters which are used by appropriate action type. For example,
|
||||
``migration`` action takes into account such parameters as
|
||||
``migration_type``, ``destination_node``, ``resource_id`` and
|
||||
``source_node``. To see a list of supported action types and their input
|
||||
parameters visit `Action plugins page <https://docs.openstack.org/watcher/latest/contributor/plugin/plugins.html#actions>`_.
|
||||
in: body
|
||||
required: true
|
||||
type: JSON
|
||||
action_parents:
|
||||
description: |
|
||||
UUIDs of parent actions.
|
||||
in: body
|
||||
required: true
|
||||
type: array
|
||||
action_state:
|
||||
description: |
|
||||
State of Action.
|
||||
in: body
|
||||
required: true
|
||||
type: string
|
||||
action_type:
|
||||
description: |
|
||||
Action type based on specific API action. Actions in Watcher are
|
||||
pluggable, to see a list of supported action types visit
|
||||
`Action plugins page <https://docs.openstack.org/watcher/latest/contributor/plugin/plugins.html#actions>`_.
|
||||
in: body
|
||||
required: true
|
||||
type: string
|
||||
|
||||
# Action Plan
|
||||
actionplan_audit_uuid:
|
||||
description: |
|
||||
The UUID of the audit this acton plan belongs to.
|
||||
in: body
|
||||
required: false
|
||||
type: string
|
||||
actionplan_efficacy_indicators:
|
||||
description: |
|
||||
The list of efficacy indicators associated to this action plan.
|
||||
in: body
|
||||
required: false
|
||||
type: array
|
||||
actionplan_global_efficacy:
|
||||
description: |
|
||||
The global efficacy of this action plan.
|
||||
in: body
|
||||
required: false
|
||||
type: array
|
||||
actionplan_state:
|
||||
description: |
|
||||
State of this action plan. To get more information about states and
|
||||
action plan's lifecycle, visit `Action Plan State Machine page <https://docs.openstack.org/watcher/latest/architecture.html#action-plan-state-machine>`_.
|
||||
in: body
|
||||
required: false
|
||||
type: string
|
||||
|
||||
# Audit
|
||||
audit_autotrigger:
|
||||
description: |
|
||||
Autoexecute action plan once audit is succeeded.
|
||||
in: body
|
||||
required: false
|
||||
type: boolean
|
||||
audit_goal:
|
||||
description: |
|
||||
The UUID or name of the Goal.
|
||||
in: body
|
||||
required: false
|
||||
type: string
|
||||
audit_interval:
|
||||
description: |
|
||||
Time interval between audit's execution.
|
||||
Can be set either in seconds or cron syntax.
|
||||
Should be defined only for CONTINUOUS audits.
|
||||
in: body
|
||||
required: false
|
||||
type: string
|
||||
audit_name:
|
||||
description: |
|
||||
Name of this audit.
|
||||
in: body
|
||||
required: false
|
||||
type: string
|
||||
audit_next_run_time:
|
||||
description: |
|
||||
The next time audit launch. Defined only for CONTINUOUS audits.
|
||||
in: body
|
||||
required: false
|
||||
type: string
|
||||
audit_parameters:
|
||||
description: |
|
||||
The strategy parameters for this audit.
|
||||
in: body
|
||||
required: false
|
||||
type: JSON
|
||||
audit_state:
|
||||
description: |
|
||||
State of this audit. To get more information about states and
|
||||
audit's lifecycle, visit `Audit State Machine page <https://docs.openstack.org/watcher/latest/architecture.html#audit-state-machine>`_.
|
||||
in: body
|
||||
required: true
|
||||
type: string
|
||||
audit_strategy:
|
||||
description: |
|
||||
The UUID or name of the Strategy.
|
||||
in: body
|
||||
required: false
|
||||
type: string
|
||||
audit_type:
|
||||
description: |
|
||||
Type of this audit. Can be either ONESHOT or CONTINUOUS.
|
||||
in: body
|
||||
required: true
|
||||
type: string
|
||||
|
||||
# Audit Template
|
||||
audittemplate_description:
|
||||
description: |
|
||||
Short description of the Audit Template.
|
||||
in: body
|
||||
required: false
|
||||
type: string
|
||||
audittemplate_goal:
|
||||
description: |
|
||||
The UUID or name of the Goal.
|
||||
in: body
|
||||
required: true
|
||||
type: string
|
||||
audittemplate_name:
|
||||
description: |
|
||||
The name of the Audit template.
|
||||
in: body
|
||||
required: true
|
||||
type: string
|
||||
audittemplate_scope:
|
||||
description: |
|
||||
Audit Scope.
|
||||
in: body
|
||||
required: false
|
||||
type: JSON
|
||||
audittemplate_strategy:
|
||||
description: |
|
||||
The UUID or name of the Strategy.
|
||||
in: body
|
||||
required: false
|
||||
type: string
|
||||
|
||||
created_at:
|
||||
description: |
|
||||
The date and time when the resource was created. The date and time
|
||||
stamp format is `ISO 8601 <https://en.wikipedia.org/wiki/ISO_8601>`_
|
||||
in: body
|
||||
required: true
|
||||
type: string
|
||||
deleted_at:
|
||||
description: |
|
||||
The date and time when the resource was deleted. The date and time
|
||||
stamp format is `ISO 8601 <https://en.wikipedia.org/wiki/ISO_8601>`_
|
||||
in: body
|
||||
required: true
|
||||
type: string
|
||||
|
||||
# Goal
|
||||
goal_display_name:
|
||||
description: |
|
||||
Localized name of the goal.
|
||||
in: body
|
||||
required: true
|
||||
type: string
|
||||
goal_efficacy_specification:
|
||||
description: |
|
||||
Efficacy specifications as result of stategy's execution.
|
||||
in: body
|
||||
required: true
|
||||
type: array
|
||||
goal_name:
|
||||
description: |
|
||||
Name of the goal.
|
||||
in: body
|
||||
required: true
|
||||
type: string
|
||||
goal_uuid:
|
||||
description: |
|
||||
Unique UUID for this goal.
|
||||
in: body
|
||||
required: true
|
||||
type: string
|
||||
|
||||
links:
|
||||
description: |
|
||||
A list of relative links. Includes the self and bookmark links.
|
||||
in: body
|
||||
required: true
|
||||
type: array
|
||||
|
||||
# Scoring Engine
|
||||
scoring_engine_description:
|
||||
description: |
|
||||
A human readable description of the Scoring Engine.
|
||||
in: body
|
||||
required: true
|
||||
type: string
|
||||
scoring_engine_metainfo:
|
||||
description: |
|
||||
A metadata associated with the scoring engine
|
||||
in: body
|
||||
required: true
|
||||
type: string
|
||||
scoring_engine_name:
|
||||
description: |
|
||||
The name of the scoring engine.
|
||||
in: body
|
||||
required: true
|
||||
type: string
|
||||
# Service
|
||||
service_host:
|
||||
description: |
|
||||
Name of host where service is placed on.
|
||||
in: body
|
||||
required: true
|
||||
type: string
|
||||
service_id:
|
||||
description: |
|
||||
ID of service.
|
||||
in: body
|
||||
required: true
|
||||
type: integer
|
||||
service_last_seen_up:
|
||||
description: |
|
||||
Time when Watcher service sent latest heartbeat.
|
||||
in: body
|
||||
required: true
|
||||
type: string
|
||||
service_name:
|
||||
description: |
|
||||
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.
|
||||
in: body
|
||||
required: true
|
||||
type: string
|
||||
|
||||
# Strategy
|
||||
strategy_check_comment:
|
||||
description: |
|
||||
Requirement comment.
|
||||
in: body
|
||||
required: true
|
||||
type: string
|
||||
strategy_check_mandatory:
|
||||
description: |
|
||||
Whether this requirement mandatory or not.
|
||||
in: body
|
||||
required: true
|
||||
type: boolean
|
||||
strategy_check_state:
|
||||
description: |
|
||||
State of requirement for Strategy.
|
||||
in: body
|
||||
required: true
|
||||
type: string or JSON
|
||||
strategy_check_type:
|
||||
description: |
|
||||
Type of requirement for Strategy.
|
||||
in: body
|
||||
required: true
|
||||
type: string
|
||||
strategy_display_name:
|
||||
description: |
|
||||
Localized name of the strategy.
|
||||
in: body
|
||||
required: true
|
||||
type: string
|
||||
strategy_name:
|
||||
description: |
|
||||
Name of the strategy.
|
||||
in: body
|
||||
required: true
|
||||
type: string
|
||||
strategy_parameters_spec:
|
||||
description: |
|
||||
Parameters specifications for this strategy.
|
||||
in: body
|
||||
required: true
|
||||
type: JSON
|
||||
strategy_uuid:
|
||||
description: |
|
||||
Unique UUID for this strategy.
|
||||
in: body
|
||||
required: true
|
||||
type: string
|
||||
|
||||
updated_at:
|
||||
description: |
|
||||
The date and time when the resource was updated. The date and time
|
||||
stamp format is `ISO 8601 <https://en.wikipedia.org/wiki/ISO_8601>`_
|
||||
in: body
|
||||
required: true
|
||||
type: string
|
||||
uuid:
|
||||
description: |
|
||||
The UUID for the resource.
|
||||
in: body
|
||||
required: true
|
||||
type: string
|
||||
@@ -1,7 +0,0 @@
|
||||
[
|
||||
{
|
||||
"op": "replace",
|
||||
"value": "CANCELLING",
|
||||
"path": "/state"
|
||||
}
|
||||
]
|
||||
@@ -1,7 +0,0 @@
|
||||
[
|
||||
{
|
||||
"op": "replace",
|
||||
"value": "CANCELLED",
|
||||
"path": "/state"
|
||||
}
|
||||
]
|
||||
@@ -1,26 +0,0 @@
|
||||
{
|
||||
"action_plans": [
|
||||
{
|
||||
"state": "ONGOING",
|
||||
"efficacy_indicators": [],
|
||||
"strategy_uuid": "7dae0eea-9df7-42b8-bb3e-313958ff2242",
|
||||
"global_efficacy": [],
|
||||
"links": [
|
||||
{
|
||||
"rel": "self",
|
||||
"href": "http://controller:9322/v1/action_plans/4cbc4ede-0d25-481b-b86e-998dbbd4f8bf"
|
||||
},
|
||||
{
|
||||
"rel": "bookmark",
|
||||
"href": "http://controller:9322/action_plans/4cbc4ede-0d25-481b-b86e-998dbbd4f8bf"
|
||||
}
|
||||
],
|
||||
"updated_at": "2018-04-10T11:59:52.640067+00:00",
|
||||
"strategy_name": "dummy_with_resize",
|
||||
"deleted_at": null,
|
||||
"uuid": "4cbc4ede-0d25-481b-b86e-998dbbd4f8bf",
|
||||
"audit_uuid": "7d100b05-0a86-491f-98a7-f93da19b272a",
|
||||
"created_at": "2018-04-10T11:59:52.640067+00:00"
|
||||
}
|
||||
]
|
||||
}
|
||||
@@ -1,24 +0,0 @@
|
||||
{
|
||||
"action_plans": [
|
||||
{
|
||||
"state": "ONGOING",
|
||||
"efficacy_indicators": [],
|
||||
"strategy_uuid": "7dae0eea-9df7-42b8-bb3e-313958ff2242",
|
||||
"global_efficacy": [],
|
||||
"links": [
|
||||
{
|
||||
"rel": "self",
|
||||
"href": "http://controller:9322/v1/action_plans/4cbc4ede-0d25-481b-b86e-998dbbd4f8bf"
|
||||
},
|
||||
{
|
||||
"rel": "bookmark",
|
||||
"href": "http://controller:9322/action_plans/4cbc4ede-0d25-481b-b86e-998dbbd4f8bf"
|
||||
}
|
||||
],
|
||||
"updated_at": "2018-04-10T11:59:52.640067+00:00",
|
||||
"strategy_name": "dummy_with_resize",
|
||||
"uuid": "4cbc4ede-0d25-481b-b86e-998dbbd4f8bf",
|
||||
"audit_uuid": "7d100b05-0a86-491f-98a7-f93da19b272a"
|
||||
}
|
||||
]
|
||||
}
|
||||
@@ -1,20 +0,0 @@
|
||||
{
|
||||
"state": "ONGOING",
|
||||
"efficacy_indicators": [],
|
||||
"strategy_uuid": "7dae0eea-9df7-42b8-bb3e-313958ff2242",
|
||||
"global_efficacy": [],
|
||||
"links": [
|
||||
{
|
||||
"rel": "self",
|
||||
"href": "http://controller:9322/v1/action_plans/4cbc4ede-0d25-481b-b86e-998dbbd4f8bf"
|
||||
},
|
||||
{
|
||||
"rel": "bookmark",
|
||||
"href": "http://controller:9322/action_plans/4cbc4ede-0d25-481b-b86e-998dbbd4f8bf"
|
||||
}
|
||||
],
|
||||
"updated_at": "2018-04-10T11:59:52.640067+00:00",
|
||||
"strategy_name": "dummy_with_resize",
|
||||
"uuid": "4cbc4ede-0d25-481b-b86e-998dbbd4f8bf",
|
||||
"audit_uuid": "7d100b05-0a86-491f-98a7-f93da19b272a"
|
||||
}
|
||||
@@ -1,22 +0,0 @@
|
||||
{
|
||||
"state": "PENDING",
|
||||
"efficacy_indicators": [],
|
||||
"strategy_uuid": "7dae0eea-9df7-42b8-bb3e-313958ff2242",
|
||||
"global_efficacy": [],
|
||||
"links": [
|
||||
{
|
||||
"rel": "self",
|
||||
"href": "http://controller:9322/v1/action_plans/4cbc4ede-0d25-481b-b86e-998dbbd4f8bf"
|
||||
},
|
||||
{
|
||||
"rel": "bookmark",
|
||||
"href": "http://controller:9322/action_plans/4cbc4ede-0d25-481b-b86e-998dbbd4f8bf"
|
||||
}
|
||||
],
|
||||
"updated_at": "2018-04-10T11:59:41.602430+00:00",
|
||||
"strategy_name": "dummy_with_resize",
|
||||
"uuid": "4cbc4ede-0d25-481b-b86e-998dbbd4f8bf",
|
||||
"audit_uuid": "7d100b05-0a86-491f-98a7-f93da19b272a",
|
||||
"created_at": "2018-04-10T11:59:12.592729+00:00",
|
||||
"deleted_at": null
|
||||
}
|
||||
@@ -1,30 +0,0 @@
|
||||
{
|
||||
"actions": [
|
||||
{
|
||||
"state": "PENDING",
|
||||
"description": "Wait for a given interval in seconds.",
|
||||
"parents": [
|
||||
"8119d16e-b419-4729-b015-fc04c4e45783"
|
||||
],
|
||||
"links": [
|
||||
{
|
||||
"rel": "self",
|
||||
"href": "http://controller:9322/v1/actions/7182a988-e6c4-4152-a0d6-067119475c83"
|
||||
},
|
||||
{
|
||||
"rel": "bookmark",
|
||||
"href": "http://controller:9322/actions/7182a988-e6c4-4152-a0d6-067119475c83"
|
||||
}
|
||||
],
|
||||
"action_plan_uuid": "c6bba9ed-a7eb-4370-9993-d873e5e22cba",
|
||||
"uuid": "7182a988-e6c4-4152-a0d6-067119475c83",
|
||||
"deleted_at": null,
|
||||
"updated_at": null,
|
||||
"input_parameters": {
|
||||
"duration": 3.2
|
||||
},
|
||||
"action_type": "sleep",
|
||||
"created_at": "2018-03-26T11:56:08.235226+00:00"
|
||||
}
|
||||
]
|
||||
}
|
||||
@@ -1,23 +0,0 @@
|
||||
{
|
||||
"actions": [
|
||||
{
|
||||
"state": "PENDING",
|
||||
"parents": [
|
||||
"8119d16e-b419-4729-b015-fc04c4e45783"
|
||||
],
|
||||
"links": [
|
||||
{
|
||||
"rel": "self",
|
||||
"href": "http://controller:9322/v1/actions/7182a988-e6c4-4152-a0d6-067119475c83"
|
||||
},
|
||||
{
|
||||
"rel": "bookmark",
|
||||
"href": "http://controller:9322/actions/7182a988-e6c4-4152-a0d6-067119475c83"
|
||||
}
|
||||
],
|
||||
"action_plan_uuid": "c6bba9ed-a7eb-4370-9993-d873e5e22cba",
|
||||
"uuid": "7182a988-e6c4-4152-a0d6-067119475c83",
|
||||
"action_type": "sleep"
|
||||
}
|
||||
]
|
||||
}
|
||||
@@ -1,26 +0,0 @@
|
||||
{
|
||||
"state": "SUCCEEDED",
|
||||
"description": "Logging a NOP message",
|
||||
"parents": [
|
||||
"b4529294-1de6-4302-b57a-9b5d5dc363c6"
|
||||
],
|
||||
"links": [
|
||||
{
|
||||
"rel": "self",
|
||||
"href": "http://controller:9322/v1/actions/54acc7a0-91b0-46ea-a5f7-4ae2b9df0b0a"
|
||||
},
|
||||
{
|
||||
"rel": "bookmark",
|
||||
"href": "http://controller:9322/actions/54acc7a0-91b0-46ea-a5f7-4ae2b9df0b0a"
|
||||
}
|
||||
],
|
||||
"action_plan_uuid": "4cbc4ede-0d25-481b-b86e-998dbbd4f8bf",
|
||||
"uuid": "54acc7a0-91b0-46ea-a5f7-4ae2b9df0b0a",
|
||||
"deleted_at": null,
|
||||
"updated_at": "2018-04-10T11:59:44.026973+00:00",
|
||||
"input_parameters": {
|
||||
"message": "Welcome"
|
||||
},
|
||||
"action_type": "nop",
|
||||
"created_at": "2018-04-10T11:59:12.725147+00:00"
|
||||
}
|
||||
@@ -1,7 +0,0 @@
|
||||
[
|
||||
{
|
||||
"op": "replace",
|
||||
"value": "CANCELLED",
|
||||
"path": "/state"
|
||||
}
|
||||
]
|
||||
@@ -1,51 +0,0 @@
|
||||
{
|
||||
"interval": "*/2 * * * *",
|
||||
"strategy_uuid": "6b3b3902-8508-4cb0-bb85-67f32866b086",
|
||||
"goal_uuid": "e1a5a45b-f251-47cf-9c5f-fa1e66e1286a",
|
||||
"name": "audit1",
|
||||
"parameters": {
|
||||
"host_choice": "retry",
|
||||
"instance_metrics": {
|
||||
"cpu_util": "compute.node.cpu.percent",
|
||||
"memory.resident": "hardware.memory.used"
|
||||
},
|
||||
"granularity": 300,
|
||||
"weights": {
|
||||
"cpu_util_weight": 1.0,
|
||||
"memory.resident_weight": 1.0
|
||||
},
|
||||
"retry_count": 1,
|
||||
"metrics": [
|
||||
"cpu_util"
|
||||
],
|
||||
"periods": {
|
||||
"instance": 720,
|
||||
"node": 600
|
||||
},
|
||||
"thresholds": {
|
||||
"cpu_util": 0.2,
|
||||
"memory.resident": 0.2
|
||||
}
|
||||
},
|
||||
"auto_trigger": false,
|
||||
"uuid": "65a5da84-5819-4aea-8278-a28d2b489028",
|
||||
"goal_name": "workload_balancing",
|
||||
"scope": [],
|
||||
"created_at": "2018-04-06T07:27:27.820460+00:00",
|
||||
"deleted_at": null,
|
||||
"state": "CANCELLED",
|
||||
"audit_type": "CONTINUOUS",
|
||||
"links": [
|
||||
{
|
||||
"rel": "self",
|
||||
"href": "http://controller:9322/v1/audits/65a5da84-5819-4aea-8278-a28d2b489028"
|
||||
},
|
||||
{
|
||||
"rel": "bookmark",
|
||||
"href": "http://controller:9322/audits/65a5da84-5819-4aea-8278-a28d2b489028"
|
||||
}
|
||||
],
|
||||
"strategy_name": "workload_stabilization",
|
||||
"next_run_time": "2018-04-06T11:56:00",
|
||||
"updated_at": "2018-04-06T11:54:01.266447+00:00"
|
||||
}
|
||||
@@ -1,12 +0,0 @@
|
||||
{
|
||||
"auto_trigger": false,
|
||||
"audit_template_uuid": "76fddfee-a9c4-40b0-8da0-c19ad6904f09",
|
||||
"name": "test_audit",
|
||||
"parameters": {
|
||||
"metrics": [
|
||||
"cpu_util"
|
||||
]
|
||||
},
|
||||
"audit_type": "CONTINUOUS",
|
||||
"interval": "*/2 * * * *"
|
||||
}
|
||||
@@ -1,5 +0,0 @@
|
||||
{
|
||||
"audit_type": "ONESHOT",
|
||||
"auto_trigger": false,
|
||||
"audit_template_uuid": "5e70a156-ced7-4012-b1c6-88fcb02ee0c1"
|
||||
}
|
||||
@@ -1,51 +0,0 @@
|
||||
{
|
||||
"interval": "*/2 * * * *",
|
||||
"strategy_uuid": "6b3b3902-8508-4cb0-bb85-67f32866b086",
|
||||
"goal_uuid": "e1a5a45b-f251-47cf-9c5f-fa1e66e1286a",
|
||||
"name": "test_audit",
|
||||
"parameters": {
|
||||
"host_choice": "retry",
|
||||
"granularity": 300,
|
||||
"thresholds": {
|
||||
"cpu_util": 0.2,
|
||||
"memory.resident": 0.2
|
||||
},
|
||||
"periods": {
|
||||
"node": 600,
|
||||
"instance": 720
|
||||
},
|
||||
"retry_count": 1,
|
||||
"metrics": [
|
||||
"cpu_util"
|
||||
],
|
||||
"weights": {
|
||||
"cpu_util_weight": 1.0,
|
||||
"memory.resident_weight": 1.0
|
||||
},
|
||||
"instance_metrics": {
|
||||
"cpu_util": "compute.node.cpu.percent",
|
||||
"memory.resident": "hardware.memory.used"
|
||||
}
|
||||
},
|
||||
"auto_trigger": false,
|
||||
"uuid": "65a5da84-5819-4aea-8278-a28d2b489028",
|
||||
"goal_name": "workload_balancing",
|
||||
"scope": [],
|
||||
"created_at": "2018-04-06T07:27:27.820460+00:00",
|
||||
"deleted_at": null,
|
||||
"state": "PENDING",
|
||||
"audit_type": "CONTINUOUS",
|
||||
"links": [
|
||||
{
|
||||
"rel": "self",
|
||||
"href": "http://controller:9322/v1/audits/65a5da84-5819-4aea-8278-a28d2b489028"
|
||||
},
|
||||
{
|
||||
"rel": "bookmark",
|
||||
"href": "http://controller:9322/audits/65a5da84-5819-4aea-8278-a28d2b489028"
|
||||
}
|
||||
],
|
||||
"strategy_name": "workload_stabilization",
|
||||
"next_run_time": null,
|
||||
"updated_at": null
|
||||
}
|
||||
@@ -1,55 +0,0 @@
|
||||
{
|
||||
"audits": [
|
||||
{
|
||||
"interval": "*/2 * * * *",
|
||||
"strategy_uuid": "6b3b3902-8508-4cb0-bb85-67f32866b086",
|
||||
"goal_uuid": "e1a5a45b-f251-47cf-9c5f-fa1e66e1286a",
|
||||
"name": "test_audit",
|
||||
"parameters": {
|
||||
"host_choice": "retry",
|
||||
"instance_metrics": {
|
||||
"cpu_util": "compute.node.cpu.percent",
|
||||
"memory.resident": "hardware.memory.used"
|
||||
},
|
||||
"granularity": 300,
|
||||
"weights": {
|
||||
"cpu_util_weight": 1.0,
|
||||
"memory.resident_weight": 1.0
|
||||
},
|
||||
"retry_count": 1,
|
||||
"metrics": [
|
||||
"cpu_util"
|
||||
],
|
||||
"periods": {
|
||||
"instance": 720,
|
||||
"node": 600
|
||||
},
|
||||
"thresholds": {
|
||||
"cpu_util": 0.2,
|
||||
"memory.resident": 0.2
|
||||
}
|
||||
},
|
||||
"auto_trigger": false,
|
||||
"uuid": "65a5da84-5819-4aea-8278-a28d2b489028",
|
||||
"goal_name": "workload_balancing",
|
||||
"scope": [],
|
||||
"created_at": "2018-04-06T07:27:27.820460+00:00",
|
||||
"deleted_at": null,
|
||||
"state": "ONGOING",
|
||||
"audit_type": "CONTINUOUS",
|
||||
"links": [
|
||||
{
|
||||
"rel": "self",
|
||||
"href": "http://controller:9322/v1/audits/65a5da84-5819-4aea-8278-a28d2b489028"
|
||||
},
|
||||
{
|
||||
"rel": "bookmark",
|
||||
"href": "http://controller:9322/audits/65a5da84-5819-4aea-8278-a28d2b489028"
|
||||
}
|
||||
],
|
||||
"strategy_name": "workload_stabilization",
|
||||
"next_run_time": "2018-04-06T09:46:00",
|
||||
"updated_at": "2018-04-06T09:44:01.604146+00:00"
|
||||
}
|
||||
]
|
||||
}
|
||||
@@ -1,28 +0,0 @@
|
||||
{
|
||||
"audits": [
|
||||
{
|
||||
"interval": null,
|
||||
"strategy_uuid": "e311727b-b9b3-43ef-a5f7-8bd7ea80df25",
|
||||
"goal_uuid": "4690f8ba-18ff-45c1-99e9-159556d23810",
|
||||
"name": "dummy-2018-03-26T11:56:07.950400",
|
||||
"auto_trigger": false,
|
||||
"uuid": "ccc69a5f-114e-46f4-b15e-a77eaa337b01",
|
||||
"goal_name": "dummy",
|
||||
"scope": [],
|
||||
"state": "SUCCEEDED",
|
||||
"audit_type": "ONESHOT",
|
||||
"links": [
|
||||
{
|
||||
"rel": "self",
|
||||
"href": "http://controller:9322/v1/audits/ccc69a5f-114e-46f4-b15e-a77eaa337b01"
|
||||
},
|
||||
{
|
||||
"rel": "bookmark",
|
||||
"href": "http://controller:9322/audits/ccc69a5f-114e-46f4-b15e-a77eaa337b01"
|
||||
}
|
||||
],
|
||||
"strategy_name": "dummy",
|
||||
"next_run_time": null
|
||||
}
|
||||
]
|
||||
}
|
||||
@@ -1,51 +0,0 @@
|
||||
{
|
||||
"interval": "*/2 * * * *",
|
||||
"strategy_uuid": "6b3b3902-8508-4cb0-bb85-67f32866b086",
|
||||
"goal_uuid": "e1a5a45b-f251-47cf-9c5f-fa1e66e1286a",
|
||||
"name": "test_audit",
|
||||
"parameters": {
|
||||
"host_choice": "retry",
|
||||
"instance_metrics": {
|
||||
"cpu_util": "compute.node.cpu.percent",
|
||||
"memory.resident": "hardware.memory.used"
|
||||
},
|
||||
"granularity": 300,
|
||||
"weights": {
|
||||
"cpu_util_weight": 1.0,
|
||||
"memory.resident_weight": 1.0
|
||||
},
|
||||
"retry_count": 1,
|
||||
"metrics": [
|
||||
"cpu_util"
|
||||
],
|
||||
"periods": {
|
||||
"instance": 720,
|
||||
"node": 600
|
||||
},
|
||||
"thresholds": {
|
||||
"cpu_util": 0.2,
|
||||
"memory.resident": 0.2
|
||||
}
|
||||
},
|
||||
"auto_trigger": false,
|
||||
"uuid": "65a5da84-5819-4aea-8278-a28d2b489028",
|
||||
"goal_name": "workload_balancing",
|
||||
"scope": [],
|
||||
"created_at": "2018-04-06T07:27:27.820460+00:00",
|
||||
"deleted_at": null,
|
||||
"state": "ONGOING",
|
||||
"audit_type": "CONTINUOUS",
|
||||
"links": [
|
||||
{
|
||||
"rel": "self",
|
||||
"href": "http://controller:9322/v1/audits/65a5da84-5819-4aea-8278-a28d2b489028"
|
||||
},
|
||||
{
|
||||
"rel": "bookmark",
|
||||
"href": "http://controller:9322/audits/65a5da84-5819-4aea-8278-a28d2b489028"
|
||||
}
|
||||
],
|
||||
"strategy_name": "workload_stabilization",
|
||||
"next_run_time": "2018-04-06T11:56:00",
|
||||
"updated_at": "2018-04-06T11:54:01.266447+00:00"
|
||||
}
|
||||
@@ -1,12 +0,0 @@
|
||||
[
|
||||
{
|
||||
"value": "CANCELLED",
|
||||
"path": "/state",
|
||||
"op": "replace"
|
||||
},
|
||||
{
|
||||
"value": "audit1",
|
||||
"path": "/name",
|
||||
"op": "replace"
|
||||
}
|
||||
]
|
||||
@@ -1,51 +0,0 @@
|
||||
{
|
||||
"interval": "*/2 * * * *",
|
||||
"strategy_uuid": "6b3b3902-8508-4cb0-bb85-67f32866b086",
|
||||
"goal_uuid": "e1a5a45b-f251-47cf-9c5f-fa1e66e1286a",
|
||||
"name": "audit1",
|
||||
"parameters": {
|
||||
"host_choice": "retry",
|
||||
"instance_metrics": {
|
||||
"cpu_util": "compute.node.cpu.percent",
|
||||
"memory.resident": "hardware.memory.used"
|
||||
},
|
||||
"granularity": 300,
|
||||
"weights": {
|
||||
"cpu_util_weight": 1.0,
|
||||
"memory.resident_weight": 1.0
|
||||
},
|
||||
"retry_count": 1,
|
||||
"metrics": [
|
||||
"cpu_util"
|
||||
],
|
||||
"periods": {
|
||||
"instance": 720,
|
||||
"node": 600
|
||||
},
|
||||
"thresholds": {
|
||||
"cpu_util": 0.2,
|
||||
"memory.resident": 0.2
|
||||
}
|
||||
},
|
||||
"auto_trigger": false,
|
||||
"uuid": "65a5da84-5819-4aea-8278-a28d2b489028",
|
||||
"goal_name": "workload_balancing",
|
||||
"scope": [],
|
||||
"created_at": "2018-04-06T07:27:27.820460+00:00",
|
||||
"deleted_at": null,
|
||||
"state": "CANCELLED",
|
||||
"audit_type": "CONTINUOUS",
|
||||
"links": [
|
||||
{
|
||||
"rel": "self",
|
||||
"href": "http://controller:9322/v1/audits/65a5da84-5819-4aea-8278-a28d2b489028"
|
||||
},
|
||||
{
|
||||
"rel": "bookmark",
|
||||
"href": "http://controller:9322/audits/65a5da84-5819-4aea-8278-a28d2b489028"
|
||||
}
|
||||
],
|
||||
"strategy_name": "workload_stabilization",
|
||||
"next_run_time": "2018-04-06T11:56:00",
|
||||
"updated_at": "2018-04-06T11:54:01.266447+00:00"
|
||||
}
|
||||
@@ -1,7 +0,0 @@
|
||||
{
|
||||
"name": "at2",
|
||||
"goal": "dummy",
|
||||
"strategy": "dummy",
|
||||
"description": "the second audit template",
|
||||
"scope": []
|
||||
}
|
||||
@@ -1,4 +0,0 @@
|
||||
{
|
||||
"name": "at2",
|
||||
"goal": "dummy"
|
||||
}
|
||||
@@ -1,23 +0,0 @@
|
||||
{
|
||||
"description": null,
|
||||
"strategy_uuid": null,
|
||||
"goal_uuid": "4690f8ba-18ff-45c1-99e9-159556d23810",
|
||||
"name": "at3",
|
||||
"uuid": "b4041d8c-85d7-4224-851d-649fe48b7196",
|
||||
"goal_name": "dummy",
|
||||
"scope": [],
|
||||
"created_at": "2018-04-04T08:38:33.110432+00:00",
|
||||
"deleted_at": null,
|
||||
"links": [
|
||||
{
|
||||
"rel": "self",
|
||||
"href": "http://controller:9322/v1/audit_templates/b4041d8c-85d7-4224-851d-649fe48b7196"
|
||||
},
|
||||
{
|
||||
"rel": "bookmark",
|
||||
"href": "http://controller:9322/audit_templates/b4041d8c-85d7-4224-851d-649fe48b7196"
|
||||
}
|
||||
],
|
||||
"strategy_name": null,
|
||||
"updated_at": null
|
||||
}
|
||||
@@ -1,23 +0,0 @@
|
||||
{
|
||||
"audit_templates":[
|
||||
{
|
||||
"strategy_uuid": null,
|
||||
"goal_uuid": "4690f8ba-18ff-45c1-99e9-159556d23810",
|
||||
"name": "at3",
|
||||
"links": [
|
||||
{
|
||||
"rel": "self",
|
||||
"href": "http://controller:9322/v1/audit_templates/b4041d8c-85d7-4224-851d-649fe48b7196"
|
||||
},
|
||||
{
|
||||
"rel": "bookmark", "href":
|
||||
"http://controller:9322/audit_templates/b4041d8c-85d7-4224-851d-649fe48b7196"
|
||||
}
|
||||
],
|
||||
"strategy_name": null,
|
||||
"uuid": "b4041d8c-85d7-4224-851d-649fe48b7196",
|
||||
"goal_name": "dummy", "scope": [],
|
||||
"description": null
|
||||
}
|
||||
]
|
||||
}
|
||||
@@ -1,22 +0,0 @@
|
||||
{
|
||||
"audit_templates":[
|
||||
{
|
||||
"strategy_uuid": null,
|
||||
"goal_uuid": "4690f8ba-18ff-45c1-99e9-159556d23810",
|
||||
"name": "at3",
|
||||
"links": [
|
||||
{
|
||||
"rel": "self",
|
||||
"href": "http://controller:9322/v1/audit_templates/b4041d8c-85d7-4224-851d-649fe48b7196"
|
||||
},
|
||||
{
|
||||
"rel": "bookmark", "href":
|
||||
"http://controller:9322/audit_templates/b4041d8c-85d7-4224-851d-649fe48b7196"
|
||||
}
|
||||
],
|
||||
"strategy_name": null,
|
||||
"uuid": "b4041d8c-85d7-4224-851d-649fe48b7196",
|
||||
"goal_name": "dummy", "scope": []
|
||||
}
|
||||
]
|
||||
}
|
||||
@@ -1,23 +0,0 @@
|
||||
{
|
||||
"description": "test 1",
|
||||
"strategy_uuid": null,
|
||||
"goal_uuid": "4690f8ba-18ff-45c1-99e9-159556d23810",
|
||||
"name": "at1",
|
||||
"uuid": "0d100c27-14af-4962-86fb-f6079287c9c6",
|
||||
"goal_name": "dummy",
|
||||
"scope": [],
|
||||
"created_at": "2018-04-04T07:48:36.175472+00:00",
|
||||
"deleted_at": null,
|
||||
"links": [
|
||||
{
|
||||
"rel": "self",
|
||||
"href": "http://controller:9322/v1/audit_templates/0d100c27-14af-4962-86fb-f6079287c9c6"
|
||||
},
|
||||
{
|
||||
"rel": "bookmark",
|
||||
"href": "http://controller:9322/audit_templates/0d100c27-14af-4962-86fb-f6079287c9c6"
|
||||
}
|
||||
],
|
||||
"strategy_name": null,
|
||||
"updated_at": "2018-04-05T07:57:55.803650+00:00"
|
||||
}
|
||||
@@ -1,7 +0,0 @@
|
||||
[
|
||||
{
|
||||
"op": "replace",
|
||||
"value": "PENDING",
|
||||
"path": "/state"
|
||||
}
|
||||
]
|
||||
@@ -1,23 +0,0 @@
|
||||
{
|
||||
"description": "test 1",
|
||||
"strategy_uuid": null,
|
||||
"goal_uuid": "4690f8ba-18ff-45c1-99e9-159556d23810",
|
||||
"name": "at11",
|
||||
"uuid": "0d100c27-14af-4962-86fb-f6079287c9c6",
|
||||
"goal_name": "dummy",
|
||||
"scope": [],
|
||||
"created_at": "2018-04-04T07:48:36.175472+00:00",
|
||||
"deleted_at": null,
|
||||
"links": [
|
||||
{
|
||||
"rel": "self",
|
||||
"href": "http://controller:9322/v1/audit_templates/0d100c27-14af-4962-86fb-f6079287c9c6"
|
||||
},
|
||||
{
|
||||
"rel": "bookmark",
|
||||
"href": "http://controller:9322/audit_templates/0d100c27-14af-4962-86fb-f6079287c9c6"
|
||||
}
|
||||
],
|
||||
"strategy_name": null,
|
||||
"updated_at": "2018-04-05T07:57:42.139127+00:00"
|
||||
}
|
||||
@@ -1,55 +0,0 @@
|
||||
{
|
||||
"goals": [
|
||||
{
|
||||
"efficacy_specification": [],
|
||||
"uuid": "e1a5a45b-f251-47cf-9c5f-fa1e66e1286a",
|
||||
"links": [
|
||||
{
|
||||
"rel": "self",
|
||||
"href": "http://controller:9322/v1/goals/e1a5a45b-f251-47cf-9c5f-fa1e66e1286a"
|
||||
},
|
||||
{
|
||||
"rel": "bookmark",
|
||||
"href": "http://controller:9322/goals/e1a5a45b-f251-47cf-9c5f-fa1e66e1286a"
|
||||
}
|
||||
],
|
||||
"name": "workload_balancing",
|
||||
"display_name": "Workload Balancing"
|
||||
},
|
||||
{
|
||||
"efficacy_specification": [
|
||||
{
|
||||
"description": "The total number of enabled compute nodes.",
|
||||
"schema": "Range(min=0, max=None, min_included=True, max_included=True, msg=None)",
|
||||
"name": "compute_nodes_count",
|
||||
"unit": null
|
||||
},
|
||||
{
|
||||
"description": "The number of compute nodes to be released.",
|
||||
"schema": "Range(min=0, max=None, min_included=True, max_included=True, msg=None)",
|
||||
"name": "released_compute_nodes_count",
|
||||
"unit": null
|
||||
},
|
||||
{
|
||||
"description": "The number of VM migrations to be performed.",
|
||||
"schema": "Range(min=0, max=None, min_included=True, max_included=True, msg=None)",
|
||||
"name": "instance_migrations_count",
|
||||
"unit": null
|
||||
}
|
||||
],
|
||||
"uuid": "cb9afa5e-aec7-4a8c-9261-c15c33f2262b",
|
||||
"links": [
|
||||
{
|
||||
"rel": "self",
|
||||
"href": "http://controller:9322/v1/goals/cb9afa5e-aec7-4a8c-9261-c15c33f2262b"
|
||||
},
|
||||
{
|
||||
"rel": "bookmark",
|
||||
"href": "http://controller:9322/goals/cb9afa5e-aec7-4a8c-9261-c15c33f2262b"
|
||||
}
|
||||
],
|
||||
"name": "server_consolidation",
|
||||
"display_name": "Server Consolidation"
|
||||
}
|
||||
]
|
||||
}
|
||||
@@ -1,19 +0,0 @@
|
||||
{
|
||||
"efficacy_specification": [],
|
||||
"name": "saving_energy",
|
||||
"links": [
|
||||
{
|
||||
"rel": "self",
|
||||
"href": "http://controller:9322/v1/goals/6f52889a-9dd4-4dbb-8e70-39b56c4836cc"
|
||||
},
|
||||
{
|
||||
"rel": "bookmark",
|
||||
"href": "http://controller:9322/goals/6f52889a-9dd4-4dbb-8e70-39b56c4836cc"
|
||||
}
|
||||
],
|
||||
"uuid": "6f52889a-9dd4-4dbb-8e70-39b56c4836cc",
|
||||
"updated_at": null,
|
||||
"display_name": "Saving Energy",
|
||||
"created_at": "2018-03-26T11:55:24.365584+00:00",
|
||||
"deleted_at": null
|
||||
}
|
||||
@@ -1,20 +0,0 @@
|
||||
{
|
||||
"scoring_engines": [
|
||||
{
|
||||
"description": "Dummy Scorer calculating the average value",
|
||||
"uuid": "5a44f007-55b1-423c-809f-6a274a9bd93b",
|
||||
"links": [
|
||||
{
|
||||
"rel": "self",
|
||||
"href": "http://controller:9322/v1/scoring_engines/5a44f007-55b1-423c-809f-6a274a9bd93b"
|
||||
},
|
||||
{
|
||||
"rel": "bookmark",
|
||||
"href": "http://controller:9322/scoring_engines/5a44f007-55b1-423c-809f-6a274a9bd93b"
|
||||
}
|
||||
],
|
||||
"name": "dummy_avg_scorer",
|
||||
"metainfo": ""
|
||||
}
|
||||
]
|
||||
}
|
||||
@@ -1,19 +0,0 @@
|
||||
{
|
||||
"scoring_engines": [
|
||||
{
|
||||
"description": "Dummy Scorer calculating the average value",
|
||||
"uuid": "5a44f007-55b1-423c-809f-6a274a9bd93b",
|
||||
"links": [
|
||||
{
|
||||
"rel": "self",
|
||||
"href": "http://controller:9322/v1/scoring_engines/5a44f007-55b1-423c-809f-6a274a9bd93b"
|
||||
},
|
||||
{
|
||||
"rel": "bookmark",
|
||||
"href": "http://controller:9322/scoring_engines/5a44f007-55b1-423c-809f-6a274a9bd93b"
|
||||
}
|
||||
],
|
||||
"name": "dummy_avg_scorer"
|
||||
}
|
||||
]
|
||||
}
|
||||
@@ -1,16 +0,0 @@
|
||||
{
|
||||
"description": "Dummy Scorer calculating the maximum value",
|
||||
"uuid": "1ac42282-4e77-473e-898b-62ea007f1deb",
|
||||
"links": [
|
||||
{
|
||||
"rel": "self",
|
||||
"href": "http://controller:9322/v1/scoring_engines/1ac42282-4e77-473e-898b-62ea007f1deb"
|
||||
},
|
||||
{
|
||||
"rel": "bookmark",
|
||||
"href": "http://controller:9322/scoring_engines/1ac42282-4e77-473e-898b-62ea007f1deb"
|
||||
}
|
||||
],
|
||||
"name": "dummy_max_scorer",
|
||||
"metainfo": ""
|
||||
}
|
||||
@@ -1,24 +0,0 @@
|
||||
{
|
||||
"services": [
|
||||
{
|
||||
"status": "ACTIVE",
|
||||
"name": "watcher-applier",
|
||||
"host": "controller",
|
||||
"links": [
|
||||
{
|
||||
"rel": "self",
|
||||
"href": "http://controller:9322/v1/services/1"
|
||||
},
|
||||
{
|
||||
"rel": "bookmark",
|
||||
"href": "http://controller:9322/services/1"
|
||||
}
|
||||
],
|
||||
"id": 1,
|
||||
"deleted_at": null,
|
||||
"updated_at": "2018-04-26T08:52:37.652895+00:00",
|
||||
"last_seen_up": "2018-04-26T08:52:37.648572",
|
||||
"created_at": "2018-03-26T11:55:24.075093+00:00"
|
||||
}
|
||||
]
|
||||
}
|
||||
@@ -1,36 +0,0 @@
|
||||
{
|
||||
"services": [
|
||||
{
|
||||
"id": 1,
|
||||
"status": "ACTIVE",
|
||||
"name": "watcher-applier",
|
||||
"host": "controller",
|
||||
"links": [
|
||||
{
|
||||
"rel": "self",
|
||||
"href": "http://controller:9322/v1/services/1"
|
||||
},
|
||||
{
|
||||
"rel": "bookmark",
|
||||
"href": "http://controller:9322/services/1"
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"id": 2,
|
||||
"status": "ACTIVE",
|
||||
"name": "watcher-decision-engine",
|
||||
"host": "controller",
|
||||
"links": [
|
||||
{
|
||||
"rel": "self",
|
||||
"href": "http://controller:9322/v1/services/2"
|
||||
},
|
||||
{
|
||||
"rel": "bookmark",
|
||||
"href": "http://controller:9322/services/2"
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
@@ -1,20 +0,0 @@
|
||||
{
|
||||
"status": "ACTIVE",
|
||||
"name": "watcher-applier",
|
||||
"host": "controller",
|
||||
"links": [
|
||||
{
|
||||
"rel": "self",
|
||||
"href": "http://controller:9322/v1/services/1"
|
||||
},
|
||||
{
|
||||
"rel": "bookmark",
|
||||
"href": "http://controller:9322/services/1"
|
||||
}
|
||||
],
|
||||
"id": 1,
|
||||
"deleted_at": null,
|
||||
"updated_at": "2018-04-26T09:45:37.653061+00:00",
|
||||
"last_seen_up": "2018-04-26T09:45:37.649314",
|
||||
"created_at": "2018-03-26T11:55:24.075093+00:00"
|
||||
}
|
||||
@@ -1,35 +0,0 @@
|
||||
{
|
||||
"strategies": [
|
||||
{
|
||||
"goal_uuid": "cb9afa5e-aec7-4a8c-9261-c15c33f2262b",
|
||||
"name": "vm_workload_consolidation",
|
||||
"links": [
|
||||
{
|
||||
"rel": "self",
|
||||
"href": "http://controller:9322/v1/strategies/6382b2d7-259e-487d-88db-78c852ffea54"
|
||||
},
|
||||
{
|
||||
"rel": "bookmark",
|
||||
"href": "http://controller:9322/strategies/6382b2d7-259e-487d-88db-78c852ffea54"
|
||||
}
|
||||
],
|
||||
"parameters_spec": {
|
||||
"properties": {
|
||||
"granularity": {
|
||||
"default": 300,
|
||||
"type": "number",
|
||||
"description": "The time between two measures in an aggregated timeseries of a metric."
|
||||
},
|
||||
"period": {
|
||||
"default": 3600,
|
||||
"type": "number",
|
||||
"description": "The time interval in seconds for getting statistic aggregation"
|
||||
}
|
||||
}
|
||||
},
|
||||
"uuid": "6382b2d7-259e-487d-88db-78c852ffea54",
|
||||
"goal_name": "server_consolidation",
|
||||
"display_name": "VM Workload Consolidation Strategy"
|
||||
}
|
||||
]
|
||||
}
|
||||
@@ -1,21 +0,0 @@
|
||||
{
|
||||
"strategies": [
|
||||
{
|
||||
"goal_uuid": "4690f8ba-18ff-45c1-99e9-159556d23810",
|
||||
"name": "dummy",
|
||||
"links": [
|
||||
{
|
||||
"rel": "self",
|
||||
"href": "http://controller:9322/v1/strategies/e311727b-b9b3-43ef-a5f7-8bd7ea80df25"
|
||||
},
|
||||
{
|
||||
"rel": "bookmark",
|
||||
"href": "http://controller:9322/strategies/e311727b-b9b3-43ef-a5f7-8bd7ea80df25"
|
||||
}
|
||||
],
|
||||
"uuid": "e311727b-b9b3-43ef-a5f7-8bd7ea80df25",
|
||||
"goal_name": "dummy",
|
||||
"display_name": "Dummy strategy"
|
||||
}
|
||||
]
|
||||
}
|
||||
@@ -1,33 +0,0 @@
|
||||
{
|
||||
"goal_uuid": "4690f8ba-18ff-45c1-99e9-159556d23810",
|
||||
"name": "dummy",
|
||||
"links": [
|
||||
{
|
||||
"rel": "self",
|
||||
"href": "http://controller:9322/v1/strategies/e311727b-b9b3-43ef-a5f7-8bd7ea80df25"
|
||||
},
|
||||
{
|
||||
"rel": "bookmark",
|
||||
"href": "http://controller:9322/strategies/e311727b-b9b3-43ef-a5f7-8bd7ea80df25"
|
||||
}
|
||||
],
|
||||
"parameters_spec": {
|
||||
"properties": {
|
||||
"para2": {
|
||||
"default": "hello",
|
||||
"type": "string",
|
||||
"description": "string parameter example"
|
||||
},
|
||||
"para1": {
|
||||
"maximum": 10.2,
|
||||
"type": "number",
|
||||
"minimum": 1.0,
|
||||
"description": "number parameter example",
|
||||
"default": 3.2
|
||||
}
|
||||
}
|
||||
},
|
||||
"uuid": "e311727b-b9b3-43ef-a5f7-8bd7ea80df25",
|
||||
"goal_name": "dummy",
|
||||
"display_name": "Dummy strategy"
|
||||
}
|
||||
@@ -1,49 +0,0 @@
|
||||
[
|
||||
{
|
||||
"state": "gnocchi: available",
|
||||
"comment": "",
|
||||
"mandatory": true,
|
||||
"type": "Datasource"
|
||||
},
|
||||
{
|
||||
"state": [
|
||||
{
|
||||
"compute.node.cpu.percent": "available"
|
||||
},
|
||||
{
|
||||
"cpu_util": "available"
|
||||
},
|
||||
{
|
||||
"memory.resident": "available"
|
||||
},
|
||||
{
|
||||
"hardware.memory.used": "available"
|
||||
}
|
||||
],
|
||||
"comment": "",
|
||||
"mandatory": false,
|
||||
"type": "Metrics"
|
||||
},
|
||||
{
|
||||
"state": [
|
||||
{
|
||||
"compute_model": "available"
|
||||
},
|
||||
{
|
||||
"storage_model": "not available"
|
||||
},
|
||||
{
|
||||
"baremetal_model": "not available"
|
||||
}
|
||||
],
|
||||
"comment": "",
|
||||
"mandatory": true,
|
||||
"type": "CDM"
|
||||
},
|
||||
{
|
||||
"state": "workload_stabilization",
|
||||
"mandatory": "",
|
||||
"comment": "",
|
||||
"type": "Name"
|
||||
}
|
||||
]
|
||||
@@ -1,254 +0,0 @@
|
||||
.. -*- rst -*-
|
||||
|
||||
============
|
||||
Action Plans
|
||||
============
|
||||
|
||||
An ``Action Plan`` specifies a flow of ``Actions`` that should be executed
|
||||
in order to satisfy a given ``Goal``. It also contains an estimated
|
||||
``global efficacy`` alongside a set of ``efficacy indicators``.
|
||||
|
||||
An ``Action Plan`` is generated by Watcher when an ``Audit`` is successful
|
||||
which implies that the ``Strategy`` which was used has found a ``Solution``
|
||||
to achieve the ``Goal`` of this ``Audit``.
|
||||
|
||||
In the default implementation of Watcher, an action plan is composed of
|
||||
a graph of linked ``Actions``. Each action may have parent actions, which
|
||||
should be executed prior to child action.
|
||||
|
||||
Start Action Plan
|
||||
=================
|
||||
|
||||
.. rest_method:: POST /v1/action_plans/{actionplan_ident}/start
|
||||
|
||||
Starts a created Action Plan resource.
|
||||
|
||||
Normal response codes: 200
|
||||
|
||||
Error codes: 400,404
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- actionplan_ident: actionplan_ident
|
||||
|
||||
Response
|
||||
--------
|
||||
|
||||
The list and example below are representative of the response as of API
|
||||
version 1:
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- uuid: uuid
|
||||
- state: actionplan_state
|
||||
- audit_uuid: actionplan_audit_uuid
|
||||
- strategy_uuid: strategy_uuid
|
||||
- strategy_name: strategy_name
|
||||
- efficacy_indicators: actionplan_efficacy_indicators
|
||||
- global_efficacy: actionplan_global_efficacy
|
||||
- links: links
|
||||
|
||||
**Example JSON representation of an Action Plan:**
|
||||
|
||||
.. literalinclude:: samples/actionplan-start-response.json
|
||||
:language: javascript
|
||||
|
||||
List Action Plan
|
||||
================
|
||||
|
||||
.. rest_method:: GET /v1/action_plans
|
||||
|
||||
Returns a list of Action Plan resources.
|
||||
|
||||
Normal response codes: 200
|
||||
|
||||
Error codes: 400,401
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- audit_uuid: r_audit
|
||||
- strategy: r_strategy
|
||||
- limit: limit
|
||||
- marker: marker
|
||||
- sort_dir: sort_dir
|
||||
- sort_key: sort_key
|
||||
|
||||
Response
|
||||
--------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- uuid: uuid
|
||||
- state: actionplan_state
|
||||
- audit_uuid: actionplan_audit_uuid
|
||||
- strategy_uuid: strategy_uuid
|
||||
- strategy_name: strategy_name
|
||||
- efficacy_indicators: actionplan_efficacy_indicators
|
||||
- global_efficacy: actionplan_global_efficacy
|
||||
- links: links
|
||||
|
||||
**Example JSON representation of an Action Plan:**
|
||||
|
||||
.. literalinclude:: samples/actionplan-list-response.json
|
||||
:language: javascript
|
||||
|
||||
List Action Plan detailed
|
||||
=========================
|
||||
|
||||
.. rest_method:: GET /v1/action_plans/detail
|
||||
|
||||
Returns a list of Action Plan resources with complete details.
|
||||
|
||||
Normal response codes: 200
|
||||
|
||||
Error codes: 400,401
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- audit_uuid: r_audit
|
||||
- strategy: r_strategy
|
||||
- limit: limit
|
||||
- marker: marker
|
||||
- sort_dir: sort_dir
|
||||
- sort_key: sort_key
|
||||
|
||||
Response
|
||||
--------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- deleted_at: deleted_at
|
||||
- updated_at: updated_at
|
||||
- created_at: created_at
|
||||
- uuid: uuid
|
||||
- state: actionplan_state
|
||||
- audit_uuid: actionplan_audit_uuid
|
||||
- strategy_uuid: strategy_uuid
|
||||
- strategy_name: strategy_name
|
||||
- efficacy_indicators: actionplan_efficacy_indicators
|
||||
- global_efficacy: actionplan_global_efficacy
|
||||
- links: links
|
||||
|
||||
**Example JSON representation of an Action Plan:**
|
||||
|
||||
.. literalinclude:: samples/actionplan-list-detailed-response.json
|
||||
:language: javascript
|
||||
|
||||
Show Action Plan
|
||||
================
|
||||
|
||||
.. rest_method:: GET /v1/action_plans/{actionplan_ident}
|
||||
|
||||
Shows details for an Action Plan.
|
||||
|
||||
Normal response codes: 200
|
||||
|
||||
Error codes: 404
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- actionplan_ident: actionplan_ident
|
||||
|
||||
Response
|
||||
--------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- uuid: uuid
|
||||
- state: actionplan_state
|
||||
- audit_uuid: actionplan_audit_uuid
|
||||
- strategy_uuid: strategy_uuid
|
||||
- strategy_name: strategy_name
|
||||
- efficacy_indicators: actionplan_efficacy_indicators
|
||||
- global_efficacy: actionplan_global_efficacy
|
||||
- links: links
|
||||
|
||||
**Example JSON representation of an Audit:**
|
||||
|
||||
.. literalinclude:: samples/actionplan-show-response.json
|
||||
:language: javascript
|
||||
|
||||
Cancel Action Plan
|
||||
==================
|
||||
|
||||
.. rest_method:: PATCH /v1/action_plans/{actionplan_ident}
|
||||
|
||||
Cancels a created Action Plan resource.
|
||||
|
||||
.. note:
|
||||
If Action Plan is in ONGOING state, then ``state`` attribute should be
|
||||
replaced with ``CANCELLING`` value. Otherwise, ``CANCELLED`` is to be
|
||||
used.
|
||||
|
||||
Normal response codes: 200
|
||||
|
||||
Error codes: 400,404
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- actionplan_ident: actionplan_ident
|
||||
|
||||
**Example Action Plan ONGOING cancelling request:**
|
||||
|
||||
.. literalinclude:: samples/actionplan-cancel-request-cancelling.json
|
||||
:language: javascript
|
||||
|
||||
**Example Action Plan PENDING cancelling request:**
|
||||
|
||||
.. literalinclude:: samples/actionplan-cancel-request-pending.json
|
||||
:language: javascript
|
||||
|
||||
Response
|
||||
--------
|
||||
|
||||
The list and example below are representative of the response as of API
|
||||
version 1:
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- uuid: uuid
|
||||
- state: actionplan_state
|
||||
- audit_uuid: actionplan_audit_uuid
|
||||
- strategy_uuid: strategy_uuid
|
||||
- strategy_name: strategy_name
|
||||
- efficacy_indicators: actionplan_efficacy_indicators
|
||||
- global_efficacy: actionplan_global_efficacy
|
||||
- links: links
|
||||
|
||||
**Example JSON representation of an Action Plan:**
|
||||
|
||||
.. literalinclude:: samples/actionplan-start-response.json
|
||||
:language: javascript
|
||||
|
||||
Delete Action Plan
|
||||
==================
|
||||
|
||||
.. rest_method:: DELETE /v1/action_plans/{actionplan_ident}
|
||||
|
||||
Deletes an Action Plan. Action Plan can be deleted only from SUCCEEDED, RECOMMENDED, FAILED, SUPERSEDED, CANCELLED states.
|
||||
|
||||
Normal response codes: 204
|
||||
|
||||
Error codes: 404
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- actionplan_ident: actionplan_ident
|
||||
@@ -1,155 +0,0 @@
|
||||
.. -*- rst -*-
|
||||
|
||||
=======
|
||||
Actions
|
||||
=======
|
||||
|
||||
An ``Action`` is what enables Watcher to transform the current state of a
|
||||
``Cluster`` after an ``Audit``.
|
||||
|
||||
An ``Action`` is an atomic task which changes the current state of a target
|
||||
Managed resource of the OpenStack ``Cluster`` such as:
|
||||
|
||||
- Live migration of an instance from one compute node to another compute
|
||||
node with Nova
|
||||
- Changing the power level of a compute node (ACPI level, ...)
|
||||
- Changing the current state of a compute node (enable or disable) with Nova
|
||||
|
||||
In most cases, an ``Action`` triggers some concrete commands on an existing
|
||||
OpenStack module (Nova, Neutron, Cinder, Ironic, etc.).
|
||||
|
||||
An ``Action`` has a life-cycle and its current state may be one of the
|
||||
following:
|
||||
|
||||
- **PENDING** : the ``Action`` has not been executed yet by the
|
||||
``Watcher Applier``.
|
||||
- **ONGOING** : the ``Action`` is currently being processed by the
|
||||
``Watcher Applier``.
|
||||
- **SUCCEEDED** : the ``Action`` has been executed successfully
|
||||
- **FAILED** : an error occurred while trying to execute the ``Action``.
|
||||
- **DELETED** : the ``Action`` is still stored in the ``Watcher database``
|
||||
but is not returned any more through the Watcher APIs.
|
||||
- **CANCELLED** : the ``Action`` was in **PENDING** or **ONGOING** state and
|
||||
was cancelled by the ``Administrator``
|
||||
|
||||
``Actions`` are created by ``Watcher Planner`` as result of Audit's execution.
|
||||
``Action`` can't be created, modified or deleted by user.
|
||||
|
||||
List Action
|
||||
===========
|
||||
|
||||
.. rest_method:: GET /v1/actions
|
||||
|
||||
Returns a list of Action resources.
|
||||
|
||||
Normal response codes: 200
|
||||
|
||||
Error codes: 400,401
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- action_plan_uuid: r_action_plan
|
||||
- audit_uuid: r_audit
|
||||
- limit: limit
|
||||
- marker: marker
|
||||
- sort_dir: sort_dir
|
||||
- sort_key: sort_key
|
||||
|
||||
Response
|
||||
--------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- uuid: uuid
|
||||
- action_type: action_type
|
||||
- state: action_state
|
||||
- action_plan_uuid: action_action_plan_uuid
|
||||
- parents: action_parents
|
||||
- links: links
|
||||
|
||||
**Example JSON representation of an Action:**
|
||||
|
||||
.. literalinclude:: samples/actions-list-response.json
|
||||
:language: javascript
|
||||
|
||||
List Action Detailed
|
||||
====================
|
||||
|
||||
.. rest_method:: GET /v1/actions/detail
|
||||
|
||||
Returns a list of Action resources with complete details.
|
||||
|
||||
Normal response codes: 200
|
||||
|
||||
Error codes: 400,401
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- action_plan_uuid: r_action_plan
|
||||
- audit_uuid: r_audit
|
||||
- limit: limit
|
||||
- marker: marker
|
||||
- sort_dir: sort_dir
|
||||
- sort_key: sort_key
|
||||
|
||||
Response
|
||||
--------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- uuid: uuid
|
||||
- action_type: action_type
|
||||
- state: action_state
|
||||
- action_plan_uuid: action_action_plan_uuid
|
||||
- parents: action_parents
|
||||
- description: action_description
|
||||
- input_parameters: action_input_parameters
|
||||
- links: links
|
||||
|
||||
**Example JSON representation of an Action:**
|
||||
|
||||
.. literalinclude:: samples/actions-list-detailed-response.json
|
||||
:language: javascript
|
||||
|
||||
Show Action
|
||||
===========
|
||||
|
||||
.. rest_method:: GET /v1/actions/{action_ident}
|
||||
|
||||
Shows details for an Action.
|
||||
|
||||
Normal response codes: 200
|
||||
|
||||
Error codes: 404
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- action_ident: action_ident
|
||||
|
||||
Response
|
||||
--------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- uuid: uuid
|
||||
- action_type: action_type
|
||||
- state: action_state
|
||||
- action_plan_uuid: action_action_plan_uuid
|
||||
- parents: action_parents
|
||||
- description: action_description
|
||||
- input_parameters: action_input_parameters
|
||||
- links: links
|
||||
|
||||
**Example JSON representation of an Action:**
|
||||
|
||||
.. literalinclude:: samples/actions-show-response.json
|
||||
:language: javascript
|
||||
@@ -1,349 +0,0 @@
|
||||
.. -*- rst -*-
|
||||
|
||||
======
|
||||
Audits
|
||||
======
|
||||
|
||||
There are creating, listing, updating and deleting methods of Watcher Audit
|
||||
resources which are implemented via the ``/v1/audits`` resource.
|
||||
|
||||
In the Watcher system, an ``Audit`` is a request for optimizing a ``Cluster``.
|
||||
|
||||
The optimization is done in order to satisfy one ``Goal`` on a given
|
||||
``Cluster``.
|
||||
|
||||
For each ``Audit``, the Watcher system generates an ``Action Plan``.
|
||||
|
||||
Create Audit
|
||||
============
|
||||
|
||||
.. rest_method:: POST /v1/audits
|
||||
|
||||
Creates a new Audit resource.
|
||||
|
||||
Mandatory attribute to be supplied: ``audit_type``.
|
||||
|
||||
``Audit`` can be created either based on existed ``Audit Template`` or by
|
||||
itself. In the first case, there also should be supplied
|
||||
``audit_template_uuid``. If ``Audit`` is created without ``Audit Template``,
|
||||
``goal`` should be provided.
|
||||
|
||||
.. warning::
|
||||
**Only ``audit_template_uuid`` can be used to create audit so far.**
|
||||
It should be fixed during the ``Rocky`` cycle.
|
||||
|
||||
Normal response codes: 201
|
||||
|
||||
Error codes: 400,404
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- audit_template_uuid: audittemplate_name
|
||||
- audit_type: audit_type
|
||||
- name: audit_name
|
||||
- goal: audit_goal
|
||||
- strategy: audit_strategy
|
||||
- parameters: audit_parameters
|
||||
- interval: audit_interval
|
||||
- scope: audittemplate_scope
|
||||
- auto_trigger: audit_autotrigger
|
||||
|
||||
**Example ONESHOT Audit creation request:**
|
||||
|
||||
.. literalinclude:: samples/audit-create-request-oneshot.json
|
||||
:language: javascript
|
||||
|
||||
**Example CONTINUOUS Audit creation request with a specified strategy:**
|
||||
|
||||
.. literalinclude:: samples/audit-create-request-continuous.json
|
||||
:language: javascript
|
||||
|
||||
Response
|
||||
--------
|
||||
|
||||
The list and example below are representative of the response as of API
|
||||
version 1:
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- uuid: uuid
|
||||
- name: audit_name
|
||||
- audit_type: audit_type
|
||||
- strategy_uuid: strategy_uuid
|
||||
- strategy_name: strategy_name
|
||||
- goal_uuid: goal_uuid
|
||||
- goal_name: goal_name
|
||||
- interval: audit_interval
|
||||
- next_run_time: audit_next_run_time
|
||||
- parameters: audit_parameters
|
||||
- auto_trigger: audit_autotrigger
|
||||
- state: audit_state
|
||||
- scope: audittemplate_scope
|
||||
- links: links
|
||||
|
||||
**Example JSON representation of an Audit:**
|
||||
|
||||
.. literalinclude:: samples/audit-create-response.json
|
||||
:language: javascript
|
||||
|
||||
List Audit
|
||||
==========
|
||||
|
||||
.. rest_method:: GET /v1/audits
|
||||
|
||||
Returns a list of Audit resources.
|
||||
|
||||
Normal response codes: 200
|
||||
|
||||
Error codes: 400,401
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- goal: r_goal
|
||||
- strategy: r_strategy
|
||||
- limit: limit
|
||||
- marker: marker
|
||||
- sort_dir: sort_dir
|
||||
- sort_key: sort_key
|
||||
|
||||
Response
|
||||
--------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- uuid: uuid
|
||||
- name: audit_name
|
||||
- audit_type: audit_type
|
||||
- strategy_uuid: strategy_uuid
|
||||
- strategy_name: strategy_name
|
||||
- goal_uuid: goal_uuid
|
||||
- goal_name: goal_name
|
||||
- interval: audit_interval
|
||||
- next_run_time: audit_next_run_time
|
||||
- auto_trigger: audit_autotrigger
|
||||
- state: audit_state
|
||||
- scope: audittemplate_scope
|
||||
- links: links
|
||||
|
||||
**Example JSON representation of an Audit:**
|
||||
|
||||
.. literalinclude:: samples/audit-list-response.json
|
||||
:language: javascript
|
||||
|
||||
List Audit Detailed
|
||||
===================
|
||||
|
||||
.. rest_method:: GET /v1/audits/detail
|
||||
|
||||
Returns a list of Audit resources with complete details.
|
||||
|
||||
Normal response codes: 200
|
||||
|
||||
Error codes: 400,401
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- goal: r_goal
|
||||
- strategy: r_strategy
|
||||
- limit: limit
|
||||
- marker: marker
|
||||
- sort_dir: sort_dir
|
||||
- sort_key: sort_key
|
||||
|
||||
Response
|
||||
--------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- uuid: uuid
|
||||
- name: audit_name
|
||||
- audit_type: audit_type
|
||||
- strategy_uuid: strategy_uuid
|
||||
- strategy_name: strategy_name
|
||||
- goal_uuid: goal_uuid
|
||||
- goal_name: goal_name
|
||||
- interval: audit_interval
|
||||
- next_run_time: audit_next_run_time
|
||||
- parameters: audit_parameters
|
||||
- auto_trigger: audit_autotrigger
|
||||
- state: audit_state
|
||||
- scope: audittemplate_scope
|
||||
- links: links
|
||||
|
||||
**Example JSON representation of an Audit:**
|
||||
|
||||
.. literalinclude:: samples/audit-list-detailed-response.json
|
||||
:language: javascript
|
||||
|
||||
Show Audit
|
||||
==========
|
||||
|
||||
.. rest_method:: GET /v1/audits/{audit_ident}
|
||||
|
||||
Shows details for an Audit.
|
||||
|
||||
Normal response codes: 200
|
||||
|
||||
Error codes: 404
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- audit_ident: audit_ident
|
||||
|
||||
Response
|
||||
--------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- uuid: uuid
|
||||
- name: audit_name
|
||||
- audit_type: audit_type
|
||||
- strategy_uuid: strategy_uuid
|
||||
- strategy_name: strategy_name
|
||||
- goal_uuid: goal_uuid
|
||||
- goal_name: goal_name
|
||||
- interval: audit_interval
|
||||
- next_run_time: audit_next_run_time
|
||||
- parameters: audit_parameters
|
||||
- auto_trigger: audit_autotrigger
|
||||
- state: audit_state
|
||||
- scope: audittemplate_scope
|
||||
- links: links
|
||||
|
||||
**Example JSON representation of an Audit:**
|
||||
|
||||
.. literalinclude:: samples/audit-show-response.json
|
||||
:language: javascript
|
||||
|
||||
Cancel Audit
|
||||
============
|
||||
|
||||
.. rest_method:: PATCH /v1/audits/{audit_ident}
|
||||
|
||||
Cancels an ONGOING Audit resource.
|
||||
|
||||
Normal response codes: 200
|
||||
|
||||
Error codes: 400,404
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- audit_ident: audit_ident
|
||||
|
||||
**Example Audit cancelling request:**
|
||||
|
||||
.. literalinclude:: samples/audit-cancel-request.json
|
||||
:language: javascript
|
||||
|
||||
Response
|
||||
--------
|
||||
|
||||
The list and example below are representative of the response as of API
|
||||
version 1:
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- uuid: uuid
|
||||
- name: audit_name
|
||||
- audit_type: audit_type
|
||||
- strategy_uuid: strategy_uuid
|
||||
- strategy_name: strategy_name
|
||||
- goal_uuid: goal_uuid
|
||||
- goal_name: goal_name
|
||||
- interval: audit_interval
|
||||
- next_run_time: audit_next_run_time
|
||||
- parameters: audit_parameters
|
||||
- auto_trigger: audit_autotrigger
|
||||
- state: audit_state
|
||||
- scope: audittemplate_scope
|
||||
- links: links
|
||||
|
||||
**Example JSON representation of an Audit:**
|
||||
|
||||
.. literalinclude:: samples/audit-cancel-response.json
|
||||
:language: javascript
|
||||
|
||||
Update Audit
|
||||
============
|
||||
|
||||
.. rest_method:: PATCH /v1/audits/{audit_ident}
|
||||
|
||||
Updates an Audit with the given information.
|
||||
|
||||
.. note:
|
||||
``audit_type`` shouldn't be changed by PATCH method.
|
||||
|
||||
Normal response codes: 200
|
||||
|
||||
Error codes: 400,404
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- audit_ident: audit_ident
|
||||
|
||||
**Example PATCH document updating Audit:**
|
||||
|
||||
.. literalinclude:: samples/audit-update-request.json
|
||||
:language: javascript
|
||||
|
||||
Response
|
||||
--------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- uuid: uuid
|
||||
- name: audit_name
|
||||
- audit_type: audit_type
|
||||
- strategy_uuid: strategy_uuid
|
||||
- strategy_name: strategy_name
|
||||
- goal_uuid: goal_uuid
|
||||
- goal_name: goal_name
|
||||
- interval: audit_interval
|
||||
- next_run_time: audit_next_run_time
|
||||
- parameters: audit_parameters
|
||||
- auto_trigger: audit_autotrigger
|
||||
- state: audit_state
|
||||
- scope: audittemplate_scope
|
||||
- links: links
|
||||
|
||||
**Example JSON representation of an Audit:**
|
||||
|
||||
.. literalinclude:: samples/audit-update-response.json
|
||||
:language: javascript
|
||||
|
||||
Delete Audit
|
||||
============
|
||||
|
||||
.. rest_method:: DELETE /v1/audits/{audit_ident}
|
||||
|
||||
Deletes an Audit. Audit can be deleted only from FAILED, SUCCEEDED, CANCELLED,
|
||||
SUSPENDED states.
|
||||
|
||||
Normal response codes: 204
|
||||
|
||||
Error codes: 404
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- audit_ident: audit_ident
|
||||
@@ -1,257 +0,0 @@
|
||||
.. -*- rst -*-
|
||||
|
||||
===============
|
||||
Audit Templates
|
||||
===============
|
||||
|
||||
There are creating, listing, updating and deleting methods of Watcher Audit
|
||||
Template resources which are implemented via the ``/v1/audit_templates``
|
||||
resource.
|
||||
|
||||
An Audit may be launched several times with the same settings
|
||||
(Goal, thresholds, ...). Therefore it makes sense to save those settings in
|
||||
some sort of Audit preset object, which is known as an Audit Template.
|
||||
|
||||
An Audit Template contains at least the Goal of the Audit.
|
||||
|
||||
Create Audit Template
|
||||
=====================
|
||||
|
||||
.. rest_method:: POST /v1/audit_templates
|
||||
|
||||
Creates a new Audit Template resource.
|
||||
|
||||
It requires ``name`` and ``goal`` attributes to be supplied in the request
|
||||
body.
|
||||
|
||||
Normal response codes: 201
|
||||
|
||||
Error codes: 400,404,409
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- name: audittemplate_name
|
||||
- goal: audittemplate_goal
|
||||
- strategy: audittemplate_strategy
|
||||
- description: audittemplate_description
|
||||
- scope: audittemplate_scope
|
||||
|
||||
**Example Audit Template creation request without a specified strategy:**
|
||||
|
||||
.. literalinclude:: samples/audittemplate-create-request-minimal.json
|
||||
:language: javascript
|
||||
|
||||
**Example Audit Template creation request with a specified strategy:**
|
||||
|
||||
.. literalinclude:: samples/audittemplate-create-request-full.json
|
||||
:language: javascript
|
||||
|
||||
Response
|
||||
--------
|
||||
|
||||
The list and example below are representative of the response as of API
|
||||
version 1:
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- uuid: uuid
|
||||
- name: audittemplate_name
|
||||
- description: audittemplate_description
|
||||
- strategy_uuid: strategy_uuid
|
||||
- strategy_name: strategy_name
|
||||
- goal_uuid: goal_uuid
|
||||
- goal_name: goal_name
|
||||
- scope: audittemplate_scope
|
||||
- links: links
|
||||
|
||||
**Example JSON representation of an Audit Template:**
|
||||
|
||||
.. literalinclude:: samples/audittemplate-create-response.json
|
||||
:language: javascript
|
||||
|
||||
List Audit Template
|
||||
===================
|
||||
|
||||
.. rest_method:: GET /v1/audit_templates
|
||||
|
||||
Returns a list of Audit Template resources.
|
||||
|
||||
Normal response codes: 200
|
||||
|
||||
Error codes: 400,401
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- goal: r_goal
|
||||
- strategy: r_strategy
|
||||
- limit: limit
|
||||
- marker: marker
|
||||
- sort_dir: sort_dir
|
||||
- sort_key: sort_key
|
||||
|
||||
Response
|
||||
--------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- uuid: uuid
|
||||
- name: audittemplate_name
|
||||
- strategy_uuid: strategy_uuid
|
||||
- strategy_name: strategy_name
|
||||
- goal_uuid: goal_uuid
|
||||
- goal_name: goal_name
|
||||
- scope: audittemplate_scope
|
||||
- links: links
|
||||
|
||||
**Example JSON representation of an Audit Template:**
|
||||
|
||||
.. literalinclude:: samples/audittemplate-list-response.json
|
||||
:language: javascript
|
||||
|
||||
List Audit Template Detailed
|
||||
============================
|
||||
|
||||
.. rest_method:: GET /v1/audit_templates/detail
|
||||
|
||||
Returns a list of Audit Template resources with complete details.
|
||||
|
||||
Normal response codes: 200
|
||||
|
||||
Error codes: 400,401
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- goal: r_goal
|
||||
- strategy: r_strategy
|
||||
- limit: limit
|
||||
- marker: marker
|
||||
- sort_dir: sort_dir
|
||||
- sort_key: sort_key
|
||||
|
||||
Response
|
||||
--------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- uuid: uuid
|
||||
- name: audittemplate_name
|
||||
- strategy_uuid: strategy_uuid
|
||||
- strategy_name: strategy_name
|
||||
- goal_uuid: goal_uuid
|
||||
- goal_name: goal_name
|
||||
- scope: audittemplate_scope
|
||||
- links: links
|
||||
- description: audittemplate_description
|
||||
|
||||
**Example JSON representation of an Audit Template:**
|
||||
|
||||
.. literalinclude:: samples/audittemplate-list-detailed-response.json
|
||||
:language: javascript
|
||||
|
||||
Show Audit Template
|
||||
===================
|
||||
|
||||
.. rest_method:: GET /v1/audit_templates/{audittemplate_ident}
|
||||
|
||||
Shows details for an Audit Template.
|
||||
|
||||
Normal response codes: 200
|
||||
|
||||
Error codes: 404
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- audittemplate_ident: audittemplate_ident
|
||||
|
||||
Response
|
||||
--------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- uuid: uuid
|
||||
- name: audittemplate_name
|
||||
- strategy_uuid: strategy_uuid
|
||||
- strategy_name: strategy_name
|
||||
- goal_uuid: goal_uuid
|
||||
- goal_name: goal_name
|
||||
- scope: audittemplate_scope
|
||||
- links: links
|
||||
- description: audittemplate_description
|
||||
|
||||
**Example JSON representation of an Audit Template:**
|
||||
|
||||
.. literalinclude:: samples/audittemplate-show-response.json
|
||||
:language: javascript
|
||||
|
||||
Update Audit Template
|
||||
=====================
|
||||
|
||||
.. rest_method:: PATCH /v1/audit_templates/{audittemplate_ident}
|
||||
|
||||
Updates an Audit Template with the given information.
|
||||
|
||||
Normal response codes: 200
|
||||
|
||||
Error codes: 400,404
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- audittemplate_ident: audittemplate_ident
|
||||
|
||||
**Example PATCH document updating Audit Template:**
|
||||
|
||||
.. literalinclude:: samples/audittemplate-update-request.json
|
||||
:language: javascript
|
||||
|
||||
Response
|
||||
--------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- uuid: uuid
|
||||
- name: audittemplate_name
|
||||
- strategy_uuid: strategy_uuid
|
||||
- strategy_name: strategy_name
|
||||
- goal_uuid: goal_uuid
|
||||
- goal_name: goal_name
|
||||
- scope: audittemplate_scope
|
||||
- links: links
|
||||
- description: audittemplate_description
|
||||
|
||||
**Example JSON representation of an Audit Template:**
|
||||
|
||||
.. literalinclude:: samples/audittemplate-update-response.json
|
||||
:language: javascript
|
||||
|
||||
Delete Audit Template
|
||||
=====================
|
||||
|
||||
.. rest_method:: DELETE /v1/audit_templates/{audittemplate_ident}
|
||||
|
||||
Deletes an Audit Template.
|
||||
|
||||
Normal response codes: 204
|
||||
|
||||
Error codes: 404
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- audittemplate_ident: audittemplate_ident
|
||||
@@ -1,126 +0,0 @@
|
||||
.. -*- rst -*-
|
||||
|
||||
=====
|
||||
Goals
|
||||
=====
|
||||
|
||||
A ``Goal`` is a human readable, observable and measurable end result having
|
||||
one objective to be achieved.
|
||||
|
||||
Here are some examples of ``Goals``:
|
||||
|
||||
- minimize the energy consumption
|
||||
- minimize the number of compute nodes (consolidation)
|
||||
- balance the workload among compute nodes
|
||||
- minimize the license cost (some softwares have a licensing model which is
|
||||
based on the number of sockets or cores where the software is deployed)
|
||||
- find the most appropriate moment for a planned maintenance on a
|
||||
given group of host (which may be an entire availability zone):
|
||||
power supply replacement, cooling system replacement, hardware
|
||||
modification, ...
|
||||
|
||||
List Goal
|
||||
=========
|
||||
|
||||
.. rest_method:: GET /v1/goals
|
||||
|
||||
Returns a list of Goal resources.
|
||||
|
||||
Normal response codes: 200
|
||||
|
||||
Error codes: 400,401
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- limit: limit
|
||||
- sort_dir: sort_dir
|
||||
- sort_key: sort_key
|
||||
|
||||
Response
|
||||
--------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- uuid: uuid
|
||||
- efficacy_specification: goal_efficacy_specification
|
||||
- name: goal_name
|
||||
- display_name: goal_display_name
|
||||
- links: links
|
||||
|
||||
**Example JSON representation of a Goal:**
|
||||
|
||||
.. literalinclude:: samples/goal-list-response.json
|
||||
:language: javascript
|
||||
|
||||
List Goal Detailed
|
||||
==================
|
||||
|
||||
.. rest_method:: GET /v1/goals/detail
|
||||
|
||||
Returns a list of Goal resources with complete details.
|
||||
|
||||
Normal response codes: 200
|
||||
|
||||
Error codes: 400,401
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- limit: limit
|
||||
- sort_dir: sort_dir
|
||||
- sort_key: sort_key
|
||||
|
||||
Response
|
||||
--------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- uuid: uuid
|
||||
- efficacy_specification: goal_efficacy_specification
|
||||
- name: goal_name
|
||||
- display_name: goal_display_name
|
||||
- links: links
|
||||
|
||||
**Example JSON representation of a Goal:**
|
||||
|
||||
.. literalinclude:: samples/goal-list-response.json
|
||||
:language: javascript
|
||||
|
||||
Show Goal
|
||||
=========
|
||||
|
||||
.. rest_method:: GET /v1/goals/{goal_ident}
|
||||
|
||||
Shows details for an Goal.
|
||||
|
||||
Normal response codes: 200
|
||||
|
||||
Error codes: 404
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- goal_ident: goal_ident
|
||||
|
||||
Response
|
||||
--------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- uuid: uuid
|
||||
- efficacy_specification: goal_efficacy_specification
|
||||
- name: goal_name
|
||||
- display_name: goal_display_name
|
||||
- links: links
|
||||
|
||||
**Example JSON representation of a Goal:**
|
||||
|
||||
.. literalinclude:: samples/goal-show-response.json
|
||||
:language: javascript
|
||||
@@ -1,120 +0,0 @@
|
||||
.. -*- rst -*-
|
||||
|
||||
===============
|
||||
Scoring Engines
|
||||
===============
|
||||
|
||||
A ``Scoring Engine`` is an executable that has a well-defined input, a
|
||||
well-defined output, and performs a purely mathematical task. That is,
|
||||
the calculation does not depend on the environment in which it is running - it
|
||||
would produce the same result anywhere.
|
||||
|
||||
Because there might be multiple algorithms used to build a particular data
|
||||
model (and therefore a scoring engine), the usage of scoring engine might
|
||||
vary. A metainfo field is supposed to contain any information which might
|
||||
be needed by the user of a given scoring engine.
|
||||
|
||||
List Scoring Engine
|
||||
===================
|
||||
|
||||
.. rest_method:: GET /v1/scoring_engines
|
||||
|
||||
Returns a list of Scoring Engine resources.
|
||||
|
||||
Normal response codes: 200
|
||||
|
||||
Error codes: 400,401
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- limit: limit
|
||||
- sort_dir: sort_dir
|
||||
- sort_key: sort_key
|
||||
|
||||
Response
|
||||
--------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- uuid: uuid
|
||||
- name: scoring_engine_name
|
||||
- description: scoring_engine_description
|
||||
- links: links
|
||||
|
||||
**Example JSON representation of a Scoring Engine:**
|
||||
|
||||
.. literalinclude:: samples/scoring_engine-list-response.json
|
||||
:language: javascript
|
||||
|
||||
List Scoring Engine Detailed
|
||||
============================
|
||||
|
||||
.. rest_method:: GET /v1/scoring_engines/detail
|
||||
|
||||
Returns a list of Scoring Engine resources with complete details.
|
||||
|
||||
Normal response codes: 200
|
||||
|
||||
Error codes: 400,401
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- limit: limit
|
||||
- sort_dir: sort_dir
|
||||
- sort_key: sort_key
|
||||
|
||||
Response
|
||||
--------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- uuid: uuid
|
||||
- name: scoring_engine_name
|
||||
- description: scoring_engine_description
|
||||
- metainfo: scoring_engine_metainfo
|
||||
- links: links
|
||||
|
||||
**Example JSON representation of a Scoring Engine:**
|
||||
|
||||
.. literalinclude:: samples/scoring_engine-list-detailed-response.json
|
||||
:language: javascript
|
||||
|
||||
Show Scoring Engine
|
||||
===================
|
||||
|
||||
.. rest_method:: GET /v1/scoring_engines/{scoring_engine_ident}
|
||||
|
||||
Shows details for a Scoring Engine resource.
|
||||
|
||||
Normal response codes: 200
|
||||
|
||||
Error codes: 404
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- scoring_engine_ident: scoring_engine_ident
|
||||
|
||||
Response
|
||||
--------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- uuid: uuid
|
||||
- name: scoring_engine_name
|
||||
- description: scoring_engine_description
|
||||
- metainfo: scoring_engine_metainfo
|
||||
- links: links
|
||||
|
||||
**Example JSON representation of a Scoring Engine:**
|
||||
|
||||
.. literalinclude:: samples/scoring_engine-show-response.json
|
||||
:language: javascript
|
||||
@@ -1,116 +0,0 @@
|
||||
.. -*- rst -*-
|
||||
|
||||
========
|
||||
Services
|
||||
========
|
||||
|
||||
This resource represents Watcher services, their states and hosts they are
|
||||
placed on.
|
||||
|
||||
List Service
|
||||
============
|
||||
|
||||
.. rest_method:: GET /v1/services
|
||||
|
||||
Returns a list of Service resources.
|
||||
|
||||
Normal response codes: 200
|
||||
|
||||
Error codes: 400,401
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- limit: limit
|
||||
- sort_dir: sort_dir
|
||||
- sort_key: sort_key
|
||||
|
||||
Response
|
||||
--------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- id: service_id
|
||||
- name: service_name
|
||||
- host: service_host
|
||||
- status: service_status
|
||||
- links: links
|
||||
|
||||
**Example JSON representation of a Service:**
|
||||
|
||||
.. literalinclude:: samples/service-list-response.json
|
||||
:language: javascript
|
||||
|
||||
List Service Detailed
|
||||
=====================
|
||||
|
||||
.. rest_method:: GET /v1/services/detail
|
||||
|
||||
Returns a list of Service resources with complete details.
|
||||
|
||||
Normal response codes: 200
|
||||
|
||||
Error codes: 400,401
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- limit: limit
|
||||
- sort_dir: sort_dir
|
||||
- sort_key: sort_key
|
||||
|
||||
Response
|
||||
--------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- id: service_id
|
||||
- name: service_name
|
||||
- host: service_host
|
||||
- status: service_status
|
||||
- last_seen_up: service_last_seen_up
|
||||
- links: links
|
||||
|
||||
**Example JSON representation of a Service:**
|
||||
|
||||
.. literalinclude:: samples/service-list-detailed-response.json
|
||||
:language: javascript
|
||||
|
||||
Show Service
|
||||
============
|
||||
|
||||
.. rest_method:: GET /v1/services/{service_ident}
|
||||
|
||||
Shows details for a Service resource.
|
||||
|
||||
Normal response codes: 200
|
||||
|
||||
Error codes: 404
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- service_ident: service_ident
|
||||
|
||||
Response
|
||||
--------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- id: service_id
|
||||
- name: service_name
|
||||
- host: service_host
|
||||
- status: service_status
|
||||
- last_seen_up: service_last_seen_up
|
||||
- links: links
|
||||
|
||||
**Example JSON representation of a Service:**
|
||||
|
||||
.. literalinclude:: samples/service-show-response.json
|
||||
:language: javascript
|
||||
@@ -1,164 +0,0 @@
|
||||
.. -*- rst -*-
|
||||
|
||||
==========
|
||||
Strategies
|
||||
==========
|
||||
|
||||
A ``Strategy`` is an algorithm implementation which is able to find a
|
||||
``Solution`` for a given ``Goal``. To get more information about strategies
|
||||
that are shipped along with Watcher, visit `strategies page`_.
|
||||
|
||||
There may be several potential strategies which are able to achieve the same
|
||||
``Goal``. This is why it is possible to configure which specific ``Strategy``
|
||||
should be used for each goal.
|
||||
|
||||
Some strategies may provide better optimization results but may take more time
|
||||
to find an optimal ``Solution``.
|
||||
|
||||
.. _`strategies page`: https://docs.openstack.org/watcher/latest/strategies/index.html
|
||||
|
||||
List Strategy
|
||||
=============
|
||||
|
||||
.. rest_method:: GET /v1/strategies
|
||||
|
||||
Returns a list of Strategy resources.
|
||||
|
||||
Normal response codes: 200
|
||||
|
||||
Error codes: 400,401
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- goal: r_goal
|
||||
- limit: limit
|
||||
- sort_dir: sort_dir
|
||||
- sort_key: sort_key
|
||||
|
||||
Response
|
||||
--------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- uuid: uuid
|
||||
- name: strategy_name
|
||||
- display_name: strategy_display_name
|
||||
- goal_name: goal_name
|
||||
- goal_uuid: goal_uuid
|
||||
- links: links
|
||||
|
||||
**Example JSON representation of a Strategy:**
|
||||
|
||||
.. literalinclude:: samples/strategy-list-response.json
|
||||
:language: javascript
|
||||
|
||||
List Strategy Detailed
|
||||
======================
|
||||
|
||||
.. rest_method:: GET /v1/strategies/detail
|
||||
|
||||
Returns a list of Strategy resources with complete details.
|
||||
|
||||
Normal response codes: 200
|
||||
|
||||
Error codes: 400,401
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- goal: r_goal
|
||||
- limit: limit
|
||||
- sort_dir: sort_dir
|
||||
- sort_key: sort_key
|
||||
|
||||
Response
|
||||
--------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- uuid: uuid
|
||||
- name: strategy_name
|
||||
- display_name: strategy_display_name
|
||||
- parameters_spec: strategy_parameters_spec
|
||||
- goal_name: goal_name
|
||||
- goal_uuid: goal_uuid
|
||||
- links: links
|
||||
|
||||
**Example JSON representation of a Strategy:**
|
||||
|
||||
.. literalinclude:: samples/strategy-list-detailed-response.json
|
||||
:language: javascript
|
||||
|
||||
Show Strategy
|
||||
=============
|
||||
|
||||
.. rest_method:: GET /v1/strategies/{strategy_ident}
|
||||
|
||||
Shows details for a Strategy resource.
|
||||
|
||||
Normal response codes: 200
|
||||
|
||||
Error codes: 404
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- strategy_ident: strategy_ident
|
||||
|
||||
Response
|
||||
--------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- uuid: uuid
|
||||
- name: strategy_name
|
||||
- display_name: strategy_display_name
|
||||
- parameters_spec: strategy_parameters_spec
|
||||
- goal_name: goal_name
|
||||
- goal_uuid: goal_uuid
|
||||
- links: links
|
||||
|
||||
**Example JSON representation of a Strategy:**
|
||||
|
||||
.. literalinclude:: samples/strategy-show-response.json
|
||||
:language: javascript
|
||||
|
||||
Show Strategy State
|
||||
===================
|
||||
|
||||
.. rest_method:: GET /v1/strategies/{strategy_ident}/state
|
||||
|
||||
Retrieve an information about strategy requirements.
|
||||
|
||||
Normal response codes: 200
|
||||
|
||||
Error codes: 404
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- strategy_ident: strategy_ident
|
||||
|
||||
Response
|
||||
--------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- state: strategy_check_state
|
||||
- comment: strategy_check_comment
|
||||
- mandatory: strategy_check_mandatory
|
||||
- type: strategy_check_type
|
||||
|
||||
**Example JSON representation of a Strategy:**
|
||||
|
||||
.. literalinclude:: samples/strategy-state-response.json
|
||||
:language: javascript
|
||||
@@ -42,7 +42,7 @@ WATCHER_AUTH_CACHE_DIR=${WATCHER_AUTH_CACHE_DIR:-/var/cache/watcher}
|
||||
|
||||
WATCHER_CONF_DIR=/etc/watcher
|
||||
WATCHER_CONF=$WATCHER_CONF_DIR/watcher.conf
|
||||
WATCHER_POLICY_YAML=$WATCHER_CONF_DIR/policy.yaml.sample
|
||||
WATCHER_POLICY_JSON=$WATCHER_CONF_DIR/policy.json
|
||||
|
||||
WATCHER_DEVSTACK_DIR=$WATCHER_DIR/devstack
|
||||
WATCHER_DEVSTACK_FILES_DIR=$WATCHER_DEVSTACK_DIR/files
|
||||
@@ -106,25 +106,7 @@ function configure_watcher {
|
||||
# Put config files in ``/etc/watcher`` for everyone to find
|
||||
sudo install -d -o $STACK_USER $WATCHER_CONF_DIR
|
||||
|
||||
local project=watcher
|
||||
local project_uc
|
||||
project_uc=$(echo watcher|tr a-z A-Z)
|
||||
local conf_dir="${project_uc}_CONF_DIR"
|
||||
# eval conf dir to get the variable
|
||||
conf_dir="${!conf_dir}"
|
||||
local project_dir="${project_uc}_DIR"
|
||||
# eval project dir to get the variable
|
||||
project_dir="${!project_dir}"
|
||||
local sample_conf_dir="${project_dir}/etc/${project}"
|
||||
local sample_policy_dir="${project_dir}/etc/${project}/policy.d"
|
||||
local sample_policy_generator="${project_dir}/etc/${project}/oslo-policy-generator/watcher-policy-generator.conf"
|
||||
|
||||
# first generate policy.yaml
|
||||
oslopolicy-sample-generator --config-file $sample_policy_generator
|
||||
# then optionally copy over policy.d
|
||||
if [[ -d $sample_policy_dir ]]; then
|
||||
cp -r $sample_policy_dir $conf_dir/policy.d
|
||||
fi
|
||||
install_default_policy watcher
|
||||
|
||||
# Rebuild the config file from scratch
|
||||
create_watcher_conf
|
||||
@@ -177,19 +159,15 @@ function create_watcher_conf {
|
||||
iniset $WATCHER_CONF DEFAULT debug "$ENABLE_DEBUG_LOG_LEVEL"
|
||||
iniset $WATCHER_CONF DEFAULT control_exchange watcher
|
||||
|
||||
iniset_rpc_backend watcher $WATCHER_CONF
|
||||
|
||||
iniset $WATCHER_CONF database connection $(database_connection_url watcher)
|
||||
iniset $WATCHER_CONF api host "$WATCHER_SERVICE_HOST"
|
||||
iniset $WATCHER_CONF api port "$WATCHER_SERVICE_PORT"
|
||||
|
||||
if is_service_enabled tls-proxy; then
|
||||
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"
|
||||
fi
|
||||
iniset $WATCHER_CONF oslo_policy policy_file $WATCHER_POLICY_JSON
|
||||
|
||||
iniset $WATCHER_CONF oslo_policy policy_file $WATCHER_POLICY_YAML
|
||||
iniset $WATCHER_CONF oslo_messaging_rabbit rabbit_userid $RABBIT_USERID
|
||||
iniset $WATCHER_CONF oslo_messaging_rabbit rabbit_password $RABBIT_PASSWORD
|
||||
iniset $WATCHER_CONF oslo_messaging_rabbit rabbit_host $RABBIT_HOST
|
||||
|
||||
iniset $WATCHER_CONF oslo_messaging_notifications driver "messagingv2"
|
||||
|
||||
@@ -301,7 +279,8 @@ function start_watcher_api {
|
||||
|
||||
# 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_tls_proxy '*' $WATCHER_SERVICE_PORT $WATCHER_SERVICE_HOST $WATCHER_SERVICE_PORT_INT &
|
||||
start_tls_proxy '*' $EC2_SERVICE_PORT $WATCHER_SERVICE_HOST $WATCHER_SERVICE_PORT_INT &
|
||||
fi
|
||||
}
|
||||
|
||||
|
||||
@@ -35,7 +35,7 @@ VNCSERVER_PROXYCLIENT_ADDRESS=$HOST_IP
|
||||
NOVA_INSTANCES_PATH=/opt/stack/data/instances
|
||||
|
||||
# Enable the Ceilometer plugin for the compute agent
|
||||
enable_plugin ceilometer git://git.openstack.org/openstack/ceilometer
|
||||
enable_plugin ceilometer https://git.openstack.org/openstack/ceilometer
|
||||
disable_service ceilometer-acentral,ceilometer-collector,ceilometer-api
|
||||
|
||||
LOGFILE=$DEST/logs/stack.sh.log
|
||||
|
||||
@@ -24,18 +24,24 @@ MULTI_HOST=1
|
||||
# This is the controller node, so disable nova-compute
|
||||
disable_service n-cpu
|
||||
|
||||
# Disable nova-network and use neutron instead
|
||||
disable_service n-net
|
||||
ENABLED_SERVICES+=,q-svc,q-dhcp,q-meta,q-agt,q-l3,neutron
|
||||
|
||||
# Enable remote console access
|
||||
enable_service n-cauth
|
||||
|
||||
# Enable the Watcher Dashboard plugin
|
||||
enable_plugin watcher-dashboard git://git.openstack.org/openstack/watcher-dashboard
|
||||
enable_plugin watcher-dashboard https://git.openstack.org/openstack/watcher-dashboard
|
||||
|
||||
# Enable the Watcher plugin
|
||||
enable_plugin watcher git://git.openstack.org/openstack/watcher
|
||||
enable_plugin watcher https://git.openstack.org/openstack/watcher
|
||||
|
||||
# Enable the Ceilometer plugin
|
||||
enable_plugin ceilometer git://git.openstack.org/openstack/ceilometer
|
||||
enable_plugin ceilometer https://git.openstack.org/openstack/ceilometer
|
||||
|
||||
# This is the controller node, so disable the ceilometer compute agent
|
||||
disable_service ceilometer-acompute
|
||||
|
||||
# Enable the ceilometer api explicitly(bug:1667678)
|
||||
enable_service ceilometer-api
|
||||
|
||||
|
||||
@@ -7,7 +7,7 @@ _XTRACE_WATCHER_PLUGIN=$(set +o | grep xtrace)
|
||||
set -o xtrace
|
||||
|
||||
echo_summary "watcher's plugin.sh was called..."
|
||||
. $DEST/watcher/devstack/lib/watcher
|
||||
source $DEST/watcher/devstack/lib/watcher
|
||||
|
||||
# Show all of defined environment variables
|
||||
(set -o posix; set)
|
||||
|
||||
@@ -3,9 +3,6 @@
|
||||
# Make sure rabbit is enabled
|
||||
enable_service rabbit
|
||||
|
||||
# Make sure mysql is enabled
|
||||
enable_service mysql
|
||||
|
||||
# Enable Watcher services
|
||||
enable_service watcher-api
|
||||
enable_service watcher-decision-engine
|
||||
|
||||
@@ -22,7 +22,7 @@ from docutils import nodes
|
||||
from docutils.parsers import rst
|
||||
from docutils import statemachine
|
||||
|
||||
from watcher.version import version_string
|
||||
from watcher.version import version_info
|
||||
|
||||
|
||||
class BaseWatcherDirective(rst.Directive):
|
||||
@@ -169,4 +169,4 @@ class WatcherFunc(BaseWatcherDirective):
|
||||
def setup(app):
|
||||
app.add_directive('watcher-term', WatcherTerm)
|
||||
app.add_directive('watcher-func', WatcherFunc)
|
||||
return {'version': version_string}
|
||||
return {'version': version_info.version_string()}
|
||||
|
||||
@@ -20,7 +20,7 @@ It is used via a single directive in the .rst file
|
||||
|
||||
"""
|
||||
|
||||
from docutils.parsers.rst import Directive
|
||||
from sphinx.util.compat import Directive
|
||||
from docutils import nodes
|
||||
|
||||
from watcher.notifications import base as notification
|
||||
|
||||
@@ -1,41 +0,0 @@
|
||||
{
|
||||
"priority": "INFO",
|
||||
"payload": {
|
||||
"watcher_object.namespace": "watcher",
|
||||
"watcher_object.version": "1.0",
|
||||
"watcher_object.name": "ActionCancelPayload",
|
||||
"watcher_object.data": {
|
||||
"uuid": "10a47dd1-4874-4298-91cf-eff046dbdb8d",
|
||||
"input_parameters": {
|
||||
"param2": 2,
|
||||
"param1": 1
|
||||
},
|
||||
"fault": null,
|
||||
"created_at": "2016-10-18T09:52:05Z",
|
||||
"updated_at": null,
|
||||
"state": "CANCELLED",
|
||||
"action_plan": {
|
||||
"watcher_object.namespace": "watcher",
|
||||
"watcher_object.version": "1.0",
|
||||
"watcher_object.name": "TerseActionPlanPayload",
|
||||
"watcher_object.data": {
|
||||
"uuid": "76be87bd-3422-43f9-93a0-e85a577e3061",
|
||||
"global_efficacy": [],
|
||||
"created_at": "2016-10-18T09:52:05Z",
|
||||
"updated_at": null,
|
||||
"state": "CANCELLING",
|
||||
"audit_uuid": "10a47dd1-4874-4298-91cf-eff046dbdb8d",
|
||||
"strategy_uuid": "cb3d0b58-4415-4d90-b75b-1e96878730e3",
|
||||
"deleted_at": null
|
||||
}
|
||||
},
|
||||
"parents": [],
|
||||
"action_type": "nop",
|
||||
"deleted_at": null
|
||||
}
|
||||
},
|
||||
"event_type": "action.cancel.end",
|
||||
"publisher_id": "infra-optim:node0",
|
||||
"timestamp": "2017-01-01 00:00:00.000000",
|
||||
"message_id": "530b409c-9b6b-459b-8f08-f93dbfeb4d41"
|
||||
}
|
||||
@@ -1,51 +0,0 @@
|
||||
{
|
||||
"priority": "ERROR",
|
||||
"payload": {
|
||||
"watcher_object.namespace": "watcher",
|
||||
"watcher_object.version": "1.0",
|
||||
"watcher_object.name": "ActionCancelPayload",
|
||||
"watcher_object.data": {
|
||||
"uuid": "10a47dd1-4874-4298-91cf-eff046dbdb8d",
|
||||
"input_parameters": {
|
||||
"param2": 2,
|
||||
"param1": 1
|
||||
},
|
||||
"fault": {
|
||||
"watcher_object.namespace": "watcher",
|
||||
"watcher_object.version": "1.0",
|
||||
"watcher_object.name": "ExceptionPayload",
|
||||
"watcher_object.data": {
|
||||
"module_name": "watcher.tests.notifications.test_action_notification",
|
||||
"exception": "WatcherException",
|
||||
"exception_message": "TEST",
|
||||
"function_name": "test_send_action_cancel_with_error"
|
||||
}
|
||||
},
|
||||
"created_at": "2016-10-18T09:52:05Z",
|
||||
"updated_at": null,
|
||||
"state": "FAILED",
|
||||
"action_plan": {
|
||||
"watcher_object.namespace": "watcher",
|
||||
"watcher_object.version": "1.0",
|
||||
"watcher_object.name": "TerseActionPlanPayload",
|
||||
"watcher_object.data": {
|
||||
"uuid": "76be87bd-3422-43f9-93a0-e85a577e3061",
|
||||
"global_efficacy": [],
|
||||
"created_at": "2016-10-18T09:52:05Z",
|
||||
"updated_at": null,
|
||||
"state": "CANCELLING",
|
||||
"audit_uuid": "10a47dd1-4874-4298-91cf-eff046dbdb8d",
|
||||
"strategy_uuid": "cb3d0b58-4415-4d90-b75b-1e96878730e3",
|
||||
"deleted_at": null
|
||||
}
|
||||
},
|
||||
"parents": [],
|
||||
"action_type": "nop",
|
||||
"deleted_at": null
|
||||
}
|
||||
},
|
||||
"event_type": "action.cancel.error",
|
||||
"publisher_id": "infra-optim:node0",
|
||||
"timestamp": "2017-01-01 00:00:00.000000",
|
||||
"message_id": "530b409c-9b6b-459b-8f08-f93dbfeb4d41"
|
||||
}
|
||||
@@ -1,41 +0,0 @@
|
||||
{
|
||||
"priority": "INFO",
|
||||
"payload": {
|
||||
"watcher_object.namespace": "watcher",
|
||||
"watcher_object.version": "1.0",
|
||||
"watcher_object.name": "ActionCancelPayload",
|
||||
"watcher_object.data": {
|
||||
"uuid": "10a47dd1-4874-4298-91cf-eff046dbdb8d",
|
||||
"input_parameters": {
|
||||
"param2": 2,
|
||||
"param1": 1
|
||||
},
|
||||
"fault": null,
|
||||
"created_at": "2016-10-18T09:52:05Z",
|
||||
"updated_at": null,
|
||||
"state": "CANCELLING",
|
||||
"action_plan": {
|
||||
"watcher_object.namespace": "watcher",
|
||||
"watcher_object.version": "1.0",
|
||||
"watcher_object.name": "TerseActionPlanPayload",
|
||||
"watcher_object.data": {
|
||||
"uuid": "76be87bd-3422-43f9-93a0-e85a577e3061",
|
||||
"global_efficacy": [],
|
||||
"created_at": "2016-10-18T09:52:05Z",
|
||||
"updated_at": null,
|
||||
"state": "CANCELLING",
|
||||
"audit_uuid": "10a47dd1-4874-4298-91cf-eff046dbdb8d",
|
||||
"strategy_uuid": "cb3d0b58-4415-4d90-b75b-1e96878730e3",
|
||||
"deleted_at": null
|
||||
}
|
||||
},
|
||||
"parents": [],
|
||||
"action_type": "nop",
|
||||
"deleted_at": null
|
||||
}
|
||||
},
|
||||
"event_type": "action.cancel.start",
|
||||
"publisher_id": "infra-optim:node0",
|
||||
"timestamp": "2017-01-01 00:00:00.000000",
|
||||
"message_id": "530b409c-9b6b-459b-8f08-f93dbfeb4d41"
|
||||
}
|
||||
@@ -20,7 +20,7 @@
|
||||
"watcher_object.name": "TerseActionPlanPayload",
|
||||
"watcher_object.data": {
|
||||
"uuid": "76be87bd-3422-43f9-93a0-e85a577e3061",
|
||||
"global_efficacy": [],
|
||||
"global_efficacy": {},
|
||||
"created_at": "2016-10-18T09:52:05Z",
|
||||
"updated_at": null,
|
||||
"state": "ONGOING",
|
||||
|
||||
@@ -30,7 +30,7 @@
|
||||
"watcher_object.name": "TerseActionPlanPayload",
|
||||
"watcher_object.data": {
|
||||
"uuid": "76be87bd-3422-43f9-93a0-e85a577e3061",
|
||||
"global_efficacy":[],
|
||||
"global_efficacy": {},
|
||||
"created_at": "2016-10-18T09:52:05Z",
|
||||
"updated_at": null,
|
||||
"state": "ONGOING",
|
||||
|
||||
@@ -20,7 +20,7 @@
|
||||
"watcher_object.name": "TerseActionPlanPayload",
|
||||
"watcher_object.data": {
|
||||
"uuid": "76be87bd-3422-43f9-93a0-e85a577e3061",
|
||||
"global_efficacy": [],
|
||||
"global_efficacy": {},
|
||||
"created_at": "2016-10-18T09:52:05Z",
|
||||
"updated_at": null,
|
||||
"state": "ONGOING",
|
||||
|
||||
@@ -1,55 +0,0 @@
|
||||
{
|
||||
"event_type": "action_plan.cancel.end",
|
||||
"payload": {
|
||||
"watcher_object.namespace": "watcher",
|
||||
"watcher_object.name": "ActionPlanCancelPayload",
|
||||
"watcher_object.version": "1.0",
|
||||
"watcher_object.data": {
|
||||
"created_at": "2016-10-18T09:52:05Z",
|
||||
"deleted_at": null,
|
||||
"audit_uuid": "10a47dd1-4874-4298-91cf-eff046dbdb8d",
|
||||
"audit": {
|
||||
"watcher_object.namespace": "watcher",
|
||||
"watcher_object.name": "TerseAuditPayload",
|
||||
"watcher_object.version": "1.0",
|
||||
"watcher_object.data": {
|
||||
"created_at": "2016-10-18T09:52:05Z",
|
||||
"deleted_at": null,
|
||||
"uuid": "10a47dd1-4874-4298-91cf-eff046dbdb8d",
|
||||
"goal_uuid": "bc830f84-8ae3-4fc6-8bc6-e3dd15e8b49a",
|
||||
"strategy_uuid": "75234dfe-87e3-4f11-a0e0-3c3305d86a39",
|
||||
"scope": [],
|
||||
"audit_type": "ONESHOT",
|
||||
"state": "SUCCEEDED",
|
||||
"parameters": {},
|
||||
"interval": null,
|
||||
"updated_at": null
|
||||
}
|
||||
},
|
||||
"uuid": "76be87bd-3422-43f9-93a0-e85a577e3061",
|
||||
"fault": null,
|
||||
"state": "CANCELLED",
|
||||
"global_efficacy": [],
|
||||
"strategy_uuid": "cb3d0b58-4415-4d90-b75b-1e96878730e3",
|
||||
"strategy": {
|
||||
"watcher_object.namespace": "watcher",
|
||||
"watcher_object.name": "StrategyPayload",
|
||||
"watcher_object.version": "1.0",
|
||||
"watcher_object.data": {
|
||||
"created_at": "2016-10-18T09:52:05Z",
|
||||
"deleted_at": null,
|
||||
"name": "TEST",
|
||||
"uuid": "cb3d0b58-4415-4d90-b75b-1e96878730e3",
|
||||
"parameters_spec": {},
|
||||
"display_name": "test strategy",
|
||||
"updated_at": null
|
||||
}
|
||||
},
|
||||
"updated_at": null
|
||||
}
|
||||
},
|
||||
"priority": "INFO",
|
||||
"message_id": "3984dc2b-8aef-462b-a220-8ae04237a56e",
|
||||
"timestamp": "2016-10-18 09:52:05.219414",
|
||||
"publisher_id": "infra-optim:node0"
|
||||
}
|
||||
@@ -1,65 +0,0 @@
|
||||
{
|
||||
"event_type": "action_plan.cancel.error",
|
||||
"publisher_id": "infra-optim:node0",
|
||||
"priority": "ERROR",
|
||||
"message_id": "9a45c5ae-0e21-4300-8fa0-5555d52a66d9",
|
||||
"payload": {
|
||||
"watcher_object.version": "1.0",
|
||||
"watcher_object.namespace": "watcher",
|
||||
"watcher_object.name": "ActionPlanCancelPayload",
|
||||
"watcher_object.data": {
|
||||
"fault": {
|
||||
"watcher_object.version": "1.0",
|
||||
"watcher_object.namespace": "watcher",
|
||||
"watcher_object.name": "ExceptionPayload",
|
||||
"watcher_object.data": {
|
||||
"exception_message": "TEST",
|
||||
"module_name": "watcher.tests.notifications.test_action_plan_notification",
|
||||
"function_name": "test_send_action_plan_cancel_with_error",
|
||||
"exception": "WatcherException"
|
||||
}
|
||||
},
|
||||
"uuid": "76be87bd-3422-43f9-93a0-e85a577e3061",
|
||||
"created_at": "2016-10-18T09:52:05Z",
|
||||
"strategy_uuid": "cb3d0b58-4415-4d90-b75b-1e96878730e3",
|
||||
"strategy": {
|
||||
"watcher_object.version": "1.0",
|
||||
"watcher_object.namespace": "watcher",
|
||||
"watcher_object.name": "StrategyPayload",
|
||||
"watcher_object.data": {
|
||||
"uuid": "cb3d0b58-4415-4d90-b75b-1e96878730e3",
|
||||
"created_at": "2016-10-18T09:52:05Z",
|
||||
"name": "TEST",
|
||||
"updated_at": null,
|
||||
"display_name": "test strategy",
|
||||
"parameters_spec": {},
|
||||
"deleted_at": null
|
||||
}
|
||||
},
|
||||
"updated_at": null,
|
||||
"deleted_at": null,
|
||||
"audit_uuid": "10a47dd1-4874-4298-91cf-eff046dbdb8d",
|
||||
"audit": {
|
||||
"watcher_object.version": "1.0",
|
||||
"watcher_object.namespace": "watcher",
|
||||
"watcher_object.name": "TerseAuditPayload",
|
||||
"watcher_object.data": {
|
||||
"parameters": {},
|
||||
"uuid": "10a47dd1-4874-4298-91cf-eff046dbdb8d",
|
||||
"goal_uuid": "bc830f84-8ae3-4fc6-8bc6-e3dd15e8b49a",
|
||||
"strategy_uuid": "75234dfe-87e3-4f11-a0e0-3c3305d86a39",
|
||||
"created_at": "2016-10-18T09:52:05Z",
|
||||
"scope": [],
|
||||
"updated_at": null,
|
||||
"audit_type": "ONESHOT",
|
||||
"interval": null,
|
||||
"deleted_at": null,
|
||||
"state": "SUCCEEDED"
|
||||
}
|
||||
},
|
||||
"global_efficacy": [],
|
||||
"state": "CANCELLING"
|
||||
}
|
||||
},
|
||||
"timestamp": "2016-10-18 09:52:05.219414"
|
||||
}
|
||||
@@ -1,55 +0,0 @@
|
||||
{
|
||||
"event_type": "action_plan.cancel.start",
|
||||
"payload": {
|
||||
"watcher_object.namespace": "watcher",
|
||||
"watcher_object.name": "ActionPlanCancelPayload",
|
||||
"watcher_object.version": "1.0",
|
||||
"watcher_object.data": {
|
||||
"created_at": "2016-10-18T09:52:05Z",
|
||||
"deleted_at": null,
|
||||
"audit_uuid": "10a47dd1-4874-4298-91cf-eff046dbdb8d",
|
||||
"audit": {
|
||||
"watcher_object.namespace": "watcher",
|
||||
"watcher_object.name": "TerseAuditPayload",
|
||||
"watcher_object.version": "1.0",
|
||||
"watcher_object.data": {
|
||||
"created_at": "2016-10-18T09:52:05Z",
|
||||
"deleted_at": null,
|
||||
"uuid": "10a47dd1-4874-4298-91cf-eff046dbdb8d",
|
||||
"goal_uuid": "bc830f84-8ae3-4fc6-8bc6-e3dd15e8b49a",
|
||||
"strategy_uuid": "75234dfe-87e3-4f11-a0e0-3c3305d86a39",
|
||||
"scope": [],
|
||||
"audit_type": "ONESHOT",
|
||||
"state": "SUCCEEDED",
|
||||
"parameters": {},
|
||||
"interval": null,
|
||||
"updated_at": null
|
||||
}
|
||||
},
|
||||
"uuid": "76be87bd-3422-43f9-93a0-e85a577e3061",
|
||||
"fault": null,
|
||||
"state": "CANCELLING",
|
||||
"global_efficacy": [],
|
||||
"strategy_uuid": "cb3d0b58-4415-4d90-b75b-1e96878730e3",
|
||||
"strategy": {
|
||||
"watcher_object.namespace": "watcher",
|
||||
"watcher_object.name": "StrategyPayload",
|
||||
"watcher_object.version": "1.0",
|
||||
"watcher_object.data": {
|
||||
"created_at": "2016-10-18T09:52:05Z",
|
||||
"deleted_at": null,
|
||||
"name": "TEST",
|
||||
"uuid": "cb3d0b58-4415-4d90-b75b-1e96878730e3",
|
||||
"parameters_spec": {},
|
||||
"display_name": "test strategy",
|
||||
"updated_at": null
|
||||
}
|
||||
},
|
||||
"updated_at": null
|
||||
}
|
||||
},
|
||||
"priority": "INFO",
|
||||
"message_id": "3984dc2b-8aef-462b-a220-8ae04237a56e",
|
||||
"timestamp": "2016-10-18 09:52:05.219414",
|
||||
"publisher_id": "infra-optim:node0"
|
||||
}
|
||||
@@ -23,7 +23,6 @@
|
||||
"audit": {
|
||||
"watcher_object.version": "1.0",
|
||||
"watcher_object.data": {
|
||||
"name": "my_audit",
|
||||
"audit_type": "ONESHOT",
|
||||
"scope": [],
|
||||
"uuid": "10a47dd1-4874-4298-91cf-eff046dbdb8d",
|
||||
|
||||
@@ -8,7 +8,6 @@
|
||||
"audit_uuid": "10a47dd1-4874-4298-91cf-eff046dbdb8d",
|
||||
"audit": {
|
||||
"watcher_object.data": {
|
||||
"name": "my_audit",
|
||||
"uuid": "10a47dd1-4874-4298-91cf-eff046dbdb8d",
|
||||
"goal_uuid": "bc830f84-8ae3-4fc6-8bc6-e3dd15e8b49a",
|
||||
"strategy_uuid": "75234dfe-87e3-4f11-a0e0-3c3305d86a39",
|
||||
|
||||
@@ -15,7 +15,6 @@
|
||||
"watcher_object.data": {
|
||||
"created_at": "2016-10-18T09:52:05Z",
|
||||
"deleted_at": null,
|
||||
"name": "my_audit",
|
||||
"uuid": "10a47dd1-4874-4298-91cf-eff046dbdb8d",
|
||||
"goal_uuid": "bc830f84-8ae3-4fc6-8bc6-e3dd15e8b49a",
|
||||
"strategy_uuid": "75234dfe-87e3-4f11-a0e0-3c3305d86a39",
|
||||
@@ -30,7 +29,7 @@
|
||||
"uuid": "76be87bd-3422-43f9-93a0-e85a577e3061",
|
||||
"fault": null,
|
||||
"state": "ONGOING",
|
||||
"global_efficacy": [],
|
||||
"global_efficacy": {},
|
||||
"strategy_uuid": "cb3d0b58-4415-4d90-b75b-1e96878730e3",
|
||||
"strategy": {
|
||||
"watcher_object.namespace": "watcher",
|
||||
|
||||
@@ -45,7 +45,6 @@
|
||||
"watcher_object.name": "TerseAuditPayload",
|
||||
"watcher_object.data": {
|
||||
"parameters": {},
|
||||
"name": "my_audit",
|
||||
"uuid": "10a47dd1-4874-4298-91cf-eff046dbdb8d",
|
||||
"goal_uuid": "bc830f84-8ae3-4fc6-8bc6-e3dd15e8b49a",
|
||||
"strategy_uuid": "75234dfe-87e3-4f11-a0e0-3c3305d86a39",
|
||||
@@ -58,7 +57,7 @@
|
||||
"state": "PENDING"
|
||||
}
|
||||
},
|
||||
"global_efficacy": [],
|
||||
"global_efficacy": {},
|
||||
"state": "ONGOING"
|
||||
}
|
||||
},
|
||||
|
||||
@@ -15,7 +15,6 @@
|
||||
"watcher_object.data": {
|
||||
"created_at": "2016-10-18T09:52:05Z",
|
||||
"deleted_at": null,
|
||||
"name": "my_audit",
|
||||
"uuid": "10a47dd1-4874-4298-91cf-eff046dbdb8d",
|
||||
"goal_uuid": "bc830f84-8ae3-4fc6-8bc6-e3dd15e8b49a",
|
||||
"strategy_uuid": "75234dfe-87e3-4f11-a0e0-3c3305d86a39",
|
||||
@@ -30,7 +29,7 @@
|
||||
"uuid": "76be87bd-3422-43f9-93a0-e85a577e3061",
|
||||
"fault": null,
|
||||
"state": "ONGOING",
|
||||
"global_efficacy": [],
|
||||
"global_efficacy": {},
|
||||
"strategy_uuid": "cb3d0b58-4415-4d90-b75b-1e96878730e3",
|
||||
"strategy": {
|
||||
"watcher_object.namespace": "watcher",
|
||||
|
||||
@@ -6,7 +6,6 @@
|
||||
"audit": {
|
||||
"watcher_object.version": "1.0",
|
||||
"watcher_object.data": {
|
||||
"name": "my_audit",
|
||||
"audit_type": "ONESHOT",
|
||||
"scope": [],
|
||||
"created_at": "2016-10-18T09:52:05Z",
|
||||
|
||||
@@ -2,7 +2,6 @@
|
||||
"priority": "INFO",
|
||||
"payload": {
|
||||
"watcher_object.data": {
|
||||
"name": "my_audit",
|
||||
"audit_type": "ONESHOT",
|
||||
"parameters": {
|
||||
"para2": "hello",
|
||||
|
||||
@@ -2,7 +2,6 @@
|
||||
"priority": "INFO",
|
||||
"payload": {
|
||||
"watcher_object.data": {
|
||||
"name": "my_audit",
|
||||
"audit_type": "ONESHOT",
|
||||
"parameters": {
|
||||
"para2": "hello",
|
||||
|
||||
@@ -2,7 +2,6 @@
|
||||
"priority": "INFO",
|
||||
"payload": {
|
||||
"watcher_object.data": {
|
||||
"name": "my_audit",
|
||||
"audit_type": "ONESHOT",
|
||||
"parameters": {
|
||||
"para2": "hello",
|
||||
|
||||
@@ -2,7 +2,6 @@
|
||||
"priority": "ERROR",
|
||||
"payload": {
|
||||
"watcher_object.data": {
|
||||
"name": "my_audit",
|
||||
"audit_type": "ONESHOT",
|
||||
"parameters": {
|
||||
"para2": "hello",
|
||||
|
||||
@@ -2,7 +2,6 @@
|
||||
"priority": "INFO",
|
||||
"payload": {
|
||||
"watcher_object.data": {
|
||||
"name": "my_audit",
|
||||
"audit_type": "ONESHOT",
|
||||
"parameters": {
|
||||
"para2": "hello",
|
||||
|
||||
@@ -2,7 +2,6 @@
|
||||
"priority": "INFO",
|
||||
"payload": {
|
||||
"watcher_object.data": {
|
||||
"name": "my_audit",
|
||||
"audit_type": "ONESHOT",
|
||||
"parameters": {
|
||||
"para2": "hello",
|
||||
|
||||
@@ -2,7 +2,6 @@
|
||||
"priority": "ERROR",
|
||||
"payload": {
|
||||
"watcher_object.data": {
|
||||
"name": "my_audit",
|
||||
"audit_type": "ONESHOT",
|
||||
"parameters": {
|
||||
"para2": "hello",
|
||||
|
||||
@@ -2,7 +2,6 @@
|
||||
"priority": "INFO",
|
||||
"payload": {
|
||||
"watcher_object.data": {
|
||||
"name": "my_audit",
|
||||
"audit_type": "ONESHOT",
|
||||
"parameters": {
|
||||
"para2": "hello",
|
||||
|
||||
@@ -4,7 +4,6 @@
|
||||
"payload": {
|
||||
"watcher_object.name": "AuditUpdatePayload",
|
||||
"watcher_object.data": {
|
||||
"name": "my_audit",
|
||||
"strategy_uuid": "75234dfe-87e3-4f11-a0e0-3c3305d86a39",
|
||||
"strategy": {
|
||||
"watcher_object.name": "StrategyPayload",
|
||||
|
||||
@@ -131,16 +131,6 @@ The actions that may have a rule enforced on them are:
|
||||
* ``GET /v1/actions/<ACTION_UUID>``
|
||||
|
||||
|
||||
* ``service:get_all``, ``service:detail`` - List available Watcher services
|
||||
|
||||
* ``GET /v1/services``
|
||||
* ``GET /v1/services/detail``
|
||||
|
||||
* ``service:get`` - Retrieve a specific Watcher service entity
|
||||
|
||||
* ``GET /v1/services/<SERVICE_ID>``
|
||||
|
||||
|
||||
|
||||
To limit an action to a particular role or roles, you list the roles like so ::
|
||||
|
||||
|
||||
@@ -19,7 +19,7 @@ The source install instructions specifically avoid using platform specific
|
||||
packages, instead using the source for the code and the Python Package Index
|
||||
(PyPi_).
|
||||
|
||||
.. _PyPi: https://pypi.org/
|
||||
.. _PyPi: https://pypi.python.org/pypi
|
||||
|
||||
It's expected that your system already has python2.7_, latest version of pip_,
|
||||
and git_ available.
|
||||
@@ -30,7 +30,7 @@ and git_ available.
|
||||
|
||||
Your system shall also have some additional system libraries:
|
||||
|
||||
On Ubuntu (tested on 16.04LTS):
|
||||
On Ubuntu (tested on 14.04LTS):
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
@@ -126,9 +126,9 @@ Here is single Dockerfile snippet you can use to run your Docker container:
|
||||
MAINTAINER David TARDIVEL <david.tardivel@b-com.com>
|
||||
|
||||
RUN apt-get update
|
||||
RUN apt-get dist-upgrade
|
||||
RUN apt-get install vim net-tools
|
||||
RUN apt-get install experimental watcher-api
|
||||
RUN apt-get dist-upgrade -y
|
||||
RUN apt-get install -y vim net-tools
|
||||
RUN apt-get install -yt experimental watcher-api
|
||||
|
||||
CMD ["/usr/bin/watcher-api"]
|
||||
|
||||
|
||||
@@ -1,7 +1,3 @@
|
||||
==================================================
|
||||
OpenStack Infrastructure Optimization Service APIs
|
||||
==================================================
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
|
||||
@@ -86,15 +86,3 @@ Actions
|
||||
|
||||
.. autotype:: watcher.api.controllers.v1.action.Action
|
||||
:members:
|
||||
|
||||
Scoring Engine
|
||||
==============
|
||||
|
||||
.. rest-controller:: watcher.api.controllers.v1.scoring_engine:ScoringEngineController
|
||||
:webprefix: /v1/scoring_engine
|
||||
|
||||
.. autotype:: watcher.api.controllers.v1.scoring_engine.ScoringEngineCollection
|
||||
:members:
|
||||
|
||||
.. autotype:: watcher.api.controllers.v1.scoring_engine.ScoringEngine
|
||||
:members:
|
||||
|
||||
@@ -119,7 +119,7 @@ The watcher command-line interface (CLI) can be used to interact with the
|
||||
Watcher system in order to control it or to know its current status.
|
||||
|
||||
Please, read `the detailed documentation about Watcher CLI
|
||||
<https://docs.openstack.org/python-watcherclient/latest/cli/>`_.
|
||||
<https://factory.b-com.com/www/watcher/doc/python-watcherclient/>`_.
|
||||
|
||||
.. _archi_watcher_dashboard_definition:
|
||||
|
||||
@@ -130,7 +130,7 @@ The Watcher Dashboard can be used to interact with the Watcher system through
|
||||
Horizon in order to control it or to know its current status.
|
||||
|
||||
Please, read `the detailed documentation about Watcher Dashboard
|
||||
<https://docs.openstack.org/watcher-dashboard/latest>`_.
|
||||
<http://docs.openstack.org/developer/watcher-dashboard/>`_.
|
||||
|
||||
.. _archi_watcher_database_definition:
|
||||
|
||||
@@ -170,7 +170,7 @@ Unless specified, it then selects the most appropriate :ref:`strategy
|
||||
goal.
|
||||
|
||||
The :ref:`Strategy <strategy_definition>` is then dynamically loaded (via
|
||||
`stevedore <https://docs.openstack.org/stevedore/latest>`_). The
|
||||
`stevedore <http://docs.openstack.org/developer/stevedore/>`_). The
|
||||
:ref:`Watcher Decision Engine <watcher_decision_engine_definition>` executes
|
||||
the strategy.
|
||||
|
||||
|
||||
@@ -42,7 +42,6 @@ extensions = [
|
||||
'ext.versioned_notifications',
|
||||
'oslo_config.sphinxconfiggen',
|
||||
'openstackdocstheme',
|
||||
'sphinx.ext.napoleon',
|
||||
]
|
||||
|
||||
wsme_protocols = ['restjson']
|
||||
@@ -73,7 +72,7 @@ copyright = u'OpenStack Foundation'
|
||||
# The full version, including alpha/beta/rc tags.
|
||||
release = watcher_version.version_info.release_string()
|
||||
# The short X.Y version.
|
||||
version = watcher_version.version_string
|
||||
version = watcher_version.version_info.version_string()
|
||||
|
||||
# A list of ignored prefixes for module index sorting.
|
||||
modindex_common_prefix = ['watcher.']
|
||||
|
||||
@@ -15,25 +15,19 @@ Service overview
|
||||
================
|
||||
|
||||
The Watcher system is a collection of services that provides support to
|
||||
optimize your IaaS platform. The Watcher service may, depending upon
|
||||
optimize your IAAS platform. The Watcher service may, depending upon
|
||||
configuration, interact with several other OpenStack services. This includes:
|
||||
|
||||
- the OpenStack Identity service (`keystone`_) for request authentication and
|
||||
to locate other OpenStack services.
|
||||
- the OpenStack Telemetry service (`ceilometer`_) for collecting the resources
|
||||
metrics.
|
||||
- the time series database (`gnocchi`_) for consuming the resources
|
||||
metrics.
|
||||
to locate other OpenStack services
|
||||
- the OpenStack Telemetry service (`ceilometer`_) for consuming the resources
|
||||
metrics
|
||||
- the OpenStack Compute service (`nova`_) works with the Watcher service and
|
||||
acts as a user-facing API for instance migration.
|
||||
- the OpenStack Bare Metal service (`ironic`_) works with the Watcher service
|
||||
and allows to manage power state of nodes.
|
||||
- the OpenStack Block Storage service (`cinder`_) works with the Watcher
|
||||
service and as an API for volume node migration.
|
||||
|
||||
The Watcher service includes the following components:
|
||||
|
||||
- ``watcher-decision-engine``: runs audit on part of your IaaS and return an
|
||||
- ``watcher-decision-engine``: runs audit on part of your IAAS and return an
|
||||
action plan in order to optimize resource placement.
|
||||
- ``watcher-api``: A RESTful API that processes application requests by sending
|
||||
them to the watcher-decision-engine over RPC.
|
||||
@@ -59,9 +53,6 @@ additional functionality:
|
||||
.. _`keystone`: https://github.com/openstack/keystone
|
||||
.. _`ceilometer`: https://github.com/openstack/ceilometer
|
||||
.. _`nova`: https://github.com/openstack/nova
|
||||
.. _`gnocchi`: https://github.com/gnocchixyz/gnocchi
|
||||
.. _`ironic`: https://github.com/openstack/ironic
|
||||
.. _`cinder`: https://github.com/openstack/cinder
|
||||
.. _`python-watcherclient`: https://github.com/openstack/python-watcherclient
|
||||
.. _`watcher-dashboard`: https://github.com/openstack/watcher-dashboard
|
||||
.. _`watcher metering`: https://github.com/b-com/watcher-metering
|
||||
@@ -138,14 +129,10 @@ Configure the Identity service for the Watcher service
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
$ openstack endpoint create --region YOUR_REGION
|
||||
watcher public http://WATCHER_API_PUBLIC_IP:9322
|
||||
|
||||
$ openstack endpoint create --region YOUR_REGION
|
||||
watcher internal http://WATCHER_API_INTERNAL_IP:9322
|
||||
|
||||
$ openstack endpoint create --region YOUR_REGION
|
||||
watcher admin http://WATCHER_API_ADMIN_IP:9322
|
||||
$ openstack endpoint create --region YOUR_REGION watcher \
|
||||
--publicurl http://WATCHER_API_PUBLIC_IP:9322 \
|
||||
--internalurl http://WATCHER_API_INTERNAL_IP:9322 \
|
||||
--adminurl http://WATCHER_API_ADMIN_IP:9322
|
||||
|
||||
.. _watcher-db_configuration:
|
||||
|
||||
@@ -178,7 +165,7 @@ You can easily generate and update a sample configuration file
|
||||
named :ref:`watcher.conf.sample <watcher_sample_configuration_files>` by using
|
||||
these following commands::
|
||||
|
||||
$ git clone git://git.openstack.org/openstack/watcher
|
||||
$ git clone https://git.openstack.org/openstack/watcher
|
||||
$ cd watcher/
|
||||
$ tox -e genconfig
|
||||
$ vi etc/watcher/watcher.conf.sample
|
||||
@@ -213,8 +200,8 @@ configuration file, in order:
|
||||
|
||||
|
||||
Although some configuration options are mentioned here, it is recommended that
|
||||
you review all the :ref:`available options
|
||||
<watcher_sample_configuration_files>`
|
||||
you review all the `available options
|
||||
<https://git.openstack.org/cgit/openstack/watcher/tree/etc/watcher/watcher.conf.sample>`_
|
||||
so that the watcher service is configured for your needs.
|
||||
|
||||
#. The Watcher Service stores information in a database. This guide uses the
|
||||
@@ -230,7 +217,7 @@ so that the watcher service is configured for your needs.
|
||||
# The SQLAlchemy connection string used to connect to the
|
||||
# database (string value)
|
||||
#connection=<None>
|
||||
connection = mysql+pymysql://watcher:WATCHER_DBPASSWORD@DB_IP/watcher?charset=utf8
|
||||
connection = mysql://watcher:WATCHER_DBPASSWORD@DB_IP/watcher?charset=utf8
|
||||
|
||||
#. Configure the Watcher Service to use the RabbitMQ message broker by
|
||||
setting one or more of these options. Replace RABBIT_HOST with the
|
||||
@@ -248,8 +235,21 @@ so that the watcher service is configured for your needs.
|
||||
# option. (string value)
|
||||
control_exchange = watcher
|
||||
|
||||
# ...
|
||||
transport_url = rabbit://RABBITMQ_USER:RABBITMQ_PASSWORD@RABBIT_HOST
|
||||
...
|
||||
|
||||
[oslo_messaging_rabbit]
|
||||
|
||||
# The username used by the message broker (string value)
|
||||
rabbit_userid = RABBITMQ_USER
|
||||
|
||||
# The password of user used by the message broker (string value)
|
||||
rabbit_password = RABBITMQ_PASSWORD
|
||||
|
||||
# The host where the message brokeris installed (string value)
|
||||
rabbit_host = RABBIT_HOST
|
||||
|
||||
# The port used bythe message broker (string value)
|
||||
#rabbit_port = 5672
|
||||
|
||||
|
||||
#. Watcher API shall validate the token provided by every incoming request,
|
||||
@@ -273,7 +273,7 @@ so that the watcher service is configured for your needs.
|
||||
|
||||
# Authentication URL (unknown value)
|
||||
#auth_url = <None>
|
||||
auth_url = http://IDENTITY_IP:5000
|
||||
auth_url = http://IDENTITY_IP:35357
|
||||
|
||||
# Username (unknown value)
|
||||
# Deprecated group/name - [DEFAULT]/username
|
||||
@@ -319,7 +319,7 @@ so that the watcher service is configured for your needs.
|
||||
|
||||
# Authentication URL (unknown value)
|
||||
#auth_url = <None>
|
||||
auth_url = http://IDENTITY_IP:5000
|
||||
auth_url = http://IDENTITY_IP:35357
|
||||
|
||||
# Username (unknown value)
|
||||
# Deprecated group/name - [DEFAULT]/username
|
||||
@@ -349,7 +349,7 @@ so that the watcher service is configured for your needs.
|
||||
[nova_client]
|
||||
|
||||
# Version of Nova API to use in novaclient. (string value)
|
||||
#api_version = 2.56
|
||||
#api_version = 2
|
||||
api_version = 2.1
|
||||
|
||||
#. Create the Watcher Service database tables::
|
||||
@@ -366,14 +366,15 @@ Configure Nova compute
|
||||
Please check your hypervisor configuration to correctly handle
|
||||
`instance migration`_.
|
||||
|
||||
.. _`instance migration`: https://docs.openstack.org/nova/latest/admin/migration.html
|
||||
.. _`instance migration`: http://docs.openstack.org/admin-guide/compute-live-migration-usage.html
|
||||
|
||||
Configure Measurements
|
||||
======================
|
||||
|
||||
You can configure and install Ceilometer by following the documentation below :
|
||||
|
||||
#. https://docs.openstack.org/ceilometer/latest
|
||||
#. http://docs.openstack.org/developer/ceilometer
|
||||
#. http://docs.openstack.org/kilo/install-guide/install/apt/content/ceilometer-nova.html
|
||||
|
||||
The built-in strategy 'basic_consolidation' provided by watcher requires
|
||||
"**compute.node.cpu.percent**" and "**cpu_util**" measurements to be collected
|
||||
@@ -385,13 +386,13 @@ the OpenStack site.
|
||||
You can use 'ceilometer meter-list' to list the available meters.
|
||||
|
||||
For more information:
|
||||
https://docs.openstack.org/ceilometer/latest/admin/telemetry-measurements.html
|
||||
http://docs.openstack.org/developer/ceilometer/measurements.html
|
||||
|
||||
Ceilometer is designed to collect measurements from OpenStack services and from
|
||||
other external components. If you would like to add new meters to the currently
|
||||
existing ones, you need to follow the documentation below:
|
||||
|
||||
#. https://docs.openstack.org/ceilometer/latest/contributor/measurements.html#new-measurements
|
||||
#. http://docs.openstack.org/developer/ceilometer/new_meters.html
|
||||
|
||||
The Ceilometer collector uses a pluggable storage system, meaning that you can
|
||||
pick any database system you prefer.
|
||||
|
||||
@@ -1,9 +1,5 @@
|
||||
===================
|
||||
Configuration Guide
|
||||
===================
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
:maxdepth: 1
|
||||
|
||||
configuring
|
||||
watcher
|
||||
|
||||
@@ -24,8 +24,8 @@ signed OpenStack's contributor's agreement.
|
||||
|
||||
.. seealso::
|
||||
|
||||
* https://docs.openstack.org/infra/manual/developers.html
|
||||
* https://wiki.openstack.org/CLA
|
||||
* http://docs.openstack.org/infra/manual/developers.html
|
||||
* http://wiki.openstack.org/CLA
|
||||
|
||||
LaunchPad Project
|
||||
-----------------
|
||||
@@ -37,22 +37,22 @@ notifications of important events.
|
||||
|
||||
.. seealso::
|
||||
|
||||
* https://launchpad.net
|
||||
* https://launchpad.net/watcher
|
||||
* https://launchpad.net/openstack
|
||||
* http://launchpad.net
|
||||
* http://launchpad.net/watcher
|
||||
* http://launchpad.net/~openstack
|
||||
|
||||
|
||||
Project Hosting Details
|
||||
-----------------------
|
||||
|
||||
Bug tracker
|
||||
https://launchpad.net/watcher
|
||||
http://launchpad.net/watcher
|
||||
|
||||
Mailing list (prefix subjects with ``[watcher]`` for faster responses)
|
||||
http://lists.openstack.org/pipermail/openstack-dev/
|
||||
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
|
||||
|
||||
Wiki
|
||||
https://wiki.openstack.org/Watcher
|
||||
http://wiki.openstack.org/Watcher
|
||||
|
||||
Code Hosting
|
||||
https://git.openstack.org/cgit/openstack/watcher
|
||||
@@ -65,7 +65,7 @@ IRC Channel
|
||||
|
||||
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, 13:00 UTC on odd weeks in the ``#openstack-meeting-alt``
|
||||
IRC channel (`meetings logs`_)
|
||||
|
||||
.. _changelog: http://eavesdrop.openstack.org/irclogs/%23openstack-watcher/
|
||||
|
||||
@@ -19,13 +19,13 @@ model. To enable the Watcher plugin with DevStack, add the following to the
|
||||
`[[local|localrc]]` section of your controller's `local.conf` to enable the
|
||||
Watcher plugin::
|
||||
|
||||
enable_plugin watcher git://git.openstack.org/openstack/watcher
|
||||
enable_plugin watcher https://git.openstack.org/openstack/watcher
|
||||
|
||||
For more detailed instructions, see `Detailed DevStack Instructions`_. Check
|
||||
out the `DevStack documentation`_ for more information regarding DevStack.
|
||||
|
||||
.. _PluginModelDocs: https://docs.openstack.org/devstack/latest/plugins.html
|
||||
.. _DevStack documentation: https://docs.openstack.org/devstack/latest
|
||||
.. _PluginModelDocs: http://docs.openstack.org/developer/devstack/plugins.html
|
||||
.. _DevStack documentation: http://docs.openstack.org/developer/devstack/
|
||||
|
||||
Detailed DevStack Instructions
|
||||
==============================
|
||||
@@ -37,7 +37,7 @@ Detailed DevStack Instructions
|
||||
needed (i.e., no computes are needed if you want to just experiment with
|
||||
the Watcher services). These servers can be VMs running on your local
|
||||
machine via VirtualBox if you prefer. DevStack currently recommends that
|
||||
you use Ubuntu 16.04 LTS. The servers should also have connections to the
|
||||
you use Ubuntu 14.04 LTS. The servers should also have connections to the
|
||||
same network such that they are all able to communicate with one another.
|
||||
|
||||
#. For each server, clone the DevStack repository and create the stack user::
|
||||
|
||||
@@ -4,7 +4,7 @@
|
||||
|
||||
https://creativecommons.org/licenses/by/3.0/
|
||||
|
||||
.. _watcher_development_environment:
|
||||
.. _watcher_developement_environment:
|
||||
|
||||
=========================================
|
||||
Set up a development environment manually
|
||||
@@ -37,7 +37,7 @@ different version of the above, please document your configuration here!
|
||||
|
||||
.. _Python: https://www.python.org/
|
||||
.. _git: https://git-scm.com/
|
||||
.. _setuptools: https://pypi.org/project/setuptools
|
||||
.. _setuptools: https://pypi.python.org/pypi/setuptools
|
||||
.. _virtualenvwrapper: https://virtualenvwrapper.readthedocs.io/en/latest/install.html
|
||||
|
||||
Getting the latest code
|
||||
@@ -69,8 +69,8 @@ itself.
|
||||
|
||||
These dependencies can be installed from PyPi_ using the Python tool pip_.
|
||||
|
||||
.. _PyPi: https://pypi.org/
|
||||
.. _pip: https://pypi.org/project/pip
|
||||
.. _PyPi: http://pypi.python.org/
|
||||
.. _pip: http://pypi.python.org/pypi/pip
|
||||
|
||||
However, your system *may* need additional dependencies that `pip` (and by
|
||||
extension, PyPi) cannot satisfy. These dependencies should be installed
|
||||
@@ -123,10 +123,9 @@ You can re-activate this virtualenv for your current shell using:
|
||||
|
||||
$ workon watcher
|
||||
|
||||
For more information on virtual environments, see virtualenv_ and
|
||||
virtualenvwrapper_.
|
||||
For more information on virtual environments, see virtualenv_.
|
||||
|
||||
.. _virtualenv: https://pypi.org/project/virtualenv/
|
||||
.. _virtualenv: http://www.virtualenv.org/
|
||||
|
||||
|
||||
|
||||
@@ -193,8 +192,6 @@ still need to configure the following sections:
|
||||
:ref:`Identity service <identity-service_configuration>` i.e. Keystone
|
||||
- The ``[watcher_messaging]`` section to configure the OpenStack AMQP-based
|
||||
message bus
|
||||
- The ``watcher_clients_auth`` section to configure Keystone client to access
|
||||
related OpenStack projects
|
||||
|
||||
So if you need some more details on how to configure one or more of these
|
||||
sections, please do have a look at :doc:`../configuration/configuring` before
|
||||
|
||||
@@ -22,7 +22,7 @@ Pre-requisites
|
||||
We assume that you have set up a working Watcher development environment. So if
|
||||
this not already the case, you can check out our documentation which explains
|
||||
how to set up a :ref:`development environment
|
||||
<watcher_development_environment>`.
|
||||
<watcher_developement_environment>`.
|
||||
|
||||
.. _development environment:
|
||||
|
||||
@@ -34,7 +34,7 @@ First off, we need to create the project structure. To do so, we can use
|
||||
generate the skeleton of our project::
|
||||
|
||||
$ virtualenv thirdparty
|
||||
$ . thirdparty/bin/activate
|
||||
$ source thirdparty/bin/activate
|
||||
$ pip install cookiecutter
|
||||
$ cookiecutter https://github.com/openstack-dev/cookiecutter
|
||||
|
||||
@@ -79,7 +79,7 @@ requirements.txt file::
|
||||
|
||||
.. _cookiecutter: https://github.com/audreyr/cookiecutter
|
||||
.. _OpenStack cookiecutter: https://github.com/openstack-dev/cookiecutter
|
||||
.. _python-watcher: https://pypi.org/project/python-watcher
|
||||
.. _python-watcher: https://pypi.python.org/pypi/python-watcher
|
||||
|
||||
Implementing a plugin for Watcher
|
||||
=================================
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user