Repository: metron Updated Branches: refs/heads/master 7dad389ee -> 7be65162a
METRON-1532 Getting started documentation improvements (sardell via nickwallen) closes apache/metron#1001 Project: http://git-wip-us.apache.org/repos/asf/metron/repo Commit: http://git-wip-us.apache.org/repos/asf/metron/commit/7be65162 Tree: http://git-wip-us.apache.org/repos/asf/metron/tree/7be65162 Diff: http://git-wip-us.apache.org/repos/asf/metron/diff/7be65162 Branch: refs/heads/master Commit: 7be65162a7e80111a7fed9d95a6fad3b8e93b7d9 Parents: 7dad389 Author: sardell <[email protected]> Authored: Fri May 25 10:44:31 2018 -0400 Committer: nickallen <[email protected]> Committed: Fri May 25 10:44:31 2018 -0400 ---------------------------------------------------------------------- metron-deployment/README.md | 22 ++++++++++++-------- metron-deployment/development/centos6/README.md | 8 +++---- .../development/ubuntu14/README.md | 6 +++--- 3 files changed, 20 insertions(+), 16 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/metron/blob/7be65162/metron-deployment/README.md ---------------------------------------------------------------------- diff --git a/metron-deployment/README.md b/metron-deployment/README.md index 805aaf0..b78a3e2 100644 --- a/metron-deployment/README.md +++ b/metron-deployment/README.md @@ -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. @@ -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? @@ -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? ---------------------------- @@ -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. @@ -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? http://git-wip-us.apache.org/repos/asf/metron/blob/7be65162/metron-deployment/development/centos6/README.md ---------------------------------------------------------------------- diff --git a/metron-deployment/development/centos6/README.md b/metron-deployment/development/centos6/README.md index ec85be3..0e38d5a 100644 --- a/metron-deployment/development/centos6/README.md +++ b/metron-deployment/development/centos6/README.md @@ -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 --------------- @@ -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 [email protected] git @@ -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. ``` http://git-wip-us.apache.org/repos/asf/metron/blob/7be65162/metron-deployment/development/ubuntu14/README.md ---------------------------------------------------------------------- diff --git a/metron-deployment/development/ubuntu14/README.md b/metron-deployment/development/ubuntu14/README.md index fbbd2ad..a3cb89b 100644 --- a/metron-deployment/development/ubuntu14/README.md +++ b/metron-deployment/development/ubuntu14/README.md @@ -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 [email protected] git @@ -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.
