metron-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ceste...@apache.org
Subject svn commit: r18254 [2/13] - in /dev/incubator/metron/0.3.1-RC3-incubating: ./ book-site/ book-site/css/ book-site/image-archive/ book-site/images/ book-site/images/logos/ book-site/images/profiles/ book-site/img/ book-site/js/ book-site/metron-analytic...
Date Thu, 09 Feb 2017 14:12:18 GMT
Added: dev/incubator/metron/0.3.1-RC3-incubating/LICENSE
==============================================================================
--- dev/incubator/metron/0.3.1-RC3-incubating/LICENSE (added)
+++ dev/incubator/metron/0.3.1-RC3-incubating/LICENSE Thu Feb  9 14:12:17 2017
@@ -0,0 +1,235 @@
+Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright {yyyy} {name of copyright owner}
+
+   Licensed 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.
+
+------------------------------------------------------------------------------------
+
+This product bundles some test examples from the Stix project (metron-platform/metron-data-management/src/test/resources/stix_example.xml and metron-platform/metron-data-management/src/test/resources/stix_example_wo_conditions.xml), which is available under a BSD license.  For details, see http://stix.mitre.org/about/termsofuse.html
+
+------------------------------------------------------------------------------------
+  MIT
+------------------------------------------------------------------------------------
+
+This product bundles wait-for-it.sh, which is available under a "MIT Software License" license.  For details, see https://github.com/vishnubob/wait-for-it
+
+------------------------------------------------------------------------------------
+
+------------------------------------------------------------------------------------
+  Creative Commons Attribution-ShareAlike 4.0 International License
+------------------------------------------------------------------------------------
+
+This product includes GeoLite2 data created by MaxMind, available from
+<a href="http://www.maxmind.com">http://www.maxmind.com</a>.
+
+------------------------------------------------------------------------------------
+  Creative Commons Attribution-ShareAlike 3.0 License
+------------------------------------------------------------------------------------
+
+This product includes a MaxMind DB created by MaxMind, available from
+<a href="https://github.com/maxmind/MaxMind-DB">https://github.com/maxmind/MaxMind-DB</a>.
+
+------------------------------------------------------------------------------------
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Added: dev/incubator/metron/0.3.1-RC3-incubating/apache-metron-0.3.1-rc3-incubating.tar.gz
==============================================================================
Binary file - no diff available.

Propchange: dev/incubator/metron/0.3.1-RC3-incubating/apache-metron-0.3.1-rc3-incubating.tar.gz
------------------------------------------------------------------------------
    svn:mime-type = application/octet-stream

Added: dev/incubator/metron/0.3.1-RC3-incubating/apache-metron-0.3.1-rc3-incubating.tar.gz.asc
==============================================================================
--- dev/incubator/metron/0.3.1-RC3-incubating/apache-metron-0.3.1-rc3-incubating.tar.gz.asc (added)
+++ dev/incubator/metron/0.3.1-RC3-incubating/apache-metron-0.3.1-rc3-incubating.tar.gz.asc Thu Feb  9 14:12:17 2017
@@ -0,0 +1,17 @@
+-----BEGIN PGP SIGNATURE-----
+Version: GnuPG v1
+
+iQIcBAABAgAGBQJYnHdGAAoJEKsBJYS/s8YsWOoP/2frCangpvLzXLkHj7MOUU4A
+IzNGe06vNlbKGOYptUL9ftMZRBYfduMi8BqppqeHm90G8kScVcU1A2WG9IF0PY64
+JmYzT98iseIlBXUv3DQrv5ZkCVbwXoXnaZWlS08kQRXO5Vf8Rt5Q2SWwp4CY5+Gf
+pzge8/tZVGqK0fYPAqTgFwNsalHfthIlaahZKGPUiesE4wYzhZ98GH3+XvIKWByV
+QBybvTyhby2ZrTGN8+o7TFTW1kRc/KcW7HRHY5iZOp0nw1nuDZtCQxHOanICQqkE
+d1JiPTevxix/LhMnWnivfrQrFNB9kyvfKFpTH6u2UlejVEU9W8JMc0cefevIAGoH
+alIj8FZdDUvbYblViKftecXspV+hpZyHf29lOBOgJyrKY07yBSW7cfDBW/cPj4+u
+FwCk6COTA/ScHcGF7bDob1JohNXZY8k+wAAouanJDTsDcNwqSVWCczwBjMqr+S4L
+K+OdyatYBsBSIqzIp5/f3jVbfguocy5VroBYW9sxZ17RScReTohtuw9tPTRD+BIs
++2eBYH9ASj5nBdFGLRJOn/rr6BAxqrcggAjHmqnmp5IK69s6RcsLTBbMTYTy05o/
+FVZjhTy4CkFE3+NG6vR2O09go7Bmt9m43BRHinEwzIQ1vGbeCQjbvIrpQjeia9Fg
+8VioNxt8H2kFHTXN5PpB
+=TOqB
+-----END PGP SIGNATURE-----

Added: dev/incubator/metron/0.3.1-RC3-incubating/apache-metron-0.3.1-rc3-incubating.tar.gz.md5
==============================================================================
--- dev/incubator/metron/0.3.1-RC3-incubating/apache-metron-0.3.1-rc3-incubating.tar.gz.md5 (added)
+++ dev/incubator/metron/0.3.1-RC3-incubating/apache-metron-0.3.1-rc3-incubating.tar.gz.md5 Thu Feb  9 14:12:17 2017
@@ -0,0 +1 @@
+MD5 (apache-metron-0.3.1-rc3-incubating.tar.gz) = b1a8b3bad6107af684680ecce38ddfb4

Added: dev/incubator/metron/0.3.1-RC3-incubating/apache-metron-0.3.1-rc3-incubating.tar.gz.sha
==============================================================================
--- dev/incubator/metron/0.3.1-RC3-incubating/apache-metron-0.3.1-rc3-incubating.tar.gz.sha (added)
+++ dev/incubator/metron/0.3.1-RC3-incubating/apache-metron-0.3.1-rc3-incubating.tar.gz.sha Thu Feb  9 14:12:17 2017
@@ -0,0 +1,2 @@
+apache-metron-0.3.1-rc3-incubating.tar.gz: 
+81A4 98BA 824C 5843 9BB4  BE13 30DE 0114 C52C 147B

Added: dev/incubator/metron/0.3.1-RC3-incubating/book-site/Upgrading.html
==============================================================================
--- dev/incubator/metron/0.3.1-RC3-incubating/book-site/Upgrading.html (added)
+++ dev/incubator/metron/0.3.1-RC3-incubating/book-site/Upgrading.html Thu Feb  9 14:12:17 2017
@@ -0,0 +1,293 @@
+<!DOCTYPE html>
+<!--
+ | Generated by Apache Maven Doxia at 2017-02-09
+ | Rendered using Apache Maven Fluido Skin 1.3.0
+-->
+<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="20170209" />
+    <meta http-equiv="Content-Language" content="en" />
+    <title>Metron &#x2013; Upgrading</title>
+    <link rel="stylesheet" href="./css/apache-maven-fluido-1.3.0.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.incubator.apache.org/" id="bannerLeft">
+                                                                                                <img src="images/metron-logo.png"  alt="Apache Metron - Incubating" width="148px" height="48px"/>
+                </a>
+                      </div>
+        <div class="pull-right">                  <a href="http://incubator.apache.org/" id="bannerRight">
+                                                                                                <img src="images/ApacheIncubating_Logo.png"  alt="Apache Incubating" width="192px" height="48px"/>
+                </a>
+      </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.incubator.apache.org/" class="externalLink" title="Metron-Incubating">
+        Metron-Incubating</a>
+        </li>
+      <li class="divider ">/</li>
+            <li class="">
+                    <a href="index.html" title="Documentation">
+        Documentation</a>
+        </li>
+      <li class="divider ">/</li>
+        <li class="">Upgrading</li>
+        
+                
+                    
+                  <li id="publishDate" class="pull-right">Last Published: 2017-02-09</li> <li class="divider pull-right">|</li>
+              <li id="projectVersion" class="pull-right">Version: 0.3.1</li>
+            
+                            </ul>
+      </div>
+
+            
+      <div class="row-fluid">
+        <div id="leftColumn" class="span3">
+          <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 class="active">
+    
+            <a href="#"><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-deployment/index.html" title="Deployment">
+          <i class="icon-chevron-right"></i>
+        Deployment</a>
+                  </li>
+                      
+      <li>
+    
+                          <a href="metron-docker/index.html" title="Docker">
+          <i class="none"></i>
+        Docker</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>
+              </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>
+          </div>
+        </div>
+        
+                
+        <div id="bodyColumn"  class="span9" >
+                                  
+            <h1>Upgrading</h1>
+<p><a name="Upgrading"></a></p>
+<p>This document constitutes a per-version listing of changes of configuration which are non-backwards compatible.</p>
+<div class="section">
+<h2><a name="a0.2.0BETA_to_0.3.0"></a>0.2.0BETA to 0.3.0</h2>
+<div class="section">
+<h3><a name="METRON-447:_Monit_fails_to_reload_when_upgrading_from_0.2.0BETA_to_master"></a><a class="externalLink" href="https://issues.apache.org/jira/browse/METRON-447">METRON-447: Monit fails to reload when upgrading from 0.2.0BETA to master</a></h3>
+<div class="section">
+<h4><a name="Description"></a>Description</h4>
+<p><tt>/etc/monit.d/enrichment-elasticsearch.monit</tt> was renamed to <tt>/etc/monit.d/indexing-elasticsearch.monit</tt>, however the old file isn&#x2019;t removed via ansible, which causes the below error during an upgrade: <tt>Starting monit: /etc/monit.d/enrichment-elasticsearch.monit:18: Service
+name conflict, enrichment already defined
+'/usr/local/monit/status_enrichment_topology.sh'</tt></p></div></div>
+<div class="section">
+<h3><a name="METRON-448:Upgrading_via_Ansible_deployment_does_not_add_topology.classpath"></a><a class="externalLink" href="https://issues.apache.org/jira/browse/METRON-448">METRON-448:Upgrading via Ansible deployment does not add topology.classpath </a></h3>
+<div class="section">
+<h4><a name="Description"></a>Description</h4>
+<p>When using Ansible to deploy the latest Metron bits to an existing installation, storm-site is not being updated with the new 0.2.1BETA parameter <tt>topology.classpath</tt>. Topologies are unable to find the client configs as a result.</p></div>
+<div class="section">
+<h4><a name="Workaround"></a>Workaround</h4>
+<p>Set the <tt>topology.classpath</tt> property for storm in Ambari to <tt>/etc/hbase/conf:/etc/hadoop/conf</tt></p></div></div></div>
+<div class="section">
+<h2><a name="a0.3.0_to_0.3.1"></a>0.3.0 to 0.3.1</h2>
+<div class="section">
+<h3><a name="METRON-664:_Make_the_index_configuration_per-writer_with_enableddisabled"></a><a class="externalLink" href="https://issues.apache.org/jira/browse/METRON-664">METRON-664: Make the index configuration per-writer with enabled/disabled</a></h3>
+<div class="section">
+<h4><a name="Description"></a>Description</h4>
+<p>As of 0.3.0 the indexing configuration</p>
+
+<ul>
+  
+<li>Is held in the enrichment configuration for a sensor</li>
+  
+<li>Has properties which control every writers (i.e. HDFS, solr or elasticsearch).</li>
+</ul>
+<p>In the 0.3.1 release, this configuration has been broken out and control for individual writers are separated.</p>
+<p>Please see the description of the configurations in the indexing <a class="externalLink" href="https://github.com/apache/incubator-metron/tree/Metron_0.3.1/metron-platform/metron-indexing#sensor-indexing-configuration">README</a></p></div>
+<div class="section">
+<h4><a name="Migration"></a>Migration</h4>
+<p>Migrate the configurations from each sensor enrichment configuration and create appropriate configurations for indexing.</p>
+<p>For instance, if a sensor enrichment config for sensor <tt>foo</tt> is in <tt>$METRON_HOME/config/zookeeper/enrichments/foo.json</tt> and looks like</p>
+
+<div class="source">
+<div class="source">
+<pre>{
+  &quot;index&quot; : &quot;foo&quot;,
+  &quot;batchSize&quot; : 100
+}
+</pre></div></div>
+<p>You would create a file to configure each writer for sensor <tt>foo</tt> called <tt>$METRON_HOME/config/zookeeper/indexing/foo.json</tt> with the contents</p>
+
+<div class="source">
+<div class="source">
+<pre>{
+  &quot;elasticsearch&quot; : {
+    &quot;index&quot; : &quot;foo&quot;,
+    &quot;batchSize&quot; : 100,
+    &quot;enabled&quot; : true
+  },
+  &quot;hdfs&quot; : { 
+    &quot;index&quot; : &quot;foo&quot;,
+    &quot;batchSize&quot; : 100,
+    &quot;enabled&quot; : true
+  }
+}
+</pre></div></div></div></div>
+<div class="section">
+<h3><a name="METRON-675:_Make_Threat_Triage_rules_able_to_be_assigned_names_and_comments"></a><a class="externalLink" href="https://issues.apache.org/jira/browse/METRON-675">METRON-675: Make Threat Triage rules able to be assigned names and comments</a></h3>
+<div class="section">
+<h4><a name="Description"></a>Description</h4>
+<p>As of 0.3.0, threat triage rules were defined as a simple Map associating a Stellar expression with a score. As of 0.3.1, due to the fact that there may be many threat triage rules, we have made the rules more complex. To help organize these, we have made the threat triage objects in their own right that contain optional name and optional comment fields.</p>
+<p>This essentially makes the risk level rules slightly more complex. The format goes from:</p>
+
+<div class="source">
+<div class="source">
+<pre>&quot;riskLevelRules&quot; : {
+    &quot;stellar expression&quot; : numeric score
+}
+</pre></div></div>
+<p>to:</p>
+
+<div class="source">
+<div class="source">
+<pre>&quot;riskLevelRules&quot; : [
+     {
+        &quot;name&quot; : &quot;optional name&quot;,
+        &quot;comment&quot; : &quot;optional comment&quot;,
+        &quot;rule&quot; : &quot;stellar expression&quot;,
+        &quot;score&quot; : numeric score
+     }
+]
+</pre></div></div></div>
+<div class="section">
+<h4><a name="Migration"></a>Migration</h4>
+<p>For every sensor enrichment configuration, you will need to migrate the <tt>riskLevelRules</tt> section to move from a map to a list of risk level rule objects.</p></div></div>
+<div class="section">
+<h3><a name="METRON-283:_Migrate_Geo_Enrichment_outside_of_MySQL"></a><a class="externalLink" href="https://issues.apache.org/jira/browse/METRON-283">METRON-283: Migrate Geo Enrichment outside of MySQL</a></h3>
+<div class="section">
+<h4><a name="Description"></a>Description</h4>
+<p>As of 0.3.0, a MySQL database was used for storage and retrieval of GeoIP information during enrichment. As of 0.3.1, the MySQL database is removed in favor of using MaxMind&#x2019;s binary GeoIP files and stored on HDFS</p>
+<p>After initial setup, this change is transparent and existing enrichment definitions will run as-is.</p></div>
+<div class="section">
+<h4><a name="Migration"></a>Migration</h4>
+<p>While new installs will not require any additional steps, in an existing install a script must be run to retrieve and load the initial data.</p>
+<p>The shell script <tt>geo_enrichment_load.sh</tt> will retrieve MaxMind GeoLite2 data and load data into HDFS, and update the configuration to point to this data. In most cases the following usage will grab the data appropriately:</p>
+
+<div class="source">
+<div class="source">
+<pre>$METRON_HOME/bin/geo_enrichment_load.sh -z &lt;zk_server&gt;:&lt;zk_port&gt;
+</pre></div></div>
+<p>Additional options, including changing the source file location (which can be a file:// location if the GeoIP data is already downloaded), are available with the -h flag and are also detailed in the metron-data-management README.me  file.</p>
+<p>One caveat is that this script will NOT update on disk config files. It is recommended to retrieve the configuration using</p>
+
+<div class="source">
+<div class="source">
+<pre>$METRON_HOME/bin/zk_load_configs.sh -z &lt;zk_server&gt;:&lt;zk_port&gt; -m DUMP
+</pre></div></div>
+<p>The new config will be <tt>geo.hdfs.file</tt> in the global section of the configuration. Append this key-value into the global.json in the config directory. A PUSH is unnecessary</p></div></div>
+<div class="section">
+<h3><a name="METRON-684:_Decouple_Timestamp_calculation_from_PROFILE_GET"></a><a class="externalLink" href="https://issues.apache.org/jira/browse/METRON-684">METRON-684: Decouple Timestamp calculation from PROFILE_GET</a></h3>
+<div class="section">
+<h4><a name="Description"></a>Description</h4>
+<p>During 0.3.1 we decoupled specifying durations for calls to the profiler into a separate function. The consequence is that existing calls to <tt>PROFILE_GET</tt> will need to migrate.</p></div>
+<div class="section">
+<h4><a name="Migration"></a>Migration</h4>
+<p>Existing calls to <tt>PROFILE_GET</tt> will need to change from <tt>PROFILE_GET('profile', 'entity', duration, 'durationUnits')</tt> to <tt>PROFILE_GET('profile', 'entity', PROFILE_FIXED(duration, 'durationUnits'))</tt></p></div></div></div>
+                  </div>
+            </div>
+          </div>
+
+    <hr/>
+
+    <footer>
+            <div class="container-fluid">
+              <div class="row span12">Copyright &copy;                   2017.
+          All Rights Reserved.      
+                    
+      </div>
+
+                          
+        
+                </div>
+    </footer>
+  </body>
+</html>

Added: dev/incubator/metron/0.3.1-RC3-incubating/book-site/css/apache-maven-fluido-1.3.0.min.css
==============================================================================
--- dev/incubator/metron/0.3.1-RC3-incubating/book-site/css/apache-maven-fluido-1.3.0.min.css (added)
+++ dev/incubator/metron/0.3.1-RC3-incubating/book-site/css/apache-maven-fluido-1.3.0.min.css Thu Feb  9 14:12:17 2017
@@ -0,0 +1,9 @@
+/*!
+ * Bootstrap v2.1.0
+ *
+ * Copyright 2012 Twitter, Inc
+ * Licensed under the Apache License v2.0
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Designed and built with all the love in the world @twitter by @mdo and @fat.

[... 3 lines stripped ...]
Added: dev/incubator/metron/0.3.1-RC3-incubating/book-site/css/print.css
==============================================================================
--- dev/incubator/metron/0.3.1-RC3-incubating/book-site/css/print.css (added)
+++ dev/incubator/metron/0.3.1-RC3-incubating/book-site/css/print.css Thu Feb  9 14:12:17 2017
@@ -0,0 +1,23 @@
+/*
+ * 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.
+ */
+
+/* $Id: print.css 1201871 2011-11-14 20:18:24Z simonetripodi $ */
+
+#banner, #footer, #leftcol, #breadcrumbs, .docs #toc, .docs .courtesylinks, #leftColumn, #navColumn {display: none !important;}
+#bodyColumn, body.docs div.docs {margin: 0 !important;border: none !important}

Added: dev/incubator/metron/0.3.1-RC3-incubating/book-site/css/site.css
==============================================================================
--- dev/incubator/metron/0.3.1-RC3-incubating/book-site/css/site.css (added)
+++ dev/incubator/metron/0.3.1-RC3-incubating/book-site/css/site.css Thu Feb  9 14:12:17 2017
@@ -0,0 +1 @@
+/* You can override this file with your own styles */
\ No newline at end of file

Added: dev/incubator/metron/0.3.1-RC3-incubating/book-site/image-archive/ApacheIncubating_Logo.png
==============================================================================
Binary file - no diff available.

Propchange: dev/incubator/metron/0.3.1-RC3-incubating/book-site/image-archive/ApacheIncubating_Logo.png
------------------------------------------------------------------------------
    svn:mime-type = application/octet-stream

Added: dev/incubator/metron/0.3.1-RC3-incubating/book-site/image-archive/metron-logo.png
==============================================================================
Binary file - no diff available.

Propchange: dev/incubator/metron/0.3.1-RC3-incubating/book-site/image-archive/metron-logo.png
------------------------------------------------------------------------------
    svn:mime-type = application/octet-stream

Added: dev/incubator/metron/0.3.1-RC3-incubating/book-site/images/ApacheIncubating_Logo.png
==============================================================================
Binary file - no diff available.

Propchange: dev/incubator/metron/0.3.1-RC3-incubating/book-site/images/ApacheIncubating_Logo.png
------------------------------------------------------------------------------
    svn:mime-type = application/octet-stream

Added: dev/incubator/metron/0.3.1-RC3-incubating/book-site/images/accessories-text-editor.png
==============================================================================
Binary file - no diff available.

Propchange: dev/incubator/metron/0.3.1-RC3-incubating/book-site/images/accessories-text-editor.png
------------------------------------------------------------------------------
    svn:mime-type = application/octet-stream

Added: dev/incubator/metron/0.3.1-RC3-incubating/book-site/images/add.gif
==============================================================================
Binary file - no diff available.

Propchange: dev/incubator/metron/0.3.1-RC3-incubating/book-site/images/add.gif
------------------------------------------------------------------------------
    svn:mime-type = application/octet-stream

Added: dev/incubator/metron/0.3.1-RC3-incubating/book-site/images/apache-maven-project-2.png
==============================================================================
Binary file - no diff available.

Propchange: dev/incubator/metron/0.3.1-RC3-incubating/book-site/images/apache-maven-project-2.png
------------------------------------------------------------------------------
    svn:mime-type = application/octet-stream

Added: dev/incubator/metron/0.3.1-RC3-incubating/book-site/images/application-certificate.png
==============================================================================
Binary file - no diff available.

Propchange: dev/incubator/metron/0.3.1-RC3-incubating/book-site/images/application-certificate.png
------------------------------------------------------------------------------
    svn:mime-type = application/octet-stream

Added: dev/incubator/metron/0.3.1-RC3-incubating/book-site/images/contact-new.png
==============================================================================
Binary file - no diff available.

Propchange: dev/incubator/metron/0.3.1-RC3-incubating/book-site/images/contact-new.png
------------------------------------------------------------------------------
    svn:mime-type = application/octet-stream

Added: dev/incubator/metron/0.3.1-RC3-incubating/book-site/images/document-properties.png
==============================================================================
Binary file - no diff available.

Propchange: dev/incubator/metron/0.3.1-RC3-incubating/book-site/images/document-properties.png
------------------------------------------------------------------------------
    svn:mime-type = application/octet-stream

Added: dev/incubator/metron/0.3.1-RC3-incubating/book-site/images/drive-harddisk.png
==============================================================================
Binary file - no diff available.

Propchange: dev/incubator/metron/0.3.1-RC3-incubating/book-site/images/drive-harddisk.png
------------------------------------------------------------------------------
    svn:mime-type = application/octet-stream

Added: dev/incubator/metron/0.3.1-RC3-incubating/book-site/images/enrichment_arch.png
==============================================================================
Binary file - no diff available.

Propchange: dev/incubator/metron/0.3.1-RC3-incubating/book-site/images/enrichment_arch.png
------------------------------------------------------------------------------
    svn:mime-type = application/octet-stream

Added: dev/incubator/metron/0.3.1-RC3-incubating/book-site/images/fix.gif
==============================================================================
Binary file - no diff available.

Propchange: dev/incubator/metron/0.3.1-RC3-incubating/book-site/images/fix.gif
------------------------------------------------------------------------------
    svn:mime-type = application/octet-stream

Added: dev/incubator/metron/0.3.1-RC3-incubating/book-site/images/icon_error_sml.gif
==============================================================================
Binary file - no diff available.

Propchange: dev/incubator/metron/0.3.1-RC3-incubating/book-site/images/icon_error_sml.gif
------------------------------------------------------------------------------
    svn:mime-type = application/octet-stream

Added: dev/incubator/metron/0.3.1-RC3-incubating/book-site/images/icon_help_sml.gif
==============================================================================
Binary file - no diff available.

Propchange: dev/incubator/metron/0.3.1-RC3-incubating/book-site/images/icon_help_sml.gif
------------------------------------------------------------------------------
    svn:mime-type = application/octet-stream

Added: dev/incubator/metron/0.3.1-RC3-incubating/book-site/images/icon_info_sml.gif
==============================================================================
Binary file - no diff available.

Propchange: dev/incubator/metron/0.3.1-RC3-incubating/book-site/images/icon_info_sml.gif
------------------------------------------------------------------------------
    svn:mime-type = application/octet-stream

Added: dev/incubator/metron/0.3.1-RC3-incubating/book-site/images/icon_success_sml.gif
==============================================================================
Binary file - no diff available.

Propchange: dev/incubator/metron/0.3.1-RC3-incubating/book-site/images/icon_success_sml.gif
------------------------------------------------------------------------------
    svn:mime-type = application/octet-stream

Added: dev/incubator/metron/0.3.1-RC3-incubating/book-site/images/icon_warning_sml.gif
==============================================================================
Binary file - no diff available.

Propchange: dev/incubator/metron/0.3.1-RC3-incubating/book-site/images/icon_warning_sml.gif
------------------------------------------------------------------------------
    svn:mime-type = application/octet-stream

Added: dev/incubator/metron/0.3.1-RC3-incubating/book-site/images/image-x-generic.png
==============================================================================
Binary file - no diff available.

Propchange: dev/incubator/metron/0.3.1-RC3-incubating/book-site/images/image-x-generic.png
------------------------------------------------------------------------------
    svn:mime-type = application/octet-stream

Added: dev/incubator/metron/0.3.1-RC3-incubating/book-site/images/indexing_arch.png
==============================================================================
Binary file - no diff available.

Propchange: dev/incubator/metron/0.3.1-RC3-incubating/book-site/images/indexing_arch.png
------------------------------------------------------------------------------
    svn:mime-type = application/octet-stream

Added: dev/incubator/metron/0.3.1-RC3-incubating/book-site/images/internet-web-browser.png
==============================================================================
Binary file - no diff available.

Propchange: dev/incubator/metron/0.3.1-RC3-incubating/book-site/images/internet-web-browser.png
------------------------------------------------------------------------------
    svn:mime-type = application/octet-stream

Added: dev/incubator/metron/0.3.1-RC3-incubating/book-site/images/logos/build-by-maven-black.png
==============================================================================
Binary file - no diff available.

Propchange: dev/incubator/metron/0.3.1-RC3-incubating/book-site/images/logos/build-by-maven-black.png
------------------------------------------------------------------------------
    svn:mime-type = application/octet-stream

Added: dev/incubator/metron/0.3.1-RC3-incubating/book-site/images/logos/build-by-maven-white.png
==============================================================================
Binary file - no diff available.

Propchange: dev/incubator/metron/0.3.1-RC3-incubating/book-site/images/logos/build-by-maven-white.png
------------------------------------------------------------------------------
    svn:mime-type = application/octet-stream

Added: dev/incubator/metron/0.3.1-RC3-incubating/book-site/images/logos/maven-feather.png
==============================================================================
Binary file - no diff available.

Propchange: dev/incubator/metron/0.3.1-RC3-incubating/book-site/images/logos/maven-feather.png
------------------------------------------------------------------------------
    svn:mime-type = application/octet-stream

Added: dev/incubator/metron/0.3.1-RC3-incubating/book-site/images/maas_arch.png
==============================================================================
Binary file - no diff available.

Propchange: dev/incubator/metron/0.3.1-RC3-incubating/book-site/images/maas_arch.png
------------------------------------------------------------------------------
    svn:mime-type = application/octet-stream

Added: dev/incubator/metron/0.3.1-RC3-incubating/book-site/images/metron-logo.png
==============================================================================
Binary file - no diff available.

Propchange: dev/incubator/metron/0.3.1-RC3-incubating/book-site/images/metron-logo.png
------------------------------------------------------------------------------
    svn:mime-type = application/octet-stream

Added: dev/incubator/metron/0.3.1-RC3-incubating/book-site/images/network-server.png
==============================================================================
Binary file - no diff available.

Propchange: dev/incubator/metron/0.3.1-RC3-incubating/book-site/images/network-server.png
------------------------------------------------------------------------------
    svn:mime-type = application/octet-stream

Added: dev/incubator/metron/0.3.1-RC3-incubating/book-site/images/package-x-generic.png
==============================================================================
Binary file - no diff available.

Propchange: dev/incubator/metron/0.3.1-RC3-incubating/book-site/images/package-x-generic.png
------------------------------------------------------------------------------
    svn:mime-type = application/octet-stream

Added: dev/incubator/metron/0.3.1-RC3-incubating/book-site/images/parser_arch.png
==============================================================================
Binary file - no diff available.

Propchange: dev/incubator/metron/0.3.1-RC3-incubating/book-site/images/parser_arch.png
------------------------------------------------------------------------------
    svn:mime-type = application/octet-stream

Added: dev/incubator/metron/0.3.1-RC3-incubating/book-site/images/profiles/pre-release.png
==============================================================================
Binary file - no diff available.

Propchange: dev/incubator/metron/0.3.1-RC3-incubating/book-site/images/profiles/pre-release.png
------------------------------------------------------------------------------
    svn:mime-type = application/octet-stream

Added: dev/incubator/metron/0.3.1-RC3-incubating/book-site/images/profiles/retired.png
==============================================================================
Binary file - no diff available.

Propchange: dev/incubator/metron/0.3.1-RC3-incubating/book-site/images/profiles/retired.png
------------------------------------------------------------------------------
    svn:mime-type = application/octet-stream

Added: dev/incubator/metron/0.3.1-RC3-incubating/book-site/images/profiles/sandbox.png
==============================================================================
Binary file - no diff available.

Propchange: dev/incubator/metron/0.3.1-RC3-incubating/book-site/images/profiles/sandbox.png
------------------------------------------------------------------------------
    svn:mime-type = application/octet-stream

Added: dev/incubator/metron/0.3.1-RC3-incubating/book-site/images/remove.gif
==============================================================================
Binary file - no diff available.

Propchange: dev/incubator/metron/0.3.1-RC3-incubating/book-site/images/remove.gif
------------------------------------------------------------------------------
    svn:mime-type = application/octet-stream

Added: dev/incubator/metron/0.3.1-RC3-incubating/book-site/images/rss.png
==============================================================================
Binary file - no diff available.

Propchange: dev/incubator/metron/0.3.1-RC3-incubating/book-site/images/rss.png
------------------------------------------------------------------------------
    svn:mime-type = application/octet-stream

Added: dev/incubator/metron/0.3.1-RC3-incubating/book-site/images/update.gif
==============================================================================
Binary file - no diff available.

Propchange: dev/incubator/metron/0.3.1-RC3-incubating/book-site/images/update.gif
------------------------------------------------------------------------------
    svn:mime-type = application/octet-stream

Added: dev/incubator/metron/0.3.1-RC3-incubating/book-site/images/window-new.png
==============================================================================
Binary file - no diff available.

Propchange: dev/incubator/metron/0.3.1-RC3-incubating/book-site/images/window-new.png
------------------------------------------------------------------------------
    svn:mime-type = application/octet-stream

Added: dev/incubator/metron/0.3.1-RC3-incubating/book-site/img/glyphicons-halflings-white.png
==============================================================================
Binary file - no diff available.

Propchange: dev/incubator/metron/0.3.1-RC3-incubating/book-site/img/glyphicons-halflings-white.png
------------------------------------------------------------------------------
    svn:mime-type = application/octet-stream

Added: dev/incubator/metron/0.3.1-RC3-incubating/book-site/img/glyphicons-halflings.png
==============================================================================
Binary file - no diff available.

Propchange: dev/incubator/metron/0.3.1-RC3-incubating/book-site/img/glyphicons-halflings.png
------------------------------------------------------------------------------
    svn:mime-type = application/octet-stream

Added: dev/incubator/metron/0.3.1-RC3-incubating/book-site/index.html
==============================================================================
--- dev/incubator/metron/0.3.1-RC3-incubating/book-site/index.html (added)
+++ dev/incubator/metron/0.3.1-RC3-incubating/book-site/index.html Thu Feb  9 14:12:17 2017
@@ -0,0 +1,257 @@
+<!DOCTYPE html>
+<!--
+ | Generated by Apache Maven Doxia at 2017-02-09
+ | Rendered using Apache Maven Fluido Skin 1.3.0
+-->
+<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="20170209" />
+    <meta http-equiv="Content-Language" content="en" />
+    <title>Metron &#x2013; </title>
+    <link rel="stylesheet" href="./css/apache-maven-fluido-1.3.0.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.incubator.apache.org/" id="bannerLeft">
+                                                                                                <img src="images/metron-logo.png"  alt="Apache Metron - Incubating" width="148px" height="48px"/>
+                </a>
+                      </div>
+        <div class="pull-right">                  <a href="http://incubator.apache.org/" id="bannerRight">
+                                                                                                <img src="images/ApacheIncubating_Logo.png"  alt="Apache Incubating" width="192px" height="48px"/>
+                </a>
+      </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.incubator.apache.org/" class="externalLink" title="Metron-Incubating">
+        Metron-Incubating</a>
+        </li>
+      <li class="divider ">/</li>
+            <li class="">
+                    <a href="index.html" title="Documentation">
+        Documentation</a>
+        </li>
+      <li class="divider ">/</li>
+        <li class=""></li>
+        
+                
+                    
+                  <li id="publishDate" class="pull-right">Last Published: 2017-02-09</li> <li class="divider pull-right">|</li>
+              <li id="projectVersion" class="pull-right">Version: 0.3.1</li>
+            
+                            </ul>
+      </div>
+
+            
+      <div class="row-fluid">
+        <div id="leftColumn" class="span3">
+          <div class="well sidebar-nav">
+                
+                    
+                <ul class="nav nav-list">
+                    <li class="nav-header">User Documentation</li>
+                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  
+      <li class="active">
+    
+            <a href="#"><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-deployment/index.html" title="Deployment">
+          <i class="icon-chevron-right"></i>
+        Deployment</a>
+                  </li>
+                      
+      <li>
+    
+                          <a href="metron-docker/index.html" title="Docker">
+          <i class="none"></i>
+        Docker</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>
+              </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>
+          </div>
+        </div>
+        
+                
+        <div id="bodyColumn"  class="span9" >
+                                  
+            <p><a class="externalLink" href="https://travis-ci.org/apache/incubator-metron"><img src="https://travis-ci.org/apache/incubator-metron.svg?branch=master" alt="Build Status" /></a></p>
+<h1>Apache Metron (Incubating)</h1>
+<p><a name="Apache_Metron_Incubating"></a></p>
+<p>Metron integrates a variety of open source big data technologies in order to offer a centralized tool for security monitoring and analysis. Metron provides capabilities for log aggregation, full packet capture indexing, storage, advanced behavioral analytics and data enrichment, while applying the most current threat intelligence information to security telemetry within a single platform.</p>
+<p>Metron can be divided into 4 areas:</p>
+
+<ol style="list-style-type: decimal">
+  
+<li>
+<p><b>A mechanism to capture, store, and normalize any type of security telemetry at extremely high rates.</b> Because security telemetry is constantly being generated, it requires a method for ingesting the data at high speeds and pushing it to various processing units for advanced computation and analytics.</p></li>
+  
+<li>
+<p><b>Real time processing and application of enrichments</b> such as threat intelligence, geolocation, and DNS information to telemetry being collected. The immediate application of this information to incoming telemetry provides the context and situational awareness, as well as the who and where information critical for investigation</p></li>
+  
+<li>
+<p><b>Efficient information storage</b> based on how the information will be used:</p>
+  
+<ul>
+    
+<li>Logs and telemetry are stored such that they can be efficiently mined and analyzed for concise security visibility</li>
+    
+<li>The ability to extract and reconstruct full packets helps an analyst answer questions such as who the true attacker was, what data was leaked, and where that data was sent</li>
+    
+<li>Long-term storage not only increases visibility over time, but also enables advanced analytics such as machine learning techniques to be used to create models on the information. Incoming data can then be scored against these stored models for advanced anomaly detection.</li>
+  </ul></li>
+  
+<li>
+<p><b>An interface that gives a security investigator a centralized view of data and alerts passed through the system.</b> Metron&#x2019;s interface presents alert summaries with threat intelligence and enrichment data specific to that alert on one single page. Furthermore, advanced search capabilities and full packet extraction tools are presented to the analyst for investigation without the need to pivot into additional tools. </p></li>
+</ol>
+<p>Big data is a natural fit for powerful security analytics. The Metron framework integrates a number of elements from the Hadoop ecosystem to provide a scalable platform for security analytics, incorporating such functionality as full-packet capture, stream processing, batch processing, real-time search, and telemetry aggregation. With Metron, our goal is to tie big data into security analytics and drive towards an extensible centralized platform to effectively enable rapid detection and rapid response for advanced security threats. </p>
+<p><a name="Obtaining_Metron"></a></p>
+<h1>Obtaining Metron</h1>
+<p>This repository is a collection of submodules for convenience which is regularly updated to point to the latest versions. Github provides multiple ways to obtain Metron&#x2019;s code:</p>
+
+<ol style="list-style-type: decimal">
+  
+<li>git clone &#x2013;recursive <a class="externalLink" href="https://github.com/apache/incubator-metron">https://github.com/apache/incubator-metron</a></li>
+  
+<li><a class="externalLink" href="https://github.com/apache/incubator-metron/archive/master.zip">Download ZIP</a></li>
+  
+<li>Clone or download each repository individually</li>
+</ol>
+<p>Option 3 is more likely to have the latest code.</p>
+<p><a name="Building_Metron"></a></p>
+<h1>Building Metron</h1>
+<p>Build the full project and run tests:</p>
+
+<div class="source">
+<div class="source">
+<pre>$ mvn clean install
+</pre></div></div>
+<p>Build without tests:</p>
+
+<div class="source">
+<div class="source">
+<pre>$ mvn clean install -DskipTests
+</pre></div></div>
+<p>Build with the HDP profile:</p>
+
+<div class="source">
+<div class="source">
+<pre>$ mvn clean install -PHDP-2.5.0.0
+</pre></div></div>
+<p>You can swap &#x201c;install&#x201d; for &#x201c;package&#x201d; in the commands above if you don&#x2019;t want to deploy the artifacts to your local .m2 repo.</p>
+<p><a name="Navigating_the_Architecture"></a></p>
+<h1>Navigating the Architecture</h1>
+<p>Metron is at its core a Kappa architecture with Apache Storm as the processing component and Apache Kafka as the unified data bus.</p>
+<p>Some high level links to the relevant subparts of the architecture, for more information:</p>
+
+<ul>
+  
+<li><a href="metron-platform/metron-parsers/index.html">Parsers</a> : Parsing data from kafka into the Metron data model and passing it downstream to Enrichment.</li>
+  
+<li><a href="metron-platform/metron-enrichment/index.html">Enrichment</a> : Enriching data post-parsing and providing the ability to tag a message as an alert and assign a risk triage level via a custom rule language.</li>
+  
+<li><a href="metron-platform/metron-indexing/index.html">Indexing</a> : Indexing the data post-enrichment into HDFS, Elasticsearch or Solr.</li>
+</ul>
+<p>Some useful utilities that cross all of these parts of the architecture:</p>
+
+<ul>
+  
+<li><a href="metron-platform/metron-common/index.html">Stellar</a> : A custom data transformation language that is used throughout metron from simple field transformation to expressing triage rules.</li>
+  
+<li><a href="metron-analytics/metron-maas-service/index.html">Model as a Service</a> : A Yarn application which can deploy machine learning and statistical models onto the cluster along with the associated Stellar functions to be able to call out to them in a scalable manner.</li>
+  
+<li><a href="metron-platform/metron-data-management/index.html">Data management</a> : A set of data management utilities aimed at getting data into HBase in a format which will allow data flowing through metron to be enriched with the results. Contains integrations with threat intelligence feeds exposed via TAXII as well as simple flat file structures.</li>
+  
+<li><a href="metron-analytics/metron-profiler/index.html">Profiler</a> : A feature extraction mechanism that can generate a profile describing the behavior of an entity. An entity might be a server, user, subnet or application. Once a profile has been generated defining what normal behavior looks-like, models can be built that identify anomalous behavior.</li>
+</ul>
+                  </div>
+            </div>
+          </div>
+
+    <hr/>
+
+    <footer>
+            <div class="container-fluid">
+              <div class="row span12">Copyright &copy;                   2017.
+          All Rights Reserved.      
+                    
+      </div>
+
+                          
+        
+                </div>
+    </footer>
+  </body>
+</html>



Mime
View raw message