Skip to content
This repository has been archived by the owner on May 12, 2021. It is now read-only.

METRON-1532: Getting started documentation improvements #1001

Closed
wants to merge 3 commits into from
Closed

METRON-1532: Getting started documentation improvements #1001

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8d1dbe6
add credentials to getting started documentation
Apr 21, 2018
f5ca33c
add instructions to make full dev more stable
Apr 23, 2018
2167106
move full dev stability advice to development README
May 14, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 13 additions & 9 deletions metron-deployment/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ This project contains tools for building, packaging, and deploying Apache Metron
How do I deploy Metron with Ambari?
-----------------------------------

This provides a Management Pack (MPack) extension for [Apache Ambari](https://ambari.apache.org/) that simplifies the provisioning, management and monitoring of Metron on clusters of any size.
This provides a Management Pack (MPack) extension for [Apache Ambari](https://ambari.apache.org/) that simplifies the provisioning, management and monitoring of Metron on clusters of any size.

This allows you to easily install Metron using a simple, guided process. This also allows you to monitor cluster health and even secure your cluster with kerberos.

Expand All @@ -47,13 +47,13 @@ To deploy Apache Metron using Ambari, follow the instructions at [packaging/amba
How do I deploy Metron on a single VM?
--------------------------------------

This will deploy Metron and all of its dependencies on a virtual machine running on your computer.
This will deploy Metron and all of its dependencies on a virtual machine running on your computer.

#### What is this good for?

* If you are new to Metron and want to explore the functionality that it offers, this is good place to start.
* If you are new to Metron and want to explore the functionality that it offers, this is good place to start.

* If you are a developer contributing to the Apache Metron project, this is also a great way to test your changes.
* If you are a developer contributing to the Apache Metron project, this is also a great way to test your changes.

#### What is this **not** good for?

Expand All @@ -69,6 +69,10 @@ Running Metron within the resource constraints of a single VM is incredibly chal

To deploy Metron in a VM running on your computer, follow the instructions at [development/centos6](development/centos6).

#### How do I address services crashing when running Metron on a single VM?

We recommend looking at Ambari and shutting down any services you may not be using. For example, we recommend turning off Metron Profiler, as this commonly causes REST services to crash when running on a single VM.


How do I build RPM packages?
----------------------------
Expand All @@ -77,7 +81,7 @@ This provides RPM packages that allow you to install Metron on an RPM-based oper

#### What is this good for?

* If you want to manually install Apache Metron on an RPM-based system like CentOS, installation can be simplified by using these packages.
* If you want to manually install Apache Metron on an RPM-based system like CentOS, installation can be simplified by using these packages.

* If you want a guided installation process using Ambari on an RPM-based system, then these RPMs are a necessary prerequisite.

Expand Down Expand Up @@ -113,25 +117,25 @@ To build the DEB packages, follow the instructions at [packaging/docker/deb-dock
How do I deploy Metron within AWS?
----------------------------------

This deploys Apache Metron on an automatically provisioned 10-node cluster running in Amazon Web Service's EC2 platform.
This deploys Apache Metron on an automatically provisioned 10-node cluster running in Amazon Web Service's EC2 platform.

This installs real sources of telemetry like Bro, Snort, and YAF, but feeds those sensors with canned pcap data.

#### What is this good for?

* If you are a Metron developer wanting to test at-scale on a multi-node cluster, then this is the right option for you.
* If you are a Metron developer wanting to test at-scale on a multi-node cluster, then this is the right option for you.

#### What is this **not** good for?

* If you want to run Metron in AWS with real data for either testing or production, then this is NOT the right option for you.

* **WARNING** This is only intended for creating an ephemeral cluster for brief periods of testing. This deployment method has the following severe limitations.
* The cluster is not secured in any way. It is up to you to manually secure it.
* The cluster is not secured in any way. It is up to you to manually secure it.
* The cluster will not survive a reboot.

#### How?

Follow the instructions available at [amazon-ec2](amazon-ec2).
Follow the instructions available at [amazon-ec2](amazon-ec2).


How do I build Metron with Docker?
Expand Down
8 changes: 4 additions & 4 deletions metron-deployment/development/centos6/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Metron on CentOS 6

This project fully automates the provisioning and deployment of Apache Metron and all necessary prerequisites on a single, virtualized host running CentOS 6.

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.
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.

Getting Started
---------------
Expand Down Expand Up @@ -52,7 +52,7 @@ Any platform that supports these tools is suitable, but the following instructio

1. Run the following command in a terminal to install all of the required tools.

```
```
brew cask install vagrant virtualbox docker
brew cask install caskroom/versions/java8
brew install maven@3.3 git
Expand Down Expand Up @@ -82,8 +82,8 @@ Any platform that supports these tools is suitable, but the following instructio

Navigate to the following resources to explore your newly minted Apache Metron environment.

* [Metron Alerts](http://node1:4201)
* [Ambari](http://node1:8080)
* [Metron Alerts](http://node1:4201) credentials: user/password
* [Ambari](http://node1:8080) credentials: admin/admin

Connecting to the host through SSH is as simple as running the following command.
```
Expand Down
6 changes: 3 additions & 3 deletions metron-deployment/development/ubuntu14/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ Any platform that supports these tools is suitable, but the following instructio

1. Run the following command in a terminal to install all of the required tools.

```
```
brew cask install vagrant virtualbox docker
brew cask install caskroom/versions/java8
brew install maven@3.3 git
Expand Down Expand Up @@ -82,8 +82,8 @@ Any platform that supports these tools is suitable, but the following instructio

Navigate to the following resources to explore your newly minted Apache Metron environment.

* [Metron Alerts](http://node1:4201)
* [Ambari](http://node1:8080)
* [Metron Alerts](http://node1:4201) credentials: user/password
* [Ambari](http://node1:8080) credentials: admin/admin

Connecting to the host through SSH is as simple as running the following command.

Expand Down