mirror of
https://github.com/apache/zeppelin
synced 2026-05-24 09:38:26 +00:00
8f344db93e
### What is this PR for? There is a dead link in [docs/README.md](https://github.com/apache/zeppelin/blob/master/docs/README.md). It should be `https://zeppelin.apache.org/docs/latest/` not `https://zeppelin.apache.org/docs/latest` ### What type of PR is it? Bug Fix ### What is the Jira issue? [ZEPPELIN-1421](https://issues.apache.org/jira/browse/ZEPPELIN-1421) ### How should this be tested? - Before [https://zeppelin.apache.org/docs/latest](https://zeppelin.apache.org/docs/latest) - After [https://zeppelin.apache.org/docs/latest/](https://zeppelin.apache.org/docs/latest/) ### Screenshots (if appropriate) ### Questions: * Does the licenses files need update? no * Is there breaking changes for older versions? no * Does this needs documentation? no Author: AhyoungRyu <fbdkdud93@hanmail.net> Closes #1420 from AhyoungRyu/ZEPPELIN-1421 and squashes the following commits:57336f8[AhyoungRyu] Remove BASE_PATH in some docs pages311e2ef[AhyoungRyu] Fix dead link in docs/README.md
68 lines
No EOL
2.2 KiB
Markdown
68 lines
No EOL
2.2 KiB
Markdown
---
|
|
layout: page
|
|
title: "Shell interpreter for Apache Zeppelin"
|
|
description: "Shell interpreter uses Apache Commons Exec to execute external processes."
|
|
group: interpreter
|
|
---
|
|
<!--
|
|
Licensed under the Apache License, Version 2.0 (the "License");
|
|
you may not use this file except in compliance with the License.
|
|
You may obtain a copy of the License at
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
distributed under the License is distributed on an "AS IS" BASIS,
|
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
See the License for the specific language governing permissions and
|
|
limitations under the License.
|
|
-->
|
|
{% include JB/setup %}
|
|
|
|
# Shell interpreter for Apache Zeppelin
|
|
|
|
<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 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>
|
|
<tr>
|
|
<td>zeppelin.shell.auth.type</td>
|
|
<td></td>
|
|
<td>Types of authentications' methods supported are SIMPLE, and KERBEROS</td>
|
|
</tr>
|
|
<tr>
|
|
<td>zeppelin.shell.principal</td>
|
|
<td></td>
|
|
<td>The principal name to load from the keytab</td>
|
|
</tr>
|
|
<tr>
|
|
<td>zeppelin.shell.keytab.location</td>
|
|
<td></td>
|
|
<td>The path to the keytab file</td>
|
|
</tr>
|
|
</table>
|
|
|
|
## Example
|
|
The following example demonstrates the basic usage of Shell in a Zeppelin notebook.
|
|
|
|
<img src="../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. |