Getting Started

1. Quick Start
            1.1. Install Runtime Dependencies
            1.2. Download Source Code
            1.3. Start the Server
            1.4. Run the Example Script
            1.5. Explore the Example Script
2. Running Lipstick on your Hadoop cluster
            2.1. Installation Requirements
            2.2. Build
            2.3. Deploy on Tomcat
            2.4. Properties file
            2.5. Run

---

1. Quick Start

1.1. Install Runtime Dependencies

Graphviz – install via http://www.graphviz.org/Download..php. Ensure Graphviz is on your PATH.

1.2. Download Source Code

git clone https://github.com/Netflix/Lipstick.git

1.3. Start the Server

From the cloned directory (lipstick by default), run “./gradlew debug -PwithHadoop”. (This may take several minutes depending on connection speed and already present build dependencies.)
You should see something similar to the following as the last lines of output:

| Running Grails application
| Server running. Browse to http://localhost:8080/lipstick
> Building > :lipstick-server:debug

1.4. Run the Example Script

From the “quickstart” sub-directory, run “./example1”.
You should see something similar to the following within the last lines of output:

Navigate to http://localhost:8080/lipstick#job/{jobId} to view progress.
...
(orange,ORANGE)

1.5. Explore the Example Script

Enter the link http://localhost:8080/lipstick#job/{jobId} from the previous step into your browser (replacing {jobId} with the appropriate id) or refreshing the main Lipstick page and clicking on the new job. Here you can get a graphical representation of the example script. Since this job was run in local mode, the information that you get doesn’t include job statistics.

2. Running Lipstick on your Hadoop cluster

Before proceeding please see the Quick Start section to clone the project and build.

2.1. Installation Requirements

- Create a MySQL database and set the credentials.

2.2. Build

Build the war and jar files. Navigate to the directory where Lipstick was cloned from github (lipstick by default).

$ cd lipstick
$ ./gradlew

This will create the lipstick-server-[version].war and the lipstick-console-[version].jar and place them in the top level build directory.

2.3. Deploy on Tomcat

Deploy the war file on Tomcat. For instructions on how to do this, please see: http://grails.org/Deployment

2.4. Properties file

Create a properties file for connecting to your MySQL database called “/etc/lipstick.properties”. Below is a sample file to connect to a local MySQL database with lipstick user and lipstick db

dataSource.driverClassName=com.mysql.jdbc.Driver
dataSource.username=lipstick
dataSource.password=lipstick
dataSource.dbCreate=upgrade
dataSource.url=jdbc:mysql://localhost/lipstick?useUnicode=true&characterEncoding=utf8&autoReconnect=true

2.5. Run

We are not currently providing a wrapper for running Lipstick on your cluster. The simplest way is to run the command as follows:

hadoop jar lipstick-console-[version].jar -Dlipstick.server.url=http://$LIPSTICK_URL