Getting Started guide

[hyandell]

A getting started guide would be very useful.

Currently I'm at "./gradlew build" -> CASS_PORT not set. Probably fairly early in the install game and paused while I wait on time to get a Cassandra and Elastic Search instance setup.

Acknowledged that the Docker instance would be one way to get that done :)

[kakawait]

You should specify your Cassandra host/port and ES host port like following

Here my sample using Cassandra and ES official docker container on localhost

./gradlew -PCASS_HOST=localhost -PCASS_PORT=9042 -PES_HOST=localhost -PES_PORT=9200 -Pgithub_oauth=XXXXXXX build

But you should change XXXXXXX by our generated key (using GitHub Personal Settings -> Personal access tokens)

---

Until #6 manual installation is necessary, is not so hard using Cassandra/ES container. Don't forget to generate DDL before starting https://github.com/Netflix/osstracker/tree/master/osstracker-ddl

Create Cassandra and ES container

docker run --name cassandra -d -p 9042:9042 cassandra
docker run --name elasticsearch -d -p 9200:9200 -p 9300:9300 elasticsearch

Connect to Cassandra from cqlsh

docker run -it --link cassandra:cassandra --rm cassandra cqlsh cassandra

Then run command on https://github.com/Netflix/osstracker/blob/master/osstracker-ddl/osstracker.cql, in my use case I replace

CREATE KEYSPACE osstracker WITH replication = {
  'class': 'NetworkTopologyStrategy',
  'us-east': '3'
};

by

CREATE KEYSPACE osstracker WITH REPLICATION = { 'class' : 'SimpleStrategy', 'replication_factor' : 3 };

Create ES index using instruction here https://github.com/Netflix/osstracker/blob/master/osstracker-ddl/elasticsearch.txt

Everything works on my side, except Kibana

[javiereguiluz]

@kakawait thanks for your detailed comment, but sadly, I can't make it work. In any case, I agree with @hyandell: this project is missing some installation guide. Thanks!

[kakawait]

@javiereguiluz what's your new issue? (PS: I'm not part of Netflix)

[DuaneOBrien]

+1 for a Getting Started and Installation guide.

[aspyker]

Thanks for pulling this together folks. I planned to write the getting started guide, but didn't get there yet. @kakawait, you got it spot on.

[kakawait]

I will try to create Gist or Asciinema from my previous successful installation asap. Feel free to use it after to write a Getting started document. But I really think best solution is to provide full stack container (see #6) :)

[aspyker]

@kakawait Can you stick to markdown if possible. I'd like for you to submit any documentation you created as a PR against the documentation branch I just created. I'd like to avoid using a Wiki. An Asciicema would be great as well.

Place we can start to add to:
https://github.com/Netflix/osstracker/blob/documentation/osstracker-docs/README.md

[kakawait]

@aspyker Done feel free to polish it.
@javiereguiluz documentation inside PR is based on new fresh installation! So tests (Mac + docker-machine) and works perfectly. But be careful I teak some things (build.gradle, DDL) so does not work with master branch

[javiereguiluz]

@kakawait thanks for the guide. I'll try to install this application again following your guide. Thanks!

[kakawait]

thanks to

CONTAINER ID        IMAGE                       COMMAND                  CREATED             STATUS              PORTS                                                       NAMES
acdd8ccd6c9a        kibana                      "/docker-entrypoint.s"   18 minutes ago      Up 18 minutes       0.0.0.0:5601->5601/tcp                                      osstracker-kibana
a791d7d9c036        osstracker-console          "npm start"              22 minutes ago      Up 22 minutes       0.0.0.0:3000->3000/tcp                                      osstracker-console
b69906540c43        elasticsearch               "/docker-entrypoint.s"   About an hour ago   Up About an hour    0.0.0.0:9200->9200/tcp, 9300/tcp                            osstracker-elasticsearch
2d18d1e92ff8        cassandra                   "/docker-entrypoint.s"   About an hour ago   Up About an hour    7000-7001/tcp, 7199/tcp, 9160/tcp, 0.0.0.0:9042->9042/tcp   osstracker-cassandra