Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/_includes/themes/zeppelin/_navigation.html
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@
<li><a href="{{BASE_PATH}}/interpreter/postgresql.html">Postgresql, HAWQ</a></li>
<li><a href="{{BASE_PATH}}/interpreter/r.html">R</a></li>
<li><a href="{{BASE_PATH}}/interpreter/scalding.html">Scalding</a></li>
<li><a href="{{BASE_PATH}}/pleasecontribute.html">Shell</a></li>
<li><a href="{{BASE_PATH}}/interpreter/shell.html">Shell</a></li>
<li><a href="{{BASE_PATH}}/interpreter/spark.html">Spark</a></li>
</ul>
</li>
Expand Down
2 changes: 1 addition & 1 deletion docs/interpreter/alluxio.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
layout: page
title: "Alluxio Interpreter"
description: "Alluxio Interpreter"
group: manual
group: interpreter
---
{% include JB/setup %}

Expand Down
2 changes: 1 addition & 1 deletion docs/interpreter/cassandra.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
layout: page
title: "Cassandra Interpreter"
description: "Cassandra Interpreter"
group: manual
group: interpreter
---
{% include JB/setup %}

Expand Down
2 changes: 1 addition & 1 deletion docs/interpreter/elasticsearch.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
layout: page
title: "Elasticsearch Interpreter"
description: ""
group: manual
group: interpreter
---
{% include JB/setup %}

Expand Down
2 changes: 1 addition & 1 deletion docs/interpreter/flink.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
layout: page
title: "Flink Interpreter"
description: ""
group: manual
group: interpreter
---
{% include JB/setup %}

Expand Down
2 changes: 1 addition & 1 deletion docs/interpreter/geode.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
layout: page
title: "Geode OQL Interpreter"
description: ""
group: manual
group: interpreter
---
{% include JB/setup %}

Expand Down
2 changes: 1 addition & 1 deletion docs/interpreter/hbase.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
layout: page
title: "HBase Shell Interpreter"
description: ""
group: manual
group: interpreter
---
{% include JB/setup %}

Expand Down
2 changes: 1 addition & 1 deletion docs/interpreter/hdfs.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
layout: page
title: "HDFS File System Interpreter"
description: ""
group: manual
group: interpreter
---
{% include JB/setup %}

Expand Down
2 changes: 1 addition & 1 deletion docs/interpreter/hive.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
layout: page
title: "Hive Interpreter"
description: ""
group: manual
group: interpreter
---
{% include JB/setup %}

Expand Down
2 changes: 1 addition & 1 deletion docs/interpreter/ignite.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
layout: page
title: "Ignite Interpreter"
description: "Ignite user guide"
group: manual
group: interpreter
---
{% include JB/setup %}

Expand Down
2 changes: 1 addition & 1 deletion docs/interpreter/jdbc.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
layout: page
title: "Generic JDBC Interpreter"
description: "JDBC user guide"
group: manual
group: interpreter
---
{% include JB/setup %}

Expand Down
2 changes: 1 addition & 1 deletion docs/interpreter/lens.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
layout: page
title: "Lens Interpreter"
description: "Lens user guide"
group: manual
group: interpreter
---
{% include JB/setup %}

Expand Down
2 changes: 1 addition & 1 deletion docs/interpreter/livy.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
layout: page
title: "Livy Interpreter"
description: ""
group: manual
group: interpreter
---
{% include JB/setup %}

Expand Down
2 changes: 1 addition & 1 deletion docs/interpreter/markdown.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
layout: page
title: "Markdown Interpreter"
description: "Markdown Interpreter"
group: manual
group: interpreter
---
{% include JB/setup %}

Expand Down
2 changes: 1 addition & 1 deletion docs/interpreter/postgresql.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
layout: page
title: "PostgreSQL and HAWQ Interpreter"
description: ""
group: manual
group: interpreter
---
{% include JB/setup %}

Expand Down
2 changes: 1 addition & 1 deletion docs/interpreter/python.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
layout: page
title: "Python Interpreter"
description: "Python Interpreter"
group: manual
group: interpreter
---
{% include JB/setup %}

Expand Down
2 changes: 1 addition & 1 deletion docs/interpreter/r.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
layout: page
title: "R Interpreter"
description: ""
group: manual
group: interpreter
---
{% include JB/setup %}

Expand Down
2 changes: 1 addition & 1 deletion docs/interpreter/scalding.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
layout: page
title: "Scalding Interpreter"
description: ""
group: manual
group: interpreter
---
{% include JB/setup %}

Expand Down
34 changes: 27 additions & 7 deletions docs/interpreter/shell.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
<div id="toc"></div>

## 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.

<table class="table-configuration">
<tr>
<th>Name</th>
<th>Value</th>
<th>Description</th>
</tr>
<tr>
<td>shell.command.timeout.millisecs</td>
<td>60000</td>
<td>Shell command time out in millisecs</td>
</tr>
</table>

## Example
The following example demonstrates the basic usage of Shell in a Zeppelin notebook.

<img src="{{BASE_PATH}}/assets/themes/zeppelin/img/docs-img/shell-example.png" width="70%" />
<img src="{{BASE_PATH}}/assets/themes/zeppelin/img/docs-img/shell-example.png" />

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.
2 changes: 1 addition & 1 deletion docs/interpreter/spark.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
layout: page
title: "Spark Interpreter Group"
description: ""
group: manual
group: interpreter
---
{% include JB/setup %}

Expand Down
22 changes: 13 additions & 9 deletions docs/rest-api/rest-credential.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,22 +19,26 @@ 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).
<div id="toc"></div>

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).

<br />
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).

<br />
## Credential REST API List

### List Credential information
<table class="table-credential">
<col width="200">
<tr>
<td>Description</td>
<td>This ```GET``` method returns all key/value pairs of credential information on the server.</td>
<td>This ```GET``` method returns all key/value pairs of the credential information on the server.</td>
</tr>
<tr>
<td>URL</td>
Expand Down Expand Up @@ -78,7 +82,7 @@ limitations under the License.
<col width="200">
<tr>
<td>Description</td>
<td>This ```PUT``` method creates an credential information with new properties.</td>
<td>This ```PUT``` method creates the credential information with new properties.</td>
</tr>
<tr>
<td>URL</td>
Expand Down Expand Up @@ -124,7 +128,7 @@ limitations under the License.
<col width="200">
<tr>
<td>Description</td>
<td>This ```DELETE``` method deletes credential information.</td>
<td>This ```DELETE``` method deletes the credential information.</td>
</tr>
<tr>
<td>URL</td>
Expand Down Expand Up @@ -154,7 +158,7 @@ limitations under the License.
<col width="200">
<tr>
<td>Description</td>
<td>This ```DELETE``` method deletes an given credential entity.</td>
<td>This ```DELETE``` method deletes a given credential entity.</td>
</tr>
<tr>
<td>URL</td>
Expand Down