From a62acbf2abd128043a80a756ffd10b187ba91060 Mon Sep 17 00:00:00 2001 From: aditi Date: Mon, 8 May 2017 14:09:42 +0530 Subject: [PATCH] Watcher official install-guide Currently watcher project does not have an official install guide at [1] This patch adds watcher install guide for rdo and debian. install-guide is written following the document [2]. [1] https://docs.openstack.org/project-install-guide/ocata/ [2] https://docs.openstack.org/contributor-guide/project-install-guide.html Change-Id: Idfae7286003f81222dadf91ddcaf95a42c7eb07f --- install-guide/source/common_configure.rst | 71 +++++ install-guide/source/common_prerequisites.rst | 139 ++++++++ install-guide/source/conf.py | 301 ++++++++++++++++++ install-guide/source/get_started.rst | 27 ++ install-guide/source/index.rst | 39 +++ install-guide/source/install-obs.rst | 34 ++ install-guide/source/install-rdo.rst | 38 +++ install-guide/source/install-ubuntu.rst | 34 ++ install-guide/source/install.rst | 20 ++ install-guide/source/next-steps.rst | 9 + install-guide/source/verify.rst | 119 +++++++ test-requirements.txt | 2 + tox.ini | 3 + 13 files changed, 836 insertions(+) create mode 100644 install-guide/source/common_configure.rst create mode 100644 install-guide/source/common_prerequisites.rst create mode 100644 install-guide/source/conf.py create mode 100644 install-guide/source/get_started.rst create mode 100644 install-guide/source/index.rst create mode 100644 install-guide/source/install-obs.rst create mode 100644 install-guide/source/install-rdo.rst create mode 100644 install-guide/source/install-ubuntu.rst create mode 100644 install-guide/source/install.rst create mode 100644 install-guide/source/next-steps.rst create mode 100644 install-guide/source/verify.rst diff --git a/install-guide/source/common_configure.rst b/install-guide/source/common_configure.rst new file mode 100644 index 0000000..b34d5de --- /dev/null +++ b/install-guide/source/common_configure.rst @@ -0,0 +1,71 @@ +2. Edit the ``/etc/watcher/watcher.conf`` file and complete the following + actions: + + * In the ``[database]`` section, configure database access: + + .. code-block:: ini + + [database] + ... + connection = mysql+pymysql://watcher:WATCHER_DBPASS@controller/watcher?charset=utf8 + + * In the `[DEFAULT]` section, configure the transport url for RabbitMQ message broker. + + .. code-block:: ini + + [DEFAULT] + ... + control_exchange = watcher + transport_url = rabbit://openstack:RABBIT_PASS@controller + + Replace the RABBIT_PASS with the password you chose for OpenStack user in RabbitMQ. + + * In the `[keystone_authtoken]` section, configure Identity service access. + + .. code-block:: ini + + [keystone_authtoken] + ... + auth_uri = http://controller:5000 + auth_url = http://controller:35357 + memcached_servers = controller:11211 + auth_type = password + project_domain_name = default + user_domain_name = default + project_name = service + username = watcher + password = WATCHER_PASS + + Replace WATCHER_PASS with the password you chose for the watcher user in the Identity service. + + * Watcher interacts with other OpenStack projects via project clients, in order to instantiate these + clients, Watcher requests new session from Identity service. In the `[watcher_client_auth]` section, + configure the identity service access to interact with other OpenStack project clients. + + .. code-block:: ini + + [watcher_client_auth] + ... + auth_type = password + auth_url = http://controller:35357 + username = watcher + password = WATCHER_PASS + project_domain_name = default + user_domain_name = default + project_name = service + + Replace WATCHER_PASS with the password you chose for the watcher user in the Identity service. + + * In the `[oslo_messaging_notifications]` section, configure the messaging driver. + + .. code-block:: ini + + [oslo_messaging_notifications] + ... + driver = messagingv2 + +3. Populate watcher database: + + .. code-block:: ini + + su -s /bin/sh -c "watcher-db-manage" watcher diff --git a/install-guide/source/common_prerequisites.rst b/install-guide/source/common_prerequisites.rst new file mode 100644 index 0000000..fda84d0 --- /dev/null +++ b/install-guide/source/common_prerequisites.rst @@ -0,0 +1,139 @@ +Prerequisites +------------- + +Before you install and configure the Infrastructure Optimization service, +you must create a database, service credentials, and API endpoints. + +1. Create the database, complete these steps: + + * Use the database access client to connect to the database + server as the ``root`` user: + + .. code-block:: console + + $ mysql -u root -p + + * Create the ``watcher`` database: + + .. code-block:: none + + CREATE DATABASE watcher CHARACTER SET utf8; + + * Grant proper access to the ``watcher`` database: + + .. code-block:: none + + GRANT ALL PRIVILEGES ON watcher.* TO 'watcher'@'localhost' \ + IDENTIFIED BY 'WATCHER_DBPASS'; + GRANT ALL PRIVILEGES ON watcher.* TO 'watcher'@'%' \ + IDENTIFIED BY 'WATCHER_DBPASS'; + + Replace ``WATCHER_DBPASS`` with a suitable password. + + * Exit the database access client. + + .. code-block:: none + + exit; + +2. Source the ``admin`` credentials to gain access to + admin-only CLI commands: + + .. code-block:: console + + $ . admin-openrc + +3. To create the service credentials, complete these steps: + + * Create the ``watcher`` user: + + .. code-block:: console + + $ openstack user create --domain default --password-prompt watcher + User Password: + Repeat User Password: + +---------------------+----------------------------------+ + | Field | Value | + +---------------------+----------------------------------+ + | domain_id | default | + | enabled | True | + | id | b18ee38e06034b748141beda8fc8bfad | + | name | watcher | + | options | {} | + | password_expires_at | None | + +---------------------+----------------------------------+ + + + * Add the ``admin`` role to the ``watcher`` user: + + .. code-block:: console + + $ openstack role add --project service --user watcher admin + + .. note:: + + This command produces no output. + + * Create the watcher service entities: + + .. code-block:: console + + $ openstack service create --name watcher --description "Infrastructure Optimization" infra-optim + +-------------+----------------------------------+ + | Field | Value | + +-------------+----------------------------------+ + | description | Infrastructure Optimization | + | enabled | True | + | id | d854f6fff0a64f77bda8003c8dedfada | + | name | watcher | + | type | infra-optim | + +-------------+----------------------------------+ + + +4. Create the Infrastructure Optimization service API endpoints: + + .. code-block:: console + + $ openstack endpoint create --region RegionOne \ + infra-optim public http://controller:9322 + +-------------+----------------------------------+ + | Field | Value | + +-------------+----------------------------------+ + | description | Infrastructure Optimization | + | enabled | True | + | id | d854f6fff0a64f77bda8003c8dedfada | + | name | watcher | + | type | infra-optim | + +-------------+----------------------------------+ + + $ openstack endpoint create --region RegionOne \ + infra-optim internal http://controller:9322 + +--------------+----------------------------------+ + | Field | Value | + +--------------+----------------------------------+ + | enabled | True | + | id | 225aef8465ef4df48a341aaaf2b0a390 | + | interface | internal | + | region | RegionOne | + | region_id | RegionOne | + | service_id | d854f6fff0a64f77bda8003c8dedfada | + | service_name | watcher | + | service_type | infra-optim | + | url | http://controller:9322 | + +--------------+----------------------------------+ + + $ openstack endpoint create --region RegionOne \ + infra-optim admin http://controller:9322 + +--------------+----------------------------------+ + | Field | Value | + +--------------+----------------------------------+ + | enabled | True | + | id | 375eb5057fb546edbdf3ee4866179672 | + | interface | admin | + | region | RegionOne | + | region_id | RegionOne | + | service_id | d854f6fff0a64f77bda8003c8dedfada | + | service_name | watcher | + | service_type | infra-optim | + | url | http://controller:9322 | + +--------------+----------------------------------+ diff --git a/install-guide/source/conf.py b/install-guide/source/conf.py new file mode 100644 index 0000000..01b0eb5 --- /dev/null +++ b/install-guide/source/conf.py @@ -0,0 +1,301 @@ +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or +# implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# This file is execfile()d with the current directory set to its +# containing dir. +# +# Note that not all possible configuration values are present in this +# autogenerated file. +# +# All configuration values have a default; values that are commented out +# serve to show the default. + +import os +# import sys + + +import openstackdocstheme + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +# sys.path.insert(0, os.path.abspath('.')) + +# -- General configuration ------------------------------------------------ + +# If your documentation needs a minimal Sphinx version, state it here. +# needs_sphinx = '1.0' + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +# TODO(ajaeger): enable PDF building, for example add 'rst2pdf.pdfbuilder' +# extensions = + +# Add any paths that contain templates here, relative to this directory. +# templates_path = ['_templates'] + +# The suffix of source filenames. +source_suffix = '.rst' + +# The encoding of source files. +# source_encoding = 'utf-8-sig' + +# The master toctree document. +master_doc = 'index' + +# General information about the project. +project = u'Installation Guide for Infrastructure Optimization Service' +bug_tag = u'install-guide' +copyright = u'2016, OpenStack contributors' + +# The version info for the project you're documenting, acts as replacement for +# |version| and |release|, also used in various other places throughout the +# built documents. +# +# The short X.Y version. +version = '0.1' +# The full version, including alpha/beta/rc tags. +release = '0.1' + +# A few variables have to be set for the log-a-bug feature. +# giturl: The location of conf.py on Git. Must be set manually. +# gitsha: The SHA checksum of the bug description. Automatically extracted +# from git log. +# bug_tag: Tag for categorizing the bug. Must be set manually. +# These variables are passed to the logabug code via html_context. +giturl = u'http://git.openstack.org/cgit/openstack/watcher/tree/install-guide/source' # noqa +git_cmd = "/usr/bin/git log | head -n1 | cut -f2 -d' '" +gitsha = os.popen(git_cmd).read().strip('\n') +html_context = {"gitsha": gitsha, "bug_tag": bug_tag, + "giturl": giturl, + "bug_project": "watcher"} + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +# language = None + +# There are two options for replacing |today|: either, you set today to some +# non-false value, then it is used: +# today = '' +# Else, today_fmt is used as the format for a strftime call. +# today_fmt = '%B %d, %Y' + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +exclude_patterns = ["common_prerequisites.rst", "common_configure.rst"] + +# The reST default role (used for this markup: `text`) to use for all +# documents. +# default_role = None + +# If true, '()' will be appended to :func: etc. cross-reference text. +# add_function_parentheses = True + +# If true, the current module name will be prepended to all description +# unit titles (such as .. function::). +# add_module_names = True + +# If true, sectionauthor and moduleauthor directives will be shown in the +# output. They are ignored by default. +# show_authors = False + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' + +# A list of ignored prefixes for module index sorting. +# modindex_common_prefix = [] + +# If true, keep warnings as "system message" paragraphs in the built documents. +# keep_warnings = False + + +# -- Options for HTML output ---------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +html_theme = 'openstackdocs' + +# Theme options are theme-specific and customize the look and feel of a theme +# further. For a list of options available for each theme, see the +# documentation. +# html_theme_options = {} + +# Add any paths that contain custom themes here, relative to this directory. +html_theme_path = [openstackdocstheme.get_html_theme_path()] + +# The name for this set of Sphinx documents. If None, it defaults to +# " v documentation". +# html_title = None + +# A shorter title for the navigation bar. Default is the same as html_title. +# html_short_title = None + +# The name of an image file (relative to this directory) to place at the top +# of the sidebar. +# html_logo = None + +# The name of an image file (within the static path) to use as favicon of the +# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 +# pixels large. +# html_favicon = None + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +# html_static_path = [] + +# Add any extra paths that contain custom files (such as robots.txt or +# .htaccess) here, relative to this directory. These files are copied +# directly to the root of the documentation. +# html_extra_path = [] + +# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, +# using the given strftime format. +# So that we can enable "log-a-bug" links from each output HTML page, this +# variable must be set to a format that includes year, month, day, hours and +# minutes. +html_last_updated_fmt = '%Y-%m-%d %H:%M' + + +# If true, SmartyPants will be used to convert quotes and dashes to +# typographically correct entities. +# html_use_smartypants = True + +# Custom sidebar templates, maps document names to template names. +# html_sidebars = {} + +# Additional templates that should be rendered to pages, maps page names to +# template names. +# html_additional_pages = {} + +# If false, no module index is generated. +# html_domain_indices = True + +# If false, no index is generated. +html_use_index = False + +# If true, the index is split into individual pages for each letter. +# html_split_index = False + +# If true, links to the reST sources are added to the pages. +html_show_sourcelink = False + +# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. +# html_show_sphinx = True + +# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. +# html_show_copyright = True + +# If true, an OpenSearch description file will be output, and all pages will +# contain a tag referring to it. The value of this option must be the +# base URL from which the finished HTML is served. +# html_use_opensearch = '' + +# This is the file name suffix for HTML files (e.g. ".xhtml"). +# html_file_suffix = None + +# Output file base name for HTML help builder. +htmlhelp_basename = 'install-guide' + +# If true, publish source files +html_copy_source = False + +# -- Options for LaTeX output --------------------------------------------- + +latex_elements = { + # The paper size ('letterpaper' or 'a4paper'). + # 'papersize': 'letterpaper', + + # The font size ('10pt', '11pt' or '12pt'). + # 'pointsize': '10pt', + + # Additional stuff for the LaTeX preamble. + # 'preamble': '', +} + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, +# author, documentclass [howto, manual, or own class]). +latex_documents = [ + ('index', 'InstallGuide.tex', u'Install Guide', + u'OpenStack contributors', 'manual'), +] + +# The name of an image file (relative to this directory) to place at the top of +# the title page. +# latex_logo = None + +# For "manual" documents, if this is true, then toplevel headings are parts, +# not chapters. +# latex_use_parts = False + +# If true, show page references after internal links. +# latex_show_pagerefs = False + +# If true, show URL addresses after external links. +# latex_show_urls = False + +# Documents to append as an appendix to all manuals. +# latex_appendices = [] + +# If false, no module index is generated. +# latex_domain_indices = True + + +# -- Options for manual page output --------------------------------------- + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + ('index', 'installguide', u'Install Guide', + [u'OpenStack contributors'], 1) +] + +# If true, show URL addresses after external links. +# man_show_urls = False + + +# -- Options for Texinfo output ------------------------------------------- + +# Grouping the document tree into Texinfo files. List of tuples +# (source start file, target name, title, author, +# dir menu entry, description, category) +texinfo_documents = [ + ('index', 'InstallGuide', u'Install Guide', + u'OpenStack contributors', 'InstallGuide', + 'This guide shows OpenStack end users how to install ' + 'an OpenStack cloud.', 'Miscellaneous'), +] + +# Documents to append as an appendix to all manuals. +# texinfo_appendices = [] + +# If false, no module index is generated. +# texinfo_domain_indices = True + +# How to display URL addresses: 'footnote', 'no', or 'inline'. +# texinfo_show_urls = 'footnote' + +# If true, do not generate a @detailmenu in the "Top" node's menu. +# texinfo_no_detailmenu = False + +# -- Options for Internationalization output ------------------------------ +locale_dirs = ['locale/'] + +# -- Options for PDF output -------------------------------------------------- + +pdf_documents = [ + ('index', u'InstallGuide', u'Install Guide', + u'OpenStack contributors') +] diff --git a/install-guide/source/get_started.rst b/install-guide/source/get_started.rst new file mode 100644 index 0000000..44a85ad --- /dev/null +++ b/install-guide/source/get_started.rst @@ -0,0 +1,27 @@ +============================================ +Infrastructure Optimization service overview +============================================ +The Infrastructure Optimization service provides flexible and scalable +optimization service for multi-tenant OpenStack based clouds. + +The Infrastructure Optimization service consists of the following components: + +``watcher`` command-line client + A CLI to communicate with ``watcher-api`` to optimize the cloud. + +``watcher-api`` service + An OpenStack-native REST API that accepts and responds to end-user calls + by processing them and forwarding to appropriate underlying watcher + services via AMQP. + +``watcher-decision-engine`` service + It runs audit and return an action plan to achieve optimization goal + specified by the end-user in audit. + +``watcher-applier`` service + It executes action plan built by watcher-decision-engine. It interacts with + other OpenStack components like nova to execute the given action + plan. + +``watcher-dashboard`` + Watcher UI implemented as a plugin for the OpenStack Dashboard. diff --git a/install-guide/source/index.rst b/install-guide/source/index.rst new file mode 100644 index 0000000..7c9aa73 --- /dev/null +++ b/install-guide/source/index.rst @@ -0,0 +1,39 @@ +=================================== +Infrastructure Optimization service +=================================== + +.. toctree:: + :maxdepth: 2 + + get_started.rst + install.rst + verify.rst + next-steps.rst + +The Infrastructure Optimization service (watcher) provides +flexible and scalable resource optimization service for +multi-tenant OpenStack-based clouds. + +Watcher provides a complete optimization loop including +everything from a metrics receiver, complex event processor +and profiler, optimization processor and an action plan +applier. This provides a robust framework to realize a wide +range of cloud optimization goals, including the reduction +of data center operating costs, increased system performance +via intelligent virtual machine migration, increased energy +efficiency—and more! + +watcher also supports a pluggable architecture by which custom +optimization algorithms, data metrics and data profilers can be +developed and inserted into the Watcher framework. + +check the documentation for watcher optimization strategies at +https://docs.openstack.org/developer/watcher/strategies + +check watcher glossary at +https://docs.openstack.org/developer/watcher/glossary.html + + +This chapter assumes a working setup of OpenStack following the +`OpenStack Installation Tutorial +`_. diff --git a/install-guide/source/install-obs.rst b/install-guide/source/install-obs.rst new file mode 100644 index 0000000..4805c15 --- /dev/null +++ b/install-guide/source/install-obs.rst @@ -0,0 +1,34 @@ +.. _install-obs: + + +Install and configure for openSUSE and SUSE Linux Enterprise +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +This section describes how to install and configure the Infrastructure Optimization service +for openSUSE Leap 42.1 and SUSE Linux Enterprise Server 12 SP1. + +.. include:: common_prerequisites.rst + +Install and configure components +-------------------------------- + +#. Install the packages: + + .. code-block:: console + + # zypper --quiet --non-interactive install + +.. include:: common_configure.rst + + +Finalize installation +--------------------- + +Start the Infrastructure Optimization services and configure them to start when +the system boots: + +.. code-block:: console + + # systemctl enable openstack-watcher-api.service + + # systemctl start openstack-watcher-api.service diff --git a/install-guide/source/install-rdo.rst b/install-guide/source/install-rdo.rst new file mode 100644 index 0000000..9215be9 --- /dev/null +++ b/install-guide/source/install-rdo.rst @@ -0,0 +1,38 @@ +.. _install-rdo: + +Install and configure for Red Hat Enterprise Linux and CentOS +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + + +This section describes how to install and configure the Infrastructure Optimization service +for Red Hat Enterprise Linux 7 and CentOS 7. + +.. include:: common_prerequisites.rst + +Install and configure components +-------------------------------- + +1. Install the packages: + + .. code-block:: console + + # sudo yum install openstack-watcher-api openstack-watcher-applier \ + openstack-watcher-decision-engine + +.. include:: common_configure.rst + +Finalize installation +--------------------- + +Start the Infrastructure Optimization services and configure them to start when +the system boots: + +.. code-block:: console + + # systemctl enable openstack-watcher-api.service \ + openstack-watcher-decision-engine.service \ + openstack-watcher-applier.service + + # systemctl start openstack-watcher-api.service \ + openstack-watcher-decision-engine.service \ + openstack-watcher-applier.service diff --git a/install-guide/source/install-ubuntu.rst b/install-guide/source/install-ubuntu.rst new file mode 100644 index 0000000..e913b8a --- /dev/null +++ b/install-guide/source/install-ubuntu.rst @@ -0,0 +1,34 @@ +.. _install-ubuntu: + +Install and configure for Ubuntu +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +This section describes how to install and configure the Infrastructure Optimization +service for Ubuntu 14.04 (LTS). + +.. include:: common_prerequisites.rst + +Install and configure components +-------------------------------- + +1. Install the packages: + + .. code-block:: console + + # apt install watcher-api watcher-decision-engine \ + watcher-applier + + # apt install python-watcherclient + +.. include:: common_configure.rst + +Finalize installation +--------------------- + +Restart the Infrastructure Optimization services: + +.. code-block:: console + + # service watcher-api restart + # service watcher-decision-engine restart + # service watcher-applier restart diff --git a/install-guide/source/install.rst b/install-guide/source/install.rst new file mode 100644 index 0000000..a235f9c --- /dev/null +++ b/install-guide/source/install.rst @@ -0,0 +1,20 @@ +.. _install: + +Install and configure +~~~~~~~~~~~~~~~~~~~~~ + +This section describes how to install and configure the +Infrastructure Optimization service, code-named watcher, on the controller node. + +This section assumes that you already have a working OpenStack +environment with at least the following components installed: +Identity Service, Compute Service, Telemetry data collection service. + +Note that installation and configuration vary by distribution. + +.. toctree:: + :maxdepth: 2 + + install-obs.rst + install-rdo.rst + install-ubuntu.rst diff --git a/install-guide/source/next-steps.rst b/install-guide/source/next-steps.rst new file mode 100644 index 0000000..c07654b --- /dev/null +++ b/install-guide/source/next-steps.rst @@ -0,0 +1,9 @@ +.. _next-steps: + +Next steps +~~~~~~~~~~ + +Your OpenStack environment now includes the watcher service. + +To add additional services, see +https://docs.openstack.org/project-install-guide/ocata/. diff --git a/install-guide/source/verify.rst b/install-guide/source/verify.rst new file mode 100644 index 0000000..e901146 --- /dev/null +++ b/install-guide/source/verify.rst @@ -0,0 +1,119 @@ +.. _verify: + +Verify operation +~~~~~~~~~~~~~~~~ + +Verify operation of the Infrastructure Optimization service. + +.. note:: + + Perform these commands on the controller node. + +1. Source the ``admin`` project credentials to gain access to + admin-only CLI commands: + + .. code-block:: console + + $ . admin-openrc + +2. List service components to verify successful launch and registration + of each process: + + .. code-block:: console + + $ openstack optimize service list + +----+-------------------------+------------+--------+ + | ID | Name | Host | Status | + +----+-------------------------+------------+--------+ + | 1 | watcher-decision-engine | controller | ACTIVE | + | 2 | watcher-applier | controller | ACTIVE | + +----+-------------------------+------------+--------+ + +3. List goals and strategies: + + .. code-block:: console + + $ openstack optimize goal list + +--------------------------------------+----------------------+----------------------+ + | UUID | Name | Display name | + +--------------------------------------+----------------------+----------------------+ + | a8cd6d1a-008b-4ff0-8dbc-b30493fcc5b9 | dummy | Dummy goal | + | 03953f2f-02d0-42b5-9a12-7ba500a54395 | workload_balancing | Workload Balancing | + | de0f8714-984b-4d6b-add1-9cad8120fbce | server_consolidation | Server Consolidation | + | f056bc80-c6d1-40dc-b002-938ccade9385 | thermal_optimization | Thermal Optimization | + | e7062856-892e-4f0f-b84d-b828464b3fd0 | airflow_optimization | Airflow Optimization | + | 1f038da9-b36c-449f-9f04-c225bf3eb478 | unclassified | Unclassified | + +--------------------------------------+----------------------+----------------------+ + + $ openstack optimize strategy list + +--------------------------------------+---------------------------+---------------------------------------------+----------------------+ + | UUID | Name | Display name | Goal | + +--------------------------------------+---------------------------+---------------------------------------------+----------------------+ + | 98ae84c8-7c9b-4cbd-8d9c-4bd7c6b106eb | dummy | Dummy strategy | dummy | + | 02a170b6-c72e-479d-95c0-8a4fdd4cc1ef | dummy_with_scorer | Dummy Strategy using sample Scoring Engines | dummy | + | 8bf591b8-57e5-4a9e-8c7d-c37bda735a45 | outlet_temperature | Outlet temperature based strategy | thermal_optimization | + | 8a0810fb-9d9a-47b9-ab25-e442878abc54 | vm_workload_consolidation | VM Workload Consolidation Strategy | server_consolidation | + | 1718859c-3eb5-45cb-9220-9cb79fe42fa5 | basic | Basic offline consolidation | server_consolidation | + | b5e7f5f1-4824-42c7-bb52-cf50724f67bf | workload_stabilization | Workload stabilization | workload_balancing | + | f853d71e-9286-4df3-9d3e-8eaf0f598e07 | workload_balance | Workload Balance Migration Strategy | workload_balancing | + | 58bdfa89-95b5-4630-adf6-fd3af5ff1f75 | uniform_airflow | Uniform airflow migration strategy | airflow_optimization | + | 66fde55d-a612-4be9-8cb0-ea63472b420b | dummy_with_resize | Dummy strategy with resize | dummy | + +--------------------------------------+---------------------------+---------------------------------------------+----------------------+ + +4. Run an action plan by creating an audit with dummy goal: + + .. code-block:: console + + $ openstack optimize audit create --goal dummy + +--------------+--------------------------------------+ + | Field | Value | + +--------------+--------------------------------------+ + | UUID | e94d4826-ad4e-44df-ad93-dff489fde457 | + | Created At | 2017-05-23T11:46:58.763394+00:00 | + | Updated At | None | + | Deleted At | None | + | State | PENDING | + | Audit Type | ONESHOT | + | Parameters | {} | + | Interval | None | + | Goal | dummy | + | Strategy | auto | + | Audit Scope | [] | + | Auto Trigger | False | + +--------------+--------------------------------------+ + + $ openstack optimize audit list + +--------------------------------------+------------+-----------+-------+----------+--------------+ + | UUID | Audit Type | State | Goal | Strategy | Auto Trigger | + +--------------------------------------+------------+-----------+-------+----------+--------------+ + | e94d4826-ad4e-44df-ad93-dff489fde457 | ONESHOT | SUCCEEDED | dummy | auto | False | + +--------------------------------------+------------+-----------+-------+----------+--------------+ + + $ openstack optimize actionplan list + +--------------------------------------+--------------------------------------+-------------+------------+-----------------+ + | UUID | Audit | State | Updated At | Global efficacy | + +--------------------------------------+--------------------------------------+-------------+------------+-----------------+ + | ba9ce6b3-969c-4b8e-bb61-ae24e8630f81 | e94d4826-ad4e-44df-ad93-dff489fde457 | RECOMMENDED | None | None | + +--------------------------------------+--------------------------------------+-------------+------------+-----------------+ + + $ openstack optimize actionplan start ba9ce6b3-969c-4b8e-bb61-ae24e8630f81 + +---------------------+--------------------------------------+ + | Field | Value | + +---------------------+--------------------------------------+ + | UUID | ba9ce6b3-969c-4b8e-bb61-ae24e8630f81 | + | Created At | 2017-05-23T11:46:58+00:00 | + | Updated At | 2017-05-23T11:53:12+00:00 | + | Deleted At | None | + | Audit | e94d4826-ad4e-44df-ad93-dff489fde457 | + | Strategy | dummy | + | State | ONGOING | + | Efficacy indicators | [] | + | Global efficacy | {} | + +---------------------+--------------------------------------+ + + $ openstack optimize actionplan list + +--------------------------------------+--------------------------------------+-----------+---------------------------+-----------------+ + | UUID | Audit | State | Updated At | Global efficacy | + +--------------------------------------+--------------------------------------+-----------+---------------------------+-----------------+ + | ba9ce6b3-969c-4b8e-bb61-ae24e8630f81 | e94d4826-ad4e-44df-ad93-dff489fde457 | SUCCEEDED | 2017-05-23T11:53:16+00:00 | None | + +--------------------------------------+--------------------------------------+-----------+---------------------------+-----------------+ diff --git a/test-requirements.txt b/test-requirements.txt index 843875e..c92e888 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -15,10 +15,12 @@ testscenarios>=0.4 # Apache-2.0/BSD testtools>=1.4.0 # MIT # Doc requirements +openstackdocstheme>=1.5.0 # Apache-2.0 oslosphinx>=4.7.0 # Apache-2.0 sphinx!=1.6.1,>=1.5.1 # BSD sphinxcontrib-pecanwsme>=0.8 # Apache-2.0 + # releasenotes reno>=1.8.0 # Apache-2.0 diff --git a/tox.ini b/tox.ini index ff797ad..a5e702c 100644 --- a/tox.ini +++ b/tox.ini @@ -68,3 +68,6 @@ commands = sphinx-build -a -W -E -d releasenotes/build/doctrees -b html releasen [testenv:bandit] deps = -r{toxinidir}/test-requirements.txt commands = bandit -r watcher -x tests -n5 -ll -s B320 + +[testenv:install-guide] +commands = sphinx-build -a -E -W -d install-guide/build/doctrees -b html install-guide/source install-guide/build/html