{% include JB/setup %}
Apache Spark is a fast and general-purpose cluster computing system. It provides high-level APIs in Java, Scala, Python and R, and an optimized engine that supports general execution graphs. Apache Spark is supported in Zeppelin with Spark interpreter group which consists of below six interpreters.
The Spark interpreter can be configured with properties provided by Zeppelin. You can also set other Spark properties which are not listed in the table. For a list of additional properties, refer to Spark Available Properties.
Without any configuration, Spark interpreter works out of box in local mode. But if you want to connect to your Spark cluster, you'll need to follow below two simple steps.
There are several options for setting SPARK_HOME
.
SPARK_HOME
in zeppelin-env.sh
SPARK_HOME
in Interpreter setting pageSPARK_HOME
via inline generic configurationSPARK_HOME
in zeppelin-env.sh
If you work with only one version of spark, then you can set SPARK_HOME
in zeppelin-env.sh
because any setting in zeppelin-env.sh
is globally applied.
e.g.
export SPARK_HOME=/usr/lib/spark
You can optionally set more environment variables in zeppelin-env.sh
# set hadoop conf dir export HADOOP_CONF_DIR=/usr/lib/hadoop
SPARK_HOME
in Interpreter setting pageIf you want to use multiple versions of spark, then you need create multiple spark interpreters and set SPARK_HOME
for each of them. e.g. Create a new spark interpreter spark24
for spark 2.4 and set SPARK_HOME
in interpreter setting page
Create a new spark interpreter spark16
for spark 1.6 and set SPARK_HOME
in interpreter setting page
SPARK_HOME
via inline generic configurationBesides setting SPARK_HOME
in interpreter setting page, you can also use inline generic configuration to put the configuration with code together for more flexibility. e.g.
After starting Zeppelin, go to Interpreter menu and edit master property in your Spark interpreter setting. The value may vary depending on your Spark cluster deployment type.
For example,
That's it. Zeppelin will work with any version of Spark and any deployment type without rebuilding Zeppelin in this way. For the further information about Spark & Zeppelin version compatibility, please refer to “Available Interpreters” section in Zeppelin download page.
Note that without exporting
SPARK_HOME
, it's running in local mode with included version of Spark. The included version may vary depending on the build profile.
SparkContext, SQLContext, SparkSession (for spark 2.x) and ZeppelinContext are automatically created and exposed as variable names sc
, sqlContext
, spark
and z
, respectively, in Scala, Kotlin, Python and R environments.
Note that Scala/Python/R environment shares the same SparkContext, SQLContext, SparkSession and ZeppelinContext instance.
Zeppelin support both yarn client and yarn cluster mode (yarn cluster mode is supported from 0.8.0). For yarn mode, you must specify SPARK_HOME
& HADOOP_CONF_DIR
. Usually you only have one hadoop cluster, so you can set HADOOP_CONF_DIR
in zeppelin-env.sh
which is applied to all spark interpreters. If you want to use spark against multiple hadoop cluster, then you need to define HADOOP_CONF_DIR
in interpreter setting or via inline generic configuration.
For spark interpreter, it is not recommended to use Zeppelin's Dependency Management for managing third party dependencies (%spark.dep
is removed from Zeppelin 0.9 as well). Instead you should set the standard Spark properties.
You can either set Spark properties in interpreter setting page or set Spark submit arguments in zeppelin-env.sh
via environment variable SPARK_SUBMIT_OPTIONS
. For examples:
export SPARK_SUBMIT_OPTIONS="--files <my_file> --jars <my_jar> --packages <my_package>"
But it is not recommended to set them in SPARK_SUBMIT_OPTIONS
. Because it will be shared by all spark interpreters, which means you can not set different dependencies for different users.
There're 2 ways to use PySpark in Zeppelin:
Vanilla PySpark interpreter is almost the same as vanilla Python interpreter except Zeppelin inject SparkContext, SQLContext, SparkSession via variables sc
, sqlContext
, spark
.
By default, Zeppelin would use IPython in %spark.pyspark
when IPython is available, Otherwise it would fall back to the original PySpark implementation. If you don't want to use IPython, then you can set zeppelin.pyspark.useIPython
as false
in interpreter setting. For the IPython features, you can refer doc Python Interpreter
You can use IPySpark
explicitly via %spark.ipyspark
. IPySpark interpreter is almost the same as IPython interpreter except Zeppelin inject SparkContext, SQLContext, SparkSession via variables sc
, sqlContext
, spark
. For the IPython features, you can refer doc Python Interpreter
Zeppelin support SparkR via %spark.r
. Here's configuration for SparkR Interpreter.
Spark Sql Interpreter share the same SparkContext/SparkSession with other Spark interpreter. That means any table registered in scala, python or r code can be accessed by Spark Sql. For examples:
%spark case class People(name: String, age: Int) var df = spark.createDataFrame(List(People("jeff", 23), People("andy", 20))) df.createOrReplaceTempView("people")
%spark.sql select * from people
By default, each sql statement would run sequentially in %spark.sql
. But you can run them concurrently by following setup.
zeppelin.spark.concurrentSQL
to true to enable the sql concurrent feature, underneath zeppelin will change to use fairscheduler for spark. And also set zeppelin.spark.concurrentSQL.max
to control the max number of sql statements running concurrently.fairscheduler.xml
under your SPARK_CONF_DIR
, check the official spark doc Configuring Pool Properties%spark(pool=pool1) sql statement
This pool feature is also available for all versions of scala Spark, PySpark. For SparkR, it is only available starting from 2.3.0.
You can choose one of shared
, scoped
and isolated
options when you configure Spark interpreter. e.g.
scoped
per user mode, Zeppelin creates separated Scala compiler for each user but share a single SparkContext.isolated
per user mode, Zeppelin creates separated SparkContext for each user.Zeppelin automatically injects ZeppelinContext
as variable z
in your Scala/Python environment. ZeppelinContext
provides some additional functions and utilities. See Zeppelin-Context for more details.
In yarn mode, the user who launch the zeppelin server will be used to launch the spark yarn application. This is not a good practise. Most of time, you will enable shiro in Zeppelin and would like to use the login user to submit the spark yarn app. For this purpose, you need to enable user impersonation for more security control. In order the enable user impersonation, you need to do the following steps
Step 1 Enable user impersonation setting hadoop's core-site.xml
. E.g. if you are using user zeppelin
to launch Zeppelin, then add the following to core-site.xml
, then restart both hdfs and yarn.
<property> <name>hadoop.proxyuser.zeppelin.groups</name> <value>*</value> </property> <property> <name>hadoop.proxyuser.zeppelin.hosts</name> <value>*</value> </property>
Step 2 Enable interpreter user impersonation in Spark interpreter's interpreter setting. (Enable shiro first of course)
Step 3(Optional) If you are using kerberos cluster, then you need to set zeppelin.server.kerberos.keytab
and zeppelin.server.kerberos.principal
to the user(aka. user in Step 1) you want to impersonate in zeppelin-site.xml
.
Logical setup with Zeppelin, Kerberos Key Distribution Center (KDC), and Spark on YARN:
Starting from 0.9, Zeppelin deprecate Spark 2.2 and earlier versions. So you will see a warning message when you use Spark 2.2 and earlier. You can get rid of this message by setting zeppelin.spark.deprecatedMsg.show
to false
.
On the server that Zeppelin is installed, install Kerberos client modules and configuration, krb5.conf. This is to make the server communicate with KDC.
Add the two properties below to Spark configuration ([SPARK_HOME]/conf/spark-defaults.conf
):
spark.yarn.principal spark.yarn.keytab
NOTE: If you do not have permission to access for the above spark-defaults.conf file, optionally, you can add the above lines to the Spark Interpreter setting through the Interpreter tab in the Zeppelin UI.