diff --git a/docs/_includes/themes/zeppelin/_navigation.html b/docs/_includes/themes/zeppelin/_navigation.html index 8a99c840cf6..7a5acc62879 100644 --- a/docs/_includes/themes/zeppelin/_navigation.html +++ b/docs/_includes/themes/zeppelin/_navigation.html @@ -64,7 +64,7 @@
  • Postgresql, HAWQ
  • R
  • Scalding
  • -
  • Shell
  • +
  • Shell
  • Spark
  • diff --git a/docs/interpreter/alluxio.md b/docs/interpreter/alluxio.md index c8ecf93d281..c3ad14acc37 100644 --- a/docs/interpreter/alluxio.md +++ b/docs/interpreter/alluxio.md @@ -2,7 +2,7 @@ layout: page title: "Alluxio Interpreter" description: "Alluxio Interpreter" -group: manual +group: interpreter --- {% include JB/setup %} diff --git a/docs/interpreter/cassandra.md b/docs/interpreter/cassandra.md index 33cff199b05..89b4ea5806f 100644 --- a/docs/interpreter/cassandra.md +++ b/docs/interpreter/cassandra.md @@ -2,7 +2,7 @@ layout: page title: "Cassandra Interpreter" description: "Cassandra Interpreter" -group: manual +group: interpreter --- {% include JB/setup %} diff --git a/docs/interpreter/elasticsearch.md b/docs/interpreter/elasticsearch.md index 4721bcda3f2..7c6e2cec4de 100644 --- a/docs/interpreter/elasticsearch.md +++ b/docs/interpreter/elasticsearch.md @@ -2,7 +2,7 @@ layout: page title: "Elasticsearch Interpreter" description: "" -group: manual +group: interpreter --- {% include JB/setup %} diff --git a/docs/interpreter/flink.md b/docs/interpreter/flink.md index a678480b59f..95ed6410958 100644 --- a/docs/interpreter/flink.md +++ b/docs/interpreter/flink.md @@ -2,7 +2,7 @@ layout: page title: "Flink Interpreter" description: "" -group: manual +group: interpreter --- {% include JB/setup %} diff --git a/docs/interpreter/geode.md b/docs/interpreter/geode.md index 84a026efff5..24abf2ea561 100644 --- a/docs/interpreter/geode.md +++ b/docs/interpreter/geode.md @@ -2,7 +2,7 @@ layout: page title: "Geode OQL Interpreter" description: "" -group: manual +group: interpreter --- {% include JB/setup %} diff --git a/docs/interpreter/hbase.md b/docs/interpreter/hbase.md index 1aeb77bcade..4598f2fe4be 100644 --- a/docs/interpreter/hbase.md +++ b/docs/interpreter/hbase.md @@ -2,7 +2,7 @@ layout: page title: "HBase Shell Interpreter" description: "" -group: manual +group: interpreter --- {% include JB/setup %} diff --git a/docs/interpreter/hdfs.md b/docs/interpreter/hdfs.md index 7cde31a6960..7369ba0feaa 100644 --- a/docs/interpreter/hdfs.md +++ b/docs/interpreter/hdfs.md @@ -2,7 +2,7 @@ layout: page title: "HDFS File System Interpreter" description: "" -group: manual +group: interpreter --- {% include JB/setup %} diff --git a/docs/interpreter/hive.md b/docs/interpreter/hive.md index a1fc4e1e618..037055b2654 100644 --- a/docs/interpreter/hive.md +++ b/docs/interpreter/hive.md @@ -2,7 +2,7 @@ layout: page title: "Hive Interpreter" description: "" -group: manual +group: interpreter --- {% include JB/setup %} diff --git a/docs/interpreter/ignite.md b/docs/interpreter/ignite.md index 8a25fd7ca79..d157d3121f2 100644 --- a/docs/interpreter/ignite.md +++ b/docs/interpreter/ignite.md @@ -2,7 +2,7 @@ layout: page title: "Ignite Interpreter" description: "Ignite user guide" -group: manual +group: interpreter --- {% include JB/setup %} diff --git a/docs/interpreter/jdbc.md b/docs/interpreter/jdbc.md index 830dd9789e4..4615b140f38 100644 --- a/docs/interpreter/jdbc.md +++ b/docs/interpreter/jdbc.md @@ -2,7 +2,7 @@ layout: page title: "Generic JDBC Interpreter" description: "JDBC user guide" -group: manual +group: interpreter --- {% include JB/setup %} diff --git a/docs/interpreter/lens.md b/docs/interpreter/lens.md index b4bcda49bd7..20b2c0ccb9d 100644 --- a/docs/interpreter/lens.md +++ b/docs/interpreter/lens.md @@ -2,7 +2,7 @@ layout: page title: "Lens Interpreter" description: "Lens user guide" -group: manual +group: interpreter --- {% include JB/setup %} diff --git a/docs/interpreter/livy.md b/docs/interpreter/livy.md index ef7c8ce6876..2f47364aae8 100644 --- a/docs/interpreter/livy.md +++ b/docs/interpreter/livy.md @@ -2,7 +2,7 @@ layout: page title: "Livy Interpreter" description: "" -group: manual +group: interpreter --- {% include JB/setup %} diff --git a/docs/interpreter/markdown.md b/docs/interpreter/markdown.md index 21184dcf762..42ab86b18c5 100644 --- a/docs/interpreter/markdown.md +++ b/docs/interpreter/markdown.md @@ -2,7 +2,7 @@ layout: page title: "Markdown Interpreter" description: "Markdown Interpreter" -group: manual +group: interpreter --- {% include JB/setup %} diff --git a/docs/interpreter/postgresql.md b/docs/interpreter/postgresql.md index 107fda1d809..a83731bc6cc 100644 --- a/docs/interpreter/postgresql.md +++ b/docs/interpreter/postgresql.md @@ -2,7 +2,7 @@ layout: page title: "PostgreSQL and HAWQ Interpreter" description: "" -group: manual +group: interpreter --- {% include JB/setup %} diff --git a/docs/interpreter/python.md b/docs/interpreter/python.md index c2a38f54433..cb9fded3685 100644 --- a/docs/interpreter/python.md +++ b/docs/interpreter/python.md @@ -2,7 +2,7 @@ layout: page title: "Python Interpreter" description: "Python Interpreter" -group: manual +group: interpreter --- {% include JB/setup %} diff --git a/docs/interpreter/r.md b/docs/interpreter/r.md index dce8bd1dcc9..bc94fff9893 100644 --- a/docs/interpreter/r.md +++ b/docs/interpreter/r.md @@ -2,7 +2,7 @@ layout: page title: "R Interpreter" description: "" -group: manual +group: interpreter --- {% include JB/setup %} diff --git a/docs/interpreter/scalding.md b/docs/interpreter/scalding.md index e8774df67fa..d2e86e742d9 100644 --- a/docs/interpreter/scalding.md +++ b/docs/interpreter/scalding.md @@ -2,7 +2,7 @@ layout: page title: "Scalding Interpreter" description: "" -group: manual +group: interpreter --- {% include JB/setup %} diff --git a/docs/interpreter/shell.md b/docs/interpreter/shell.md index 11e73b7cba6..f86e830a3a8 100644 --- a/docs/interpreter/shell.md +++ b/docs/interpreter/shell.md @@ -2,19 +2,39 @@ layout: page title: "Shell Interpreter" description: "Shell Interpreter" -group: manual +group: interpreter --- {% include JB/setup %} -## Shell interpreter for Apache Zeppelin +# Shell interpreter for Apache Zeppelin -### Overview -Shell interpreter uses [Apache Commons Exec](https://commons.apache.org/proper/commons-exec) to execute external processes. +
    +## Overview +Shell interpreter uses [Apache Commons Exec](https://commons.apache.org/proper/commons-exec) to execute external processes. In Zeppelin notebook, you can use ` %sh ` in the beginning of a paragraph to invoke system shell and run commands. -Note: Currently each command runs as Zeppelin user. -### Example +> **Note :** Currently each command runs as the user Zeppelin server is running as. + +## Configuration +At the "Interpreters" menu in Zeppelin dropdown menu, you can set the property value for Shell interpreter. + + + + + + + + + + + + +
    NameValueDescription
    shell.command.timeout.millisecs60000Shell command time out in millisecs
    + +## Example The following example demonstrates the basic usage of Shell in a Zeppelin notebook. - + + +If you need further information about **Zeppelin Interpreter Setting** for using Shell interpreter, please read [What is interpreter setting?](../manual/interpreters.html#what-is-interpreter-setting) section first. \ No newline at end of file diff --git a/docs/interpreter/spark.md b/docs/interpreter/spark.md index a183033bf7c..81f48443a93 100644 --- a/docs/interpreter/spark.md +++ b/docs/interpreter/spark.md @@ -2,7 +2,7 @@ layout: page title: "Spark Interpreter Group" description: "" -group: manual +group: interpreter --- {% include JB/setup %} diff --git a/docs/rest-api/rest-credential.md b/docs/rest-api/rest-credential.md index a01f3351b90..01916746551 100644 --- a/docs/rest-api/rest-credential.md +++ b/docs/rest-api/rest-credential.md @@ -19,14 +19,18 @@ limitations under the License. --> {% include JB/setup %} -## Zeppelin REST API - Zeppelin provides several REST APIs for interaction and remote activation of zeppelin functionality. +# Apache Zeppelin Credential REST API - All REST APIs are available starting with the following endpoint `http://[zeppelin-server]:[zeppelin-port]/api`. Note that zeppelin REST APIs receive or return JSON objects, it is recommended for you to install some JSON viewers 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](http://zeppelin.apache.org/community.html). +## Overview +Apache Zeppelin provides several REST APIs for interaction and remote activation of zeppelin functionality. +All REST APIs are available starting with the following endpoint `http://[zeppelin-server]:[zeppelin-port]/api`. +Note that Apache Zeppelin REST APIs receive or return JSON objects, it is recommended for you to install some JSON viewers such as [JSONView](https://chrome.google.com/webstore/detail/jsonview/chklaanhfefbnpoihckbnefhakgolnmc). -
    +If you work with Apache Zeppelin and find a need for an additional REST API, please [file an issue or send us an email](http://zeppelin.apache.org/community.html). + +
    ## Credential REST API List ### List Credential information @@ -34,7 +38,7 @@ limitations under the License. Description - This ```GET``` method returns all key/value pairs of credential information on the server. + This ```GET``` method returns all key/value pairs of the credential information on the server. URL @@ -78,7 +82,7 @@ limitations under the License. Description - This ```PUT``` method creates an credential information with new properties. + This ```PUT``` method creates the credential information with new properties. URL @@ -124,7 +128,7 @@ limitations under the License. Description - This ```DELETE``` method deletes credential information. + This ```DELETE``` method deletes the credential information. URL @@ -154,7 +158,7 @@ limitations under the License. Description - This ```DELETE``` method deletes an given credential entity. + This ```DELETE``` method deletes a given credential entity. URL