svn commit: r1766620 [2/2] - in /zeppelin/site/docs/0.7.0-SNAPSHOT: ./ assets/themes/zeppelin/img/ui-img/ install/ manual/ rest-api/

Tue, 25 Oct 2016 20:20:07 -0700 

Modified: zeppelin/site/docs/0.7.0-SNAPSHOT/search_data.json
URL: 
http://svn.apache.org/viewvc/zeppelin/site/docs/0.7.0-SNAPSHOT/search_data.json?rev=1766620&r1=1766619&r2=1766620&view=diff
==============================================================================
--- zeppelin/site/docs/0.7.0-SNAPSHOT/search_data.json (original)
+++ zeppelin/site/docs/0.7.0-SNAPSHOT/search_data.json Wed Oct 26 03:19:37 2016
@@ -94,7 +94,7 @@
 
     "/install/install.html": {
       "title": "Quick Start",
-      "content"  : "<!--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 
athttp://www.apache.org/licenses/LICENSE-2.0Unless required by applicable law 
or agreed to in writing, softwaredistributed 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 andlimitations under the License.-->Quick StartWelcome to Apache 
Zeppelin! On this page are instructions to help you get 
started.InstallationApache Zeppelin officially supports and is tested on the 
following environments:      Name    Value        Oracle JDK    1.7  (set 
JAVA_HOME)        OS    Mac OSX  Ubuntu 14.X  CentOS 6.X  Windows 7 Pro SP1  To 
install Apache Zeppelin, you have two options:You can download pre-built binary 
packages from the archive. This is usua
 lly easier than building from source, and you can download the latest stable 
version (or older versions, if necessary).You can also build from source. This 
gives you a development version of Zeppelin, which is more unstable but has new 
features.Downloading Binary PackageStable binary packages are available on the 
Apache Zeppelin Download Page. You can download a default package with all 
interpreters, or you can download the net-install package, which lets you 
choose which interpreters to install.If you downloaded the default package, 
just unpack it in a directory of your choice and you're ready to go. If 
you downloaded the net-install package, you should manually install additional 
interpreters first. You can also install everything by running 
./bin/install-interpreter.sh --all.After unpacking, jump to the Starting Apache 
Zeppelin with Command Line.Building from SourceIf you want to build from 
source, you must first install the following dependencies:      Name    Value   
  
    Git    (Any Version)        Maven    3.1.x or higher  If you 
haven't installed Git and Maven yet, check the Before Build section and 
follow the step by step instructions from there.1. Clone the Apache Zeppelin 
repositorygit clone https://github.com/apache/zeppelin.git2. Build source with 
optionsEach interpreter requires different build options. For more information 
about build options, please see the 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.11mvn clean package -Pspark-2.0 
-Phadoop-2.4 -Pyarn -Ppyspark -Psparkr -Pscala-2.11# build with spark-1.6, 
scala-2.10mvn clean package -Pspark-1.6 -Phadoop-2.4 -Pyarn -Ppyspark -Psparkr# 
spark-cassandra integrationmvn clean package -Pcassandra-spark-1.5 
-Dhadoop.version=2.6.0 -Phadoop-2.6 -DskipTests# with CDHmvn clean package 
-Pspark-1.5 -Dhadoop.version=2.6.0-cdh5.5.0 -Phadoop-2.6 -Pvendor-repo 
-DskipTests# with M
 apRmvn clean package -Pspark-1.5 -Pmapr50 -DskipTestsFor further information 
about building from source, please see README.md in the Zeppelin 
repository.Starting Apache Zeppelin from the Command LineStarting Apache 
ZeppelinOn all platforms except for Windows:bin/zeppelin-daemon.sh startIf you 
are using Windows:binzeppelin.cmdAfter Zeppelin has started successfully, go to 
http://localhost:8080 with your web browser.Stopping 
Zeppelinbin/zeppelin-daemon.sh stop(Optional) Start Apache Zeppelin with a 
service managerNote : The below description was written based on Ubuntu 
Linux.Apache Zeppelin can be auto-started as a service with an init script, 
using a service manager like upstart.This is an example upstart script saved as 
/etc/init/zeppelin.confThis allows the service to be managed with commands such 
assudo service zeppelin start  sudo service zeppelin stop  sudo service 
zeppelin restartOther service managers could use a similar approach with the 
upstart argument passed to the zeppeli
 n-daemon.sh script.bin/zeppelin-daemon.sh upstartzeppelin.confdescription 
"zeppelin"start on (local-filesystems and net-device-up 
IFACE!=lo)stop on shutdown# Respawn the process on unexpected 
terminationrespawn# 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 examplechdir 
/usr/share/zeppelinexec bin/zeppelin-daemon.sh upstartNext 
Steps:Congratulations, you have successfully installed Apache Zeppelin! Here 
are two next steps you might find useful:If you are new to Apache 
Zeppelin...For an in-depth overview of the Apache Zeppelin UI, head to Explore 
Apache Zeppelin UI.After getting familiar with the Apache Zeppelin UI, have fun 
with a short walk-through Tutorial that uses the Apache Spark backend.If you 
need more configuration for Apache Zeppelin, jump to the next section: Apache 
Zeppelin Configuration.If you need 
 more information about Spark or JDBC interpreter settings...Apache Zeppelin 
provides deep integration with Apache Spark. For more information, see Spark 
Interpreter for Apache Zeppelin.You can also use generic JDBC connections in 
Apache Zeppelin. Go to Generic JDBC Interpreter for Apache Zeppelin.If you are 
in a multi-user environment...You can set permissions for your notebooks and 
secure data resource in a multi-user environment. Go to More -> Security 
section.Apache Zeppelin ConfigurationYou can configure Apache Zeppelin with 
either environment variables in conf/zeppelin-env.sh (confzeppelin-env.cmd for 
Windows) or Java properties in conf/zeppelin-site.xml. If both are defined, 
then the environment variables will take priority.      zeppelin-env.sh    
zeppelin-site.xml    Default value    Description        ZEPPELIN_PORT    
zeppelin.server.port    8080    Zeppelin server port        ZEPPELIN_SSL_PORT   
 zeppelin.server.ssl.port    8443    Zeppelin Server ssl port (used whe
 n ssl environment/property is set to true)        ZEPPELIN_MEM    N/A    
-Xmx1024m -XX:MaxPermSize=512m    JVM mem options        ZEPPELIN_INTP_MEM    
N/A    ZEPPELIN_MEM    JVM mem options for interpreter process        
ZEPPELIN_JAVA_OPTS    N/A        JVM options        ZEPPELIN_ALLOWED_ORIGINS    
zeppelin.server.allowed.origins    *    Enables a way to specify a ',' 
separated list of allowed origins for REST and websockets.  i.e. 
http://localhost:8080           N/A    zeppelin.anonymous.allowed    true    
The anonymous user is allowed by default.        ZEPPELIN_SERVER_CONTEXT_PATH   
 zeppelin.server.context.path    /    Context path of the web application       
 ZEPPELIN_SSL    zeppelin.ssl    false            ZEPPELIN_SSL_CLIENT_AUTH    
zeppelin.ssl.client.auth    false            ZEPPELIN_SSL_KEYSTORE_PATH    
zeppelin.ssl.keystore.path    keystore            ZEPPELIN_SSL_KEYSTORE_TYPE    
zeppelin.ssl.keystore.type    JKS            ZEPPELIN_SSL_KEYSTORE_PASSWORD    
zep
 pelin.ssl.keystore.password                ZEPPELIN_SSL_KEY_MANAGER_PASSWORD   
 zeppelin.ssl.key.manager.password                ZEPPELIN_SSL_TRUSTSTORE_PATH  
  zeppelin.ssl.truststore.path                ZEPPELIN_SSL_TRUSTSTORE_TYPE    
zeppelin.ssl.truststore.type                ZEPPELIN_SSL_TRUSTSTORE_PASSWORD    
zeppelin.ssl.truststore.password                ZEPPELIN_NOTEBOOK_HOMESCREEN    
zeppelin.notebook.homescreen        Display notebook IDs on the Apache Zeppelin 
homescreen i.e. 2A94M5J1Z        ZEPPELIN_NOTEBOOK_HOMESCREEN_HIDE    
zeppelin.notebook.homescreen.hide    false    Hide the notebook ID set by 
ZEPPELIN_NOTEBOOK_HOMESCREEN on the Apache Zeppelin homescreen. For the further 
information, please read Customize your Zeppelin homepage.        
ZEPPELIN_WAR_TEMPDIR    zeppelin.war.tempdir    webapps    Location of the 
jetty temporary directory        ZEPPELIN_NOTEBOOK_DIR    zeppelin.notebook.dir 
   notebook    The root directory where notebook directories are saved     
    ZEPPELIN_NOTEBOOK_S3_BUCKET    zeppelin.notebook.s3.bucket    zeppelin    
S3 Bucket where notebook files will be saved        ZEPPELIN_NOTEBOOK_S3_USER   
 zeppelin.notebook.s3.user    user    User name of an S3 bucketi.e. 
bucket/user/notebook/2A94M5J1Z/note.json        ZEPPELIN_NOTEBOOK_S3_ENDPOINT   
 zeppelin.notebook.s3.endpoint    s3.amazonaws.com    Endpoint for the bucket   
     ZEPPELIN_NOTEBOOK_S3_KMS_KEY_ID    zeppelin.notebook.s3.kmsKeyID        
AWS KMS Key ID to use for encrypting data in S3 (optional)        
ZEPPELIN_NOTEBOOK_S3_EMP    zeppelin.notebook.s3.encryptionMaterialsProvider    
    Class name of a custom S3 encryption materials provider implementation to 
use for encrypting data in S3 (optional)        
ZEPPELIN_NOTEBOOK_AZURE_CONNECTION_STRING    
zeppelin.notebook.azure.connectionString        The Azure storage account 
connection stringi.e. 
DefaultEndpointsProtocol=https;AccountName=<accountName>;AccountKey=<accountKey>
        ZEPPEL
 IN_NOTEBOOK_AZURE_SHARE    zeppelin.notebook.azure.share    zeppelin    Azure 
Share where the notebook files will be saved        
ZEPPELIN_NOTEBOOK_AZURE_USER    zeppelin.notebook.azure.user    user    
Optional user name of an Azure file sharei.e. 
share/user/notebook/2A94M5J1Z/note.json        ZEPPELIN_NOTEBOOK_STORAGE    
zeppelin.notebook.storage    org.apache.zeppelin.notebook.repo.VFSNotebookRepo  
  Comma separated list of notebook storage locations        
ZEPPELIN_NOTEBOOK_ONE_WAY_SYNC    zeppelin.notebook.one.way.sync    false    If 
there are multiple notebook storage locations, should we treat the first one as 
the only source of truth?        ZEPPELIN_INTERPRETERS    zeppelin.interpreters 
     
org.apache.zeppelin.spark.SparkInterpreter,org.apache.zeppelin.spark.PySparkInterpreter,org.apache.zeppelin.spark.SparkSqlInterpreter,org.apache.zeppelin.spark.DepInterpreter,org.apache.zeppelin.markdown.Markdown,org.apache.zeppelin.shell.ShellInterpreter,
    ...              Comma separ
 ated interpreter configurations [Class]       NOTE: This property is 
deprecated since Zeppelin-0.6.0 and will not be supported from Zeppelin-0.7.0 
on.            ZEPPELIN_INTERPRETER_DIR    zeppelin.interpreter.dir    
interpreter    Interpreter directory        
ZEPPELIN_WEBSOCKET_MAX_TEXT_MESSAGE_SIZE    
zeppelin.websocket.max.text.message.size    1024000    Size (in characters) of 
the maximum text message that can be received by websocket.  ",
+      "content"  : "<!--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 
athttp://www.apache.org/licenses/LICENSE-2.0Unless required by applicable law 
or agreed to in writing, softwaredistributed 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 andlimitations under the License.-->Quick StartWelcome to Apache 
Zeppelin! On this page are instructions to help you get 
started.InstallationApache Zeppelin officially supports and is tested on the 
following environments:      Name    Value        Oracle JDK    1.7  (set 
JAVA_HOME)        OS    Mac OSX  Ubuntu 14.X  CentOS 6.X  Windows 7 Pro SP1  To 
install Apache Zeppelin, you have two options:You can download pre-built binary 
packages from the archive. This is usua
 lly easier than building from source, and you can download the latest stable 
version (or older versions, if necessary).You can also build from source. This 
gives you a development version of Zeppelin, which is more unstable but has new 
features.Downloading Binary PackageStable binary packages are available on the 
Apache Zeppelin Download Page. You can download a default package with all 
interpreters, or you can download the net-install package, which lets you 
choose which interpreters to install.If you downloaded the default package, 
just unpack it in a directory of your choice and you're ready to go. If 
you downloaded the net-install package, you should manually install additional 
interpreters first. You can also install everything by running 
./bin/install-interpreter.sh --all.After unpacking, jump to the Starting Apache 
Zeppelin with Command Line.Building from SourceIf you want to build from 
source, you must first install the following dependencies:      Name    Value   
  
    Git    (Any Version)        Maven    3.1.x or higher  If you 
haven't installed Git and Maven yet, check the Before Build section and 
follow the step by step instructions from there.1. Clone the Apache Zeppelin 
repositorygit clone https://github.com/apache/zeppelin.git2. Build source with 
optionsEach interpreter requires different build options. For more information 
about build options, please see the 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.11mvn clean package -Pspark-2.0 
-Phadoop-2.4 -Pyarn -Ppyspark -Psparkr -Pscala-2.11# build with spark-1.6, 
scala-2.10mvn clean package -Pspark-1.6 -Phadoop-2.4 -Pyarn -Ppyspark -Psparkr# 
spark-cassandra integrationmvn clean package -Pcassandra-spark-1.5 
-Dhadoop.version=2.6.0 -Phadoop-2.6 -DskipTests# with CDHmvn clean package 
-Pspark-1.5 -Dhadoop.version=2.6.0-cdh5.5.0 -Phadoop-2.6 -Pvendor-repo 
-DskipTests# with M
 apRmvn clean package -Pspark-1.5 -Pmapr50 -DskipTestsFor further information 
about building from source, please see README.md in the Zeppelin 
repository.Starting Apache Zeppelin from the Command LineStarting Apache 
ZeppelinOn all platforms except for Windows:bin/zeppelin-daemon.sh startIf you 
are using Windows:binzeppelin.cmdAfter Zeppelin has started successfully, go to 
http://localhost:8080 with your web browser.Stopping 
Zeppelinbin/zeppelin-daemon.sh stop(Optional) Start Apache Zeppelin with a 
service managerNote : The below description was written based on Ubuntu 
Linux.Apache Zeppelin can be auto-started as a service with an init script, 
using a service manager like upstart.This is an example upstart script saved as 
/etc/init/zeppelin.confThis allows the service to be managed with commands such 
assudo service zeppelin start  sudo service zeppelin stop  sudo service 
zeppelin restartOther service managers could use a similar approach with the 
upstart argument passed to the zeppeli
 n-daemon.sh script.bin/zeppelin-daemon.sh upstartzeppelin.confdescription 
"zeppelin"start on (local-filesystems and net-device-up 
IFACE!=lo)stop on shutdown# Respawn the process on unexpected 
terminationrespawn# 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 examplechdir 
/usr/share/zeppelinexec bin/zeppelin-daemon.sh upstartNext 
Steps:Congratulations, you have successfully installed Apache Zeppelin! Here 
are two next steps you might find useful:If you are new to Apache 
Zeppelin...For an in-depth overview of the Apache Zeppelin UI, head to Explore 
Apache Zeppelin UI.After getting familiar with the Apache Zeppelin UI, have fun 
with a short walk-through Tutorial that uses the Apache Spark backend.If you 
need more configuration for Apache Zeppelin, jump to the next section: Apache 
Zeppelin Configuration.If you need 
 more information about Spark or JDBC interpreter settings...Apache Zeppelin 
provides deep integration with Apache Spark. For more information, see Spark 
Interpreter for Apache Zeppelin.You can also use generic JDBC connections in 
Apache Zeppelin. Go to Generic JDBC Interpreter for Apache Zeppelin.If you are 
in a multi-user environment...You can set permissions for your notebooks and 
secure data resource in a multi-user environment. Go to More -> Security 
section.Apache Zeppelin ConfigurationYou can configure Apache Zeppelin with 
either environment variables in conf/zeppelin-env.sh (confzeppelin-env.cmd for 
Windows) or Java properties in conf/zeppelin-site.xml. If both are defined, 
then the environment variables will take priority.      zeppelin-env.sh    
zeppelin-site.xml    Default value    Description        ZEPPELIN_PORT    
zeppelin.server.port    8080    Zeppelin server port        ZEPPELIN_SSL_PORT   
 zeppelin.server.ssl.port    8443    Zeppelin Server ssl port (used whe
 n ssl environment/property is set to true)        ZEPPELIN_MEM    N/A    
-Xmx1024m -XX:MaxPermSize=512m    JVM mem options        ZEPPELIN_INTP_MEM    
N/A    ZEPPELIN_MEM    JVM mem options for interpreter process        
ZEPPELIN_JAVA_OPTS    N/A        JVM options        ZEPPELIN_ALLOWED_ORIGINS    
zeppelin.server.allowed.origins    *    Enables a way to specify a ',' 
separated list of allowed origins for REST and websockets.  i.e. 
http://localhost:8080           N/A    zeppelin.anonymous.allowed    true    
The anonymous user is allowed by default.        ZEPPELIN_SERVER_CONTEXT_PATH   
 zeppelin.server.context.path    /    Context path of the web application       
 ZEPPELIN_SSL    zeppelin.ssl    false            ZEPPELIN_SSL_CLIENT_AUTH    
zeppelin.ssl.client.auth    false            ZEPPELIN_SSL_KEYSTORE_PATH    
zeppelin.ssl.keystore.path    keystore            ZEPPELIN_SSL_KEYSTORE_TYPE    
zeppelin.ssl.keystore.type    JKS            ZEPPELIN_SSL_KEYSTORE_PASSWORD    
zep
 pelin.ssl.keystore.password                ZEPPELIN_SSL_KEY_MANAGER_PASSWORD   
 zeppelin.ssl.key.manager.password                ZEPPELIN_SSL_TRUSTSTORE_PATH  
  zeppelin.ssl.truststore.path                ZEPPELIN_SSL_TRUSTSTORE_TYPE    
zeppelin.ssl.truststore.type                ZEPPELIN_SSL_TRUSTSTORE_PASSWORD    
zeppelin.ssl.truststore.password                ZEPPELIN_NOTEBOOK_HOMESCREEN    
zeppelin.notebook.homescreen        Display note IDs on the Apache Zeppelin 
homescreen i.e. 2A94M5J1Z        ZEPPELIN_NOTEBOOK_HOMESCREEN_HIDE    
zeppelin.notebook.homescreen.hide    false    Hide the note ID set by 
ZEPPELIN_NOTEBOOK_HOMESCREEN on the Apache Zeppelin homescreen. For the further 
information, please read Customize your Zeppelin homepage.        
ZEPPELIN_WAR_TEMPDIR    zeppelin.war.tempdir    webapps    Location of the 
jetty temporary directory        ZEPPELIN_NOTEBOOK_DIR    zeppelin.notebook.dir 
   notebook    The root directory where notebook directories are saved        
ZEPPE
 LIN_NOTEBOOK_S3_BUCKET    zeppelin.notebook.s3.bucket    zeppelin    S3 Bucket 
where notebook files will be saved        ZEPPELIN_NOTEBOOK_S3_USER    
zeppelin.notebook.s3.user    user    User name of an S3 bucketi.e. 
bucket/user/notebook/2A94M5J1Z/note.json        ZEPPELIN_NOTEBOOK_S3_ENDPOINT   
 zeppelin.notebook.s3.endpoint    s3.amazonaws.com    Endpoint for the bucket   
     ZEPPELIN_NOTEBOOK_S3_KMS_KEY_ID    zeppelin.notebook.s3.kmsKeyID        
AWS KMS Key ID to use for encrypting data in S3 (optional)        
ZEPPELIN_NOTEBOOK_S3_EMP    zeppelin.notebook.s3.encryptionMaterialsProvider    
    Class name of a custom S3 encryption materials provider implementation to 
use for encrypting data in S3 (optional)        
ZEPPELIN_NOTEBOOK_AZURE_CONNECTION_STRING    
zeppelin.notebook.azure.connectionString        The Azure storage account 
connection stringi.e. 
DefaultEndpointsProtocol=https;AccountName=<accountName>;AccountKey=<accountKey>
        ZEPPELIN_NOTEB
 OOK_AZURE_SHARE    zeppelin.notebook.azure.share    zeppelin    Azure Share 
where the notebook files will be saved        ZEPPELIN_NOTEBOOK_AZURE_USER    
zeppelin.notebook.azure.user    user    Optional user name of an Azure file 
sharei.e. share/user/notebook/2A94M5J1Z/note.json        
ZEPPELIN_NOTEBOOK_STORAGE    zeppelin.notebook.storage    
org.apache.zeppelin.notebook.repo.VFSNotebookRepo    Comma separated list of 
notebook storage locations        ZEPPELIN_NOTEBOOK_ONE_WAY_SYNC    
zeppelin.notebook.one.way.sync    false    If there are multiple notebook 
storage locations, should we treat the first one as the only source of truth?   
     ZEPPELIN_INTERPRETERS    zeppelin.interpreters      
org.apache.zeppelin.spark.SparkInterpreter,org.apache.zeppelin.spark.PySparkInterpreter,org.apache.zeppelin.spark.SparkSqlInterpreter,org.apache.zeppelin.spark.DepInterpreter,org.apache.zeppelin.markdown.Markdown,org.apache.zeppelin.shell.ShellInterpreter,
    ...              Comma separated int
 erpreter configurations [Class]       NOTE: This property is deprecated since 
Zeppelin-0.6.0 and will not be supported from Zeppelin-0.7.0 on.            
ZEPPELIN_INTERPRETER_DIR    zeppelin.interpreter.dir    interpreter    
Interpreter directory        ZEPPELIN_WEBSOCKET_MAX_TEXT_MESSAGE_SIZE    
zeppelin.websocket.max.text.message.size    1024000    Size (in characters) of 
the maximum text message that can be received by websocket.  ",
       "url": " /install/install.html",
       "group": "install",
       "excerpt": "This page will help you get started and will guide you 
through installing Apache Zeppelin, running it in the command line and 
configuring options."
@@ -127,7 +127,7 @@
 
     "/install/virtual_machine.html": {
       "title": "Apache Zeppelin on Vagrant Virtual Machine",
-      "content"  : "<!--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 
athttp://www.apache.org/licenses/LICENSE-2.0Unless required by applicable law 
or agreed to in writing, softwaredistributed 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 andlimitations under the License.-->Apache Zeppelin on Vagrant 
Virtual MachineOverviewApache Zeppelin distribution includes a script 
directoryscripts/vagrant/zeppelin-devThis script creates a virtual machine that 
launches a repeatable, known set of core dependencies required for developing 
Zeppelin. It can also be used to run an existing Zeppelin build if you 
don't plan to build from source.For PySpark users, this script includes 
several helpful Python Librar
 ies.For SparkR users, this script includes several helpful R 
Libraries.PrerequisitesThis script requires three applications, Ansible, 
Vagrant and Virtual Box.  All of these applications are freely available as 
Open Source projects and extremely easy to set up on most operating 
systems.Create a Zeppelin Ready VMIf you are running Windows and don't 
yet have python installed, install Python 2.7.x first.Download and Install 
Vagrant:  Vagrant DownloadsInstall Ansible:  Ansible Python pip installsudo 
easy_install pipsudo pip install ansibleansible --versionAfter then, please 
check whether it reports ansible version 1.9.2 or higher.Install Virtual Box: 
Virtual Box DownloadsType vagrant up  from within the 
/scripts/vagrant/zeppelin-dev directoryThats it ! You can now run vagrant ssh 
and this will place you into the guest machines terminal prompt.If you 
don't wish to build Zeppelin from scratch, run the z-manager installer 
script while running in the guest VM:curl -fsSL https
 ://raw.githubusercontent.com/NFLabs/z-manager/master/zeppelin-installer.sh | 
bashBuilding ZeppelinYou can now git clone 
git://git.apache.org/zeppelin.gitinto a directory on your host machine, or 
directly in your virtual machine.Cloning Zeppelin into the 
/scripts/vagrant/zeppelin-dev directory from the host, will allow the directory 
to be shared between your host and the guest machine.Cloning the project again 
may seem counter intuitive, since this script likely originated from the 
project repository.  Consider copying just the vagrant/zeppelin-dev script from 
the Zeppelin project as a stand alone directory, then once again clone the 
specific branch you wish to build.Synced folders enable Vagrant to sync a 
folder on the host machine to the guest machine, allowing you to continue 
working on your project's files on your host machine, but use the 
resources in the guest machine to compile or run your project. (1) Synced 
Folder Description from Vagrant UpBy default, Vagrant will s
 hare your project directory (the directory with the Vagrantfile) to /vagrant.  
Which means you should be able to build within the guest machine after youcd 
/vagrant/zeppelinWhat's in this VM?Running the following commands in 
the guest machine should display these expected versions:node --version should 
report v0.12.7mvn --version should report Apache Maven 3.3.9 and Java version: 
1.7.0_85The virtual machine consists of:Ubuntu Server 14.04 LTSNode.js 
0.12.7npm 2.11.3ruby 1.9.3 + rake, make and bundler (only required if building 
jekyll documentation)Maven 3.3.9GitUnziplibfontconfig to avoid phatomJs missing 
dependency issuesopenjdk-7-jdkPython addons: pip, matplotlib, scipy, numpy, 
pandasR and R Packages required to run the R Interpreter and the related R 
tutorial notebook, including:  Knitr, devtools, repr, rCharts, ggplot2, 
googleVis, mplot, htmltools, base64enc, data.tableHow to build & run 
ZeppelinThis assumes you've already cloned the project either on the
  host machine in the zeppelin-dev directory (to be shared with the guest 
machine) or cloned directly into a directory while running inside the guest 
machine.  The following build steps will also include Python and R support via 
PySpark and SparkR:cd /zeppelinmvn clean package -Pspark-1.6 -Ppyspark 
-Phadoop-2.4 -Psparkr -DskipTests./bin/zeppelin-daemon.sh startOn your host 
machine browse to http://localhost:8080/If you turned off port forwarding in 
the Vagrantfile browse to http://192.168.51.52:8080Tweaking the Virtual 
MachineIf you plan to run this virtual machine along side other Vagrant images, 
you may wish to bind the virtual machine to a specific IP address, and not use 
port fowarding from your local host.Comment out the forward_port line, and 
uncomment the private_network line in Vagrantfile.  The subnet that works best 
for your local network will vary so adjust 192.168.*.* 
accordingly.#config.vm.network "forwarded_port", guest: 8080, 
host: 8080config.vm.netwo
 rk "private_network", ip: 
"192.168.51.52"vagrant halt followed by vagrant up will 
restart the guest machine bound to the IP address of 192.168.51.52.This 
approach usually is typically required if running other virtual machines that 
discover each other directly by IP address, such as Spark Masters and Slaves as 
well as Cassandra Nodes, Elasticsearch Nodes, and other Spark data sources.  
You may wish to launch nodes in virtual machines with IP addresses in a subnet 
that works for your local network, such as: 192.168.51.53, 192.168.51.54, 
192.168.51.53, etc..ExtrasPython ExtrasWith Zeppelin running, Numpy, SciPy, 
Pandas and Matplotlib will be available.  Create a pyspark notebook, and try 
the below code.%pysparkimport numpyimport scipyimport pandasimport 
matplotlibprint "numpy " + numpy.__version__print 
"scipy " + scipy.__version__print "pandas " 
+ pandas.__version__print "matplotlib &amp
 ;quot; + matplotlib.__version__To Test plotting using Matplotlib into a 
rendered %html SVG image, try%pysparkimport 
matplotlibmatplotlib.use('Agg')   # turn off interactive 
charting so this works for server side SVG renderingimport matplotlib.pyplot as 
pltimport numpy as npimport StringIO# clear out any previous plots on this 
notebookplt.clf()def show(p):    img = StringIO.StringIO()    p.savefig(img, 
format='svg')    img.seek(0)    print "%html 
<div style='width:600px'>" + img.buf + 
"</div>"# Example datapeople = 
('Tom', 'Dick', 'Harry', 
'Slim', 'Jim')y_pos = 
np.arange(len(people))performance = 3 + 10 * np.random.rand(len(people))error = 
np.random.rand(len(people))plt.barh(y_pos, performance, xerr=error, 
align='center', alpha=0.4)plt.yticks(y_pos, 
people)plt.xlabel('Per
 formance')plt.title('How fast do you want to go 
today?')show(plt)R ExtrasWith zeppelin running, an R Tutorial notebook 
will be available.  The R packages required to run the examples and graphs in 
this tutorial notebook were installed by this virtual machine.The installed R 
Packages include: Knitr, devtools, repr, rCharts, ggplot2, googleVis, mplot, 
htmltools, base64enc, data.table",
+      "content"  : "<!--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 
athttp://www.apache.org/licenses/LICENSE-2.0Unless required by applicable law 
or agreed to in writing, softwaredistributed 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 andlimitations under the License.-->Apache Zeppelin on Vagrant 
Virtual MachineOverviewApache Zeppelin distribution includes a script 
directoryscripts/vagrant/zeppelin-devThis script creates a virtual machine that 
launches a repeatable, known set of core dependencies required for developing 
Zeppelin. It can also be used to run an existing Zeppelin build if you 
don't plan to build from source.For PySpark users, this script includes 
several helpful Python Librar
 ies.For SparkR users, this script includes several helpful R 
Libraries.PrerequisitesThis script requires three applications, Ansible, 
Vagrant and Virtual Box.  All of these applications are freely available as 
Open Source projects and extremely easy to set up on most operating 
systems.Create a Zeppelin Ready VMIf you are running Windows and don't 
yet have python installed, install Python 2.7.x first.Download and Install 
Vagrant:  Vagrant DownloadsInstall Ansible:  Ansible Python pip installsudo 
easy_install pipsudo pip install ansibleansible --versionAfter then, please 
check whether it reports ansible version 1.9.2 or higher.Install Virtual Box: 
Virtual Box DownloadsType vagrant up  from within the 
/scripts/vagrant/zeppelin-dev directoryThats it ! You can now run vagrant ssh 
and this will place you into the guest machines terminal prompt.If you 
don't wish to build Zeppelin from scratch, run the z-manager installer 
script while running in the guest VM:curl -fsSL https
 ://raw.githubusercontent.com/NFLabs/z-manager/master/zeppelin-installer.sh | 
bashBuilding ZeppelinYou can now git clone 
git://git.apache.org/zeppelin.gitinto a directory on your host machine, or 
directly in your virtual machine.Cloning Zeppelin into the 
/scripts/vagrant/zeppelin-dev directory from the host, will allow the directory 
to be shared between your host and the guest machine.Cloning the project again 
may seem counter intuitive, since this script likely originated from the 
project repository.  Consider copying just the vagrant/zeppelin-dev script from 
the Zeppelin project as a stand alone directory, then once again clone the 
specific branch you wish to build.Synced folders enable Vagrant to sync a 
folder on the host machine to the guest machine, allowing you to continue 
working on your project's files on your host machine, but use the 
resources in the guest machine to compile or run your project. (1) Synced 
Folder Description from Vagrant UpBy default, Vagrant will s
 hare your project directory (the directory with the Vagrantfile) to /vagrant.  
Which means you should be able to build within the guest machine after youcd 
/vagrant/zeppelinWhat's in this VM?Running the following commands in 
the guest machine should display these expected versions:node --version should 
report v0.12.7mvn --version should report Apache Maven 3.3.9 and Java version: 
1.7.0_85The virtual machine consists of:Ubuntu Server 14.04 LTSNode.js 
0.12.7npm 2.11.3ruby 1.9.3 + rake, make and bundler (only required if building 
jekyll documentation)Maven 3.3.9GitUnziplibfontconfig to avoid phatomJs missing 
dependency issuesopenjdk-7-jdkPython addons: pip, matplotlib, scipy, numpy, 
pandasR and R Packages required to run the R Interpreter and the related R 
tutorial notebook, including:  Knitr, devtools, repr, rCharts, ggplot2, 
googleVis, mplot, htmltools, base64enc, data.tableHow to build & run 
ZeppelinThis assumes you've already cloned the project either on the
  host machine in the zeppelin-dev directory (to be shared with the guest 
machine) or cloned directly into a directory while running inside the guest 
machine.  The following build steps will also include Python and R support via 
PySpark and SparkR:cd /zeppelinmvn clean package -Pspark-1.6 -Ppyspark 
-Phadoop-2.4 -Psparkr -DskipTests./bin/zeppelin-daemon.sh startOn your host 
machine browse to http://localhost:8080/If you turned off port forwarding in 
the Vagrantfile browse to http://192.168.51.52:8080Tweaking the Virtual 
MachineIf you plan to run this virtual machine along side other Vagrant images, 
you may wish to bind the virtual machine to a specific IP address, and not use 
port fowarding from your local host.Comment out the forward_port line, and 
uncomment the private_network line in Vagrantfile.  The subnet that works best 
for your local network will vary so adjust 192.168.*.* 
accordingly.#config.vm.network "forwarded_port", guest: 8080, 
host: 8080config.vm.netwo
 rk "private_network", ip: 
"192.168.51.52"vagrant halt followed by vagrant up will 
restart the guest machine bound to the IP address of 192.168.51.52.This 
approach usually is typically required if running other virtual machines that 
discover each other directly by IP address, such as Spark Masters and Slaves as 
well as Cassandra Nodes, Elasticsearch Nodes, and other Spark data sources.  
You may wish to launch nodes in virtual machines with IP addresses in a subnet 
that works for your local network, such as: 192.168.51.53, 192.168.51.54, 
192.168.51.53, etc..ExtrasPython ExtrasWith Zeppelin running, Numpy, SciPy, 
Pandas and Matplotlib will be available.  Create a pyspark notebook, and try 
the below code.%pysparkimport numpyimport scipyimport pandasimport 
matplotlibprint "numpy " + numpy.__version__print 
"scipy " + scipy.__version__print "pandas " 
+ pandas.__version__print "matplotlib &amp
 ;quot; + matplotlib.__version__To Test plotting using Matplotlib into a 
rendered %html SVG image, try%pysparkimport 
matplotlibmatplotlib.use('Agg')   # turn off interactive 
charting so this works for server side SVG renderingimport matplotlib.pyplot as 
pltimport numpy as npimport StringIO# clear out any previous plots on this 
noteplt.clf()def show(p):    img = StringIO.StringIO()    p.savefig(img, 
format='svg')    img.seek(0)    print "%html 
<div style='width:600px'>" + img.buf + 
"</div>"# Example datapeople = 
('Tom', 'Dick', 'Harry', 
'Slim', 'Jim')y_pos = 
np.arange(len(people))performance = 3 + 10 * np.random.rand(len(people))error = 
np.random.rand(len(people))plt.barh(y_pos, performance, xerr=error, 
align='center', alpha=0.4)plt.yticks(y_pos, 
people)plt.xlabel('Perform
 ance')plt.title('How fast do you want to go 
today?')show(plt)R ExtrasWith zeppelin running, an R Tutorial notebook 
will be available.  The R packages required to run the examples and graphs in 
this tutorial notebook were installed by this virtual machine.The installed R 
Packages include: Knitr, devtools, repr, rCharts, ggplot2, googleVis, mplot, 
htmltools, base64enc, data.table",
       "url": " /install/virtual_machine.html",
       "group": "install",
       "excerpt": "Apache Zeppelin provides a script for running a virtual 
machine for development through Vagrant. The script will create a virtual 
machine with core dependencies pre-installed, required for developing Apache 
Zeppelin."
@@ -446,10 +446,10 @@
 
     "/manual/notebookashomepage.html": {
       "title": "Customize Apache Zeppelin homepage",
-      "content"  : "<!--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 
athttp://www.apache.org/licenses/LICENSE-2.0Unless required by applicable law 
or agreed to in writing, softwaredistributed 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 andlimitations under the License.-->Customize Apache Zeppelin 
homepageApache Zeppelin allows you to use one of the notebooks 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.How to set a notebook as your Zeppelin homepageThe process for 
creating your homepage is very simple as shown below:Create a notebook using 
ZeppelinSet the notebook id in the c
 onfig fileRestart ZeppelinCreate a notebook using ZeppelinCreate a new 
notebook 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, html, table orAngular (backend API, frontend API).Run (shift+Enter) the 
notebook and see the output. Optionally, change the notebook view to report to 
hidethe code sections.Set the notebook id in the config fileTo set the notebook 
id in the config file, you should copy it from the last word in the notebook 
url.For example,Set the notebook id to the ZEPPELIN_NOTEBOOK_HOMESCREEN 
environment variableor zeppelin.notebook.homescreen property.You can also set 
the ZEPPELIN_NOTEBOOK_HOMESCREEN_HIDE environment variableor 
zeppelin.notebook.homescreen.hide property to hide the new notebook from the 
notebook list.Restart ZeppelinRestart your Zeppelin server./bin/zeppelin-daemon 
stop./bin/zeppelin-daemon startThat's it! Open your browser and 
navigate to Apach
 e Zeppelin and see your customized homepage.Show notes list in your custom 
homepageIf you want to display the list of notes on your custom Apache Zeppelin 
homepage allyou need to do is use our %angular support.Add the following code 
to a paragraph in you home page and run it... Voila! You have your notes 
list.println("""%angular  <div 
class="col-md-4" ng-controller="HomeCtrl as 
home">    <h4>Notebooks</h4>    
<div>      <h5><a href="" 
data-toggle="modal" 
data-target="#noteNameModal" style="text-decoration: 
none;">        <i style="font-size: 
15px;" 
class="icon-notebook"></i> Create new 
note</a></h5>        <ul 
style="list-style-type: none;">     
      <li ng-repeat="note in home.notes.list track by 
$index"><i style="font-size: 10px;" 
class="icon-doc"></i>            
<a style="text-decoration: none;" 
href="#/notebook/"></a>          
</li>        </ul>    </div>  
</div>""")After running the notebook 
you will see output similar to this one:The main trick here relays in linking 
the <div> to the controller:<div 
class="col-md-4" ng-controller="HomeCtrl as 
home">Once we have home as our controller variable in our 
<div></div> we can use home.notes.list to get 
access to the notebook list.",
+      "content"  : "<!--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 
athttp://www.apache.org/licenses/LICENSE-2.0Unless required by applicable law 
or agreed to in writing, softwaredistributed 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 andlimitations under the License.-->Customize Apache Zeppelin 
homepageApache 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.How 
to set a note as your Zeppelin homepageThe process for creating your homepage 
is very simple as shown below:Create a note using ZeppelinSet the note id in 
the config fileRestar
 t ZeppelinCreate a note using ZeppelinCreate 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, html, table orAngular 
(backend API, frontend API).Run (shift+Enter) the note and see the output. 
Optionally, change the note view to report to hidethe code sections.Set the 
note id in the config fileTo set the note id in the config file, you should 
copy it from the last word in the note url.For example,Set the note id to the 
ZEPPELIN_NOTEBOOK_HOMESCREEN environment variableor 
zeppelin.notebook.homescreen property.You can also set the 
ZEPPELIN_NOTEBOOK_HOMESCREEN_HIDE environment variableor 
zeppelin.notebook.homescreen.hide property to hide the new note from the note 
list.Restart ZeppelinRestart your Zeppelin server./bin/zeppelin-daemon 
stop./bin/zeppelin-daemon startThat's it! Open your browser and 
navigate to Apache Zeppelin and see your customized homepage.Show notes l
 ist in your custom homepageIf you want to display the list of notes on your 
custom Apache Zeppelin homepage allyou need to do is use our %angular 
support.Add the following code to a paragraph in you home page and run it... 
Voila! You have your notes list.println("""%angular  
<div class="col-md-4" ng-controller="HomeCtrl 
as home">    <h4>Notebooks</h4>    
<div>      <h5><a href="" 
data-toggle="modal" 
data-target="#noteNameModal" style="text-decoration: 
none;">        <i style="font-size: 
15px;" 
class="icon-notebook"></i> Create new 
note</a></h5>        <ul 
style="list-style-type: none;">          <li 
ng-repeat="note in home.notes.l
 ist track by $index"><i style="font-size: 
10px;" class="icon-doc"></i>    
        <a style="text-decoration: none;" 
href="#/notebook/"></a>          
</li>        </ul>    </div>  
</div>""")After running the note you 
will see output similar to this one:The main trick here relays in linking the 
<div> to the controller:<div 
class="col-md-4" ng-controller="HomeCtrl as 
home">Once we have home as our controller variable in our 
<div></div> we can use home.notes.list to get 
access to the note list.",
       "url": " /manual/notebookashomepage.html",
       "group": "manual",
-      "excerpt": "Apache Zeppelin allows you to use one of the notebooks 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."
+      "excerpt": "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."
     }
     ,
     
@@ -535,7 +535,7 @@
 
     "/rest-api/rest-notebook.html": {
       "title": "Apache Zeppelin Notebook REST API",
-      "content"  : "<!--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 
athttp://www.apache.org/licenses/LICENSE-2.0Unless required by applicable law 
or agreed to in writing, softwaredistributed 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 andlimitations under the License.-->Apache Zeppelin Notebook 
REST APIOverviewApache Zeppelin provides several REST APIs for interaction and 
remote activation of zeppelin functionality.All REST APIs are available 
starting with the following endpoint 
http://[zeppelin-server]:[zeppelin-port]/api. Note that Apache Zeppelin REST 
APIs receive or return JSON objects, it is recommended for you to install some 
JSON viewers such as JSONView.If you work with Apache Zeppelin and
  find a need for an additional REST API, please file an issue or send us an 
email.Notebook REST API ListNotebooks REST API supports the following 
operations: List, Create, Get, Delete, Clone, Run, Export, Import as detailed 
in the following tables.List of the notebooks              Description      
This GET method lists the available notebooks on your server.          Notebook 
JSON contains the name and id of all notebooks.                    URL      
http://[zeppelin-server]:[zeppelin-port]/api/notebook              Success code 
     200               Fail code       500                sample JSON response  
     {  "status": "OK",  
"message": "",  "body": [ 
   {      "name":"Homepage",      
"id":"2AV4WUEMK"    },    {      
"name":"Zeppelin Tutorial",      
"id":&quot
 ;2A94M5J1Z"    }  ]}      Create a new notebook              
Description      This POST method creates a new notebook using the given name 
or default name if none given.          The body field of the returned JSON 
contains the new notebook id.                    URL      
http://[zeppelin-server]:[zeppelin-port]/api/notebook              Success code 
     201               Fail code       500                sample JSON input 
(without paragraphs)       {"name": "name of new 
notebook"}               sample JSON input (with initial paragraphs)   
    {  "name": "name of new notebook",  
"paragraphs": [    {      "title": 
"paragraph title1",      "text": 
"paragraph text1"    },    {      "title": 
"paragraph title2",      "text": 
"paragraph text2"    
 }  ]}               sample JSON response       {  "status": 
"CREATED",  "message": 
"",  "body": "2AZPHY918"} 
     Get an existing notebook information              Description      This 
GET method retrieves an existing notebook's information using the given 
id.          The body field of the returned JSON contain information about 
paragraphs in the notebook.                    URL      
http://[zeppelin-server]:[zeppelin-port]/api/notebook/[notebookId]              
Success code      200               Fail code       500                sample 
JSON response       {  "status": "OK",  
"message": "",  "body": { 
   "paragraphs": [      {        "text": 
"%sql nselect age, count(1) valuenfrom bank nwhere age < 30 
ngroup by age norder by a
 ge",        "config": {          
"colWidth": 4,          "graph": {          
  "mode": "multiBarChart",            
"height": 300,            "optionOpen": 
false,            "keys": [              {                
"name": "age",                
"index": 0,                "aggr": 
"sum"              }            ],            
"values": [              {                
"name": "value",                
"index": 1,                "aggr": 
"sum"              }            ],            
"groups": [],            "scatter": {       
       "xAxis": {                "name": 
"
 age",                "index": 0,                
"aggr": "sum"              },              
"yAxis": {                "name": 
"value",                "index": 1,         
       "aggr": "sum"              }         
   }          }        },        "settings": {          
"params": {},          "forms": {}        
},        "jobName": 
"paragraph_1423500782552_-1439281894",        
"id": "20150210-015302_1492795503",        
"result": {          "code": 
"SUCCESS",          "type": 
"TABLE",          "msg": 
"agetvaluen19t4n20t3n21t7n22t9n23t20n24t24n25t44n26t77n27t94n28t103n29t97n&q
 uot;        },        "dateCreated": "Feb 10, 2015 
1:53:02 AM",        "dateStarted": "Jul 3, 
2015 1:43:17 PM",        "dateFinished": 
"Jul 3, 2015 1:43:23 PM",        "status": 
"FINISHED",        
"progressUpdateIntervalMs": 500      }    ],    
"name": "Zeppelin Tutorial",    
"id": "2A94M5J1Z",    
"angularObjects": {},    "config": {      
"looknfeel": "default"    },    
"info": {}  }}      Delete a notebook              
Description      This DELETE method deletes a notebook by the given notebook 
id.                    URL      
http://[zeppelin-server]:[zeppelin-port]/api/notebook/[notebookId]              
Success code      200               Fail code       500     
            sample JSON response       {"status": 
"OK","message": ""}      
Clone a notebook              Description      This POST method clones a 
notebook by the given id and create a new notebook using the given name         
 or default name if none given.          The body field of the returned JSON 
contains the new notebook id.                    URL      
http://[zeppelin-server]:[zeppelin-port]/api/notebook/[notebookId]              
Success code      201               Fail code       500                sample 
JSON input       {"name": "name of new 
notebook"}               sample JSON response       {  
"status": "CREATED",  
"message": "",  "body": 
"2AZPHY918"}      Run all paragraphs              Description 
           This POST method runs all paragraphs in the give
 n notebook id.       If you can not find Notebook id 404 returns.      If 
there is a problem with the interpreter returns a 412 error.                    
URL      http://[zeppelin-server]:[zeppelin-port]/api/notebook/job/[notebookId] 
             Success code      200               Fail code       404 or 412     
          sample JSON response       {"status": 
"OK"}                sample JSON error response               
             {             "status": 
"NOTFOUND",             "message": 
"note not found."           }                             {   
          "status": "PRECONDITIONFAILED",   
          "message": 
"paragraph1469771130099-278315611 Not selected or Invalid Interpreter 
bind"           }                      Stop all paragraphs             
 Description      This DELETE method stops all paragr
 aphs in the given notebook id.                    URL      
http://[zeppelin-server]:[zeppelin-port]/api/notebook/job/[notebookId]          
    Success code      200               Fail code       500                
sample JSON response       {"status":"OK"}  
    Get the status of all paragraphs              Description      This GET 
method gets the status of all paragraphs by the given notebook id.          The 
body field of the returned JSON contains of the array that compose of the 
paragraph id, paragraph status, paragraph finish date, paragraph started date.  
                  URL      
http://[zeppelin-server]:[zeppelin-port]/api/notebook/job/[notebookId]          
    Success code      200               Fail code       500                
sample JSON response       {  "status": 
"OK",  "body": [    {      
"id":"20151121-212654_766735423",      
"statu
 s":"FINISHED",      
"finished":"Tue Nov 24 14:21:40 KST 2015",  
    "started":"Tue Nov 24 14:21:39 KST 
2015"    },    {      
"progress":"1",      
"id":"20151121-212657_730976687",      
"status":"RUNNING",      
"finished":"Tue Nov 24 14:21:35 KST 2015",  
    "started":"Tue Nov 24 14:21:40 KST 
2015"    }  ]}      Get the status of a single paragraph              
Description      This GET method gets the status of a single paragraph by the 
given notebook and paragraph id.          The body field of the returned JSON 
contains of the array that compose of the paragraph id, paragraph status, 
paragraph finish date, paragraph started date.                    URL      
http://[zeppelin-server]:[zeppelin-port]/api/noteb
 ook/job/[notebookId]/[paragraphId]              Success code      200          
     Fail code       500                sample JSON response       {  
"status": "OK",  "body": 
{      "id":"20151121-212654_766735423",    
  "status":"FINISHED",      
"finished":"Tue Nov 24 14:21:40 KST 2015",  
    "started":"Tue Nov 24 14:21:39 KST 
2015"    }}      Run a paragraph asynchronously              
Description      This POST method runs the paragraph asynchronously by given 
notebook and paragraph id. This API always return SUCCESS even if the execution 
of the paragraph fails later because the API is asynchronous                    
URL      
http://[zeppelin-server]:[zeppelin-port]/api/notebook/job/[notebookId]/[paragraphId]
              Success code      200               Fail code       500          
       sample JSON input (optional, only needed when if you want to update 
dynamic form's value)       {  "name": "name 
of new notebook",  "params": {    
"formLabel1": "value1",    
"formLabel2": "value2"  }}               
sample JSON response       {"status": "OK"} 
     Run a paragraph synchronously              Description       This POST 
method runs the paragraph synchronously by given notebook and paragraph id. 
This API can return SUCCESS or ERROR depending on the outcome of the paragraph 
execution                    URL      
http://[zeppelin-server]:[zeppelin-port]/api/notebook/job/[notebookId]/[paragraphId]
              Success code      200               Fail code       500           
     sample JSON input (optional, only needed when if you want to update 
dynamic form's value)       {  "name&am
 p;quot;: "name of new notebook",  
"params": {    "formLabel1": 
"value1",    "formLabel2": 
"value2"  }}               sample JSON response       
{"status": "OK"}               sample JSON 
error       {   "status": 
"INTERNAL_SERVER_ERROR",   "body": {       
"code": "ERROR",       
"type": "TEXT",       
"msg": "bash: -c: line 0: unexpected EOF while 
looking for matching ``'nbash: -c: line 1: syntax error: unexpected end 
of filenExitValue: 2"   }}      Stop a paragraph              
Description      This DELETE method stops the paragraph by given notebook and 
paragraph id.                    URL      
http://[zeppelin-server]:[zeppelin-port]/api/notebook/job/[notebookId]/[paragraph
 Id]              Success code      200               Fail code       500       
         sample JSON response       {"status": 
"OK"}      Add Cron Job              Description      This 
POST method adds cron job by the given notebook id.                    URL      
http://[zeppelin-server]:[zeppelin-port]/api/notebook/cron/[notebookId]         
     Success code      200               Fail code       500                
sample JSON input       {"cron": "cron expression of 
notebook"}               sample JSON response       
{"status": "OK"}      Remove Cron Job       
       Description      This DELETE method removes cron job by the given 
notebook id.                    URL      
http://[zeppelin-server]:[zeppelin-port]/api/notebook/cron/[notebookId]         
     Success code      200               Fail code       500                
sample JSON response       {"status&
 quot;: "OK"}      Get Cron Job              Description      
This GET method gets cron job expression of given notebook id.          The 
body field of the returned JSON contains the cron expression.                   
 URL      
http://[zeppelin-server]:[zeppelin-port]/api/notebook/cron/[notebookId]         
     Success code      200               Fail code       500                
sample JSON response       {"status": "OK", 
"body": "* * * * * ?"}      Full text 
search through the paragraphs in all notebooks              Description      
GET request will return list of matching paragraphs                    URL      
http://[zeppelin-server]:[zeppelin-port]/api/notebook/search?q=[query]          
    Success code      200              Fail code       500               Sample 
JSON response       {  "status": "OK",  
"body": [    {      "i
 d": "/paragraph/",      
"name":"Notebook Name",       
"snippet":"",      
"text":""    }  ]}      Create a new 
paragraph              Description      This POST method create a new paragraph 
using JSON payload.          The body field of the returned JSON contain the 
new paragraph id.                    URL      
http://[zeppelin-server]:[zeppelin-port]/api/notebook/[notebookId]/paragraph    
          Success code      201               Fail code       500               
 sample JSON input (add to the last)       {  "title": 
"Paragraph insert revised",  "text": 
"%sparknprintln("Paragraph insert 
revised")"}               sample JSON input (add to specific 
index)       {  "title": "Paragraph insert 
revised",  "text&quo
 t;: "%sparknprintln("Paragraph insert 
revised")",  "index": 0}               
sample JSON response       {  "status": 
"CREATED",  "message": 
"",  "body": 
"20151218-100330_1754029574"}      Get a paragraph 
information              Description      This GET method retrieves an existing 
paragraph's information using the given id.          The body field of 
the returned JSON contain information about paragraph.                    URL   
   
http://[zeppelin-server]:[zeppelin-port]/api/notebook/[notebookId]/paragraph/[paragraphId]
              Success code      200               Fail code       500           
     sample JSON response       {  "status": 
"OK",  "message": "",  
"body": {    "title": "Paragraph2&
 amp;quot;,    "text": 
"%sparknnprintln("it's 
paragraph2")",    "dateUpdated": 
"Dec 18, 2015 7:33:54 AM",    "config": {   
   "colWidth": 12,      "graph": {        
"mode": "table",        
"height": 300,        "optionOpen": false,  
      "keys": [],        "values": [],      
  "groups": [],        "scatter": {}      
},      "enabled": true,      "title": 
true,      "editorMode": "ace/mode/scala"   
 },    "settings": {      "params": {},     
 "forms": {}    },    "jobName": 
"paragraph_1450391574392_-1890856722",    "id&qu
 ot;: "20151218-073254_1105602047",    
"result": {      "code": 
"SUCCESS",      "type": 
"TEXT",      "msg": "it's 
paragraph2n"    },    "dateCreated": "Dec 
18, 2015 7:32:54 AM",    "dateStarted": 
"Dec 18, 2015 7:33:55 AM",    
"dateFinished": "Dec 18, 2015 7:33:55 AM",  
  "status": "FINISHED",    
"progressUpdateIntervalMs": 500  }}      Move a paragraph to 
the specific index              Description      This POST method moves a 
paragraph to the specific index (order) from the notebook.                    
URL      
http://[zeppelin-server]:[zeppelin-port]/api/notebook/[notebookId]/paragraph/[paragraphId]/move/[newIndex]
              Success code      200               Fail code
        500                sample JSON response       
{"status": 
"OK","message": ""}      
Delete a paragraph              Description      This DELETE method deletes a 
paragraph by the given notebook and paragraph id.                    URL      
http://[zeppelin-server]:[zeppelin-port]/api/notebook/[notebookId]/paragraph/[paragraphId]
              Success code      200               Fail code       500           
     sample JSON response       {"status": 
"OK","message": ""}      
Export a notebook              Description      This GET method exports a 
notebook by the given id and gernerates a JSON                    URL      
http://[zeppelin-server]:[zeppelin-port]/api/notebook/export/[notebookId]       
       Success code      201               Fail code       500          sample 
JSON response       {  "paragraphs": [    { 
      "text": "%md This is my new paragraph in my 
new note",      "dateUpdated": "Jan 8, 2016 
4:49:38 PM",      "config": {        
"enabled": true      },      "settings": {  
      "params": {},        "forms": {}      
},      "jobName": 
"paragraph_1452300578795_1196072540",      
"id": "20160108-164938_1685162144",      
"dateCreated": "Jan 8, 2016 4:49:38 PM",    
  "status": "READY",      
"progressUpdateIntervalMs": 500    }  ],  
"name": "source note for export",  
"id": "2B82H3RR1",  
"angularObjects": {},  "config": {},  
"info": {}}      Impo
 rt a notebook              Description      This POST method imports a 
notebook from the notebook JSON input                    URL      
http://[zeppelin-server]:[zeppelin-port]/api/notebook/import              
Success code      201               Fail code       500         sample JSON 
input      {  "paragraphs": [    {      
"text": "%md This is my new paragraph in my new 
note",      "dateUpdated": "Jan 8, 2016 
4:49:38 PM",      "config": {        
"enabled": true      },      "settings": {  
      "params": {},        "forms": {}      
},      "jobName": 
"paragraph_1452300578795_1196072540",      
"id": "20160108-164938_1685162144",      
"dateCreated": "Jan 8, 2016 4:49:38 PM",    
  "status&amp
 ;quot;: "READY",      
"progressUpdateIntervalMs": 500    }  ],  
"name": "source note for export",  
"id": "2B82H3RR1",  
"angularObjects": {},  "config": {},  
"info": {}}          sample JSON response      {  
"status": "CREATED",  
"message": "",  "body": 
"2AZPHY918"}          ",

[... 5 lines stripped ...]

Reply via email to