diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..e06d208 --- /dev/null +++ b/LICENSE @@ -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. + diff --git a/README.md b/README.md new file mode 100644 index 0000000..e7576a8 --- /dev/null +++ b/README.md @@ -0,0 +1,37 @@ +Ceilometer Redis plugin +======================= + +Provides a mechanism to allow Ceilometer agents to be horizontally scaled out +and to balance workload between corresponding agents. The current plugin version +provides this mechanism *only* for Central agent. + +Building the plugin +------------------- + +1. Clone the fuel-plugin repo: + + ``git clone https://review.openstack.org/openstack/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-.rpm 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-.rpm root@::/tmp`` + ``ssh root@:`` + ``cd /tmp`` + +6. Install the Ceilometer Redis plugin: + + ``fuel plugins --install ceilometer-redis-.rpm`` + +7. Plugin is ready to be used and can be enabled on the Settings tab of the Fuel web UI. + diff --git a/doc/content/description.rst b/doc/content/description.rst new file mode 100644 index 0000000..2a219cd --- /dev/null +++ b/doc/content/description.rst @@ -0,0 +1,35 @@ +Ceilometer Redis plugin +======================= + +Ceilometer Redis Plugin provides a coordination mechanism for +`Ceilometer agents `_. +The first version of plugin will support only `Central Agent `_. +It uses `tooz library `_ with +`Redis backend `_ to provide a set of resources +to be polled for each Central agent. The plugin also changes deployment of Ceilometer central agent: +now every controller has its own running ceilometer central service +which are joined into coordination group. These changes in deployment will be done automatically. +It also configures redis-server under pacemaker to monitor its process. The plugin configures +`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. + + +Requirements +------------ + +======================= ================ +Requirement Version/Comment +======================= ================ +Fuel 7.0 +tooz <0.14.0,>=0.13.1 +======================= ================ + +Limitations +----------- + +* The plugin version 1.0.0 provides coordination only for Agent Central service. + Alarm evaluator and Notification agent will be supported in the next plugin + version. + +.. include:: installation.rst +.. include:: guide.rst diff --git a/doc/content/guide.rst b/doc/content/guide.rst new file mode 100644 index 0000000..e91f88a --- /dev/null +++ b/doc/content/guide.rst @@ -0,0 +1,77 @@ +User Guide +========== + +Once the Ceilometer Redis plugin plugin has been installed (following `Installation Guide`_), you can +create *OpenStack* environments with Ceilometer whose Central agent works in workload_partitioned mode. + +Ceilometer installation +----------------------- + +This plugin was created to provide partitioning for Ceilometer services. So its +usage is senseless without Ceilometer installed. +So, you will need to `create a new OpenStack environment `_ +with `Ceilometer `_ using the Fuel UI Wizard. + + +Plugin configuration +-------------------- + +#. First of all, make sure that plugin was successfully installed. + Go to the *Plugins* tab. You should see the following: + + .. image:: images/redis-plugin.png + :width: 100% + +#. The next step is enable the plugin. Go to *Environments* tab and + select the *Redis plugin for Ceilometer* checkbox: + + .. image:: images/redis-plugin-on.png + :width: 100% + +#. Run `network verification check `_. + +#. Press `Deploy button `_ to once you are done with environment configuration. + + +How to check that plugin works +------------------------------ +#. Check that ceilometer-agent-central service is running on each controller. Run ``pcs resource`` + and you should see the following in the output:: + + Clone Set: clone_p_ceilometer-agent-central [p_ceilometer-agent-central] + Started: [ node-1.domain.tld node-2.domain.tld node-3.domain.tld ] + + + ``Started`` list should contain all controllers. + +#. Check that samples are not duplicated. For this purpose you may choose + any metric collected by central agent. All these metrics may be found here + `Measurements `_ . + You may choose any section *except* OpenStack Compute and then select metric with 'Pollster' Origin. + For example, let's choose storage.objects. + + Plugin works *correctly* if you see one sample for each resource every polling_interval (1 minute in this example):: + + root@node-2:~# ceilometer sample-list -m storage.objects -l 10| grep storage.objects + | 65e486c734394d3ea321ae72639ebe91 | storage.objects | gauge | 0.0 | object | 2015-11-05T10:32:27 | + | 65e486c734394d3ea321ae72639ebe91 | storage.objects | gauge | 0.0 | object | 2015-11-05T10:31:29 | + + + + Plugin works *incorrectly* if there are duplications. In this example is seen that every + ``polling_interval`` there are 3 samples about one resource:: + + root@node-2:~# ceilometer sample-list -m storage.objects -l 20| grep storage.objects + | 65e486c734394d3ea321ae72639ebe91 | storage.objects | gauge | 0.0 | object ....| + | 65e486c734394d3ea321ae72639ebe91 | storage.objects | gauge | 0.0 | object ....| + | 65e486c734394d3ea321ae72639ebe91 | storage.objects | gauge | 0.0 | object ....| + | 65e486c734394d3ea321ae72639ebe91 | storage.objects | gauge | 0.0 | object ....| + | 65e486c734394d3ea321ae72639ebe91 | storage.objects | gauge | 0.0 | object ....| + | 65e486c734394d3ea321ae72639ebe91 | storage.objects | gauge | 0.0 | object ....| + + .... 2015-11-05T10:27:37 | + .... 2015-11-05T10:27:26 | + .... 2015-11-05T10:27:17 | + .... 2015-11-05T10:26:38 | + .... 2015-11-05T10:26:26 | + .... 2015-11-05T10:26:17 | diff --git a/doc/content/images/redis-plugin-on.png b/doc/content/images/redis-plugin-on.png new file mode 100644 index 0000000..b37e9e5 Binary files /dev/null and b/doc/content/images/redis-plugin-on.png differ diff --git a/doc/content/images/redis-plugin.png b/doc/content/images/redis-plugin.png new file mode 100644 index 0000000..9978778 Binary files /dev/null and b/doc/content/images/redis-plugin.png differ diff --git a/doc/content/installation.rst b/doc/content/installation.rst new file mode 100644 index 0000000..9715e29 --- /dev/null +++ b/doc/content/installation.rst @@ -0,0 +1,35 @@ + +Installation Guide +================== + +Install the Plugin +------------------ + +To install the Redis plugin: + +#. Download the Redis plugin from the + `Fuel Plugins Catalog `_. + +#. Move the plugin's rpm to the + `Fuel Master node `_ with secure copy (scp):: + + scp fuel-plugin-ceilometer-redis/ceilometer-redis-1.0-1.0.0-1.noarch.rpm / + root@::/tmp + + +#. Log into the Fuel Master node and install the Ceilometer Redis plugin:: + + ssh root@: + cd /tmp + fuel plugins --install ceilometer-redis-1.0-1.0.0-1.noarch.rpm + + +#. Verify that the plugin is installed correctly:: + + [root@fuel-master ~]# fuel plugins list + id | name | version | package_version + ---|------------------|---------|---------------- + 4 | ceilometer-redis | 1.0.0 | 2.0.0 + + + diff --git a/doc/content/tests.rst b/doc/content/tests.rst new file mode 100644 index 0000000..e69de29 diff --git a/specs/ceilometer-redis.rst b/specs/ceilometer-redis.rst new file mode 100644 index 0000000..68851ba --- /dev/null +++ b/specs/ceilometer-redis.rst @@ -0,0 +1,258 @@ +.. + 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: + +* Currently there are several Ceilometer services which do not support workload + partitioning in MOS: central agent, alarm evaluator and agent notification. During + Juno release cycle workload partitioning for central agent was implemented. + In Kilo, partition coordination was introduced to alarm evaluator and agent + notification. In Liberty, coordination for notification agent was further improved. + Thus, it should be supported in MOS. + For this purpose we should provide tooz library support. This library is responsible for + coordination between services and supports several backends: zookeeper, redis, memcached. + Redis was chosen as the tooz backend in MOS. + +Proposed change +=============== + +Support for Ceilometer services coordination is an experimental feature and it was +decided to implement it as a fuel plugin. + +Its implementation requires the following things to be done: +* Implement Redis installation on controller nodes in HA mode +* Prepare Redis packages and their dependencies +* Enable partitioning in config for ceilometer central agents +* Enable partitioning in config for ceilometer alarm evaluator +* Enable partitioning in config for ceilometer notification agents + +Installation diagram for central agent is below. The schemas for alarm-evaluator and +notification agent are similar + +:: + + +---------------------+ + | | + | +---------------+ | + | | ceilometer +-------------------------+ + | | central agent | | | + | +---------------+ | | + | | | + | Primary controller | | + | | | + | +---------------+ | | + | | redis <------------------------------+ + | | master | | | | + | +---------------+ | | | + | | | | + +---------------------+ | | + | | + +---------------------+ | | + | | | | + | +---------------+ | | | + | | ceilometer +-------------------------+ | + | | central agent | | | | + | +---------------+ | | | + | | +------v----+--+ + | controller 1 | | | + | | | Coordination | + | +---------------+ | | | + | | redis | | +------^----+--+ + | | slave1 | | | | + | | <------------------------------+ + | +---------------+ | | | + | | | | + +---------------------+ | | + | | + +---------------------+ | | + | | | | + | +---------------+ | | | + | | ceilometer +-------------------------+ | + | | central agent | | | + | +---------------+ | | + | | | + | controller 2 | | + | | | + | +---------------+ | | + | | redis | | | + | | slave2 <------------------------------+ + | | | | + | +---------------+ | + | | + +---------------------+ + + +Alternatives +------------ + +* We may use MQ queues for task ditribution between the services. The problem is + that MQ is one of the most weak point in OpenStack now and it may be not safe + to make it responsible for HA and coordination. + +Data model impact +----------------- + +None + +REST API impact +--------------- + +None + +Upgrade impact +-------------- + +These changes will be needed in puppet scripts: + +* Add redis module + +* Configure ceilometer agents to be partitioned + + +This change will be needed in packages: + +* Use upstream Redis packages and its dependencies + +Security impact +--------------- + +None + +Notifications impact +-------------------- + +None + +Other end user impact +--------------------- + +None + +Performance Impact +------------------ + +Performance should become better because the same amount of work will be +done using several workers + +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: + Nadya Shakhat, Ilya Tyaptin, Igor Degtiarov + +Reviewer: + Vladimir Kuklin Sergii Golovatiuk + +QA: + Vitaly Gusev + +Work Items +---------- + +* Implement redis installation from puppet (iberezovskiy) + +* Configure ceilometer central agent (iberezovskiy) + +* Configure alarm evaluator (Nadya Shakhat) + +* Configure notification agents (Nadya Shakhat) + +* Write a documentation (Nadya Shakhat) + +Dependencies +============ + +None + +Testing +======= + +General testing approach: + +* Environment with ceilometer in HA mode should be successfully deployed + +* Redis cluster should be with one master and two slaves + +* Ensure that after node with redis master was broken ceilometer services + can work with new redis master + + +Testing approach for central agent: + +* Ceilometer should collect all enabled polling meters for deployed + environment + +* Ensure that the sets of meters to be polled by each central agent are disjoint + +* Ensure that after one central agent is broken, during the next polling + cycle all measurements will be rescheduled between two another, + and all of meters will be collected + + +Testing approach for alarm evaluator: + +* Ensure that alarms can be successfully created + +* Ensure that after one alarm evaluator is broken, during the next alarm evaluation + cycle all alarms will be rescheduled between two another for further evaluation + and all of alarms will be successfully evaluated + +* Ensure that the sets of alarms for each alarm evaluator are disjoint + + +Testing approach for notification agent: + +* Ensure that messages don't not stuck in notification.info queue + +* Ensure that IPC queues are created in MQ, chech that list of IPC queues corresponds + to pipeline.yaml and each queue has the one consumer + +* Ensure that after one alarm evaluator was broken, during the next alarm evaluation + cycle all alarms will be rescheduled between two another for further evaluation + and all of them will be successfully evaluated + +Documentation Impact +==================== + +A Plugin Guide about redis plugin installation should be created. +Also, the document about ceilometer HA and partitioning should be done. + +For validation and testing purpose, the test plan and test report should be provided. + +References +========== + +1. Central agent: https://github.com/openstack/ceilometer-specs/blob/master/specs/juno/central-agent-partitioning.rst +2. Notification agent: https://github.com/openstack/ceilometer-specs/blob/master/specs/kilo/notification-coordiation.rst +3. Notification agent cont.: https://github.com/openstack/ceilometer-specs/blob/master/specs/liberty/distributed-coordinated-notifications.rst