Added: release/metron/0.4.1/site-book/metron-deployment/vagrant/quick-dev-platform/index.html ============================================================================== --- release/metron/0.4.1/site-book/metron-deployment/vagrant/quick-dev-platform/index.html (added) +++ release/metron/0.4.1/site-book/metron-deployment/vagrant/quick-dev-platform/index.html Fri Sep 15 23:37:46 2017 @@ -0,0 +1,399 @@ +<!DOCTYPE html> +<!-- + | Generated by Apache Maven Doxia at 2017-09-08 + | 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="20170908" /> + <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" /> + <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> + <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="">Quick Development Platform</li> + + + + <li id="publishDate" class="pull-right">Last Published: 2017-09-08</li> <li class="divider pull-right">|</li> + <li id="projectVersion" class="pull-right">Version: 0.4.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> + + <a href="../../../Upgrading.html" title="Upgrading"> + <i class="none"></i> + Upgrading</a> + </li> + + <li> + + <a href="../../../metron-analytics/index.html" title="Analytics"> + <i class="icon-chevron-right"></i> + Analytics</a> + </li> + + <li> + + <a href="../../../metron-contrib/metron-docker/index.html" title="Docker"> + <i class="none"></i> + Docker</a> + </li> + + <li> + + <a href="../../../metron-deployment/index.html" title="Deployment"> + <i class="icon-chevron-down"></i> + Deployment</a> + <ul class="nav nav-list"> + + <li> + + <a href="../../../metron-deployment/Kerberos-ambari-setup.html" title="Kerberos-ambari-setup"> + <i class="none"></i> + Kerberos-ambari-setup</a> + </li> + + <li> + + <a href="../../../metron-deployment/Kerberos-manual-setup.html" title="Kerberos-manual-setup"> + <i class="none"></i> + Kerberos-manual-setup</a> + </li> + + <li> + + <a href="../../../metron-deployment/amazon-ec2/index.html" title="Amazon-ec2"> + <i class="none"></i> + Amazon-ec2</a> + </li> + + <li> + + <a href="../../../metron-deployment/other-examples/index.html" title="Other-examples"> + <i class="icon-chevron-right"></i> + Other-examples</a> + </li> + + <li> + + <a href="../../../metron-deployment/packaging/ambari/index.html" title="Ambari"> + <i class="none"></i> + Ambari</a> + </li> + + <li> + + <a href="../../../metron-deployment/packaging/docker/ansible-docker/index.html" title="Ansible-docker"> + <i class="none"></i> + Ansible-docker</a> + </li> + + <li> + + <a href="../../../metron-deployment/packaging/docker/rpm-docker/index.html" title="Rpm-docker"> + <i class="none"></i> + Rpm-docker</a> + </li> + + <li> + + <a href="../../../metron-deployment/packaging/packer-build/index.html" title="Packer-build"> + <i class="none"></i> + Packer-build</a> + </li> + + <li> + + <a href="../../../metron-deployment/roles/index.html" title="Roles"> + <i class="icon-chevron-right"></i> + Roles</a> + </li> + + <li> + + <a href="../../../metron-deployment/vagrant/index.html" title="Vagrant"> + <i class="icon-chevron-down"></i> + 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> + + <a href="../../../metron-deployment/vagrant/fastcapa-test-platform/index.html" title="Fastcapa-test-platform"> + <i class="none"></i> + Fastcapa-test-platform</a> + </li> + + <li> + + <a href="../../../metron-deployment/vagrant/full-dev-platform/index.html" title="Full-dev-platform"> + <i class="none"></i> + Full-dev-platform</a> + </li> + + <li class="active"> + + <a href="#"><i class="none"></i>Quick-dev-platform</a> + </li> + </ul> + </li> + </ul> + </li> + + <li> + + <a href="../../../metron-interface/metron-alerts/index.html" title="Alerts"> + <i class="none"></i> + Alerts</a> + </li> + + <li> + + <a href="../../../metron-interface/metron-config/index.html" title="Config"> + <i class="none"></i> + Config</a> + </li> + + <li> + + <a href="../../../metron-interface/metron-rest/index.html" title="Rest"> + <i class="none"></i> + Rest</a> + </li> + + <li> + + <a href="../../../metron-platform/index.html" title="Platform"> + <i class="icon-chevron-right"></i> + Platform</a> + </li> + + <li> + + <a href="../../../metron-sensors/index.html" title="Sensors"> + <i class="icon-chevron-right"></i> + Sensors</a> + </li> + + <li> + + <a href="../../../metron-stellar/stellar-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> + </div> + </div> + + + <div id="bodyColumn" class="span9" > + + <h1>Quick Development Platform</h1> +<p>This project fully automates the provisioning and deployment of Apache Metron and all necessary prerequisites on a single, virtualized host running on Virtualbox. </p> +<p>This image is designed for quick deployment of a single node Metron cluster running on Virtualbox. This platform is ideal for use by Metron developers. It uses a base image that has been pre-loaded with Ambari and HDP.</p> +<p>Metron is composed of many components and installing all of these on a single host, especially a virtualized one, will greatly stress the resources of the host. The host will require at least 8 GB of RAM and a fair amount of patience. It is highly recommended that you shut down all unnecessary services. To that end the vagrant file configuration defaults to disabling solr and yaf.</p> +<div class="section"> +<h2><a name="Getting_Started"></a>Getting Started</h2> +<div class="section"> +<h3><a name="Prerequisites"></a>Prerequisites</h3> +<p>As with the Full Development Platform (<tt>metron-deployment/vagrant/full-dev-platform</tt>), the computer used to deploy Apache Metron will need the following components installed.</p> + +<ul> + +<li><a class="externalLink" href="https://github.com/ansible/ansible";>Ansible</a> (2.0.0.2 or 2.2.2.0)</li> + +<li><a class="externalLink" href="https://www.docker.com/community-edition";>Docker</a></li> + +<li><a class="externalLink" href="https://www.vagrantup.com";>Vagrant</a> 1.8.1</li> + +<li><a class="externalLink" href="https://github.com/devopsgroup-io/vagrant-hostmanager";>Vagrant Hostmanager Plugin</a> <tt>vagrant plugin install vagrant-hostmanager</tt></li> + +<li><a class="externalLink" href="https://virtualbox.org";>Virtualbox</a> 5.0.16</li> + +<li>Python 2.7.11</li> + +<li>Maven 3.3.9</li> +</ul> +<div class="section"> +<h4><a name="macOS"></a>macOS</h4> +<p>Any platform that supports these tools is suitable, but the following instructions cover installation on macOS. The easiest means of installing these tools on a Mac is to use the excellent <a class="externalLink" href="http://brew.sh/";>Homebrew</a> project.</p> + +<ol style="list-style-type: decimal"> + +<li> +<p>Install Homebrew by following the instructions at <a class="externalLink" href="http://brew.sh/";>Homebrew</a>.</p></li> + +<li> +<p>Run the following command in a terminal to install all of the required tools.</p> + +<div class="source"> +<div class="source"> +<pre> brew cask install vagrant virtualbox java docker + brew install maven git +</pre></div></div></li> + +<li> +<p>Install Ansible by following the instructions <a class="externalLink" href="http://docs.ansible.com/ansible/intro_installation.html#latest-releases-via-pip";>here</a>.</p></li> +</ol></div></div> +<div class="section"> +<h3><a name="Deploy_Metron"></a>Deploy Metron</h3> + +<ol style="list-style-type: decimal"> + +<li> +<p>Ensure that the Docker service is running.</p></li> + +<li> +<p>Deploy Metron</p> + +<div class="source"> +<div class="source"> +<pre>cd metron-deployment/vagrant/quick-dev-platform +vagrant up +</pre></div></div> +<p>Should the process fail before completing the deployment, the following command will continue the deployment process without re-instantiating the host.</p> + +<div class="source"> +<div class="source"> +<pre>vagrant provision +</pre></div></div></li> +</ol></div> +<div class="section"> +<h3><a name="Explore_Metron"></a>Explore Metron</h3> +<p>Navigate to the following resources to explore your newly minted Apache Metron environment.</p> + +<ul> + +<li><a class="externalLink" href="http://node1:8080";>Ambari</a></li> + +<li><a class="externalLink" href="http://node1:5000";>Metron</a></li> + +<li><a class="externalLink" href="http://node1:2812";>Services</a></li> +</ul></div> +<div class="section"> +<h3><a name="Working_with_Metron"></a>Working with Metron</h3> +<p>As you build out new capabilities for Metron, you will need to re-deploy the Storm topologies. To do so, first HALT the running Storm topologies and then run the following command.</p> + +<div class="source"> +<div class="source"> +<pre>./run_enrichment_role.sh +</pre></div></div> +<p>Connecting to the host through SSH is as simple as running the following command.</p> + +<div class="source"> +<div class="source"> +<pre>vagrant ssh +</pre></div></div></div></div> + </div> + </div> + </div> + + <hr/> + + <footer> + <div class="container-fluid"> + <div class="row span12">Copyright © 2017 + <a href="https://www.apache.org";>The Apache Software Foundation</a>. + All Rights Reserved. + + </div> + + + + </div> + </footer> + </body> +</html>
Added: release/metron/0.4.1/site-book/metron-interface/metron-alerts/index.html ============================================================================== --- release/metron/0.4.1/site-book/metron-interface/metron-alerts/index.html (added) +++ release/metron/0.4.1/site-book/metron-interface/metron-alerts/index.html Fri Sep 15 23:37:46 2017 @@ -0,0 +1,338 @@ +<!DOCTYPE html> +<!-- + | Generated by Apache Maven Doxia at 2017-09-08 + | 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="20170908" /> + <meta http-equiv="Content-Language" content="en" /> + <title>Metron – </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.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=""></li> + + + + <li id="publishDate" class="pull-right">Last Published: 2017-09-08</li> <li class="divider pull-right">|</li> + <li id="projectVersion" class="pull-right">Version: 0.4.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> + + <a href="../../Upgrading.html" title="Upgrading"> + <i class="none"></i> + Upgrading</a> + </li> + + <li> + + <a href="../../metron-analytics/index.html" title="Analytics"> + <i class="icon-chevron-right"></i> + Analytics</a> + </li> + + <li> + + <a href="../../metron-contrib/metron-docker/index.html" title="Docker"> + <i class="none"></i> + Docker</a> + </li> + + <li> + + <a href="../../metron-deployment/index.html" title="Deployment"> + <i class="icon-chevron-right"></i> + Deployment</a> + </li> + + <li class="active"> + + <a href="#"><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-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> + </div> + </div> + + + <div id="bodyColumn" class="span9" > + + <ul> + +<li><a href="#Caveats">Caveats</a></li> + +<li><a href="#Prerequisites">Prerequisites</a></li> + +<li><a href="#Development_Setup">Development Setup</a></li> + +<li><a href="#E2E_Tests">E2E Tests</a></li> + +<li><a href="#Mpack_Integration">Mpack Integration</a></li> + +<li><a href="#Installing_on_an_existing_Cluster">Installing on an existing Cluster</a></li> +</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"> +<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 alerts can be populated using Quick Dev, 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> + +<ol style="list-style-type: decimal"> + +<li> +<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 install +</pre></div></div></li> + +<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: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> +<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> + +<ol style="list-style-type: decimal"> + +<li> +<p>Run e2e webserver :</p> + +<div class="source"> +<div class="source"> +<pre>cd metron/metron-interface/metron-alerts +sh ./scripts/start-server-for-e2e.sh +</pre></div></div></li> + +<li> +<p>run e2e test using the following command</p> + +<div class="source"> +<div class="source"> +<pre>cd metron/metron-interface/metron-alerts +npm run e2e +</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> +</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 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> + +<ol style="list-style-type: decimal"> + +<li> +<p>Build Metron:</p> + +<div class="source"> +<div class="source"> +<pre>mvn clean package -DskipTests +</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> + +<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></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> + </div> + </div> + </div> + + <hr/> + + <footer> + <div class="container-fluid"> + <div class="row span12">Copyright © 2017 + <a href="https://www.apache.org";>The Apache Software Foundation</a>. + All Rights Reserved. + + </div> + + + + </div> + </footer> + </body> +</html> Added: release/metron/0.4.1/site-book/metron-interface/metron-config/index.html ============================================================================== --- release/metron/0.4.1/site-book/metron-interface/metron-config/index.html (added) +++ release/metron/0.4.1/site-book/metron-interface/metron-config/index.html Fri Sep 15 23:37:46 2017 @@ -0,0 +1,341 @@ +<!DOCTYPE html> +<!-- + | Generated by Apache Maven Doxia at 2017-09-08 + | 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="20170908" /> + <meta http-equiv="Content-Language" content="en" /> + <title>Metron – Metron Management UI</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.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="">Metron Management UI</li> + + + + <li id="publishDate" class="pull-right">Last Published: 2017-09-08</li> <li class="divider pull-right">|</li> + <li id="projectVersion" class="pull-right">Version: 0.4.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> + + <a href="../../Upgrading.html" title="Upgrading"> + <i class="none"></i> + Upgrading</a> + </li> + + <li> + + <a href="../../metron-analytics/index.html" title="Analytics"> + <i class="icon-chevron-right"></i> + Analytics</a> + </li> + + <li> + + <a href="../../metron-contrib/metron-docker/index.html" title="Docker"> + <i class="none"></i> + Docker</a> + </li> + + <li> + + <a href="../../metron-deployment/index.html" title="Deployment"> + <i class="icon-chevron-right"></i> + Deployment</a> + </li> + + <li> + + <a href="../../metron-interface/metron-alerts/index.html" title="Alerts"> + <i class="none"></i> + Alerts</a> + </li> + + <li class="active"> + + <a href="#"><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-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> + </div> + </div> + + + <div id="bodyColumn" class="span9" > + + <h1>Metron Management UI</h1> +<p><a name="Metron_Management_UI"></a></p> +<p>This module provides a user interface for management functions in Metron.</p> +<div class="section"> +<h2><a name="Prerequisites"></a>Prerequisites</h2> + +<ul> + +<li>A network accessible Metron REST application</li> + +<li>nodejs v6.9+ (nodejs can be installed on quick dev with <tt>curl --silent --location https://rpm.nodesource.com/setup_6.x | bash - && yum install -y nodejs</tt>)</li> +</ul></div> +<div class="section"> +<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>Package the application with Maven:</p> + +<div class="source"> +<div class="source"> +<pre>cd metron-interface/metron-config +mvn clean package +</pre></div></div></li> + +<li> +<p>Untar the archive in the $METRON_HOME directory. The directory structure will look like:</p> + +<div class="source"> +<div class="source"> +<pre>bin + metron-management-ui +web + expressjs + package.json + server.js + management-ui + web assets (html, css, js, ...) +</pre></div></div></li> + +<li> +<p>Copy the <tt>$METRON_HOME/bin/metron-management-ui</tt> script to <tt>/etc/init.d/metron-management-ui</tt></p></li> + +<li> +<p>Install the <a class="externalLink" href="https://expressjs.com/";>Express</a> web framework from the <tt>package.json</tt> file in <tt>$METRON_HOME/web/expressjs</tt>:</p> + +<div class="source"> +<div class="source"> +<pre>npm --prefix $METRON_HOME/web/expressjs/ install +</pre></div></div></li> +</ol></div> +<div class="section"> +<h3><a name="From_Package_Manager"></a>From Package Manager</h3> + +<ol style="list-style-type: decimal"> + +<li> +<p>Deploy the RPM at <tt>/metron/metron-deployment/packaging/docker/rpm-docker/target/RPMS/noarch/metron-config-$METRON_VERSION-*.noarch.rpm</tt></p></li> + +<li> +<p>Install the RPM with:</p> + +<div class="source"> +<div class="source"> +<pre>rpm -ih metron-config-$METRON_VERSION-*.noarch.rpm +</pre></div></div></li> +</ol></div></div> +<div class="section"> +<h2><a name="Configuration"></a>Configuration</h2> +<p>The Managment UI is configured in the <tt>$METRON_HOME/config/management_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 managment 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-management-ui start +</pre></div></div> +<p>The application will be available at <a class="externalLink" href="http://host:4200";>http://host:4200</a> assuming the port is set to <tt>4200</tt>. Logs can be found at <tt>/var/log/metron/metron-management-ui.log</tt>.</p></div> +<div class="section"> +<h2><a name="Development"></a>Development</h2> +<p>The Management UI can also be started in development mode. This allows changes to web assets to be seen interactively.</p> + +<ol style="list-style-type: decimal"> + +<li> +<p>Install the application with dev dependencies:</p> + +<div class="source"> +<div class="source"> +<pre>cd metron-interface/metron-config +npm install +</pre></div></div></li> + +<li> +<p>Start the application:</p> + +<div class="source"> +<div class="source"> +<pre>./scripts/start_dev.sh +</pre></div></div></li> +</ol> +<p>The application will be available at <a class="externalLink" href="http://localhost:4200/";>http://localhost:4200/</a>. The REST application url defaults to <tt>http://localhost:8080</tt> but can be changed in the <tt>proxy.conf.json</tt> file.</p></div> +<div class="section"> +<h2><a name="Testing"></a>Testing</h2> + +<ol style="list-style-type: decimal"> + +<li> +<p>Install the application with dev dependencies:</p> + +<div class="source"> +<div class="source"> +<pre>cd metron-interface/metron-config +npm install +</pre></div></div></li> + +<li> +<p>Unit tests can be run with:</p> + +<div class="source"> +<div class="source"> +<pre>npm test +</pre></div></div></li> +</ol></div> +<div class="section"> +<h2><a name="License"></a>License</h2> +<p>This projects bundles Font Awesome which is available under the SIL Open Font License. See <a class="externalLink" href="http://fontawesome.io/license/";>http://fontawesome.io/license/</a> for more details.</p></div> + </div> + </div> + </div> + + <hr/> + + <footer> + <div class="container-fluid"> + <div class="row span12">Copyright © 2017 + <a href="https://www.apache.org";>The Apache Software Foundation</a>. + All Rights Reserved. + + </div> + + + + </div> + </footer> + </body> +</html>
