Getting Started

We assume that you have working HBase and elasticsearch clusters.

• Clone the code from github

    git clone [email protected]:flipkart-incubator/foxtrot.git

• Build and using maven3

    mvn clean install

Note: This takes a long time to build due to large number of test-cases. To skip tests (not-recommended) add the "-DskipTests" flag to the above command.

• Edit configuration file to fit your needs. We assume you have created a config called local.yml in config/ directory.

• Create the table-meta index

    curl -XPUT 'http://localhost:9200/table-meta'

• Put proper mapping, so that ES does not store any data and timestamps are properly detected

    scripts/local_es_setup.sh localhost

• Start the service

    java -Dfile.encoding=utf-8 -jar foxtrot-server/target/foxtrot-server-0.1.jar server config/local.yml

• Create a table

    curl -H 'Content-type: application/json' -XPOST http://localhost:18000/foxtrot/v1/tables -d '{ "name" : "testapp",  "ttl" : 7 }'

• To push events, use the event ingestion APIs. See the Event Ingestion page for API details.

• See Using the data in Foxtrot to understand how to access your data.