METRON-1607 update public web site to point at 0.5.0 new release (justinleet) closes apache/metron#1053
Project: http://git-wip-us.apache.org/repos/asf/metron/repo Commit: http://git-wip-us.apache.org/repos/asf/metron/commit/ae1d3eb9 Tree: http://git-wip-us.apache.org/repos/asf/metron/tree/ae1d3eb9 Diff: http://git-wip-us.apache.org/repos/asf/metron/diff/ae1d3eb9 Branch: refs/heads/feature/METRON-1416-upgrade-solr Commit: ae1d3eb9adfa678553c59c8abdc3fe90aaf1a5ae Parents: 1b9828e Author: justinleet <justinjl...@gmail.com> Authored: Fri Jun 8 08:18:15 2018 -0400 Committer: leet <l...@apache.org> Committed: Fri Jun 8 08:18:15 2018 -0400 ---------------------------------------------------------------------- site/current-book/CONTRIBUTING.html | 157 + site/current-book/Upgrading.html | 354 +- .../css/apache-maven-fluido-1.3.0.min.css | 9 - .../css/apache-maven-fluido-1.7.min.css | 17 + site/current-book/css/maven-base.css | 168 + site/current-book/css/maven-theme.css | 161 + site/current-book/css/print.css | 11 +- .../fonts/glyphicons-halflings-regular.eot | Bin 0 -> 35283 bytes .../fonts/glyphicons-halflings-regular.svg | 229 + .../fonts/glyphicons-halflings-regular.ttf | Bin 0 -> 55016 bytes .../fonts/glyphicons-halflings-regular.woff | Bin 0 -> 41793 bytes .../images/apache-maven-project-2.png | Bin 33442 -> 43073 bytes site/current-book/images/collapsed.gif | Bin 0 -> 53 bytes site/current-book/images/expanded.gif | Bin 0 -> 52 bytes site/current-book/images/external.png | Bin 0 -> 230 bytes site/current-book/images/icon_error_sml.gif | Bin 633 -> 1010 bytes site/current-book/images/icon_info_sml.gif | Bin 638 -> 606 bytes site/current-book/images/icon_success_sml.gif | Bin 604 -> 990 bytes site/current-book/images/icon_warning_sml.gif | Bin 625 -> 576 bytes site/current-book/images/newwindow.png | Bin 0 -> 220 bytes site/current-book/index.html | 347 +- .../js/apache-maven-fluido-1.3.0.min.js | 21 - .../js/apache-maven-fluido-1.7.min.js | 25 + site/current-book/metron-analytics/index.html | 303 +- .../metron-maas-service/index.html | 451 +- .../metron-profiler-client/index.html | 888 +- .../metron-analytics/metron-profiler/index.html | 1338 +- .../metron-statistics/HLLP.html | 10962 ++++++----------- .../metron-statistics/index.html | 870 +- .../metron-contrib/metron-docker/index.html | 540 +- .../metron-performance/index.html | 317 + .../Kerberos-ambari-setup.html | 372 +- .../Kerberos-manual-setup.html | 1218 +- .../metron-deployment/amazon-ec2/index.html | 755 +- .../metron-deployment/ansible/index.html | 128 + .../metron-deployment/ansible/roles/index.html | 140 + .../ansible/roles/opentaxii/index.html | 301 + .../ansible/roles/pcap_replay/index.html | 172 + .../ansible/roles/sensor-stubs/index.html | 221 + .../ansible/roles/sensor-test-mode/index.html | 156 + .../development/centos6/index.html | 233 + .../development/fastcapa/index.html | 249 + .../metron-deployment/development/index.html | 137 + .../development/ubuntu14/index.html | 233 + site/current-book/metron-deployment/index.html | 691 +- .../metron-deployment/other-examples/index.html | 363 +- .../manual-install/Manual_Install_CentOS6.html | 1352 +- .../ambari/elasticsearch-mpack/index.html | 190 + .../packaging/ambari/index.html | 1150 +- .../packaging/ambari/metron-mpack/index.html | 337 + .../packaging/docker/ansible-docker/index.html | 432 +- .../packaging/docker/deb-docker/index.html | 194 + .../packaging/docker/rpm-docker/index.html | 430 +- .../packaging/packer-build/index.html | 382 +- .../metron-deployment/roles/index.html | 332 - .../metron-deployment/roles/monit/index.html | 388 - .../roles/opentaxii/index.html | 480 - .../roles/pcap_replay/index.html | 355 - .../roles/sensor-stubs/index.html | 401 - .../roles/sensor-test-mode/index.html | 345 - .../vagrant/codelab-platform/index.html | 383 - .../vagrant/fastcapa-test-platform/index.html | 416 - .../vagrant/full-dev-platform/index.html | 420 - .../metron-deployment/vagrant/index.html | 305 - .../vagrant/quick-dev-platform/index.html | 406 - .../metron-interface/metron-alerts/index.html | 434 +- .../metron-interface/metron-config/index.html | 415 +- .../metron-interface/metron-rest/index.html | 2661 ++-- .../Performance-tuning-guide.html | 1123 +- site/current-book/metron-platform/index.html | 346 +- .../metron-platform/metron-api/index.html | 387 +- .../metron-platform/metron-common/index.html | 877 +- .../metron-data-management/index.html | 1348 +- .../metron-elasticsearch/index.html | 706 +- .../metron-enrichment/Performance.html | 802 ++ .../metron-enrichment/index.html | 760 +- .../metron-platform/metron-indexing/index.html | 547 +- .../metron-management/index.html | 1178 +- .../metron-parsers/3rdPartyParser.html | 467 + .../metron-platform/metron-parsers/index.html | 870 +- .../metron-parsers/parser-testing.html | 434 +- .../metron-pcap-backend/index.html | 503 +- .../metron-platform/metron-writer/index.html | 377 +- .../metron-sensors/bro-plugin-kafka/index.html | 519 - .../metron-sensors/fastcapa/index.html | 1239 +- site/current-book/metron-sensors/index.html | 299 +- .../metron-sensors/pycapa/index.html | 605 +- .../stellar-3rd-party-example/index.html | 263 +- .../stellar-common/3rdPartyStellar.html | 330 +- .../metron-stellar/stellar-common/index.html | 3603 ++---- .../metron-stellar/stellar-zeppelin/index.html | 239 + .../use-cases/forensic_clustering/index.html | 517 +- .../geographic_login_outliers/index.html | 442 +- site/current-book/use-cases/index.html | 283 +- .../use-cases/typosquat_detection/index.html | 545 + site/documentation/index.md | 14 +- 96 files changed, 22303 insertions(+), 32065 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/metron/blob/ae1d3eb9/site/current-book/CONTRIBUTING.html ---------------------------------------------------------------------- diff --git a/site/current-book/CONTRIBUTING.html b/site/current-book/CONTRIBUTING.html new file mode 100644 index 0000000..bb3119e --- /dev/null +++ b/site/current-book/CONTRIBUTING.html @@ -0,0 +1,157 @@ +<!DOCTYPE html> +<!-- + | Generated by Apache Maven Doxia Site Renderer 1.8 from src/site/markdown/CONTRIBUTING.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 – How To Contribute</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 ">How To Contribute</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 class="active"><a href="#"><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-right"></span>Deployment</a></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>How To Contribute</h1> +<p><a name="How_To_Contribute"></a></p> +<p>As an open source project, Metron welcomes contributions of all forms. There are several great ways to contribute!</p> +<ul> + +<li><a href="#Contributing_a_Code_Change">Contributing a Code Change</a></li> +<li>Reviewing pull requests on our GitHub page. Check out current open <a class="externalLink" href="https://github.com/apache/metron/pulls";>Pull Requests</a></li> +<li>Improve our documentation. Our docs are self contained in the project in README files. Doc changes are the same process as a code change. See <a href="#Contributing_a_Code_Change">Contributing a Code Change</a></li> +<li>Contributing to or starting discussions on the mailing lists. Both the user and dev lists are great places to give and receive help, or provide feedback. See <a class="externalLink" href="http://metron.apache.org/community/#mailinglist";>Mailing Lists</a></li> +<li>Filing tickets for features, enhancements, and bugs to our JIRA. Take a look at <a class="externalLink" href="https://cwiki.apache.org/confluence/display/METRON/Reporting+Issues";>Reporting Issues</a> and the <a class="externalLink" href="https://issues.apache.org/jira/projects/METRON";>Metron JIRA</a></li> +</ul> +<div class="section"> +<h2><a name="Contributing_A_Code_Change"></a>Contributing A Code Change</h2> +<ol style="list-style-type: decimal"> + +<li>Open a <a class="externalLink" href="https://issues.apache.org/jira/projects/METRON";>JIRA ticket</a> associated with your change, if one doesn’t already exist. Assign it to yourself and give a good description. +<ul> + +<li>Feel free to ask questions on the lists and collaborate!</li> +</ul> +</li> +<li>Implement your change +<ul> + +<li>We recommend setting up <a class="externalLink" href="https://docs.travis-ci.com";>Travis CI</a> on your personal Github repo to handle long running testing. If the Travis build fails, you’ll want to look into it. See <a class="externalLink" href="https://docs.travis-ci.com/user/getting-started/#To-get-started-with-Travis-CI";>Getting started</a> for instructions.</li> +</ul> +</li> +<li>Open a GitHub <a class="externalLink" href="https://github.com/apache/metron/pulls";>Pull Request</a> with your change +<ul> + +<li>Fork the Metron repo. Look at <a class="externalLink" href="https://help.github.com/articles/fork-a-repo/";>Fork a repo</a></li> +<li>Make the PR. See <a class="externalLink" href="https://help.github.com/articles/creating-a-pull-request-from-a-fork/";>Creating a pull request from a fork</a></li> +<li>Make sure the PR name starts with your JIRA ticket number (METRON-XXXX).</li> +</ul> +</li> +<li>Iterate on your change with reviewers until it’s merged into master.</li> +</ol></div> +<div class="section"> +<h2><a name="Development_Guidelines"></a>Development Guidelines</h2> +<p>The full guidelines can be found on the <a class="externalLink" href="https://cwiki.apache.org/confluence/display/METRON/Development+Guidelines";>Metron wiki</a>. They boil down to</p> +<ol style="list-style-type: decimal"> + +<li>Make sure you’ve tested your change.</li> +<li>Make sure you’ve documented your change.</li> +<li>Follow the <a class="externalLink" href="https://google.github.io/styleguide/javaguide.html";>Google Java Style Guide</a> +<ul> + +<li>If the file is a different style follow that style.</li> +</ul> +</li> +<li>Be open to feedback.</li> +</ol></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/Upgrading.html ---------------------------------------------------------------------- diff --git a/site/current-book/Upgrading.html b/site/current-book/Upgrading.html index 78fe2ac..fac4db1 100644 --- a/site/current-book/Upgrading.html +++ b/site/current-book/Upgrading.html @@ -1,199 +1,109 @@ <!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/Upgrading.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 – Upgrading</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="">Upgrading</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 ">Upgrading</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 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-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-right"></i> - Deployment</a> - </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 class="active"><a href="#"><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-right"></span>Deployment</a></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>Upgrading</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>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.4.2_to_0.5.0"></a>0.4.2 to 0.5.0</h2> +<div class="section"> +<h3><a name="METRON-941:_native_PaloAlto_parser_corrupts_message_when_having_a_comma_in_the_payload"></a><a class="externalLink" href="https://issues.apache.org/jira/browse/METRON-941";>METRON-941: native PaloAlto parser corrupts message when having a comma in the payload</a></h3> +<p>While modifying the PaloAlto log parser to support logs from newer PAN-OS version and to not break when a message payload contains a comma, some field names were changed to extend the coverage, fix some duplicate names and change some field names to the Metron standard message format.</p> +<p>Installations making use of this parser should check, if the resulting messages still meet their expectations and adjust downstream configurations (i.e. ElasticSearch template) accordingly.</p> +<p><i>Note:</i> Previously, the samples for the test contained a full syslog line (including syslog header). This did - and will continue to - create a broken “domain” field in the parsed message. It is recommended to only feed the syslog message part to the parser for now.</p></div></div> +<div class="section"> <h2><a name="a0.4.1_to_0.4.2"></a>0.4.1 to 0.4.2</h2> <div class="section"> <h3><a name="METRON-1277:_STELLAR_Add_Match_functionality_to_language"></a><a class="externalLink" href="https://issues.apache.org/jira/browse/METRON-1277";>METRON-1277: STELLAR Add Match functionality to language</a></h3> -<p>As we continue to evolve the Stellar language, it is possible that new keywords will be added to the language. This may cause compatablity issues where these reserved words and symbols are used in existing scripts.</p> +<p>As we continue to evolve the Stellar language, it is possible that new keywords will be added to the language. This may cause compatablity issues where these reserved words and symbols are used in existing scripts.</p> <p>Adding <tt>match</tt> to the Stellar lanaguage has introduced the following new reserved keywords and symbols:</p> <p><tt>match</tt>, <tt>default</tt>, <tt>{</tt>, <tt>}</tt>, ‘=>’</p> <p>Any stellar expressions which use these keywords not in quotes will need to be modified.</p></div> @@ -203,21 +113,22 @@ <p>Two steps must be done for each sensor, but not on each index for each sensor.</p> <p>First is to update the Elasticsearch template for each sensor, so any new indices have the field:</p> -<div class="source"> -<div class="source"> -<pre>export ELASTICSEARCH="node1" +<div> +<div> +<pre class="source">export ELASTICSEARCH="node1" export SENSOR="bro" curl -XGET "http://${ELASTICSEARCH}:9200/_template/${SENSOR}_index*?pretty=true" -o "${SENSOR}.template" -sed -i '' '2d;$d' ./${SENSOR}.template -sed -i '' '/"properties" : {/ a\ +sed -i '2d;$d' ./${SENSOR}.template +sed -i '/"properties" : {/ a\ "alert": { "type": "nested"},' ${SENSOR}.template curl -XPUT "http://${ELASTICSEARCH}:9200/_template/${SENSOR}_index" -d @${SENSOR}.template </pre></div></div> -<p>To update existing indexes, update Elasticsearch mappings with the new field for each sensor. Make sure to set the ELASTICSEARCH variable appropriately.</p> -<div class="source"> -<div class="source"> -<pre>curl -XPUT "http://${ELASTICSEARCH}:9200/${SENSOR}_index*/_mapping/${SENSOR}_doc" -d ' +<p>To update existing indexes, update Elasticsearch mappings with the new field for each sensor. Make sure to set the ELASTICSEARCH variable appropriately.</p> + +<div> +<div> +<pre class="source">curl -XPUT "http://${ELASTICSEARCH}:9200/${SENSOR}_index*/_mapping/${SENSOR}_doc" -d ' { "properties" : { "alert" : { @@ -228,10 +139,11 @@ curl -XPUT "http://${ELASTICSEARCH}:9200/_template/${SENSOR}_index" -d ' rm ${SENSOR}.template </pre></div></div> + <p>For a more detailed description, please see metron-platform/metron-elasticsearch/README.md</p></div> <div class="section"> <h3><a name="Description"></a>Description</h3> -<p>In the 0.4.2 release, </p></div></div> +<p>In the 0.4.2 release,</p></div></div> <div class="section"> <h2><a name="a0.3.1_to_0.4.0"></a>0.3.1 to 0.4.0</h2> <div class="section"> @@ -242,15 +154,13 @@ rm ${SENSOR}.template <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> +<h3><a name="METRON-664:_Make_the_index_configuration_per-writer_with_enabled.2Fdisabled"></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> @@ -260,18 +170,19 @@ rm ${SENSOR}.template <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>{ +<div> +<div> +<pre class="source">{ "index" : "foo", "batchSize" : 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>{ +<div> +<div> +<pre class="source">{ "elasticsearch" : { "index" : "foo", "batchSize" : 100, @@ -283,25 +194,27 @@ rm ${SENSOR}.template "enabled" : true } } -</pre></div></div></div></div> +</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> +<p>This essentially makes the risk level rules slightly more complex. The format goes from:</p> -<div class="source"> -<div class="source"> -<pre>"riskLevelRules" : { +<div> +<div> +<pre class="source">"riskLevelRules" : { "stellar expression" : numeric score } </pre></div></div> + <p>to:</p> -<div class="source"> -<div class="source"> -<pre>"riskLevelRules" : [ +<div> +<div> +<pre class="source">"riskLevelRules" : [ { "name" : "optional name", "comment" : "optional comment", @@ -309,7 +222,8 @@ rm ${SENSOR}.template "score" : numeric score } ] -</pre></div></div></div> +</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> @@ -324,23 +238,25 @@ rm ${SENSOR}.template <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 <zk_server>:<zk_port> +<div> +<div> +<pre class="source">$METRON_HOME/bin/geo_enrichment_load.sh -z <zk_server>:<zk_port> </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>Additional options, including changing the source file location (which can be a <a class="externalLink" href="file://">file://</a> 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 <zk_server>:<zk_port> -m DUMP +<div> +<div> +<pre class="source">$METRON_HOME/bin/zk_load_configs.sh -z <zk_server>:<zk_port> -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> +<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> @@ -350,9 +266,7 @@ rm ${SENSOR}.template <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’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> +<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’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"> @@ -361,23 +275,17 @@ name conflict, enrichment already defined <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> - </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>
