SPARK-938 - Openstack Swift object storage support

Documentation how to integrate Spark with Openstack Swift.
YanTangZhai · Jun 10, 2014 · eff538d · eff538d
1 parent b6c37ef
commit eff538d
Show file tree

Hide file tree

Showing 4 changed files with 96 additions and 68 deletions.
diff --git a/core/pom.xml b/core/pom.xml
@@ -35,7 +35,11 @@
       <groupId>org.apache.hadoop</groupId>
       <artifactId>hadoop-client</artifactId>
     </dependency>
-    <dependency>
+     <dependency>
+        <groupId>org.apache.hadoop</groupId>
+        <artifactId>hadoop-openstack</artifactId>
+     </dependency>
+     <dependency>
       <groupId>net.java.dev.jets3t</groupId>
       <artifactId>jets3t</artifactId>
     </dependency>

diff --git a/docs/openstack-integration.md b/docs/openstack-integration.md
@@ -8,76 +8,85 @@ title: Accessing Openstack Swift storage from Spark
 Spark's file interface allows it to process data in Openstack Swift using the same URI formats that are supported for Hadoop. You can specify a path in Swift as input through a URI of the form `swift://<container.service_provider>/path`. You will also need to set your Swift security credentials, through `SparkContext.hadoopConfiguration`. 
 
 #Configuring Hadoop to use Openstack Swift
-Openstack Swift driver was merged in Hadoop verion 2.3.0 ([Swift driver](https://issues.apache.org/jira/browse/HADOOP-8545))  Users that wish to use previous Hadoop versions will need to configure Swift driver manually. 
-<h2>Hadoop 2.3.0 and above.</h2>
-An Openstack Swift driver was merged into Haddop 2.3.0 . Current Hadoop driver requieres Swift to use Keystone authentication. There are additional efforts to support temp auth for Hadoop [Hadoop-10420](https://issues.apache.org/jira/browse/HADOOP-10420).
+Openstack Swift driver was merged in Hadoop verion 2.3.0 ([Swift driver](https://issues.apache.org/jira/browse/HADOOP-8545)).  Users that wish to use previous Hadoop versions will need to configure Swift driver manually. Current Swift driver requieres Swift to use Keystone authentication method. There are recent efforts to support also temp auth [Hadoop-10420](https://issues.apache.org/jira/browse/HADOOP-10420).
 To configure Hadoop to work with Swift one need to modify core-sites.xml of Hadoop and setup Swift FS.
 
-    <configuration>
-      <property>
-	  <name>fs.swift.impl</name>
-	    <value>org.apache.hadoop.fs.swift.snative.SwiftNativeFileSystem</value>
-	  </property>
-    </configuration>
+	<configuration>
+		<property>
+			<name>fs.swift.impl</name>
+			<value>org.apache.hadoop.fs.swift.snative.SwiftNativeFileSystem</value>
+		</property>
+	</configuration>
 
+#Configuring Swift 
+Proxy server of Swift should include `list_endpoints` middleware. More information available [here](https://github.com/openstack/swift/blob/master/swift/common/middleware/list_endpoints.py)
 
-<h2>Configuring Spark - stand alone cluster</h2>
-You need to configure the compute-classpath.sh and add Hadoop classpath for 
+#Configuring Spark
+To use Swift driver, Spark need to be compiled with `hadoop-openstack-2.3.0.jar` distributted with Hadoop 2.3.0. 
+For the Maven builds, Spark's main pom.xml should include 
 
-
-    CLASSPATH = <YOUR HADOOP PATH>/share/hadoop/common/lib/*
-    CLASSPATH = <YOUR HADOOP PATH>/share/hadoop/hdfs/*
-    CLASSPATH = <YOUR HADOOP PATH>/share/hadoop/tools/lib/*
-    CLASSPATH = <YOUR HADOOP PATH>/share/hadoop/hdfs/lib/*
-    CLASSPATH = <YOUR HADOOP PATH>/share/hadoop/mapreduce/*
-    CLASSPATH = <YOUR HADOOP PATH>/share/hadoop/mapreduce/lib/*
-    CLASSPATH = <YOUR HADOOP PATH>/share/hadoop/yarn/*
-    CLASSPATH = <YOUR HADOOP PATH>/share/hadoop/yarn/lib/*
-
-Additional parameters has to be provided to the Hadoop from Spark. Swift driver of Hadoop uses those parameters to perform authentication in Keystone needed to access Swift.
-List of mandatory parameters is : `fs.swift.service.<PROVIDER>.auth.url`, `fs.swift.service.<PROVIDER>.auth.endpoint.prefix`, `fs.swift.service.<PROVIDER>.tenant`, `fs.swift.service.<PROVIDER>.username`,
-`fs.swift.service.<PROVIDER>.password`, `fs.swift.service.<PROVIDER>.http.port`, `fs.swift.service.<PROVIDER>.http.port`, `fs.swift.service.<PROVIDER>.public`. 
-Create core-sites.xml and place it under /spark/conf directory. Configure core-sites.xml with general Keystone parameters, for example
-
-
-	  <property>
-	      <name>fs.swift.service.<PROVIDER>.auth.url</name>
-	      <value>http://127.0.0.1:5000/v2.0/tokens</value>
-	  </property>
-	  <property>
-	      <name>fs.swift.service.<PROVIDER>.auth.endpoint.prefix</name>
-	      <value>endpoints</value>
-	  </property>
-	      <name>fs.swift.service.<PROVIDER>.http.port</name>
-	      <value>8080</value>
-	  </property>
-	  <property>
-	      <name>fs.swift.service.<PROVIDER>.region</name>
-	      <value>RegionOne</value>
-	  </property>
-	  <property>
-	      <name>fs.swift.service.<PROVIDER>.public</name>
-	      <value>true</value>
-	  </property>
-
-We left with `fs.swift.service.<PROVIDER>.tenant`, `fs.swift.service.<PROVIDER>.username`, `fs.swift.service.<PROVIDER>.password`. The best way is to provide them to SparkContext in run time, which seems to be impossible yet.
-Another approach is to change Hadoop Swift FS driver to provide them via system environment variables. For now we provide them via core-sites.xml 
-
-	   <property>
-	      <name>fs.swift.service.<PROVIDER>.tenant</name>
-	      <value>test</value>
-	  </property>
-	  <property>
-	      <name>fs.swift.service.<PROVIDER>.username</name>
-	      <value>tester</value>
-	  </property>
-	  <property>
-	      <name>fs.swift.service.<PROVIDER>.password</name>
-	      <value>testing</value>
-	  </property>
-	  <property>
-<h3> Usage </h3>
-Assume you have a Swift container `logs` with an object `data.log`. You can use `swift://` scheme to access objects from Swift.
-
-    val sfdata = sc.textFile("swift://logs.<PROVIDER>/data.log")
+	<swift.version>2.3.0</swift.version>
+
+
+	<dependency>
+		<groupId>org.apache.hadoop</groupId>
+		<artifactId>hadoop-openstack</artifactId>
+		<version>${swift.version}</version>
+	</dependency>
+
+in addition, pom.xml of the `core` and `yarn` projects should include
+
+	<dependency>
+		<groupId>org.apache.hadoop</groupId>
+		<artifactId>hadoop-openstack</artifactId>
+	</dependency>
+
+
+Additional parameters has to be provided to the Swift driver. Swift driver will use those parameters to perform authentication in Keystone prior  accessing Swift. List of mandatory parameters is : `fs.swift.service.<PROVIDER>.auth.url`, `fs.swift.service.<PROVIDER>.auth.endpoint.prefix`, `fs.swift.service.<PROVIDER>.tenant`, `fs.swift.service.<PROVIDER>.username`,
+`fs.swift.service.<PROVIDER>.password`, `fs.swift.service.<PROVIDER>.http.port`, `fs.swift.service.<PROVIDER>.http.port`, `fs.swift.service.<PROVIDER>.public`, where `PROVIDER` is any name. `fs.swift.service.<PROVIDER>.auth.url` should point to the Keystone authentication URL.
+
+Create core-sites.xml with the mandatory parameters and place it under /spark/conf directory. For example:
+
+
+	<property>
+		<name>fs.swift.service.<PROVIDER>.auth.url</name>
+		<value>http://127.0.0.1:5000/v2.0/tokens</value>
+	</property>
+	<property>
+		<name>fs.swift.service.<PROVIDER>.auth.endpoint.prefix</name>
+		<value>endpoints</value>
+	</property>
+		<name>fs.swift.service.<PROVIDER>.http.port</name>
+		<value>8080</value>
+	</property>
+	<property>
+		<name>fs.swift.service.<PROVIDER>.region</name>
+		<value>RegionOne</value>
+	</property>
+	<property>
+		<name>fs.swift.service.<PROVIDER>.public</name>
+		<value>true</value>
+	</property>
+
+We left with `fs.swift.service.<PROVIDER>.tenant`, `fs.swift.service.<PROVIDER>.username`, `fs.swift.service.<PROVIDER>.password`. The best way to provide those parameters to SparkContext in run time, which seems to be impossible yet.
+Another approach is to adapt Swift driver to obtain those values from system environment variables. For now we provide them via core-sites.xml. 
+Assume a tenant `test` with user `tester` was defined in Keystone, then the core-sites.xml shoud include: 
+
+	<property>
+		<name>fs.swift.service.<PROVIDER>.tenant</name>
+		<value>test</value>
+	</property>
+	<property>
+		<name>fs.swift.service.<PROVIDER>.username</name>
+		<value>tester</value>
+	</property>
+	<property>
+		<name>fs.swift.service.<PROVIDER>.password</name>
+		<value>testing</value>
+	</property>
+# Usage
+Assume there exists Swift container `logs` with an object `data.log`. To access `data.log` from Spark the `swift://` scheme should be used. 
+For example:
+
+	val sfdata = sc.textFile("swift://logs.<PROVIDER>/data.log")
 
diff --git a/pom.xml b/pom.xml
@@ -132,6 +132,7 @@
     <codahale.metrics.version>3.0.0</codahale.metrics.version>
     <avro.version>1.7.6</avro.version>
     <jets3t.version>0.7.1</jets3t.version>
+    <swift.version>2.3.0</swift.version>
 
     <PermGen>64m</PermGen>
     <MaxPermGen>512m</MaxPermGen>
@@ -584,6 +585,11 @@
           </exclusion>
         </exclusions>
       </dependency>
+      <dependency>
+        <groupId>org.apache.hadoop</groupId>
+        <artifactId>hadoop-openstack</artifactId>
+        <version>${swift.version}</version>
+      </dependency>
       <dependency>
         <groupId>org.apache.hadoop</groupId>
         <artifactId>hadoop-yarn-api</artifactId>
@@ -1024,6 +1030,11 @@
           <artifactId>hadoop-client</artifactId>
           <scope>provided</scope>
         </dependency>
+   <dependency>
+      <groupId>org.apache.hadoop</groupId>
+      <artifactId>hadoop-openstack</artifactId>
+      <scope>provided</scope>
+    </dependency>
         <dependency>
           <groupId>org.apache.hadoop</groupId>
           <artifactId>hadoop-yarn-api</artifactId>

diff --git a/yarn/pom.xml b/yarn/pom.xml
@@ -55,6 +55,10 @@
       <groupId>org.apache.hadoop</groupId>
       <artifactId>hadoop-client</artifactId>
     </dependency>
+     <dependency>
+        <groupId>org.apache.hadoop</groupId>
+        <artifactId>hadoop-openstack</artifactId>
+     </dependency>
     <dependency>
       <groupId>org.scalatest</groupId>
       <artifactId>scalatest_${scala.binary.version}</artifactId>