mobilize-hdfs 1.0.0

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+log
+config

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in mobilize-hadoop.gemspec
+gemspec

data/LICENSE.txt

@@ -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 2012 ngmoco, LLC
+
+   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.

data/README.md

@@ -0,0 +1,245 @@
+Mobilize-Hdfs
+===============
+
+Mobilize-Hdfs adds the power of hdfs to [mobilize-ssh][mobilize-ssh].
+* read, write, and copy hdfs files through Google
+Spreadsheets.
+
+Table Of Contents
+-----------------
+* [Overview](#section_Overview)
+* [Install](#section_Install)
+  * [Mobilize-Hdfs](#section_Install_Mobilize-Hdfs)
+  * [Install Dirs and Files](#section_Install_Dirs_and_Files)
+* [Configure](#section_Configure)
+  * [Hdfs](#section_Configure_Hdfs)
+* [Start](#section_Start)
+  * [Create Job](#section_Start_Create_Job)
+  * [Run Test](#section_Start_Run_Test)
+* [Meta](#section_Meta)
+* [Author](#section_Author)
+
+<a name='section_Overview'></a>
+Overview
+-----------
+
+* Mobilize-hdfs adds Hdfs methods to mobilize-ssh.
+
+<a name='section_Install'></a>
+Install
+------------
+
+Make sure you go through all the steps in the
+[mobilize-base][mobilize-base] and [mobilize-ssh][mobilize-ssh]
+install sections first.
+
+<a name='section_Install_Mobilize-Hdfs'></a>
+### Mobilize-Hdfs
+
+add this to your Gemfile:
+
+``` ruby
+gem "mobilize-hdfs"
+```
+
+or do
+
+  $ gem install mobilize-hdfs
+
+for a ruby-wide install.
+
+<a name='section_Install_Dirs_and_Files'></a>
+### Dirs and Files
+
+### Rakefile
+
+Inside the Rakefile in your project's root dir, make sure you have:
+
+``` ruby
+require 'mobilize-base/tasks'
+require 'mobilize-ssh/tasks'
+require 'mobilize-hdfs/tasks'
+```
+
+This defines rake tasks essential to run the environment.
+
+### Config Dir
+
+run
+
+  $ rake mobilize_hdfs:setup
+
+This will copy over a sample hadoop.yml to your config dir.
+
+<a name='section_Configure'></a>
+Configure
+------------
+
+<a name='section_Configure_Hadoop'></a>
+### Configure Hadoop
+
+* Hadoop is big data. That means we need to be careful when reading from
+the cluster as it could easily fill up our mongodb instance, RAM, local disk
+space, etc.
+* To achieve this, all hadoop operations, stage outputs, etc. are
+executed and stored on the cluster only. 
+  * The exceptions are:
+    * writing to the cluster from an external source, such as a google
+sheet. Here there
+is no risk as the external source has much more strict size limits than
+hdfs.
+    * reading from the cluster, such as for posting to google sheet. In
+this case, the read_limit parameter dictates the maximum amount that can
+be read. If the data is bigger than the read limit, an exception will be
+raised.
+
+The Hadoop configuration consists of:
+* output_cluster, which is the cluster where stage outputs will be
+stored. Clusters are defined in the clusters parameter as described
+below.
+* output_dir, which is the absolute path to the directory in HDFS that will store stage
+outputs. Directory names should end with a slash (/).
+* read_limit, which is the maximum size data that can be read from the
+cluster. This is applied at read time by piping hadoop dfs -cat | head
+-c <size limit>. Default is 1GB.
+* clusters - this defines aliases for clusters, which are used as
+parameters for Hdfs stages. Cluster aliases contain 5 parameters:
+  * namenode - defines the name and port for accessing the namenode
+    * name - namenode full name, as in namenode1.host.com
+    * port - namenode port, by default 50070
+  * gateway_node - defines the node that executes the cluster commands.
+  * exec_path - defines the path to the hadoop 
+This node must be defined in ssh.yml according to the specs in
+[mobilize-ssh][mobilize-ssh]. The gateway node can be the same for
+multiple clusters, depending on your cluster setup.
+  * exec_path - defines the path to the hadoop executable on the
+gateway_node.
+
+Sample hadoop.yml:
+
+``` yml
+---
+development:
+  output_cluster: dev_cluster
+  output_dir: /user/mobilize/development/
+  read_limit: 1000000000
+  clusters:
+    dev_cluster:
+      namenode:
+        name: dev_namenode.host.com
+        port: 50070
+      gateway_node: dev_hadoop_host
+      exec_path: /path/to/hadoop
+    dev_cluster_2:
+      namenode:
+        name: dev_namenode_2.host.com
+        port: 50070
+      gateway_node: dev_hadoop_host
+      exec_path: /path/to/hadoop
+test:
+  output_cluster: test_cluster
+  output_dir: /user/mobilize/test/
+  read_limit: 1000000000
+  clusters:
+    test_cluster:
+      namenode:
+        name: test_namenode.host.com
+        port: 50070
+      gateway_node: test_hadoop_host
+      exec_path: /path/to/hadoop
+    test_cluster_2:
+      namenode:
+        name: test_namenode_2.host.com
+        port: 50070
+      gateway_node: test_hadoop_host
+      exec_path: /path/to/hadoop
+production:
+  output_cluster: prod_cluster
+  output_dir: /user/mobilize/production/
+  read_limit: 1000000000
+  clusters:
+    prod_cluster:
+      namenode:
+        name: prod_namenode.host.com
+        port: 50070
+      gateway_node: prod_hadoop_host
+      exec_path: /path/to/hadoop
+    prod_cluster_2:
+      namenode:
+        name: prod_namenode_2.host.com
+        port: 50070
+      gateway_node: prod_hadoop_host
+      exec_path: /path/to/hadoop
+```
+
+<a name='section_Start'></a>
+Start
+-----
+
+<a name='section_Start_Create_Job'></a>
+### Create Job
+
+* For mobilize-hdfs, the following stages are available. 
+  * cluster and user are optional for all of the below.
+    * cluster defaults to output_cluster;
+    * user is treated the same way as in [mobilize-ssh][mobilize-ssh].
+  * hdfs.read `source:<hdfs_full_path>, user:<user>`, which reads the input path on the specified cluster.
+  * hdfs.write `source:<gsheet_full_path>, target:<hdfs_full_path>, user:<user>` 
+  * hdfs.copy `source:<source_hdfs_full_path>,target:<target_hdfs_full_path>,user:<user>`
+  * The gsheet_full_path should be of the form `<gbook_name>/<gsheet_name>`. The test uses "Requestor_mobilize(test)/test_hdfs_1.in".
+  * The hdfs_full_path is the cluster alias followed by full path on the cluster. 
+    * if a full path is supplied without a preceding cluster alias (e.g. "/user/mobilize/test/test_hdfs_1.in"), 
+      the output cluster will be used.
+    * The test uses "/user/mobilize/test/test_hdfs_1.in" for the initial
+write, then "test_cluster_2/user/mobilize/test/test_hdfs_copy.out" for
+the copy and subsequent read.
+  * both cluster arguments and user are optional. If copying from
+one cluster to another, your source_cluster gateway_node must be able to
+access both clusters.
+
+<a name='section_Start_Run_Test'></a>
+### Run Test
+
+To run tests, you will need to 
+
+1) go through the [mobilize-base][mobilize-base] and [mobilize-ssh][mobilize-ssh] tests first
+
+2) clone the mobilize-hdfs repository 
+
+From the project folder, run
+
+3) $ rake mobilize_hdfs:setup
+
+Copy over the config files from the mobilize-base and mobilize-ssh
+projects into the config dir, and populate the values in the hadoop.yml file.
+
+If you don't have two clusters, you can populate test_cluster_2 with the
+same cluster as your first.
+
+3) $ rake test
+
+* The test runs a 4 stage job:
+  * test_hdfs_1:
+    * `hdfs.write target:"/user/mobilize/test/test_hdfs_1.out", source:"Runner_mobilize(test)/test_hdfs_1.in"`
+    * `hdfs.copy source:"/user/mobilize/test/test_hdfs_1.out",target:"test_cluster_2/user/mobilize/test/test_hdfs_1_copy.out"`
+    * `hdfs.read source:"/user/mobilize/test/test_hdfs_1_copy.out"`
+    * `gsheet.write source:"stage3", target:"Runner_mobilize(test)/test_hdfs_1_copy.out"`
+  * at the end of the test, there should be a sheet named "test_hdfs_1_copy.out" with the same data as test_hdfs_1.in
+
+<a name='section_Meta'></a>
+Meta
+----
+
+* Code: `git clone git://github.com/ngmoco/mobilize-hdfs.git`
+* Home: <https://github.com/ngmoco/mobilize-hdfs>
+* Bugs: <https://github.com/ngmoco/mobilize-hdfs/issues>
+* Gems: <http://rubygems.org/gems/mobilize-hdfs>
+
+<a name='section_Author'></a>
+Author
+------
+
+Cassio Paes-Leme :: cpaesleme@ngmoco.com :: @cpaesleme
+
+[mobilize-base]: https://github.com/ngmoco/mobilize-base
+[mobilize-ssh]: https://github.com/ngmoco/mobilize-ssh