http://git-wip-us.apache.org/repos/asf/metron/blob/ae1d3eb9/site/current-book/metron-deployment/development/index.html ---------------------------------------------------------------------- diff --git a/site/current-book/metron-deployment/development/index.html b/site/current-book/metron-deployment/development/index.html new file mode 100644 index 0000000..ea99fdf --- /dev/null +++ b/site/current-book/metron-deployment/development/index.html @@ -0,0 +1,137 @@ +<!DOCTYPE html> +<!-- + | Generated by Apache Maven Doxia Site Renderer 1.8 from src/site/markdown/metron-deployment/development/index.md at 2018-06-07 + | Rendered using Apache Maven Fluido Skin 1.7 +--> +<html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en"> + <head> + <meta charset="UTF-8" /> + <meta name="viewport" content="width=device-width, initial-scale=1.0" /> + <meta name="Date-Revision-yyyymmdd" content="20180607" /> + <meta http-equiv="Content-Language" content="en" /> + <title>Metron РMetron Development Environments</title> + <link rel="stylesheet" href="../../css/apache-maven-fluido-1.7.min.css" /> + <link rel="stylesheet" href="../../css/site.css" /> + <link rel="stylesheet" href="../../css/print.css" media="print" /> + <script type="text/javascript" src="../../js/apache-maven-fluido-1.7.min.js"></script> +<script type="text/javascript"> + $( document ).ready( function() { $( '.carousel' ).carousel( { interval: 3500 } ) } ); + </script> + </head> + <body class="topBarDisabled"> + <div class="container-fluid"> + <div id="banner"> + <div class="pull-left"><a href="http://metron.apache.org/"; id="bannerLeft"><img src="../../images/metron-logo.png" alt="Apache Metron" width="148px" height="48px"/></a></div> + <div class="pull-right"></div> + <div class="clear"><hr/></div> + </div> + + <div id="breadcrumbs"> + <ul class="breadcrumb"> + <li class=""><a href="http://www.apache.org"; class="externalLink" title="Apache">Apache</a><span class="divider">/</span></li> + <li class=""><a href="http://metron.apache.org/"; class="externalLink" title="Metron">Metron</a><span class="divider">/</span></li> + <li class=""><a href="../../index.html" title="Documentation">Documentation</a><span class="divider">/</span></li> + <li class="active ">Metron Development Environments</li> + <li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2018-06-07</li> + <li id="projectVersion" class="pull-right">Version: 0.5.0</li> + </ul> + </div> + <div class="row-fluid"> + <div id="leftColumn" class="span2"> + <div class="well sidebar-nav"> + <ul class="nav nav-list"> + <li class="nav-header">User Documentation</li> + <li><a href="../../index.html" title="Metron"><span class="icon-chevron-down"></span>Metron</a> + <ul class="nav nav-list"> + <li><a href="../../CONTRIBUTING.html" title="CONTRIBUTING"><span class="none"></span>CONTRIBUTING</a></li> + <li><a href="../../Upgrading.html" title="Upgrading"><span class="none"></span>Upgrading</a></li> + <li><a href="../../metron-analytics/index.html" title="Analytics"><span class="icon-chevron-right"></span>Analytics</a></li> + <li><a href="../../metron-contrib/metron-docker/index.html" title="Docker"><span class="none"></span>Docker</a></li> + <li><a href="../../metron-contrib/metron-performance/index.html" title="Performance"><span class="none"></span>Performance</a></li> + <li><a href="../../metron-deployment/index.html" title="Deployment"><span class="icon-chevron-down"></span>Deployment</a> + <ul class="nav nav-list"> + <li><a href="../../metron-deployment/Kerberos-ambari-setup.html" title="Kerberos-ambari-setup"><span class="none"></span>Kerberos-ambari-setup</a></li> + <li><a href="../../metron-deployment/Kerberos-manual-setup.html" title="Kerberos-manual-setup"><span class="none"></span>Kerberos-manual-setup</a></li> + <li><a href="../../metron-deployment/amazon-ec2/index.html" title="Amazon-ec2"><span class="none"></span>Amazon-ec2</a></li> + <li><a href="../../metron-deployment/ansible/index.html" title="Ansible"><span class="icon-chevron-right"></span>Ansible</a></li> + <li class="active"><a href="#"><span class="icon-chevron-down"></span>Development</a> + <ul class="nav nav-list"> + <li><a href="../../metron-deployment/development/centos6/index.html" title="Centos6"><span class="none"></span>Centos6</a></li> + <li><a href="../../metron-deployment/development/fastcapa/index.html" title="Fastcapa"><span class="none"></span>Fastcapa</a></li> + <li><a href="../../metron-deployment/development/ubuntu14/index.html" title="Ubuntu14"><span class="none"></span>Ubuntu14</a></li> + </ul> +</li> + <li><a href="../../metron-deployment/other-examples/index.html" title="Other-examples"><span class="icon-chevron-right"></span>Other-examples</a></li> + <li><a href="../../metron-deployment/packaging/ambari/index.html" title="Ambari"><span class="icon-chevron-right"></span>Ambari</a></li> + <li><a href="../../metron-deployment/packaging/docker/ansible-docker/index.html" title="Ansible-docker"><span class="none"></span>Ansible-docker</a></li> + <li><a href="../../metron-deployment/packaging/docker/deb-docker/index.html" title="Deb-docker"><span class="none"></span>Deb-docker</a></li> + <li><a href="../../metron-deployment/packaging/docker/rpm-docker/index.html" title="Rpm-docker"><span class="none"></span>Rpm-docker</a></li> + <li><a href="../../metron-deployment/packaging/packer-build/index.html" title="Packer-build"><span class="none"></span>Packer-build</a></li> + </ul> +</li> + <li><a href="../../metron-interface/metron-alerts/index.html" title="Alerts"><span class="none"></span>Alerts</a></li> + <li><a href="../../metron-interface/metron-config/index.html" title="Config"><span class="none"></span>Config</a></li> + <li><a href="../../metron-interface/metron-rest/index.html" title="Rest"><span class="none"></span>Rest</a></li> + <li><a href="../../metron-platform/index.html" title="Platform"><span class="icon-chevron-right"></span>Platform</a></li> + <li><a href="../../metron-sensors/index.html" title="Sensors"><span class="icon-chevron-right"></span>Sensors</a></li> + <li><a href="../../metron-stellar/stellar-3rd-party-example/index.html" title="Stellar-3rd-party-example"><span class="none"></span>Stellar-3rd-party-example</a></li> + <li><a href="../../metron-stellar/stellar-common/index.html" title="Stellar-common"><span class="icon-chevron-right"></span>Stellar-common</a></li> + <li><a href="../../metron-stellar/stellar-zeppelin/index.html" title="Stellar-zeppelin"><span class="none"></span>Stellar-zeppelin</a></li> + <li><a href="../../use-cases/index.html" title="Use-cases"><span class="icon-chevron-right"></span>Use-cases</a></li> + </ul> +</li> +</ul> + <hr /> + <div id="poweredBy"> + <div class="clear"></div> + <div class="clear"></div> + <div class="clear"></div> + <div class="clear"></div> +<a href="http://maven.apache.org/"; title="Built by Maven" class="poweredBy"><img class="builtBy" alt="Built by Maven" src="../../images/logos/maven-feather.png" /></a> + </div> + </div> + </div> + <div id="bodyColumn" class="span10" > +<!-- +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you under the Apache License, Version 2.0 (the +"License"); you may not use this file except in compliance +with the License. You may obtain a copy of the License at + +http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. +--> +<h1>Metron Development Environments</h1> +<p><a name="Metron_Development_Environments"></a></p> +<p>This directory contains environments useful for Metron developers. These environments are not intended for proof-of-concept, testing, or production use. These are extremely resource constrained and cannot support anything beyond the most basic work loads.</p> +<ul> + +<li>Metron running on CentOS 6</li> +<li>Metron running on Ubuntu 14</li> +<li>Fastcapa</li> +</ul> +<div class="section"> +<h2><a name="Vagrant_Cachier_recommendations"></a>Vagrant Cachier recommendations</h2> +<p>The development boxes are designed to be spun up and destroyed on a regular basis as part of the development cycle. In order to avoid the overhead of re-downloading many of the heavy platform dependencies, Vagrant can use the <a class="externalLink" href="http://fgrehm.viewdocs.io/vagrant-cachier/";>vagrant-cachier</a> plugin to store package caches between builds. If the plugin has been installed to your vagrant it will be used, and packages will be cached in ~/.vagrant/cache.</p></div> + </div> + </div> + </div> + <hr/> + <footer> + <div class="container-fluid"> + <div class="row-fluid"> +̩ 2015-2016 The Apache Software Foundation. Apache Metron, Metron, Apache, the Apache feather logo, + and the Apache Metron project logo are trademarks of The Apache Software Foundation. + </div> + </div> + </footer> + </body> +</html>
http://git-wip-us.apache.org/repos/asf/metron/blob/ae1d3eb9/site/current-book/metron-deployment/development/ubuntu14/index.html ---------------------------------------------------------------------- diff --git a/site/current-book/metron-deployment/development/ubuntu14/index.html b/site/current-book/metron-deployment/development/ubuntu14/index.html new file mode 100644 index 0000000..16b2d81 --- /dev/null +++ b/site/current-book/metron-deployment/development/ubuntu14/index.html @@ -0,0 +1,233 @@ +<!DOCTYPE html> +<!-- + | Generated by Apache Maven Doxia Site Renderer 1.8 from src/site/markdown/metron-deployment/development/ubuntu14/index.md at 2018-06-07 + | Rendered using Apache Maven Fluido Skin 1.7 +--> +<html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en"> + <head> + <meta charset="UTF-8" /> + <meta name="viewport" content="width=device-width, initial-scale=1.0" /> + <meta name="Date-Revision-yyyymmdd" content="20180607" /> + <meta http-equiv="Content-Language" content="en" /> + <title>Metron – Metron on Ubuntu 14</title> + <link rel="stylesheet" href="../../../css/apache-maven-fluido-1.7.min.css" /> + <link rel="stylesheet" href="../../../css/site.css" /> + <link rel="stylesheet" href="../../../css/print.css" media="print" /> + <script type="text/javascript" src="../../../js/apache-maven-fluido-1.7.min.js"></script> +<script type="text/javascript"> + $( document ).ready( function() { $( '.carousel' ).carousel( { interval: 3500 } ) } ); + </script> + </head> + <body class="topBarDisabled"> + <div class="container-fluid"> + <div id="banner"> + <div class="pull-left"><a href="http://metron.apache.org/"; id="bannerLeft"><img src="../../../images/metron-logo.png" alt="Apache Metron" width="148px" height="48px"/></a></div> + <div class="pull-right"></div> + <div class="clear"><hr/></div> + </div> + + <div id="breadcrumbs"> + <ul class="breadcrumb"> + <li class=""><a href="http://www.apache.org"; class="externalLink" title="Apache">Apache</a><span class="divider">/</span></li> + <li class=""><a href="http://metron.apache.org/"; class="externalLink" title="Metron">Metron</a><span class="divider">/</span></li> + <li class=""><a href="../../../index.html" title="Documentation">Documentation</a><span class="divider">/</span></li> + <li class="active ">Metron on Ubuntu 14</li> + <li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2018-06-07</li> + <li id="projectVersion" class="pull-right">Version: 0.5.0</li> + </ul> + </div> + <div class="row-fluid"> + <div id="leftColumn" class="span2"> + <div class="well sidebar-nav"> + <ul class="nav nav-list"> + <li class="nav-header">User Documentation</li> + <li><a href="../../../index.html" title="Metron"><span class="icon-chevron-down"></span>Metron</a> + <ul class="nav nav-list"> + <li><a href="../../../CONTRIBUTING.html" title="CONTRIBUTING"><span class="none"></span>CONTRIBUTING</a></li> + <li><a href="../../../Upgrading.html" title="Upgrading"><span class="none"></span>Upgrading</a></li> + <li><a href="../../../metron-analytics/index.html" title="Analytics"><span class="icon-chevron-right"></span>Analytics</a></li> + <li><a href="../../../metron-contrib/metron-docker/index.html" title="Docker"><span class="none"></span>Docker</a></li> + <li><a href="../../../metron-contrib/metron-performance/index.html" title="Performance"><span class="none"></span>Performance</a></li> + <li><a href="../../../metron-deployment/index.html" title="Deployment"><span class="icon-chevron-down"></span>Deployment</a> + <ul class="nav nav-list"> + <li><a href="../../../metron-deployment/Kerberos-ambari-setup.html" title="Kerberos-ambari-setup"><span class="none"></span>Kerberos-ambari-setup</a></li> + <li><a href="../../../metron-deployment/Kerberos-manual-setup.html" title="Kerberos-manual-setup"><span class="none"></span>Kerberos-manual-setup</a></li> + <li><a href="../../../metron-deployment/amazon-ec2/index.html" title="Amazon-ec2"><span class="none"></span>Amazon-ec2</a></li> + <li><a href="../../../metron-deployment/ansible/index.html" title="Ansible"><span class="icon-chevron-right"></span>Ansible</a></li> + <li><a href="../../../metron-deployment/development/index.html" title="Development"><span class="icon-chevron-down"></span>Development</a> + <ul class="nav nav-list"> + <li><a href="../../../metron-deployment/development/centos6/index.html" title="Centos6"><span class="none"></span>Centos6</a></li> + <li><a href="../../../metron-deployment/development/fastcapa/index.html" title="Fastcapa"><span class="none"></span>Fastcapa</a></li> + <li class="active"><a href="#"><span class="none"></span>Ubuntu14</a></li> + </ul> +</li> + <li><a href="../../../metron-deployment/other-examples/index.html" title="Other-examples"><span class="icon-chevron-right"></span>Other-examples</a></li> + <li><a href="../../../metron-deployment/packaging/ambari/index.html" title="Ambari"><span class="icon-chevron-right"></span>Ambari</a></li> + <li><a href="../../../metron-deployment/packaging/docker/ansible-docker/index.html" title="Ansible-docker"><span class="none"></span>Ansible-docker</a></li> + <li><a href="../../../metron-deployment/packaging/docker/deb-docker/index.html" title="Deb-docker"><span class="none"></span>Deb-docker</a></li> + <li><a href="../../../metron-deployment/packaging/docker/rpm-docker/index.html" title="Rpm-docker"><span class="none"></span>Rpm-docker</a></li> + <li><a href="../../../metron-deployment/packaging/packer-build/index.html" title="Packer-build"><span class="none"></span>Packer-build</a></li> + </ul> +</li> + <li><a href="../../../metron-interface/metron-alerts/index.html" title="Alerts"><span class="none"></span>Alerts</a></li> + <li><a href="../../../metron-interface/metron-config/index.html" title="Config"><span class="none"></span>Config</a></li> + <li><a href="../../../metron-interface/metron-rest/index.html" title="Rest"><span class="none"></span>Rest</a></li> + <li><a href="../../../metron-platform/index.html" title="Platform"><span class="icon-chevron-right"></span>Platform</a></li> + <li><a href="../../../metron-sensors/index.html" title="Sensors"><span class="icon-chevron-right"></span>Sensors</a></li> + <li><a href="../../../metron-stellar/stellar-3rd-party-example/index.html" title="Stellar-3rd-party-example"><span class="none"></span>Stellar-3rd-party-example</a></li> + <li><a href="../../../metron-stellar/stellar-common/index.html" title="Stellar-common"><span class="icon-chevron-right"></span>Stellar-common</a></li> + <li><a href="../../../metron-stellar/stellar-zeppelin/index.html" title="Stellar-zeppelin"><span class="none"></span>Stellar-zeppelin</a></li> + <li><a href="../../../use-cases/index.html" title="Use-cases"><span class="icon-chevron-right"></span>Use-cases</a></li> + </ul> +</li> +</ul> + <hr /> + <div id="poweredBy"> + <div class="clear"></div> + <div class="clear"></div> + <div class="clear"></div> + <div class="clear"></div> +<a href="http://maven.apache.org/"; title="Built by Maven" class="poweredBy"><img class="builtBy" alt="Built by Maven" src="../../../images/logos/maven-feather.png" /></a> + </div> + </div> + </div> + <div id="bodyColumn" class="span10" > +<!-- +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you under the Apache License, Version 2.0 (the +"License"); you may not use this file except in compliance +with the License. You may obtain a copy of the License at + +http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. +--> +<h1>Metron on Ubuntu 14</h1> +<p>This project fully automates the provisioning and deployment of Apache Metron and all necessary prerequisites on a single, virtualized host running Ubuntu 14.</p> +<p>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.</p> +<div class="section"> +<h2><a name="Getting_Started"></a>Getting Started</h2> +<div class="section"> +<h3><a name="Prerequisites"></a>Prerequisites</h3> +<p>The computer used to deploy Apache Metron will need to have the following components installed.</p> +<ul> + +<li><a class="externalLink" href="https://github.com/ansible/ansible";>Ansible</a> (2.0.0.2, 2.2.2.0, or 2.5.0)</li> +<li><a class="externalLink" href="https://www.docker.com/community-edition";>Docker</a></li> +<li><a class="externalLink" href="https://www.vagrantup.com";>Vagrant</a> 2.0+</li> +<li><a class="externalLink" href="https://github.com/devopsgroup-io/vagrant-hostmanager";>Vagrant Hostmanager Plugin</a></li> +<li><a class="externalLink" href="https://virtualbox.org";>Virtualbox</a> 5.0+</li> +<li>Python 2.7</li> +<li>Maven 3.3.9</li> +<li>C++11 compliant compiler, like <a class="externalLink" href="https://gcc.gnu.org/projects/cxx-status.html#cxx11";>GCC</a></li> +</ul> +<p>Running the following script can help validate whether you have all the prerequisites installed and running correctly.</p> + +<div> +<div> +<pre class="source"> metron-deployment/scripts/platform-info.sh +</pre></div></div> + +<div class="section"> +<h4><a name="How_do_I_install_these_on_MacOS.3F"></a>How do I install these on MacOS?</h4> +<p>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 <a class="externalLink" href="http://brew.sh/";>Homebrew</a> project.</p> +<ol style="list-style-type: decimal"> + +<li> + +<p>Install Homebrew by following the instructions at <a class="externalLink" href="http://brew.sh/";>Homebrew</a>.</p> +</li> +<li> + +<p>Run the following command in a terminal to install all of the required tools.</p> + +<div> +<div> +<pre class="source">brew cask install vagrant virtualbox docker +brew cask install caskroom/versions/java8 +brew install maven@3.3 git +pip install ansible==2.2.2.0 +vagrant plugin install vagrant-hostmanager +open /Applications/Docker.app +</pre></div></div> +</li> +</ol></div></div> +<div class="section"> +<h3><a name="Deploy_Metron"></a>Deploy Metron</h3> +<ol style="list-style-type: decimal"> + +<li> + +<p>Ensure that the Docker service is running.</p> +</li> +<li> + +<p>Deploy Metron</p> + +<div> +<div> +<pre class="source">cd metron-deployment/development/ubuntu14 +vagrant up +</pre></div></div> + +<p>Should the process fail before completing the deployment, the following command will continue the deployment process without re-instantiating the host.</p> + +<div> +<div> +<pre class="source">vagrant provision +</pre></div></div> +</li> +</ol></div> +<div class="section"> +<h3><a name="Explore_Metron"></a>Explore Metron</h3> +<p>Navigate to the following resources to explore your newly minted Apache Metron environment.</p> +<ul> + +<li><a class="externalLink" href="http://node1:4201";>Metron Alerts</a></li> +<li><a class="externalLink" href="http://node1:8080";>Ambari</a></li> +</ul> +<p>Connecting to the host through SSH is as simple as running the following command.</p> + +<div> +<div> +<pre class="source">vagrant ssh +</pre></div></div> +</div> +<div class="section"> +<h3><a name="Working_with_Metron"></a>Working with Metron</h3> +<p>In addition to re-running the entire provisioning play book, you may now re-run an individual Ansible tag or a collection of tags in the following ways. The following commands will re-run the <tt>sensor-stubs</tt> role on the Vagrant image. This will install and start the sensor stub components.</p> + +<div> +<div> +<pre class="source">vagrant --ansible-tags="sensor-stubs" provision +</pre></div></div> + +<p>Tags are listed in the playbooks, some frequently used tags:</p> +<ul> + +<li><tt>hdp-install</tt> - Install HDP</li> +<li><tt>hdp-deploy</tt> - Deploy and Start HDP Services (will start all Hadoop Services)</li> +<li><tt>sensors</tt> - Deploy and start the sensors.</li> +<li><tt>sensor-stubs</tt> - Deploy and start the sensor stubs.</li> +</ul></div></div> + </div> + </div> + </div> + <hr/> + <footer> + <div class="container-fluid"> + <div class="row-fluid"> +é 2015-2016 The Apache Software Foundation. Apache Metron, Metron, Apache, the Apache feather logo, + and the Apache Metron project logo are trademarks of The Apache Software Foundation. + </div> + </div> + </footer> + </body> +</html> http://git-wip-us.apache.org/repos/asf/metron/blob/ae1d3eb9/site/current-book/metron-deployment/index.html ---------------------------------------------------------------------- diff --git a/site/current-book/metron-deployment/index.html b/site/current-book/metron-deployment/index.html index 72723a6..a3ffcbd 100644 --- a/site/current-book/metron-deployment/index.html +++ b/site/current-book/metron-deployment/index.html @@ -1,540 +1,285 @@ <!DOCTYPE html> <!-- - | Generated by Apache Maven Doxia at 2018-01-03 - | Rendered using Apache Maven Fluido Skin 1.3.0 + | Generated by Apache Maven Doxia Site Renderer 1.8 from src/site/markdown/metron-deployment/index.md at 2018-06-07 + | Rendered using Apache Maven Fluido Skin 1.7 --> <html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en"> <head> <meta charset="UTF-8" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" /> - <meta name="Date-Revision-yyyymmdd" content="20180103" /> + <meta name="Date-Revision-yyyymmdd" content="20180607" /> <meta http-equiv="Content-Language" content="en" /> - <title>Metron – Overview</title> - <link rel="stylesheet" href="../css/apache-maven-fluido-1.3.0.min.css" /> + <title>Metron – </title> + <link rel="stylesheet" href="../css/apache-maven-fluido-1.7.min.css" /> <link rel="stylesheet" href="../css/site.css" /> <link rel="stylesheet" href="../css/print.css" media="print" /> - - - <script type="text/javascript" src="../js/apache-maven-fluido-1.3.0.min.js"></script> - - - -<script type="text/javascript">$( document ).ready( function() { $( '.carousel' ).carousel( { interval: 3500 } ) } );</script> - - </head> - <body class="topBarDisabled"> - - - - - <div class="container-fluid"> - <div id="banner"> - <div class="pull-left"> - <a href="http://metron.apache.org/"; id="bannerLeft"> - <img src="../images/metron-logo.png" alt="Apache Metron" width="148px" height="48px"/> - </a> - </div> - <div class="pull-right"> </div> + <script type="text/javascript" src="../js/apache-maven-fluido-1.7.min.js"></script> +<script type="text/javascript"> + $( document ).ready( function() { $( '.carousel' ).carousel( { interval: 3500 } ) } ); + </script> + </head> + <body class="topBarDisabled"> + <div class="container-fluid"> + <div id="banner"> + <div class="pull-left"><a href="http://metron.apache.org/"; id="bannerLeft"><img src="../images/metron-logo.png" alt="Apache Metron" width="148px" height="48px"/></a></div> + <div class="pull-right"></div> <div class="clear"><hr/></div> </div> <div id="breadcrumbs"> <ul class="breadcrumb"> - - - <li class=""> - <a href="http://www.apache.org"; class="externalLink" title="Apache"> - Apache</a> - </li> - <li class="divider ">/</li> - <li class=""> - <a href="http://metron.apache.org/"; class="externalLink" title="Metron"> - Metron</a> - </li> - <li class="divider ">/</li> - <li class=""> - <a href="../index.html" title="Documentation"> - Documentation</a> - </li> - <li class="divider ">/</li> - <li class="">Overview</li> - - - - <li id="publishDate" class="pull-right">Last Published: 2018-01-03</li> <li class="divider pull-right">|</li> - <li id="projectVersion" class="pull-right">Version: 0.4.2</li> - - </ul> + <li class=""><a href="http://www.apache.org"; class="externalLink" title="Apache">Apache</a><span class="divider">/</span></li> + <li class=""><a href="http://metron.apache.org/"; class="externalLink" title="Metron">Metron</a><span class="divider">/</span></li> + <li class=""><a href="../index.html" title="Documentation">Documentation</a><span class="divider">/</span></li> + <li class="active "></li> + <li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2018-06-07</li> + <li id="projectVersion" class="pull-right">Version: 0.5.0</li> + </ul> </div> - - <div class="row-fluid"> - <div id="leftColumn" class="span3"> + <div id="leftColumn" class="span2"> <div class="well sidebar-nav"> - - - <ul class="nav nav-list"> - <li class="nav-header">User Documentation</li> - - <li> - - <a href="../index.html" title="Metron"> - <i class="icon-chevron-down"></i> - Metron</a> - <ul class="nav nav-list"> - - <li> - - <a href="../Upgrading.html" title="Upgrading"> - <i class="none"></i> - Upgrading</a> - </li> - - <li> - - <a href="../metron-analytics/index.html" title="Analytics"> - <i class="icon-chevron-right"></i> - Analytics</a> - </li> - - <li> - - <a href="../metron-contrib/metron-docker/index.html" title="Docker"> - <i class="none"></i> - Docker</a> - </li> - - <li class="active"> - - <a href="#"><i class="icon-chevron-down"></i>Deployment</a> - <ul class="nav nav-list"> - - <li> - - <a href="../metron-deployment/Kerberos-ambari-setup.html" title="Kerberos-ambari-setup"> - <i class="none"></i> - Kerberos-ambari-setup</a> - </li> - - <li> - - <a href="../metron-deployment/Kerberos-manual-setup.html" title="Kerberos-manual-setup"> - <i class="none"></i> - Kerberos-manual-setup</a> - </li> - - <li> - - <a href="../metron-deployment/amazon-ec2/index.html" title="Amazon-ec2"> - <i class="none"></i> - Amazon-ec2</a> - </li> - - <li> - - <a href="../metron-deployment/other-examples/index.html" title="Other-examples"> - <i class="icon-chevron-right"></i> - Other-examples</a> - </li> - - <li> - - <a href="../metron-deployment/packaging/ambari/index.html" title="Ambari"> - <i class="none"></i> - Ambari</a> - </li> - - <li> - - <a href="../metron-deployment/packaging/docker/ansible-docker/index.html" title="Ansible-docker"> - <i class="none"></i> - Ansible-docker</a> - </li> - - <li> - - <a href="../metron-deployment/packaging/docker/rpm-docker/index.html" title="Rpm-docker"> - <i class="none"></i> - Rpm-docker</a> - </li> - - <li> - - <a href="../metron-deployment/packaging/packer-build/index.html" title="Packer-build"> - <i class="none"></i> - Packer-build</a> - </li> - - <li> - - <a href="../metron-deployment/roles/index.html" title="Roles"> - <i class="icon-chevron-right"></i> - Roles</a> - </li> - - <li> - - <a href="../metron-deployment/vagrant/index.html" title="Vagrant"> - <i class="icon-chevron-right"></i> - Vagrant</a> - </li> - </ul> - </li> - - <li> - - <a href="../metron-interface/metron-alerts/index.html" title="Alerts"> - <i class="none"></i> - Alerts</a> - </li> - - <li> - - <a href="../metron-interface/metron-config/index.html" title="Config"> - <i class="none"></i> - Config</a> - </li> - - <li> - - <a href="../metron-interface/metron-rest/index.html" title="Rest"> - <i class="none"></i> - Rest</a> - </li> - - <li> - - <a href="../metron-platform/index.html" title="Platform"> - <i class="icon-chevron-right"></i> - Platform</a> - </li> - - <li> - - <a href="../metron-sensors/index.html" title="Sensors"> - <i class="icon-chevron-right"></i> - Sensors</a> - </li> - - <li> - - <a href="../metron-stellar/stellar-3rd-party-example/index.html" title="Stellar-3rd-party-example"> - <i class="none"></i> - Stellar-3rd-party-example</a> - </li> - - <li> - - <a href="../metron-stellar/stellar-common/index.html" title="Stellar-common"> - <i class="icon-chevron-right"></i> - Stellar-common</a> - </li> - - <li> - - <a href="../use-cases/index.html" title="Use-cases"> - <i class="icon-chevron-right"></i> - Use-cases</a> - </li> - </ul> - </li> - </ul> - - - - <hr class="divider" /> - - <div id="poweredBy"> - <div class="clear"></div> - <div class="clear"></div> - <div class="clear"></div> - <a href="http://maven.apache.org/"; title="Built by Maven" class="poweredBy"> - <img class="builtBy" alt="Built by Maven" src="../images/logos/maven-feather.png" /> - </a> - </div> + <ul class="nav nav-list"> + <li class="nav-header">User Documentation</li> + <li><a href="../index.html" title="Metron"><span class="icon-chevron-down"></span>Metron</a> + <ul class="nav nav-list"> + <li><a href="../CONTRIBUTING.html" title="CONTRIBUTING"><span class="none"></span>CONTRIBUTING</a></li> + <li><a href="../Upgrading.html" title="Upgrading"><span class="none"></span>Upgrading</a></li> + <li><a href="../metron-analytics/index.html" title="Analytics"><span class="icon-chevron-right"></span>Analytics</a></li> + <li><a href="../metron-contrib/metron-docker/index.html" title="Docker"><span class="none"></span>Docker</a></li> + <li><a href="../metron-contrib/metron-performance/index.html" title="Performance"><span class="none"></span>Performance</a></li> + <li class="active"><a href="#"><span class="icon-chevron-down"></span>Deployment</a> + <ul class="nav nav-list"> + <li><a href="../metron-deployment/Kerberos-ambari-setup.html" title="Kerberos-ambari-setup"><span class="none"></span>Kerberos-ambari-setup</a></li> + <li><a href="../metron-deployment/Kerberos-manual-setup.html" title="Kerberos-manual-setup"><span class="none"></span>Kerberos-manual-setup</a></li> + <li><a href="../metron-deployment/amazon-ec2/index.html" title="Amazon-ec2"><span class="none"></span>Amazon-ec2</a></li> + <li><a href="../metron-deployment/ansible/index.html" title="Ansible"><span class="icon-chevron-right"></span>Ansible</a></li> + <li><a href="../metron-deployment/development/index.html" title="Development"><span class="icon-chevron-right"></span>Development</a></li> + <li><a href="../metron-deployment/other-examples/index.html" title="Other-examples"><span class="icon-chevron-right"></span>Other-examples</a></li> + <li><a href="../metron-deployment/packaging/ambari/index.html" title="Ambari"><span class="icon-chevron-right"></span>Ambari</a></li> + <li><a href="../metron-deployment/packaging/docker/ansible-docker/index.html" title="Ansible-docker"><span class="none"></span>Ansible-docker</a></li> + <li><a href="../metron-deployment/packaging/docker/deb-docker/index.html" title="Deb-docker"><span class="none"></span>Deb-docker</a></li> + <li><a href="../metron-deployment/packaging/docker/rpm-docker/index.html" title="Rpm-docker"><span class="none"></span>Rpm-docker</a></li> + <li><a href="../metron-deployment/packaging/packer-build/index.html" title="Packer-build"><span class="none"></span>Packer-build</a></li> + </ul> +</li> + <li><a href="../metron-interface/metron-alerts/index.html" title="Alerts"><span class="none"></span>Alerts</a></li> + <li><a href="../metron-interface/metron-config/index.html" title="Config"><span class="none"></span>Config</a></li> + <li><a href="../metron-interface/metron-rest/index.html" title="Rest"><span class="none"></span>Rest</a></li> + <li><a href="../metron-platform/index.html" title="Platform"><span class="icon-chevron-right"></span>Platform</a></li> + <li><a href="../metron-sensors/index.html" title="Sensors"><span class="icon-chevron-right"></span>Sensors</a></li> + <li><a href="../metron-stellar/stellar-3rd-party-example/index.html" title="Stellar-3rd-party-example"><span class="none"></span>Stellar-3rd-party-example</a></li> + <li><a href="../metron-stellar/stellar-common/index.html" title="Stellar-common"><span class="icon-chevron-right"></span>Stellar-common</a></li> + <li><a href="../metron-stellar/stellar-zeppelin/index.html" title="Stellar-zeppelin"><span class="none"></span>Stellar-zeppelin</a></li> + <li><a href="../use-cases/index.html" title="Use-cases"><span class="icon-chevron-right"></span>Use-cases</a></li> + </ul> +</li> +</ul> + <hr /> + <div id="poweredBy"> + <div class="clear"></div> + <div class="clear"></div> + <div class="clear"></div> + <div class="clear"></div> +<a href="http://maven.apache.org/"; title="Built by Maven" class="poweredBy"><img class="builtBy" alt="Built by Maven" src="../images/logos/maven-feather.png" /></a> + </div> </div> </div> - - - <div id="bodyColumn" class="span9" > - - <h1>Overview</h1> -<p><a name="Overview"></a></p> -<p>This set of playbooks can be used to deploy an Ambari-managed Hadoop cluster containing Metron services using Ansible. These playbooks target RHEL/CentOS 6.x operating systems.</p> -<p>Installation consists of -</p> + <div id="bodyColumn" class="span10" > +<!-- +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you under the Apache License, Version 2.0 (the +"License"); you may not use this file except in compliance +with the License. You may obtain a copy of the License at -<ul> - -<li>Building Metron tarballs, RPMs and the Ambari MPack</li> - -<li>Deploying Ambari</li> - -<li>Leveraging Ambari to install: - -<ul> - -<li>The required Hadoop Components</li> - -<li>Core Metron (Parsing, Enrichment, Indexing)</li> - -<li>Elasticsearch</li> - -<li>Kibana</li> - </ul></li> - -<li>Starting All Services</li> -</ul> -<div class="section"> -<h2><a name="Prerequisites"></a>Prerequisites</h2> -<p>The following tools are required to run these scripts:</p> +http://www.apache.org/licenses/LICENSE-2.0 +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. +--> +<p>This project contains tools for building, packaging, and deploying Apache Metron. Please refer to the following sections for more information on how to get Apache Metron running in your environment.</p> <ul> - -<li><a class="externalLink" href="https://maven.apache.org/";>Maven</a></li> - -<li><a class="externalLink" href="https://git-scm.com/";>Git</a></li> - -<li><a class="externalLink" href="http://www.ansible.com/";>Ansible</a> (2.0.0.2 or 2.2.2.0)</li> - -<li><a class="externalLink" href="https://www.docker.com/";>Docker</a> (Docker for Mac on OSX)</li> -</ul> -<p>These scripts depend on two files for configuration:</p> -<ul> - -<li>hosts - declares which Ansible roles will be run on which hosts</li> - -<li>group_vars/all - various configuration settings needed to install Metron</li> +<li><a href="#How_do_I_deploy_Metron_with_Ambari">How do I deploy Metron with Ambari?</a></li> +<li><a href="#How_do_I_deploy_Metron_on_a_single_VM">How do I deploy Metron on a single VM?</a></li> +<li><a href="#How_do_I_build_RPM_packages">How do I build RPM packages?</a></li> +<li><a href="#How_do_I_build_DEB_packages">How do I build DEB packages?</a></li> +<li><a href="#How_do_I_deploy_Metron_within_AWS">How do I deploy Metron within AWS?</a></li> +<li><a href="#How_do_I_build_Metron_with_Docker">How do I build Metron with Docker?</a></li> </ul> -<p>For production use, it is recommended that Metron be installed on an existing cluster managed by Ambari as described in the Installing Management Pack section below.</p></div> <div class="section"> -<h2><a name="Ambari"></a>Ambari</h2> -<p>The Ambari playbook will install a Hadoop cluster including the Metron Services (Parsing, Enrichment, Indexing). Ambari will also install Elasticsearch and Kibana.</p> -<p>Currently, the playbooks supports building a local development cluster running on one node or deploying to a 10 node cluster on AWS EC2.</p></div> +<h2><a name="How_do_I_deploy_Metron_with_Ambari.3F"></a>How do I deploy Metron with Ambari?</h2> +<p>This provides a Management Pack (MPack) extension for <a class="externalLink" href="https://ambari.apache.org/";>Apache Ambari</a> that simplifies the provisioning, management and monitoring of Metron on clusters of any size.</p> +<p>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.</p> <div class="section"> -<h2><a name="Vagrant"></a>Vagrant</h2> -<p>There is a development environment based on Vagrant that is referred to as “Full Dev”. This installs the entire Ambari/Metron stack. This is useful in testing out changes to the installation procedure.</p> <div class="section"> -<h3><a name="Prerequsities"></a>Prerequsities</h3> - +<h4><a name="What_is_this_good_for.3F"></a>What is this good for?</h4> <ul> - -<li>Install <a class="externalLink" href="https://www.vagrantup.com/";>Vagrant</a> (5.0.16+)</li> - -<li>Install the Hostmanager plugin for vagrant - Run <tt>vagrant plugin install vagrant-hostmanager</tt> on the machine where Vagrant is installed</li> + +<li> + +<p>If you want to see how Metron can really scale by deploying it on your own hardware, or even in the cloud, this is the best option for you.</p> +</li> +<li> + +<p>If you want to run a proof-of-concept to see how Apache Metron can benefit your organization, then this is the way to do it.</p> +</li> </ul></div> <div class="section"> -<h3><a name="Full-Dev"></a>Full-Dev</h3> -<p>Navigate to <tt>metron/metron-deployment/vagrant/full-dev-platform</tt> and run <tt>vagrant up</tt>.</p></div></div> +<h4><a name="How.3F"></a>How?</h4> +<p>To deploy Apache Metron using Ambari, follow the instructions at <a href="packaging/ambari/metron-mpack/index.html">packaging/ambari/metron-mpack</a>.</p></div></div></div> <div class="section"> -<h2><a name="Ambari_Management_Pack"></a>Ambari Management Pack</h2> -<p>An Ambari Management Pack can be built in order to make the Metron service available on top of an existing stack, rather than needing a direct stack update.</p> -<p>This will set up</p> - -<ul> - -<li>Metron Parsers</li> - -<li>Enrichment</li> - -<li>Indexing</li> - -<li>GeoIP data</li> - -<li>Optional Elasticsearch</li> - -<li>Optional Kibana</li> -</ul> +<h2><a name="How_do_I_deploy_Metron_on_a_single_VM.3F"></a>How do I deploy Metron on a single VM?</h2> +<p>This will deploy Metron and all of its dependencies on a virtual machine running on your computer.</p> <div class="section"> -<h3><a name="Prerequisites"></a>Prerequisites</h3> - +<div class="section"> +<h4><a name="What_is_this_good_for.3F"></a>What is this good for?</h4> <ul> - -<li>A cluster managed by Ambari 2.4.2+</li> - -<li>Metron RPMs available on the cluster in the /localrepo directory. See <a href="#RPMs">RPMs</a> for further information.</li> - -<li><a class="externalLink" href="https://nodejs.org/en/download/package-manager/";>Node.js</a> repository installed on the Management UI host</li> + +<li> + +<p>If you are new to Metron and want to explore the functionality that it offers, this is good place to start.</p> +</li> +<li> + +<p>If you are a developer contributing to the Apache Metron project, this is also a great way to test your changes.</p> +</li> </ul></div> <div class="section"> -<h3><a name="Building_Management_Pack"></a>Building Management Pack</h3> -<p>From <tt>metron-deployment</tt> run</p> +<h4><a name="What_is_this_not_good_for.3F"></a>What is this <b>not</b> good for?</h4> +<ul> -<div class="source"> -<div class="source"> -<pre>mvn clean package -</pre></div></div> -<p>A tar.gz that can be used with Ambari can be found at <tt>metron-deployment/packaging/ambari/metron-mpack/target/</tt></p></div> -<div class="section"> -<h3><a name="Installing_Management_Pack"></a>Installing Management Pack</h3> -<p>Before installing the mpack, update Storm’s topology.classpath in Ambari to include ‘/etc/hbase/conf:/etc/hadoop/conf’. Restart Storm service.</p> -<p>Place the mpack’s tar.gz onto the node running Ambari Server. From the command line on this node, run</p> +<li> -<div class="source"> -<div class="source"> -<pre>ambari-server install-mpack --mpack=<mpack_location> --verbose -</pre></div></div> -<p>This will make the services available in Ambari in the same manner as any services in a stack, e.g. through Add Services or during cluster install. The Indexing / Parsers/ Enrichment masters should be colocated with a Kafka Broker (to create topics) and HBase client (to create the enrichment and theatintel tables). This colocation is currently not enforced by Ambari, and should be managed by either a Service or Stack advisor as an enhancement.</p> -<p>Several configuration parameters will need to be filled in, and should be pretty self explanatory (primarily a couple of Elasticsearch configs, and the Storm REST URL). Examples are provided in the descriptions on Ambari. Notably, the URL for the GeoIP database that is preloaded (and is prefilled by default) can be set to use a <tt>file:///</tt> location</p> -<p>After installation, a custom action is available in Ambari (where stop / start services are) to install Elasticsearch templates. Similar to this, a custom Kibana action to Load Template is available.</p> -<p>Another custom action is available in Ambari to import Zeppelin dashboards. See the <a href="../metron-platform/metron-indexing/index.html">metron-indexing documentation</a></p> -<div class="section"> -<h4><a name="Offline_installation"></a>Offline installation</h4> -<p>Currently there is only one point that would reach out to the internet during an install. This is the URL for the GeoIP database information.</p> -<p>The RPMs DO NOT reach out to the internet (because there is currently no hosting for them). They look on the local filesystem in <tt>/localrepo</tt>.</p></div></div> -<div class="section"> -<h3><a name="Current_Limitations"></a>Current Limitations</h3> -<p>There are a set of limitations that should be addressed based to improve the current state of the mpacks.</p> +<p>This VM is <b>not</b> intended for processing anything beyond the most basic, low volume work loads.</p> +</li> +<li> -<ul> - -<li>There is currently no hosting for RPMs remotely. They will have to be built locally.</li> - -<li>Colocation of appropriate services should be enforced by Ambari. See [#Installing Management Pack] for more details.</li> - -<li>Storm’s topology.classpath is not updated with the Metron service install and needs to be updated separately.</li> - -<li>Several configuration parameters used when installing the Metron service could (and should) be grabbed from Ambari. Install will require them to be manually entered.</li> - -<li>Need to handle upgrading Metron</li> -</ul></div></div> -<div class="section"> -<h2><a name="RPMs"></a>RPMs</h2> -<p>RPMs can be built to install the components in metron-platform. These RPMs are built in a Docker container and placed into <tt>target</tt>.</p> -<p>Components in the RPMs:</p> +<p>Additional services should <b>not</b> be installed along side Metron in this VM.</p> +</li> +<li> -<ul> - -<li>metron-common</li> - -<li>metron-data-management</li> - -<li>metron-elasticsearch</li> - -<li>metron-enrichment</li> - -<li>metron-parsers</li> - -<li>metron-pcap</li> - -<li>metron-solr</li> - -<li>stellar-common</li> +<p>This VM should <b>not</b> be used to run a proof-of-concept for Apache Metron within your organization.</p> +</li> </ul> +<p>Running Metron within the resource constraints of a single VM is incredibly challenging. Failing to respect this warning, will cause various services to fail mysteriously as the system runs into memory and processing limits.</p></div> <div class="section"> -<h3><a name="Prerequisites"></a>Prerequisites</h3> - +<h4><a name="How.3F"></a>How?</h4> +<p>To deploy Metron in a VM running on your computer, follow the instructions at <a href="development/centos6/index.html">development/centos6</a>.</p></div></div></div> +<div class="section"> +<h2><a name="How_do_I_build_RPM_packages.3F"></a>How do I build RPM packages?</h2> +<p>This provides RPM packages that allow you to install Metron on an RPM-based operating system like CentOS.</p> +<div class="section"> +<div class="section"> +<h4><a name="What_is_this_good_for.3F"></a>What is this good for?</h4> <ul> - -<li>Docker. The image detailed in: <tt>metron-deployment/packaging/docker/rpm-docker/README.md</tt> will automatically be built (or rebuilt if necessary).</li> - -<li>Artifacts for metron-platform have been produced. E.g. <tt>mvn clean package -DskipTests</tt> in <tt>metron-platform</tt></li> -</ul> -<p>The artifacts are required because there is a dependency on modules not expressed via Maven (we grab the resulting assemblies, but don’t need the jars). These are</p> +<li> + +<p>If you want to manually install Apache Metron on an RPM-based system like CentOS, installation can be simplified by using these packages.</p> +</li> +<li> + +<p>If you want a guided installation process using Ambari on an RPM-based system, then these RPMs are a necessary prerequisite.</p> +</li> +</ul></div> +<div class="section"> +<h4><a name="What_is_this_not_good_for.3F"></a>What is this <b>not</b> good for?</h4> <ul> - -<li>metron-common</li> - -<li>metron-data-management</li> - -<li>metron-elasticsearch</li> - -<li>metron-enrichment</li> - -<li>metron-indexing</li> - -<li>metron-parsers</li> - -<li>metron-pcap-backend</li> - -<li>metron-solr</li> - -<li>metron-profiler</li> - -<li>metron-config</li> + +<li>If you want a complete, guided installation process, use Ambari rather than just these packages. Installing Metron using <b>only</b> these RPMs still leaves a considerable amount of configuration necessary to get Metron running. Installing with Ambari automates these additional steps.</li> </ul></div> <div class="section"> -<h3><a name="Building_RPMs"></a>Building RPMs</h3> +<h4><a name="How.3F"></a>How?</h4> +<p>To build the RPM packages, follow the instructions at <a href="packaging/docker/rpm-docker/index.html">packaging/docker/rpm-docker</a>.</p></div></div></div> +<div class="section"> +<h2><a name="How_do_I_build_DEB_packages.3F"></a>How do I build DEB packages?</h2> +<p>This builds installable DEB packages that allow you to install Metron on an APT-based operating system like Ubuntu.</p> +<div class="section"> +<div class="section"> +<h4><a name="What_is_this_good_for.3F"></a>What is this good for?</h4> +<ul> + +<li> -<div class="source"> -<div class="source"> -<pre>cd metron-deployment -mvn clean package -Pbuild-rpms -</pre></div></div> -<p>The output RPM files will land in <tt>target/RPMS/noarch</tt>. They can be installed with the standard</p> +<p>If you want to manually install Metron on a APT-based system like Ubuntu, installation can be simplified by using these packages.</p> +</li> +<li> -<div class="source"> -<div class="source"> -<pre>rpm -i <package> -</pre></div></div></div></div> +<p>If you want a guided installation process using Ambari on an APT-based system, then these DEBs are a necessary prerequisite.</p> +</li> +</ul></div> <div class="section"> -<h2><a name="Kibana_Dashboards"></a>Kibana Dashboards</h2> -<p>The dashboards installed by the Kibana custom action are managed by the dashboard.p file. This file is created by exporting existing dashboards from a running Kibana instance.</p> -<p>To create a new version of the file, make any necessary changes to Kibana (e.g. on full-dev), and export with the appropriate script.</p> +<h4><a name="What_is_this_not_good_for.3F"></a>What is this <b>not</b> good for?</h4> +<ul> -<div class="source"> -<div class="source"> -<pre>python packaging/ambari/metron-mpack/src/main/resources/common-services/KIBANA/4.5.1/package/scripts/dashboard/dashboardindex.py \ -$ES_HOST 9200 \ -packaging/ambari/metron-mpack/src/main/resources/common-services/KIBANA/4.5.1/package/scripts/dashboard/dashboard.p -s -</pre></div></div> -<p>Build the Ambari Mpack to get the dashboard updated appropriately.</p> -<p>Once the MPack is installed, run the Kibana service’s action “Load Template” to install dashboards. This will completely overwrite the .kibana in Elasticsearch, so use with caution.</p></div> +<li>If you want a complete, guided installation process, use Ambari rather than just these packages. Installing Metron using <b>only</b> these RPMs still leaves a considerable amount of configuration necessary to get Metron running. Installing with Ambari automates these additional steps.</li> +</ul></div> <div class="section"> -<h2><a name="Kerberos"></a>Kerberos</h2> -<p>The MPack can allow Metron to be installed and then Kerberized, or installed on top of an already Kerberized cluster. This is done through Ambari’s standard Kerberization setup.</p> +<h4><a name="How.3F"></a>How?</h4> +<p>To build the DEB packages, follow the instructions at <a href="packaging/docker/deb-docker/index.html">packaging/docker/deb-docker</a>.</p></div></div></div> <div class="section"> -<h3><a name="Caveats"></a>Caveats</h3> - +<h2><a name="How_do_I_deploy_Metron_within_AWS.3F"></a>How do I deploy Metron within AWS?</h2> +<p>This deploys Apache Metron on an automatically provisioned 10-node cluster running in Amazon Web Service’s EC2 platform.</p> +<p>This installs real sources of telemetry like Bro, Snort, and YAF, but feeds those sensors with canned pcap data.</p> +<div class="section"> +<div class="section"> +<h4><a name="What_is_this_good_for.3F"></a>What is this good for?</h4> <ul> - -<li>For nodes using a Metron client and a local repo, the repo must exist on all nodes (e.g via createrepo). This repo can be empty; only the main Metron services need the RPMs.</li> - -<li>A Metron client must be installed on each supervisor node in a secured cluster. This is to ensure that the Metron keytab and client_jaas.conf get distributed in order to allow reading and writing from Kafka. - + +<li>If you are a Metron developer wanting to test at-scale on a multi-node cluster, then this is the right option for you.</li> +</ul></div> +<div class="section"> +<h4><a name="What_is_this_not_good_for.3F"></a>What is this <b>not</b> good for?</h4> <ul> - -<li>When Metron is already installed on the cluster, this should be done before Kerberizing.</li> - -<li>When addding Metron to an already Kerberized cluster, ensure that all supervisor nodes receive a Metron client.</li> - </ul></li> - -<li>Storm (and Metron) must be restarted after Metron is installed on an already Kerberized cluster. Several Storm configs get updated, and Metron will be unable to write to Kafka without a restart. - + +<li> + +<p>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.</p> +</li> +<li> + +<p><b>WARNING</b> This is only intended for creating an ephemeral cluster for brief periods of testing. This deployment method has the following severe limitations.</p> <ul> - -<li>Kerberizing a cluster with an existing Metron already has restarts of all services during Kerberization, so it’s unneeded.</li> - </ul></li> + +<li>The cluster is not secured in any way. It is up to you to manually secure it.</li> +<li>The cluster will not survive a reboot.</li> </ul> -<p>Instructions for setup on Full Dev can be found at <a href="Kerberos-ambari-setup.html">Kerberos-ambari-setup.md</a>. These instructions reference the manual install instructions.</p></div> +</li> +</ul></div> <div class="section"> -<h3><a name="Kerberos_Without_an_MPack"></a>Kerberos Without an MPack</h3> -<p>Using the MPack is preferred, but instructions for Kerberizing manually can be found at <a href="Kerberos-manual-setup.html">Kerberos-manual-setup.md</a>. These instructions are reference by the Ambari Kerberos install instructions and include commands for setting up a KDC.</p></div></div> +<h4><a name="How.3F"></a>How?</h4> +<p>Follow the instructions available at <a href="amazon-ec2/index.html">amazon-ec2</a>.</p></div></div></div> <div class="section"> -<h2><a name="TODO"></a>TODO</h2> - +<h2><a name="How_do_I_build_Metron_with_Docker.3F"></a>How do I build Metron with Docker?</h2> +<p>This provides a Docker containing all of the prerequisites required to build Metron. This allows you to easily build Metron without installing all of the build dependencies manually.</p> +<div class="section"> +<div class="section"> +<h4><a name="What_is_this_good_for.3F"></a>What is this good for?</h4> <ul> - -<li>Support Ubuntu deployments</li> -</ul></div> - </div> - </div> - </div> +<li>If you want to build Metron, but do not want to manually install all of the build dependencies, then this is a good option.</li> +</ul></div> +<div class="section"> +<h4><a name="How.3F"></a>How?</h4> +<p>Follow the instructions available at <a href="packaging/docker/ansible-docker/index.html">packaging/docker/ansible-docker</a>.</p></div></div></div> + </div> + </div> + </div> <hr/> - <footer> - <div class="container-fluid"> - <div class="row span12">Copyright © 2018 - <a href="https://www.apache.org";>The Apache Software Foundation</a>. - All Rights Reserved. - + <div class="container-fluid"> + <div class="row-fluid"> +é 2015-2016 The Apache Software Foundation. Apache Metron, Metron, Apache, the Apache feather logo, + and the Apache Metron project logo are trademarks of The Apache Software Foundation. + </div> </div> - - - - </div> </footer> </body> </html> http://git-wip-us.apache.org/repos/asf/metron/blob/ae1d3eb9/site/current-book/metron-deployment/other-examples/index.html ---------------------------------------------------------------------- diff --git a/site/current-book/metron-deployment/other-examples/index.html b/site/current-book/metron-deployment/other-examples/index.html index 3cf67e2..3a89cb0 100644 --- a/site/current-book/metron-deployment/other-examples/index.html +++ b/site/current-book/metron-deployment/other-examples/index.html @@ -1,297 +1,130 @@ <!DOCTYPE html> <!-- - | Generated by Apache Maven Doxia at 2018-01-03 - | Rendered using Apache Maven Fluido Skin 1.3.0 + | Generated by Apache Maven Doxia Site Renderer 1.8 from src/site/markdown/metron-deployment/other-examples/index.md at 2018-06-07 + | Rendered using Apache Maven Fluido Skin 1.7 --> <html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en"> <head> <meta charset="UTF-8" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" /> - <meta name="Date-Revision-yyyymmdd" content="20180103" /> + <meta name="Date-Revision-yyyymmdd" content="20180607" /> <meta http-equiv="Content-Language" content="en" /> <title>Metron – Other Example Deployments</title> - <link rel="stylesheet" href="../../css/apache-maven-fluido-1.3.0.min.css" /> + <link rel="stylesheet" href="../../css/apache-maven-fluido-1.7.min.css" /> <link rel="stylesheet" href="../../css/site.css" /> <link rel="stylesheet" href="../../css/print.css" media="print" /> - - - <script type="text/javascript" src="../../js/apache-maven-fluido-1.3.0.min.js"></script> - - - -<script type="text/javascript">$( document ).ready( function() { $( '.carousel' ).carousel( { interval: 3500 } ) } );</script> - - </head> - <body class="topBarDisabled"> - - - - - <div class="container-fluid"> - <div id="banner"> - <div class="pull-left"> - <a href="http://metron.apache.org/"; id="bannerLeft"> - <img src="../../images/metron-logo.png" alt="Apache Metron" width="148px" height="48px"/> - </a> - </div> - <div class="pull-right"> </div> + <script type="text/javascript" src="../../js/apache-maven-fluido-1.7.min.js"></script> +<script type="text/javascript"> + $( document ).ready( function() { $( '.carousel' ).carousel( { interval: 3500 } ) } ); + </script> + </head> + <body class="topBarDisabled"> + <div class="container-fluid"> + <div id="banner"> + <div class="pull-left"><a href="http://metron.apache.org/"; id="bannerLeft"><img src="../../images/metron-logo.png" alt="Apache Metron" width="148px" height="48px"/></a></div> + <div class="pull-right"></div> <div class="clear"><hr/></div> </div> <div id="breadcrumbs"> <ul class="breadcrumb"> - - - <li class=""> - <a href="http://www.apache.org"; class="externalLink" title="Apache"> - Apache</a> - </li> - <li class="divider ">/</li> - <li class=""> - <a href="http://metron.apache.org/"; class="externalLink" title="Metron"> - Metron</a> - </li> - <li class="divider ">/</li> - <li class=""> - <a href="../../index.html" title="Documentation"> - Documentation</a> - </li> - <li class="divider ">/</li> - <li class="">Other Example Deployments</li> - - - - <li id="publishDate" class="pull-right">Last Published: 2018-01-03</li> <li class="divider pull-right">|</li> - <li id="projectVersion" class="pull-right">Version: 0.4.2</li> - - </ul> + <li class=""><a href="http://www.apache.org"; class="externalLink" title="Apache">Apache</a><span class="divider">/</span></li> + <li class=""><a href="http://metron.apache.org/"; class="externalLink" title="Metron">Metron</a><span class="divider">/</span></li> + <li class=""><a href="../../index.html" title="Documentation">Documentation</a><span class="divider">/</span></li> + <li class="active ">Other Example Deployments</li> + <li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2018-06-07</li> + <li id="projectVersion" class="pull-right">Version: 0.5.0</li> + </ul> </div> - - <div class="row-fluid"> - <div id="leftColumn" class="span3"> + <div id="leftColumn" class="span2"> <div class="well sidebar-nav"> - - - <ul class="nav nav-list"> - <li class="nav-header">User Documentation</li> - - <li> - - <a href="../../index.html" title="Metron"> - <i class="icon-chevron-down"></i> - Metron</a> - <ul class="nav nav-list"> - - <li> - - <a href="../../Upgrading.html" title="Upgrading"> - <i class="none"></i> - Upgrading</a> - </li> - - <li> - - <a href="../../metron-analytics/index.html" title="Analytics"> - <i class="icon-chevron-right"></i> - Analytics</a> - </li> - - <li> - - <a href="../../metron-contrib/metron-docker/index.html" title="Docker"> - <i class="none"></i> - Docker</a> - </li> - - <li> - - <a href="../../metron-deployment/index.html" title="Deployment"> - <i class="icon-chevron-down"></i> - Deployment</a> - <ul class="nav nav-list"> - - <li> - - <a href="../../metron-deployment/Kerberos-ambari-setup.html" title="Kerberos-ambari-setup"> - <i class="none"></i> - Kerberos-ambari-setup</a> - </li> - - <li> - - <a href="../../metron-deployment/Kerberos-manual-setup.html" title="Kerberos-manual-setup"> - <i class="none"></i> - Kerberos-manual-setup</a> - </li> - - <li> - - <a href="../../metron-deployment/amazon-ec2/index.html" title="Amazon-ec2"> - <i class="none"></i> - Amazon-ec2</a> - </li> - - <li class="active"> - - <a href="#"><i class="icon-chevron-down"></i>Other-examples</a> - <ul class="nav nav-list"> - - <li> - - <a href="../../metron-deployment/other-examples/manual-install/Manual_Install_CentOS6.html" title="Manual_Install_CentOS6"> - <i class="none"></i> - Manual_Install_CentOS6</a> - </li> - </ul> - </li> - - <li> - - <a href="../../metron-deployment/packaging/ambari/index.html" title="Ambari"> - <i class="none"></i> - Ambari</a> - </li> - - <li> - - <a href="../../metron-deployment/packaging/docker/ansible-docker/index.html" title="Ansible-docker"> - <i class="none"></i> - Ansible-docker</a> - </li> - - <li> - - <a href="../../metron-deployment/packaging/docker/rpm-docker/index.html" title="Rpm-docker"> - <i class="none"></i> - Rpm-docker</a> - </li> - - <li> - - <a href="../../metron-deployment/packaging/packer-build/index.html" title="Packer-build"> - <i class="none"></i> - Packer-build</a> - </li> - - <li> - - <a href="../../metron-deployment/roles/index.html" title="Roles"> - <i class="icon-chevron-right"></i> - Roles</a> - </li> - - <li> - - <a href="../../metron-deployment/vagrant/index.html" title="Vagrant"> - <i class="icon-chevron-right"></i> - Vagrant</a> - </li> - </ul> - </li> - - <li> - - <a href="../../metron-interface/metron-alerts/index.html" title="Alerts"> - <i class="none"></i> - Alerts</a> - </li> - - <li> - - <a href="../../metron-interface/metron-config/index.html" title="Config"> - <i class="none"></i> - Config</a> - </li> - - <li> - - <a href="../../metron-interface/metron-rest/index.html" title="Rest"> - <i class="none"></i> - Rest</a> - </li> - - <li> - - <a href="../../metron-platform/index.html" title="Platform"> - <i class="icon-chevron-right"></i> - Platform</a> - </li> - - <li> - - <a href="../../metron-sensors/index.html" title="Sensors"> - <i class="icon-chevron-right"></i> - Sensors</a> - </li> - - <li> - - <a href="../../metron-stellar/stellar-3rd-party-example/index.html" title="Stellar-3rd-party-example"> - <i class="none"></i> - Stellar-3rd-party-example</a> - </li> - - <li> - - <a href="../../metron-stellar/stellar-common/index.html" title="Stellar-common"> - <i class="icon-chevron-right"></i> - Stellar-common</a> - </li> - - <li> - - <a href="../../use-cases/index.html" title="Use-cases"> - <i class="icon-chevron-right"></i> - Use-cases</a> - </li> - </ul> - </li> - </ul> - - - - <hr class="divider" /> - - <div id="poweredBy"> - <div class="clear"></div> - <div class="clear"></div> - <div class="clear"></div> - <a href="http://maven.apache.org/"; title="Built by Maven" class="poweredBy"> - <img class="builtBy" alt="Built by Maven" src="../../images/logos/maven-feather.png" /> - </a> - </div> + <ul class="nav nav-list"> + <li class="nav-header">User Documentation</li> + <li><a href="../../index.html" title="Metron"><span class="icon-chevron-down"></span>Metron</a> + <ul class="nav nav-list"> + <li><a href="../../CONTRIBUTING.html" title="CONTRIBUTING"><span class="none"></span>CONTRIBUTING</a></li> + <li><a href="../../Upgrading.html" title="Upgrading"><span class="none"></span>Upgrading</a></li> + <li><a href="../../metron-analytics/index.html" title="Analytics"><span class="icon-chevron-right"></span>Analytics</a></li> + <li><a href="../../metron-contrib/metron-docker/index.html" title="Docker"><span class="none"></span>Docker</a></li> + <li><a href="../../metron-contrib/metron-performance/index.html" title="Performance"><span class="none"></span>Performance</a></li> + <li><a href="../../metron-deployment/index.html" title="Deployment"><span class="icon-chevron-down"></span>Deployment</a> + <ul class="nav nav-list"> + <li><a href="../../metron-deployment/Kerberos-ambari-setup.html" title="Kerberos-ambari-setup"><span class="none"></span>Kerberos-ambari-setup</a></li> + <li><a href="../../metron-deployment/Kerberos-manual-setup.html" title="Kerberos-manual-setup"><span class="none"></span>Kerberos-manual-setup</a></li> + <li><a href="../../metron-deployment/amazon-ec2/index.html" title="Amazon-ec2"><span class="none"></span>Amazon-ec2</a></li> + <li><a href="../../metron-deployment/ansible/index.html" title="Ansible"><span class="icon-chevron-right"></span>Ansible</a></li> + <li><a href="../../metron-deployment/development/index.html" title="Development"><span class="icon-chevron-right"></span>Development</a></li> + <li class="active"><a href="#"><span class="icon-chevron-down"></span>Other-examples</a> + <ul class="nav nav-list"> + <li><a href="../../metron-deployment/other-examples/manual-install/Manual_Install_CentOS6.html" title="Manual_Install_CentOS6"><span class="none"></span>Manual_Install_CentOS6</a></li> + </ul> +</li> + <li><a href="../../metron-deployment/packaging/ambari/index.html" title="Ambari"><span class="icon-chevron-right"></span>Ambari</a></li> + <li><a href="../../metron-deployment/packaging/docker/ansible-docker/index.html" title="Ansible-docker"><span class="none"></span>Ansible-docker</a></li> + <li><a href="../../metron-deployment/packaging/docker/deb-docker/index.html" title="Deb-docker"><span class="none"></span>Deb-docker</a></li> + <li><a href="../../metron-deployment/packaging/docker/rpm-docker/index.html" title="Rpm-docker"><span class="none"></span>Rpm-docker</a></li> + <li><a href="../../metron-deployment/packaging/packer-build/index.html" title="Packer-build"><span class="none"></span>Packer-build</a></li> + </ul> +</li> + <li><a href="../../metron-interface/metron-alerts/index.html" title="Alerts"><span class="none"></span>Alerts</a></li> + <li><a href="../../metron-interface/metron-config/index.html" title="Config"><span class="none"></span>Config</a></li> + <li><a href="../../metron-interface/metron-rest/index.html" title="Rest"><span class="none"></span>Rest</a></li> + <li><a href="../../metron-platform/index.html" title="Platform"><span class="icon-chevron-right"></span>Platform</a></li> + <li><a href="../../metron-sensors/index.html" title="Sensors"><span class="icon-chevron-right"></span>Sensors</a></li> + <li><a href="../../metron-stellar/stellar-3rd-party-example/index.html" title="Stellar-3rd-party-example"><span class="none"></span>Stellar-3rd-party-example</a></li> + <li><a href="../../metron-stellar/stellar-common/index.html" title="Stellar-common"><span class="icon-chevron-right"></span>Stellar-common</a></li> + <li><a href="../../metron-stellar/stellar-zeppelin/index.html" title="Stellar-zeppelin"><span class="none"></span>Stellar-zeppelin</a></li> + <li><a href="../../use-cases/index.html" title="Use-cases"><span class="icon-chevron-right"></span>Use-cases</a></li> + </ul> +</li> +</ul> + <hr /> + <div id="poweredBy"> + <div class="clear"></div> + <div class="clear"></div> + <div class="clear"></div> + <div class="clear"></div> +<a href="http://maven.apache.org/"; title="Built by Maven" class="poweredBy"><img class="builtBy" alt="Built by Maven" src="../../images/logos/maven-feather.png" /></a> + </div> </div> </div> - - - <div id="bodyColumn" class="span9" > - - <h1>Other Example Deployments</h1> + <div id="bodyColumn" class="span10" > +<!-- +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you under the Apache License, Version 2.0 (the +"License"); you may not use this file except in compliance +with the License. You may obtain a copy of the License at + +http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. +--> +<h1>Other Example Deployments</h1> <p><a name="Other_Example_Deployments"></a></p> <p>This folder contains other example deployments which are not covered under the automatic installs. These examples have been vetted and tested by the Metron community at the time of entry. However, development moves fast and things may change. If there are problems with these steps, please check the mailing lists first or log a Jira ticket.</p> - <ul> - + <li><a href="manual-install/Manual_Install_CentOS6.html">Metron 0.4.0 on CentOS 6 Manual Install</a> (July 2017)</li> </ul> - </div> - </div> - </div> - + </div> + </div> + </div> <hr/> - <footer> - <div class="container-fluid"> - <div class="row span12">Copyright © 2018 - <a href="https://www.apache.org";>The Apache Software Foundation</a>. - All Rights Reserved. - + <div class="container-fluid"> + <div class="row-fluid"> +é 2015-2016 The Apache Software Foundation. Apache Metron, Metron, Apache, the Apache feather logo, + and the Apache Metron project logo are trademarks of The Apache Software Foundation. + </div> </div> - - - - </div> </footer> </body> </html>
