http://git-wip-us.apache.org/repos/asf/metron/blob/79b38ea2/current-book/metron-deployment/roles/index.html ---------------------------------------------------------------------- diff --git a/current-book/metron-deployment/roles/index.html b/current-book/metron-deployment/roles/index.html index a7cf149..53372ea 100644 --- a/current-book/metron-deployment/roles/index.html +++ b/current-book/metron-deployment/roles/index.html @@ -1,13 +1,13 @@ <!DOCTYPE html> <!-- - | Generated by Apache Maven Doxia at 2017-09-15 + | Generated by Apache Maven Doxia at 2018-01-03 | 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="20170915" /> + <meta name="Date-Revision-yyyymmdd" content="20180103" /> <meta http-equiv="Content-Language" content="en" /> <title>Metron – Ansible Roles</title> <link rel="stylesheet" href="../../css/apache-maven-fluido-1.3.0.min.css" /> @@ -61,8 +61,8 @@ - <li id="publishDate" class="pull-right">Last Published: 2017-09-15</li> <li class="divider pull-right">|</li> - <li id="projectVersion" class="pull-right">Version: 0.4.1</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> </div> @@ -103,7 +103,7 @@ <i class="none"></i> Docker</a> </li> - + <li> <a href="../../metron-deployment/index.html" title="Deployment"> @@ -208,7 +208,7 @@ </li> </ul> </li> - + <li> <a href="../../metron-deployment/vagrant/index.html" title="Vagrant"> @@ -238,20 +238,27 @@ <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> @@ -259,7 +266,7 @@ <i class="icon-chevron-right"></i> Stellar-common</a> </li> - + <li> <a href="../../use-cases/index.html" title="Use-cases"> @@ -311,7 +318,7 @@ <footer> <div class="container-fluid"> - <div class="row span12">Copyright © 2017 + <div class="row span12">Copyright © 2018 <a href="https://www.apache.org";>The Apache Software Foundation</a>. All Rights Reserved.
http://git-wip-us.apache.org/repos/asf/metron/blob/79b38ea2/current-book/metron-deployment/roles/monit/index.html ---------------------------------------------------------------------- diff --git a/current-book/metron-deployment/roles/monit/index.html b/current-book/metron-deployment/roles/monit/index.html index 54c659a..09684dc 100644 --- a/current-book/metron-deployment/roles/monit/index.html +++ b/current-book/metron-deployment/roles/monit/index.html @@ -1,13 +1,13 @@ <!DOCTYPE html> <!-- - | Generated by Apache Maven Doxia at 2017-09-15 + | Generated by Apache Maven Doxia at 2018-01-03 | 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="20170915" /> + <meta name="Date-Revision-yyyymmdd" content="20180103" /> <meta http-equiv="Content-Language" content="en" /> <title>Metron – Monit Integration</title> <link rel="stylesheet" href="../../../css/apache-maven-fluido-1.3.0.min.css" /> @@ -61,8 +61,8 @@ - <li id="publishDate" class="pull-right">Last Published: 2017-09-15</li> <li class="divider pull-right">|</li> - <li id="projectVersion" class="pull-right">Version: 0.4.1</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> </div> @@ -103,7 +103,7 @@ <i class="none"></i> Docker</a> </li> - + <li> <a href="../../../metron-deployment/index.html" title="Deployment"> @@ -208,7 +208,7 @@ </li> </ul> </li> - + <li> <a href="../../../metron-deployment/vagrant/index.html" title="Vagrant"> @@ -238,20 +238,27 @@ <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> @@ -259,7 +266,7 @@ <i class="icon-chevron-right"></i> Stellar-common</a> </li> - + <li> <a href="../../../use-cases/index.html" title="Use-cases"> @@ -367,7 +374,7 @@ <footer> <div class="container-fluid"> - <div class="row span12">Copyright © 2017 + <div class="row span12">Copyright © 2018 <a href="https://www.apache.org";>The Apache Software Foundation</a>. All Rights Reserved. http://git-wip-us.apache.org/repos/asf/metron/blob/79b38ea2/current-book/metron-deployment/roles/opentaxii/index.html ---------------------------------------------------------------------- diff --git a/current-book/metron-deployment/roles/opentaxii/index.html b/current-book/metron-deployment/roles/opentaxii/index.html index 89abff1..29d8700 100644 --- a/current-book/metron-deployment/roles/opentaxii/index.html +++ b/current-book/metron-deployment/roles/opentaxii/index.html @@ -1,13 +1,13 @@ <!DOCTYPE html> <!-- - | Generated by Apache Maven Doxia at 2017-09-15 + | Generated by Apache Maven Doxia at 2018-01-03 | 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="20170915" /> + <meta name="Date-Revision-yyyymmdd" content="20180103" /> <meta http-equiv="Content-Language" content="en" /> <title>Metron – OpenTAXII</title> <link rel="stylesheet" href="../../../css/apache-maven-fluido-1.3.0.min.css" /> @@ -61,8 +61,8 @@ - <li id="publishDate" class="pull-right">Last Published: 2017-09-15</li> <li class="divider pull-right">|</li> - <li id="projectVersion" class="pull-right">Version: 0.4.1</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> </div> @@ -103,7 +103,7 @@ <i class="none"></i> Docker</a> </li> - + <li> <a href="../../../metron-deployment/index.html" title="Deployment"> @@ -208,7 +208,7 @@ </li> </ul> </li> - + <li> <a href="../../../metron-deployment/vagrant/index.html" title="Vagrant"> @@ -238,20 +238,27 @@ <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> @@ -259,7 +266,7 @@ <i class="icon-chevron-right"></i> Stellar-common</a> </li> - + <li> <a href="../../../use-cases/index.html" title="Use-cases"> @@ -459,7 +466,7 @@ taxii-poll --discovery http://hailataxii.com/taxii-data -c guest.phishtank_com - <footer> <div class="container-fluid"> - <div class="row span12">Copyright © 2017 + <div class="row span12">Copyright © 2018 <a href="https://www.apache.org";>The Apache Software Foundation</a>. All Rights Reserved. http://git-wip-us.apache.org/repos/asf/metron/blob/79b38ea2/current-book/metron-deployment/roles/pcap_replay/index.html ---------------------------------------------------------------------- diff --git a/current-book/metron-deployment/roles/pcap_replay/index.html b/current-book/metron-deployment/roles/pcap_replay/index.html index e350bea..22bf7c0 100644 --- a/current-book/metron-deployment/roles/pcap_replay/index.html +++ b/current-book/metron-deployment/roles/pcap_replay/index.html @@ -1,13 +1,13 @@ <!DOCTYPE html> <!-- - | Generated by Apache Maven Doxia at 2017-09-15 + | Generated by Apache Maven Doxia at 2018-01-03 | 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="20170915" /> + <meta name="Date-Revision-yyyymmdd" content="20180103" /> <meta http-equiv="Content-Language" content="en" /> <title>Metron – Pcap Replay</title> <link rel="stylesheet" href="../../../css/apache-maven-fluido-1.3.0.min.css" /> @@ -61,8 +61,8 @@ - <li id="publishDate" class="pull-right">Last Published: 2017-09-15</li> <li class="divider pull-right">|</li> - <li id="projectVersion" class="pull-right">Version: 0.4.1</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> </div> @@ -103,7 +103,7 @@ <i class="none"></i> Docker</a> </li> - + <li> <a href="../../../metron-deployment/index.html" title="Deployment"> @@ -208,7 +208,7 @@ </li> </ul> </li> - + <li> <a href="../../../metron-deployment/vagrant/index.html" title="Vagrant"> @@ -238,20 +238,27 @@ <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> @@ -259,7 +266,7 @@ <i class="icon-chevron-right"></i> Stellar-common</a> </li> - + <li> <a href="../../../use-cases/index.html" title="Use-cases"> @@ -334,7 +341,7 @@ <footer> <div class="container-fluid"> - <div class="row span12">Copyright © 2017 + <div class="row span12">Copyright © 2018 <a href="https://www.apache.org";>The Apache Software Foundation</a>. All Rights Reserved. http://git-wip-us.apache.org/repos/asf/metron/blob/79b38ea2/current-book/metron-deployment/roles/sensor-stubs/index.html ---------------------------------------------------------------------- diff --git a/current-book/metron-deployment/roles/sensor-stubs/index.html b/current-book/metron-deployment/roles/sensor-stubs/index.html index 3756024..436a523 100644 --- a/current-book/metron-deployment/roles/sensor-stubs/index.html +++ b/current-book/metron-deployment/roles/sensor-stubs/index.html @@ -1,13 +1,13 @@ <!DOCTYPE html> <!-- - | Generated by Apache Maven Doxia at 2017-09-15 + | Generated by Apache Maven Doxia at 2018-01-03 | 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="20170915" /> + <meta name="Date-Revision-yyyymmdd" content="20180103" /> <meta http-equiv="Content-Language" content="en" /> <title>Metron – Sensor Stubs</title> <link rel="stylesheet" href="../../../css/apache-maven-fluido-1.3.0.min.css" /> @@ -61,8 +61,8 @@ - <li id="publishDate" class="pull-right">Last Published: 2017-09-15</li> <li class="divider pull-right">|</li> - <li id="projectVersion" class="pull-right">Version: 0.4.1</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> </div> @@ -103,7 +103,7 @@ <i class="none"></i> Docker</a> </li> - + <li> <a href="../../../metron-deployment/index.html" title="Deployment"> @@ -208,7 +208,7 @@ </li> </ul> </li> - + <li> <a href="../../../metron-deployment/vagrant/index.html" title="Vagrant"> @@ -238,20 +238,27 @@ <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> @@ -259,7 +266,7 @@ <i class="icon-chevron-right"></i> Stellar-common</a> </li> - + <li> <a href="../../../use-cases/index.html" title="Use-cases"> @@ -301,7 +308,7 @@ <div class="section"> <h3><a name="aQ_How_do_I_install_the_sensor_stubs"></a>(Q) How do I install the sensor stubs?</h3> <p>Using the default playbooks, this role can be installed by using the Ansible tag <tt>sensor-stubs</tt>. This service is installed on the same hosts where the sensors would be; defined by the <tt>sensors</tt> host group.</p> -<p>The defaults for the “Quick Dev” and “Full Dev” environments have been changed so that the Sensor Stubs are installed by default, rather than the sensors themselves. The Amazon EC2 environment continues to install the original sensors by default.</p></div> +<p>The defaults for the “Full Dev” environment have been changed so that the Sensor Stubs are installed by default, rather than the sensors themselves. The Amazon EC2 environment continues to install the original sensors by default.</p></div> <div class="section"> <h3><a name="aQ_How_do_I_use_the_sensor_stubs"></a>(Q) How do I use the sensor stubs?</h3> <p>Start all sensor stubs. The output includes the PID for each running sensor stub.</p> @@ -362,11 +369,11 @@ Stopping sensor-stubs... </pre></div></div></div> <div class="section"> <h3><a name="aQ_How_do_I_install_the_original_sensors"></a>(Q) How do I install the original sensors?</h3> -<p>The default behavior can be changed by skipping the <tt>sensor-stubs</tt> flag and including the <tt>sensors</tt> flag. For example, to deploy “Quick Dev” with the original sensors run the following command.</p> +<p>The default behavior can be changed by skipping the <tt>sensor-stubs</tt> flag and including the <tt>sensors</tt> flag. For example, to deploy “Full Dev” with the original sensors run the following command.</p> <div class="source"> <div class="source"> -<pre>cd metron-deployment/vagrant/quick-dev-platform +<pre>cd metron-deployment/vagrant/full-dev-platform vagrant --ansible-skip-tags="sensor-stubs,solr" up </pre></div></div></div> <div class="section"> @@ -380,7 +387,7 @@ vagrant --ansible-skip-tags="sensor-stubs,solr" up <footer> <div class="container-fluid"> - <div class="row span12">Copyright © 2017 + <div class="row span12">Copyright © 2018 <a href="https://www.apache.org";>The Apache Software Foundation</a>. All Rights Reserved. http://git-wip-us.apache.org/repos/asf/metron/blob/79b38ea2/current-book/metron-deployment/roles/sensor-test-mode/index.html ---------------------------------------------------------------------- diff --git a/current-book/metron-deployment/roles/sensor-test-mode/index.html b/current-book/metron-deployment/roles/sensor-test-mode/index.html index d6c62c6..bf88d45 100644 --- a/current-book/metron-deployment/roles/sensor-test-mode/index.html +++ b/current-book/metron-deployment/roles/sensor-test-mode/index.html @@ -1,13 +1,13 @@ <!DOCTYPE html> <!-- - | Generated by Apache Maven Doxia at 2017-09-15 + | Generated by Apache Maven Doxia at 2018-01-03 | 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="20170915" /> + <meta name="Date-Revision-yyyymmdd" content="20180103" /> <meta http-equiv="Content-Language" content="en" /> <title>Metron – Sensor Test Mode</title> <link rel="stylesheet" href="../../../css/apache-maven-fluido-1.3.0.min.css" /> @@ -61,8 +61,8 @@ - <li id="publishDate" class="pull-right">Last Published: 2017-09-15</li> <li class="divider pull-right">|</li> - <li id="projectVersion" class="pull-right">Version: 0.4.1</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> </div> @@ -103,7 +103,7 @@ <i class="none"></i> Docker</a> </li> - + <li> <a href="../../../metron-deployment/index.html" title="Deployment"> @@ -208,7 +208,7 @@ </li> </ul> </li> - + <li> <a href="../../../metron-deployment/vagrant/index.html" title="Vagrant"> @@ -238,20 +238,27 @@ <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> @@ -259,7 +266,7 @@ <i class="icon-chevron-right"></i> Stellar-common</a> </li> - + <li> <a href="../../../use-cases/index.html" title="Use-cases"> @@ -324,7 +331,7 @@ <footer> <div class="container-fluid"> - <div class="row span12">Copyright © 2017 + <div class="row span12">Copyright © 2018 <a href="https://www.apache.org";>The Apache Software Foundation</a>. All Rights Reserved. http://git-wip-us.apache.org/repos/asf/metron/blob/79b38ea2/current-book/metron-deployment/vagrant/codelab-platform/index.html ---------------------------------------------------------------------- diff --git a/current-book/metron-deployment/vagrant/codelab-platform/index.html b/current-book/metron-deployment/vagrant/codelab-platform/index.html index 8edf5ac..e4b8eca 100644 --- a/current-book/metron-deployment/vagrant/codelab-platform/index.html +++ b/current-book/metron-deployment/vagrant/codelab-platform/index.html @@ -1,13 +1,13 @@ <!DOCTYPE html> <!-- - | Generated by Apache Maven Doxia at 2017-09-15 + | Generated by Apache Maven Doxia at 2018-01-03 | 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="20170915" /> + <meta name="Date-Revision-yyyymmdd" content="20180103" /> <meta http-equiv="Content-Language" content="en" /> <title>Metron – Developer Image for Apache Metron on Virtualbox</title> <link rel="stylesheet" href="../../../css/apache-maven-fluido-1.3.0.min.css" /> @@ -61,8 +61,8 @@ - <li id="publishDate" class="pull-right">Last Published: 2017-09-15</li> <li class="divider pull-right">|</li> - <li id="projectVersion" class="pull-right">Version: 0.4.1</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> </div> @@ -75,7 +75,7 @@ <ul class="nav nav-list"> <li class="nav-header">User Documentation</li> - + <li> <a href="../../../index.html" title="Metron"> @@ -231,7 +231,7 @@ <i class="none"></i> Rest</a> </li> - + <li> <a href="../../../metron-platform/index.html" title="Platform"> @@ -245,6 +245,13 @@ <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> @@ -252,7 +259,7 @@ <i class="icon-chevron-right"></i> Stellar-common</a> </li> - + <li> <a href="../../../use-cases/index.html" title="Use-cases"> @@ -362,7 +369,7 @@ <footer> <div class="container-fluid"> - <div class="row span12">Copyright © 2017 + <div class="row span12">Copyright © 2018 <a href="https://www.apache.org";>The Apache Software Foundation</a>. All Rights Reserved. http://git-wip-us.apache.org/repos/asf/metron/blob/79b38ea2/current-book/metron-deployment/vagrant/fastcapa-test-platform/index.html ---------------------------------------------------------------------- diff --git a/current-book/metron-deployment/vagrant/fastcapa-test-platform/index.html b/current-book/metron-deployment/vagrant/fastcapa-test-platform/index.html index 7f0c87c..2fcb617 100644 --- a/current-book/metron-deployment/vagrant/fastcapa-test-platform/index.html +++ b/current-book/metron-deployment/vagrant/fastcapa-test-platform/index.html @@ -1,13 +1,13 @@ <!DOCTYPE html> <!-- - | Generated by Apache Maven Doxia at 2017-09-15 + | Generated by Apache Maven Doxia at 2018-01-03 | 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="20170915" /> + <meta name="Date-Revision-yyyymmdd" content="20180103" /> <meta http-equiv="Content-Language" content="en" /> <title>Metron – Fastcapa Test Environment</title> <link rel="stylesheet" href="../../../css/apache-maven-fluido-1.3.0.min.css" /> @@ -61,8 +61,8 @@ - <li id="publishDate" class="pull-right">Last Published: 2017-09-15</li> <li class="divider pull-right">|</li> - <li id="projectVersion" class="pull-right">Version: 0.4.1</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> </div> @@ -103,7 +103,7 @@ <i class="none"></i> Docker</a> </li> - + <li> <a href="../../../metron-deployment/index.html" title="Deployment"> @@ -173,7 +173,7 @@ <i class="icon-chevron-right"></i> Roles</a> </li> - + <li> <a href="../../../metron-deployment/vagrant/index.html" title="Vagrant"> @@ -181,13 +181,6 @@ Vagrant</a> <ul class="nav nav-list"> - <li> - - <a href="../../../metron-deployment/vagrant/codelab-platform/index.html" title="Codelab-platform"> - <i class="none"></i> - Codelab-platform</a> - </li> - <li class="active"> <a href="#"><i class="none"></i>Fastcapa-test-platform</a> @@ -199,13 +192,6 @@ <i class="none"></i> Full-dev-platform</a> </li> - - <li> - - <a href="../../../metron-deployment/vagrant/quick-dev-platform/index.html" title="Quick-dev-platform"> - <i class="none"></i> - Quick-dev-platform</a> - </li> </ul> </li> </ul> @@ -231,20 +217,27 @@ <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> @@ -252,7 +245,7 @@ <i class="icon-chevron-right"></i> Stellar-common</a> </li> - + <li> <a href="../../../use-cases/index.html" title="Use-cases"> @@ -297,7 +290,15 @@ </ul> <div class="section"> <h2><a name="Getting_Started"></a>Getting Started</h2> -<p>Simply run <tt>vagrant up</tt> to launch the environment. Automated tests are executed after provisioning completes to ensure that Fastcapa and the rest of the environment is functioning properly.</p> +<p>The Fastcapa test environment can be executed on different operating systems. There is a sub-directory for each operating system that Fastcapa can be tested on. </p> +<p>To run, simply execute <tt>vagrant up</tt> within the appropriate directory. For example, to run the tests on CentOS 7.1 then execute the following commands.</p> + +<div class="source"> +<div class="source"> +<pre>cd centos-7.1 +vagrant up +</pre></div></div> +<p>Automated tests are executed after provisioning completes to ensure that Fastcapa and the rest of the environment is functioning properly. If you see something like the following, then the tests have passed.</p> <div class="source"> <div class="source"> @@ -314,6 +315,21 @@ TASK [debug] ******************************************************************* ok: [source] => { "msg": "Successfully received a Kafka message from fastcapa!" } +</pre></div></div> +<p>If the deployment process fails mid-course, running <tt>vagrant provision</tt> will continue the process from where it left off. This can sometimes occur when the VM reboots as part of the deployment process. The error might look like the following.</p> + +<div class="source"> +<div class="source"> +<pre>TASK [fastcapa : Restart for modified kernel params] *************************** +fatal: [sink]: UNREACHABLE! => {"changed": false, "msg": "Failed to connect to the host via ssh: Shared connection to 127.0.0.1 closed.\r\n", "unreachable": true} + to retry, use: --limit @/Users/nallen/Development/metron/metron-deployment/vagrant/fastcapa-test-platform/playbook.retry + +PLAY RECAP ********************************************************************* +sink : ok=11 changed=9 unreachable=1 failed=0 +source : ok=29 changed=25 unreachable=0 failed=0 + +Ansible failed to complete successfully. Any error output should be +visible above. Please fix these errors and try again. </pre></div></div></div> <div class="section"> <h2><a name="Going_Deeper"></a>Going Deeper</h2> @@ -352,6 +368,32 @@ service fastcapa status <pre>/usr/hdp/current/kafka-broker/bin/kafka-console-consumer.sh --zookeeper localhost:2181 --topic pcap </pre></div></div> <p>Enter ‘CTRL-C’ to kill the <tt>kafka-console-consumer</tt> process once you are able to see that packets are being sent. These packets will appear to be gibberish in the console. This is the raw binary network packet data after all.</p></div></div> +<div class="section"> +<h2><a name="FAQ"></a>FAQ</h2> +<div class="section"> +<h3><a name="Error_Message:_Timed_out_while_waiting_for_the_machine_to_boot"></a>Error Message: Timed out while waiting for the machine to boot</h3> + +<div class="source"> +<div class="source"> +<pre>Timed out while waiting for the machine to boot. This means that +Vagrant was unable to communicate with the guest machine within +the configured ("config.vm.boot_timeout" value) time period. +If you look above, you should be able to see the error(s) that +Vagrant had when attempting to connect to the machine. These errors +are usually good hints as to what may be wrong. +If you're using a custom box, make sure that networking is properly +working and you're able to connect to the machine. It is a common +problem that networking isn't setup properly in these boxes. +Verify that authentication configurations are also setup properly, +as well. +If the box appears to be booting properly, you may want to increase +the timeout ("config.vm.boot_timeout") value. +➜ centos-7.4 git:(master) ✗ vagrant status +Current machine states: +source running (virtualbox) +sink not created (virtualbox) +</pre></div></div> +<p>If you are unable to launch any of the Fastcapa test environments, which results in a message like the one above, then you may need to upgrade your version of Virtualbox. Success has been reported with versions of VirtualBox 5.1.22+.</p></div></div> </div> </div> </div> @@ -360,7 +402,7 @@ service fastcapa status <footer> <div class="container-fluid"> - <div class="row span12">Copyright © 2017 + <div class="row span12">Copyright © 2018 <a href="https://www.apache.org";>The Apache Software Foundation</a>. All Rights Reserved. http://git-wip-us.apache.org/repos/asf/metron/blob/79b38ea2/current-book/metron-deployment/vagrant/full-dev-platform/index.html ---------------------------------------------------------------------- diff --git a/current-book/metron-deployment/vagrant/full-dev-platform/index.html b/current-book/metron-deployment/vagrant/full-dev-platform/index.html index 401a3ac..bee92c5 100644 --- a/current-book/metron-deployment/vagrant/full-dev-platform/index.html +++ b/current-book/metron-deployment/vagrant/full-dev-platform/index.html @@ -1,13 +1,13 @@ <!DOCTYPE html> <!-- - | Generated by Apache Maven Doxia at 2017-09-15 + | Generated by Apache Maven Doxia at 2018-01-03 | 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="20170915" /> + <meta name="Date-Revision-yyyymmdd" content="20180103" /> <meta http-equiv="Content-Language" content="en" /> <title>Metron – Full Development Platform</title> <link rel="stylesheet" href="../../../css/apache-maven-fluido-1.3.0.min.css" /> @@ -61,8 +61,8 @@ - <li id="publishDate" class="pull-right">Last Published: 2017-09-15</li> <li class="divider pull-right">|</li> - <li id="projectVersion" class="pull-right">Version: 0.4.1</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> </div> @@ -103,7 +103,7 @@ <i class="none"></i> Docker</a> </li> - + <li> <a href="../../../metron-deployment/index.html" title="Deployment"> @@ -173,7 +173,7 @@ <i class="icon-chevron-right"></i> Roles</a> </li> - + <li> <a href="../../../metron-deployment/vagrant/index.html" title="Vagrant"> @@ -183,13 +183,6 @@ <li> - <a href="../../../metron-deployment/vagrant/codelab-platform/index.html" title="Codelab-platform"> - <i class="none"></i> - Codelab-platform</a> - </li> - - <li> - <a href="../../../metron-deployment/vagrant/fastcapa-test-platform/index.html" title="Fastcapa-test-platform"> <i class="none"></i> Fastcapa-test-platform</a> @@ -199,13 +192,6 @@ <a href="#"><i class="none"></i>Full-dev-platform</a> </li> - - <li> - - <a href="../../../metron-deployment/vagrant/quick-dev-platform/index.html" title="Quick-dev-platform"> - <i class="none"></i> - Quick-dev-platform</a> - </li> </ul> </li> </ul> @@ -231,20 +217,27 @@ <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> @@ -252,7 +245,7 @@ <i class="icon-chevron-right"></i> Stellar-common</a> </li> - + <li> <a href="../../../use-cases/index.html" title="Use-cases"> @@ -320,7 +313,8 @@ <div class="source"> <div class="source"> -<pre>brew cask install vagrant virtualbox java docker +<pre>brew cask install vagrant virtualbox docker +brew cask install caskroom/versions/java8 brew install [email protected] git pip install ansible==2.2.2.0 vagrant plugin install vagrant-hostmanager @@ -412,7 +406,7 @@ vagrant up <footer> <div class="container-fluid"> - <div class="row span12">Copyright © 2017 + <div class="row span12">Copyright © 2018 <a href="https://www.apache.org";>The Apache Software Foundation</a>. All Rights Reserved. http://git-wip-us.apache.org/repos/asf/metron/blob/79b38ea2/current-book/metron-deployment/vagrant/index.html ---------------------------------------------------------------------- diff --git a/current-book/metron-deployment/vagrant/index.html b/current-book/metron-deployment/vagrant/index.html index 8a29917..744ea5b 100644 --- a/current-book/metron-deployment/vagrant/index.html +++ b/current-book/metron-deployment/vagrant/index.html @@ -1,13 +1,13 @@ <!DOCTYPE html> <!-- - | Generated by Apache Maven Doxia at 2017-09-15 + | Generated by Apache Maven Doxia at 2018-01-03 | 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="20170915" /> + <meta name="Date-Revision-yyyymmdd" content="20180103" /> <meta http-equiv="Content-Language" content="en" /> <title>Metron – Vagrant Deployment</title> <link rel="stylesheet" href="../../css/apache-maven-fluido-1.3.0.min.css" /> @@ -61,8 +61,8 @@ - <li id="publishDate" class="pull-right">Last Published: 2017-09-15</li> <li class="divider pull-right">|</li> - <li id="projectVersion" class="pull-right">Version: 0.4.1</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> </div> @@ -103,7 +103,7 @@ <i class="none"></i> Docker</a> </li> - + <li> <a href="../../metron-deployment/index.html" title="Deployment"> @@ -173,7 +173,7 @@ <i class="icon-chevron-right"></i> Roles</a> </li> - + <li class="active"> <a href="#"><i class="icon-chevron-down"></i>Vagrant</a> @@ -181,13 +181,6 @@ <li> - <a href="../../metron-deployment/vagrant/codelab-platform/index.html" title="Codelab-platform"> - <i class="none"></i> - Codelab-platform</a> - </li> - - <li> - <a href="../../metron-deployment/vagrant/fastcapa-test-platform/index.html" title="Fastcapa-test-platform"> <i class="none"></i> Fastcapa-test-platform</a> @@ -199,13 +192,6 @@ <i class="none"></i> Full-dev-platform</a> </li> - - <li> - - <a href="../../metron-deployment/vagrant/quick-dev-platform/index.html" title="Quick-dev-platform"> - <i class="none"></i> - Quick-dev-platform</a> - </li> </ul> </li> </ul> @@ -231,20 +217,27 @@ <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> @@ -252,7 +245,7 @@ <i class="icon-chevron-right"></i> Stellar-common</a> </li> - + <li> <a href="../../use-cases/index.html" title="Use-cases"> @@ -286,13 +279,9 @@ <ul> -<li>Codelab Platform</li> - <li>Fast CAPA Test Platform</li> <li>Full Dev Platform</li> - -<li>Quick Dev Platform</li> </ul> </div> </div> @@ -302,7 +291,7 @@ <footer> <div class="container-fluid"> - <div class="row span12">Copyright © 2017 + <div class="row span12">Copyright © 2018 <a href="https://www.apache.org";>The Apache Software Foundation</a>. All Rights Reserved. http://git-wip-us.apache.org/repos/asf/metron/blob/79b38ea2/current-book/metron-deployment/vagrant/quick-dev-platform/index.html ---------------------------------------------------------------------- diff --git a/current-book/metron-deployment/vagrant/quick-dev-platform/index.html b/current-book/metron-deployment/vagrant/quick-dev-platform/index.html index 136b790..f72df78 100644 --- a/current-book/metron-deployment/vagrant/quick-dev-platform/index.html +++ b/current-book/metron-deployment/vagrant/quick-dev-platform/index.html @@ -1,13 +1,13 @@ <!DOCTYPE html> <!-- - | Generated by Apache Maven Doxia at 2017-09-15 + | Generated by Apache Maven Doxia at 2018-01-03 | 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="20170915" /> + <meta name="Date-Revision-yyyymmdd" content="20180103" /> <meta http-equiv="Content-Language" content="en" /> <title>Metron – Quick Development Platform</title> <link rel="stylesheet" href="../../../css/apache-maven-fluido-1.3.0.min.css" /> @@ -61,8 +61,8 @@ - <li id="publishDate" class="pull-right">Last Published: 2017-09-15</li> <li class="divider pull-right">|</li> - <li id="projectVersion" class="pull-right">Version: 0.4.1</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> </div> @@ -75,7 +75,7 @@ <ul class="nav nav-list"> <li class="nav-header">User Documentation</li> - + <li> <a href="../../../index.html" title="Metron"> @@ -231,7 +231,7 @@ <i class="none"></i> Rest</a> </li> - + <li> <a href="../../../metron-platform/index.html" title="Platform"> @@ -245,6 +245,13 @@ <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> @@ -252,7 +259,7 @@ <i class="icon-chevron-right"></i> Stellar-common</a> </li> - + <li> <a href="../../../use-cases/index.html" title="Use-cases"> @@ -385,7 +392,7 @@ vagrant up <footer> <div class="container-fluid"> - <div class="row span12">Copyright © 2017 + <div class="row span12">Copyright © 2018 <a href="https://www.apache.org";>The Apache Software Foundation</a>. All Rights Reserved. http://git-wip-us.apache.org/repos/asf/metron/blob/79b38ea2/current-book/metron-interface/metron-alerts/index.html ---------------------------------------------------------------------- diff --git a/current-book/metron-interface/metron-alerts/index.html b/current-book/metron-interface/metron-alerts/index.html index cbfbe36..cf30176 100644 --- a/current-book/metron-interface/metron-alerts/index.html +++ b/current-book/metron-interface/metron-alerts/index.html @@ -1,13 +1,13 @@ <!DOCTYPE html> <!-- - | Generated by Apache Maven Doxia at 2017-09-15 + | Generated by Apache Maven Doxia at 2018-01-03 | 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="20170915" /> + <meta name="Date-Revision-yyyymmdd" content="20180103" /> <meta http-equiv="Content-Language" content="en" /> <title>Metron – </title> <link rel="stylesheet" href="../../css/apache-maven-fluido-1.3.0.min.css" /> @@ -61,8 +61,8 @@ - <li id="publishDate" class="pull-right">Last Published: 2017-09-15</li> <li class="divider pull-right">|</li> - <li id="projectVersion" class="pull-right">Version: 0.4.1</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> </div> @@ -103,7 +103,7 @@ <i class="none"></i> Docker</a> </li> - + <li> <a href="../../metron-deployment/index.html" title="Deployment"> @@ -129,20 +129,27 @@ <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> @@ -150,7 +157,7 @@ <i class="icon-chevron-right"></i> Stellar-common</a> </li> - + <li> <a href="../../use-cases/index.html" title="Use-cases"> @@ -195,127 +202,164 @@ </ul> <div class="section"> <h2><a name="Caveats"></a>Caveats</h2> - -<ul> - -<li>UI doesn’t have an authentication module yet</li> - -<li>UI uses local storage to save all the data. A middleware needs to be designed and developed for persisting the data</li> -</ul></div> +<div class="section"> +<h3><a name="Local_Storage"></a>Local Storage</h3> +<p>UI uses local storage to save all the data. A middleware needs to be designed and developed for persisting the data</p></div> +<div class="section"> +<h3><a name="Search_for_Alert_GUIDs"></a>Search for Alert GUIDs</h3> +<p>Alert GUIDs must be double-quoted when being searched on to ensure correctness of results, e.g. guid:“id1”.</p></div> +<div class="section"> +<h3><a name="Search_for_Comments"></a>Search for Comments</h3> +<p>Users cannot search for the contents of the comment’s in the Alerts-UI</p></div> +<div class="section"> +<h3><a name="Meta_alerts"></a>Meta alerts</h3> +<p>Grouping/faceting requests and other aggregations do not return meta alerts. This is because it’s not clear what the intended results should be when there are multiple matching items.</p> +<p>Sorting has a similar caveat, in that if we are matching on multiple alerts, there is no well defined sort.</p> +<p>Alerts that are contained in a a meta alert are generally excluded from search results, because a user has already grouped them in a meaningful way.</p></div></div> <div class="section"> <h2><a name="Prerequisites"></a>Prerequisites</h2> <ul> -<li>Elastic search should be up and running and should have some alerts populated by metron topologies</li> +<li>The Metron REST application should be up and running and Elasticsearch should have some alerts populated by Metron topologies</li> -<li>The alerts can be populated using Quick Dev, Full Dev or any other setup</li> +<li>The Management UI should be installed (which includes <a class="externalLink" href="https://expressjs.com/";>Express</a>)</li> + +<li>The alerts can be populated using Full Dev or any other setup</li> <li>UI is developed using angular4 and uses angular-cli</li> <li>node.JS >= 7.8.0</li> </ul></div> <div class="section"> -<h2><a name="Development_Setup"></a>Development Setup</h2> +<h2><a name="Installation"></a>Installation</h2> +<div class="section"> +<h3><a name="From_Source"></a>From Source</h3> <ol style="list-style-type: decimal"> <li> -<p>Install all the dependent node_modules using the following command</p> +<p>Package the application with Maven:</p> <div class="source"> <div class="source"> -<pre>cd metron/metron-interface/metron-alerts -npm install +<pre>cd metron-interface/metron-alerts +mvn clean package </pre></div></div></li> <li> -<p>UI can be run by using the following command</p> +<p>Untar the archive in the $METRON_HOME directory. The directory structure will look like:</p> <div class="source"> <div class="source"> -<pre>./scripts/start-dev.sh +<pre>bin + metron-alerts-ui +web + expressjs + alerts-server.js + alerts-ui + web assets (html, css, js, ...) </pre></div></div></li> -<li>You can view the GUI @http://localhost:4200 . The default credentials for login are admin/password</li> -</ol> -<p><b>NOTE</b>: <i>In the development mode ui by default connects to ES at <a class="externalLink" href="http://node1:9200";>http://node1:9200</a> for fetching data. If you wish to change it you can change the ES url at metron/metron-interface/metron-alerts/proxy.conf.json</i></p></div> +<li> +<p>Copy the <tt>$METRON_HOME/bin/metron-alerts-ui</tt> script to <tt>/etc/init.d/metron-alerts-ui</tt></p></li> + +<li> +<p><a class="externalLink" href="https://expressjs.com/";>Express</a> is installed at <tt>$METRON_HOME/web/expressjs/</tt> as part of the Management UI installation process. The Management UI should be installed first on the same host as the Alerts UI.</p></li> +</ol></div> <div class="section"> -<h2><a name="E2E_Tests"></a>E2E Tests</h2> -<p>An expressjs server is available for mocking the elastic search api.</p> +<h3><a name="From_Package_Manager"></a>From Package Manager</h3> <ol style="list-style-type: decimal"> <li> -<p>Run e2e webserver :</p> +<p>Deploy the RPM at <tt>/metron/metron-deployment/packaging/docker/rpm-docker/target/RPMS/noarch/metron-alerts-$METRON_VERSION-*.noarch.rpm</tt></p></li> + +<li> +<p>Install the RPM with:</p> <div class="source"> <div class="source"> -<pre>cd metron/metron-interface/metron-alerts -sh ./scripts/start-server-for-e2e.sh +<pre>rpm -ih metron-alerts-$METRON_VERSION-*.noarch.rpm </pre></div></div></li> +</ol></div> +<div class="section"> +<h3><a name="From_Ambari_MPack"></a>From Ambari MPack</h3> +<p>The Alerts UI is included in the Metron Ambari MPack. It can be accessed through the Quick Links in the Metron service.</p></div></div> +<div class="section"> +<h2><a name="Configuration"></a>Configuration</h2> +<p>The Alerts UI is configured in the <tt>$METRON_HOME/config/alerts_ui.yml</tt> file. Create this file and set the values to match your environment:</p> + +<div class="source"> +<div class="source"> +<pre>port: port the alerts UI will run on + +rest: + host: REST application host + port: REST applciation port +</pre></div></div></div> +<div class="section"> +<h2><a name="Usage"></a>Usage</h2> +<p>After configuration is complete, the Management UI can be managed as a service:</p> + +<div class="source"> +<div class="source"> +<pre>service metron-alerts-ui start +</pre></div></div> +<p>The application will be available at <a class="externalLink" href="http://host:4201";>http://host:4201</a> assuming the port is set to <tt>4201</tt>. Logs can be found at <tt>/var/log/metron/metron-alerts-ui.log</tt>.</p></div> +<div class="section"> +<h2><a name="Development_Setup"></a>Development Setup</h2> + +<ol style="list-style-type: decimal"> <li> -<p>run e2e test using the following command</p> +<p>Install all the dependent node_modules using the following command</p> <div class="source"> <div class="source"> <pre>cd metron/metron-interface/metron-alerts -npm run e2e +npm install </pre></div></div></li> <li> -<p>E2E tests uses data from full-dev wherever applicable. The tests assume rest-api’s are available @http://node1:8082</p></li> +<p>UI can be run by using the following command</p> + +<div class="source"> +<div class="source"> +<pre>./scripts/start-dev.sh +</pre></div></div></li> + +<li>You can view the GUI @http://localhost:4201. The default credentials for login are admin/password</li> </ol> -<p><b>NOTE</b>: <i>e2e tests covers all the general workflows and we will extend them as we need</i></p></div> +<p><b>NOTE</b>: <i>In the development mode ui by default connects to REST at <a class="externalLink" href="http://node1:8082";>http://node1:8082</a> for fetching data. If you wish to change it you can change the REST url at metron/metron-interface/metron-alerts/proxy.conf.json</i></p></div> <div class="section"> -<h2><a name="Mpack_Integration"></a>Mpack Integration</h2> -<p>Yet to come</p></div> -<div class="section"> -<h2><a name="Installing_on_an_existing_Cluster"></a>Installing on an existing Cluster</h2> +<h2><a name="E2E_Tests"></a>E2E Tests</h2> +<p>An expressjs server is available for mocking the elastic search api.</p> <ol style="list-style-type: decimal"> <li> -<p>Build Metron:</p> +<p>Run e2e webserver :</p> <div class="source"> <div class="source"> -<pre>mvn clean package -DskipTests +<pre>cd metron/metron-interface/metron-alerts +sh ./scripts/start-server-for-e2e.sh </pre></div></div></li> <li> -<p>Copy <tt>metron/metron-interface/metron-alerts/target/metron-alerts-METRON_VERSION-archive.tar.gz</tt> to the desired host.</p></li> - -<li> -<p>Untar the archive in the target directory. The directory structure will look like:</p> +<p>run e2e test using the following command</p> <div class="source"> <div class="source"> -<pre>bin - start_alerts_ui.sh -web - alerts-ui - package.json - server.js - web assets (html, css, js, ...) +<pre>cd metron/metron-interface/metron-alerts +npm run e2e </pre></div></div></li> <li> -<p><a class="externalLink" href="https://github.com/expressjs/express";>Expressjs</a> webserver script is included in the build that will serve the application. (The script has few rewrite rules and we can replace expressjs with any other webserver)</p></li> - -<li> -<p>Then start the application with the script:</p> - -<div class="source"> -<div class="source"> -<pre>./bin/start_alerts_ui.sh -Usage: server.js -p [port] -r [restUrl] -Options: - -p Port to run metron alerts ui [required] - -r, --resturl Url where elastic search rest api is available [required] -</pre></div></div></li> -</ol></div> +<p>E2E tests uses data from full-dev wherever applicable. The tests assume rest-api’s are available @http://node1:8082</p></li> +</ol> +<p><b>NOTE</b>: <i>e2e tests covers all the general workflows and we will extend them as we need</i></p></div> </div> </div> </div> @@ -324,7 +368,7 @@ Options: <footer> <div class="container-fluid"> - <div class="row span12">Copyright © 2017 + <div class="row span12">Copyright © 2018 <a href="https://www.apache.org";>The Apache Software Foundation</a>. All Rights Reserved.
