You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@lens.apache.org by jd...@apache.org on 2015/01/21 11:55:01 UTC

incubator-lens git commit: LENS-206. Update diagrams and their sources in site

Repository: incubator-lens
Updated Branches:
  refs/heads/master 0c3b0537f -> acdfd299f


LENS-206. Update diagrams and their sources in site

Signed-off-by: jdhok <ja...@inmobi.com>


Project: http://git-wip-us.apache.org/repos/asf/incubator-lens/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-lens/commit/acdfd299
Tree: http://git-wip-us.apache.org/repos/asf/incubator-lens/tree/acdfd299
Diff: http://git-wip-us.apache.org/repos/asf/incubator-lens/diff/acdfd299

Branch: refs/heads/master
Commit: acdfd299f05649e64170fc94a5d9f3ae1903757d
Parents: 0c3b053
Author: Amareshwari Sriramdasu <am...@inmobi.com>
Authored: Tue Jan 20 17:19:43 2015 +0530
Committer: jdhok <ja...@inmobi.com>
Committed: Wed Jan 21 16:23:19 2015 +0530

----------------------------------------------------------------------
 src/site/apt/admin/deployment.apt           |  51 +++++++++++------------
 src/site/apt/user/index.apt                 |   9 ++--
 src/site/datalayout.pptx                    | Bin 0 -> 95671 bytes
 src/site/diagrams.pptx                      | Bin 91507 -> 99574 bytes
 src/site/resources/images/deployment.png    | Bin 58113 -> 49493 bytes
 src/site/resources/images/query-states.png  | Bin 95452 -> 0 bytes
 src/site/resources/images/querystate.png    | Bin 95452 -> 59582 bytes
 src/site/resources/images/server-design.png | Bin 104265 -> 0 bytes
 src/site/resources/images/serverdesign.png  | Bin 104265 -> 64082 bytes
 9 files changed, 29 insertions(+), 31 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-lens/blob/acdfd299/src/site/apt/admin/deployment.apt
----------------------------------------------------------------------
diff --git a/src/site/apt/admin/deployment.apt b/src/site/apt/admin/deployment.apt
index bbaa56c..57be521 100644
--- a/src/site/apt/admin/deployment.apt
+++ b/src/site/apt/admin/deployment.apt
@@ -23,54 +23,51 @@ Lens server deployment
   Make sure you have finished {{{../gettingstarted/install-steps.html} Install and run}} doc,
   before proceeding.
 
-  Lens server requires Hive metastore. Hive server is required if Hive is one
-  of the execution engines.
+  Lens server requires Hive metastore for providing OLAP cube metastore. Its also requires a DB for storing system
+  tables, which can be shared with Hive metastore server's underlying DB as well. Hive server is required if Hive is
+  one of the execution engines.
 
-  Typical deployment suggested is depicted in the following  diagram
+  Typical deployment suggested is depicted in the following diagram (the boxes and lines in blue show server level
+  components, the ones in green show execution components)
 
 [/images/deployment.png] Lens Server deployment
 
-  It requires HiveMetastore server, HiveServer2 and Lens Server running on different machines.
-
+  Its recommended HiveMetastore server, HiveServer2 and Lens Server running on different machines.
 
 * Dependencies and their versions
 
    * Requires java 1.6+
 
-   * Requires Hadoop cdh3u5+
+   * Requires Hadoop 2.x+
 
    * Requires Hive metastore 0.13+
 
    * Requires Hive server2 0.13+
-   
+
 * Restart and recovery
 
-  Lens server should not have problems with Hive Metastore server, Hive Server2 or Hadoop restarts. Lens server can persist its state before going and recover from previous state upon restart. 
-  
+  Lens server should not have problems with Hive Metastore server, Hive Server2 or Hadoop restarts. Lens server can
+   persist its state before going and recover from previous state upon restart.
+
   * Recoverability
-  
-  ** To enable lens server with recoverability, i.e. to allow users access queries before restart, lens server should be started with lens.server.restart.enabled set to true.
-  Admin can set this to false if no recoverability is required.
 
-  * Restarting 
+  ** To enable lens server with recoverability, i.e. to allow users access queries before restart, lens server should be
+   started with lens.server.restart.enabled set to true. Admin can set this to false if no recoverability is required.
+
+  * Restarting
+
+  ** To start the lens server a fresh lens.server.recover.onrestart should be disabled. If it is true, the server will
+   load its persisted state before restart.
 
-  ** To start the lens server a fresh lens.server.recover.onrestart should be disabled. If it is true, the server will load its persisted state before restart.
-  
-  
 * Server modes
 
-  Lens server can be started in various modes. The server mode can be specified via configuration when it is starting up. Available modes are
-  
+  Lens server can be started in various modes. The server mode can be specified via configuration when it is starting
+   up. Available modes are
+
   * READ_ONLY : Allows all requests on sesssion resource and Only GET requests on all other resources
-  
+
   * METASTORE_READONLY : Allows Only GET requests on metastore service and all other requests on other services
-  
+
   * METASTORE_NODROP: DELETE requests on metastore are not accepted, all other requests are accepted
-  
-  * OPEN: This is the default mode. All requests are accepted
-  
-  
-  
-  
-  
 
+  * OPEN: This is the default mode. All requests are accepted

http://git-wip-us.apache.org/repos/asf/incubator-lens/blob/acdfd299/src/site/apt/user/index.apt
----------------------------------------------------------------------
diff --git a/src/site/apt/user/index.apt b/src/site/apt/user/index.apt
index ffcc12c..d48c734 100644
--- a/src/site/apt/user/index.apt
+++ b/src/site/apt/user/index.apt
@@ -128,9 +128,12 @@ Lens User Guide
 	For each query Lens server will poll the chosen backend engine for query status. A GET on the query endpoint returns the latest status of the query.
 
 
-		The <<RUNNING>> state indicates that the query is currently being processed by the query backend. 
+  The <<RUNNING>> state indicates that the query is currently being processed by the query backend. 
+  After the <<RUNNING>> state, the query can enter either the <<EXECUTED>> or <<FAILED>> states, depending on the result of query execution.
+  If the execution is successful, then server would format the result if required and then set the state to
+  <<SUCCESSFUL>> or <<FAILED>> if formatting fails.
 
-		After the <<RUNNING>> state, the query can enter either the <<SUCCESSFUL>> or <<FAILED>> states, depending on the result of query execution. If the query is <<SUCCESSFUL>>, its result set can be retrieved using the result set API call, by passing the session handle and query handle. The query can be executed once, and its results can be fetched multiple times unless the query has been purged from Lens server state.
+	 If the query is <<SUCCESSFUL>>, its result set can be retrieved using the result set API call, by passing the session handle and query handle. The query can be executed once, and its results can be fetched multiple times unless the query has been purged from Lens server state.
 
 	In any state, if the user requests that the query be cancelled, the query will enter into <<CANCELLED>> state. Query can be cancelled by sending a DELETE at the query endpoint. 
 
@@ -157,6 +160,4 @@ Lens User Guide
 	For Java clients, JAXB classes corresponding to each of the endpoints are available.
 
 
-* Quota service
-
 

http://git-wip-us.apache.org/repos/asf/incubator-lens/blob/acdfd299/src/site/datalayout.pptx
----------------------------------------------------------------------
diff --git a/src/site/datalayout.pptx b/src/site/datalayout.pptx
new file mode 100644
index 0000000..4ce429a
Binary files /dev/null and b/src/site/datalayout.pptx differ

http://git-wip-us.apache.org/repos/asf/incubator-lens/blob/acdfd299/src/site/diagrams.pptx
----------------------------------------------------------------------
diff --git a/src/site/diagrams.pptx b/src/site/diagrams.pptx
index f7136b1..3769dec 100644
Binary files a/src/site/diagrams.pptx and b/src/site/diagrams.pptx differ

http://git-wip-us.apache.org/repos/asf/incubator-lens/blob/acdfd299/src/site/resources/images/deployment.png
----------------------------------------------------------------------
diff --git a/src/site/resources/images/deployment.png b/src/site/resources/images/deployment.png
index 2f2c914..9e24733 100644
Binary files a/src/site/resources/images/deployment.png and b/src/site/resources/images/deployment.png differ

http://git-wip-us.apache.org/repos/asf/incubator-lens/blob/acdfd299/src/site/resources/images/query-states.png
----------------------------------------------------------------------
diff --git a/src/site/resources/images/query-states.png b/src/site/resources/images/query-states.png
deleted file mode 100644
index 9cbe0e5..0000000
Binary files a/src/site/resources/images/query-states.png and /dev/null differ

http://git-wip-us.apache.org/repos/asf/incubator-lens/blob/acdfd299/src/site/resources/images/querystate.png
----------------------------------------------------------------------
diff --git a/src/site/resources/images/querystate.png b/src/site/resources/images/querystate.png
index 9cbe0e5..bcadc93 100644
Binary files a/src/site/resources/images/querystate.png and b/src/site/resources/images/querystate.png differ

http://git-wip-us.apache.org/repos/asf/incubator-lens/blob/acdfd299/src/site/resources/images/server-design.png
----------------------------------------------------------------------
diff --git a/src/site/resources/images/server-design.png b/src/site/resources/images/server-design.png
deleted file mode 100644
index e8b69dd..0000000
Binary files a/src/site/resources/images/server-design.png and /dev/null differ

http://git-wip-us.apache.org/repos/asf/incubator-lens/blob/acdfd299/src/site/resources/images/serverdesign.png
----------------------------------------------------------------------
diff --git a/src/site/resources/images/serverdesign.png b/src/site/resources/images/serverdesign.png
index e8b69dd..bf49b55 100644
Binary files a/src/site/resources/images/serverdesign.png and b/src/site/resources/images/serverdesign.png differ