Home

Awesome

##Brisket

###About

The primary purpose of this application is to scan, store, and prepare Cloud Server Provider (CSP) guest/instance/host data for further statistical and trend analysis.

Description

See the position paper for a sneak peak into what this project was created for.

Scanner Placement

Scanners are hosted in several North American, European, and Asia/Pacific countries (blue). The main analysis server (a.k.a. CloudCooker) is located in the US (black). <img src="https://raw.github.com/andrewsmhay/brisket/master/misc/sensor.png"> ###Requirements Each script has different requirements but you should be able to run <code>bundle install</code> to install the gems listed in the Gemfile.

###Usage ####trim.rb <i>Cooking Note: You must trim the brisket before adding the rub to it.</i>

Used to prepare the scan configuration file with the appropriate set of ports for the scan.

<pre><code> $ sudo ./trim.rb <i>ports</i> masscan </code></pre>

Where <i>ports</i> is one of the following options:

e.g.

<pre><code> <b>$ sudo ./trim.rb remote masscan</b> </code></pre>

####rub.rb <i>Cooking Note: Once trimmed, the brisket must be seasoned.</i>

Used to call the scanner and export the results in the appropriate results date directory and file.

<pre><code> $ sudo ./rub.rb <i>region</i> <i>scanner</i> </code></pre>

Where <i>region</i> is one of the following options:

and where <i>scanner</i> is one of the following options:

e.g.

<pre><code> <b>$ sudo ./rub.rb apac masscan</b> </code></pre>

####mop.rb <i>Keep it moist if you want to win!</i>

Script to convert the various results formats into a common .csv file format.

<pre><code> $ sudo ./mop.rb <i>scanner</i> <i>date</i> </code></pre>

Where <i>scanner</i> is one of the following options:

and where <i>date</i> is the date directory that contains the scanner results files to convert in <i>M/D/YYYY</i> format.

e.g.

<pre><code> <b>$ sudo ./mop.rb masscan 2/3/2014</b> </code></pre>

Note - For <i>March 2, 2014</i> the directory structure would be 2014/3/2 and should be entered as 2/3/2014.

####injector.rb <i>Add marinade to the brisket to keep it moist on the inside...</i>

Script to archive, transfer, and cleanup scan data. All scanner results are archived using <code>tar</code> and <code>bzip2</code>. The daily archive file is transferred to the CloudCooker for futher processing. Local scan results and the daily archive are deleted upon transmission to the CloudCooker.

<pre><code> <b>$ sudo ./injector.rb</b> </code></pre>

####fixins.rb <i>Cooking Note: It just ain't a BBQ without some proper fixins to make the meal complete.</i>

This script downloads and unpacks the most recent GeoLiteCity database file for use in converting IP addresses to latitude and longitude data.

<pre><code> <b>$ sudo ./fixins.rb city</b> </code></pre>

###Contact

To provide any feedback or ask any questions please reach out to Andrew Hay on Twitter at <a href="http://twitter.com/andrewsmhay" target="new">@andrewsmhay</a>.