x
/
collectd-openstack-plugins
Code Issues Proposed changes

Inconsistent capitalization on Gnocchi, Aodh, OpenStack in docs 

Docs use inconsistent capitalisation of Gnocchi, Aodh, OpenStack, etc.
Ref: https://docs.openstack.org/contributor-guide/writing-style/openstack-components.html

Change-Id: Ia1ea04d4cf45e33f0257226e09e5a4da5275c4ad
Closes-Bug:#1708667
This commit is contained in:
rajat29 2017-08-07 12:24:23 +05:30 committed by Rajat Sharma
parent d474b8ba68
commit eef5c8dce0
4 changed files with 20 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.rst
View File

@ -24,10 +24,10 @@
collectd-ceilometer-plugin
==========================
Collectd plugins for publishing to OpenStack (Gnocchi and Aodh).
Collectd plugins for publishing to OpenStack (gnocchi and aodh).
This repositiory contains collectd plugins for publishing telemetry data
(metrics and events) gathered by collectd to Gnocchi and Aodh.
(metrics and events) gathered by collectd to gnocchi and aodh.
This allows a more comprehensive set of platform telemetry to be made available
to OpenStack which enables service assurance, fault management and monitoring.
@ -52,16 +52,16 @@ works:
https://collectd.org/
* Information on how collectd is enabled for Openstack:
https://01.org/openstack/blogs/emmalfoley/2016/collectd-enabling-openstack
* Presentation on how collectd, Ceilometer and DPDK work together:
* Presentation on how collectd, ceilometer and DPDK work together:
https://www.youtube.com/watch?v=BdebhsBFEJs
Features
--------
* Gnocchi plugin (for collectd)
** Store collectd metrics in Gnocchi
** Store collectd metrics in gnocchi
* Aodh plugin (for collectd)
** Forward collectd notifications to Aodh
** Forward collectd notifications to aodh
* Devstack plugin (for deploying the contents of this repo)
** Configure and deploy plugins
** Build collectd from source

18
doc/source/GSG.rst
View File

@ -26,16 +26,16 @@ Getting Started with Collectd
=============================
This is a getting started guide that describes the manual setup of collectd
and the configuration of the plugins contained in this repository (Gnocchi, Aodh).
and the configuration of the plugins contained in this repository (gnocchi, aodh).
Pre-requisites
--------------
- Access to the internet
- A working OpenStack environment
- Keystone service enabled
- Gnocchi and/or Aodh service(s) enabled
- keystone service enabled
- gnocchi and/or aodh service(s) enabled
Collectd Installation
---------------------
@ -191,10 +191,10 @@ Configuring Collectd
* Configure some collectd plugins
Collectd openstack plugins
Collectd OpenStack plugins
--------------------------
This section describes the steps to installing and configuring the collectd
plugins for Ceiloemter, Gnocchi and Aodh.
plugins for gnocchi and aodh.
* Clone the collectd-ceilometer-plugin code.
@ -235,7 +235,8 @@ In the collectd-{gnocchi,aodh}-plugin.conf file a few variables
have to be changed to suit your environment:
* Set the ``ModulePath`` to be the location of your collectd-ceilometer-plugin
directory (this values will be the same for Gnocchi and Aodh plugins).
directory (this values will be the same for gnocchi and aodh plugins).
::
@ -261,7 +262,8 @@ have to be changed to suit your environment:
* Modify the credentials for the openstack service that the plugin is using.
These will be different for gnocchi and aodh.
These values are set when creating the Aodh and Gnocchi services in OpenStack.
These values are set when creating the aodh and gnocchi services in OpenStack.
If you used an installer, some typical values are shown below.
::

4
doc/source/alarms_guide.rst
View File

@ -24,14 +24,14 @@
Enabling Alarms for plugin metrics/meters
=========================================
This guide provides a description of what Aodh features are available when the
This guide provides a description of what aodh features are available when the
collectd-gnocchi plugin is enabled. It provides a list of the alarms that can be
created and how to create them.
Gnocchi Based Alarms
--------------------
There are three types of gnocchi based alarms that can be created using Aodh:
There are three types of gnocchi based alarms that can be created using aodh:
- gnocchi_resources_threshold
- gnocchi_aggregation_by_metrics_threshold

6
doc/source/devstackGSG.rst
View File

@ -48,7 +48,7 @@ Configuration of DevStack
-------------------------
These configuration instructions only allow for the minimal installation of
collectd, Gnocchi, Aodh and the plugins in this repo. The sample local.conf
collectd, gnocchi, aodh and the plugins in this repo. The sample local.conf
provided must be edited to enable additional services.
To configure DevStack for to install the plugin, download the sample local.conf
@ -167,7 +167,7 @@ Aodh is an alarming service that allows an alarm to be created and/or updated
if there is something unusual happening with the system. When this service is
enabled via the collectd-ceilometer-plugin, it allows alarms to be
created/updated for all notifications sent from collectd. All notifications
sent from collectd are configured as event alarms in Aodh.
sent from collectd are configured as event alarms in aodh.
To enable aodh with collectd, add the following to your local.conf:
::
@ -190,7 +190,7 @@ You can set this severity to be one of three settings "low", "moderate" or
"critical". If you leave this unset for any of the meters that trigger an alarm
severity will default to "moderate".
In addition to this, alarms can be created manually via the Aodh command line
In addition to this, alarms can be created manually via the aodh command line
based on the metrics generated by the gnocchi plugin.
For more information on this please read
:doc:`<alarms_guide.rst>`