mirror of
https://github.com/apache/zeppelin
synced 2026-05-24 09:38:26 +00:00
feat: Add docs/usage
This commit is contained in:
1ambda
parent
735946bca0
commit
28970a4fe6
22 changed files with 114 additions and 114 deletions
|
|
@ -41,25 +41,26 @@
|
|||
<li><a href="{{BASE_PATH}}/usage/dynamic_form/intro.html">What is Dynamic Form?</a></li>
|
||||
<li role="separator" class="divider"></li>
|
||||
<li class="title"><span>Display System</span></li>
|
||||
<li><a href="">Text Display</a></li>
|
||||
<li><a href="">HTML Display</a></li>
|
||||
<li><a href="">Table Display</a></li>
|
||||
<li><a href="{{BASE_PATH}}/displaysystem/basicdisplaysystem.html#network">Network</a></li>
|
||||
<li><a href="">Angular Display using Backend API</a></li>
|
||||
<li><a href="">Angular Display using Frontend API</a></li>
|
||||
<li><a href="{{BASE_PATH}}/usage/display_system/basic.html#text">Text Display</a></li>
|
||||
<li><a href="{{BASE_PATH}}/usage/display_system/basic.html#html">HTML Display</a></li>
|
||||
<li><a href="{{BASE_PATH}}/usage/display_system/basic.html#table">Table Display</a></li>
|
||||
<li><a href="{{BASE_PATH}}/usage/display_system/basic.html#network">Network</a></li>
|
||||
<li><a href="{{BASE_PATH}}/usage/display_system/angular_backend.html">Angular Display using Backend API</a></li>
|
||||
<li><a href="{{BASE_PATH}}/usage/display_system/angular_frontend.html">Angular Display using Frontend API</a></li>
|
||||
<li role="separator" class="divider"></li>
|
||||
<li class="title"><span>Interpreter</span></li>
|
||||
<li><a href="{{BASE_PATH}}/usage/interpreter/overview.html">Overview</a></li>
|
||||
<li><a href="{{BASE_PATH}}/usage/interpreter/user_impersonation.html">User Impersonation</a></li>
|
||||
<li><a href="{{BASE_PATH}}/usage/interpreter/dependency_management.html">Dependency Management</a></li>
|
||||
<li><a href="{{BASE_PATH}}/usage/interpreter/installing.html">Installing Custom Interpreters</a></li>
|
||||
<li><a href="{{BASE_PATH}}/usage/interpreter/installation.html">Installing Interpreters</a></li>
|
||||
<!--<li><a href="{{BASE_PATH}}/usage/interpreter/dynamic_loading.html">Dynamic Interpreter Loading (Experimental)</a></li>-->
|
||||
<li><a href="{{BASE_PATH}}/usage/interpreter/execution_hooks.html">Execution Hooks (Experimental)</a></li>
|
||||
<li role="separator" class="divider"></li>
|
||||
<li class="title"><span>REST API</span></li>
|
||||
<li><a href="{{BASE_PATH}}/usage/rest_api/interpreter.html">Interpreter API</a></li>
|
||||
<li><a href="{{BASE_PATH}}/usage/rest_api/zeppelin_server.html">Zeppelin Server API</a></li>
|
||||
<li><a href="{{BASE_PATH}}/usage/rest_api/notebook.html">Notebook API</a></li>
|
||||
<li><a href="{{BASE_PATH}}/usage/rest_api/notebook_repo.html">Notebook Repository API</a></li>
|
||||
<li><a href="{{BASE_PATH}}/usage/rest_api/notebook_repository.html">Notebook Repository API</a></li>
|
||||
<li><a href="{{BASE_PATH}}/usage/rest_api/configuration.html">Configuration API</a></li>
|
||||
<li><a href="{{BASE_PATH}}/usage/rest_api/credential.html">Credential API</a></li>
|
||||
<li><a href="{{BASE_PATH}}/usage/rest_api/helium.html">Helium API</a></li>
|
||||
|
|
|
|||
|
|
@ -264,7 +264,7 @@ body {
|
|||
}
|
||||
|
||||
.content :first-child {
|
||||
margin-top: 0;
|
||||
margin-top: 20px;
|
||||
}
|
||||
|
||||
@media screen and (min-width: 64em) {
|
||||
|
|
|
|||
|
|
@ -18,10 +18,9 @@ See the License for the specific language governing permissions and
|
|||
limitations under the License.
|
||||
-->
|
||||
{% include JB/setup %}
|
||||
<br />
|
||||
<div class="row">
|
||||
<div class="row" style="margin-top: 0px;">
|
||||
<div class="col-sm-6 col-md-6" style="padding-right:0;">
|
||||
<h1 style="color:#4c555a">What is Apache Zeppelin?</h1>
|
||||
<h1 style="color:#4c555a; margin-top: 0px;">What is Apache Zeppelin?</h1>
|
||||
<p style="margin-bottom: 0px; margin-top: 20px; font-size: 18px; font-style="font-family: "Roboto", sans-serif;">
|
||||
Multi-purpose notebook which supports
|
||||
</p>
|
||||
|
|
@ -37,7 +36,7 @@ limitations under the License.
|
|||
<br/>
|
||||
</div>
|
||||
<div class="col-sm-6 col-md-6" style="padding:0;">
|
||||
<div class="hidden-xs" style="margin-top: 50px;"></div>
|
||||
<div class="hidden-xs" style="margin-top: 60px;"></div>
|
||||
<img class="img-responsive" style="border: 1px solid #ecf0f1;" src="./assets/themes/zeppelin/img/notebook.png" />
|
||||
</div>
|
||||
</div>
|
||||
|
|
@ -55,7 +54,7 @@ limitations under the License.
|
|||
|
||||
#### Usage
|
||||
* Dynamic Form
|
||||
* [What is Dynamic Form?](./usage/dynamic_form/intro.html): a step by step guide for creating dynamic forms
|
||||
* [What is Dynamic Form](./usage/dynamic_form/intro.html): a step by step guide for creating dynamic forms
|
||||
* Display System
|
||||
* [Text Display (`%text`)](./usage/display_system/basic.html#text)
|
||||
* [HTML Display (`%html`)](./usage/display_system/basic.html#html)
|
||||
|
|
@ -66,13 +65,13 @@ limitations under the License.
|
|||
* [Overview](./usage/interpreter/overview.html): what is interpreter group? how can you set interpreters in Apache Zeppelin?
|
||||
* [User Impersonation](./usage/interpreter/user_impersonation.html) when you want to run interpreter as end user
|
||||
* [Dependency Management](./usage/interpreter/dependency_management.html) when you include external libraries to interpreter
|
||||
* [Installing Custom Interpreters](./usage/interpreter/installation.html): Install not only community managed interpreters but also 3rd party interpreters
|
||||
* [Execution Hooks](./usage/interpreterexechooks.html) to specify additional code to be executed by an interpreter at pre and post-paragraph code execution
|
||||
* [Installing Interpreters](./usage/interpreter/installation.html): Install not only community managed interpreters but also 3rd party interpreters
|
||||
* [Execution Hooks](./usage/interpreter/execution_hooks.html) to specify additional code to be executed by an interpreter at pre and post-paragraph code execution
|
||||
* REST API: available REST API list in Apache Zeppelin
|
||||
* [Interpreter API](./usage/rest_api/interpreter.html)
|
||||
* [Zeppelin Server API](./usage/rest_api/zeppelin_server.html)
|
||||
* [Notebook API](./usage/rest_api/notebook.html)
|
||||
* [Notebook Repository API](./usage/rest_api/notebookRepo.html)
|
||||
* [Notebook Repository API](./usage/rest_api/notebook_repository.html)
|
||||
* [Configuration API](./usage/rest_api/configuration.html)
|
||||
* [Credential API](./usage/rest_api/credential.html)
|
||||
* [Helium API](./usage/rest_api/helium.html)
|
||||
|
|
|
|||
|
|
@ -1,8 +1,8 @@
|
|||
---
|
||||
layout: page
|
||||
title: "Back-end Angular API in Apache Zeppelin"
|
||||
title: "Backend Angular API in Apache Zeppelin"
|
||||
description: "Apache Zeppelin provides a gateway between your interpreter and your compiled AngularJS view templates. You can not only update scope variables from your interpreter but also watch them in the interpreter, which is JVM process."
|
||||
group: display
|
||||
group: usage/display_system
|
||||
---
|
||||
<!--
|
||||
Licensed under the Apache License, Version 2.0 (the "License");
|
||||
|
|
@ -19,7 +19,7 @@ limitations under the License.
|
|||
-->
|
||||
{% include JB/setup %}
|
||||
|
||||
# Back-end Angular API in Apache Zeppelin
|
||||
# Backend Angular API in Apache Zeppelin
|
||||
|
||||
<div id="toc"></div>
|
||||
|
||||
|
|
@ -188,7 +188,7 @@ AngularModel("myModel")()
|
|||
AngularModel("myModel", "New value")
|
||||
```
|
||||
|
||||
<img src="../assets/themes/zeppelin/img/docs-img/basic-usage-angular.png" width="70%">
|
||||
<img src="/assets/themes/zeppelin/img/docs-img/basic-usage-angular.png" width="70%">
|
||||
|
||||
### Example: String Converter
|
||||
Using below example, you can convert the lowercase string to uppercase.
|
||||
|
|
@ -211,4 +211,4 @@ val button = <div class="btn btn-success btn-sm">Convert</div>.onClick{() =>
|
|||
```
|
||||
{% endraw %}
|
||||
|
||||
<img src="../assets/themes/zeppelin/img/docs-img/string-converter-angular.gif" width="70%">
|
||||
<img src="/assets/themes/zeppelin/img/docs-img/string-converter-angular.gif" width="70%">
|
||||
|
|
@ -1,8 +1,8 @@
|
|||
---
|
||||
layout: page
|
||||
title: "Front-end Angular API in Apache Zeppelin"
|
||||
title: "Frontend Angular API in Apache Zeppelin"
|
||||
description: "In addition to the back-end API to handle Angular objects binding, Apache Zeppelin exposes a simple AngularJS z object on the front-end side to expose the same capabilities."
|
||||
group: display
|
||||
group: usage/display_system
|
||||
---
|
||||
<!--
|
||||
Licensed under the Apache License, Version 2.0 (the "License");
|
||||
|
|
@ -19,12 +19,12 @@ limitations under the License.
|
|||
-->
|
||||
{% include JB/setup %}
|
||||
|
||||
# Front-end Angular API in Apache Zeppelin
|
||||
# Frontend Angular API in Apache Zeppelin
|
||||
|
||||
<div id="toc"></div>
|
||||
|
||||
## Basic Usage
|
||||
In addition to the [back-end API](./back-end-angular.html) to handle Angular objects binding, Apache Zeppelin also exposes a simple AngularJS <code>**z**</code> object on the front-end side to expose the same capabilities.
|
||||
In addition to the [backend Angular API](./angular_backend.html) to handle Angular objects binding, Apache Zeppelin also exposes a simple AngularJS <code>**z**</code> object on the front-end side to expose the same capabilities.
|
||||
This <code>**z**</code> object is accessible in the Angular isolated scope for each paragraph.
|
||||
|
||||
|
||||
|
|
@ -47,7 +47,7 @@ Bind a value to an angular object and a **mandatory** target paragraph:
|
|||
|
||||
```
|
||||
|
||||
<img src="../assets/themes/zeppelin/img/screenshots/z_angularBind.gif" />
|
||||
<img src="/assets/themes/zeppelin/img/screenshots/z_angularBind.gif" />
|
||||
|
||||
<hr/>
|
||||
|
||||
|
|
@ -63,7 +63,7 @@ Unbind/remove a value from angular object and a **mandatory** target paragraph:
|
|||
|
||||
```
|
||||
|
||||
<img src="../assets/themes/zeppelin/img/screenshots/z_angularUnbind.gif" />
|
||||
<img src="/assets/themes/zeppelin/img/screenshots/z_angularUnbind.gif" />
|
||||
|
||||
The signature for the **`z.angularBind() / z.angularUnbind()`** functions are:
|
||||
|
||||
|
|
@ -98,7 +98,7 @@ You can also trigger paragraph execution by calling **`z.runParagraph()`** funct
|
|||
|
||||
```
|
||||
|
||||
<img src="../assets/themes/zeppelin/img/screenshots/z_runParagraph.gif" />
|
||||
<img src="/assets/themes/zeppelin/img/screenshots/z_runParagraph.gif" />
|
||||
|
||||
<br />
|
||||
## Overriding dynamic form with Angular Object
|
||||
|
|
@ -110,13 +110,13 @@ The idea is to create a custom form using plain HTML/AngularJS code and bind act
|
|||
Consequently if you use the **Dynamic Form** syntax in a paragraph and there is a bound Angular object having the same name as the `${formName}`, the Angular object will have higher priority and the **Dynamic Form** will not be displayed. Example:
|
||||
|
||||
|
||||
<img src="../assets/themes/zeppelin/img/screenshots/z_angularJs_overriding_dynamic_form.gif" />
|
||||
<img src="/assets/themes/zeppelin/img/screenshots/z_angularJs_overriding_dynamic_form.gif" />
|
||||
|
||||
|
||||
<br />
|
||||
## Feature matrix comparison
|
||||
|
||||
How does the front-end AngularJS API compares to the [back-end API](./back-end-angular.html) ? Below is a comparison matrix for both APIs:
|
||||
How does the front-end AngularJS API compares to the [backend Angular API](./angular_backend.html)? Below is a comparison matrix for both APIs:
|
||||
|
||||
<table class="table-configuration">
|
||||
<thead>
|
||||
|
|
@ -2,7 +2,7 @@
|
|||
layout: page
|
||||
title: "Basic Display System in Apache Zeppelin"
|
||||
description: "There are 3 basic display systems in Apache Zeppelin. By default, Zeppelin prints interpreter responce as a plain text using text display system. With %html directive, Zeppelin treats your output as HTML. You can also simply use %table display system to leverage Zeppelin's built in visualization."
|
||||
group: display
|
||||
group: usage/display_system
|
||||
---
|
||||
<!--
|
||||
Licensed under the Apache License, Version 2.0 (the "License");
|
||||
|
|
@ -27,38 +27,38 @@ limitations under the License.
|
|||
|
||||
By default, Apache Zeppelin prints interpreter response as a plain text using `text` display system.
|
||||
|
||||
<img src="../assets/themes/zeppelin/img/screenshots/display_text.png" />
|
||||
<img src="/assets/themes/zeppelin/img/screenshots/display_text.png" />
|
||||
|
||||
You can explicitly say you're using `text` display system.
|
||||
|
||||
<img src="../assets/themes/zeppelin/img/screenshots/display_text1.png" />
|
||||
<img src="/assets/themes/zeppelin/img/screenshots/display_text1.png" />
|
||||
|
||||
## Html
|
||||
|
||||
With `%html` directive, Zeppelin treats your output as HTML
|
||||
|
||||
<img src="../assets/themes/zeppelin/img/screenshots/display_html.png" />
|
||||
<img src="/assets/themes/zeppelin/img/screenshots/display_html.png" />
|
||||
|
||||
### Mathematical expressions
|
||||
HTML display system automatically formats mathematical expression using [MathJax](https://www.mathjax.org/). You can use
|
||||
`\\( INLINE EXPRESSION \\)` and `$$ EXPRESSION $$` to format. For example
|
||||
|
||||
<img src="../assets/themes/zeppelin/img/screenshots/display_formula.png" />
|
||||
<img src="/assets/themes/zeppelin/img/screenshots/display_formula.png" />
|
||||
|
||||
|
||||
## Table
|
||||
|
||||
If you have data that row separated by `\n` (newline) and column separated by `\t` (tab) with first row as header row, for example
|
||||
|
||||
<img src="../assets/themes/zeppelin/img/screenshots/display_table.png" />
|
||||
<img src="/assets/themes/zeppelin/img/screenshots/display_table.png" />
|
||||
|
||||
You can simply use `%table` display system to leverage Zeppelin's built in visualization.
|
||||
|
||||
<img src="../assets/themes/zeppelin/img/screenshots/display_table1.png" />
|
||||
<img src="/assets/themes/zeppelin/img/screenshots/display_table1.png" />
|
||||
|
||||
If table contents start with `%html`, it is interpreted as an HTML.
|
||||
|
||||
<img src="../assets/themes/zeppelin/img/screenshots/display_table_html.png" />
|
||||
<img src="/assets/themes/zeppelin/img/screenshots/display_table_html.png" />
|
||||
|
||||
> **Note :** Display system is backend independent.
|
||||
|
||||
|
|
@ -2,7 +2,7 @@
|
|||
layout: page
|
||||
title: "Dynamic Form in Apache Zeppelin"
|
||||
description: "Apache Zeppelin dynamically creates input forms. Depending on language backend, there're two different ways to create dynamic form."
|
||||
group: manual
|
||||
group: usage/dynamic_form
|
||||
---
|
||||
<!--
|
||||
Licensed under the Apache License, Version 2.0 (the "License");
|
||||
|
|
@ -19,7 +19,7 @@ limitations under the License.
|
|||
-->
|
||||
{% include JB/setup %}
|
||||
|
||||
# Dynamic Form
|
||||
# What is Dynamic Form?
|
||||
|
||||
<div id="toc"></div>
|
||||
|
||||
|
|
@ -41,8 +41,7 @@ for example
|
|||
|
||||
Also you can provide default value, using `${formName=defaultValue}`.
|
||||
|
||||
<img src="../assets/themes/zeppelin/img/screenshots/form_input_default.png" />
|
||||
|
||||
<img src="/assets/themes/zeppelin/img/screenshots/form_input_default.png" />
|
||||
|
||||
### Select form
|
||||
|
||||
|
|
@ -50,11 +49,11 @@ To create select form, use `${formName=defaultValue,option1|option2...}`
|
|||
|
||||
for example
|
||||
|
||||
<img src="../assets/themes/zeppelin/img/screenshots/form_select.png" />
|
||||
<img src="/assets/themes/zeppelin/img/screenshots/form_select.png" />
|
||||
|
||||
Also you can separate option's display name and value, using `${formName=defaultValue,option1(DisplayName)|option2(DisplayName)...}`
|
||||
|
||||
<img src="../assets/themes/zeppelin/img/screenshots/form_select_displayname.png" />
|
||||
<img src="/assets/themes/zeppelin/img/screenshots/form_select_displayname.png" />
|
||||
|
||||
The paragraph will be automatically run after you change your selection by default.
|
||||
But in case you have multiple types dynamic form in one paragraph, you might want to run the paragraph after changing all the selections.
|
||||
|
|
@ -62,17 +61,17 @@ You can control this by unchecking the below **Run on selection change** option
|
|||
|
||||
Even if you uncheck this option, still you can run it by pressing `Enter`.
|
||||
|
||||
<img src="../assets/themes/zeppelin/img/screenshots/selectForm-checkbox.png" />
|
||||
<img src="/assets/themes/zeppelin/img/screenshots/selectForm-checkbox.png" />
|
||||
|
||||
### Checkbox form
|
||||
|
||||
For multi-selection, you can create a checkbox form using `${checkbox:formName=defaultValue1|defaultValue2...,option1|option2...}`. The variable will be substituted by a comma-separated string based on the selected items. For example:
|
||||
|
||||
<img src="../assets/themes/zeppelin/img/screenshots/form_checkbox.png">
|
||||
<img src="/assets/themes/zeppelin/img/screenshots/form_checkbox.png">
|
||||
|
||||
You can specify the delimiter using `${checkbox(delimiter):formName=...}`:
|
||||
|
||||
<img src="../assets/themes/zeppelin/img/screenshots/form_checkbox_delimiter.png">
|
||||
<img src="/assets/themes/zeppelin/img/screenshots/form_checkbox_delimiter.png">
|
||||
|
||||
Like [select form](#select-form), the paragraph will be automatically run after you change your selection by default.
|
||||
But in case you have multiple types dynamic form in one paragraph, you might want to run the paragraph after changing all the selections.
|
||||
|
|
@ -80,11 +79,11 @@ You can control this by unchecking the below **Run on selection change** option
|
|||
|
||||
Even if you uncheck this option, still you can run it by pressing `Enter`.
|
||||
|
||||
<img src="../assets/themes/zeppelin/img/screenshots/selectForm-checkbox.png" />
|
||||
<img src="/assets/themes/zeppelin/img/screenshots/selectForm-checkbox.png" />
|
||||
|
||||
## Creates Programmatically
|
||||
|
||||
Some language backends can programmatically create forms. For example [ZeppelinContext](../interpreter/spark.html#zeppelincontext) provides a form creation API
|
||||
Some language backends can programmatically create forms. For example [ZeppelinContext](../../interpreter/spark.html#zeppelincontext) provides a form creation API
|
||||
|
||||
Here are some examples:
|
||||
|
||||
|
|
@ -107,7 +106,7 @@ print("Hello "+z.input("name"))
|
|||
|
||||
</div>
|
||||
</div>
|
||||
<img src="../assets/themes/zeppelin/img/screenshots/form_input_prog.png" />
|
||||
<img src="/assets/themes/zeppelin/img/screenshots/form_input_prog.png" />
|
||||
|
||||
### Text input form with default value
|
||||
<div class="codetabs">
|
||||
|
|
@ -128,7 +127,7 @@ print("Hello "+z.input("name", "sun"))
|
|||
|
||||
</div>
|
||||
</div>
|
||||
<img src="../assets/themes/zeppelin/img/screenshots/form_input_default_prog.png" />
|
||||
<img src="/assets/themes/zeppelin/img/screenshots/form_input_default_prog.png" />
|
||||
|
||||
### Select form
|
||||
<div class="codetabs">
|
||||
|
|
@ -161,7 +160,7 @@ print("Hello "+z.select("day", [("1","mon"),
|
|||
|
||||
</div>
|
||||
</div>
|
||||
<img src="../assets/themes/zeppelin/img/screenshots/form_select_prog.png" />
|
||||
<img src="/assets/themes/zeppelin/img/screenshots/form_select_prog.png" />
|
||||
|
||||
#### Checkbox form
|
||||
<div class="codetabs">
|
||||
|
|
@ -184,4 +183,4 @@ print("Hello "+ " and ".join(z.checkbox("fruit", options, ["apple"])))
|
|||
|
||||
</div>
|
||||
</div>
|
||||
<img src="../assets/themes/zeppelin/img/screenshots/form_checkbox_prog.png" />
|
||||
<img src="/assets/themes/zeppelin/img/screenshots/form_checkbox_prog.png" />
|
||||
|
|
@ -1,8 +1,9 @@
|
|||
---
|
||||
layout: page
|
||||
title: "Dependency Management for Apache Spark Interpreter"
|
||||
title: "Dependency Management for Interpreter"
|
||||
description: "Include external libraries to Apache Spark Interpreter by setting dependencies in interpreter menu."
|
||||
group: manual
|
||||
group: usage/interpreter
|
||||
|
||||
---
|
||||
<!--
|
||||
Licensed under the Apache License, Version 2.0 (the "License");
|
||||
|
|
@ -33,8 +34,8 @@ When your code requires external library, instead of doing download/copy/restart
|
|||
<hr>
|
||||
<div class="row">
|
||||
<div class="col-md-6">
|
||||
<a data-lightbox="compiler" href="../assets/themes/zeppelin/img/docs-img/interpreter-dependency-loading.png">
|
||||
<img class="img-responsive" src="../assets/themes/zeppelin/img/docs-img/interpreter-dependency-loading.png" />
|
||||
<a data-lightbox="compiler" href="/assets/themes/zeppelin/img/docs-img/interpreter-dependency-loading.png">
|
||||
<img class="img-responsive" src="/assets/themes/zeppelin/img/docs-img/interpreter-dependency-loading.png" />
|
||||
</a>
|
||||
</div>
|
||||
<div class="col-md-6" style="padding-top:30px">
|
||||
|
|
@ -52,11 +53,11 @@ When your code requires external library, instead of doing download/copy/restart
|
|||
<hr>
|
||||
<div class="row">
|
||||
<div class="col-md-6">
|
||||
<a data-lightbox="compiler" href="../assets/themes/zeppelin/img/docs-img/interpreter-add-repo1.png">
|
||||
<img class="img-responsive" src="../assets/themes/zeppelin/img/docs-img/interpreter-add-repo1.png" />
|
||||
<a data-lightbox="compiler" href="/assets/themes/zeppelin/img/docs-img/interpreter-add-repo1.png">
|
||||
<img class="img-responsive" src="/assets/themes/zeppelin/img/docs-img/interpreter-add-repo1.png" />
|
||||
</a>
|
||||
<a data-lightbox="compiler" href="../assets/themes/zeppelin/img/docs-img/interpreter-add-repo2.png">
|
||||
<img class="img-responsive" src="../assets/themes/zeppelin/img/docs-img/interpreter-add-repo2.png" />
|
||||
<a data-lightbox="compiler" href="/assets/themes/zeppelin/img/docs-img/interpreter-add-repo2.png">
|
||||
<img class="img-responsive" src="/assets/themes/zeppelin/img/docs-img/interpreter-add-repo2.png" />
|
||||
</a>
|
||||
</div>
|
||||
<div class="col-md-6" style="padding-top:30px">
|
||||
|
|
@ -2,7 +2,7 @@
|
|||
layout: page
|
||||
title: "Dynamic Interpreter Loading using REST API"
|
||||
description: "Apache Zeppelin provides pluggable interpreter architecture which results in a wide and variety of the supported backend system. In this page, we will introduce dynamic interpreter loading using REST API."
|
||||
group: manual
|
||||
group: usage/interpreter
|
||||
---
|
||||
<!--
|
||||
Licensed under the Apache License, Version 2.0 (the "License");
|
||||
|
|
@ -24,19 +24,19 @@ limitations under the License.
|
|||
<div id="toc"></div>
|
||||
|
||||
Apache Zeppelin provides pluggable interpreter architecture which results in a wide and variety of the supported backend system. In this section, we will introduce **Dynamic interpreter loading** using **REST API**. This concept actually comes from [Zeppelin Helium Proposal](https://cwiki.apache.org/confluence/display/ZEPPELIN/Helium+proposal).
|
||||
Before we start, if you are not familiar with the concept of **Zeppelin interpreter**, you can check out [Overview of Zeppelin interpreter](../manual/interpreters.html) first.
|
||||
Before we start, if you are not familiar with the concept of **Zeppelin interpreter**, you can check out [Overview: Zeppelin Interpreter](./overview.html) first.
|
||||
|
||||
## Overview
|
||||
In the past, Zeppelin was loading interpreter binaries from `/interpreter/[interpreter_name]` directory. They were configured by `zeppelin.interpreters` property in `conf/zeppelin-site.xml` or `ZEPPELIN_INTERPRETERS` env variables in `conf/zeppelin-env.sh`. They were loaded on Zeppelin server startup and stayed alive until the server was stopped.
|
||||
In order to simplify using 3rd party interpreters, we changed this way to **dynamically** load interpreters from **Maven Repository** using **REST API**. Hopefully, the picture below will help you to understand the process.
|
||||
<center><img src="../assets/themes/zeppelin/img/docs-img/zeppelin_user.png" height="85%" width="85%"></center>
|
||||
<center><img src="/assets/themes/zeppelin/img/docs-img/zeppelin_user.png" height="85%" width="85%"></center>
|
||||
|
||||
## Load & Unload Interpreters Using REST API
|
||||
|
||||
### Load
|
||||
You can **load** interpreters located in Maven repository using REST API, like this:
|
||||
|
||||
( Maybe, you are unfamiliar with `[interpreter_group_name]` or `[interpreter_name]`. If so, please checkout [Interpreters in Zeppelin](../manual/interpreter.html) again. )
|
||||
(Maybe, you are unfamiliar with `[interpreter_group_name]` or `[interpreter_name]`. If so, please checkout [Overview: Zeppelin Interpreter](./overview.html) again.)
|
||||
|
||||
```
|
||||
http://[zeppelin-server]:[zeppelin-port]/api/interpreter/load/[interpreter_group_name]/[interpreter_name]
|
||||
|
|
@ -106,19 +106,19 @@ After loading an interpreter, you can use it by creating and configuring it in Z
|
|||
Oh, you don't need to restart your Zeppelin server. Because it is **Dynamic Loading**, you can configure and load it **at runtime** !
|
||||
|
||||
1. After Zeppelin server up, browse Zeppelin home and click **Interpreter tab**.
|
||||
<center><img src="../assets/themes/zeppelin/img/docs-img/interpreter_setting_1.png" height="85%" width="85%"></center>
|
||||
<center><img src="/assets/themes/zeppelin/img/docs-img/interpreter_setting_1.png" height="85%" width="85%"></center>
|
||||
|
||||
2. At the **Interpreter** section, click **+Create** button.
|
||||
<center><img src="../assets/themes/zeppelin/img/docs-img/interpreter_setting_2.png" height="85%" width="85%"></center>
|
||||
<center><img src="/assets/themes/zeppelin/img/docs-img/interpreter_setting_2.png" height="85%" width="85%"></center>
|
||||
|
||||
3. Then, you can verify the interpreter list that you loaded.
|
||||
<center><img src="../assets/themes/zeppelin/img/docs-img/interpreter_setting_3.png" height="85%" width="85%"></center>
|
||||
<center><img src="/assets/themes/zeppelin/img/docs-img/interpreter_setting_3.png" height="85%" width="85%"></center>
|
||||
|
||||
4. After choosing an interpreter, you can configure and use it. Don't forget to save it.
|
||||
|
||||
5. Create a new notebook in the **Notebook** section, then you can bind the interpreters from your interpreter list. Just drag and drop !
|
||||
<center><img src="../assets/themes/zeppelin/img/docs-img/interpreter_binding_1.png" height="85%" width="85%"></center>
|
||||
<center><img src="../assets/themes/zeppelin/img/docs-img/interpreter_binding_2.png" height="85%" width="85%"></center>
|
||||
<center><img src="/assets/themes/zeppelin/img/docs-img/interpreter_binding_1.png" height="85%" width="85%"></center>
|
||||
<center><img src="/assets/themes/zeppelin/img/docs-img/interpreter_binding_2.png" height="85%" width="85%"></center>
|
||||
|
||||
6. At last, you can use your interpreter !
|
||||
|
||||
|
|
@ -1,8 +1,8 @@
|
|||
---
|
||||
layout: page
|
||||
title: "Interpreter Installation in Netinst Binary Package"
|
||||
title: "Installing Interpreters"
|
||||
description: "Apache Zeppelin provides Interpreter Installation mechanism for whom downloaded Zeppelin netinst binary package, or just want to install another 3rd party interpreters."
|
||||
group: manual
|
||||
group: usage/interpreter
|
||||
---
|
||||
<!--
|
||||
Licensed under the Apache License, Version 2.0 (the "License");
|
||||
|
|
@ -19,7 +19,7 @@ limitations under the License.
|
|||
-->
|
||||
{% include JB/setup %}
|
||||
|
||||
# Interpreter Installation
|
||||
# Installing Interpreters
|
||||
|
||||
<div id="toc"></div>
|
||||
|
||||
|
|
@ -98,7 +98,7 @@ rm -rf ./interpreter/spark
|
|||
```
|
||||
|
||||
<br />
|
||||
Once you have installed interpreters, you need to restart Zeppelin. And then [create interpreter setting](../manual/interpreters.html#what-is-zeppelin-interpreter) and [bind it with your notebook](../manual/interpreters.html#what-is-zeppelin-interpreter-setting).
|
||||
Once you have installed interpreters, you need to restart Zeppelin. And then [create interpreter setting](./overview.html#what-is-zeppelin-interpreter) and [bind it with your notebook](./overview.html#what-is-zeppelin-interpreter-setting).
|
||||
|
||||
|
||||
## 3rd party interpreters
|
||||
|
|
@ -113,7 +113,7 @@ You can also install 3rd party interpreters located in the maven repository by u
|
|||
|
||||
The above command will download maven artifact `groupId1:artifact1:version1` and all of its transitive dependencies into `interpreter/interpreter1` directory.
|
||||
|
||||
After restart Zeppelin, then [create interpreter setting](../manual/interpreters.html#what-is-zeppelin-interpreter) and [bind it with your note](../manual/interpreters.html#what-is-zeppelin-interpreter-setting).
|
||||
After restart Zeppelin, then [create interpreter setting](./overview.html#what-is-zeppelin-interpreter) and [bind it with your note](../overview.html#what-is-interpreter-setting).
|
||||
|
||||
#### Install multiple 3rd party interpreters at once
|
||||
|
||||
|
|
@ -1,8 +1,8 @@
|
|||
---
|
||||
layout: page
|
||||
title: "Interpreters in Apache Zeppelin"
|
||||
title: "Interpreter in Apache Zeppelin"
|
||||
description: "This document explains about the role of interpreters, interpreters group and interpreter settings in Apache Zeppelin. The concept of Zeppelin interpreter allows any language/data-processing-backend to be plugged into Zeppelin."
|
||||
group: manual
|
||||
group: usage/interpreter
|
||||
---
|
||||
<!--
|
||||
Licensed under the Apache License, Version 2.0 (the "License");
|
||||
|
|
@ -19,7 +19,7 @@ limitations under the License.
|
|||
-->
|
||||
{% include JB/setup %}
|
||||
|
||||
# Interpreters in Apache Zeppelin
|
||||
# Interpreter in Apache Zeppelin
|
||||
|
||||
<div id="toc"></div>
|
||||
|
||||
|
|
@ -34,12 +34,12 @@ Zeppelin Interpreter is a plug-in which enables Zeppelin users to use a specific
|
|||
|
||||
When you click the ```+Create``` button in the interpreter page, the interpreter drop-down list box will show all the available interpreters on your server.
|
||||
|
||||
<img src="../assets/themes/zeppelin/img/screenshots/interpreter_create.png" width="280px">
|
||||
<img src="/assets/themes/zeppelin/img/screenshots/interpreter_create.png" width="280px">
|
||||
|
||||
## What is interpreter setting?
|
||||
Zeppelin interpreter setting is the configuration of a given interpreter on Zeppelin server. For example, the properties are required for hive JDBC interpreter to connect to the Hive server.
|
||||
|
||||
<img src="../assets/themes/zeppelin/img/screenshots/interpreter_setting.png" width="500px">
|
||||
<img src="/assets/themes/zeppelin/img/screenshots/interpreter_setting.png" width="500px">
|
||||
|
||||
Properties are exported as environment variables when property name is consisted of upper characters, numbers and underscore ([A-Z_0-9]). Otherwise set properties as JVM property.
|
||||
|
||||
|
|
@ -71,12 +71,12 @@ You may use parameters from the context of interpreter by add #{contextParameter
|
|||
|
||||
If context parameter is null then replaced by empty string.
|
||||
|
||||
<img src="../assets/themes/zeppelin/img/screenshots/interpreter_setting_with_context_parameters.png" width="800px">
|
||||
<img src="/assets/themes/zeppelin/img/screenshots/interpreter_setting_with_context_parameters.png" width="800px">
|
||||
|
||||
<br>
|
||||
Each notebook can be bound to multiple Interpreter Settings using setting icon on upper right corner of the notebook.
|
||||
|
||||
<img src="../assets/themes/zeppelin/img/screenshots/interpreter_binding.png" width="800px">
|
||||
<img src="/assets/themes/zeppelin/img/screenshots/interpreter_binding.png" width="800px">
|
||||
|
||||
|
||||
|
||||
|
|
@ -84,11 +84,11 @@ Each notebook can be bound to multiple Interpreter Settings using setting icon o
|
|||
Every Interpreter is belonged to an **Interpreter Group**. Interpreter Group is a unit of start/stop interpreter.
|
||||
By default, every interpreter is belonged to a single group, but the group might contain more interpreters. For example, Spark interpreter group is including Spark support, pySpark, Spark SQL and the dependency loader.
|
||||
|
||||
Technically, Zeppelin interpreters from the same group are running in the same JVM. For more information about this, please checkout [here](../development/writingzeppelininterpreter.html).
|
||||
Technically, Zeppelin interpreters from the same group are running in the same JVM. For more information about this, please checkout [here](../development/writing_zeppelin_interpreter.html).
|
||||
|
||||
Each interpreters is belonged to a single group and registered together. All of their properties are listed in the interpreter setting like below image.
|
||||
|
||||
<img src="../assets/themes/zeppelin/img/screenshots/interpreter_setting_spark.png" width="500px">
|
||||
<img src="/assets/themes/zeppelin/img/screenshots/interpreter_setting_spark.png" width="500px">
|
||||
|
||||
|
||||
## Interpreter binding mode
|
||||
|
|
@ -96,7 +96,7 @@ Each interpreters is belonged to a single group and registered together. All of
|
|||
Each Interpreter Setting can choose one of 'shared', 'scoped', 'isolated' interpreter binding mode.
|
||||
In 'shared' mode, every notebook bound to the Interpreter Setting will share the single Interpreter instance. In 'scoped' mode, each notebook will create new Interpreter instance in the same interpreter process. In 'isolated' mode, each notebook will create new Interpreter process.
|
||||
|
||||
<img src="../assets/themes/zeppelin/img/screenshots/interpreter_persession.png" width="400px">
|
||||
<img src="/assets/themes/zeppelin/img/screenshots/interpreter_persession.png" width="400px">
|
||||
|
||||
|
||||
## Connecting to the existing remote interpreter
|
||||
|
|
@ -112,12 +112,12 @@ interpreter.start()
|
|||
|
||||
The above code will start interpreter thread inside your process. Once the interpreter is started you can configure zeppelin to connect to RemoteInterpreter by checking **Connect to existing process** checkbox and then provide **Host** and **Port** on which interpreter process is listening as shown in the image below:
|
||||
|
||||
<img src="../assets/themes/zeppelin/img/screenshots/existing_interpreter.png" width="450px">
|
||||
<img src="/assets/themes/zeppelin/img/screenshots/existing_interpreter.png" width="450px">
|
||||
|
||||
## Precode
|
||||
|
||||
Snippet of code (language of interpreter) that executes after initialization of the interpreter depends on [Binding mode](#interpreter-binding-mode). To configure add parameter with class of interpreter (`zeppelin.<ClassName>.precode`) except JDBCInterpreter ([JDBC precode](../interpreter/jdbc.md#usage-precode)).
|
||||
Snippet of code (language of interpreter) that executes after initialization of the interpreter depends on [Binding mode](#interpreter-binding-mode). To configure add parameter with class of interpreter (`zeppelin.<ClassName>.precode`) except JDBCInterpreter ([JDBC precode](../../interpreter/jdbc.html#usage-precode)).
|
||||
|
||||
<img src="../assets/themes/zeppelin/img/screenshots/interpreter_precode.png" width="800px">
|
||||
<img src="/assets/themes/zeppelin/img/screenshots/interpreter_precode.png" width="800px">
|
||||
|
||||
|
||||
|
|
@ -1,8 +1,8 @@
|
|||
---
|
||||
layout: page
|
||||
title: "Run zeppelin interpreter process as web front end user"
|
||||
title: "Impersonation: run zeppelin interpreter process as web front end user"
|
||||
description: "Set up zeppelin interpreter process as web front end user."
|
||||
group: manual
|
||||
group: usage/interpreter
|
||||
---
|
||||
<!--
|
||||
Licensed under the Apache License, Version 2.0 (the "License");
|
||||
|
|
@ -19,7 +19,7 @@ limitations under the License.
|
|||
-->
|
||||
{% include JB/setup %}
|
||||
|
||||
## Run zeppelin interpreter process as web front end user
|
||||
## Impersonation: run zeppelin interpreter process as web frontend user
|
||||
|
||||
* Enable shiro auth in shiro.ini
|
||||
|
||||
|
|
@ -54,8 +54,8 @@ export ZEPPELIN_IMPERSONATE_CMD='sudo -H -u ${ZEPPELIN_IMPERSONATE_USER} bash -c
|
|||
<br /><br />
|
||||
</div>
|
||||
<div class="col-md-12" >
|
||||
<a data-lightbox="compiler" href="../assets/themes/zeppelin/img/screenshots/user-impersonation.gif">
|
||||
<img class="img-responsive" src="../assets/themes/zeppelin/img/screenshots/user-impersonation.gif" />
|
||||
<a data-lightbox="compiler" href="/assets/themes/zeppelin/img/screenshots/user-impersonation.gif">
|
||||
<img class="img-responsive" src="/assets/themes/zeppelin/img/screenshots/user-impersonation.gif" />
|
||||
</a>
|
||||
|
||||
</div>
|
||||
|
|
@ -1,8 +1,8 @@
|
|||
---
|
||||
layout: page
|
||||
title: "Customize Apache Zeppelin homepage"
|
||||
title: "Customizing Apache Zeppelin homepage"
|
||||
description: "Apache Zeppelin allows you to use one of the notes you create as your Zeppelin Homepage. With that you can brand your Zeppelin installation, adjust the instruction to your users needs and even translate to other languages."
|
||||
group: manual
|
||||
group: usage/other_features
|
||||
---
|
||||
<!--
|
||||
Licensed under the Apache License, Version 2.0 (the "License");
|
||||
|
|
@ -19,7 +19,7 @@ limitations under the License.
|
|||
-->
|
||||
{% include JB/setup %}
|
||||
|
||||
# Customize Apache Zeppelin homepage
|
||||
# Customizing Apache Zeppelin homepage
|
||||
|
||||
<div id="toc"></div>
|
||||
|
||||
|
|
@ -37,8 +37,8 @@ The process for creating your homepage is very simple as shown below:
|
|||
### Create a note using Zeppelin
|
||||
Create a new note using Zeppelin,
|
||||
you can use ```%md``` interpreter for markdown content or any other interpreter you like.
|
||||
You can also use the display system to generate [text](../displaysystem/basicdisplaysystem.html#text), [html](../displaysystem/basicdisplaysystem.html#html), [table](../displaysystem/basicdisplaysystem.html#table) or
|
||||
Angular ([backend API](../displaysystem/back-end-angular.html), [frontend API](../displaysystem/front-end-angular.html)).
|
||||
You can also use the display system to generate [text](../display_system/basic.html#text), [html](../display_system/basic.html#html), [table](../display_system/basic.html#table) or
|
||||
Angular ([backend API](../display_system/angular_backend.html), [frontend API](../display_system/angular_frontend.html)).
|
||||
|
||||
Run (shift+Enter) the note and see the output. Optionally, change the note view to report to hide
|
||||
the code sections.
|
||||
|
|
@ -82,7 +82,7 @@ println(
|
|||
|
||||
After running the paragraph, you will see output similar to this one:
|
||||
|
||||
<img src="../assets/themes/zeppelin/img/docs-img/homepage_custom_notebook_list.png" />
|
||||
<img src="/assets/themes/zeppelin/img/docs-img/homepage_custom_notebook_list.png" />
|
||||
|
||||
That's it! Voila! You have your note list.
|
||||
|
||||
|
|
@ -1,8 +1,8 @@
|
|||
---
|
||||
layout: page
|
||||
title: "How can you publish your paragraph"
|
||||
title: "How can you publish your paragraphs"
|
||||
description: "Apache Zeppelin provides a feature for publishing your notebook paragraph results. Using this feature, you can show Zeppelin notebook paragraph results in your own website."
|
||||
group: manual
|
||||
group: usage/other_features
|
||||
---
|
||||
<!--
|
||||
Licensed under the Apache License, Version 2.0 (the "License");
|
||||
|
|
@ -19,7 +19,7 @@ limitations under the License.
|
|||
-->
|
||||
{% include JB/setup %}
|
||||
|
||||
# How can you publish your paragraph ?
|
||||
# How can you publish your paragraphs?
|
||||
|
||||
<div id="toc"></div>
|
||||
|
||||
|
|
@ -30,10 +30,10 @@ It's very straightforward. Just use `<iframe>` tag in your page.
|
|||
A first step to publish your paragraph result is **Copy a Paragraph Link**.
|
||||
|
||||
* After running a paragraph in your Zeppelin notebook, click a gear button located on the right side. Then, click **Link this Paragraph** menu like below image.
|
||||
<center><img src="../assets/themes/zeppelin/img/docs-img/link-the-paragraph.png" height="100%" width="100%"></center>
|
||||
<center><img src="/assets/themes/zeppelin/img/docs-img/link-the-paragraph.png" height="100%" width="100%"></center>
|
||||
|
||||
* Just copy the provided link.
|
||||
<center><img src="../assets/themes/zeppelin/img/docs-img/copy-the-link.png" height="100%" width="100%"></center>
|
||||
<center><img src="/assets/themes/zeppelin/img/docs-img/copy-the-link.png" height="100%" width="100%"></center>
|
||||
|
||||
## Embed the Paragraph to Your Website
|
||||
For publishing the copied paragraph, you may use `<iframe>` tag in your website page.
|
||||
|
|
@ -44,6 +44,6 @@ For example,
|
|||
```
|
||||
|
||||
Finally, you can show off your beautiful visualization results in your website.
|
||||
<center><img src="../assets/themes/zeppelin/img/docs-img/your-website.png" height="90%" width="90%"></center>
|
||||
<center><img src="/assets/themes/zeppelin/img/docs-img/your-website.png" height="90%" width="90%"></center>
|
||||
|
||||
> **Note**: To embed the paragraph in a website, Apache Zeppelin needs to be reachable by that website. And please use this feature with caution and in a trusted environment only, as Zeppelin entire Webapp could be accessible by whoever visits your website.
|
||||
|
|
@ -2,7 +2,7 @@
|
|||
layout: page
|
||||
title: "Apache Zeppelin Configuration REST API"
|
||||
description: "This page contains Apache Zeppelin Configuration REST API information."
|
||||
group: rest-api
|
||||
group: usage/rest_api
|
||||
---
|
||||
<!--
|
||||
Licensed under the Apache License, Version 2.0 (the "License");
|
||||
|
|
@ -2,7 +2,7 @@
|
|||
layout: page
|
||||
title: "Apache Zeppelin Credential REST API"
|
||||
description: "This page contains Apache Zeppelin Credential REST API information."
|
||||
group: rest-api
|
||||
group: usage/rest_api
|
||||
---
|
||||
<!--
|
||||
Licensed under the Apache License, Version 2.0 (the "License");
|
||||
|
|
@ -2,7 +2,7 @@
|
|||
layout: page
|
||||
title: "Apache Zeppelin Helium REST API"
|
||||
description: "This page contains Apache Zeppelin Helium REST API information."
|
||||
group: rest-api
|
||||
group: usage/rest_api
|
||||
---
|
||||
<!--
|
||||
Licensed under the Apache License, Version 2.0 (the "License");
|
||||
|
|
@ -2,7 +2,7 @@
|
|||
layout: page
|
||||
title: "Apache Zeppelin Interpreter REST API"
|
||||
description: "This page contains Apache Zeppelin Interpreter REST API information."
|
||||
group: rest-api
|
||||
group: usage/rest_api
|
||||
---
|
||||
<!--
|
||||
Licensed under the Apache License, Version 2.0 (the "License");
|
||||
|
|
@ -32,7 +32,7 @@ If you work with Apache Zeppelin and find a need for an additional REST API, ple
|
|||
|
||||
## Interpreter REST API List
|
||||
|
||||
The role of registered interpreters, settings and interpreters group are described in [here](../manual/interpreters.html).
|
||||
The role of registered interpreters, settings and interpreters group are described in [here](../interpreter/overview.html).
|
||||
|
||||
### List of registered interpreters
|
||||
|
||||
|
|
@ -2,7 +2,7 @@
|
|||
layout: page
|
||||
title: "Apache Zeppelin Notebook REST API"
|
||||
description: "This page contains Apache Zeppelin Notebook REST API information."
|
||||
group: rest-api
|
||||
group: usage/rest_api
|
||||
---
|
||||
<!--
|
||||
Licensed under the Apache License, Version 2.0 (the "License");
|
||||
|
|
@ -2,7 +2,7 @@
|
|||
layout: page
|
||||
title: "Apache Zeppelin notebook repository REST API"
|
||||
description: "This page contains Apache Zeppelin notebook repository REST API information."
|
||||
group: rest-api
|
||||
group: usage/rest_api
|
||||
---
|
||||
<!--
|
||||
Licensed under the Apache License, Version 2.0 (the "License");
|
||||
|
|
@ -2,7 +2,7 @@
|
|||
layout: page
|
||||
title: "Apache Zeppelin Server REST API"
|
||||
description: "This page contains Apache Zeppelin Server REST API information."
|
||||
group: rest-api
|
||||
group: usage/rest_api
|
||||
---
|
||||
<!--
|
||||
Licensed under the Apache License, Version 2.0 (the "License");
|
||||
Loading…
Reference in a new issue