Repository: incubator-zeppelin Updated Branches: refs/heads/gh-pages 6de664d28 -> f6cf52e34
Zeppelin interpreter documentation and interpreter REST API documentation Add documentation about the role of Interpreters, interpreters group and interpreters settings in Zeppelin and docs about interpreter REST API. Please review verify that https://github.com/eranwitkon/incubator-zeppelin/blob/gh-pages/docs/manual/interpreters.md is correct... Author: eranwitkon <[email protected]> Closes #256 from eranwitkon/gh-pages and squashes the following commits: 0d5ac82 [eranwitkon] remove TODO comments and fix JSONVie URL e10d467 [eranwitkon] Merge remote-tracking branch 'upstream/gh-pages' into gh-pages c0ac1c0 [eranwitkon] Fix typo and re-phrase What is zeppelin interpreter section in interpreters.md 0355216 [eranwitkon] Merge remote-tracking branch 'upstream/gh-pages' into gh-pages e870699 [eranwitkon] Add documentation about the role of Interpreters, interpreters group and interpreters settings in Zeppelin and docs about interpreter REST API Project: http://git-wip-us.apache.org/repos/asf/incubator-zeppelin/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-zeppelin/commit/f6cf52e3 Tree: http://git-wip-us.apache.org/repos/asf/incubator-zeppelin/tree/f6cf52e3 Diff: http://git-wip-us.apache.org/repos/asf/incubator-zeppelin/diff/f6cf52e3 Branch: refs/heads/gh-pages Commit: f6cf52e34095bc11d80bb921064e5abe8414cbe9 Parents: 6de664d Author: eranwitkon <[email protected]> Authored: Fri Aug 28 13:24:07 2015 +0300 Committer: Lee moon soo <[email protected]> Committed: Mon Aug 31 07:20:13 2015 -0700 ---------------------------------------------------------------------- .../img/screenshots/interpreter_create.png | Bin 0 -> 10591 bytes .../img/screenshots/interpreter_setting.png | Bin 0 -> 14602 bytes .../screenshots/interpreter_setting_spark.png | Bin 0 -> 40237 bytes docs/index.md | 5 + docs/manual/interpreters.md | 38 ++++ docs/rest-api/rest-interpreter.md | 195 +++++++++++++++++++ .../rest-json-interpreter-create-response.json | 1 + .../rest-json/rest-json-interpreter-create.json | 1 + .../rest-json-interpreter-delete-response.json | 1 + .../rest-json/rest-json-interpreter-list.json | 1 + .../rest-json-interpreter-setting.json | 1 + .../rest-json-interpreter-update-response.json | 1 + .../rest-json/rest-json-interpreter-update.json | 1 + index.md | 2 +- 14 files changed, 246 insertions(+), 1 deletion(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-zeppelin/blob/f6cf52e3/assets/themes/zeppelin/img/screenshots/interpreter_create.png ---------------------------------------------------------------------- diff --git a/assets/themes/zeppelin/img/screenshots/interpreter_create.png b/assets/themes/zeppelin/img/screenshots/interpreter_create.png new file mode 100644 index 0000000..dacd278 Binary files /dev/null and b/assets/themes/zeppelin/img/screenshots/interpreter_create.png differ http://git-wip-us.apache.org/repos/asf/incubator-zeppelin/blob/f6cf52e3/assets/themes/zeppelin/img/screenshots/interpreter_setting.png ---------------------------------------------------------------------- diff --git a/assets/themes/zeppelin/img/screenshots/interpreter_setting.png b/assets/themes/zeppelin/img/screenshots/interpreter_setting.png new file mode 100644 index 0000000..d6b9a21 Binary files /dev/null and b/assets/themes/zeppelin/img/screenshots/interpreter_setting.png differ http://git-wip-us.apache.org/repos/asf/incubator-zeppelin/blob/f6cf52e3/assets/themes/zeppelin/img/screenshots/interpreter_setting_spark.png ---------------------------------------------------------------------- diff --git a/assets/themes/zeppelin/img/screenshots/interpreter_setting_spark.png b/assets/themes/zeppelin/img/screenshots/interpreter_setting_spark.png new file mode 100644 index 0000000..83b6249 Binary files /dev/null and b/assets/themes/zeppelin/img/screenshots/interpreter_setting_spark.png differ http://git-wip-us.apache.org/repos/asf/incubator-zeppelin/blob/f6cf52e3/docs/index.md ---------------------------------------------------------------------- diff --git a/docs/index.md b/docs/index.md index 41e1b63..5fa9c6d 100644 --- a/docs/index.md +++ b/docs/index.md @@ -17,6 +17,8 @@ group: nav-right ### Interpreter +**[Interpreters in zeppelin](manual/interpreters.html)** + * [flink](../docs/pleasecontribute.html) * [hive](../docs/pleasecontribute.html) * [ignite](../docs/pleasecontribute.html) @@ -40,6 +42,9 @@ group: nav-right * [Dynamic Form](./manual/dynamicform.html) * [Notebook as Homepage](./manual/notebookashomepage.html) +### REST API + * [Interpreter API](./rest-api/rest-interpreter.html) + * [Notebook API](../docs/pleasecontribute.html) ### Development http://git-wip-us.apache.org/repos/asf/incubator-zeppelin/blob/f6cf52e3/docs/manual/interpreters.md ---------------------------------------------------------------------- diff --git a/docs/manual/interpreters.md b/docs/manual/interpreters.md new file mode 100644 index 0000000..ab9fdf4 --- /dev/null +++ b/docs/manual/interpreters.md @@ -0,0 +1,38 @@ +--- +layout: page +title: "Interpreters" +description: "" +group: manual +--- +{% include JB/setup %} + + +## Interpreters in zeppelin + +This section explain the role of Interpreters, interpreters group and interpreters settings in Zeppelin. +Zeppelin interpreter concept allows any language/data-processing-backend to be plugged into Zeppelin. +Currently Zeppelin supports many interpreters such as Scala(with Apache Spark), Python(with Apache Spark), SparkSQL, Hive, Markdown and Shell. + +### What is zeppelin interpreter? + +Zeppelin Interpreter is the plug-in which enable zeppelin user to use a specific language/data-processing-backend. For example to use scala code in Zeppelin, you need ```spark``` interpreter. + +When you click on the ```+Create``` button in the interpreter page the interpreter drop-down list box will present all the available interpreters on your server. + +<img src="../../assets/themes/zeppelin/img/screenshots/interpreter_create.png"> + +### What is zeppelin interpreter setting? + +Zeppelin interpreter setting is the configuration of a given interpreter on zeppelin server. For example, the properties requried for hive JDBC interpreter to connect to the Hive server. + +<img src="../../assets/themes/zeppelin/img/screenshots/interpreter_setting.png"> +### What is zeppelin interpreter group? + +Every Interpreter belongs to an InterpreterGroup. InterpreterGroup is a unit of start/stop interpreter. +By default, every interpreter belong to a single group but the group might contain more interpreters. For example, spark interpreter group include spark support, pySpark, +SparkSQL and the dependency loader. + +Technically, Zeppelin interpreters from the same group are running in the same JVM. + +Interpreters belong to a single group a registered together and all of their properties are listed in the interpreter setting. +<img src="../../assets/themes/zeppelin/img/screenshots/interpreter_setting_spark.png"> http://git-wip-us.apache.org/repos/asf/incubator-zeppelin/blob/f6cf52e3/docs/rest-api/rest-interpreter.md ---------------------------------------------------------------------- diff --git a/docs/rest-api/rest-interpreter.md b/docs/rest-api/rest-interpreter.md new file mode 100644 index 0000000..8bd56a0 --- /dev/null +++ b/docs/rest-api/rest-interpreter.md @@ -0,0 +1,195 @@ +--- +layout: page +title: "Interpreter REST API" +description: "" +group: rest-api +--- +{% include JB/setup %} + +## Zeppelin REST API + Zeppelin provides several REST API's for interaction and remote activation of zeppelin functionality. + + All REST API are available starting with the following endpoint ```http://[zeppelin-server]:[zeppelin-port]/api``` + + Note that zeppein REST API receive or return JSON objects, it it recomended you install some JSON view such as + [JSONView](https://chrome.google.com/webstore/detail/jsonview/chklaanhfefbnpoihckbnefhakgolnmc) + + + If you work with zeppelin and find a need for an additional REST API please [file an issue or send us mail](../../community.html) + + <br /> +### Interpreter REST API list + + The role of registered interpreters, settings and interpreters group is described [here](../manual/interpreters.html) + + <table class="table-configuration"> + <col width="200"> + <tr> + <th>List registered interpreters</th> + <th></th> + </tr> + <tr> + <td>Description</td> + <td>This ```GET``` method return all the registered interpreters available on the server.</td> + </tr> + <tr> + <td>URL</td> + <td>```http://[zeppelin-server]:[zeppelin-port]/api/interpreter```</td> + </tr> + <tr> + <td>Success code</td> + <td>200</td> + </tr> + <tr> + <td> Fail code</td> + <td> 500 </td> + </tr> + <tr> + <td> sample JSON response + </td> + <td> [Interpreter list sample](rest-json/rest-json-interpreter-list.json) + </td> + </tr> + </table> + +<br/> + + <table class="table-configuration"> + <col width="200"> + <tr> + <th>List interpreters settings</th> + <th></th> + </tr> + <tr> + <td>Description</td> + <td>This ```GET``` method return all the interpreters settings registered on the server.</td> + </tr> + <tr> + <td>URL</td> + <td>```http://[zeppelin-server]:[zeppelin-port]/api/interpreter/setting```</td> + </tr> + <tr> + <td>Success code</td> + <td>200</td> + </tr> + <tr> + <td> Fail code</td> + <td> 500 </td> + </tr> + <tr> + <td> sample JSON response + </td> + <td> [Setting list sample](rest-json/rest-json-interpreter-setting.json) + </td> + </tr> + </table> + +<br/> + + <table class="table-configuration"> + <col width="200"> + <tr> + <th>Create an interpreter setting</th> + <th></th> + </tr> + <tr> + <td>Description</td> + <td>This ```POST``` method adds a new interpreter setting using a registered interpreter to the server.</td> + </tr> + <tr> + <td>URL</td> + <td>```http://[zeppelin-server]:[zeppelin-port]/api/interpreter/setting```</td> + </tr> + <tr> + <td>Success code</td> + <td>201</td> + </tr> + <tr> + <td> Fail code</td> + <td> 500 </td> + </tr> + <tr> + <td> sample JSON input + </td> + <td> [Create JSON sample](rest-json/rest-json-interpreter-create.json) + </td> + </tr> + <tr> + <td> sample JSON response + </td> + <td> [Create response sample](rest-json/rest-json-interpreter-create-response.json) + </td> + </tr> + </table> + + +<br/> + + <table class="table-configuration"> + <col width="200"> + <tr> + <th>Update an interpreter setting</th> + <th></th> + </tr> + <tr> + <td>Description</td> + <td>This ```PUT``` method updates an interpreter setting with new properties.</td> + </tr> + <tr> + <td>URL</td> + <td>```http://[zeppelin-server]:[zeppelin-port]/api/interpreter/setting/[interpreter ID]```</td> + </tr> + <tr> + <td>Success code</td> + <td>200</td> + </tr> + <tr> + <td> Fail code</td> + <td> 500 </td> + </tr> + <tr> + <td> sample JSON input + </td> + <td> [Update JSON sample](rest-json/rest-json-interpreter-update.json) + </td> + </tr> + <tr> + <td> sample JSON response + </td> + <td> [Update response sample](rest-json/rest-json-interpreter-update-response.json) + </td> + </tr> + </table> + + +<br/> + + <table class="table-configuration"> + <col width="200"> + <tr> + <th>Delete an interpreter setting</th> + <th></th> + </tr> + <tr> + <td>Description</td> + <td>This ```DELETE``` method deletes an given interpreter setting.</td> + </tr> + <tr> + <td>URL</td> + <td>```http://[zeppelin-server]:[zeppelin-port]/api/interpreter/setting/[interpreter ID]```</td> + </tr> + <tr> + <td>Success code</td> + <td>200</td> + </tr> + <tr> + <td> Fail code</td> + <td> 500 </td> + </tr> + <tr> + <td> sample JSON response + </td> + <td> [Delete response sample](rest-json/rest-json-interpreter-delete-response.json) + </td> + </tr> + </table> http://git-wip-us.apache.org/repos/asf/incubator-zeppelin/blob/f6cf52e3/docs/rest-api/rest-json/rest-json-interpreter-create-response.json ---------------------------------------------------------------------- diff --git a/docs/rest-api/rest-json/rest-json-interpreter-create-response.json b/docs/rest-api/rest-json/rest-json-interpreter-create-response.json new file mode 100644 index 0000000..43b3f81 --- /dev/null +++ b/docs/rest-api/rest-json/rest-json-interpreter-create-response.json @@ -0,0 +1 @@ +{"status":"CREATED","message":""} \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-zeppelin/blob/f6cf52e3/docs/rest-api/rest-json/rest-json-interpreter-create.json ---------------------------------------------------------------------- diff --git a/docs/rest-api/rest-json/rest-json-interpreter-create.json b/docs/rest-api/rest-json/rest-json-interpreter-create.json new file mode 100644 index 0000000..25aba39 --- /dev/null +++ b/docs/rest-api/rest-json/rest-json-interpreter-create.json @@ -0,0 +1 @@ +{"name":"md2","group":"md","properties":{"propname":"propvalue"},"interpreterGroup":[{"class":"org.apache.zeppelin.markdown.Markdown","name":"md"}],"option":{"remote":true}} \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-zeppelin/blob/f6cf52e3/docs/rest-api/rest-json/rest-json-interpreter-delete-response.json ---------------------------------------------------------------------- diff --git a/docs/rest-api/rest-json/rest-json-interpreter-delete-response.json b/docs/rest-api/rest-json/rest-json-interpreter-delete-response.json new file mode 100644 index 0000000..48aa9be --- /dev/null +++ b/docs/rest-api/rest-json/rest-json-interpreter-delete-response.json @@ -0,0 +1 @@ +{"status":"OK"} \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-zeppelin/blob/f6cf52e3/docs/rest-api/rest-json/rest-json-interpreter-list.json ---------------------------------------------------------------------- diff --git a/docs/rest-api/rest-json/rest-json-interpreter-list.json b/docs/rest-api/rest-json/rest-json-interpreter-list.json new file mode 100644 index 0000000..2489c53 --- /dev/null +++ b/docs/rest-api/rest-json/rest-json-interpreter-list.json @@ -0,0 +1 @@ +{"status":"OK","message":"","body":{"md.md":{"name":"md","group":"md","className":"org.apache.zeppelin.markdown.Markdown","properties":{},"path":"/home/Downloads/incubator-zeppelin-master/interpreter/md"},"flink.flink":{"name":"flink","group":"flink","className":"org.apache.zeppelin.flink.FlinkInterpreter","properties":{"port":{"defaultValue":"6123","description":"port of running JobManager"},"host":{"defaultValue":"local","description":"host name of running JobManager. \u0027local\u0027 runs flink in local mode"}},"path":"/home/Downloads/incubator-zeppelin-master/interpreter/flink"},"ignite.ignitesql":{"name":"ignitesql","group":"ignite","className":"org.apache.zeppelin.ignite.IgniteSqlInterpreter","properties":{"ignite.jdbc.url":{"defaultValue":"jdbc:ignite://localhost:11211/","description":"Ignite JDBC connection URL."}},"path":"/home/Downloads/incubator-zeppelin-master/interpreter/ignite"},"tajo.tql":{"name":"tql","group":"tajo","className":"org.apache.zeppelin.tajo.TajoInterpre ter","properties":{"tajo.jdbc.uri":{"defaultValue":"jdbc:tajo://localhost:26002/default","description":"The URL for TajoServer."}},"path":"/home/Downloads/incubator-zeppelin-master/interpreter/tajo"},"sh.sh":{"name":"sh","group":"sh","className":"org.apache.zeppelin.shell.ShellInterpreter","properties":{},"path":"/home/Downloads/incubator-zeppelin-master/interpreter/sh"},"hive.hql":{"name":"hql","group":"hive","className":"org.apache.zeppelin.hive.HiveInterpreter","properties":{"hive.hiveserver2.password":{"defaultValue":"","description":"The password for the hive user"},"hive.hiveserver2.user":{"defaultValue":"hive","description":"The hive user"},"hive.hiveserver2.url":{"defaultValue":"jdbc:hive2://localhost:10000","description":"The URL for HiveServer2."}},"path":"/home/Downloads/incubator-zeppelin-master/interpreter/hive"},"ignite.ignite":{"name":"ignite","group":"ignite","className":"org.apache.zeppelin.ignite.IgniteInterpreter","properties":{"ignite.config.url":{"defaultValue": "","description":"Configuration URL. Overrides all other settings."},"ignite.peerClassLoadingEnabled":{"defaultValue":"true","description":"Peer class loading enabled. true or false"},"ignite.clientMode":{"defaultValue":"true","description":"Client mode. true or false"},"ignite.addresses":{"defaultValue":"127.0.0.1:47500..47509","description":"Coma separated list of addresses (e.g. 127.0.0.1:47500 or 127.0.0.1:47500..47509)"}},"path":"/home/Downloads/incubator-zeppelin-master/interpreter/ignite"},"psql.sql":{"name":"sql","group":"psql","className":"org.apache.zeppelin.postgresql.PostgreSqlInterpreter","properties":{"postgresql.password":{"defaultValue":"","description":"The PostgreSQL user password"},"postgresql.max.result":{"defaultValue":"1000","description":"Max number of SQL result to display."},"postgresql.user":{"defaultValue":"gpadmin","description":"The PostgreSQL user name"},"postgresql.url":{"defaultValue":"jdbc:postgresql://localhost:5432/","description":"The URL for Post greSQL."},"postgresql.driver.name":{"defaultValue":"org.postgresql.Driver","description":"JDBC Driver Name"}},"path":"/home/Downloads/incubator-zeppelin-master/interpreter/psql"},"geode.oql":{"name":"oql","group":"geode","className":"org.apache.zeppelin.geode.GeodeOqlInterpreter","properties":{"geode.max.result":{"defaultValue":"1000","description":"Max number of OQL result to display."},"geode.locator.host":{"defaultValue":"localhost","description":"The Geode Locator Host."},"geode.locator.port":{"defaultValue":"10334","description":"The Geode Locator Port"}},"path":"/home/Downloads/incubator-zeppelin-master/interpreter/geode"},"cassandra.cassandra":{"name":"cassandra","group":"cassandra","className":"org.apache.zeppelin.cassandra.CassandraInterpreter","properties":{"cassandra.pooling.new.connection.threshold.remote":{"defaultValue":"100","description":"Cassandra new connection threshold remove. Protocol V2 and below default \u003d 100Protocol V3 and above default \u003d 200"},"cas sandra.query.default.fetchSize":{"defaultValue":"5000","description":"Cassandra query default fetch size. Default \u003d 5000"},"cassandra.socket.tcp.no_delay":{"defaultValue":"true","description":"Cassandra socket TCP no delay. Default \u003d true"},"cassandra.hosts":{"defaultValue":"localhost","description":"Comma separated Cassandra hosts (DNS name or IP address). Default \u003d localhost. Ex: \u0027192.168.0.12,node2,node3\u0027"},"cassandra.credentials.username":{"defaultValue":"none","description":"Cassandra credentials username. Default \u003d \u0027none\u0027"},"cassandra.pooling.new.connection.threshold.local":{"defaultValue":"100","description":"Cassandra new connection threshold local. Protocol V2 and below default \u003d 100Protocol V3 and above default \u003d 800"},"cassandra.socket.read.timeout.millisecs":{"defaultValue":"12000","description":"Cassandra socket read timeout in millisecs. Default \u003d 12000"},"cassandra.load.balancing.policy":{"defaultValue":"DEFAULT", "description":"Cassandra Load Balancing Policy. Default \u003d new TokenAwarePolicy(new DCAwareRoundRobinPolicy())"},"cassandra.pooling.max.request.per.connection.local":{"defaultValue":"1024","description":"Cassandra max request per connection local. Protocol V2 and below default \u003d 128Protocol V3 and above default \u003d 1024"},"cassandra.cluster":{"defaultValue":"Test Cluster","description":"Cassandra cluster name. Default \u003d \u0027Test Cluster\u0027"},"cassandra.pooling.heartbeat.interval.seconds":{"defaultValue":"30","description":"Cassandra pool heartbeat interval in secs. Default \u003d 30"},"cassandra.query.default.serial.consistency":{"defaultValue":"SERIAL","description":"Cassandra query default serial consistency level. Default \u003d SERIAL"},"cassandra.retry.policy":{"defaultValue":"DEFAULT","description":"Cassandra Retry Policy. Default \u003d DefaultRetryPolicy.INSTANCE"},"cassandra.native.port":{"defaultValue":"9042","description":"Cassandra native port. Defa ult \u003d 9042"},"cassandra.interpreter.parallelism":{"defaultValue":"10","description":"Cassandra interpreter parallelism.Default \u003d 10"},"cassandra.pooling.pool.timeout.millisecs":{"defaultValue":"5000","description":"Cassandra pool time out in millisecs. Default \u003d 5000"},"cassandra.pooling.max.request.per.connection.remote":{"defaultValue":"256","description":"Cassandra max request per connection remote. Protocol V2 and below default \u003d 128Protocol V3 and above default \u003d 256"},"cassandra.compression.protocol":{"defaultValue":"NONE","description":"Cassandra compression protocol. Available values: NONE, SNAPPY, LZ4. Default \u003d NONE"},"cassandra.socket.connection.timeout.millisecs":{"defaultValue":"5000","description":"Cassandra socket default connection timeout in millisecs. Default \u003d 5000"},"cassandra.query.default.consistency":{"defaultValue":"ONE","description":"Cassandra query default consistency level. Default \u003d ONE"},"cassandra.keyspace":{"def aultValue":"system","description":"Cassandra keyspace name. Default \u003d \u0027system\u0027"},"cassandra.reconnection.policy":{"defaultValue":"DEFAULT","description":"Cassandra Reconnection Policy. Default \u003d new ExponentialReconnectionPolicy(1000, 10 * 60 * 1000)"},"cassandra.pooling.max.connection.per.host.local":{"defaultValue":"8","description":"Cassandra max connection per host local. Protocol V2 and below default \u003d 8Protocol V3 and above default \u003d 1"},"cassandra.credentials.password":{"defaultValue":"none","description":"Cassandra credentials password. Default \u003d \u0027none\u0027"},"cassandra.protocol.version":{"defaultValue":"3","description":"Cassandra protocol version. Default \u003d 3"},"cassandra.max.schema.agreement.wait.second":{"defaultValue":"10","description":"Cassandra max schema agreement wait in second.Default \u003d ProtocolOptions.DEFAULT_MAX_SCHEMA_AGREEMENT_WAIT_SECONDS"},"cassandra.pooling.core.connection.per.host.remote":{"defaultValue":" 1","description":"Cassandra core connection per host remove. Protocol V2 and below default \u003d 1Protocol V3 and above default \u003d 1"},"cassandra.pooling.core.connection.per.host.local":{"defaultValue":"2","description":"Cassandra core connection per host local. Protocol V2 and below default \u003d 2Protocol V3 and above default \u003d 1"},"cassandra.pooling.max.connection.per.host.remote":{"defaultValue":"2","description":"Cassandra max connection per host remote. Protocol V2 and below default \u003d 2Protocol V3 and above default \u003d 1"},"cassandra.pooling.idle.timeout.seconds":{"defaultValue":"120","description":"Cassandra idle time out in seconds. Default \u003d 120"},"cassandra.speculative.execution.policy":{"defaultValue":"DEFAULT","description":"Cassandra Speculative Execution Policy. Default \u003d NoSpeculativeExecutionPolicy.INSTANCE"}},"path":"/home/Downloads/incubator-zeppelin-master/interpreter/cassandra"},"lens.lens":{"name":"lens","group":"lens","className":"o rg.apache.zeppelin.lens.LensInterpreter","properties":{"lens.server.base.url":{"defaultValue":"http://\u003chostname\u003e:\u003cport\u003e/lensapi","description":"The URL for Lens Server"},"zeppelin.lens.maxThreads":{"defaultValue":"10","description":"If concurrency is true then how many threads?"},"zeppelin.lens.maxResults":{"defaultValue":"1000","description":"max number of rows to display"},"lens.client.dbname":{"defaultValue":"default","description":"The database schema name"},"lens.query.enable.persistent.resultset":{"defaultValue":"false","description":"Apache Lens to persist result in HDFS?"},"zeppelin.lens.run.concurrent":{"defaultValue":"true","description":"Run concurrent Lens Sessions"},"lens.session.cluster.user":{"defaultValue":"default","description":"Hadoop cluster username"}},"path":"/home/Downloads/incubator-zeppelin-master/interpreter/lens"},"spark.spark":{"name":"spark","group":"spark","className":"org.apache.zeppelin.spark.SparkInterpreter","properties":{"spark. executor.memory":{"defaultValue":"512m","description":"Executor memory per worker instance. ex) 512m, 32g"},"args":{"defaultValue":"","description":"spark commandline args"},"spark.yarn.jar":{"defaultValue":"","description":"The location of the Spark jar file. If you use yarn as a cluster, we should set this value"},"zeppelin.spark.useHiveContext":{"defaultValue":"true","description":"Use HiveContext instead of SQLContext if it is true."},"spark.app.name":{"defaultValue":"Zeppelin","description":"The name of spark application."},"spark.cores.max":{"defaultValue":"","description":"Total number of cores to use. Empty value uses all available core."},"zeppelin.spark.maxResult":{"defaultValue":"1000","description":"Max number of SparkSQL result to display."},"master":{"defaultValue":"local[*]","description":"Spark master uri. ex) spark://masterhost:7077"}},"path":"/home/Downloads/incubator-zeppelin-master/interpreter/spark"},"angular.angular":{"name":"angular","group":"angular","classNa me":"org.apache.zeppelin.angular.AngularInterpreter","properties":{},"path":"/home/Downloads/incubator-zeppelin-master/interpreter/angular"},"phoenix.sql":{"name":"sql","group":"phoenix","className":"org.apache.zeppelin.phoenix.PhoenixInterpreter","properties":{"phoenix.jdbc.url":{"defaultValue":"jdbc:phoenix:localhost:2181:/hbase-unsecure","description":"Phoenix JDBC connection string"},"phoenix.user":{"defaultValue":"","description":"The Phoenix user"},"phoenix.driver.name":{"defaultValue":"org.apache.phoenix.jdbc.PhoenixDriver","description":"Phoenix Driver classname."},"phoenix.password":{"defaultValue":"","description":"The password for the Phoenix user"},"phoenix.max.result":{"defaultValue":"1000","description":"Max number of SQL results to display."}},"path":"/home/Downloads/incubator-zeppelin-master/interpreter/phoenix"},"spark.pyspark":{"name":"pyspark","group":"spark","className":"org.apache.zeppelin.spark.PySparkInterpreter","properties":{"spark.home":{"defaultValue":""," description":"Spark home path. Should be provided for pyspark"},"zeppelin.pyspark.python":{"defaultValue":"python","description":"Python command to run pyspark with"}},"path":"/home/Downloads/incubator-zeppelin-master/interpreter/spark"},"spark.sql":{"name":"sql","group":"spark","className":"org.apache.zeppelin.spark.SparkSqlInterpreter","properties":{"zeppelin.spark.concurrentSQL":{"defaultValue":"false","description":"Execute multiple SQL concurrently if set true."},"zeppelin.spark.maxResult":{"defaultValue":"1000","description":"Max number of SparkSQL result to display."}},"path":"/home/Downloads/incubator-zeppelin-master/interpreter/spark"},"spark.dep":{"name":"dep","group":"spark","className":"org.apache.zeppelin.spark.DepInterpreter","properties":{"zeppelin.dep.localrepo":{"defaultValue":"local-repo","description":"local repository for dependency loader"}},"path":"/home/Downloads/incubator-zeppelin-master/interpreter/spark"}}} \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-zeppelin/blob/f6cf52e3/docs/rest-api/rest-json/rest-json-interpreter-setting.json ---------------------------------------------------------------------- diff --git a/docs/rest-api/rest-json/rest-json-interpreter-setting.json b/docs/rest-api/rest-json/rest-json-interpreter-setting.json new file mode 100644 index 0000000..dc7e08d --- /dev/null +++ b/docs/rest-api/rest-json/rest-json-interpreter-setting.json @@ -0,0 +1 @@ +{"status":"OK","message":"","body":[{"id":"2AY6GV7Q3","name":"spark","group":"spark","properties":{"spark.cores.max":"","spark.yarn.jar":"","master":"local[*]","zeppelin.spark.maxResult":"1000","zeppelin.dep.localrepo":"local-repo","spark.app.name":"Zeppelin","spark.executor.memory":"512m","zeppelin.spark.useHiveContext":"true","args":"","spark.home":"","zeppelin.spark.concurrentSQL":"false","zeppelin.pyspark.python":"python"},"interpreterGroup":[{"class":"org.apache.zeppelin.spark.SparkInterpreter","name":"spark"},{"class":"org.apache.zeppelin.spark.PySparkInterpreter","name":"pyspark"},{"class":"org.apache.zeppelin.spark.SparkSqlInterpreter","name":"sql"},{"class":"org.apache.zeppelin.spark.DepInterpreter","name":"dep"}],"option":{"remote":true}},{"id":"2AYUGP2D5","name":"md","group":"md","properties":{"":""},"interpreterGroup":[{"class":"org.apache.zeppelin.markdown.Markdown","name":"md"}],"option":{"remote":true}},{"id":"2AWBZQVB8","name":"angular","group":"angular","properties" :{},"interpreterGroup":[{"class":"org.apache.zeppelin.angular.AngularInterpreter","name":"angular"}],"option":{"remote":true}},{"id":"2AWSES8Z8","name":"sh","group":"sh","properties":{},"interpreterGroup":[{"class":"org.apache.zeppelin.shell.ShellInterpreter","name":"sh"}],"option":{"remote":true}},{"id":"2AWTCSXEX","name":"hive","group":"hive","properties":{"hive.hiveserver2.url":"jdbc:hive2://localhost:10000","hive.hiveserver2.password":"","hive.hiveserver2.user":"hive"},"interpreterGroup":[{"class":"org.apache.zeppelin.hive.HiveInterpreter","name":"hql"}],"option":{"remote":true}}]} \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-zeppelin/blob/f6cf52e3/docs/rest-api/rest-json/rest-json-interpreter-update-response.json ---------------------------------------------------------------------- diff --git a/docs/rest-api/rest-json/rest-json-interpreter-update-response.json b/docs/rest-api/rest-json/rest-json-interpreter-update-response.json new file mode 100644 index 0000000..e2cab9d --- /dev/null +++ b/docs/rest-api/rest-json/rest-json-interpreter-update-response.json @@ -0,0 +1 @@ +{"status":"OK","message":"","body":{"id":"2AYMV9Q7N","name":"md2","group":"md","properties":{"propname":"Otherpropvalue"},"interpreterGroup":[{"class":"org.apache.zeppelin.markdown.Markdown","name":"md"}],"option":{"remote":true}}} \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-zeppelin/blob/f6cf52e3/docs/rest-api/rest-json/rest-json-interpreter-update.json ---------------------------------------------------------------------- diff --git a/docs/rest-api/rest-json/rest-json-interpreter-update.json b/docs/rest-api/rest-json/rest-json-interpreter-update.json new file mode 100644 index 0000000..17a5b0c --- /dev/null +++ b/docs/rest-api/rest-json/rest-json-interpreter-update.json @@ -0,0 +1 @@ +{"name":"md2","group":"md","properties":{"propname":"Otherpropvalue"},"interpreterGroup":[{"class":"org.apache.zeppelin.markdown.Markdown","name":"md"}],"option":{"remote":true}} \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-zeppelin/blob/f6cf52e3/index.md ---------------------------------------------------------------------- diff --git a/index.md b/index.md index 6e57543..a5245e6 100644 --- a/index.md +++ b/index.md @@ -28,7 +28,7 @@ tagline: Less Development, More analysis! ### Multiple language backend Zeppelin interpreter concept allows any language/data-processing-backend to be plugged into Zeppelin. -Current languages included in the Zeppelin interpreter are: Scala(with Apache Spark), Python(with Apache Spark), SparkSQL, Hive, Markdown and Shell. +Currently Zeppelin supports many interpreters such as Scala(with Apache Spark), Python(with Apache Spark), SparkSQL, Hive, Markdown and Shell. <img class="img-responsive" src="assets/themes/zeppelin/img/screenshots/multiple_language_backend.png" />
