Quick Start

Welcome to your first trial to explore Apache Zeppelin! This page will help you to get started and here is the list of topics covered.

Installation

Apache Zeppelin officially supports and is tested on next environments.

There are two options to install Apache Zeppelin on your machine. One is downloading pre-built binary package from the archive. You can download not only the latest stable version but also the older one if you need. The other option is building from the source. Although it can be unstable somehow since it is on development status, you can explore newly added feature and change it as you want.

Downloading Binary Package

If you want to install Apache Zeppelin with a stable binary package, please visit Apache Zeppelin download Page.

If you have downloaded netinst binary, install additional interpreters before you start Zeppelin. Or simply run ./bin/install-interpreter.sh --all.

After unpacking, jump to Starting Apache Zeppelin with Command Line section.

Building from Source

If you want to build from the source, the software below needs to be installed on your system.

If you don't have it installed yet, please check Before Build section and follow step by step instructions from there.

1. Clone Apache Zeppelin repository

git clone https://github.com/apache/zeppelin.git

2. Build source with options

Each interpreters requires different build options. For the further information about options, please see Build section.

mvn clean package -DskipTests [Options]

Here are some examples with several options

# build with spark-2.0, scala-2.11
./dev/change_scala_version.sh 2.11
mvn clean package -Pspark-2.0 -Phadoop-2.4 -Pyarn -Ppyspark -Psparkr -Pscala-2.11

# build with spark-1.6, scala-2.10
mvn clean package -Pspark-1.6 -Phadoop-2.4 -Pyarn -Ppyspark -Psparkr

# spark-cassandra integration
mvn clean package -Pcassandra-spark-1.5 -Dhadoop.version=2.6.0 -Phadoop-2.6 -DskipTests

# with CDH
mvn clean package -Pspark-1.5 -Dhadoop.version=2.6.0-cdh5.5.0 -Phadoop-2.6 -Pvendor-repo -DskipTests

# with MapR
mvn clean package -Pspark-1.5 -Pmapr50 -DskipTests

For the further information about building with source, please see README.md in Zeppelin repository.

Starting Apache Zeppelin with Command Line

Start Zeppelin

bin/zeppelin-daemon.sh start

If you are using Windows

bin\zeppelin.cmd

After successful start, visit http://localhost:8080 with your web browser.

Stop Zeppelin

bin/zeppelin-daemon.sh stop

(Optional) Start Apache Zeppelin with a service manager

Note : The below description was written based on Ubuntu Linux.

Apache Zeppelin can be auto started as a service with an init script, such as services managed by upstart.

The following is an example of upstart script to be saved as /etc/init/zeppelin.conf This also allows the service to be managed with commands such as

sudo service zeppelin start  
sudo service zeppelin stop  
sudo service zeppelin restart

Other service managers could use a similar approach with the upstart argument passed to the zeppelin-daemon.sh script.

bin/zeppelin-daemon.sh upstart

zeppelin.conf

description "zeppelin"

start on (local-filesystems and net-device-up IFACE!=lo)
stop on shutdown

# Respawn the process on unexpected termination
respawn

# respawn the job up to 7 times within a 5 second period.
# If the job exceeds these values, it will be stopped and marked as failed.
respawn limit 7 5

# zeppelin was installed in /usr/share/zeppelin in this example
chdir /usr/share/zeppelin
exec bin/zeppelin-daemon.sh upstart

What is the next?

Congratulation on your successful Apache Zeppelin installation! Here are two next steps you might need.

If you are new to Apache Zeppelin

• For an in-depth overview of Apache Zeppelin UI, head to Explore Apache Zeppelin UI.
• After getting familiar with Apache Zeppelin UI, have fun with a short walk-through Tutorial that uses Apache Spark backend.
• If you need more configuration setting for Apache Zeppelin, jump to the next section: Apache Zeppelin Configuration.

If you need more information about Spark or JDBC interpreter setting

• Apache Zeppelin provides deep integration with Apache Spark. For the further informtation, see Spark Interpreter for Apache Zeppelin.
• Also, you can use generic JDBC connections in Apache Zeppelin. Go to Generic JDBC Interpreter for Apache Zeppelin.

If you are in multi-user environment

• You can set permissions for your notebooks and secure data resource in multi-user environment. Go to More -> Security section.

Apache Zeppelin Configuration

You can configure Apache Zeppelin with both environment variables in conf/zeppelin-env.sh (conf\zeppelin-env.cmd for Windows) and Java properties in conf/zeppelin-site.xml. If both are defined, then the environment variables will take priority.