Skip to content

Commit

Permalink
first commit
Browse files Browse the repository at this point in the history
  • Loading branch information
aimannajjar committed Oct 1, 2015
0 parents commit fb4233d
Show file tree
Hide file tree
Showing 496 changed files with 147,803 additions and 0 deletions.
1 change: 1 addition & 0 deletions INSTALL
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Installation instructions can be found in README.md
201 changes: 201 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,201 @@
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.
9 changes: 9 additions & 0 deletions NOTICE
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
Portions of this software were developed in the User Experience
and Analytics Groups at Rakuten Marketing, LCC.

This CSD and Parcel package uses Redis software.

Redis is open source software released under the terms of the three clause BSD license. Most of the Redis source code was written and is copyrighted by Salvatore Sanfilippo and Pieter Noordhuis. A list of other contributors can be found in the git history.
The Redis trademark and logo are owned by Salvatore Sanfilippo and can be used in accordance with the Redis Trademark Guidelines.

Redis license can be found at http://redis.io/topics/license
105 changes: 105 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,105 @@
Redis Parcel and CSD for Cloudera's CDH 5
=============
This parcel and CSD greatly simplifies deploying and managing Redis on your Cloudera cluster.
The CSD will setup Redis sentinel as well when you deploy the service to multiple instances.

## Table of Contents
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
**Table of Contents** *generated with [DocToc](http://doctoc.herokuapp.com/)*

- [Installation](#installation)
- [1. Install the CSD](#1-install-the-csd)
- [2. Downloading and Distributing Redis Parcel](#2-downloading-and-distributing-redis-parcel)
- [Known Limitations](#known-limitations)
- [Adding/Removing slaves to existing Redis cluster](#addingremoving-slaves-to-existing-redis-cluster)
- [Workaround](#workaround)
- [Changing Redis Sentinel port on existing Cluster](#changing-redis-sentinel-port-on-existing-cluster)
- [Configuring Redis Sentinel Parameters](#configuring-redis-sentinel-parameters)
- [Q&A](#q&a)
- [Service fails to start with this error reported: start_processes.sh: line 3: /var/lib/redis/src/redis-sentinel: No such file or directory](#service-fails-to-start-with-this-error-reported-start_processessh-line-3-varlibredissrcredis-sentinel-no-such-file-or-directory)

<!-- END doctoc generated TOC please keep comment here to allow auto update -->

### Installation

#### 1. Install the CSD

1. **IMPORTANT:** The CSD will build Redis the first time it runs, please make sure both gcc/cc and make are installed on **all** nodes.
2. Download the latest CSD release from this repository (alternatively, you can build it using the maven command "mvn assembly:assembly" and use the jar compiled in target folder)
3. Upload the CSD jar to your Cloudera Manager node, place it in /opt/cloudera/csd/
4. Restart cloudera-scm-manager on Clouder Manager node:

```bash
service cloudera-scm-server restart
```



#### 2. Downloading and Distributing Redis Parcel

1. Clone this git repository (you do not need to clone it inside your Cloudera cluster)
2. Setup a quick HTTP server to serve as cloudera repository, the HTTP server will need to serve the "parcel" directory:

```bash
cd parcel
python -m SimpleHTTPServer
```

3. Go to your Cloudera Manager: http://x.x.x.x:7180 and login with your admin credentials
4. Click on the parcels icon on the top right corner (next to the search bar)
5. Click on "Edit Settings"
6. Add a new value in "Remote Parcel Repository URLs", enter the IP address for the machine on which you just setup your HTTP server, for example: http://x.x.x.x:8000
7. Save your changes and go back to Parcels page by clicking on the Parcels icon on the top right corner (next to the search bar)
8. Click on "Check for New Parcels"
9. You should see "REDIS" parcel in the list. Download it, then distribute it and activate it
10. You will be prompted to restart your cluster, click "Restart". Once that's done, you will need to restart "Cloudera Management Service" manually as well
11. Now you should be able to simply add your new Redis service through CM. (click on the little arrow next your cluster name and click "Add Service", follow the wizard instructions)

### Known Limitations

##### Adding/Removing slaves to existing Redis cluster
When you add a new instance to your Redis service in Cloudera,
there is a chance that this new node will become a master. This happens because whenever the Redis service is restarted,
it rewrite the redis.conf file and it uses the first instance as the master. For example, if you have a cluster with the following nodes hostnames: node2, node3 and node4. And then you add "node1", node1 might become the new master and might causes to wipe out existing data.

###### Workaround
If you really want to add a new node, you can do the following:

1. Login onto redis-cli shell
2. Issue save command
3. Stop the Redis service (In CM)
4. Backup the data dump file to a safe location
5. In CM, navigate to "Redis" service page, expand "Actions" drop-down menu and click on "Reset Topology"
6. Add/Remove Redis nodes
7. Start up the service, find what the new Redis master node is.
8. Stop the service, restore the backup from the dump file
9. Start up Redis service again

##### Changing Redis Sentinel port on existing Cluster
The CSD will avoid re-writing redis-sentinel.conf every time you deploy new configuraiton, that's because Redis sentinel rewrites this file every time a fail-over occurs, the only way to deploy new Redis sentinel port is by using "Reset Topolgy" action (accessible through CM's UI). However, that might causes another node to become a master and cause some data discrapencies (i.e. if that's node was not fully-sync). If you really want to change sentinel port, consider the performing steps in the section above.

#### Configuring Redis Sentinel Parameters
Currently Redis sentinel will always be configured with the default settings, the only configurable setting is the port number (but please refer to the section above before changing the port number).

### Q&A

##### Service fails to start with this error reported: start_processes.sh: line 3: /var/lib/redis/src/redis-sentinel: No such file or directory

This means the CSD failed to build Redis. To troubleshoot this error, login manually to the node Redis is being installed on, and run the following

```bash
sudo su redis
cd /var/lib/redis/deps
make hiredis jemalloc linenoise lua
cd /var/lib/redis
make
```

You should resolve any errors until you are able to completely build Redis. Once done, please run 'make clean' and perform the same steps needed to resolve the build errors on all other CDH nodes. Then retry installing the service on Cloudera Manager.

*Note:* Please feel free to submit pull requests that you think might be useful to others so they don't run into the same errors you encountered.




33 changes: 33 additions & 0 deletions assembly.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
<!--
# Copyright (c) 2015 Rakuten Marketing, LLC
# Licensed to Rakuten Marketing, LLC under one
# or more contributor license agreements. See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership. Rakuten Marketing licenses this file
# to you 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.
#
# Author: Aiman Najjar <[email protected]>
-->
<assembly>
<id>assemble</id>
<formats>
<format>jar</format>
</formats>
<includeBaseDirectory>false</includeBaseDirectory>
<fileSets>
<fileSet>
<directory>${project.basedir}/src</directory>
<outputDirectory>/</outputDirectory>
</fileSet>
</fileSets>
</assembly>
1 change: 1 addition & 0 deletions parcel/REDIS-2.8.17_0.1.0-el5.parcel
1 change: 1 addition & 0 deletions parcel/REDIS-2.8.17_0.1.0-el6.parcel
1 change: 1 addition & 0 deletions parcel/REDIS-2.8.17_0.1.0-lucid.parcel
Binary file added parcel/REDIS-2.8.17_0.1.0-precise.parcel
Binary file not shown.
1 change: 1 addition & 0 deletions parcel/REDIS-2.8.17_0.1.0-sles11.parcel
1 change: 1 addition & 0 deletions parcel/REDIS-2.8.17_0.1.0-squeeze.parcel
1 change: 1 addition & 0 deletions parcel/REDIS-2.8.17_0.1.0-trusty.parcel
1 change: 1 addition & 0 deletions parcel/REDIS-2.8.17_0.1.0-wheezy.parcel
Loading

0 comments on commit fb4233d

Please sign in to comment.