diff --git a/docs/openstack-integration.md b/docs/openstack-integration.md index 07f22b3f12b13..a38e2b44e97de 100644 --- a/docs/openstack-integration.md +++ b/docs/openstack-integration.md @@ -1,15 +1,22 @@ ---- -layout: global +yout: global title: Accessing Openstack Swift storage from Spark --- # 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:///path`. You will also need to set your Swift security credentials, through `SparkContext.hadoopConfiguration`. +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:///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. 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. +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. @@ -19,11 +26,12 @@ To configure Hadoop to work with Swift one need to modify core-sites.xml of Hado #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) +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) #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 +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 2.3.0 @@ -42,10 +50,18 @@ in addition, pom.xml of the `core` and `yarn` projects should include -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..auth.url`, `fs.swift.service..auth.endpoint.prefix`, `fs.swift.service..tenant`, `fs.swift.service..username`, -`fs.swift.service..password`, `fs.swift.service..http.port`, `fs.swift.service..http.port`, `fs.swift.service..public`, where `PROVIDER` is any name. `fs.swift.service..auth.url` should point to the Keystone authentication URL. +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..auth.url`, +`fs.swift.service..auth.endpoint.prefix`, `fs.swift.service..tenant`, +`fs.swift.service..username`, +`fs.swift.service..password`, `fs.swift.service..http.port`, +`fs.swift.service..http.port`, `fs.swift.service..public`, where +`PROVIDER` is any name. `fs.swift.service..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: +Create core-sites.xml with the mandatory parameters and place it under /spark/conf +directory. For example: @@ -68,9 +84,13 @@ Create core-sites.xml with the mandatory parameters and place it under /spark/co true -We left with `fs.swift.service..tenant`, `fs.swift.service..username`, `fs.swift.service..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: +We left with `fs.swift.service..tenant`, `fs.swift.service..username`, +`fs.swift.service..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: fs.swift.service..tenant @@ -85,8 +105,8 @@ Assume a tenant `test` with user `tester` was defined in Keystone, then the core testing # 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: +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./data.log")