Review Board 1.7.22


SQOOP-1262 Sqoop2: Tool: Create user guide entry for the Tooling infrastructure

Review Request #16468 - Created Dec. 26, 2013 and updated

Jarek Cecho
SQOOP-1262
Reviewers
Sqoop
sqoop-sqoop2
Provided documentation for existing tools.
Built docs and checked the output.

Diff revision 2 (Latest)

1 2
1 2

  1. docs/src/site/sphinx/Installation.rst: Loading...
  2. docs/src/site/sphinx/Tools.rst: Loading...
  3. docs/src/site/sphinx/Upgrade.rst: Loading...
  4. docs/src/site/sphinx/index.rst: Loading...
docs/src/site/sphinx/Installation.rst
Revision c25d394a60a00658383391e6dd51c90142b7bdbc New Change
[20] 11 lines
[+20]
12
   WITHOUT WARRANTIES OR CONDITIONS OF lANY KIND, either express or implied.
12
   WITHOUT WARRANTIES OR CONDITIONS OF lANY KIND, either express or implied.
13
   See the License for the specific language governing permissions and
13
   See the License for the specific language governing permissions and
14
   limitations under the License.
14
   limitations under the License.
15

    
   
15

   
16

    
   
16

   
17
=======================================
17
============
18
Installation
18
Installation
19
=======================================
19
============
20

    
   
20

   
21
Sqoop ships as one binary package however it's compound from two separate parts - client and server. You need to install server on single node in your cluster. This node will then serve as an entry point for all connecting Sqoop clients. Server acts as a mapreduce client and therefore Hadoop must be installed and configured on machine hosting Sqoop server. Clients can be installed on any arbitrary number of machines. Client is not acting as a mapreduce client and thus you do not need to install Hadoop on nodes that will act only as a Sqoop client.
21
Sqoop ships as one binary package however it's compound from two separate parts - client and server. You need to install server on single node in your cluster. This node will then serve as an entry point for all connecting Sqoop clients. Server acts as a mapreduce client and therefore Hadoop must be installed and configured on machine hosting Sqoop server. Clients can be installed on any arbitrary number of machines. Client is not acting as a mapreduce client and thus you do not need to install Hadoop on nodes that will act only as a Sqoop client.
22

    
   
22

   
23
Server installation
23
Server installation
24
===================
24
===================
[+20] [20] 31 lines
[+20]
56
File ``sqoop_bootstrap.properties`` specifies which configuration provider should be used for loading configuration for rest of Sqoop server. Default value ``PropertiesConfigurationProvider`` should be sufficient.
56
File ``sqoop_bootstrap.properties`` specifies which configuration provider should be used for loading configuration for rest of Sqoop server. Default value ``PropertiesConfigurationProvider`` should be sufficient.
57

    
   
57

   
58

    
   
58

   
59
Second configuration file ``sqoop.properties`` contains remaining configuration properties that can affect Sqoop server. File is very well documented, so check if all configuration properties fits your environment. Default or very little tweaking should be sufficient most common cases.
59
Second configuration file ``sqoop.properties`` contains remaining configuration properties that can affect Sqoop server. File is very well documented, so check if all configuration properties fits your environment. Default or very little tweaking should be sufficient most common cases.
60

    
   
60

   

    
   
61
You can verify the Sqoop server configuration using `Verify Tool <Tools.html#verify>`__, for example::

    
   
62

   

    
   
63
  ./bin/sqoop.sh tool verify

    
   
64

   

    
   
65
Upon running the ``verify`` tool, you should see messages similar to the following::

    
   
66

   

    
   
67
  Verification was successful.

    
   
68
  Tool class org.apache.sqoop.tools.tool.VerifyTool has finished correctly

    
   
69

   

    
   
70
Consult `Verify Tool <Tools.html#upgrade>`__ documentation page in case of any failure.

    
   
71

   
61
Server Life Cycle
72
Server Life Cycle
62
-----------------
73
-----------------
63

    
   
74

   
64
After installation and configuration you can start Sqoop server with following command: ::
75
After installation and configuration you can start Sqoop server with following command: ::
65

    
   
76

   
[+20] [20] 18 lines
docs/src/site/sphinx/Tools.rst
New File
 
docs/src/site/sphinx/Upgrade.rst
Revision 49a76c2d5e57ca718575bbf47697709dd3d19ce8 New Change
 
docs/src/site/sphinx/index.rst
Revision f5d7d9263df5c3fabfcd1113496a7be431ade329 New Change
 
  1. docs/src/site/sphinx/Installation.rst: Loading...
  2. docs/src/site/sphinx/Tools.rst: Loading...
  3. docs/src/site/sphinx/Upgrade.rst: Loading...
  4. docs/src/site/sphinx/index.rst: Loading...