http://git-wip-us.apache.org/repos/asf/metron/blob/cf4c2ecd/current-book/metron-interface/metron-rest/index.html ---------------------------------------------------------------------- diff --git a/current-book/metron-interface/metron-rest/index.html b/current-book/metron-interface/metron-rest/index.html new file mode 100644 index 0000000..5955c5f --- /dev/null +++ b/current-book/metron-interface/metron-rest/index.html @@ -0,0 +1,1996 @@ +<!DOCTYPE html> +<!-- + | Generated by Apache Maven Doxia at 2017-06-27 + | 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="20170627" /> + <meta http-equiv="Content-Language" content="en" /> + <title>Metron – Metron REST</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 REST</li> + + + + <li id="publishDate" class="pull-right">Last Published: 2017-06-27</li> <li class="divider pull-right">|</li> + <li id="projectVersion" class="pull-right">Version: 0.4.0</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-deployment/index.html" title="Deployment"> + <i class="icon-chevron-right"></i> + Deployment</a> + </li> + + <li> + + <a href="../../metron-docker/index.html" title="Docker"> + <i class="none"></i> + Docker</a> + </li> + + <li> + + <a href="../../metron-interface/metron-config/index.html" title="Config"> + <i class="none"></i> + Config</a> + </li> + + <li class="active"> + + <a href="#"><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> + </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 REST</h1> +<p><a name="Metron_REST"></a></p> +<p>This module provides a RESTful API for interacting with Metron.</p> +<div class="section"> +<h2><a name="Prerequisites"></a>Prerequisites</h2> + +<ul> + +<li>A running Metron cluster</li> + +<li>Java 8 installed</li> + +<li>Storm CLI and Metron topology scripts (start_parser_topology.sh, start_enrichment_topology.sh, start_elasticsearch_topology.sh) installed</li> + +<li>A relational database</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>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>config + rest_application.yml +bin + metron-rest +lib + metron-rest-$METRON_VERSION.jar +</pre></div></div></li> + +<li> +<p>Copy the <tt>$METRON_HOME/bin/metron-rest</tt> script to <tt>/etc/init.d/metron-rest</tt></p></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-rest-$METRON_VERSION-*.noarch.rpm</tt></p></li> + +<li> +<p>Install the RPM with:</p> + +<div class="source"> +<div class="source"> +<pre>rpm -ih metron-rest-$METRON_VERSION-*.noarch.rpm +</pre></div></div></li> +</ol></div></div> +<div class="section"> +<h2><a name="Configuration"></a>Configuration</h2> +<p>The REST application depends on several configuration parameters:</p> +<div class="section"> +<h3><a name="REQUIRED"></a>REQUIRED</h3> +<p>No optional parameter has a default.</p> + +<table border="0" class="table table-striped"> + <thead> + +<tr class="a"> + +<th>Environment Variable </th> + +<th>Description</th> + </tr> + </thead> + <tbody> + +<tr class="b"> + +<td>METRON_JDBC_DRIVER </td> + +<td>JDBC driver class</td> + </tr> + +<tr class="a"> + +<td>METRON_JDBC_URL </td> + +<td>JDBC url</td> + </tr> + +<tr class="b"> + +<td>METRON_JDBC_USERNAME </td> + +<td>JDBC username</td> + </tr> + +<tr class="a"> + +<td>METRON_JDBC_PLATFORM </td> + +<td>JDBC platform (one of h2, mysql, postgres, oracle</td> + </tr> + +<tr class="b"> + +<td>ZOOKEEPER </td> + +<td>Zookeeper quorum (ex. node1:2181,node2:2181)</td> + </tr> + +<tr class="a"> + +<td>BROKERLIST </td> + +<td>Kafka Broker list (ex. node1:6667,node2:6667)</td> + </tr> + +<tr class="b"> + +<td>HDFS_URL </td> + +<td>HDFS url or <tt>fs.defaultFS</tt> Hadoop setting (ex. <a class="externalLink" href="hdfs://node1:8020">hdfs://node1:8020</a>)</td> + </tr> + </tbody> +</table></div> +<div class="section"> +<h3><a name="Optional_-_With_Defaults"></a>Optional - With Defaults</h3> + +<table border="0" class="table table-striped"> + <thead> + +<tr class="a"> + +<th>Environment Variable </th> + +<th>Description </th> + +<th>Required </th> + +<th>Default</th> + </tr> + </thead> + <tbody> + +<tr class="b"> + +<td>METRON_USER </td> + +<td>Run the application as this user </td> + +<td>Optional </td> + +<td>metron</td> + </tr> + +<tr class="a"> + +<td>METRON_LOG_DIR </td> + +<td>Directory where the log file is written </td> + +<td>Optional </td> + +<td>/var/log/metron/</td> + </tr> + +<tr class="b"> + +<td>METRON_PID_DIR </td> + +<td>Directory where the pid file is written </td> + +<td>Optional </td> + +<td>/var/run/metron/</td> + </tr> + +<tr class="a"> + +<td>METRON_REST_PORT </td> + +<td>REST application port </td> + +<td>Optional </td> + +<td>8082</td> + </tr> + +<tr class="b"> + +<td>METRON_JDBC_CLIENT_PATH </td> + +<td>Path to JDBC client jar </td> + +<td>Optional </td> + +<td>H2 is bundled</td> + </tr> + +<tr class="a"> + +<td>METRON_TEMP_GROK_PATH </td> + +<td>Temporary directory used to test grok statements </td> + +<td>Optional </td> + +<td>./patterns/temp</td> + </tr> + +<tr class="b"> + +<td>METRON_DEFAULT_GROK_PATH </td> + +<td>Defaults HDFS directory used to store grok statements </td> + +<td>Optional </td> + +<td>/apps/metron/patterns</td> + </tr> + +<tr class="a"> + +<td>SECURITY_ENABLED </td> + +<td>Enables Kerberos support </td> + +<td>Optional </td> + +<td>false</td> + </tr> + </tbody> +</table></div> +<div class="section"> +<h3><a name="Optional_-_Blank_Defaults"></a>Optional - Blank Defaults</h3> + +<table border="0" class="table table-striped"> + <thead> + +<tr class="a"> + +<th>Environment Variable </th> + +<th>Description </th> + +<th>Required</th> + </tr> + </thead> + <tbody> + +<tr class="b"> + +<td>METRON_JVMFLAGS </td> + +<td>JVM flags added to the start command </td> + +<td>Optional</td> + </tr> + +<tr class="a"> + +<td>METRON_SPRING_PROFILES_ACTIVE </td> + +<td>Active Spring profiles (see <a href="#spring-profiles">below</a>) </td> + +<td>Optional</td> + </tr> + +<tr class="b"> + +<td>METRON_SPRING_OPTIONS </td> + +<td>Additional Spring input parameters </td> + +<td>Optional</td> + </tr> + +<tr class="a"> + +<td>METRON_PRINCIPAL_NAME </td> + +<td>Kerberos principal for the metron user </td> + +<td>Optional</td> + </tr> + +<tr class="b"> + +<td>METRON_SERVICE_KEYTAB </td> + +<td>Path to the Kerberos keytab for the metron user </td> + +<td>Optional</td> + </tr> + </tbody> +</table> +<p>These are set in the <tt>/etc/sysconfig/metron</tt> file.</p></div></div> +<div class="section"> +<h2><a name="Database_setup"></a>Database setup</h2> +<p>The REST application persists data in a relational database and requires a dedicated database user and database (see <a class="externalLink" href="https://docs.spring.io/spring-boot/docs/current/reference/html/boot-features-sql.html";>https://docs.spring.io/spring-boot/docs/current/reference/html/boot-features-sql.html</a> for more detail).</p> +<div class="section"> +<h3><a name="Development"></a>Development</h3> +<p>The REST application comes with embedded database support for development purposes (<a class="externalLink" href="https://docs.spring.io/spring-boot/docs/current/reference/html/boot-features-sql.html#boot-features-embedded-database-support)">https://docs.spring.io/spring-boot/docs/current/reference/html/boot-features-sql.html#boot-features-embedded-database-support)</a>.</p> +<p>For example, edit these variables in <tt>/etc/sysconfig/metron</tt> before starting the application to configure H2:</p> + +<div class="source"> +<div class="source"> +<pre>METRON_JDBC_DRIVER="org.h2.Driver" +METRON_JDBC_URL="jdbc:h2:file:~/metrondb" +METRON_JDBC_USERNAME="root" +METRON_JDBC_PASSWORD='root" +METRON_JDBC_PLATFORM="h2" +</pre></div></div></div> +<div class="section"> +<h3><a name="Production"></a>Production</h3> +<p>The REST application should be configured with a production-grade database outside of development.</p> +<p>For example, the following configures the application for MySQL:</p> + +<ol style="list-style-type: decimal"> + +<li> +<p>Install MySQL if not already available (this example uses version 5.7, installation instructions can be found <a class="externalLink" href="https://dev.mysql.com/doc/refman/5.7/en/linux-installation-yum-repo.html";>here</a>)</p></li> + +<li> +<p>Create a metron user and REST database and permission the user for that database:</p> + +<div class="source"> +<div class="source"> +<pre>CREATE USER 'metron'@'node1' IDENTIFIED BY 'Myp@ssw0rd'; +CREATE DATABASE IF NOT EXISTS metronrest; +GRANT ALL PRIVILEGES ON metronrest.* TO 'metron'@'node1'; +</pre></div></div></li> + +<li> +<p>Install the MySQL JDBC client onto the REST application host and configurate the METRON_JDBC_CLIENT_PATH variable:</p> + +<div class="source"> +<div class="source"> +<pre>cd $METRON_HOME/lib +wget https://dev.mysql.com/get/Downloads/Connector-J/mysql-connector-java-5.1.41.tar.gz +tar xf mysql-connector-java-5.1.41.tar.gz +</pre></div></div></li> + +<li> +<p>Edit these variables in <tt>/etc/sysconfig/metron</tt> to configure the REST application for MySQL:</p> + +<div class="source"> +<div class="source"> +<pre>METRON_JDBC_DRIVER="com.mysql.jdbc.Driver" +METRON_JDBC_URL="jdbc:mysql://mysql_host:3306/metronrest" +METRON_JDBC_USERNAME="metron" +METRON_JDBC_PLATFORM="mysql" +METRON_JDBC_CLIENT_PATH=$METRON_HOME/lib/mysql-connector-java-5.1.41/mysql-connector-java-5.1.41-bin.jar +</pre></div></div></li> +</ol></div></div> +<div class="section"> +<h2><a name="Usage"></a>Usage</h2> +<p>After configuration is complete, the REST application can be managed as a service:</p> + +<div class="source"> +<div class="source"> +<pre>service metron-rest start +</pre></div></div> +<p>If a production database is configured, the JDBC password should be passed in as the first argument on startup:</p> + +<div class="source"> +<div class="source"> +<pre>service metron-rest start Myp@ssw0rd +</pre></div></div> +<p>The REST application can be accessed with the Swagger UI at <a class="externalLink" href="http://host:port/swagger-ui.html#/";>http://host:port/swagger-ui.html#/</a>. The default port is 8082.</p></div> +<div class="section"> +<h2><a name="Security"></a>Security</h2> +<div class="section"> +<h3><a name="Authentication"></a>Authentication</h3> +<p>The metron-rest module uses <a class="externalLink" href="http://projects.spring.io/spring-security/";>Spring Security</a> for authentication and stores user credentials in the relational database configured above. The required tables are created automatically the first time the application is started so that should be done first. For example (continuing the MySQL example above), users can be added by connecting to MySQL and running:</p> + +<div class="source"> +<div class="source"> +<pre>use metronrest; +insert into users (username, password, enabled) values ('your_username','your_password',1); +insert into authorities (username, authority) values ('your_username', 'ROLE_USER'); +</pre></div></div></div> +<div class="section"> +<h3><a name="Kerberos"></a>Kerberos</h3> +<p>Metron REST can be configured for a cluster with Kerberos enabled. A client JAAS file is required for Kafka and Zookeeper and a Kerberos keytab for the metron user principal is required for all other services. Configure these settings in the <tt>/etc/sysconfig/metron</tt> file:</p> + +<div class="source"> +<div class="source"> +<pre>SECURITY_ENABLED=true +METRON_JVMFLAGS="-Djava.security.auth.login.config=$METRON_HOME/client_jaas.conf" +METRON_PRINCIPAL_NAME="met...@example.com" +METRON_SERVICE_KEYTAB="/etc/security/keytabs/metron.keytab" +</pre></div></div></div></div> +<div class="section"> +<h2><a name="Spring_Profiles"></a>Spring Profiles</h2> +<p>The REST application comes with a few <a class="externalLink" href="http://docs.spring.io/autorepo/docs/spring-boot/current/reference/html/boot-features-profiles.html";>Spring Profiles</a> to aid in testing and development.</p> + +<table border="0" class="table table-striped"> + <thead> + +<tr class="a"> + +<th>Profile </th> + +<th>Description </th> + </tr> + </thead> + <tbody> + +<tr class="b"> + +<td>test </td> + +<td>sets variables to in-memory services, only used for integration testing </td> + </tr> + +<tr class="a"> + +<td>dev </td> + +<td>adds a test user to the database with credentials <tt>user/password</tt> </td> + </tr> + +<tr class="b"> + +<td>vagrant </td> + +<td>sets configuration variables to match the Metron vagrant environment </td> + </tr> + +<tr class="a"> + +<td>docker </td> + +<td>sets configuration variables to match the Metron dcoker environment </td> + </tr> + </tbody> +</table> +<p>Setting active profiles is done with the METRON_SPRING_PROFILES_ACTIVE variable. For example, set this variable in <tt>/etc/sysconfig/metron</tt> to configure the REST application for the Vagrant environment and add a test user:</p> + +<div class="source"> +<div class="source"> +<pre>METRON_SPRING_PROFILES_ACTIVE="vagrant,dev" +</pre></div></div></div> +<div class="section"> +<h2><a name="API"></a>API</h2> +<p>Request and Response objects are JSON formatted. The JSON schemas are available in the Swagger UI.</p> + +<table border="0" class="table table-striped"> + <thead> + +<tr class="a"> + +<th> </th> + </tr> + </thead> + <tbody> + +<tr class="b"> + +<td><a href="#GET_apiv1globalconfig"> <tt>GET /api/v1/global/config</tt></a></td> + </tr> + +<tr class="a"> + +<td><a href="#DELETE_apiv1globalconfig"> <tt>DELETE /api/v1/global/config</tt></a></td> + </tr> + +<tr class="b"> + +<td><a href="#POST_apiv1globalconfig"> <tt>POST /api/v1/global/config</tt></a></td> + </tr> + +<tr class="a"> + +<td><a href="#GET_apiv1grokgetstatement"> <tt>GET /api/v1/grok/get/statement</tt></a></td> + </tr> + +<tr class="b"> + +<td><a href="#GET_apiv1groklist"> <tt>GET /api/v1/grok/list</tt></a></td> + </tr> + +<tr class="a"> + +<td><a href="#POST_apiv1grokvalidate"> <tt>POST /api/v1/grok/validate</tt></a></td> + </tr> + +<tr class="b"> + +<td><a href="#POST_apiv1hdfs"> <tt>POST /api/v1/hdfs</tt></a></td> + </tr> + +<tr class="a"> + +<td><a href="#GET_apiv1hdfs"> <tt>GET /api/v1/hdfs</tt></a></td> + </tr> + +<tr class="b"> + +<td><a href="#DELETE_apiv1hdfs"> <tt>DELETE /api/v1/hdfs</tt></a></td> + </tr> + +<tr class="a"> + +<td><a href="#GET_apiv1hdfslist"> <tt>GET /api/v1/hdfs/list</tt></a></td> + </tr> + +<tr class="b"> + +<td><a href="#GET_apiv1kafkatopic"> <tt>GET /api/v1/kafka/topic</tt></a></td> + </tr> + +<tr class="a"> + +<td><a href="#POST_apiv1kafkatopic"> <tt>POST /api/v1/kafka/topic</tt></a></td> + </tr> + +<tr class="b"> + +<td><a href="#GET_apiv1kafkatopicname"> <tt>GET /api/v1/kafka/topic/{name}</tt></a></td> + </tr> + +<tr class="a"> + +<td><a href="#DELETE_apiv1kafkatopicname"> <tt>DELETE /api/v1/kafka/topic/{name}</tt></a></td> + </tr> + +<tr class="b"> + +<td><a href="#GET_apiv1kafkatopicnamesample"> <tt>GET /api/v1/kafka/topic/{name}/sample</tt></a></td> + </tr> + +<tr class="a"> + +<td><a href="#GET_apiv1sensorenrichmentconfig"> <tt>GET /api/v1/sensor/enrichment/config</tt></a></td> + </tr> + +<tr class="b"> + +<td><a href="#GET_apiv1sensorenrichmentconfiglistavailableenrichments"> <tt>GET /api/v1/sensor/enrichment/config/list/available/enrichments</tt></a></td> + </tr> + +<tr class="a"> + +<td><a href="#GET_apiv1sensorenrichmentconfiglistavailablethreattriageaggregators"> <tt>GET /api/v1/sensor/enrichment/config/list/available/threat/triage/aggregators</tt></a></td> + </tr> + +<tr class="b"> + +<td><a href="#DELETE_apiv1sensorenrichmentconfigname"> <tt>DELETE /api/v1/sensor/enrichment/config/{name}</tt></a></td> + </tr> + +<tr class="a"> + +<td><a href="#POST_apiv1sensorenrichmentconfigname"> <tt>POST /api/v1/sensor/enrichment/config/{name}</tt></a></td> + </tr> + +<tr class="b"> + +<td><a href="#GET_apiv1sensorenrichmentconfigname"> <tt>GET /api/v1/sensor/enrichment/config/{name}</tt></a></td> + </tr> + +<tr class="a"> + +<td><a href="#GET_apiv1sensorindexingconfig"> <tt>GET /api/v1/sensor/indexing/config</tt></a></td> + </tr> + +<tr class="b"> + +<td><a href="#DELETE_apiv1sensorindexingconfigname"> <tt>DELETE /api/v1/sensor/indexing/config/{name}</tt></a></td> + </tr> + +<tr class="a"> + +<td><a href="#POST_apiv1sensorindexingconfigname"> <tt>POST /api/v1/sensor/indexing/config/{name}</tt></a></td> + </tr> + +<tr class="b"> + +<td><a href="#GET_apiv1sensorindexingconfigname"> <tt>GET /api/v1/sensor/indexing/config/{name}</tt></a></td> + </tr> + +<tr class="a"> + +<td><a href="#POST_apiv1sensorparserconfig"> <tt>POST /api/v1/sensor/parser/config</tt></a></td> + </tr> + +<tr class="b"> + +<td><a href="#GET_apiv1sensorparserconfig"> <tt>GET /api/v1/sensor/parser/config</tt></a></td> + </tr> + +<tr class="a"> + +<td><a href="#GET_apiv1sensorparserconfiglistavailable"> <tt>GET /api/v1/sensor/parser/config/list/available</tt></a></td> + </tr> + +<tr class="b"> + +<td><a href="#POST_apiv1sensorparserconfigparseMessage"> <tt>POST /api/v1/sensor/parser/config/parseMessage</tt></a></td> + </tr> + +<tr class="a"> + +<td><a href="#GET_apiv1sensorparserconfigreloadavailable"> <tt>GET /api/v1/sensor/parser/config/reload/available</tt></a></td> + </tr> + +<tr class="b"> + +<td><a href="#DELETE_apiv1sensorparserconfigname"> <tt>DELETE /api/v1/sensor/parser/config/{name}</tt></a></td> + </tr> + +<tr class="a"> + +<td><a href="#GET_apiv1sensorparserconfigname"> <tt>GET /api/v1/sensor/parser/config/{name}</tt></a></td> + </tr> + +<tr class="b"> + +<td><a href="#POST_apiv1stellarapplytransformations"> <tt>POST /api/v1/stellar/apply/transformations</tt></a></td> + </tr> + +<tr class="a"> + +<td><a href="#GET_apiv1stellarlist"> <tt>GET /api/v1/stellar/list</tt></a></td> + </tr> + +<tr class="b"> + +<td><a href="#GET_apiv1stellarlistfunctions"> <tt>GET /api/v1/stellar/list/functions</tt></a></td> + </tr> + +<tr class="a"> + +<td><a href="#GET_apiv1stellarlistsimplefunctions"> <tt>GET /api/v1/stellar/list/simple/functions</tt></a></td> + </tr> + +<tr class="b"> + +<td><a href="#POST_apiv1stellarvalidaterules"> <tt>POST /api/v1/stellar/validate/rules</tt></a></td> + </tr> + +<tr class="a"> + +<td><a href="#GET_apiv1storm"> <tt>GET /api/v1/storm</tt></a></td> + </tr> + +<tr class="b"> + +<td><a href="#GET_apiv1stormclientstatus"> <tt>GET /api/v1/storm/client/status</tt></a></td> + </tr> + +<tr class="a"> + +<td><a href="#GET_apiv1stormenrichment"> <tt>GET /api/v1/storm/enrichment</tt></a></td> + </tr> + +<tr class="b"> + +<td><a href="#GET_apiv1stormenrichmentactivate"> <tt>GET /api/v1/storm/enrichment/activate</tt></a></td> + </tr> + +<tr class="a"> + +<td><a href="#GET_apiv1stormenrichmentdeactivate"> <tt>GET /api/v1/storm/enrichment/deactivate</tt></a></td> + </tr> + +<tr class="b"> + +<td><a href="#GET_apiv1stormenrichmentstart"> <tt>GET /api/v1/storm/enrichment/start</tt></a></td> + </tr> + +<tr class="a"> + +<td><a href="#GET_apiv1stormenrichmentstop"> <tt>GET /api/v1/storm/enrichment/stop</tt></a></td> + </tr> + +<tr class="b"> + +<td><a href="#GET_apiv1stormindexing"> <tt>GET /api/v1/storm/indexing</tt></a></td> + </tr> + +<tr class="a"> + +<td><a href="#GET_apiv1stormindexingactivate"> <tt>GET /api/v1/storm/indexing/activate</tt></a></td> + </tr> + +<tr class="b"> + +<td><a href="#GET_apiv1stormindexingdeactivate"> <tt>GET /api/v1/storm/indexing/deactivate</tt></a></td> + </tr> + +<tr class="a"> + +<td><a href="#GET_apiv1stormindexingstart"> <tt>GET /api/v1/storm/indexing/start</tt></a></td> + </tr> + +<tr class="b"> + +<td><a href="#GET_apiv1stormindexingstop"> <tt>GET /api/v1/storm/indexing/stop</tt></a></td> + </tr> + +<tr class="a"> + +<td><a href="#GET_apiv1stormparseractivatename"> <tt>GET /api/v1/storm/parser/activate/{name}</tt></a></td> + </tr> + +<tr class="b"> + +<td><a href="#GET_apiv1stormparserdeactivatename"> <tt>GET /api/v1/storm/parser/deactivate/{name}</tt></a></td> + </tr> + +<tr class="a"> + +<td><a href="#GET_apiv1stormparserstartname"> <tt>GET /api/v1/storm/parser/start/{name}</tt></a></td> + </tr> + +<tr class="b"> + +<td><a href="#GET_apiv1stormparserstopname"> <tt>GET /api/v1/storm/parser/stop/{name}</tt></a></td> + </tr> + +<tr class="a"> + +<td><a href="#GET_apiv1stormname"> <tt>GET /api/v1/storm/{name}</tt></a></td> + </tr> + +<tr class="b"> + +<td><a href="#GET_apiv1user"> <tt>GET /api/v1/user</tt></a></td> + </tr> + </tbody> +</table> +<div class="section"> +<h3><a name="GET_apiv1globalconfig"></a><tt>GET /api/v1/global/config</tt></h3> + +<ul> + +<li>Description: Retrieves the current Global Config from Zookeeper</li> + +<li>Returns: + +<ul> + +<li>200 - Returns current Global Config JSON in Zookeeper</li> + +<li>404 - Global Config JSON was not found in Zookeeper</li> + </ul></li> +</ul></div> +<div class="section"> +<h3><a name="DELETE_apiv1globalconfig"></a><tt>DELETE /api/v1/global/config</tt></h3> + +<ul> + +<li>Description: Deletes the current Global Config from Zookeeper</li> + +<li>Returns: + +<ul> + +<li>200 - Global Config JSON was deleted</li> + +<li>404 - Global Config JSON was not found in Zookeeper</li> + </ul></li> +</ul></div> +<div class="section"> +<h3><a name="POST_apiv1globalconfig"></a><tt>POST /api/v1/global/config</tt></h3> + +<ul> + +<li>Description: Creates or updates the Global Config in Zookeeper</li> + +<li>Input: + +<ul> + +<li>globalConfig - The Global Config JSON to be saved</li> + </ul></li> + +<li>Returns: + +<ul> + +<li>200 - Global Config updated. Returns saved Global Config JSON</li> + +<li>201 - Global Config created. Returns saved Global Config JSON</li> + </ul></li> +</ul></div> +<div class="section"> +<h3><a name="GET_apiv1grokgetstatement"></a><tt>GET /api/v1/grok/get/statement</tt></h3> + +<ul> + +<li>Description: Retrieves a Grok statement from the classpath</li> + +<li>Input: + +<ul> + +<li>path - Path to classpath resource</li> + </ul></li> + +<li>Returns: + +<ul> + +<li>200 - Grok statement</li> + </ul></li> +</ul></div> +<div class="section"> +<h3><a name="GET_apiv1groklist"></a><tt>GET /api/v1/grok/list</tt></h3> + +<ul> + +<li>Description: Lists the common Grok statements available in Metron</li> + +<li>Returns: + +<ul> + +<li>200 - JSON object containing pattern label/Grok statements key value pairs</li> + </ul></li> +</ul></div> +<div class="section"> +<h3><a name="POST_apiv1grokvalidate"></a><tt>POST /api/v1/grok/validate</tt></h3> + +<ul> + +<li>Description: Applies a Grok statement to a sample message</li> + +<li>Input: + +<ul> + +<li>grokValidation - Object containing Grok statement and sample message</li> + </ul></li> + +<li>Returns: + +<ul> + +<li>200 - JSON results</li> + </ul></li> +</ul></div> +<div class="section"> +<h3><a name="POST_apiv1hdfs"></a><tt>POST /api/v1/hdfs</tt></h3> + +<ul> + +<li>Description: Writes contents to an HDFS file. Warning: this will overwrite the contents of a file if it already exists.</li> + +<li>Input: + +<ul> + +<li>path - Path to HDFS file</li> + +<li>contents - File contents</li> + </ul></li> + +<li>Returns: + +<ul> + +<li>200 - Contents were written</li> + </ul></li> +</ul></div> +<div class="section"> +<h3><a name="GET_apiv1hdfs"></a><tt>GET /api/v1/hdfs</tt></h3> + +<ul> + +<li>Description: Reads a file from HDFS and returns the contents</li> + +<li>Input: + +<ul> + +<li>path - Path to HDFS file</li> + </ul></li> + +<li>Returns: + +<ul> + +<li>200 - Returns file contents</li> + </ul></li> +</ul></div> +<div class="section"> +<h3><a name="DELETE_apiv1hdfs"></a><tt>DELETE /api/v1/hdfs</tt></h3> + +<ul> + +<li>Description: Deletes a file from HDFS</li> + +<li>Input: + +<ul> + +<li>path - Path to HDFS file</li> + +<li>recursive - Delete files recursively</li> + </ul></li> + +<li>Returns: + +<ul> + +<li>200 - File was deleted</li> + +<li>404 - File was not found in HDFS</li> + </ul></li> +</ul></div> +<div class="section"> +<h3><a name="GET_apiv1hdfslist"></a><tt>GET /api/v1/hdfs/list</tt></h3> + +<ul> + +<li>Description: Lists an HDFS directory</li> + +<li>Input: + +<ul> + +<li>path - Path to HDFS directory</li> + </ul></li> + +<li>Returns: + +<ul> + +<li>200 - HDFS directory list</li> + </ul></li> +</ul></div> +<div class="section"> +<h3><a name="GET_apiv1kafkatopic"></a><tt>GET /api/v1/kafka/topic</tt></h3> + +<ul> + +<li>Description: Retrieves all Kafka topics</li> + +<li>Returns: + +<ul> + +<li>200 - Returns a list of all Kafka topics</li> + </ul></li> +</ul></div> +<div class="section"> +<h3><a name="POST_apiv1kafkatopic"></a><tt>POST /api/v1/kafka/topic</tt></h3> + +<ul> + +<li>Description: Creates a new Kafka topic</li> + +<li>Input: + +<ul> + +<li>topic - Kafka topic</li> + </ul></li> + +<li>Returns: + +<ul> + +<li>200 - Returns saved Kafka topic</li> + </ul></li> +</ul></div> +<div class="section"> +<h3><a name="GET_apiv1kafkatopicname"></a><tt>GET /api/v1/kafka/topic/{name}</tt></h3> + +<ul> + +<li>Description: Retrieves a Kafka topic</li> + +<li>Input: + +<ul> + +<li>name - Kafka topic name</li> + </ul></li> + +<li>Returns: + +<ul> + +<li>200 - Returns Kafka topic</li> + +<li>404 - Kafka topic is missing</li> + </ul></li> +</ul></div> +<div class="section"> +<h3><a name="DELETE_apiv1kafkatopicname"></a><tt>DELETE /api/v1/kafka/topic/{name}</tt></h3> + +<ul> + +<li>Description: Deletes a Kafka topic</li> + +<li>Input: + +<ul> + +<li>name - Kafka topic name</li> + </ul></li> + +<li>Returns: + +<ul> + +<li>200 - Kafka topic was deleted</li> + +<li>404 - Kafka topic is missing</li> + </ul></li> +</ul></div> +<div class="section"> +<h3><a name="GET_apiv1kafkatopicnamesample"></a><tt>GET /api/v1/kafka/topic/{name}/sample</tt></h3> + +<ul> + +<li>Description: Retrieves a sample message from a Kafka topic using the most recent offset</li> + +<li>Input: + +<ul> + +<li>name - Kafka topic name</li> + </ul></li> + +<li>Returns: + +<ul> + +<li>200 - Returns sample message</li> + +<li>404 - Either Kafka topic is missing or contains no messages</li> + </ul></li> +</ul></div> +<div class="section"> +<h3><a name="GET_apiv1sensorenrichmentconfig"></a><tt>GET /api/v1/sensor/enrichment/config</tt></h3> + +<ul> + +<li>Description: Retrieves all SensorEnrichmentConfigs from Zookeeper</li> + +<li>Returns: + +<ul> + +<li>200 - Returns all SensorEnrichmentConfigs</li> + </ul></li> +</ul></div> +<div class="section"> +<h3><a name="GET_apiv1sensorenrichmentconfiglistavailableenrichments"></a><tt>GET /api/v1/sensor/enrichment/config/list/available/enrichments</tt></h3> + +<ul> + +<li>Description: Lists the available enrichments</li> + +<li>Returns: + +<ul> + +<li>200 - Returns a list of available enrichments</li> + </ul></li> +</ul></div> +<div class="section"> +<h3><a name="GET_apiv1sensorenrichmentconfiglistavailablethreattriageaggregators"></a><tt>GET /api/v1/sensor/enrichment/config/list/available/threat/triage/aggregators</tt></h3> + +<ul> + +<li>Description: Lists the available threat triage aggregators</li> + +<li>Returns: + +<ul> + +<li>200 - Returns a list of available threat triage aggregators</li> + </ul></li> +</ul></div> +<div class="section"> +<h3><a name="DELETE_apiv1sensorenrichmentconfigname"></a><tt>DELETE /api/v1/sensor/enrichment/config/{name}</tt></h3> + +<ul> + +<li>Description: Deletes a SensorEnrichmentConfig from Zookeeper</li> + +<li>Input: + +<ul> + +<li>name - SensorEnrichmentConfig name</li> + </ul></li> + +<li>Returns: + +<ul> + +<li>200 - SensorEnrichmentConfig was deleted</li> + +<li>404 - SensorEnrichmentConfig is missing</li> + </ul></li> +</ul></div> +<div class="section"> +<h3><a name="POST_apiv1sensorenrichmentconfigname"></a><tt>POST /api/v1/sensor/enrichment/config/{name}</tt></h3> + +<ul> + +<li>Description: Updates or creates a SensorEnrichmentConfig in Zookeeper</li> + +<li>Input: + +<ul> + +<li>sensorEnrichmentConfig - SensorEnrichmentConfig</li> + +<li>name - SensorEnrichmentConfig name</li> + </ul></li> + +<li>Returns: + +<ul> + +<li>200 - SensorEnrichmentConfig updated. Returns saved SensorEnrichmentConfig</li> + +<li>201 - SensorEnrichmentConfig created. Returns saved SensorEnrichmentConfig</li> + </ul></li> +</ul></div> +<div class="section"> +<h3><a name="GET_apiv1sensorenrichmentconfigname"></a><tt>GET /api/v1/sensor/enrichment/config/{name}</tt></h3> + +<ul> + +<li>Description: Retrieves a SensorEnrichmentConfig from Zookeeper</li> + +<li>Input: + +<ul> + +<li>name - SensorEnrichmentConfig name</li> + </ul></li> + +<li>Returns: + +<ul> + +<li>200 - Returns SensorEnrichmentConfig</li> + +<li>404 - SensorEnrichmentConfig is missing</li> + </ul></li> +</ul></div> +<div class="section"> +<h3><a name="GET_apiv1sensorindexingconfig"></a><tt>GET /api/v1/sensor/indexing/config</tt></h3> + +<ul> + +<li>Description: Retrieves all SensorIndexingConfigs from Zookeeper</li> + +<li>Returns: + +<ul> + +<li>200 - Returns all SensorIndexingConfigs</li> + </ul></li> +</ul></div> +<div class="section"> +<h3><a name="DELETE_apiv1sensorindexingconfigname"></a><tt>DELETE /api/v1/sensor/indexing/config/{name}</tt></h3> + +<ul> + +<li>Description: Deletes a SensorIndexingConfig from Zookeeper</li> + +<li>Input: + +<ul> + +<li>name - SensorIndexingConfig name</li> + </ul></li> + +<li>Returns: + +<ul> + +<li>200 - SensorIndexingConfig was deleted</li> + +<li>404 - SensorIndexingConfig is missing</li> + </ul></li> +</ul></div> +<div class="section"> +<h3><a name="POST_apiv1sensorindexingconfigname"></a><tt>POST /api/v1/sensor/indexing/config/{name}</tt></h3> + +<ul> + +<li>Description: Updates or creates a SensorIndexingConfig in Zookeeper</li> + +<li>Input: + +<ul> + +<li>sensorIndexingConfig - SensorIndexingConfig</li> + +<li>name - SensorIndexingConfig name</li> + </ul></li> + +<li>Returns: + +<ul> + +<li>200 - SensorIndexingConfig updated. Returns saved SensorIndexingConfig</li> + +<li>201 - SensorIndexingConfig created. Returns saved SensorIndexingConfig</li> + </ul></li> +</ul></div> +<div class="section"> +<h3><a name="GET_apiv1sensorindexingconfigname"></a><tt>GET /api/v1/sensor/indexing/config/{name}</tt></h3> + +<ul> + +<li>Description: Retrieves a SensorIndexingConfig from Zookeeper</li> + +<li>Input: + +<ul> + +<li>name - SensorIndexingConfig name</li> + </ul></li> + +<li>Returns: + +<ul> + +<li>200 - Returns SensorIndexingConfig</li> + +<li>404 - SensorIndexingConfig is missing</li> + </ul></li> +</ul></div> +<div class="section"> +<h3><a name="POST_apiv1sensorparserconfig"></a><tt>POST /api/v1/sensor/parser/config</tt></h3> + +<ul> + +<li>Description: Updates or creates a SensorParserConfig in Zookeeper</li> + +<li>Input: + +<ul> + +<li>sensorParserConfig - SensorParserConfig</li> + </ul></li> + +<li>Returns: + +<ul> + +<li>200 - SensorParserConfig updated. Returns saved SensorParserConfig</li> + +<li>201 - SensorParserConfig created. Returns saved SensorParserConfig</li> + </ul></li> +</ul></div> +<div class="section"> +<h3><a name="GET_apiv1sensorparserconfig"></a><tt>GET /api/v1/sensor/parser/config</tt></h3> + +<ul> + +<li>Description: Retrieves all SensorParserConfigs from Zookeeper</li> + +<li>Returns: + +<ul> + +<li>200 - Returns all SensorParserConfigs</li> + </ul></li> +</ul></div> +<div class="section"> +<h3><a name="GET_apiv1sensorparserconfiglistavailable"></a><tt>GET /api/v1/sensor/parser/config/list/available</tt></h3> + +<ul> + +<li>Description: Lists the available parser classes that can be found on the classpath</li> + +<li>Returns: + +<ul> + +<li>200 - Returns a list of available parser classes</li> + </ul></li> +</ul></div> +<div class="section"> +<h3><a name="POST_apiv1sensorparserconfigparseMessage"></a><tt>POST /api/v1/sensor/parser/config/parseMessage</tt></h3> + +<ul> + +<li>Description: Parses a sample message given a SensorParserConfig</li> + +<li>Input: + +<ul> + +<li>parseMessageRequest - Object containing a sample message and SensorParserConfig</li> + </ul></li> + +<li>Returns: + +<ul> + +<li>200 - Returns parsed message</li> + </ul></li> +</ul></div> +<div class="section"> +<h3><a name="GET_apiv1sensorparserconfigreloadavailable"></a><tt>GET /api/v1/sensor/parser/config/reload/available</tt></h3> + +<ul> + +<li>Description: Scans the classpath for available parser classes and reloads the cached parser class list</li> + +<li>Returns: + +<ul> + +<li>200 - Returns a list of available parser classes</li> + </ul></li> +</ul></div> +<div class="section"> +<h3><a name="DELETE_apiv1sensorparserconfigname"></a><tt>DELETE /api/v1/sensor/parser/config/{name}</tt></h3> + +<ul> + +<li>Description: Deletes a SensorParserConfig from Zookeeper</li> + +<li>Input: + +<ul> + +<li>name - SensorParserConfig name</li> + </ul></li> + +<li>Returns: + +<ul> + +<li>200 - SensorParserConfig was deleted</li> + +<li>404 - SensorParserConfig is missing</li> + </ul></li> +</ul></div> +<div class="section"> +<h3><a name="GET_apiv1sensorparserconfigname"></a><tt>GET /api/v1/sensor/parser/config/{name}</tt></h3> + +<ul> + +<li>Description: Retrieves a SensorParserConfig from Zookeeper</li> + +<li>Input: + +<ul> + +<li>name - SensorParserConfig name</li> + </ul></li> + +<li>Returns: + +<ul> + +<li>200 - Returns SensorParserConfig</li> + +<li>404 - SensorParserConfig is missing</li> + </ul></li> +</ul></div> +<div class="section"> +<h3><a name="POST_apiv1stellarapplytransformations"></a><tt>POST /api/v1/stellar/apply/transformations</tt></h3> + +<ul> + +<li>Description: Executes transformations against a sample message</li> + +<li>Input: + +<ul> + +<li>transformationValidation - Object containing SensorParserConfig and sample message</li> + </ul></li> + +<li>Returns: + +<ul> + +<li>200 - Returns transformation results</li> + </ul></li> +</ul></div> +<div class="section"> +<h3><a name="GET_apiv1stellarlist"></a><tt>GET /api/v1/stellar/list</tt></h3> + +<ul> + +<li>Description: Retrieves field transformations</li> + +<li>Returns: + +<ul> + +<li>200 - Returns a list field transformations</li> + </ul></li> +</ul></div> +<div class="section"> +<h3><a name="GET_apiv1stellarlistfunctions"></a><tt>GET /api/v1/stellar/list/functions</tt></h3> + +<ul> + +<li>Description: Lists the Stellar functions that can be found on the classpath</li> + +<li>Returns: + +<ul> + +<li>200 - Returns a list of Stellar functions</li> + </ul></li> +</ul></div> +<div class="section"> +<h3><a name="GET_apiv1stellarlistsimplefunctions"></a><tt>GET /api/v1/stellar/list/simple/functions</tt></h3> + +<ul> + +<li>Description: Lists the simple Stellar functions (functions with only 1 input) that can be found on the classpath</li> + +<li>Returns: + +<ul> + +<li>200 - Returns a list of simple Stellar functions</li> + </ul></li> +</ul></div> +<div class="section"> +<h3><a name="POST_apiv1stellarvalidaterules"></a><tt>POST /api/v1/stellar/validate/rules</tt></h3> + +<ul> + +<li>Description: Tests Stellar statements to ensure they are well-formed</li> + +<li>Input: + +<ul> + +<li>statements - List of statements to validate</li> + </ul></li> + +<li>Returns: + +<ul> + +<li>200 - Returns validation results</li> + </ul></li> +</ul></div> +<div class="section"> +<h3><a name="GET_apiv1storm"></a><tt>GET /api/v1/storm</tt></h3> + +<ul> + +<li>Description: Retrieves the status of all Storm topologies</li> + +<li>Returns: + +<ul> + +<li>200 - Returns a list of topologies with status information</li> + </ul></li> +</ul></div> +<div class="section"> +<h3><a name="GET_apiv1stormclientstatus"></a><tt>GET /api/v1/storm/client/status</tt></h3> + +<ul> + +<li>Description: Retrieves information about the Storm command line client</li> + +<li>Returns: + +<ul> + +<li>200 - Returns storm command line client information</li> + </ul></li> +</ul></div> +<div class="section"> +<h3><a name="GET_apiv1stormenrichment"></a><tt>GET /api/v1/storm/enrichment</tt></h3> + +<ul> + +<li>Description: Retrieves the status of the Storm enrichment topology</li> + +<li>Returns: + +<ul> + +<li>200 - Returns topology status information</li> + +<li>404 - Topology is missing</li> + </ul></li> +</ul></div> +<div class="section"> +<h3><a name="GET_apiv1stormenrichmentactivate"></a><tt>GET /api/v1/storm/enrichment/activate</tt></h3> + +<ul> + +<li>Description: Activates a Storm enrichment topology</li> + +<li>Returns: + +<ul> + +<li>200 - Returns activate response message</li> + </ul></li> +</ul></div> +<div class="section"> +<h3><a name="GET_apiv1stormenrichmentdeactivate"></a><tt>GET /api/v1/storm/enrichment/deactivate</tt></h3> + +<ul> + +<li>Description: Deactivates a Storm enrichment topology</li> + +<li>Returns: + +<ul> + +<li>200 - Returns deactivate response message</li> + </ul></li> +</ul></div> +<div class="section"> +<h3><a name="GET_apiv1stormenrichmentstart"></a><tt>GET /api/v1/storm/enrichment/start</tt></h3> + +<ul> + +<li>Description: Starts a Storm enrichment topology</li> + +<li>Returns: + +<ul> + +<li>200 - Returns start response message</li> + </ul></li> +</ul></div> +<div class="section"> +<h3><a name="GET_apiv1stormenrichmentstop"></a><tt>GET /api/v1/storm/enrichment/stop</tt></h3> + +<ul> + +<li>Description: Stops a Storm enrichment topology</li> + +<li>Input: + +<ul> + +<li>stopNow - Stop the topology immediately</li> + </ul></li> + +<li>Returns: + +<ul> + +<li>200 - Returns stop response message</li> + </ul></li> +</ul></div> +<div class="section"> +<h3><a name="GET_apiv1stormindexing"></a><tt>GET /api/v1/storm/indexing</tt></h3> + +<ul> + +<li>Description: Retrieves the status of the Storm indexing topology</li> + +<li>Returns: + +<ul> + +<li>200 - Returns topology status information</li> + +<li>404 - Topology is missing</li> + </ul></li> +</ul></div> +<div class="section"> +<h3><a name="GET_apiv1stormindexingactivate"></a><tt>GET /api/v1/storm/indexing/activate</tt></h3> + +<ul> + +<li>Description: Activates a Storm indexing topology</li> + +<li>Returns: + +<ul> + +<li>200 - Returns activate response message</li> + </ul></li> +</ul></div> +<div class="section"> +<h3><a name="GET_apiv1stormindexingdeactivate"></a><tt>GET /api/v1/storm/indexing/deactivate</tt></h3> + +<ul> + +<li>Description: Deactivates a Storm indexing topology</li> + +<li>Returns: + +<ul> + +<li>200 - Returns deactivate response message</li> + </ul></li> +</ul></div> +<div class="section"> +<h3><a name="GET_apiv1stormindexingstart"></a><tt>GET /api/v1/storm/indexing/start</tt></h3> + +<ul> + +<li>Description: Starts a Storm indexing topology</li> + +<li>Returns: + +<ul> + +<li>200 - Returns start response message</li> + </ul></li> +</ul></div> +<div class="section"> +<h3><a name="GET_apiv1stormindexingstop"></a><tt>GET /api/v1/storm/indexing/stop</tt></h3> + +<ul> + +<li>Description: Stops a Storm enrichment topology</li> + +<li>Input: + +<ul> + +<li>stopNow - Stop the topology immediately</li> + </ul></li> + +<li>Returns: + +<ul> + +<li>200 - Returns stop response message</li> + </ul></li> +</ul></div> +<div class="section"> +<h3><a name="GET_apiv1stormparseractivatename"></a><tt>GET /api/v1/storm/parser/activate/{name}</tt></h3> + +<ul> + +<li>Description: Activates a Storm parser topology</li> + +<li>Input: + +<ul> + +<li>name - Parser name</li> + </ul></li> + +<li>Returns: + +<ul> + +<li>200 - Returns activate response message</li> + </ul></li> +</ul></div> +<div class="section"> +<h3><a name="GET_apiv1stormparserdeactivatename"></a><tt>GET /api/v1/storm/parser/deactivate/{name}</tt></h3> + +<ul> + +<li>Description: Deactivates a Storm parser topology</li> + +<li>Input: + +<ul> + +<li>name - Parser name</li> + </ul></li> + +<li>Returns: + +<ul> + +<li>200 - Returns deactivate response message</li> + </ul></li> +</ul></div> +<div class="section"> +<h3><a name="GET_apiv1stormparserstartname"></a><tt>GET /api/v1/storm/parser/start/{name}</tt></h3> + +<ul> + +<li>Description: Starts a Storm parser topology</li> + +<li>Input: + +<ul> + +<li>name - Parser name</li> + </ul></li> + +<li>Returns: + +<ul> + +<li>200 - Returns start response message</li> + </ul></li> +</ul></div> +<div class="section"> +<h3><a name="GET_apiv1stormparserstopname"></a><tt>GET /api/v1/storm/parser/stop/{name}</tt></h3> + +<ul> + +<li>Description: Stops a Storm parser topology</li> + +<li>Input: + +<ul> + +<li>name - Parser name</li> + +<li>stopNow - Stop the topology immediately</li> + </ul></li> + +<li>Returns: + +<ul> + +<li>200 - Returns stop response message</li> + </ul></li> +</ul></div> +<div class="section"> +<h3><a name="GET_apiv1stormname"></a><tt>GET /api/v1/storm/{name}</tt></h3> + +<ul> + +<li>Description: Retrieves the status of a Storm topology</li> + +<li>Input: + +<ul> + +<li>name - Topology name</li> + </ul></li> + +<li>Returns: + +<ul> + +<li>200 - Returns topology status information</li> + +<li>404 - Topology is missing</li> + </ul></li> +</ul></div> +<div class="section"> +<h3><a name="GET_apiv1user"></a><tt>GET /api/v1/user</tt></h3> + +<ul> + +<li>Description: Retrieves the current user</li> + +<li>Returns: + +<ul> + +<li>200 - Current user</li> + </ul></li> +</ul></div></div> +<div class="section"> +<h2><a name="Testing"></a>Testing</h2> +<p>Profiles are includes for both the metron-docker and Quick Dev environments.</p> +<div class="section"> +<h3><a name="metron-docker"></a>metron-docker</h3> +<p>Start the <a href="../../metron-docker/index.html">metron-docker</a> environment. Build the metron-rest module and start it with the Spring Boot Maven plugin:</p> + +<div class="source"> +<div class="source"> +<pre>mvn clean package +mvn spring-boot:run -Drun.profiles=docker,dev +</pre></div></div> +<p>The metron-rest application will be available at <a class="externalLink" href="http://localhost:8080/swagger-ui.html#/";>http://localhost:8080/swagger-ui.html#/</a>.</p></div> +<div class="section"> +<h3><a name="Quick_Dev"></a>Quick Dev</h3> +<p>Start the <a href="../../metron-deployment/vagrant/quick-dev-platform/index.html">Quick Dev</a> environment. Build the metron-rest module and start it with the Spring Boot Maven plugin:</p> + +<div class="source"> +<div class="source"> +<pre>mvn clean package +mvn spring-boot:run -Drun.profiles=vagrant,dev +</pre></div></div> +<p>The metron-rest application will be available at <a class="externalLink" href="http://localhost:8080/swagger-ui.html#/";>http://localhost:8080/swagger-ui.html#/</a>.</p> +<p>To run the application locally on the Quick Dev host (node1), follow the <a href="#Installation">Installation</a> instructions above. Then set the METRON_SPRING_PROFILES_ACTIVE variable in <tt>/etc/sysconfig/metron</tt>:</p> + +<div class="source"> +<div class="source"> +<pre>METRON_SPRING_PROFILES_ACTIVE="vagrant,dev" +</pre></div></div> +<p>and start the application:</p> + +<div class="source"> +<div class="source"> +<pre>service metron-rest start +</pre></div></div> +<p>In a cluster with Kerberos enabled, update the security settings in <tt>/etc/sysconfig/metron</tt>. Security is disabled by default in the <tt>vagrant</tt> Spring profile so that setting must be overriden with the METRON_SPRING_OPTIONS variable:</p> + +<div class="source"> +<div class="source"> +<pre>METRON_SPRING_PROFILES_ACTIVE="vagrant,dev" +METRON_JVMFLAGS="-Djava.security.auth.login.config=$METRON_HOME/client_jaas.conf" +METRON_SPRING_OPTIONS="--kerberos.enabled=true" +</pre></div></div> +<p>The metron-rest application will be available at <a class="externalLink" href="http://node1:8082/swagger-ui.html#/";>http://node1:8082/swagger-ui.html#/</a>.</p></div></div> +<div class="section"> +<h2><a name="License"></a>License</h2> +<p>This project depends on the Java Transaction API. See <a class="externalLink" href="https://java.net/projects/jta-spec/";>https://java.net/projects/jta-spec/</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>
http://git-wip-us.apache.org/repos/asf/metron/blob/cf4c2ecd/current-book/metron-platform/index.html ---------------------------------------------------------------------- diff --git a/current-book/metron-platform/index.html b/current-book/metron-platform/index.html index 0546ef1..44c1804 100644 --- a/current-book/metron-platform/index.html +++ b/current-book/metron-platform/index.html @@ -1,13 +1,13 @@ <!DOCTYPE html> <!-- - | Generated by Apache Maven Doxia at 2017-02-23 + | Generated by Apache Maven Doxia at 2017-06-27 | 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="20170223" /> + <meta name="Date-Revision-yyyymmdd" content="20170627" /> <meta http-equiv="Content-Language" content="en" /> <title>Metron – Current Build</title> <link rel="stylesheet" href="../css/apache-maven-fluido-1.3.0.min.css" /> @@ -30,14 +30,11 @@ <div class="container-fluid"> <div id="banner"> <div class="pull-left"> - <a href="http://metron.incubator.apache.org/"; id="bannerLeft"> - <img src="../images/metron-logo.png" alt="Apache Metron - Incubating" width="148px" height="48px"/> + <a 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"> <a href="http://incubator.apache.org/"; id="bannerRight"> - <img src="../images/ApacheIncubating_Logo.png" alt="Apache Incubating" width="192px" height="48px"/> - </a> - </div> + <div class="pull-right"> </div> <div class="clear"><hr/></div> </div> @@ -51,8 +48,8 @@ </li> <li class="divider ">/</li> <li class=""> - <a href="http://metron.incubator.apache.org/"; class="externalLink" title="Metron-Incubating"> - Metron-Incubating</a> + <a href="http://metron.apache.org/"; class="externalLink" title="Metron"> + Metron</a> </li> <li class="divider ">/</li> <li class=""> @@ -64,8 +61,8 @@ - <li id="publishDate" class="pull-right">Last Published: 2017-02-23</li> <li class="divider pull-right">|</li> - <li id="projectVersion" class="pull-right">Version: 0.3.1</li> + <li id="publishDate" class="pull-right">Last Published: 2017-06-27</li> <li class="divider pull-right">|</li> + <li id="projectVersion" class="pull-right">Version: 0.4.0</li> </ul> </div> @@ -78,7 +75,7 @@ <ul class="nav nav-list"> <li class="nav-header">User Documentation</li> - + <li> <a href="../index.html" title="Metron"> @@ -99,7 +96,7 @@ <i class="icon-chevron-right"></i> Analytics</a> </li> - + <li> <a href="../metron-deployment/index.html" title="Deployment"> @@ -113,7 +110,21 @@ <i class="none"></i> Docker</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 class="active"> <a href="#"><i class="icon-chevron-down"></i>Platform</a> @@ -125,13 +136,13 @@ <i class="none"></i> Api</a> </li> - + <li> <a href="../metron-platform/metron-common/index.html" title="Common"> - <i class="none"></i> + <i class="icon-chevron-right"></i> Common</a> - </li> + </li> <li> @@ -174,9 +185,16 @@ <i class="none"></i> Pcap-backend</a> </li> + + <li> + + <a href="../metron-platform/metron-writer/index.html" title="Writer"> + <i class="none"></i> + Writer</a> + </li> </ul> </li> - + <li> <a href="../metron-sensors/index.html" title="Sensors"> @@ -220,11 +238,11 @@ 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>Current Build</h1> <p><a name="Current_Build"></a></p> -<p>The latest build of metron-platform is 0.3.1.</p> +<p>The latest build of metron-platform is 0.4.0.</p> <p>We are still in the process of merging/porting additional features from our production code base into this open source release. This release will be followed by a number of additional beta releases until the port is complete. We will also work on getting additional documentation and user/developer guides to the community as soon as we can. At this time we offer no support for the beta software, but will try to respond to requests as promptly as we can.</p> <p><a name="metron-platform"></a></p> <h1>metron-platform</h1> -<p>Extensible set of Storm topologies and topology attributes for streaming, enriching, indexing, and storing telemetry in Hadoop. General information on Metron is available at <a class="externalLink" href="https://metron.incubator.apache.org/";>https://metron.incubator.apache.org/</a></p> +<p>Extensible set of Storm topologies and topology attributes for streaming, enriching, indexing, and storing telemetry in Hadoop. General information on Metron is available at <a class="externalLink" href="https://metron.apache.org/";>https://metron.apache.org/</a></p> <p><a name="Documentation"></a></p> <h1>Documentation</h1> <p>Please see documentation within each individual module for description and usage instructions. Sample topologies are provided under Metron_Topologies to get you started with the framework. We pre-assume knowledge of Hadoop, Storm, Kafka, and HBase.</p> @@ -236,8 +254,9 @@ limitations under the License. --><h1>Current Build</h1> <footer> <div class="container-fluid"> - <div class="row span12">Copyright © 2017. - All Rights Reserved. + <div class="row span12">Copyright © 2017 + <a href="https://www.apache.org";>The Apache Software Foundation</a>. + All Rights Reserved. </div> http://git-wip-us.apache.org/repos/asf/metron/blob/cf4c2ecd/current-book/metron-platform/metron-api/index.html ---------------------------------------------------------------------- diff --git a/current-book/metron-platform/metron-api/index.html b/current-book/metron-platform/metron-api/index.html index fe2b9a6..607e4aa 100644 --- a/current-book/metron-platform/metron-api/index.html +++ b/current-book/metron-platform/metron-api/index.html @@ -1,13 +1,13 @@ <!DOCTYPE html> <!-- - | Generated by Apache Maven Doxia at 2017-02-23 + | Generated by Apache Maven Doxia at 2017-06-27 | 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="20170223" /> + <meta name="Date-Revision-yyyymmdd" content="20170627" /> <meta http-equiv="Content-Language" content="en" /> <title>Metron – Metron PCAP Service</title> <link rel="stylesheet" href="../../css/apache-maven-fluido-1.3.0.min.css" /> @@ -30,14 +30,11 @@ <div class="container-fluid"> <div id="banner"> <div class="pull-left"> - <a href="http://metron.incubator.apache.org/"; id="bannerLeft"> - <img src="../../images/metron-logo.png" alt="Apache Metron - Incubating" width="148px" height="48px"/> + <a 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"> <a href="http://incubator.apache.org/"; id="bannerRight"> - <img src="../../images/ApacheIncubating_Logo.png" alt="Apache Incubating" width="192px" height="48px"/> - </a> - </div> + <div class="pull-right"> </div> <div class="clear"><hr/></div> </div> @@ -51,8 +48,8 @@ </li> <li class="divider ">/</li> <li class=""> - <a href="http://metron.incubator.apache.org/"; class="externalLink" title="Metron-Incubating"> - Metron-Incubating</a> + <a href="http://metron.apache.org/"; class="externalLink" title="Metron"> + Metron</a> </li> <li class="divider ">/</li> <li class=""> @@ -64,8 +61,8 @@ - <li id="publishDate" class="pull-right">Last Published: 2017-02-23</li> <li class="divider pull-right">|</li> - <li id="projectVersion" class="pull-right">Version: 0.3.1</li> + <li id="publishDate" class="pull-right">Last Published: 2017-06-27</li> <li class="divider pull-right">|</li> + <li id="projectVersion" class="pull-right">Version: 0.4.0</li> </ul> </div> @@ -78,7 +75,7 @@ <ul class="nav nav-list"> <li class="nav-header">User Documentation</li> - + <li> <a href="../../index.html" title="Metron"> @@ -99,7 +96,7 @@ <i class="icon-chevron-right"></i> Analytics</a> </li> - + <li> <a href="../../metron-deployment/index.html" title="Deployment"> @@ -113,7 +110,21 @@ <i class="none"></i> Docker</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"> @@ -125,13 +136,13 @@ <a href="#"><i class="none"></i>Api</a> </li> - + <li> <a href="../../metron-platform/metron-common/index.html" title="Common"> - <i class="none"></i> + <i class="icon-chevron-right"></i> Common</a> - </li> + </li> <li> @@ -174,9 +185,16 @@ <i class="none"></i> Pcap-backend</a> </li> + + <li> + + <a href="../../metron-platform/metron-writer/index.html" title="Writer"> + <i class="none"></i> + Writer</a> + </li> </ul> </li> - + <li> <a href="../../metron-sensors/index.html" title="Sensors"> @@ -272,8 +290,9 @@ <footer> <div class="container-fluid"> - <div class="row span12">Copyright © 2017. - All Rights Reserved. + <div class="row span12">Copyright © 2017 + <a href="https://www.apache.org";>The Apache Software Foundation</a>. + All Rights Reserved. </div>
