Skip to content
Permalink
Branch: master
Find file Copy path
Find file Copy path
225 lines (177 sloc) 16.5 KB

Pre-Requisites

The following software need to be installed and appropriate environment variables must to be set to run Mobius applications.

Version Environment variables Notes
JDK 7u85 or 8u60 (OpenJDK or Oracle JDK) JAVA_HOME After setting JAVA_HOME, run set PATH=%PATH%;%JAVA_HOME%\bin to add java to PATH
Spark 1.5.2 or 1.6.* SPARK_HOME Spark can be downloaded from Spark download website. The version of Spark should match the one supported by the Mobius branch/release you are using. See Mobius versioning policy for notes of Spark & Mobius versions. Alternatively, if you used RunSamples.cmd to run Mobius samples, you can find toos\spark* directory (under build directory) that can be used as SPARK_HOME
winutils.exe see Running Hadoop on Windows for details HADOOP_HOME Spark in Windows needs this utility in %HADOOP_HOME%\bin directory. It can be copied over from any Hadoop distribution. Alternative, if you used RunSamples.cmd to run Mobius samples, you can find toos\winutils directory (under build directory) that can be used as HADOOP_HOME
Mobius Appropriate version of Mobius release or a valid dev build SPARKCLR_HOME If you downloaded a Mobius release, SPARKCLR_HOME should be set to the directory named runtime (for example, D:\downloads\spark-clr_2.10-1.5.200\runtime). Alternatively, if you used RunSamples.cmd to run Mobius samples, you can find runtime directory (under build directory) that can be used as SPARKCLR_HOME.

Dependencies

Some features in Mobius depend on classes outside of Spark and Mobius. A selected set of jar files that Mobius depends on are available in Mobius release under "runtime\dependencies" folder. These jar files are used with "--jars" parameter in Mobius (that is sparkclr-submit.cmd) and they get passed to Spark (spark-submit.cmd).

The following tables lists the Mobius features and their dependencies. The version numbers in the jar files below are just for completeness in names and a different version of the jar file may work with Mobius.

Mobius Feature Dependencies
Using CSV files with DataFrame API
  • spark-csv_2.10-1.3.0.jar
  • commons-csv-1.1.jar
  • Kafka messages processing with DStream API spark-streaming-kafka-assembly_2.10-1.6.1.jar

    Note that additional external jar files may need to be specificed as dependencies for a Mobius application depending on the Mobius features used (like EventHubs event processing or using Hive). These jars are not included in Mobius release under "dependencies" folder.

    Windows Instructions

    Local Mode

    To use Mobius with Spark available locally in a machine, navigate to %SPARKCLR_HOME%\scripts directory and run the following command

    sparkclr-submit.cmd <spark arguments> --exe <Mobius driver name> <path to driver> <driver arguments>

    Notes

    Sample Commands

    • sparkclr-submit.cmd --total-executor-cores 2 --exe SparkClrPi.exe C:\Git\Mobius\examples\Pi\bin\Debug
    • sparkclr-submit.cmd --conf spark.local.dir=C:\sparktemp --exe SparkClrPi.exe C:\Git\Mobius\examples\Pi\bin\Debug
    • sparkclr-submit.cmd --jars c:\dependency\some.jar --exe SparkClrPi.exe C:\Git\Mobius\examples\Pi\bin\Debug

    Debug Mode

    Debug mode is used to step through the C# code in Visual Studio during a debugging session. With this mode, driver-side operations can be debugged.

    The steps to debug a Mobius driver program are:

    1. Navigate to %SPARKCLR_HOME%\scripts directory and run sparkclr-submit.cmd debug (Note: refer to additional instructions for Mobius versions 1.6.200 or later)
    2. Look for the message in the console output that looks like "Port number used by CSharpBackend is ". Note down the port number and use it in the next step
    3. Add the following XML snippet to App.Config in the Visual Studio project for Mobius application that you want to debug and start debugging
    <appSettings>
        <add key="CSharpWorkerPath" value="/path/to/driverprogram/CSharpWorker.exe"/>
        <add key="CSharpBackendPortNumber" value="port_number_from_previous_step"/>
    </appSettings>
    

    Instructions for Mobius versions 1.6.200 or later

    • Syntax to launch CSharpBackend in debug mode is sparkclr-submit.cmd debug <port number>. Port number is optional.
      • If the port number is not specified, default port number (5567) will be used and there is no need to set that in App.Config using the key CSharpBackendPortNumber.
      • If the port number is specified, it will be used when launching the CSharpBackend. This port number should be set in App.Config using the key CSharpBackendPortNumber
      • If the port number specified is 0, a random port number will be used in CSharpBackend. This behavior is same as in Mobius releases prior to 1.6.200. This port number should be set in App.Config using the key CSharpBackendPortNumber

    Notes

    • CSharpWorkerPath - the folder containing CSharpWorker.exe should also contain Microsoft.Spark.CSharp.Adapter.dll, executable that has the Mobius driver application and any dependent binaries. Typically, the path to CSharpWorker.exe in the build output directory of Mobius application is used for this configuration value
    • In debug mode sparkclr-submit.cmd (or sparkclr-submit.sh) does not support commandline parameters like --jars or --conf.
    • If a jar file is required by Spark (for example, spark-xml_2.10-0.3.1.jar to process XML files) then the local path to the jar file must set using the command set SPARKCLR_DEBUGMODE_EXT_JARS=C:\ext\spark-xml\spark-xml_2.10-0.3.1.jar before launching CSharpBackend in step #1 above

    Standalone Cluster

    Client Mode

    Mobius runtime folder and the build output of Mobius driver application must be copied over to the machine where you submit Mobius apps to a Spark Standalone cluster. Once copying is done, instructions are same as that of local mode but specifying master URL (--master <spark://host:port>) is required in addition.

    Sample Commands

    • sparkclr-submit.cmd --master spark://93.184.216.34:7077 --total-executor-cores 2 --exe SparkClrPi.exe C:\Git\Mobius\examples\Pi\bin\Debug
    • sparkclr-submit.cmd --master spark://93.184.216.34:7077 --conf spark.local.dir=C:\sparktemp --exe SparkClrPi.exe C:\Git\Mobius\examples\Pi\bin\Debug
    • sparkclr-submit.cmd --master spark://93.184.216.34:7077 --jars c:\dependency\some.jar --exe SparkClrPi.exe C:\Git\Mobius\examples\Pi\bin\Debug

    Cluster Mode

    To submit Mobius app in Cluster mode, both spark-clr*.jar and app binaries need be made available in HDFS. Let's say Pi.zip includes all files under Pi\bin\[debug|release]:

    hdfs dfs -copyFromLocal \path\to\pi.zip hdfs://path/to/pi
    hdfs dfs -copyFromLocal \path\to\runtime\lib\spark-clr*.jar hdfs://path/to/spark-clr-jar
    
    cd \path\to\runtime
    scripts\sparkclr-submit.cmd ^
        --total-executor-cores 2 ^
        --deploy-mode cluster ^
        --master <spark://host:port> ^
        --remote-sparkclr-jar hdfs://path/to/spark-clr-jar/spark-clr_2.10-1.5.200.jar ^
        --exe Pi.exe ^
        hdfs://path/to/pi/pi.zip ^
        spark.local.dir <full-path to temp directory on any spark worker>
    

    YARN Cluster

    Mobius runtime folder and the build output of Mobius application must be copied over to the machine where you submit Mobius application to a YARN cluster, also make sure following enviroment variables are set properly before submission.

    • HADOOP_HOME
    • HADOOP_CONF_DIR
    • YARN_CONF_DIR
    • SPARK_HOME
    • SPARK_DIST_CLASSPATH

    Client Mode

    Sample command

    sparkclr-submit.cmd ^
        --master yarn ^
        --deploy-mode client ^
        --num-executors 10 ^
        --executor-cores 2 ^
        --executor-memory 1G ^
        --conf spark.speculation=true ^
        --driver-memory 1G ^
        --exe SparkClrPi.exe ^
        C:\Git\Mobius\examples\Pi\bin\Debug
    

    Cluster Mode

    Sample command

    sparkclr-submit.cmd ^
        --master yarn ^
        --deploy-mode cluster ^
        --num-executors 10 ^
        --executor-cores 2 ^
        --executor-memory 1G ^
        --conf spark.speculation=true ^
        --driver-memory 1G ^
        --exe SparkClrPi.exe ^
        C:\Git\Mobius\examples\Pi\bin\Debug
    

    Linux Instructions

    Instructions to run Mobius applications in Linux are available at linux-instructions.md

    Running Mobius Examples in Local Mode

    Type Examples
    Batch
    SQL
    Streaming

    The following sample commands show how to run Mobius examples in local mode. Using the instruction above, the following sample commands can be tweaked to run in other modes

    Pi Example (Batch)

    • Run sparkclr-submit.cmd --exe SparkClrPi.exe C:\Git\Mobius\examples\Batch\Pi\bin\Debug

    Computes the approximate value of Pi using two appropaches and displays the value.

    WordCount Example (Batch)

    • Run sparkclr-submit.cmd --exe SparkClrPi.exe C:\Git\Mobius\examples\Batch\WordCount\bin\Debug <InputFilePath>

    InputFilePath should be in one of the following formats:

    • hdfs://path/to/inputfile
    • file:///C:/path/to/inputfile

    WordCount Example - F# (Batch)

    • Run sparkclr-submit.cmd --exe WordCountFSharp.exe C:\Git\Mobius\examples\fsharp\WordCount\bin\Debug <InputFilePath>

    InputFilePath should be in one of the following formats:

    • hdfs://path/to/inputfile
    • file:///C:/path/to/inputfile

    JDBC Example (Sql)

    • Download a JDBC driver for the SQL Database you want to use
    • sparkclr-submit.cmd --jars C:\MobiusDependencies\sqljdbc4.jar --exe SparkClrJdbc.exe C:\Git\Mobius\examples\Sql\JdbcDataFrame\bin\Debug <jdbc connection string> <table name>

    The schema and row count of the table name provided as the commandline argument to SparkClrJdbc.exe is displayed.

    Spark-XML Example (Sql)

    • Download books.xml and the location of this file is the first argument to SparkClrXml.exe below

    sparkclr-submit.cmd --jars C:\MobiusDependencies\spark-xml_2.10-0.3.1.jar --exe SparkClrXml.exe C:\Git\Mobius\examples\Sql\SparkXml\bin\Debug C:\MobiusData\books.xml C:\MobiusData\booksModified.xml

    Displays the number of XML elements in the input XML file provided as the first argument to SparkClrXml.exe and writes the modified XML to the file specified in the second commandline argument.

    Hive Example (Sql)

    sparkclr-submit.cmd --exe HiveDataFrame.exe C:\Git\Mobius\examples\Sql\HiveDataFrame\bin\Debug <input json file path>

    Reads data from a csv file, creates a Hive table and reads data from it. The <input json file path> could look like C:\Git\Mobius\examples\Sql\HiveDataFrame\data\people.json or file:///C:/Git/Mobius/examples/Sql/HiveDataFrame/data/people.json in Windows environment. While in local Linux environment, the <input json file path> could look look like file:///path/to/people.json.

    Cassandra Example (Sql)

    • Download following jars that are needed to use Spark with Cassandra. Note that you need to get the right version of the jar files depending on the versions of Spark and Cassandra. Refer to version compatibility table for details.
    • Create keyspace, tables and insert data necessary for testing. Look at CassandraDataFrameExample code for CQL to setup test data.
    • sparkclr-submit.cmd --jars <jar files used for using Cassandra in Spark> --exe CassandraDataFrameExample.exe C:\Git\Mobius\examples\Sql\CassandraDataFrame\bin\Debug
    • Note - If you created keyspace and tables with different names than what is in the CQL in the example or do not have Cassandra in localhost, you need to pass arguments to the example sparkclr-submit.cmd --jars <jar files used for using Cassandra in Spark> --exe CassandraDataFrameExample.exe C:\Git\Mobius\examples\Sql\CassandraDataFrame\bin\Debug <host name> <keyspace name> <users table name> <filtered users table name>

    This sample reads data from a table, displays results in the console, performs filter on dataframe and writes results to another table

    JSON Example - F# (Sql)

    • Run sparkclr-submit.cmd --exe JsonDataFrame.exe C:\Git\Mobius\examples\fsharp\JsonDataFrame\bin\Debug <InputFilePath>

    A file named data.json available in the same location as JsonDataFrame.exe and it may be used when running the example

    InputFilePath should be in one of the following formats:

    • hdfs://path/to/inputfile
    • file:///C:/path/to/inputfile

    EventHubs Example (Streaming)

    • Get the following jar files
      • qpid-amqp-1-0-client-0.32.jar
      • qpid-amqp-1-0-common-0.32.jar
      • eventhubs-client-0.9.1.jar
      • spark-streaming-eventhubs_2.10-0.1.0.jar
    • Publish sample events to EventHubs to be used in this example using EventPublisher class (remember to update packages.config, connection parameters to EventHub and uncomment commented out statements to build and use EventPublisher)
    • Update EventHubs connection parameters in SparkCLREventHubsExample implementation and build
    • sparkclr-submit.cmd --master local[4] --conf spark.local.dir=d:\temp --jars C:\MobiusDependencies\spark-streaming-eventhubs_2.10-0.1.0.jar,C:\MobiusDependencies\eventhubs-client-0.9.1.jar,C:\MobiusDependencies\qpid-amqp-1-0-client-0.32.jar,C:\MobiusDependencies\qpid-amqp-1-0-common-0.32.jar --exe SparkCLREventHub.exe C:\Git\Mobius\examples\Streaming\EventHub\bin\Debug

    This example aggregates events published to EventHub in the format [timestamp],[loglevel],[logmessage] by time and log-level and prints the count of events per window.

    Note that all the dependencies listed above are available in maven that can be downloaded. spark-streaming-eventhubs*.jar is not yet updated to support Spark version beyond 1.3.1 or published to Maven. A fork of this repo is available with preview releases at https://github.com/SparkCLR/spark-eventhubs/releases and the jar file can be downloaded from this location.

    HdfsWordCount Example (Streaming)

    • Remove <checkpoint directory> (used in next step) if it already exists.
    • Run sparkclr-submit.cmd --exe SparkClrHdfsWordCount.exe C:\Git\Mobius\examples\Streaming\HdfsWordCount\bin\Debug <checkpoint directory> <input directory>

    Counts words in new text files created in the given directory using Mobius streaming.

    Kafka Example (Streaming)

    • Publish sample messages to Kafka to be used in this example using MessagePublisher class (remember to include reference to KafkaNet library (https://github.com/Microsoft/CSharpClient-for-Kafka), connection parameters to Kafka and uncomment commented out statements to build and use MessagePublisher)
    • Update Kafka parameters in SparkClrKafkaExample implementation and build
    • sparkclr-submit.cmd --master local[4] --conf spark.local.dir=d:\temp --exe SparkClrKafka.exe C:\Git\Mobius\examples\Streaming\Kafka\bin\Debug
    You can’t perform that action at this time.