Skip to content

ZEPPELIN-296 add flink docs #303

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
bzz wants to merge 3 commits into from
Closed

ZEPPELIN-296 add flink docs #303

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f85b4cd
Update /download page
Sep 14, 2015
8e87683
Update /docs README
Sep 14, 2015
8a2f909
ZEPPELIN-296: initial Flink interpreter docs
Sep 14, 2015
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
30 changes: 19 additions & 11 deletions docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,11 @@
## Zeppelin project website

## Build
Welcome to the Zeppelin documentation!

This readme will walk you through building the Zeppelin documentation, which is included here with the Zeppelin source code.


## Build website
See https://help.github.com/articles/using-jekyll-with-pages#installing-jekyll

**tl;dr version:**
Expand All @@ -11,22 +16,25 @@ See https://help.github.com/articles/using-jekyll-with-pages#installing-jekyll

*On OS X 10.9 you may need to do "xcode-select --install"*

## On local machine

### Run
## Run website

bundle exec jekyll serve --watch

### Deploy
1. generate static website in ```_site```

bundle exec jekyll build
2. checkout asf repo
## Deploy to ASF svnpubsub infra (commiters only)
1. generate static website in `./_site`
```
bundle exec jekyll build --safe
```

2. checkout ASF repo
```
svn co https://svn.apache.org/repos/asf/incubator/zeppelin asf-zepplelin

```
3. copy zeppelin/_site to asf-zepplelin/site
4. svn commit
4. ```svn commit```

## Adding a new page

### Add a new page
rake page name="new-page.md"

3 changes: 1 addition & 2 deletions docs/docs/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ group: nav-right

**[Interpreters in zeppelin](manual/interpreters.html)**

* [flink](../docs/pleasecontribute.html)
* [flink](../docs/interpreter/flink.html)
* [hive](../docs/pleasecontribute.html)
* [ignite](../docs/pleasecontribute.html)
* [lens](../docs/pleasecontribute.html)
Expand Down Expand Up @@ -53,4 +53,3 @@ group: nav-right
* [How to contribute (website)](./development/howtocontributewebsite.html)



49 changes: 49 additions & 0 deletions docs/docs/interpreter/flink.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
---
layout: page
title: "Flink Interpreter"
description: ""
group: manual
---
{% include JB/setup %}


## Flink interpreter for Apache Zeppelin
[Apache Flink](https://flink.apache.org) is an open source platform for distributed stream and batch data processing.


### How to start local Flink cluster, to test the interpreter
Zeppelin comes with pre-configured flink-local interpreter, which starts Flink in a local mode on your machine, so you do not need to install anything.

### How to configure interpreter to point to Flink cluster
At the "Interpreters" menu, you have to create a new Flink interpreter and provide next properties:

property | value | Description
---------|----------|-----
host | local | host name of running JobManager. 'local' runs flink in local mode (default)
port | 6123 | port of running JobManager
xxx | yyy | anything else from [Flink Configuration](https://ci.apache.org/projects/flink/flink-docs-release-0.9/setup/config.html)

### How to test it's working

In example, by using the [Zeppelin notebook](https://www.zeppelinhub.com/viewer/notebooks/aHR0cHM6Ly9yYXcuZ2l0aHVidXNlcmNvbnRlbnQuY29tL05GTGFicy96ZXBwZWxpbi1ub3RlYm9va3MvbWFzdGVyL25vdGVib29rcy8yQVFFREs1UEMvbm90ZS5qc29u) is from [Till Rohrmann's presentation](http://www.slideshare.net/tillrohrmann/data-analysis-49806564) "Interactive data analysis with Apache Flink" for Apache Flink Meetup.


```
%sh
rm 10.txt.utf-8
wget http://www.gutenberg.org/ebooks/10.txt.utf-8
```
```
%flink
case class WordCount(word: String, frequency: Int)
val bible:DataSet[String] = env.readTextFile("10.txt.utf-8")
val partialCounts: DataSet[WordCount] = bible.flatMap{
line =>
"""\b\w+\b""".r.findAllIn(line).map(word => WordCount(word, 1))
// line.split(" ").map(word => WordCount(word, 1))
}
val wordCounts = partialCounts.groupBy("word").reduce{
(left, right) => WordCount(left.word, left.frequency + right.frequency)
}
val result10 = wordCounts.first(10).collect()
```
10 changes: 6 additions & 4 deletions docs/download.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,16 @@ group: nav-right

### Download Zeppelin

The latest release of Apache Zeppelin (incubating) is 0.5.0-incubating. Released on July 23, 2015 ([release notes](./docs/releases/zeppelin-release-0.5.0-incubating.html)) ([git tag](https://git-wip-us.apache.org/repos/asf?p=incubator-zeppelin.git;a=tag;h=refs/tags/v0.5.0))
The latest release of Apache Zeppelin (incubating) is *0.5.0-incubating*.

[Download](http://www.apache.org/dyn/closer.cgi/incubator/zeppelin/0.5.0-incubating)
- 0.5.0-incubating released on July 23, 2015 ([release notes](./docs/releases/zeppelin-release-0.5.0-incubating.html)) ([git tag](https://git-wip-us.apache.org/repos/asf?p=incubator-zeppelin.git;a=tag;h=refs/tags/v0.5.0))

[Download](http://www.apache.org/dyn/closer.cgi/incubator/zeppelin/0.5.0-incubating)

### Build from source, installation

Check [install](./docs/install/install.html).
### Build from source

For developers, to get latest *0.6.0-incubating-SNAPSHOT* check [install](./docs/install/install.html) section.


<!--
Expand Down