| Quick Development Platform |
| ========================== |
| |
| This project fully automates the provisioning and deployment of Apache Metron and all necessary prerequisites on a single, virtualized host running on Virtualbox. |
| |
| This image is designed for quick deployment of a single node Metron cluster running on Virtualbox. This platform is ideal for use by Metron developers. It uses a base image that has been pre-loaded with Ambari and HDP. |
| |
| Metron is composed of many components and installing all of these on a single host, especially a virtualized one, will greatly stress the resources of the host. The host will require at least 8 GB of RAM and a fair amount of patience. It is highly recommended that you shut down all unnecessary services. To that end the vagrant file configuration defaults to disabling solr and yaf. |
| |
| Getting Started |
| --------------- |
| |
| ### Prerequisites |
| |
| As with the Full Development Platform (`metron-deployment/vagrant/full-dev-platform`), the computer used to deploy Apache Metron will need the following components installed. |
| |
| - [Ansible](https://github.com/ansible/ansible) (2.0.0.2 or 2.2.2.0) |
| - [Docker](https://www.docker.com/community-edition) |
| - [Vagrant](https://www.vagrantup.com) 1.8.1 |
| - [Vagrant Hostmanager Plugin](https://github.com/devopsgroup-io/vagrant-hostmanager) `vagrant plugin install vagrant-hostmanager` |
| - [Virtualbox](https://virtualbox.org) 5.0.16 |
| - Python 2.7.11 |
| - Maven 3.3.9 |
| |
| #### macOS |
| |
| Any platform that supports these tools is suitable, but the following instructions cover installation on macOS. The easiest means of installing these tools on a Mac is to use the excellent [Homebrew](http://brew.sh/) project. |
| |
| 1. Install Homebrew by following the instructions at [Homebrew](http://brew.sh/). |
| |
| 1. Run the following command in a terminal to install all of the required tools. |
| |
| ``` |
| brew cask install vagrant virtualbox java docker |
| brew install maven git |
| ``` |
| |
| 1. Install Ansible by following the instructions [here](http://docs.ansible.com/ansible/intro_installation.html#latest-releases-via-pip). |
| |
| ### Deploy Metron |
| |
| 1. Ensure that the Docker service is running. |
| |
| 1. Deploy Metron |
| |
| ``` |
| cd metron-deployment/vagrant/quick-dev-platform |
| vagrant up |
| ``` |
| |
| Should the process fail before completing the deployment, the following command will continue the deployment process without re-instantiating the host. |
| |
| ``` |
| vagrant provision |
| ``` |
| |
| ### Explore Metron |
| |
| Navigate to the following resources to explore your newly minted Apache Metron environment. |
| |
| - [Ambari](http://node1:8080) |
| - [Metron](http://node1:5000) |
| - [Services](http://node1:2812) |
| |
| ### Working with Metron |
| |
| As you build out new capabilities for Metron, you will need to re-deploy the Storm topologies. To do so, first HALT the running Storm topologies and then run the following command. |
| |
| ``` |
| ./run_enrichment_role.sh |
| ``` |
| |
| Connecting to the host through SSH is as simple as running the following command. |
| |
| ``` |
| vagrant ssh |
| ``` |
