[Docs] OpenStack Telemetry plugin

* Adds the structure for the OpenStack Telemetry plugin documentation.
* Adds content

Co-Authored-By: Nadya Shakhat <nprivalova@mirantis.com>

Change-Id: I68de3e5f9eea4d2c5709a641beb051e0729f5b28
This commit is contained in:
Maria Zlatkova 2016-09-27 14:35:35 +03:00
parent e1b55627f3
commit 8d720daba7
18 changed files with 1083 additions and 0 deletions

224
docs/Makefile Normal file
View File

@ -0,0 +1,224 @@
# Makefile for Sphinx documentation
#
# You can set these variables from the command line.
SPHINXOPTS =
SPHINXBUILD = sphinx-build
PAPER =
BUILDDIR = build
# User-friendly check for sphinx-build
ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
endif
# Internal variables.
PAPEROPT_a4 = -D latex_paper_size=a4
PAPEROPT_letter = -D latex_paper_size=letter
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
# the i18n builder cannot share the environment and doctrees with the others
I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
.PHONY: help
help:
@echo "Please use \`make <target>' where <target> is one of"
@echo " html to make standalone HTML files"
@echo " dirhtml to make HTML files named index.html in directories"
@echo " singlehtml to make a single large HTML file"
@echo " pickle to make pickle files"
@echo " json to make JSON files"
@echo " htmlhelp to make HTML files and a HTML help project"
@echo " qthelp to make HTML files and a qthelp project"
@echo " applehelp to make an Apple Help Book"
@echo " devhelp to make HTML files and a Devhelp project"
@echo " epub to make an epub"
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
@echo " pdf to make pdf with rst2pdf"
@echo " latexpdf to make LaTeX files and run them through pdflatex"
@echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
@echo " text to make text files"
@echo " man to make manual pages"
@echo " texinfo to make Texinfo files"
@echo " info to make Texinfo files and run them through makeinfo"
@echo " gettext to make PO message catalogs"
@echo " changes to make an overview of all changed/added/deprecated items"
@echo " xml to make Docutils-native XML files"
@echo " pseudoxml to make pseudoxml-XML files for display purposes"
@echo " linkcheck to check all external links for integrity"
@echo " doctest to run all doctests embedded in the documentation (if enabled)"
@echo " coverage to run coverage check of the documentation (if enabled)"
.PHONY: clean
clean:
rm -rf $(BUILDDIR)/*
.PHONY: html
html:
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
.PHONY: dirhtml
dirhtml:
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
.PHONY: singlehtml
singlehtml:
$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
@echo
@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
.PHONY: pickle
pickle:
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
@echo
@echo "Build finished; now you can process the pickle files."
.PHONY: json
json:
$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
@echo
@echo "Build finished; now you can process the JSON files."
.PHONY: htmlhelp
htmlhelp:
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
@echo
@echo "Build finished; now you can run HTML Help Workshop with the" \
".hhp project file in $(BUILDDIR)/htmlhelp."
.PHONY: qthelp
qthelp:
$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
@echo
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/OpenStackTelemetrypluginforFuel.qhcp"
@echo "To view the help file:"
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/OpenStackTelemetrypluginforFuel.qhc"
.PHONY: applehelp
applehelp:
$(SPHINXBUILD) -b applehelp $(ALLSPHINXOPTS) $(BUILDDIR)/applehelp
@echo
@echo "Build finished. The help book is in $(BUILDDIR)/applehelp."
@echo "N.B. You won't be able to view it unless you put it in" \
"~/Library/Documentation/Help or install it in your application" \
"bundle."
.PHONY: devhelp
devhelp:
$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
@echo
@echo "Build finished."
@echo "To view the help file:"
@echo "# mkdir -p $$HOME/.local/share/devhelp/OpenStackTelemetrypluginforFuel"
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/OpenStackTelemetrypluginforFuel"
@echo "# devhelp"
.PHONY: epub
epub:
$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
@echo
@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
.PHONY: latex
latex:
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@echo
@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
@echo "Run \`make' in that directory to run these through (pdf)latex" \
"(use \`make latexpdf' here to do that automatically)."
.PHONY: pdf
pdf:
$(SPHINXBUILD) -b pdf $(ALLSPHINXOPTS) $(BUILDDIR)/pdf
@echo
@echo "Build finished. The PDFs are in $(BUILDDIR)/pdf."
.PHONY: latexpdf
latexpdf:
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@echo "Running LaTeX files through pdflatex..."
$(MAKE) -C $(BUILDDIR)/latex all-pdf
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
.PHONY: latexpdfja
latexpdfja:
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@echo "Running LaTeX files through platex and dvipdfmx..."
$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
.PHONY: text
text:
$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
@echo
@echo "Build finished. The text files are in $(BUILDDIR)/text."
.PHONY: man
man:
$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
@echo
@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
.PHONY: texinfo
texinfo:
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
@echo
@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
@echo "Run \`make' in that directory to run these through makeinfo" \
"(use \`make info' here to do that automatically)."
.PHONY: info
info:
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
@echo "Running Texinfo files through makeinfo..."
make -C $(BUILDDIR)/texinfo info
@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
.PHONY: gettext
gettext:
$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
@echo
@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
.PHONY: changes
changes:
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
@echo
@echo "The overview file is in $(BUILDDIR)/changes."
.PHONY: linkcheck
linkcheck:
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
@echo
@echo "Link check complete; look for any errors in the above output " \
"or in $(BUILDDIR)/linkcheck/output.txt."
.PHONY: doctest
doctest:
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
@echo "Testing of doctests in the sources finished, look at the " \
"results in $(BUILDDIR)/doctest/output.txt."
.PHONY: coverage
coverage:
$(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) $(BUILDDIR)/coverage
@echo "Testing of coverage in the sources finished, look at the " \
"results in $(BUILDDIR)/coverage/python.txt."
.PHONY: xml
xml:
$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
@echo
@echo "Build finished. The XML files are in $(BUILDDIR)/xml."
.PHONY: pseudoxml
pseudoxml:
$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
@echo
@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."

View File

@ -0,0 +1,81 @@
.. _architecture:
Architecture overview
---------------------
The Telemetry plugin uses Ceilometer agents to collect data and its own
processing mechanism to put the data into storages. Ceilometer API is used
to retrieve the data and present it to the end user.
The following diagram shows the OpenStack Telemetry plugin architecture:
.. image:: images/arch_diagram.png
:width: 450pt
Ceilometer agents are deployed as follows:
* The central agents service is placed on controllers. This service polls
metrics about OpenStack services. A central agent obtains the measurements
and sends them to the ``notifications.sample`` queue.
.. note:: If Kafka is not deployed, only one central agent will be running
in the environment under Pacemaker. If Kafka is deployed, the
coordination mechanism with Zookeeper will be automatically
enabled.
* Compute agents work on compute nodes and use the same code base as the
central agents. The main difference is the configuration and the fact
that compute agents use metadata cache that is enabled by the Telemetry
plugin. The compute agents request instance metadata from Nova
API every 10 minutes, but not each polling interval. For more information,
see the corresponding
`specification <https://github.com/openstack/telemetry-specs/blob/master/specs/mitaka/Improve-instance-metering.rst>`_.
A compute agent obtains the measurements and sends them to the
``notifications.sample`` queue.
* Notification agents are placed on controllers. Each notification agent
performs the following:
* Obtains data from polling agents and OpenStack services. In other words,
it listens to the ``notifications.sample`` and ``notifications.info``
queues. The Telemetry plugin may be customized at this point. By default,
Ceilometer notification agents do not convert OpenStack notifications to
Ceilometer Events. If you enable Event API, notification agents will write
Events directly to Elasticsearch with the ``direct://`` publisher.
* Performs transformations and sends the data further to the
``metering.sample`` queue.
.. note::
In Mirantis OpenStack, Ceilometer notification agents do not require
coordination. For more details, see
`Custom transformed metrics <https://docs.mirantis.com/openstack/fuel/fuel-9.0/mos-planning-guide.html#monitoring-custom-transformed-metrics>`_.
A notification agent is the last Ceilometer-related processor. As a result,
all the data collected is placed in the ``metering.sample`` queue and
Ceilometer Events are written into Elasticsearch (if Event API is enabled).
Ceilometer agents work with the message brokers through ``oslo.messaging`` and
do not depend on the message broker we use.
To continue data processing, Hindsight or Heka are used. The diagram above
shows Heka/Hindsight separately because their placement depends on what is
actually chosen. For information about Heka, see
`Heka documentation <https://hekad.readthedocs.io/en/stable/message/index.html>`_.
For proper work with Kafka, we use a new generation of Heka called
`Hindsight <https://github.com/mozilla-services/hindsight/tree/master/docs>`_.
Hindsight supports all the required Kafka functionality but cannot be used
to work with RabbitMQ. Therefore, these instruments are used depending on the
message broker type:
* If Kafka is deployed, Hindsight is deployed on the same nodes where Kafka is
running. Hindsight is started with four input plugins to make data
consumption fast enough. Analysis plugins are not used. The output plugins
have a batching mechanism to deliver data into the storages in an optimal
manner. Hindsight services are not running under Pacemaker but will be
restarted automatically in case of any failures. Heka is not used in this
scenario.
* If Kafka is not deployed, RabbitMQ is used as a transport system and Heka is
running on each controller under Pacemaker. Hindsight is not used in this
scenario.
Once Heka or Hindsight receives a data sample, it is processed through a chain
of plugins and finally sent to InfluxDB or Elasticsearch.

340
docs/source/conf.py Normal file
View File

@ -0,0 +1,340 @@
# -*- 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'The OpenStack Telemetry plugin for Fuel'
copyright = u'2016, Mirantis Inc.'
# 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.0'
# 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 = 'OpenStackTelemetryPlugin-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', 'OpenStackTelemetry.tex', u'The OpenStack Telemetry plugin for Fuel Documentation',
u'Mirantis Inc.', '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-telemetry-plugin', u'Guide to the OpenStack Telemetry Plugin ver. xxxxxx for Fuel',
[u'Mirantis 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', 'Telemetry', u'The OpenStack Telemetry Plugin for Fuel Documentation',
u'Mirantis Inc.', 'Telemetry', 'The OpenStack Telemetry Plugin for Fuel Documentation',
'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 OpenStack Telemetry Plugin for Fuel'
epub_author = u'Mirantis Inc.'
epub_publisher = u'Mirantis Inc.'
epub_copyright = u'2016, Mirantis 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

59
docs/source/configure.rst Normal file
View File

@ -0,0 +1,59 @@
.. _configure:
Configure the plugin
--------------------
Once installed, configure the OpenStack Telemetry plugin.
**To configure the OpenStack Telemetry plugin:**
#. Log in to the Fuel web UI.
#. Verify that the Telemetry plugin is listed in the :guilabel:`Plugins` tab:
.. image:: images/installed_telemetry_plugin.png
:width: 450pt
#. Create an OpenStack environment as described in the
`Fuel User Guide <http://docs.openstack.org/developer/fuel-docs/userdocs/fuel-user-guide/create-environment.html>`_
or use an existing one.
#. To enable the plugin, navigate to the :guilabel:`Environments` tab and
select :guilabel:`The OpenStack Telemetry Plugin`:
.. image:: images/settings.png
:width: 450pt
#. Optional. To enable Event API and Resource API, select
:guilabel:`Advanced Settings`:
.. image:: images/advanced_settings.png
:width: 450pt
If selected, configure Elasticsearch that stores Ceilometer events and
resources:
* Select :guilabel:`Use local Elasticsearch` if you have deployed the
Elasticsearch-Kibana plugin.
* Otherwise, select :guilabel:`Use External Elasticsearch` and define the
IP and port for the Elasticsearch you want to use.
#. Configure InfluxDB:
.. image:: images/influx.png
:width: 450pt
* Select :guilabel:`Use local InfluxDB` if you have deployed the
InfluxDB-Grafana plugin.
* Otherwise, select :guilabel:`Use External InfluxDB` and define the IP or
DNS name, port, database name, username, and password for the
Elasticsearch you want to use to keep the Ceilometer-related data.
#. Configure additional metadata to be kept along with Ceilometer samples in
InfluxDB:
.. image:: images/metadata.png
:width: 450pt
By default, the Telemetry plugin keeps the list of metadata fields
described in the :ref:`limitations` section. If this list is not
sufficient, add the names of metadata fields.

Binary file not shown.

After

Width:  |  Height:  |  Size: 51 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 71 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 33 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 28 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 43 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 93 KiB

33
docs/source/index.rst Normal file
View File

@ -0,0 +1,33 @@
================================================================
Welcome to the OpenStack Telemetry Plugin for Fuel Documentation
================================================================
Overview
~~~~~~~~
.. toctree::
:maxdepth: 1
intro
architecture
requirements
prerequisites
limitations
licenses
references
Installing the OpenStack Telemetry Plugin for Fuel
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. toctree::
:maxdepth: 1
install
Configuring the OpenStack Telemetry Plugin for Fuel
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. toctree::
:maxdepth: 1
configure

129
docs/source/install.rst Normal file
View File

@ -0,0 +1,129 @@
.. _install:
Introduction
------------
Before you install the OpenStack Telemetry plugin, verify that your
environment meets the requirements described in :ref:`requirements`.
You must have the Fuel Master node installed and configured before you can
install the plugin.
You can install the OpenStack Telemetry plugin using one of the following
options:
* Install using the RPM file
* Install from source
Install using the RPM file
--------------------------
**To install the OpenStack Telemetry plugin using the RPM file of the Fuel
plugins catalog:**
#. Download the OpenStack Telemetry plugin from the `Fuel plugins catalog <https://www.mirantis.com/validated-solution-integrations/fuel-plugins/>`_.
#. Copy the plugin ``.rpm`` file to the Fuel Master node:
**Example:**
.. code-block:: console
# scp telemetry-1.0-1.0.0-1.noarch.rpm root@fuel-master:/tmp
#. Log in to the Fuel Master node CLI as root.
#. Install the plugin using the
`Fuel Plugins CLI <http://docs.openstack.org/developer/fuel-docs/userdocs/fuel-user-guide/cli/cli_plugins.html>`_:
.. code-block:: console
# fuel plugins --install telemetry-1.0-1.0.0-1.noarch.rpm
#. Verify that the plugin is installed correctly:
.. code-block:: console
# fuel plugins
id | name | version | package_version | releases
---|------------|---------|-----------------|--------------------
1 | telemetry | 1.0.0 | 4.0.0 | ubuntu (mitaka-9.0)
#. Proceed to :ref:`configure`.
Install from source
-------------------
Alternatively, you may want to build the plugin RPM file from source if, for
example, you want to test the latest features of the master branch or
customize the plugin.
.. note:: Running a Fuel plugin that you built yourself is at your own risk
and will not be supported.
To install the OpenStack Telemetry plugin from source, first prepare an
environment to build the RPM file. The recommended approach is to build the
RPM file directly onto the Fuel Master node so that you will not have to copy
that file later on.
**To prepare an environment and build the plugin:**
#. Install the standard Linux development tools:
.. code-block:: console
[root@home ~] yum install createrepo rpm rpm-build dpkg-devel
#. Install the Fuel Plugin Builder. To do that, you should first get pip:
.. code-block:: console
[root@home ~] easy_install pip
#. Then install the Fuel Plugin Builder (the ``fpb`` command line) with ``pip``:
.. code-block:: console
[root@home ~] pip install fuel-plugin-builder
.. note:: You may also need to build the Fuel Plugin Builder if the package
version of the plugin is higher than the package version supported by
the Fuel Plugin Builder you get from ``pypi``. For instructions on how
to build the Fuel Plugin Builder, see the *Install Fuel Plugin Builder*
section of the
`Fuel Plugin SDK Guide <http://docs.openstack.org/developer/fuel-docs/plugindocs/fuel-plugin-sdk-guide/create-plugin/install-plugin-builder.html>`_.
#. Clone the plugin repository:
.. code-block:: console
[root@home ~] git clone https://github.com/openstack/fuel-plugin-openstack-telemetry
#. Verify that the plugin is valid:
.. code-block:: console
[root@home ~] fpb --check ./fuel-plugin-openstack-telemetry
#. Build the plugin:
.. code-block:: console
[root@home ~] fpb --build ./fuel-plugin-openstack-telemetry
**To install the plugin:**
#. Once you create the RPM file, install the plugin:
.. code-block:: console
[root@fuel ~] fuel plugins --install ./fuel-plugin-openstack-telemetry/*.noarch.rpm
#. Verify that the plugin is installed correctly:
.. code-block:: console
# fuel plugins
id | name | version | package_version | releases
---|------------|---------|-----------------|--------------------
1 | telemetry | 1.0.0 | 4.0.0 | ubuntu (mitaka-9.0)
#. Proceed to :ref:`configure`.

45
docs/source/intro.rst Normal file
View File

@ -0,0 +1,45 @@
.. _intro:
Introduction
------------
The OpenStack Telemetry plugin collects metrics about OpenStack resources and
provides this data through Ceilometer API. This plugin implements all
Ceilometer functionality except complex queries with InfluxDB and Elasticsearch
as back ends for samples and events.
The OpenStack Telemetry plugin uses the following Ceilometer components:
* Polling agents (both central and computes)
* Notification agent
* Ceilometer API agent
Ceilometer Collector is not used. Instead, the Telemetry plugin uses its own
tools to collect telemetry data from the Ceilometer agents.
The Telemetry plugin provides a better functionality if deployed together
with the Kafka plugin. In this case, the Telemetry plugin configures Kafka as
a message bus for the Ceilometer agents and OpenStack services still send
notifications to RabbitMQ. To process this correctly, Ceilometer notification
agent listens to Kafka and RabbitMQ simultaneously.
However, the Telemetry plugin works without Kafka as well, but there are some
scalability limitations. For more information, see :ref:`limitations`.
Depending on the message broker installed, Hindsight or Heka are used as
collectors:
* Hindsight -- fetches Ceilometer samples from Kafka and is installed on the
same nodes as Kafka.
* Heka -- works with RabbitMQ and is installed on controller nodes under
Pacemaker.
We recommend installing the Telemetry plugin along with the StackLight plugins.
In this case, the Telemetry plugin will use the same databases as StackLight:
InfluxDB and Elasticsearch. Otherwise, you can configure external storages.
By default, the OpenStack Telemetry plugin supports only sample and statistics
API. However, you can enable full Ceilometer API support.
.. seealso::
* :ref:`architecture`

15
docs/source/licenses.rst Normal file
View File

@ -0,0 +1,15 @@
.. _licenses:
Licenses
--------
Third-party components
++++++++++++++++++++++
+-----------+-----------------------------------------------+------------------------+
| Name | Project website | License |
+===========+===============================================+========================+
| Heka | https://github.com/mozilla-services/heka | Mozilla Public License |
+-----------+-----------------------------------------------+------------------------+
| Hindsight | https://github.com/mozilla-services/hindsight | Mozilla Public License |
+-----------+-----------------------------------------------+------------------------+

View File

@ -0,0 +1,62 @@
.. _limitations:
Limitations
-----------
The OpenStack Telemetry plugin for Fuel has the following limitations:
* Ceilometer API is not fully supported by default. The following Ceilometer
commands are supported:
* By default:
* ``ceilometer sample-list``
* ``ceilometer statistics``
* If :guilabel:`Resource API` is enabled:
* ``ceilometer resource-list``
* ``ceilometer meter-list``
* If :guilabel:`Event API` is enabled:
* ``ceilometer event-list``
Ceilometer
`complex queries <http://docs.openstack.org/developer/ceilometer/webapi/v2.html#complex-query>`_
are not supported.
* The Telemetry plugin does not store all the OpenStack resources metadata
along with Ceilometer Samples in InfluxDB. Using the Fuel web UI, you can
configure the list of metadata. The default values are as follows:
| ``status``
| ``deleted``
| ``container_format``
| ``min_ram``
| ``updated_at``
| ``min_disk``
| ``is_public size``
| ``checksum``
| ``created_at disk_format``
| ``protected``
| ``instance_host``
| ``host``
| ``display_name``
| ``instance_id``
| ``instance_type``
| ``status``
| ``state``
| ``user_metadata.stack``
To use Ceilometer API requests based on metadata, add the required metadata
as described in :ref:`configure`.
* Coordination for Ceilometer central agent and Aodh alarm evaluator services
are switched off if RabbitMQ is used. The Telemetry plugin is based on
the Ceilometer used in Mirantis OpenStack. Therefore, the notification
agents do not require coordination. The coordination through tooz with
Zookeeper back end is supported if the Kafka plugin is installed.
* The OpenStack Telemetry plugin is incompatible with the
`Redis plugin <https://github.com/openstack/fuel-plugin-ceilometer-redis>`_.

View File

@ -0,0 +1,24 @@
.. _prerequisites:
Prerequisites
-------------
Prior to installing the OpenStack Telemetry plugin, you may want to install
the back-end services the plugin uses to store the data. These back-end
services include the following:
* Elasticsearch
* InfluxDB
To install the back-end services, use one of the options:
* Automatic installation within a Fuel environment using the following Fuel
plugins:
* `StackLight Elasticsearch-Kibana plugin
<http://fuel-plugin-elasticsearch-kibana.readthedocs.io/en/latest>`__
* `StackLight InfluxDB-Grafana plugin
<http://fuel-plugin-influxdb-grafana.readthedocs.io/en/latest>`__
* Manual installation outside of a Fuel environment. The installation must
comply with the :ref:`requirements` of the OpenStack Telemetry plugin.

View File

@ -0,0 +1,22 @@
.. _references:
References
----------
For more information about the software discussed in this document, see the
following links:
* The `StackLight Collector plugin <https://github.com/openstack/fuel-plugin-lma-collector>`_
project at GitHub
* The `StackLight Elasticsearch-Kibana plugin <https://github.com/openstack/fuel-plugin-elasticsearch-kibana>`_
project at GitHub
* The `StackLight InfluxDB-Grafana plugin <https://github.com/openstack/fuel-plugin-influxdb-grafana>`_
project at GitHub
* The official `Kibana documentation <https://www.elastic.co/guide/en/kibana/3.0/index.html>`_
* The official `Elasticsearch documentation <https://www.elastic.co/guide/en/elasticsearch/reference/1.4/index.html>`_
* The official `InfluxDB documentation <https://docs.influxdata.com/influxdb/v0.10/>`_
* The official `Grafana documentation <http://docs.grafana.org/v2.6/>`_
* The official `Heka documentation <https://hekad.readthedocs.io/en/stable/message/index.html>`_
* The official `Hindsight documentation <https://github.com/mozilla-services/hindsight/tree/master/docs>`_

View File

@ -0,0 +1,49 @@
.. _requirements:
Requirements
------------
The OpenStack Telemetry plugin has the following requirements:
======================= =================================
Requirement Version/Comment
======================= =================================
Fuel 9.0 on Mitaka
======================= =================================
If you use external storages:
+----------------------------------+-----------------------------------------+
| Requirement | Version/Comment |
+==================================+=========================================+
| An Elasticsearch server (for | 2.0.0 or higher, the RESTful API must be|
| Ceilometer Resources and Events) | enabled over port 9200 |
+----------------------------------+-----------------------------------------+
| A running InfluxDB server (for | 0.10.0 or higher, the RESTful API must |
| Ceilometer Samples) | be enabled over port 8086 |
+----------------------------------+-----------------------------------------+
Compatibilities
---------------
The OpenStack Telemetry plugin is compatible with the following plugins:
* To install the back-end services automatically, use the following StackLight
plugins:
============================ ======================================
Plugin Version/Comment
============================ ======================================
StackLight InfluxDB-Grafana 0.10.0 or newer
StackLight ES-Kibana 0.10.2 or newer. If Resource API
is disabled, the version may be 0.10.0
============================ ======================================
* To use Kafka as a message queue, install:
========== ==================
Plugin Version/Comment
========== ==================
Kafka 1.0.0
========== ==================