Add documentation for Ceilometer Redis plugin
* Add LICENSE * Add README with information about plugin * Add plugin specification Partially implements: blueprint ceilometer-central-agent-ha Change-Id: I918c7542be8d5311e28ea2a87bb792127fcc70c9
This commit is contained in:
iberezovskiy
parent
a3a450088e
commit
7e0e6973aa
|
|
@ -0,0 +1,202 @@
|
|||
Apache License
|
||||
Version 2.0, January 2004
|
||||
http://www.apache.org/licenses/
|
||||
|
||||
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
||||
|
||||
1. Definitions.
|
||||
|
||||
"License" shall mean the terms and conditions for use, reproduction,
|
||||
and distribution as defined by Sections 1 through 9 of this document.
|
||||
|
||||
"Licensor" shall mean the copyright owner or entity authorized by
|
||||
the copyright owner that is granting the License.
|
||||
|
||||
"Legal Entity" shall mean the union of the acting entity and all
|
||||
other entities that control, are controlled by, or are under common
|
||||
control with that entity. For the purposes of this definition,
|
||||
"control" means (i) the power, direct or indirect, to cause the
|
||||
direction or management of such entity, whether by contract or
|
||||
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
||||
outstanding shares, or (iii) beneficial ownership of such entity.
|
||||
|
||||
"You" (or "Your") shall mean an individual or Legal Entity
|
||||
exercising permissions granted by this License.
|
||||
|
||||
"Source" form shall mean the preferred form for making modifications,
|
||||
including but not limited to software source code, documentation
|
||||
source, and configuration files.
|
||||
|
||||
"Object" form shall mean any form resulting from mechanical
|
||||
transformation or translation of a Source form, including but
|
||||
not limited to compiled object code, generated documentation,
|
||||
and conversions to other media types.
|
||||
|
||||
"Work" shall mean the work of authorship, whether in Source or
|
||||
Object form, made available under the License, as indicated by a
|
||||
copyright notice that is included in or attached to the work
|
||||
(an example is provided in the Appendix below).
|
||||
|
||||
"Derivative Works" shall mean any work, whether in Source or Object
|
||||
form, that is based on (or derived from) the Work and for which the
|
||||
editorial revisions, annotations, elaborations, or other modifications
|
||||
represent, as a whole, an original work of authorship. For the purposes
|
||||
of this License, Derivative Works shall not include works that remain
|
||||
separable from, or merely link (or bind by name) to the interfaces of,
|
||||
the Work and Derivative Works thereof.
|
||||
|
||||
"Contribution" shall mean any work of authorship, including
|
||||
the original version of the Work and any modifications or additions
|
||||
to that Work or Derivative Works thereof, that is intentionally
|
||||
submitted to Licensor for inclusion in the Work by the copyright owner
|
||||
or by an individual or Legal Entity authorized to submit on behalf of
|
||||
the copyright owner. For the purposes of this definition, "submitted"
|
||||
means any form of electronic, verbal, or written communication sent
|
||||
to the Licensor or its representatives, including but not limited to
|
||||
communication on electronic mailing lists, source code control systems,
|
||||
and issue tracking systems that are managed by, or on behalf of, the
|
||||
Licensor for the purpose of discussing and improving the Work, but
|
||||
excluding communication that is conspicuously marked or otherwise
|
||||
designated in writing by the copyright owner as "Not a Contribution."
|
||||
|
||||
"Contributor" shall mean Licensor and any individual or Legal Entity
|
||||
on behalf of whom a Contribution has been received by Licensor and
|
||||
subsequently incorporated within the Work.
|
||||
|
||||
2. Grant of Copyright License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
copyright license to reproduce, prepare Derivative Works of,
|
||||
publicly display, publicly perform, sublicense, and distribute the
|
||||
Work and such Derivative Works in Source or Object form.
|
||||
|
||||
3. Grant of Patent License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
(except as stated in this section) patent license to make, have made,
|
||||
use, offer to sell, sell, import, and otherwise transfer the Work,
|
||||
where such license applies only to those patent claims licensable
|
||||
by such Contributor that are necessarily infringed by their
|
||||
Contribution(s) alone or by combination of their Contribution(s)
|
||||
with the Work to which such Contribution(s) was submitted. If You
|
||||
institute patent litigation against any entity (including a
|
||||
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
||||
or a Contribution incorporated within the Work constitutes direct
|
||||
or contributory patent infringement, then any patent licenses
|
||||
granted to You under this License for that Work shall terminate
|
||||
as of the date such litigation is filed.
|
||||
|
||||
4. Redistribution. You may reproduce and distribute copies of the
|
||||
Work or Derivative Works thereof in any medium, with or without
|
||||
modifications, and in Source or Object form, provided that You
|
||||
meet the following conditions:
|
||||
|
||||
(a) You must give any other recipients of the Work or
|
||||
Derivative Works a copy of this License; and
|
||||
|
||||
(b) You must cause any modified files to carry prominent notices
|
||||
stating that You changed the files; and
|
||||
|
||||
(c) You must retain, in the Source form of any Derivative Works
|
||||
that You distribute, all copyright, patent, trademark, and
|
||||
attribution notices from the Source form of the Work,
|
||||
excluding those notices that do not pertain to any part of
|
||||
the Derivative Works; and
|
||||
|
||||
(d) If the Work includes a "NOTICE" text file as part of its
|
||||
distribution, then any Derivative Works that You distribute must
|
||||
include a readable copy of the attribution notices contained
|
||||
within such NOTICE file, excluding those notices that do not
|
||||
pertain to any part of the Derivative Works, in at least one
|
||||
of the following places: within a NOTICE text file distributed
|
||||
as part of the Derivative Works; within the Source form or
|
||||
documentation, if provided along with the Derivative Works; or,
|
||||
within a display generated by the Derivative Works, if and
|
||||
wherever such third-party notices normally appear. The contents
|
||||
of the NOTICE file are for informational purposes only and
|
||||
do not modify the License. You may add Your own attribution
|
||||
notices within Derivative Works that You distribute, alongside
|
||||
or as an addendum to the NOTICE text from the Work, provided
|
||||
that such additional attribution notices cannot be construed
|
||||
as modifying the License.
|
||||
|
||||
You may add Your own copyright statement to Your modifications and
|
||||
may provide additional or different license terms and conditions
|
||||
for use, reproduction, or distribution of Your modifications, or
|
||||
for any such Derivative Works as a whole, provided Your use,
|
||||
reproduction, and distribution of the Work otherwise complies with
|
||||
the conditions stated in this License.
|
||||
|
||||
5. Submission of Contributions. Unless You explicitly state otherwise,
|
||||
any Contribution intentionally submitted for inclusion in the Work
|
||||
by You to the Licensor shall be under the terms and conditions of
|
||||
this License, without any additional terms or conditions.
|
||||
Notwithstanding the above, nothing herein shall supersede or modify
|
||||
the terms of any separate license agreement you may have executed
|
||||
with Licensor regarding such Contributions.
|
||||
|
||||
6. Trademarks. This License does not grant permission to use the trade
|
||||
names, trademarks, service marks, or product names of the Licensor,
|
||||
except as required for reasonable and customary use in describing the
|
||||
origin of the Work and reproducing the content of the NOTICE file.
|
||||
|
||||
7. Disclaimer of Warranty. Unless required by applicable law or
|
||||
agreed to in writing, Licensor provides the Work (and each
|
||||
Contributor provides its Contributions) on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
||||
implied, including, without limitation, any warranties or conditions
|
||||
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
||||
PARTICULAR PURPOSE. You are solely responsible for determining the
|
||||
appropriateness of using or redistributing the Work and assume any
|
||||
risks associated with Your exercise of permissions under this License.
|
||||
|
||||
8. Limitation of Liability. In no event and under no legal theory,
|
||||
whether in tort (including negligence), contract, or otherwise,
|
||||
unless required by applicable law (such as deliberate and grossly
|
||||
negligent acts) or agreed to in writing, shall any Contributor be
|
||||
liable to You for damages, including any direct, indirect, special,
|
||||
incidental, or consequential damages of any character arising as a
|
||||
result of this License or out of the use or inability to use the
|
||||
Work (including but not limited to damages for loss of goodwill,
|
||||
work stoppage, computer failure or malfunction, or any and all
|
||||
other commercial damages or losses), even if such Contributor
|
||||
has been advised of the possibility of such damages.
|
||||
|
||||
9. Accepting Warranty or Additional Liability. While redistributing
|
||||
the Work or Derivative Works thereof, You may choose to offer,
|
||||
and charge a fee for, acceptance of support, warranty, indemnity,
|
||||
or other liability obligations and/or rights consistent with this
|
||||
License. However, in accepting such obligations, You may act only
|
||||
on Your own behalf and on Your sole responsibility, not on behalf
|
||||
of any other Contributor, and only if You agree to indemnify,
|
||||
defend, and hold each Contributor harmless for any liability
|
||||
incurred by, or claims asserted against, such Contributor by reason
|
||||
of your accepting any such warranty or additional liability.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
APPENDIX: How to apply the Apache License to your work.
|
||||
|
||||
To apply the Apache License to your work, attach the following
|
||||
boilerplate notice, with the fields enclosed by brackets "{}"
|
||||
replaced with your own identifying information. (Don't include
|
||||
the brackets!) The text should be enclosed in the appropriate
|
||||
comment syntax for the file format. We also recommend that a
|
||||
file or class name and description of purpose be included on the
|
||||
same "printed page" as the copyright notice for easier
|
||||
identification within third-party archives.
|
||||
|
||||
Copyright {yyyy} {name of copyright owner}
|
||||
|
||||
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.
|
||||
|
||||
|
|
@ -0,0 +1,61 @@
|
|||
Ceilometer Redis plugin
|
||||
=======================
|
||||
|
||||
Provide a mechanism to allow the central agent to be horizontally scaled out,
|
||||
such that each agent polls a disjoint subset of resources.
|
||||
|
||||
Redis was chosen as coordination backend for Fuel deployments with Ceilometer.
|
||||
|
||||
This repository contains all necessary files to build Ceilometer Redis Fuel plugin.
|
||||
Currently, the only supported Fuel version is 7.0 (Ubuntu deployments).
|
||||
|
||||
Building the plugin
|
||||
-------------------
|
||||
|
||||
1. Clone the fuel-plugin repo from:
|
||||
|
||||
``git clone https://github.com/stackforge/fuel-plugin-ceilometer-redis``
|
||||
|
||||
2. Install the Fuel Plugin Builder:
|
||||
|
||||
``pip install fuel-plugin-builder``
|
||||
|
||||
3. Build Ceilometer Redis Fuel plugin:
|
||||
|
||||
``fpb --build fuel-plugin-ceilometer-redis/``
|
||||
|
||||
4. The ceilometer-redis-<x.x.x>.fp plugin package will be created in the plugin folder
|
||||
(fuel-plugin-ceilometer-redis/).
|
||||
|
||||
5. Move this file to the Fuel Master node with secure copy (scp):
|
||||
|
||||
``scp fuel-plugin-ceilometer-redis/ceilometer-redis-<x.x.x>.fp root@:<the_Fuel_Master_node_IP address>:/tmp``
|
||||
``ssh root@:<the_Fuel_Master_node_IP address>``
|
||||
``cd /tmp``
|
||||
|
||||
6. Install the Ceilometer Redis plugin:
|
||||
|
||||
``fuel plugins --install ceilometer-redis-<x.x.x>.fp``
|
||||
|
||||
7. Plugin is ready to use and can be enabled on the Settings tab of the Fuel web UI.
|
||||
|
||||
|
||||
Deployment details
|
||||
------------------
|
||||
|
||||
* Plugin changes deployment of Ceilometer central agent:
|
||||
Now every controller has his own running ceilometer central service
|
||||
which are joined in coorditation group.
|
||||
|
||||
* Plugin configures redis-server under pacemaker to monitor its process
|
||||
|
||||
* Plugin configure redis-sentinel to monitor the state of redis cluster,
|
||||
to elect new master during failovers, to forward ceilometer agents
|
||||
to new elected redis master, to organize sync between redis nodes.
|
||||
|
||||
|
||||
Accessing Workload partitioning functionality
|
||||
---------------------------------------------
|
||||
|
||||
Please use official Openstack documentation to obtain more information:
|
||||
- http://specs.openstack.org/openstack/ceilometer-specs/specs/juno/central-agent-partitioning.html
|
||||
|
|
@ -0,0 +1,213 @@
|
|||
..
|
||||
This work is licensed under a Creative Commons Attribution 3.0 Unported
|
||||
License.
|
||||
|
||||
http://creativecommons.org/licenses/by/3.0/legalcode
|
||||
|
||||
==============================================
|
||||
Add central agent HA and workload partitioning
|
||||
==============================================
|
||||
|
||||
https://blueprints.launchpad.net/fuel/+spec/ceilometer-central-agent-ha
|
||||
|
||||
Implement Redis installation and using it as a coordination backend
|
||||
for ceilometer central agents
|
||||
|
||||
Problem description
|
||||
===================
|
||||
|
||||
A detailed description of the problem:
|
||||
|
||||
* Currentrly ceilometer central agent is the only one ceilometer component
|
||||
that didn't support HA and workload partitioning. During Juno release
|
||||
cycle this feature was intorduced to the ceilometer in the upstream code
|
||||
using tooz coordination openstack library. This library supports several
|
||||
backends (zookeeper, redis, memcached among them). It was decided
|
||||
to introduce this built-in ceilometer feature to MOS as well.
|
||||
Redis was chosen as the coordination backend.
|
||||
|
||||
Proposed change
|
||||
===============
|
||||
|
||||
This feature is experimental and should be implemented as fuel-plugin.
|
||||
It's implementation requires following things to be done:
|
||||
* Implement Redis installation on controller nodes only in HA mode
|
||||
* Prepare Redis packages and it's dependencies
|
||||
* Configure ceilometer central agents to work with redis
|
||||
|
||||
Installation diagram is as follows
|
||||
|
||||
::
|
||||
|
||||
+---------------------+
|
||||
| |
|
||||
| +---------------+ |
|
||||
| | ceilometer +-------------------------+
|
||||
| | central agent | | |
|
||||
| +---------------+ | |
|
||||
| | |
|
||||
| Primary controller | |
|
||||
| | |
|
||||
| +---------------+ | |
|
||||
| | redis <------------------------------+
|
||||
| | master | | | |
|
||||
| +---------------+ | | |
|
||||
| | | |
|
||||
+---------------------+ | |
|
||||
| |
|
||||
+---------------------+ | |
|
||||
| | | |
|
||||
| +---------------+ | | |
|
||||
| | ceilometer +-------------------------+ |
|
||||
| | central agent | | | |
|
||||
| +---------------+ | | |
|
||||
| | +------v----+--+
|
||||
| controller 1 | | |
|
||||
| | | Coordination |
|
||||
| +---------------+ | | |
|
||||
| | redis | | +------^----+--+
|
||||
| | slave1 | | | |
|
||||
| | <------------------------------+
|
||||
| +---------------+ | | |
|
||||
| | | |
|
||||
+---------------------+ | |
|
||||
| |
|
||||
+---------------------+ | |
|
||||
| | | |
|
||||
| +---------------+ | | |
|
||||
| | ceilometer +-------------------------+ |
|
||||
| | central agent | | |
|
||||
| +---------------+ | |
|
||||
| | |
|
||||
| controller 2 | |
|
||||
| | |
|
||||
| +---------------+ | |
|
||||
| | redis | | |
|
||||
| | slave2 <------------------------------+
|
||||
| | | |
|
||||
| +---------------+ |
|
||||
| |
|
||||
+---------------------+
|
||||
|
||||
|
||||
Alternatives
|
||||
------------
|
||||
|
||||
This feature could be implemented by default, but it has experimental status.
|
||||
|
||||
Data model impact
|
||||
-----------------
|
||||
|
||||
None
|
||||
|
||||
REST API impact
|
||||
---------------
|
||||
|
||||
None
|
||||
|
||||
Upgrade impact
|
||||
--------------
|
||||
|
||||
These changes will be needed in puppet scripts:
|
||||
|
||||
* Add redis module
|
||||
|
||||
* Configure ceilometer central agent to use redis as backend
|
||||
|
||||
This change will be needed in packages:
|
||||
|
||||
* Use upstream Redis packages and it's dependencies
|
||||
|
||||
Security impact
|
||||
---------------
|
||||
|
||||
None
|
||||
|
||||
Notifications impact
|
||||
--------------------
|
||||
|
||||
None
|
||||
|
||||
Other end user impact
|
||||
---------------------
|
||||
|
||||
None
|
||||
|
||||
Performance Impact
|
||||
------------------
|
||||
|
||||
None
|
||||
|
||||
Other deployer impact
|
||||
---------------------
|
||||
|
||||
This could be installed only in HA mode with ceilometer
|
||||
|
||||
Developer impact
|
||||
----------------
|
||||
|
||||
None
|
||||
|
||||
Implementation
|
||||
==============
|
||||
|
||||
Assignee(s)
|
||||
-----------
|
||||
|
||||
Primary assignee:
|
||||
Ivan Berezovskiy
|
||||
|
||||
Other contributors:
|
||||
Dina Belova
|
||||
|
||||
Reviewer:
|
||||
Vladimir Kuklin Sergii Golovatiuk
|
||||
|
||||
QA:
|
||||
Vadim Rovachev
|
||||
|
||||
Work Items
|
||||
----------
|
||||
|
||||
* Implement redis installation from puppet (iberezovskiy)
|
||||
|
||||
* Configure ceilometer central agent (iberezovskiy)
|
||||
|
||||
* Write a documentation (ipovolotskaya)
|
||||
|
||||
Dependencies
|
||||
============
|
||||
|
||||
None
|
||||
|
||||
Testing
|
||||
=======
|
||||
|
||||
Testing approach:
|
||||
|
||||
* Environment with ceilometer in HA mode should be succesfully deployed
|
||||
|
||||
* Ceilometer should collect all enabled polling meters for deployed
|
||||
environment
|
||||
|
||||
* Polling meters should be divided on groups by ceilometer central agents
|
||||
|
||||
* Redis cluster should be with one master and two slaves
|
||||
|
||||
* Ensure that after one central agent was broken, during the next polling
|
||||
cycle all measurements will be rescheduled between two another,
|
||||
and still all of them will be collected
|
||||
|
||||
* Ensure that after node with redis master was broken ceilometer central
|
||||
agents can work with new redis master and can poll meters
|
||||
|
||||
Documentation Impact
|
||||
====================
|
||||
|
||||
A note should be added about redis plugin installation and
|
||||
how ceilometer agent can work in HA mode
|
||||
|
||||
References
|
||||
==========
|
||||
|
||||
None
|
||||
Loading…
Reference in New Issue