Driven Administrator Guide
version 1.2-eap-11Installing and Configuring the Driven Plugin
Overview
To enable Driven, you must install the Driven Plugin in your Hadoop environment so that it can collect telemetry data and send it to the Driven Server. The plugin for the licensed, self-hosted version of Driven is different from the Driven Beta plugin in that it does not automatically send data to cascading.io, so it must be configured to know where to send the data.
For information about Driven Plugin setup in environments that use the cascading.io service as part of the beta program, see Getting Started with Driven for Driven Beta.
Prerequisites
-
The Driven Server must be installed and configured before you can set up the Driven Plugin.
-
Your data applications must have network access to your installation of the Driven Server.
Installing the Plugin
The following steps document how to obtain and configure the Driven Plugin. See the documentation for Amazon Elastic MapReduce or Maven and Gradle if you use those environments. If you plan to package the Driven Plugin directly in your application, you can add the Maven spec to your project file as a dependency. Adding the plugin to your Maven repositories is particularly useful if you plan to use Driven from your IDE as you develop a Cascading application.
-
On UNIX, Linux, and Mac: Run the following command:
$ wget -i http://eap.concurrentinc.com/driven/1.2/driven-plugin/latest-jar.txt
-
On Windows: Download the latest JAR file: driven-plugin-1.2-eap-11.jar
The JAR file includes all dependencies.
Configuring the Plugin
Step 1: Make the plugin accessible to your application
Add the path of the plugin to the cascading-service.properties file in your Hadoop configuration directory (${HADOOP_CONF}).
If you do not have the properties file, create it in ${HADOOP_CONF}. For Hadoop 1.x, the configuration directory may be ${HADOOP_HOME}/conf.
For Hadoop 2.x, the configuration directory is ${HADOOP_HOME}/etc/hadoop.
$ echo cascading.management.service.jar=${PATH}driven-plugin-1.2-eap-11.jar >> ${HADOOP_CONF}/cascading-service.properties
Alternatively, set the path to the plugin by adding it to the HADOOP_CLASSPATH environment variable:
$ export HADOOP_CLASSPATH=$HADOOP_CLASSPATH:${PATH}/driven-plugin-1.2-eap-11.jar
Step 2: Set the Driven Server host URL
Specify the URL for the Driven Server in the Cascading service properties file in the following command format:
$ echo cascading.management.document.service.hosts=${DRIVEN_SERVER_URL} >> ${HADOOP_CONF}/cascading-service.properties
Alternatively, set the host in an environment variable. Example:
$ export DRIVEN_SERVER_HOSTS=${DRIVEN_SERVER_URL}
Step 3 (Optional): Using a Driven API Key
Each Driven Team has a unique API key. By associating an application with an API key, you make the application searchable by other members of your team.
-
Log in to the Driven Server to open the Driven web interface.
-
Hover over your user name in the upper-right corner of the window.
-
Click My Teams.
-
Record an API key for the team of your choice.
-
Configure the Driven Plugin with the Driven API key by one of the following methods:
Store the API key parameter in the cascading-service properties file. Example:
$ echo cascading.management.document.service.apikey=${API_KEY} >> ${HADOOP_CONF}/cascading-service.properties
Alternatively, you can set the API key in an environment variable. Example:
$ export DRIVEN_API_KEY=${API_KEY}
Additional Configuration Settings
The Driven Plugin has additional configuration options that primarily are for administrative tasks. For more information, see Driven Plugin Configuration Parameters.