Skip to content

Latest commit

 

History

History
179 lines (95 loc) · 8.6 KB

README.md

File metadata and controls

179 lines (95 loc) · 8.6 KB
Raw

red-pnda

Red PNDA logo

This framework provisions a minimal set of the PNDA (pnda.io) components to enable developers writing apps targeted at the full PNDA stack, to experiment with the PNDA components in a smaller, lightweight environment. Data exploration and app prototyping is supported using Jupyter and Apache Spark.

Note:

  • Packages and application support isn't available on red-pnda. The respective tabs will not work on the PNDA console and will throw an error message.

  • This framework is not implemented with either scalability nor HA in mind and hence is unsuited for running production workloads. If this is a requirement, then one of the core PNDA flavors will be required - see PNDA Guide.

The Red PNDA framework is intended as a platform for experimentation and is NOT formally supported at this point in time. Any issues encountered with the system can be reported to the standard PNDA support forums for informational purposes only.

Acknowledgement

This work has been inspired by an initial concept created by Maros Marsalek (https://github.com/marosmars) and Nick Hall (https://github.com/cloudwiser)

Prerequisites

Tested with Ubuntu 14.04.5 distro.

VirtualBox minimum version : 5.1.14

VMWare Fusion: 8.5.x

Minimum amount of RAM / VCPU / Storage: 4GB / 2 VCPUs / 8GB

Running the OVA

The latest OVA image can be downloaded from here

If you are installing the OVA file on Virtualbox, please refer to Installing on VirtualBox Guide.

If you are installing the OVA file on VMware Fusion, please refer to Installing on Fusion Guide.

Please note that we have yet to test the OVA on other virtualized environments e.g. deploying via vSphere on VMWare ESXi. Successful deployment in such environments are likely to be dependent on specific hardware compatiility as well as needing manual network interface mapping.

MD5 checksum

The md5 hash of the latest Red PNDA .OVA file can be found at md5_checksum.md

Please check that the md5 checksum is the same. If it doesn't match, it usually means the download was corrupted and you might have to re-download the file.

On Mac, to find out the md5 checksum, open a terminal window and enter the following command:

md5 <path-to-ova-file>

On Linux, to find out the md5 checksum, open a terminal window and enter the following command:

md5sum <path-to-ova-file>

Please note that Windows does not have a native md5 checksum application. Please use a third-party application such as HashCheck.

VM SSH access

If you are using Mac or Linux OS, you should be able to connect to the Red-PNDA VM using ssh from your host machine to the host-only/bridged adapter IP address of the VM.

If you are using Windows, consider using PuTTY to connect via ssh to the host-only/bridged adapter IP address of the Red-PNDA VM.

Red-PNDA components

Red-PNDA makes use the following open source components:

Data Ingestion

For instructions on how to use logstash to ingest data, refer to this guide

For detailed instructions on different data ingress methods, refer to this guide

Kafka

How to connect to red-pnda kafka instance?

To connect to the red-pnda kafka instance, you can connect to the broker on <ip>:9092.

Are there any default topics which I can use?

By default, there are two kafka topics created for easy usage.

  1. raw.log.localtest
  2. avro.log.localtest

The raw.log.localtest topic is a generic topic; you could use this topic to ingest any type of data.

The avro.log.localtest topic can be used to ingest PNDA avro encoded data.

Note that if you use the raw.log.localtest topic, data is written to the disk of the VM.

By default data is stored in the /data directory of the VM's file system using a system-timestamp directory hierarchy

For example, if you streamed data on 20th June 2017 at 5PM, your data will be stored in...

/data/year=2017/month=6/day=20/hour=17/dump.json

Sample Kafka Producer

We have also provided a sample Kafka producer in python. This will send one json event to the raw.log.logtest topic per execution, so feel free to play around with it.

cd /opt/pnda
python producer.py

Depending on what time you send the data, it will be stored in

/data/year=yyyy/month=mm/day=dd/hour=hh/dump.json

Where yyyy,mm,dd and hh can be retreived by using the system date command

date

Jupyter Notebooks

The Jupyter Notebook is a web application that allows you to create and share documents that contain live code, equations, visualizations and explanatory text. In Red PNDA, it supports exploration and presentation of data from the local file system.

The default password for the Jupyter Notebook is pnda

Please refer to our Jupyter Guide for steps on how to use Jupyter

For those who are new to PNDA, there’s a network-related dataset (BGP updates from the Internet) and an accompanying tutorial Juypter notebook named Introduction to Big Data Analytics.ipynb, to help you get started.

Also, there's a sample tutorial named tutorial.ipynb provided to do some basic analysis with data dumped to disk via Kafka through Spark DataFrames.

If you are interested in data mining or anomaly detection, take a look at the red-pnda-anom-detect.ipynb where we work with telemetry data and try and detect unintentional traffic loss in the network.

Grafana Server

Default login credentials for Grafana is pnda/pndapnda

Local Documentation

A copy of this documentation is also available in the Red PNDA OVA at /home/pnda/red-pnda-develop.

Shutdown

Suspending the VM is not supported. Please reboot or do a clean shutdown of the VM.

To shutdown the VM in VBox, right-click on the VM and click on Close -> Power Off to do a graceful shutdown.

In Fusion, Click on Virtual Machine tab on the main menu and click on Shutdown

General Troubleshooting

Please refer to our Troubleshooting guide for tips if you encounter any problems.

Roll your own Red PNDA

If you are interested in creating your own Red PNDA, either on your local machine or in a VM without installing the .OVA file, please refer to this guide for further details.

Further Reading

For further deep dive into the various components, use this as a entry point.