added qa doc

This commit is contained in:
Dirk Wallerstorfer 2016-12-05 13:45:14 +01:00
parent 052f93d76c
commit 1f05189319
6 changed files with 584 additions and 0 deletions

View File

@ -0,0 +1,4 @@
Appendix
========
Provide any links to external resources or documentation here.

341
doc/qa/source/conf.py Normal file
View File

@ -0,0 +1,341 @@
# -*- coding: utf-8 -*-
#
# plugin name documentation build configuration file, created by
# sphinx-quickstart on Wed Oct 7 12:48:35 2015.
#
# 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 sys
import os
# 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.
extensions = [
# 'sphinx.ext.todo',
# 'sphinx.ext.coverage',
]
# 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'Dynatrace plugin for Fuel'
copyright = u'2016, Dynatrace LLC'
# 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 = '1.0'
# The full version, including alpha/beta/rc tags.
release = '1.0-1.0.0-1'
# 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 = []
# 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 = 'default'
# 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 = []
# The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> 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 = ['_static']
# 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.
#html_last_updated_fmt = '%b %d, %Y'
# 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 = True
# 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 = True
# 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 <link> 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 = 'Dynatrace-doc'
# -- 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', 'fuel-plugin-dynatrace-qa.tex', u'Dynatrace plugin for Fuel Test Plan',
u'Dynatrace LLC.', '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
# make latex stop printing blank pages between sections
# http://stackoverflow.com/questions/5422997/sphinx-docs-remove-blank-pages-from-generated-pdfs
latex_elements = { 'classoptions': ',openany,oneside', 'babel' : '\\usepackage[english]{babel}' }
# -- Options for manual page output ---------------------------------------
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
('index', 'fuel-plugin-openbook', u'Guide to the Openbook Plugin ver. 1.1-1.1.0-1 for Fuel',
[u'Talligent Inc.'], 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', 'Dynatrace', u'Dynatrace Plugin for Fuel Test Plan',
u'Dynatrace LLC.', 'Dynatrace', 'Dynatrace Plugin for Fuel Test Plan',
'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
# Insert footnotes where they are defined instead of
# at the end.
pdf_inline_footnotes = True
# -- Options for Epub output ----------------------------------------------
# Bibliographic Dublin Core info.
#epub_title = u'The Openbook Plugin for Fuel'
#epub_author = u'Talligent Inc.'
#epub_publisher = u'Talligent Inc.'
#epub_copyright = u'2015, Talligent Inc.'
# The basename for the epub file. It defaults to the project name.
#epub_basename = u'fuel-plugin-openbook'
# The HTML theme for the epub output. Since the default themes are not optimized
# for small screen space, using the same theme for HTML and epub output is
# usually not wise. This defaults to 'epub', a theme designed to save visual
# space.
#epub_theme = 'epub'
# The language of the text. It defaults to the language option
# or en if the language is not set.
#epub_language = ''
# The scheme of the identifier. Typical schemes are ISBN or URL.
#epub_scheme = ''
# The unique identifier of the text. This can be a ISBN number
# or the project homepage.
#epub_identifier = ''
# A unique identification for the text.
#epub_uid = ''
# A tuple containing the cover image and cover page html template filenames.
#epub_cover = ()
# A sequence of (type, uri, title) tuples for the guide element of content.opf.
#epub_guide = ()
# HTML files that should be inserted before the pages created by sphinx.
# The format is a list of tuples containing the path and title.
#epub_pre_files = []
# HTML files shat should be inserted after the pages created by sphinx.
# The format is a list of tuples containing the path and title.
#epub_post_files = []
# A list of files that should not be packed into the epub file.
#epub_exclude_files = ['search.html']
# The depth of the table of contents in toc.ncx.
#epub_tocdepth = 3
# Allow duplicate toc entries.
#epub_tocdup = True
# Choose between 'default' and 'includehidden'.
#epub_tocscope = 'default'
# Fix unsupported image types using the PIL.
#epub_fix_images = False
# Scale large images.
#epub_max_image_width = 0
# How to display URL addresses: 'footnote', 'no', or 'inline'.
#epub_show_urls = 'inline'
# If false, no index is generated.
#epub_use_index = True

13
doc/qa/source/index.rst Normal file
View File

@ -0,0 +1,13 @@
.. _fuel-plugin-dynatrace:
Test Plan to the Dynatrace plugin version 1.0-1.0.0-1 for Fuel 9.0
==============================================================
.. toctree::
:maxdepth: 2
:numbered:
overview
teststrategy
systemtesting
appendix

View File

@ -0,0 +1,29 @@
Overview
========
The Dynatrace Fuel plugin introduces two new node roles called *Dynatrace
OneAgent* and *Dynatrace Security Gateway*. In order to work properly you need
an active Dynatrace account (free trial also works) and access to your SaaS
account or a Dynatrace Managed node/cluster on premise.
* Dynatrace OneAgent
The *Dynatrace OneAgent* role must be applied to all nodes
in your environment that have the Controller role. The OneAgent instruments the
OpenStack services and also the supporting services like MySQL, RabbitMQ,
Memcached, HAproxy, ... and sends all monitoring and log data to the node with
*Dynatrace Security Gateway* role.
* Dynatrace Security Gateway
The *Dynatrace Security Gateway* role must be
applied to a standalone physical machine, where no other OpenStack service is
running. If you plan to use Dynatrace for monitoring your applications that run
on top of OpenStack as well, you need to make sure that the VMs where the
Dynatrace OneAgent is installed have network access to the *Dynatrace Security
Gateway* node.
Developer's specification
-------------------------
https://github.com/Dynatrace/fuel-plugin-dynatrace/blob/master/specs/spec.rst
Limitations
-----------
Dynatrace Fuel plugin version 1.0.0 has been developed for Fuel 9.0/9.1.

View File

@ -0,0 +1,171 @@
System Test Scenarios
=====================
**Install plugin and deploy environment**
=============== =====
Test Case ID install_plugin_deploy_env
--------------- -----
Steps 1. Install plugin using Fuel CLI, refer to the `Installation
Guide <http://docs.openstack.org/developer/fuel-docs/user
docs/fuel-install-guide/plugins/plugins_install_plugins.h
tml>`_
#. Ensure plugin is successfully installed, as in the
`Installation Guide <http://docs.openstack.org/developer/
fuel-docs/userdocs/fuel-install-guide/plugins/plugins_ins
tall_plugins.html>`_
#. Create environment with enabled plugin in Fuel Web UI
#. Add 3 controller nodes and apply the Dynatrace OneAgent
role to all 3, 1 compute node, and 1 Dynatrace Security
Gateway node
#. Run network verification
#. Deploy the cluster
#. Verify there were no error messages during the deployment
#. Run health check
--------------- -----
Expected Result Plugin is installed successfully. Dynatrace OneAgent is
installed on the controller nodes. Dynatrace Security
Gateway is setup successfully. All OSTF tests pass.
Environment is deployed successfully.
=============== =====
**Modifying environment with enabled plugin (remove/add controller nodes)**
=============== =====
Test Case ID modify_env_with_plugin_remove_add_controller
--------------- -----
Steps 1. Install plugin using Fuel CLI, refer to the `Installation
Guide <http://docs.openstack.org/developer/fuel-docs/user
docs/fuel-install-guide/plugins/plugins_install_plugins.h
tml>`_
#. Ensure plugin is successfully installed, as in the
`Installation Guide <http://docs.openstack.org/developer/
fuel-docs/userdocs/fuel-install-guide/plugins/plugins_ins
tall_plugins.html>`_
#. Create environment with enabled plugin in Fuel Web UI
#. Add 3 controller nodes and apply the Dynatrace OneAgent
role to all 3, 1 compute node, and 1 Dynatrace Security
Gateway node
#. Run network verification
#. Deploy the cluster
#. Verify there were no error messages during the deployment
#. Run OpenStack health check
#. Remove 1 controller node
#. Redeploy the cluster
#. Run health check
#. Add 1 new controller node
#. Redeploy the cluster
#. Run health check
--------------- -----
Expected Result Plugin is installed successfully. Dynatrace OneAgent is
installed on the controller nodes. Dynatrace Security
Gateway is setup successfully. All OSTF tests pass.
Environment is deployed successfully. The environment is
redeployed successfully when adding/removing a controller
node.
=============== =====
**Modifying environment with enabled plugin (remove/add compute nodes)**
=============== =====
Test Case ID modify_env_with_plugin_remove_add_compute
--------------- -----
Steps 1. Install plugin using Fuel CLI, refer to the `Installation
Guide <http://docs.openstack.org/developer/fuel-docs/user
docs/fuel-install-guide/plugins/plugins_install_plugins.h
tml>`_
#. Ensure plugin is successfully installed, as in the
`Installation Guide <http://docs.openstack.org/developer/
fuel-docs/userdocs/fuel-install-guide/plugins/plugins_ins
tall_plugins.html>`_
#. Create environment with enabled plugin in Fuel Web UI
#. Add 3 controller nodes and apply the Dynatrace OneAgent
role to all 3, 1 compute node, and 1 Dynatrace Security
Gateway node
#. Run network verification
#. Deploy the cluster
#. Verify there were no error messages during the deployment
#. Run health check
#. Add 1 compute node
#. Redeploy the cluster
#. Run health check
#. Remove 1 compute node
#. Redeploy the cluster
#. Run health check
--------------- -----
Expected Result Plugin is installed successfully. Dynatrace OneAgent is
installed on the controller nodes. Dynatrace Security
Gateway is setup successfully. All OSTF tests pass.
Environment is deployed successfully. The environment is
redeployed successfully when adding/removing a compute
node.
=============== =====
**Uninstall of plugin in the deployed environment**
=============== =====
Test Case ID uninstall_plugin_with_deployed_env
--------------- -----
Steps 1. Install plugin using Fuel CLI, refer to the `Installation
Guide <http://docs.openstack.org/developer/fuel-docs/user
docs/fuel-install-guide/plugins/plugins_install_plugins.h
tml>`_
#. Ensure plugin is successfully installed, as in the
`Installation Guide <http://docs.openstack.org/developer/
fuel-docs/userdocs/fuel-install-guide/plugins/plugins_ins
tall_plugins.html>`_
#. Create environment with enabled plugin in Fuel Web UI
#. Add 3 controller nodes and apply the Dynatrace OneAgent
role to all 3, 1 compute node, and 1 Dynatrace Security
Gateway node
#. Run network verification
#. Deploy the cluster
#. Verify there were no error messages during the deployment
#. Run health check
#. Uninstall the plugin with running
``fuel plugins --remove <plugin-name>==<plugin_version>``
#. Ensure that the following output appears in CLI:
*"400 Client Error: Bad Request (Can't delete
plugin which is enabled for some environment.)"*
--------------- -----
Expected Result Plugin is installed successfully. Dynatrace OneAgent is
installed on the controller nodes. Dynatrace Security
Gateway is setup successfully. All OSTF tests pass.
Environment is deployed successfully. An alert is
displayed when trying to uninstall the plugin.
=============== =====
**Uninstall of plugin in the non-deployed environment**
=============== =====
Test Case ID uninstall_plugin
--------------- -----
Steps 1. Install plugin using Fuel CLI, refer to the `Installation
Guide <http://docs.openstack.org/developer/fuel-docs/user
docs/fuel-install-guide/plugins/plugins_install_plugins.h
tml>`_
#. Ensure plugin is successfully installed, as in the
`Installation Guide <http://docs.openstack.org/developer/
fuel-docs/userdocs/fuel-install-guide/plugins/plugins_ins
tall_plugins.html>`_
#. Create environment with enabled plugin in Fuel Web UI
#. Add 3 controller nodes and apply the Dynatrace OneAgent
role to all 3, 1 compute node, and 1 Dynatrace Security
Gateway node
#. Run network verification
#. Delete listed environment
#. Uninstall the plugin with running
``fuel plugins --remove <plugin-name>==<plugin_version>``
--------------- -----
Expected Result Plugin is installed successfully. The cluster is created and
network verification is passed. The plugin is enabled and
configured in the Fuel Web UI. When uninstalling the plugin,
no plugin-related elements are left in the environment (e.g.
UI elements disappear, Nailgun database is restored to the
default state, no output for command "fuel plugins --list").
=============== =====

View File

@ -0,0 +1,26 @@
Test Strategy
=============
Dynatrace Fuel plugin is a non-intrusive plugin for Fuel, that doesn't modify or replace any standard OpenStack service. It provides the Dynatrace monitoring solution for the OpenStack control plane services and also monitoring for the applications, if you choose to install Dynatrace in your workloads as well. The plugin installs the Dynatrace Security Gateway and the Dynatrace OneAgent. The goal of the tests is to ensure that the installation of the Dynatrace components was successful and that the OpenStack services work as intended.
Acceptance Criteria
-------------------
All OSTF test should pass to ensure correct functionality of Fuel and the OpenStack cluster.
Test environment, infrastructure, and tools
-------------------------------------------
The plugin installs the Dynatrace OneAgent and the Dynatrace Security Gateway. The Dynatrace OneAgent runs on all major operating systems (see [1] for details). The Dynatrace Security Gateway should be installed on a dedicated physical or virtual machine. Find the requirements for the Dynatrace Security Gateway here [2].
To successfully operate Dynatrace, you also need a Dynatrace account with either a Dynatrace SaaS or Dynatrace Managed (on premise) environment. You can start a free trial [3] to setup a new environment or use your existing account. You will need the ID of your environment, the security token of your environment, and, if you use Dynatrace Managed, the IP address or domain name of the server where Dynatrace Managed is running for a successful setup of the Dynatrace OneAgent and the Dynatrace Security Gateway.
[1] Which environments and version does Dynatrace support?
https://help.dynatrace.com/get-started/welcome/which-environments-and-versions-does-dynatrace-support/
[2] Requirements for the Dynatrace Security Gateway?
https://help.dynatrace.com/get-started/install/how-do-i-install-dynatrace-security-gateway/
[3] Start 30-day free Dynatrace trial
https://www.dynatrace.com/trial/
Product compatibility matrix
----------------------------
Dynatrace plugin is developed for Fuel 9.0/9.1. It works with all major operating systems (https://help.dynatrace.com/get-started/welcome/which-environments-and-versions-does-dynatrace-support/).