Ver Fonte

HUE-2727 [livy] Flesh out interactive session documentation

Erick Tryzelaar há 10 anos atrás
pai
commit
cfa9f2c
1 ficheiros alterados com 56 adições e 38 exclusões
  1. 56 38
      apps/spark/java/README.rst

+ 56 - 38
apps/spark/java/README.rst

@@ -400,50 +400,68 @@ REST Objects
 Batch
 -----
 
-+----------------+--------------------------------------------------+-----------------+
-| name           | description                                      | type            |
-+================+==================================================+=================+
-| file           | archive holding the file                         | path (required) |
-+----------------+--------------------------------------------------+-----------------+
-| args           | command line arguments                           | list of strings |
-+----------------+--------------------------------------------------+-----------------+
-| className      | application's java/spark main class              | string          |
-+----------------+--------------------------------------------------+-----------------+
-| jars           | files to be placed on the java classpath         | list of paths   |
-+----------------+--------------------------------------------------+-----------------+
-| pyFiles        | files to be placed on the PYTHONPATH             | list of paths   |
-+----------------+--------------------------------------------------+-----------------+
-| files          | files to be placed in executor working directory | list of paths   |
-+----------------+--------------------------------------------------+-----------------+
-| driverMemory   | memory for driver                                | string          |
-+----------------+--------------------------------------------------+-----------------+
-| driverCores    | number of cores used by driver                   | int             |
-+----------------+--------------------------------------------------+-----------------+
-| executorMemory | memory for executor                              | string          |
-+----------------+--------------------------------------------------+-----------------+
-| executorCores  | number of cores used by executor                 | int             |
-+----------------+--------------------------------------------------+-----------------+
-| numExecutors   | number of executor                               | int             |
-+----------------+--------------------------------------------------+-----------------+
-| archives       |                                                  | list of paths   |
-+----------------+--------------------------------------------------+-----------------+
++----------------+--------------------------------------------------------------------------------+-----------------+
+| name           | description                                                                    | type            |
++================+================================================================================+=================+
+| file           | archive holding the file                                                       | path (required) |
++----------------+--------------------------------------------------------------------------------+-----------------+
+| args           | command line arguments                                                         | list of strings |
++----------------+--------------------------------------------------------------------------------+-----------------+
+| className      | application's java/spark main class                                            | string          |
++----------------+--------------------------------------------------------------------------------+-----------------+
+| jars           | files to be placed on the java classpath                                       | list of paths   |
++----------------+--------------------------------------------------------------------------------+-----------------+
+| pyFiles        | files to be placed on the PYTHONPATH                                           | list of paths   |
++----------------+--------------------------------------------------------------------------------+-----------------+
+| files          | files to be placed in executor working directory                               | list of paths   |
++----------------+--------------------------------------------------------------------------------+-----------------+
+| driverMemory   | memory for driver                                                              | string          |
++----------------+--------------------------------------------------------------------------------+-----------------+
+| driverCores    | number of cores used by driver (YARN mode only)                                | int             |
++----------------+--------------------------------------------------------------------------------+-----------------+
+| executorMemory | memory for executor                                                            | string          |
++----------------+--------------------------------------------------------------------------------+-----------------+
+| executorCores  | number of cores used by executor                                               | int             |
++----------------+--------------------------------------------------------------------------------+-----------------+
+| numExecutors   | number of executors (YARN mode only)                                           | int             |
++----------------+--------------------------------------------------------------------------------+-----------------+
+| archives       | Archives to be uncompressed in the executor working directory (YARN mode only) | list of paths   |
++----------------+--------------------------------------------------------------------------------+-----------------+
 
 Session
 -------
 
 Sessions represent an interactive shell.
 
-+-----------+-------------------------------+------------------+
-| name      | description                   | type             |
-+===========+===============================+==================+
-| id        | The session id                | string           |
-+-----------+-------------------------------+------------------+
-| state     | The state of the session      | `session state`_ |
-+-----------+-------------------------------+------------------+
-| kind      | The session kind              | `session kind`_  |
-+-----------+-------------------------------+------------------+
-| proxyUser | The user running this session | optional string  |
-+-----------+-------------------------------+------------------+
++----------------+--------------------------------------------------------------------------------+------------------+
+| name           | description                                                                    | type             |
++================+================================================================================+==================+
+| id             | The session id                                                                 | string           |
++----------------+--------------------------------------------------------------------------------+------------------+
+| state          | The state of the session                                                       | `session state`_ |
++----------------+--------------------------------------------------------------------------------+------------------+
+| kind           | The session kind                                                               | `session kind`_  |
++----------------+--------------------------------------------------------------------------------+------------------+
+| proxyUser      | The user running this session                                                  | optional string  |
++----------------+--------------------------------------------------------------------------------+------------------+
+| jars           | files to be placed on the java classpath                                       | list of paths    |
++----------------+--------------------------------------------------------------------------------+------------------+
+| pyFiles        | files to be placed on the PYTHONPATH                                           | list of paths    |
++----------------+--------------------------------------------------------------------------------+------------------+
+| files          | files to be placed in executor working directory                               | list of paths    |
++----------------+--------------------------------------------------------------------------------+------------------+
+| driverMemory   | memory for driver                                                              | string           |
++----------------+--------------------------------------------------------------------------------+------------------+
+| driverCores    | number of cores used by driver (YARN mode only)                                | int              |
++----------------+--------------------------------------------------------------------------------+------------------+
+| executorMemory | memory for executor                                                            | string           |
++----------------+--------------------------------------------------------------------------------+------------------+
+| executorCores  | number of cores used by executor                                               | int              |
++----------------+--------------------------------------------------------------------------------+------------------+
+| numExecutors   | number of executors (YARN mode only)                                           | int              |
++----------------+--------------------------------------------------------------------------------+------------------+
+| archives       | Archives to be uncompressed in the executor working directory (YARN mode only) | list of paths    |
++----------------+--------------------------------------------------------------------------------+------------------+
 
 Session State
 ^^^^^^^^^^^^^