mirror of
https://github.com/apache/zeppelin
synced 2026-05-24 09:38:26 +00:00
629e21769e
### What is this PR for? With ZEPPELIN-2841, it had changed the default working directory of Shell Interpreter from the relative path where Zeppelin is running to user-home. This is to make the configuration optional. ### What type of PR is it? [Improvement] ### What is the Jira issue? * https://issues.apache.org/jira/browse/ZEPPELIN-2903 ### How should this be tested? by default when the user runs shell interpreter and executes `pwd` will the path where Zeppelin server is running, but when `shell.working.directory.user.home` is set to true in Zeppelin's interpreter setting, it will point to the user's home directory by which the interpreter is running. Author: Prabhjyot Singh <prabhjyotsingh@gmail.com> Closes #2566 from prabhjyotsingh/ZEPPELIN-2903 and squashes the following commits:9934df52a[Prabhjyot Singh] add doc for shell.working.directory.user.home9164ed2c0[Prabhjyot Singh] Make setting of working directory to user-home optional for shell interpreter
84 lines
2.9 KiB
Markdown
84 lines
2.9 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>shell.working.directory.user.home</td>
|
|
<td>false</td>
|
|
<td>If this set to true, the shell's working directory will be set to user home</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="{{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?](../usage/interpreter/overview.html#what-is-interpreter-setting) section first.
|
|
|
|
## Kerberos refresh interval
|
|
For changing the default behavior of when to renew Kerberos ticket following changes can be made in `conf/zeppelin-env.sh`.
|
|
|
|
```bash
|
|
# Change Kerberos refresh interval (default value is 1d). Allowed postfix are ms, s, m, min, h, and d.
|
|
export LAUNCH_KERBEROS_REFRESH_INTERVAL=4h
|
|
# Change kinit number retries (default value is 5), which means if the kinit command fails for 5 retries consecutively it will close the interpreter.
|
|
export KINIT_FAIL_THRESHOLD=10
|
|
```
|