Repository: sqoop Updated Branches: refs/heads/sqoop2 3d004facd -> 1440159de
SQOOP-2614: Sqoop2: Update the document for using Jetty as server (Colin Ma via Jarek Jarcec Cecho) Project: http://git-wip-us.apache.org/repos/asf/sqoop/repo Commit: http://git-wip-us.apache.org/repos/asf/sqoop/commit/1440159d Tree: http://git-wip-us.apache.org/repos/asf/sqoop/tree/1440159d Diff: http://git-wip-us.apache.org/repos/asf/sqoop/diff/1440159d Branch: refs/heads/sqoop2 Commit: 1440159de79b0c934235eba71b06b6c0918a039b Parents: 3d004fa Author: Jarek Jarcec Cecho <[email protected]> Authored: Mon Oct 12 17:22:44 2015 -0700 Committer: Jarek Jarcec Cecho <[email protected]> Committed: Mon Oct 12 17:22:44 2015 -0700 ---------------------------------------------------------------------- docs/src/site/sphinx/CommandLineClient.rst | 2 +- docs/src/site/sphinx/ConnectorDevelopment.rst | 2 +- docs/src/site/sphinx/Installation.rst | 6 +++--- docs/src/site/sphinx/RESTAPI.rst | 2 +- docs/src/site/sphinx/SecurityGuideOnSqoop2.rst | 8 ++++---- 5 files changed, 10 insertions(+), 10 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/sqoop/blob/1440159d/docs/src/site/sphinx/CommandLineClient.rst ---------------------------------------------------------------------- diff --git a/docs/src/site/sphinx/CommandLineClient.rst b/docs/src/site/sphinx/CommandLineClient.rst index 91b30b2..8c4c592 100644 --- a/docs/src/site/sphinx/CommandLineClient.rst +++ b/docs/src/site/sphinx/CommandLineClient.rst @@ -114,7 +114,7 @@ Configure connection to Sqoop server - host port and web application name. Avail +-----------------------+---------------+--------------------------------------------------+ | ``-p``, ``--port`` | 12000 | TCP Port | +-----------------------+---------------+--------------------------------------------------+ -| ``-w``, ``--webapp`` | sqoop | Tomcat's web application name | +| ``-w``, ``--webapp`` | sqoop | Jetty's web application name | +-----------------------+---------------+--------------------------------------------------+ | ``-u``, ``--url`` | | Sqoop Server in url format | +-----------------------+---------------+--------------------------------------------------+ http://git-wip-us.apache.org/repos/asf/sqoop/blob/1440159d/docs/src/site/sphinx/ConnectorDevelopment.rst ---------------------------------------------------------------------- diff --git a/docs/src/site/sphinx/ConnectorDevelopment.rst b/docs/src/site/sphinx/ConnectorDevelopment.rst index 41389c8..60dae3f 100644 --- a/docs/src/site/sphinx/ConnectorDevelopment.rst +++ b/docs/src/site/sphinx/ConnectorDevelopment.rst @@ -488,7 +488,7 @@ Loading new connector say sqoop-foo-connector to the sqoop2, here are the steps 1. Create a ``sqoop-foo-connector.jar``. Make sure the jar contains the ``sqoopconnector.properties`` for it to be picked up by Sqoop -2. Add this jar to the ``org.apache.sqoop.classpath.extra`` property in the sqoop.properties located under the ``server/conf`` directory. +2. Add this jar to the ``org.apache.sqoop.classpath.extra`` property in the sqoop.properties located under the ``conf`` directory. :: http://git-wip-us.apache.org/repos/asf/sqoop/blob/1440159d/docs/src/site/sphinx/Installation.rst ---------------------------------------------------------------------- diff --git a/docs/src/site/sphinx/Installation.rst b/docs/src/site/sphinx/Installation.rst index c2de6c7..9d56875 100644 --- a/docs/src/site/sphinx/Installation.rst +++ b/docs/src/site/sphinx/Installation.rst @@ -44,7 +44,7 @@ Installing Dependencies Hadoop libraries must be available on node where you are planning to run Sqoop server with proper configuration for major services - ``NameNode`` and either ``JobTracker`` or ``ResourceManager`` depending whether you are running Hadoop 1 or 2. There is no need to run any Hadoop service on the same node as Sqoop server, just the libraries and configuration files must be available. -Path to Hadoop libraries is stored in file ``catalina.properties`` inside directory ``server/conf``. You need to change property called ``common.loader`` to contain all directories with your Hadoop libraries. The default expected locations are ``/usr/lib/hadoop`` and ``/usr/lib/hadoop/lib/``. Please check out the comments in the file for further description how to configure different locations. +Path to Hadoop libraries is stored in environment ``HADOOP_COMMON_HOME``, ``HADOOP_HDFS_HOME``, ``HADOOP_MAPRED_HOME`` and ``HADOOP_YARN_HOME``. You need to set the environment with your Hadoop libraries. If the environment ``HADOOP_HOME`` is set, the default expected locations are ``$HADOOP_HOME/share/hadoop/common``, ``$HADOOP_HOME/share/hadoop/hdfs``, ``$HADOOP_HOME/share/hadoop/mapreduce`` and ``$HADOOP_HOME/share/hadoop/yarn``. Lastly you might need to install JDBC drivers that are not bundled with Sqoop because of incompatible licenses. You can add any arbitrary Java jar file to Sqoop server by copying it into ``lib/`` directory. You can create this directory if it do not exists already. @@ -60,7 +60,7 @@ Further documentation pages will assume that you have the binaries on your ``$PA Configuring Server ------------------ -Before starting server you should revise configuration to match your specific environment. Server configuration files are stored in ``server/config`` directory of distributed artifact along side with other configuration files of Tomcat. +Before starting server you should revise configuration to match your specific environment. Server configuration files are stored in ``conf`` directory. 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. @@ -89,7 +89,7 @@ Similarly you can stop server using following command: :: sqoop2-server stop -By default Sqoop server daemons use ports 12000 and 12001. You can set ``SQOOP_HTTP_PORT`` and ``SQOOP_ADMIN_PORT`` in configuration file ``server/bin/setenv.sh`` to use different ports. +By default Sqoop server daemons use ports 12000. You can set ``org.apache.sqoop.jetty.port`` in configuration file ``conf/sqoop.properties`` to use different ports. Client installation =================== http://git-wip-us.apache.org/repos/asf/sqoop/blob/1440159d/docs/src/site/sphinx/RESTAPI.rst ---------------------------------------------------------------------- diff --git a/docs/src/site/sphinx/RESTAPI.rst b/docs/src/site/sphinx/RESTAPI.rst index d5b19dc..39aabc0 100644 --- a/docs/src/site/sphinx/RESTAPI.rst +++ b/docs/src/site/sphinx/RESTAPI.rst @@ -27,7 +27,7 @@ Initialization Before continuing further, make sure that the Sqoop server is running. -Then find out the details of the Sqoop server: ``host``, ``port`` and ``webapp``, and keep them in mind. Note that the sqoop server is running on Apache Tomcat. To exercise a REST API for Sqoop, you could assemble and send a HTTP request to an url corresponding to that API. Generally, the url contains the ``host`` on which the sqoop server is running, the ``port`` at which the sqoop server is listening to and ``webapp``, the context path at which the Sqoop server is registered in the Apache Tomcat engine. +Then find out the details of the Sqoop server: ``host``, ``port`` and ``webapp``, and keep them in mind. Note that the sqoop server is running on Jetty. To exercise a REST API for Sqoop, you could assemble and send a HTTP request to an url corresponding to that API. Generally, the url contains the ``host`` on which the sqoop server is running, the ``port`` at which the sqoop server is listening to and ``webapp``, the context path at which the Sqoop server is registered in the Jetty engine. Certain requests might need to contain some additional query parameters and post data. These parameters could be given via the HTTP headers, request body or both. All the content in the HTTP body is in ``JSON`` format. http://git-wip-us.apache.org/repos/asf/sqoop/blob/1440159d/docs/src/site/sphinx/SecurityGuideOnSqoop2.rst ---------------------------------------------------------------------- diff --git a/docs/src/site/sphinx/SecurityGuideOnSqoop2.rst b/docs/src/site/sphinx/SecurityGuideOnSqoop2.rst index fb35d4e..7194d3b 100644 --- a/docs/src/site/sphinx/SecurityGuideOnSqoop2.rst +++ b/docs/src/site/sphinx/SecurityGuideOnSqoop2.rst @@ -25,7 +25,7 @@ Simple Authentication Configuration ------------- -Modify Sqoop configuration file, normally in <Sqoop Folder>/server/config/sqoop.properties. +Modify Sqoop configuration file, normally in <Sqoop Folder>/conf/sqoop.properties. :: @@ -83,7 +83,7 @@ Create keytab and principal for Sqoop 2 via kadmin in command line. Configuration ------------- -Modify Sqoop configuration file, normally in <Sqoop Folder>/server/config/sqoop.properties. +Modify Sqoop configuration file, normally in <Sqoop Folder>/conf/sqoop.properties. :: @@ -134,7 +134,7 @@ If the Sqoop server has started successfully with Kerberos authentication, the f 2014-12-04 15:02:58,038 INFO security.KerberosAuthenticationHandler [org.apache.sqoop.security.authentication.KerberosAuthenticationHandler.secureLogin(KerberosAuthenticationHandler.java:84)] Using Kerberos authentication, principal [sqoop/[email protected]] keytab [/home/kerberos/sqoop.keytab] -If the Sqoop client was able to communicate with the Sqoop server, the following will be in <Sqoop Folder>/server/log/catalina.out: +If the Sqoop client was able to communicate with the Sqoop server, the following will be in <@LOGDIR>/sqoop.log : :: @@ -169,7 +169,7 @@ Users can create their own authentication modules. By performing the following s } } -- Modify configuration org.apache.sqoop.authentication.handler in <Sqoop Folder>/server/config/sqoop.properties and set it to the customized authentication handler class name. +- Modify configuration org.apache.sqoop.authentication.handler in <Sqoop Folder>/conf/sqoop.properties and set it to the customized authentication handler class name. - Restart the Sqoop server. Authorization
