Repository: metron Updated Branches: refs/heads/asf-site 7152bce7b -> cf4c2ecde
http://git-wip-us.apache.org/repos/asf/metron/blob/cf4c2ecd/current-book/metron-sensors/pycapa/index.html ---------------------------------------------------------------------- diff --git a/current-book/metron-sensors/pycapa/index.html b/current-book/metron-sensors/pycapa/index.html index 0841338..4bdd35c 100644 --- a/current-book/metron-sensors/pycapa/index.html +++ b/current-book/metron-sensors/pycapa/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 – Pycapa</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,14 +110,28 @@ <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"> <i class="icon-chevron-right"></i> Platform</a> </li> - + <li> <a href="../../metron-sensors/index.html" title="Sensors"> @@ -130,6 +141,13 @@ <li> + <a href="../../metron-sensors/bro-plugin-kafka/index.html" title="Bro-plugin-kafka"> + <i class="none"></i> + Bro-plugin-kafka</a> + </li> + + <li> + <a href="../../metron-sensors/fastcapa/index.html" title="Fastcapa"> <i class="none"></i> Fastcapa</a> @@ -163,84 +181,351 @@ <div id="bodyColumn" class="span9" > - <h1>Pycapa</h1> -<p><a name="Pycapa"></a></p> -<div class="section"> -<h2><a name="Overview"></a>Overview</h2> -<p>Pycapa performs network packet capture, both off-the-wire and from Kafka, which is useful for the testing and development of <a class="externalLink" href="https://github.com/apache/incubator-metron";>Apache Metron</a>. It is not intended for production use. The tool will capture packets from a specified interface and push them into a Kafka Topic.</p></div> -<div class="section"> -<h2><a name="Installation"></a>Installation</h2> + <div class="section"> +<h2><a name="Pycapa"></a>Pycapa</h2> +<ul> + +<li><a href="#Overview">Overview</a></li> + +<li><a href="#Installation">Installation</a></li> + +<li><a href="#Usage">Usage</a> + +<ul> + +<li><a href="#Parameters">Parameters</a></li> + +<li><a href="#Examples">Examples</a></li> + +<li><a href="#Kerberos">Kerberos</a></li> + </ul></li> + +<li><a href="#FAQs">FAQs</a></li> +</ul> +<h1>Overview</h1> +<p>Pycapa performs network packet capture, both off-the-wire and from a Kafka topic, which is useful for the testing and development of <a class="externalLink" href="https://github.com/apache/metron";>Apache Metron</a>. It is not intended for production use. The tool will capture packets from a specified interface and push them into a Kafka Topic. The tool can also do the reverse. It can consume packets from Kafka and reconstruct each network packet. This can then be used to create a <a class="externalLink" href="https://wiki.wireshark.org/Development/LibpcapFileFormat";>libpcap-compliant file</a> or even to feed directly into a tool like Wireshark to monitor ongoing activity.</p> +<h1>Installation</h1> +<p>General notes on the installation of Pycapa.</p> + +<ul> + +<li>Python 2.7 is required.</li> + +<li>The following package dependencies are required and can be installed automatically with <tt>pip</tt>. + +<ul> + +<li><a class="externalLink" href="https://github.com/confluentinc/confluent-kafka-python";>confluent-kafka-python</a></li> + +<li><a class="externalLink" href="https://github.com/CoreSecurity/pcapy";>pcapy</a></li> + </ul></li> + +<li>These instructions can be used directly on CentOS 7+.</li> + +<li>Other Linux distributions that come with Python 2.7 can use these instructions with some minor modifications.</li> + +<li>Older distributions, like CentOS 6, that come with Python 2.6 installed, should install Python 2.7 within a virtual environment and then run Pycapa from within the virtual environment.</li> +</ul> + +<ol style="list-style-type: decimal"> + +<li> +<p>Install system dependencies including the core development tools, Python libraries and header files, and Libpcap libraries and header files. On CentOS 7+, you can install these requirements with the following command.</p> + +<div class="source"> +<div class="source"> +<pre> yum -y install "@Development tools" python-devel libpcap-devel +</pre></div></div></li> + +<li> +<p>Install Librdkafka at your chosen $PREFIX.</p> + +<div class="source"> +<div class="source"> +<pre> export PREFIX=/usr + wget https://github.com/edenhill/librdkafka/archive/v0.9.4.tar.gz -O - | tar -xz + cd librdkafka-0.9.4/ + ./configure --prefix=$PREFIX + make + make install +</pre></div></div></li> + +<li> +<p>Add Librdkafka to the dynamic library load path.</p> + +<div class="source"> +<div class="source"> +<pre>echo "$PREFIX/lib" >> /etc/ld.so.conf.d/pycapa.conf +ldconfig -v +</pre></div></div></li> + +<li> +<p>Install Pycapa. This assumes that you already have the Metron source code on the host.</p> + <div class="source"> <div class="source"> -<pre>pip install -r requirements.txt +<pre>cd metron/metron-sensors/pycapa +pip install -r requirements.txt python setup.py install -</pre></div></div></div> +</pre></div></div></li> +</ol> +<h1>Usage</h1> +<p>Pycapa has two primary runtime modes.</p> + +<ul> + +<li> +<p><b>Producer Mode</b>: Pycapa can capture packets from a network interface and forward those packets to a Kafka topic. Pycapa embeds the raw network packet data in the Kafka message body. The message key contains the timestamp indicating when the packet was captured in microseconds from the epoch, in network byte order.</p></li> + +<li> +<p><b>Consumer Mode</b>: Pycapa can also perform the reverse operation. It can consume packets from Kafka and reconstruct each network packet. This can then be used to create a <a class="externalLink" href="https://wiki.wireshark.org/Development/LibpcapFileFormat";>libpcap-compliant file</a> or even to feed directly into a tool like Wireshark to monitor activity.</p></li> +</ul> <div class="section"> -<h2><a name="Usage"></a>Usage</h2> +<h3><a name="Parameters"></a>Parameters</h3> <div class="source"> <div class="source"> <pre>$ pycapa --help -usage: pycapa [-h] [-p] [-c] [-k KAFKA_BROKERS] [-t TOPIC] [-n PACKET_COUNT] - [-d DEBUG] [-i INTERFACE] +usage: pycapa [-h] [-p] [-c] [-k KAFKA_BROKERS] [-t KAFKA_TOPIC] + [-o {begin,end,stored}] [-i NETWORK_IFACE] [-m MAX_PACKETS] + [-pp PRETTY_PRINT] [-ll LOG_LEVEL] [-X KAFKA_CONFIGS] + [-s SNAPLEN] optional arguments: -h, --help show this help message and exit -p, --producer sniff packets and send to kafka -c, --consumer read packets from kafka - -k KAFKA_BROKERS, --kafka KAFKA_BROKERS - kafka broker(s) - -t TOPIC, --topic TOPIC + -k KAFKA_BROKERS, --kafka-broker KAFKA_BROKERS + kafka broker(s) as host:port + -t KAFKA_TOPIC, --kafka-topic KAFKA_TOPIC kafka topic - -n PACKET_COUNT, --number PACKET_COUNT - number of packets to consume - -d DEBUG, --debug DEBUG - debug every X packets - -i INTERFACE, --interface INTERFACE - interface to listen on -</pre></div></div> -<p>Pycapa has two primary runtime modes.</p> + -o {begin,end,stored}, --kafka-offset {begin,end,stored} + kafka offset to consume from; default=end + -i NETWORK_IFACE, --interface NETWORK_IFACE + network interface to listen on + -m MAX_PACKETS, --max-packets MAX_PACKETS + stop after this number of packets + -pp PRETTY_PRINT, --pretty-print PRETTY_PRINT + pretty print every X packets + -ll LOG_LEVEL, --log-level LOG_LEVEL + set the log level; DEBUG, INFO, WARN + -X KAFKA_CONFIGS define a kafka client parameter; key=value + -s SNAPLEN, --snaplen SNAPLEN + capture only the first X bytes of each packet; + default=65535 +</pre></div></div></div> +<div class="section"> +<h3><a name="Examples"></a>Examples</h3> <div class="section"> -<h3><a name="Producer_Mode"></a>Producer Mode</h3> -<p>Pycapa can be configured to capture packets from a network interface and then forward those packets to a Kafka topic. The following example will capture packets from the <tt>eth0</tt> network interface and forward those to a Kafka topic called <tt>pcap</tt> running on <tt>localhost</tt>.</p> +<h4><a name="Example_1"></a>Example 1</h4> +<p>Capture 10 packets from the <tt>eth0</tt> network interface and forward those to a Kafka topic called <tt>pcap</tt> running on <tt>localhost:9092</tt>. The process will not terminate until all messages have been delivered to Kafka.</p> <div class="source"> <div class="source"> -<pre>pycapa --producer --kafka localhost:9092 --topic pcap -i eth0 -</pre></div></div> -<p>To output debug messages every 100 captured packets, run the following.</p> +<pre>$ pycapa --producer \ + --interface eth0 \ + --kafka-broker localhost:9092 \ + --kafka-topic pcap \ + --max-packets 10 +INFO:root:Connecting to Kafka; {'bootstrap.servers': 'localhost:9092', 'group.id': 'AWBHMIAESAHJ'} +INFO:root:Starting packet capture +INFO:root:Waiting for '6' message(s) to flush +INFO:root:'10' packet(s) in, '10' packet(s) out +</pre></div></div></div> +<div class="section"> +<h4><a name="Example_2"></a>Example 2</h4> +<p>Capture packets until SIGINT is received (the interrupt signal sent when entering CTRL-C in the console.) In this example, nothing will be reported as packets are captured and delivered to Kafka. Simply wait a few seconds, then type CTRL-C and the number of packets will be reported.</p> <div class="source"> <div class="source"> -<pre>pycapa --producer --kafka localhost:9092 --topic pcap -i eth0 --debug 100 +<pre>$ pycapa --producer \ + --interface en0 \ + --kafka-broker localhost:9092 \ + --kafka-topic pcap +INFO:root:Connecting to Kafka; {'bootstrap.servers': 'localhost:9092', 'group.id': 'EULLGDOMZDCT'} +INFO:root:Starting packet capture +^C +INFO:root:Clean shutdown process started +INFO:root:Waiting for '2' message(s) to flush +INFO:root:'21' packet(s) in, '21' packet(s) out </pre></div></div></div> <div class="section"> -<h3><a name="Consumer_Mode"></a>Consumer Mode</h3> -<p>Pycapa can be configured to consume packets from a Kafka topic and then write those packets to a <a class="externalLink" href="https://wiki.wireshark.org/Development/LibpcapFileFormat";>libpcap-compliant file</a>. To read 100 packets from a kafka topic and then write those to a <a class="externalLink" href="https://wiki.wireshark.org/Development/LibpcapFileFormat";>libpcap-compliant file</a>, run the following command. The file <tt>out.pcap</tt> can then be opened with a tool such as Wireshark for further validation.</p> +<h4><a name="Example_3"></a>Example 3</h4> +<p>While capturing packets, output diagnostic information every 5 packets. Diagnostics will report when packets have been received from the network interface and when they have been successfully delivered to Kafka.</p> <div class="source"> <div class="source"> -<pre>pycapa --consumer --kafka localhost:9092 --topic pcap --n 100 > out.pcap -</pre></div></div> -<p>To consume packets from Kafka continuously and print debug messages every 10 packets, run the following command. </p> +<pre>$ pycapa --producer \ + --interface eth0 \ + --kafka-broker localhost:9092 \ + --kafka-topic pcap \ + --pretty-print 5 + INFO:root:Connecting to Kafka; {'bootstrap.servers': 'localhost:9092', 'group.id': 'UAWINMBDNQEH'} + INFO:root:Starting packet capture + Packet received[5] + Packet delivered[5]: date=2017-05-08 14:48:54.474031 topic=pcap partition=0 offset=29086 len=42 + Packet received[10] + Packet received[15] + Packet delivered[10]: date=2017-05-08 14:48:58.879710 topic=pcap partition=0 offset=0 len=187 + Packet delivered[15]: date=2017-05-08 14:48:59.633127 topic=pcap partition=0 offset=0 len=43 + Packet received[20] + Packet delivered[20]: date=2017-05-08 14:49:01.949628 topic=pcap partition=0 offset=29101 len=134 + Packet received[25] + ^C + INFO:root:Clean shutdown process started + Packet delivered[25]: date=2017-05-08 14:49:03.589940 topic=pcap partition=0 offset=0 len=142 + INFO:root:Waiting for '1' message(s) to flush + INFO:root:'27' packet(s) in, '27' packet(s) out + +</pre></div></div></div> +<div class="section"> +<h4><a name="Example_4"></a>Example 4</h4> +<p>Consume 10 packets and create a libpcap-compliant pcap file.</p> + +<div class="source"> +<div class="source"> +<pre> $ pycapa --consumer \ + --kafka-broker localhost:9092 \ + --kafka-topic pcap \ + --max-packets 10 \ + > out.pcap + $ tshark -r out.pcap + 1 0.000000 199.193.204.147 → 192.168.0.3 TLSv1.2 151 Application Data + 2 0.000005 199.193.204.147 → 192.168.0.3 TLSv1.2 1191 Application Data + 3 0.000088 192.168.0.3 → 199.193.204.147 TCP 66 54788 → 443 [ACK] Seq=1 Ack=86 Win=4093 Len=0 TSval=961284465 TSecr=943744612 + 4 0.000089 192.168.0.3 → 199.193.204.147 TCP 66 54788 → 443 [ACK] Seq=1 Ack=1211 Win=4058 Len=0 TSval=961284465 TSecr=943744612 + 5 0.948788 192.168.0.3 → 192.30.253.125 TCP 54 54671 → 443 [ACK] Seq=1 Ack=1 Win=4096 Len=0 + 6 1.005175 192.30.253.125 → 192.168.0.3 TCP 66 [TCP ACKed unseen segment] 443 → 54671 [ACK] Seq=1 Ack=2 Win=31 Len=0 TSval=2658544467 TSecr=961240339 + 7 1.636312 fe80::1286:8cff:fe0e:65df → ff02::1 ICMPv6 134 Router Advertisement from 10:86:8c:0e:65:df + 8 2.253052 192.175.27.112 → 192.168.0.3 TLSv1.2 928 Application Data + 9 2.253140 192.168.0.3 → 192.175.27.112 TCP 66 55078 → 443 [ACK] Seq=1 Ack=863 Win=4069 Len=0 TSval=961286699 TSecr=967172238 + 10 2.494769 192.168.0.3 → 224.0.0.251 MDNS 82 Standard query 0x0000 PTR _googlecast._tcp.local, "QM" question +</pre></div></div></div> +<div class="section"> +<h4><a name="Example_5"></a>Example 5</h4> +<p>Consume 10 packets from the Kafka topic <tt>pcap</tt> running on <tt>localhost:9092</tt>, then pipe those into Wireshark for DPI.</p> <div class="source"> <div class="source"> -<pre>pycapa --consumer --kafka localhost:9092 --topic pcap --debug 10 +<pre>$ pycapa --consumer \ + --kafka-broker localhost:9092 \ + --kafka-topic pcap \ + --max-packets 10 \ + | tshark -i - +Capturing on 'Standard input' + 1 0.000000 ArrisGro_0e:65:df → Apple_bf:0d:43 ARP 56 Who has 192.168.0.3? Tell 192.168.0.1 + 2 0.000044 Apple_bf:0d:43 → ArrisGro_0e:65:df ARP 42 192.168.0.3 is at ac:bc:32:bf:0d:43 + 3 0.203495 fe80::1286:8cff:fe0e:65df → ff02::1 ICMPv6 134 Router Advertisement from 10:86:8c:0e:65:df + 4 2.031988 192.168.0.3 → 96.27.183.249 TCP 54 55110 → 443 [ACK] Seq=1 Ack=1 Win=4108 Len=0 + 5 2.035816 192.30.253.125 → 192.168.0.3 TLSv1.2 97 Application Data + 6 2.035892 192.168.0.3 → 192.30.253.125 TCP 66 54671 → 443 [ACK] Seq=1 Ack=32 Win=4095 Len=0 TSval=961120495 TSecr=2658503052 + 7 2.035994 192.168.0.3 → 192.30.253.125 TLSv1.2 101 Application Data + 8 2.053866 96.27.183.249 → 192.168.0.3 TCP 66 [TCP ACKed unseen segment] 443 → 55110 [ACK] Seq=1 Ack=2 Win=243 Len=0 TSval=728145145 TSecr=961030381 + 9 2.083872 192.30.253.125 → 192.168.0.3 TCP 66 443 → 54671 [ACK] Seq=32 Ack=36 Win=31 Len=0 TSval=2658503087 TSecr=961120495 + 10 3.173189 fe80::1286:8cff:fe0e:65df → ff02::1 ICMPv6 134 Router Advertisement from 10:86:8c:0e:65:df +10 packets captured </pre></div></div></div></div> <div class="section"> -<h2><a name="Dependencies"></a>Dependencies</h2> +<h3><a name="Kerberos"></a>Kerberos</h3> +<p>The probe can be used in a Kerberized environment. Follow these additional steps to use Pycapa with Kerberos. The following assumptions have been made. These may need altered to fit your environment.</p> <ul> -<li><a class="externalLink" href="https://github.com/dpkp/kafka-python";>kafka-python</a></li> +<li>The Kafka broker is at <tt>kafka1:6667</tt></li> -<li><a class="externalLink" href="https://github.com/CoreSecurity/pcapy";>pcapy</a></li> -</ul></div> -<div class="section"> -<h2><a name="Implementation"></a>Implementation</h2> -<p>When run in Producer Mode, Pycapa embeds the raw network packet data in the Kafka message. The message key contains the timestamp indicating when the packet was captured in microseconds from the epoch. This value is in network byte order.</p></div> +<li>Zookeeper is at <tt>zookeeper1:2181</tt></li> + +<li>The Kafka security protocol is <tt>SASL_PLAINTEXT</tt></li> + +<li>The keytab used is located at <tt>/etc/security/keytabs/metron.headless.keytab</tt></li> + +<li>The service principal is <tt>[email protected]</tt></li> +</ul> + +<ol style="list-style-type: decimal"> + +<li> +<p>Build Librdkafka with SASL support (<tt>--enable-sasl</tt>) and install at your chosen $PREFIX.</p> + +<div class="source"> +<div class="source"> +<pre>wget https://github.com/edenhill/librdkafka/archive/v0.9.4.tar.gz -O - | tar -xz +cd librdkafka-0.9.4/ +./configure --prefix=$PREFIX --enable-sasl +make +make install +</pre></div></div></li> + +<li> +<p>Validate Librdkafka does indeed support SASL. Run the following command and ensure that <tt>sasl</tt> is returned as a built-in feature.</p> + +<div class="source"> +<div class="source"> +<pre>$ examples/rdkafka_example -X builtin.features +builtin.features = gzip,snappy,ssl,sasl,regex +</pre></div></div> +<p>If it is not, ensure that you have <tt>libsasl</tt> or <tt>libsasl2</tt> installed. On CentOS, this can be installed with the following command.</p> + +<div class="source"> +<div class="source"> +<pre>yum install -y cyrus-sasl cyrus-sasl-devel cyrus-sasl-gssapi +</pre></div></div></li> + +<li> +<p>Grant access to your Kafka topic. In this example the topic is simply named <tt>pcap</tt>.</p> + +<div class="source"> +<div class="source"> +<pre>${KAFKA_HOME}/bin/kafka-acls.sh \ + --authorizer kafka.security.auth.SimpleAclAuthorizer \ + --authorizer-properties zookeeper.connect=zookeeper1:2181 \ + --add \ + --allow-principal User:metron \ + --topic pcap +${KAFKA_HOME}/bin/kafka-acls.sh \ + --authorizer kafka.security.auth.SimpleAclAuthorizer \ + --authorizer-properties zookeeper.connect=zookeeper1:2181 \ + --add \ + --allow-principal User:metron \ + --group pycapa +</pre></div></div></li> + +<li> +<p>Use Pycapa as you normally would, but append the following three additional parameters</p> + +<ul> + +<li><tt>security.protocol</tt></li> + +<li><tt>sasl.kerberos.keytab</tt></li> + +<li><tt>sasl.kerberos.principal</tt></li> + </ul> + +<div class="source"> +<div class="source"> +<pre> $ pycapa --producer \ + --interface eth0 \ + --kafka-broker kafka1:6667 \ + --kafka-topic pcap --max-packets 10 \ + -X security.protocol=SASL_PLAINTEXT \ + -X sasl.kerberos.keytab=/etc/security/keytabs/metron.headless.keytab \ + -X [email protected] + INFO:root:Connecting to Kafka; {'sasl.kerberos.principal': '[email protected]', 'group.id': 'ORNLVWJZZUAA', 'security.protocol': 'SASL_PLAINTEXT', 'sasl.kerberos.keytab': '/etc/security/keytabs/metron.headless.keytab', 'bootstrap.servers': 'kafka1:6667'} + INFO:root:Starting packet capture + INFO:root:Waiting for '1' message(s) to flush + INFO:root:'10' packet(s) in, '10' packet(s) out +</pre></div></div></li> +</ol> +<h1>FAQs</h1> +<p><b>Question</b>: How do I get more logs?</p> +<p>Use the following two command-line arguments to get detailed logging.</p> + +<div class="source"> +<div class="source"> +<pre>-X debug=all --log-level DEBUG +</pre></div></div></div></div> </div> </div> </div> @@ -249,8 +534,9 @@ optional arguments: <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/develop/bylaws/index.html ---------------------------------------------------------------------- diff --git a/develop/bylaws/index.html b/develop/bylaws/index.html new file mode 100644 index 0000000..8a2be3b --- /dev/null +++ b/develop/bylaws/index.html @@ -0,0 +1,508 @@ +<!DOCTYPE html> + +<html lang="en-US" prefix="og: http://ogp.me/ns#"; ng-app="hortonWorksApp"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><style type="text/css">@charset "UTF-8";[ng\:cloak],[ng-cloak],[data-ng-cloak],[x-ng-cloak],.ng-cloak,.x-ng-cloak,.ng-hide:not(.ng-hide-animate){display:none !important;}ng\:form{display:block;}.ng-animate-shim{visibility:hidden;}.ng-anchor{position:absolute;}</style> + + <meta name="viewport" content="width=device-width, height=device-height, initial-scale=1.0, user-scalable=0, minimum-scale=1.0, maximum-scale=1.0"> + <link rel="profile" href="http://gmpg.org/xfn/11";> + <title>Apache Metron Bylaws</title> + + <style type="text/css"> + img.wp-smiley, + img.emoji { + display: inline !important; + border: none !important; + box-shadow: none !important; + height: 1em !important; + width: 1em !important; + margin: 0 .07em !important; + vertical-align: -0.1em !important; + background: none !important; + padding: 0 !important; + } + </style> + + <script> + (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ + (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), + m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) + })(window,document,'script','https://www.google-analytics.com/analytics.js','ga'); + + ga('create', 'UA-78972211-1', 'auto'); + ga('send', 'pageview'); + + </script> + + <link rel="stylesheet" id="default-css" href="/css/default.css" type="text/css" media="all"> + <link rel="stylesheet" id="legacy-css" href="/css/legacy.css" type="text/css" media="all"> + <link rel="stylesheet" id="gravityforms-css" href="/css/gravityforms.css" type="text/css" media="all"> + <link rel="stylesheet" id="selectboxit-css" href="/css/selectBoxIt.css" type="text/css" media="all"> + <link href='http://fonts.googleapis.com/css?family=Roboto%20Condensed' rel='stylesheet' type='text/css'> + + <script type="text/javascript" src="/js/jquery.js"></script> + <script type="text/javascript" src="/js/jquery-migrate.min.js"></script> + <script type="text/javascript" src="/js/jquery.mobile.custom.min.js"></script> + <script type="text/javascript" src="/js/isotope.pkgd.min.js"></script> + <script type="text/javascript" src="/js/navigation.js"></script> + <script type="text/javascript" src="/js/slider.js"></script> + <script type="text/javascript" src="/js/jquery.classyloader.js"></script> + <script type="text/javascript" src="/js/hero-slider.js"></script> + <script type="text/javascript" src="/js/footer.js"></script> + <script type="text/javascript" src="/js/top-form.js"></script> + <script type="text/javascript" src="/js/local6.js"></script> + <script type="text/javascript" src="/js/select-list.js"></script> + <script type="text/javascript" src="/js/legacy.js"></script> + <script type="text/javascript" src="/js/paralax-scroll.js"></script> + <script type="text/javascript" src="/js/jquery-ui.min.js"></script> + <script type="text/javascript" src="/js/jquery.selectBoxIt.min.js"></script> + <script type="text/javascript" src="/js/scroll-slider.js"></script> + <script type="text/javascript" src="/js/charts-animate.js"></script> + <script type="text/javascript" src="/js/dotdotdot.js"></script> + <script type="text/javascript" src="/js/products_scroll.js"></script> + <script type="text/javascript" src="/js/parallax.min.js"></script> + <script type="text/javascript" src="/js/parallax.js"></script> + <script type="text/javascript" src="/js/shb0wjr.js"></script> + + <script> + window.lsfDataLayer = window.lsfDataLayer || []; + </script> + + <style> + body { + font-family: "roboto-condensed", sans-serif; + } + </style> + + <!-- Angular js files --> + <script src="/js/angular.min.js"></script> + <script src="/js/angular-animate.min.js"></script> + <script src="/js/app.js"></script> + <script src="/js/pressReleaseController.js"></script> + <script src="/js/eventCtrl.js"></script> + <!-- End Angular js files --> + <link rel="stylesheet" type="text/css" href="/css/prettify.css"> + <script type="text/javascript" async="" src="/js/munchkin-beta.js"></script> + <link type="text/css" href="/css/jquery-ui-insightera-custom-1.8.css" rel="stylesheet"> + <style id="style-1-cropbar-clipper"> + /* Copyright 2014 Evernote Corporation. All rights reserved. */ + + .en-markup-crop-options { + top: 18px !important; + left: 50% !important; + margin-left: -100px !important; + width: 200px !important; + border: 2px rgba(255, 255, 255, .38) solid !important; + border-radius: 4px !important; + } + + .en-markup-crop-options div div:first-of-type { + margin-left: 0px !important; + } + </style> +</head> + + +<body class="wrap"> + <header> + <div class="main-navigation" style="height: 85px;"> + <div class="main-nav fixed"> + <div class="wrapper"> + <div class="logo"> + <a href=""><img src="/img/logo.png" alt="Logo"></a> + </div> + <nav> + <div class="toggle"> + <span></span> + <span></span> + <span></span> + </div> + <div class="menu-wrapper" style="height: auto; display: block;"> + <ul class="main-menu"> + <li class="products-menu"><a href="/">Home</a> + </li> + <li class="solutions-menu"><a href="/about/">About</a> + </li> + <li class="services-menu"><a href="/documentation/">Documentation</a> + </li> + <li class="services-menu"><a href="/community/">Community</a> + </li> + <li class="training-menu"><a href="/news/">News</a> + </li> + <li> + <button class="button-default button-green" style="line-height:43px;"> <a>Download </a></button> + </li> +</ul> + + </div> + </nav> + </div> + </div> + </div> +</header> + + + <section class="standalone"> + <div class="grid"> + + <div class="unit whole"> + <article> + <h1>Apache Metron Bylaws</h1> + <h2 id="introduction">Introduction</h2> + +<p>This document defines the bylaws under which the Apache Metron project +operates. It defines the roles and responsibilities of the project, +who may vote, how voting works, how conflicts are resolved, etc.</p> + +<p>Metron is a project of the Apache Software Foundation (ASF) and the foundation +holds the trademark on the name âMetronâ and copyright on the combined +code base. The <a href="http://www.apache.org/foundation/faq.html";>Apache Foundation +FAQ</a> and +<a href="http://www.apache.org/foundation/how-it-works.html";>How-It-Works</a> +explain the operation and background of the foundation.</p> + +<p>Apache has a <a href="http://www.apache.org/foundation/policies/conduct.html";>code of +conduct</a> that +it expects its members to follow. In particular:</p> + +<ul> + <li> + <p>Be <strong>open and welcoming</strong>. It is important that we grow and +encourage the community of users and developers for our project.</p> + </li> + <li> + <p>Be <strong>collaborative</strong>. Working together on the open mailing lists and +bug database to make decisions helps the project grow.</p> + </li> + <li> + <p>Be <strong>respectful</strong> of others. Everyone is volunteering their time and +efforts to work on this project. Please be respectful of everyone +and their views.</p> + </li> +</ul> + +<p>Metron is typical of Apache projects in that it operates under a set of +principles, known collectively as the âApache Wayâ. If you are new to +Apache development, please refer to +<a href="http://www.apache.org/foundation/how-it-works.html";>this</a> for more +information on how Apache projects operate.</p> + +<h2 id="roles-and-responsibilities">Roles and Responsibilities</h2> + +<p>Apache projects define a set of roles with associated rights and +responsibilities. These roles govern what tasks an individual may +perform within the project. The roles are defined in the following +sections.</p> + +<h3 id="users">Users</h3> + +<p>The most important participants in the project are people who use our +software. The majority of our developers start out as users and guide +their development efforts from the userâs perspective. Users +contribute to the Apache projects by providing feedback to developers +in the form of bug reports and feature suggestions. As well, users +participate in the Apache community by helping other users on mailing +lists and user support forums.</p> + +<h3 id="contributors">Contributors</h3> + +<p>Contributors include all of the volunteers who donate time, code, +documentation, +or resources to the Metron Project. A contributor that makes sustained, +welcome contributions to the project may be invited to become a +committer, though the exact timing of such invitations depends on many +factors.</p> + +<h3 id="committers">Committers</h3> + +<p>The projectâs committers are responsible for the projectâs technical +management. Committers have the right to commit to the projectâs git +repository. Committers may cast binding votes on any technical +discussion.</p> + +<p>Committer access is by invitation only and must be approved by +consensus approval of the active Project Management Committee (PMC) +members.</p> + +<p>If a committer wishes to leave the project or does not contribute to +the project in any form for six months, the PMC may make them emeritus. +Emeritus committers lose their ability to commit code or cast binding +votes. An emeritus committer may +request reinstatement of commit access from the PMC. Such +reinstatement is subject to consensus approval of active PMC members.</p> + +<p>All Apache committers are required to have a signed <a href="https://www.apache.org/licenses/icla.txt";>Individual +Contributor License +Agreement</a> (ICLA) on file +with the Apache Software Foundation. There is a <a href="http://www.apache.org/dev/committers.html";>Committer +FAQ</a> which provides more +details on the requirements for Committers.</p> + +<p>A committer who makes a +sustained contribution to the project may be invited to become a +member of the PMC. The form of contribution +is not limited to code. It can also include code review, helping out +users on the mailing lists, documentation, testing, etc.</p> + +<h3 id="release-manager">Release Manager</h3> + +<p>A Release Manager (RM) is a committer who volunteers to produce a +Release Candidate. The RM shall publish a Release Plan on the +dev mailing list stating the branch from which they intend to +make a Release Candidate.</p> + +<h3 id="project-management-committee">Project Management Committee</h3> + +<p>The Project Management Committee (PMC) for Apache Metron was created by +the Apache Board in December 2015 when Metron moved out of Ciscoâs OpenSOC<br /> +project and became an incubated project at Apache. +The PMC is responsible to the board and +the ASF for the management and oversight of the Apache Metron +codebase. The responsibilities of the PMC include</p> + +<ul> + <li> + <p>Deciding what is distributed as products of the Apache Metron +project. In particular all releases must be approved by the PMC.</p> + </li> + <li> + <p>Maintaining the projectâs shared resources, including the codebase +repository, mailing lists, and websites.</p> + </li> + <li> + <p>Speaking on behalf of the project.</p> + </li> + <li> + <p>Resolving license disputes regarding products of the project</p> + </li> + <li> + <p>Nominating new PMC members and committers</p> + </li> + <li> + <p>Maintaining these bylaws and other guidelines of the project</p> + </li> +</ul> + +<p>Membership of the PMC is by invitation only and must be approved by a +consensus approval of active PMC members.</p> + +<p>A PMC member is considered +emeritus by their own declaration or by not contributing in any form +to the project for over six months. An emeritus member may request +reinstatement to the PMC. Such reinstatement is subject to consensus +approval of the active PMC members.</p> + +<p>The chair of the PMC is appointed by the ASF board. The chair is an +office holder of the Apache Software Foundation (Vice President, +Apache Metron) and has primary responsibility to the board for the +management of the project within the scope of the Metron PMC. The +chair reports to the board quarterly on developments within the Metron +project.</p> + +<p>When the project desires a new PMC chair, the PMC votes to recommend a +new chair using <a href="http://wiki.apache.org/general/BoardVoting";>Single Transferable +Vote</a> voting. The decision +must be ratified by the Apache board.</p> + +<h2 id="decision-making">Decision Making</h2> + +<p>Within the Metron project, different types of decisions require +different forms of approval. For example, the previous section +describes several decisions which require âconsensus approval.â +This section defines how voting is performed, the types of +approvals, and which types of decision require which type of approval.</p> + +<h3 id="voting">Voting</h3> + +<p>Decisions regarding the project are made by votes on the primary +project development mailing list ([email protected]). Where +necessary, PMC voting may take place on the private Metron PMC mailing +list. Votes are clearly indicated by subject line starting with +[VOTE]. Votes may contain multiple items for approval and these should +be clearly separated. Voting is carried out by replying to the vote +mail. Voting may take five flavors:</p> + +<ul> + <li> + <p><strong>+1</strong> â âYes,â âAgree,â or âthe action should be performed.â In general, +this vote also indicates a willingness on the behalf of the voter in +âmaking it happen.â</p> + </li> + <li> + <p><strong>+0</strong> â This vote indicates a willingness for the action under +consideration to go ahead. The voter, however, will not be able to +help.</p> + </li> + <li> + <p><strong>0</strong> â The voter is neutral on the topic under discussion.</p> + </li> + <li> + <p><strong>-0</strong> â This vote indicates that the voter does not, in general, agree + with the proposed action but is not concerned enough to prevent the + action going ahead.</p> + </li> + <li> + <p><strong>-1</strong> â This is a negative vote. On issues where consensus is required, + this vote counts as a veto. All vetoes must contain an explanation + of why the veto is appropriate. Vetoes with no explanation are + void. It may also be appropriate for a -1 vote to include an + alternative course of action.</p> + </li> +</ul> + +<p>All participants in the Metron project are encouraged to show their +agreement for or against a particular action by voting, regardless of +whether their vote is binding. Nonbinding votes are useful for +encouraging discussion and understanding the scope of opinions within +the project.</p> + +<h3 id="approvals">Approvals</h3> + +<p>These are the types of approvals that can be sought. Different actions +require different types of approvals.</p> + +<ul> + <li> + <p><strong>Consensus Approval</strong> â Consensus approval requires 3 binding +1 +votes and no binding vetoes.</p> + </li> + <li> + <p><strong>Lazy Consensus</strong> â Lazy consensus requires at least one +1 vote and +no -1 votes (âsilence gives assentâ).</p> + </li> + <li> + <p><strong>Lazy Majority</strong> â A lazy majority vote requires 3 binding +1 votes + and more binding +1 votes than -1 votes.</p> + </li> + <li> + <p><strong>Lazy 2/3 Majority</strong> â Lazy 2/3 majority votes requires at least 3 +votes and twice as many +1 votes as -1 votes.</p> + </li> +</ul> + +<h3 id="vetoes">Vetoes</h3> + +<p>A valid, binding veto cannot be overruled. If a veto is cast, it must +be accompanied by a valid reason explaining the reasons for the +veto. The validity of a veto, if challenged, can be confirmed by +anyone who has a binding vote. This does not necessarily signify +agreement with the veto - merely that the veto is valid. If you +disagree with a valid veto, you must lobby the person casting the veto +to withdraw their veto. If a veto is not withdrawn, any action that +has already been taken must be reversed in a timely manner.</p> + +<h3 id="actions">Actions</h3> + +<p>This section describes the various actions which are undertaken within +the project, the corresponding approval required for that action and +those who have binding votes over the action.</p> + +<h4 id="code-change">Code Change</h4> + +<p>A change made to a codebase of the project requires <em>lazy consensus</em> +of active committers other than the author of the patch. The code can +be committed after the first +1.</p> + +<h4 id="product-release">Product Release</h4> + +<p>To make a release, the release manager creates a release candidate and +a vote requiring a <em>lazy majority</em> of the active PMC members is +required. Once the vote passes, the release candidate becomes an +official release.</p> + +<h4 id="adoption-of-new-codebase">Adoption of New Codebase</h4> + +<p>When the codebase for an existing, released product is to be replaced +with an alternative codebase, it requires a <em>lazy 2/3 majority</em> of PMC +members. This also covers the creation of new sub-projects and +submodules within the project.</p> + +<h4 id="new-committer">New Committer</h4> + +<p>When a new committer is proposed for the project, <em>consensus approval</em> +of the active PMC members is required.</p> + +<h4 id="new-pmc-member">New PMC Member</h4> + +<p>To promote a committer to a PMC member requires <em>consensus approval</em> +of active PMC members.</p> + +<p>If the vote passes, the Apache Board must be notified to make the change +official.</p> + +<h4 id="committer-removal">Committer Removal</h4> + +<p>Removal of commit privileges requires a <em>lazy 2/3 majority</em> of active +PMC members.</p> + +<h4 id="pmc-member-removal">PMC Member Removal</h4> + +<p>Removing a PMC member requires a <em>lazy 2/3 majority</em> of active PMC +members, excluding the member in question.</p> + +<p>If the vote passes, the Apache Board must be notified to make the change +official.</p> + +<h4 id="modifying-bylaws">Modifying Bylaws</h4> + +<p>Modifying this document requires a <em>lazy majority</em> of active PMC members.</p> + +<h3 id="voting-timeframes">Voting Timeframes</h3> + +<p>Votes are open for a minimum period of 72 hours to allow all active +voters time to consider the vote. For holiday weekends or conferences, +consider using a longer vote window. Votes relating to code changes are +not subject to a strict timetable but should be made as timely as +possible.</p> + + </article> + </div> + + <div class="clear"></div> + + </div> +</section> + + + </section> +<section class="intro-block darken" id="docshome"> + <div class="content-960 hover-btn text-center disclaimer"> + The contents of this website are © 2016 Apache Software Foundation under the terms of the Apache License v2. Apache Metron and its logo are trademarks of the Apache Software Foundation. + </div> +</section> + + <script> + var anchorForId = function (id) { + var anchor = document.createElement("a"); + anchor.className = "header-link"; + anchor.href = "#" + id; + anchor.innerHTML = "<span class=\"sr-only\">Permalink</span><i class=\"fa fa-link\"></i>"; + anchor.title = "Permalink"; + return anchor; + }; + + var linkifyAnchors = function (level, containingElement) { + var headers = containingElement.getElementsByTagName("h" + level); + for (var h = 0; h < headers.length; h++) { + var header = headers[h]; + + if (typeof header.id !== "undefined" && header.id !== "") { + header.appendChild(anchorForId(header.id)); + } + } + }; + + document.onreadystatechange = function () { + if (this.readyState === "complete") { + var contentBlock = document.getElementsByClassName("docs")[0] || document.getElementsByClassName("news")[0]; + if (!contentBlock) { + return; + } + for (var level = 1; level <= 6; level++) { + linkifyAnchors(level, contentBlock); + } + } + }; +</script> + + +</body> +</html> http://git-wip-us.apache.org/repos/asf/metron/blob/cf4c2ecd/develop/coding/index.html ---------------------------------------------------------------------- diff --git a/develop/coding/index.html b/develop/coding/index.html new file mode 100644 index 0000000..59ea441 --- /dev/null +++ b/develop/coding/index.html @@ -0,0 +1,243 @@ +<!DOCTYPE html> + +<html lang="en-US" prefix="og: http://ogp.me/ns#"; ng-app="hortonWorksApp"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><style type="text/css">@charset "UTF-8";[ng\:cloak],[ng-cloak],[data-ng-cloak],[x-ng-cloak],.ng-cloak,.x-ng-cloak,.ng-hide:not(.ng-hide-animate){display:none !important;}ng\:form{display:block;}.ng-animate-shim{visibility:hidden;}.ng-anchor{position:absolute;}</style> + + <meta name="viewport" content="width=device-width, height=device-height, initial-scale=1.0, user-scalable=0, minimum-scale=1.0, maximum-scale=1.0"> + <link rel="profile" href="http://gmpg.org/xfn/11";> + <title>Coding Guidelines</title> + + <style type="text/css"> + img.wp-smiley, + img.emoji { + display: inline !important; + border: none !important; + box-shadow: none !important; + height: 1em !important; + width: 1em !important; + margin: 0 .07em !important; + vertical-align: -0.1em !important; + background: none !important; + padding: 0 !important; + } + </style> + + <script> + (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ + (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), + m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) + })(window,document,'script','https://www.google-analytics.com/analytics.js','ga'); + + ga('create', 'UA-78972211-1', 'auto'); + ga('send', 'pageview'); + + </script> + + <link rel="stylesheet" id="default-css" href="/css/default.css" type="text/css" media="all"> + <link rel="stylesheet" id="legacy-css" href="/css/legacy.css" type="text/css" media="all"> + <link rel="stylesheet" id="gravityforms-css" href="/css/gravityforms.css" type="text/css" media="all"> + <link rel="stylesheet" id="selectboxit-css" href="/css/selectBoxIt.css" type="text/css" media="all"> + <link href='http://fonts.googleapis.com/css?family=Roboto%20Condensed' rel='stylesheet' type='text/css'> + + <script type="text/javascript" src="/js/jquery.js"></script> + <script type="text/javascript" src="/js/jquery-migrate.min.js"></script> + <script type="text/javascript" src="/js/jquery.mobile.custom.min.js"></script> + <script type="text/javascript" src="/js/isotope.pkgd.min.js"></script> + <script type="text/javascript" src="/js/navigation.js"></script> + <script type="text/javascript" src="/js/slider.js"></script> + <script type="text/javascript" src="/js/jquery.classyloader.js"></script> + <script type="text/javascript" src="/js/hero-slider.js"></script> + <script type="text/javascript" src="/js/footer.js"></script> + <script type="text/javascript" src="/js/top-form.js"></script> + <script type="text/javascript" src="/js/local6.js"></script> + <script type="text/javascript" src="/js/select-list.js"></script> + <script type="text/javascript" src="/js/legacy.js"></script> + <script type="text/javascript" src="/js/paralax-scroll.js"></script> + <script type="text/javascript" src="/js/jquery-ui.min.js"></script> + <script type="text/javascript" src="/js/jquery.selectBoxIt.min.js"></script> + <script type="text/javascript" src="/js/scroll-slider.js"></script> + <script type="text/javascript" src="/js/charts-animate.js"></script> + <script type="text/javascript" src="/js/dotdotdot.js"></script> + <script type="text/javascript" src="/js/products_scroll.js"></script> + <script type="text/javascript" src="/js/parallax.min.js"></script> + <script type="text/javascript" src="/js/parallax.js"></script> + <script type="text/javascript" src="/js/shb0wjr.js"></script> + + <script> + window.lsfDataLayer = window.lsfDataLayer || []; + </script> + + <style> + body { + font-family: "roboto-condensed", sans-serif; + } + </style> + + <!-- Angular js files --> + <script src="/js/angular.min.js"></script> + <script src="/js/angular-animate.min.js"></script> + <script src="/js/app.js"></script> + <script src="/js/pressReleaseController.js"></script> + <script src="/js/eventCtrl.js"></script> + <!-- End Angular js files --> + <link rel="stylesheet" type="text/css" href="/css/prettify.css"> + <script type="text/javascript" async="" src="/js/munchkin-beta.js"></script> + <link type="text/css" href="/css/jquery-ui-insightera-custom-1.8.css" rel="stylesheet"> + <style id="style-1-cropbar-clipper"> + /* Copyright 2014 Evernote Corporation. All rights reserved. */ + + .en-markup-crop-options { + top: 18px !important; + left: 50% !important; + margin-left: -100px !important; + width: 200px !important; + border: 2px rgba(255, 255, 255, .38) solid !important; + border-radius: 4px !important; + } + + .en-markup-crop-options div div:first-of-type { + margin-left: 0px !important; + } + </style> +</head> + + +<body class="wrap"> + <header> + <div class="main-navigation" style="height: 85px;"> + <div class="main-nav fixed"> + <div class="wrapper"> + <div class="logo"> + <a href=""><img src="/img/logo.png" alt="Logo"></a> + </div> + <nav> + <div class="toggle"> + <span></span> + <span></span> + <span></span> + </div> + <div class="menu-wrapper" style="height: auto; display: block;"> + <ul class="main-menu"> + <li class="products-menu"><a href="/">Home</a> + </li> + <li class="solutions-menu"><a href="/about/">About</a> + </li> + <li class="services-menu"><a href="/documentation/">Documentation</a> + </li> + <li class="services-menu"><a href="/community/">Community</a> + </li> + <li class="training-menu"><a href="/news/">News</a> + </li> + <li> + <button class="button-default button-green" style="line-height:43px;"> <a>Download </a></button> + </li> +</ul> + + </div> + </nav> + </div> + </div> + </div> +</header> + + + <section class="standalone"> + <div class="grid"> + + <div class="unit whole"> + <article> + <h1>Coding Guidelines</h1> + <h2 id="general-rules">General rules</h2> + +<ul> + <li>All files must have an Apache copyright header at the top of the file.</li> + <li>Code should be removed rather than commented out.</li> + <li>All public functions should have javadoc comments.</li> + <li>Always use braces to surround branches.</li> + <li>try-finally should be avoided.</li> +</ul> + +<h2 id="formatting">Formatting</h2> + +<ul> + <li>All files must have an 80 character maximum line length.</li> + <li>Indentation should be 2 spaces.</li> + <li>Files should use spaces instead of tabs.</li> + <li>Wrapping lines + <ul> + <li>Break after a comma.</li> + <li>Break before an operator.</li> + <li>Prefer higher-level breaks to lower-level breaks.</li> + <li>Align the new line with beginning of the expression at the same level +on the previous line.</li> + <li>If the above rules lead to confusing code, just indent 8 spaces.</li> + </ul> + </li> + <li>One variable declaration per a line.</li> +</ul> + +<h2 id="naming">Naming</h2> + +<ul> + <li>Packages should be all lowercase. + <ul> + <li>Java code should be in <code class="highlighter-rouge">org.apache.,metron</code>, except for compatibility classes</li> + </ul> + </li> + <li>Classes should be in mixed case.</li> + <li>Variables should be in camel case.</li> + <li>Constants should be in upper case.</li> +</ul> + + </article> + </div> + + <div class="clear"></div> + + </div> +</section> + + + </section> +<section class="intro-block darken" id="docshome"> + <div class="content-960 hover-btn text-center disclaimer"> + The contents of this website are © 2016 Apache Software Foundation under the terms of the Apache License v2. Apache Metron and its logo are trademarks of the Apache Software Foundation. + </div> +</section> + + <script> + var anchorForId = function (id) { + var anchor = document.createElement("a"); + anchor.className = "header-link"; + anchor.href = "#" + id; + anchor.innerHTML = "<span class=\"sr-only\">Permalink</span><i class=\"fa fa-link\"></i>"; + anchor.title = "Permalink"; + return anchor; + }; + + var linkifyAnchors = function (level, containingElement) { + var headers = containingElement.getElementsByTagName("h" + level); + for (var h = 0; h < headers.length; h++) { + var header = headers[h]; + + if (typeof header.id !== "undefined" && header.id !== "") { + header.appendChild(anchorForId(header.id)); + } + } + }; + + document.onreadystatechange = function () { + if (this.readyState === "complete") { + var contentBlock = document.getElementsByClassName("docs")[0] || document.getElementsByClassName("news")[0]; + if (!contentBlock) { + return; + } + for (var level = 1; level <= 6; level++) { + linkifyAnchors(level, contentBlock); + } + } + }; +</script> + + +</body> +</html> http://git-wip-us.apache.org/repos/asf/metron/blob/cf4c2ecd/develop/index.html ---------------------------------------------------------------------- diff --git a/develop/index.html b/develop/index.html index f752d38..95fc00f 100644 --- a/develop/index.html +++ b/develop/index.html @@ -234,12 +234,12 @@ developers working on the project. The project has created <p>There are several development mailing lists for Metron</p> <ul> - <li><a href="mailto:dev@metron.apache.org">dev@metron.apache.org</a> - Development discussions -with archive <a href="https://mail-archives.apache.org/mod_mbox/incubator-metron-dev/";>here</a></li> - <li><a href="mailto:issues@metron.apache.org">issues@metron.apache.org</a> - Bug tracking -with archive <a href="https://mail-archives.apache.org/mod_mbox/incubator-metron-issues/";>here</a></li> - <li><a href="mailto:commits@metron.apache.org">commits@metron.apache.org</a> - Git tracking -with archive <a href="https://mail-archives.apache.org/mod_mbox/incubator-metron-commits/";>here</a></li> + <li><a href="mailto:[email protected]";>[email protected]</a> - Development discussions +with archive <a href="https://mail-archives.apache.org/mod_mbox/metron-dev/";>here</a></li> + <li><a href="mailto:[email protected]";>[email protected]</a> - Bug tracking +with archive <a href="https://mail-archives.apache.org/mod_mbox/metron-issues/";>here</a></li> + <li><a href="mailto:[email protected]";>[email protected]</a> - Git tracking +with archive <a href="https://mail-archives.apache.org/mod_mbox/metron-commits/";>here</a></li> </ul> <p>You can subscribe to the lists by sending email to @@ -250,14 +250,14 @@ with archive <a href="https://mail-archives.apache.org/mod_mbox/incubator-metron <p>Metron uses git for version control. Get the source code:</p> -<p><code>% git clone https://git-wip-us.apache.org/repos/asf/incubator-metron.git</code></p> +<p><code class="highlighter-rouge">% git clone https://git-wip-us.apache.org/repos/asf/metron.git</code></p> <p>The important branches are:</p> <ul> - <li><a href="https://github.com/apache/incubator-metron/tree/master";>master</a> - + <li><a href="https://github.com/apache/metron/tree/master";>master</a> - The trunk for all developement</li> - <li><a href="https://github.com/apache/incubator-metron/tree/asf-site";>asf-site</a> - + <li><a href="https://github.com/apache/metron/tree/asf-site";>asf-site</a> - The pages that are deployed to https://metron.apache.org/</li> </ul> http://git-wip-us.apache.org/repos/asf/metron/blob/cf4c2ecd/docs/hive-ddl.html ---------------------------------------------------------------------- diff --git a/docs/hive-ddl.html b/docs/hive-ddl.html index f7a99b1..0c66416 100644 --- a/docs/hive-ddl.html +++ b/docs/hive-ddl.html @@ -155,7 +155,7 @@ - <option value="/docs/arch.html">Metron Architecture</option> + <option value="http://localhost:4000/docs/arch.html";>Metron Architecture</option> @@ -231,12 +231,10 @@ - - - <li class=""><a href="/docs/arch.html">Metron Architecture</a></li> + <li class=""><a href="http://localhost:4000/docs/arch.html";>Metron Architecture</a></li> @@ -251,8 +249,6 @@ - - http://git-wip-us.apache.org/repos/asf/metron/blob/cf4c2ecd/docs/index.html ---------------------------------------------------------------------- diff --git a/docs/index.html b/docs/index.html index e36da17..53c3493 100644 --- a/docs/index.html +++ b/docs/index.html @@ -155,7 +155,7 @@ - <option value="/docs/arch.html">Metron Architecture</option> + <option value="http://localhost:4000/docs/arch.html";>Metron Architecture</option> @@ -231,12 +231,10 @@ - - - <li class=""><a href="/docs/arch.html">Metron Architecture</a></li> + <li class=""><a href="http://localhost:4000/docs/arch.html";>Metron Architecture</a></li> @@ -251,8 +249,6 @@ - - http://git-wip-us.apache.org/repos/asf/metron/blob/cf4c2ecd/docs/sensor.html ---------------------------------------------------------------------- diff --git a/docs/sensor.html b/docs/sensor.html index c460cdf..0f61d4b 100644 --- a/docs/sensor.html +++ b/docs/sensor.html @@ -155,7 +155,7 @@ - <option value="/docs/arch.html">Metron Architecture</option> + <option value="http://localhost:4000/docs/arch.html";>Metron Architecture</option> @@ -231,12 +231,10 @@ - - - <li class=""><a href="/docs/arch.html">Metron Architecture</a></li> + <li class=""><a href="http://localhost:4000/docs/arch.html";>Metron Architecture</a></li> @@ -251,8 +249,6 @@ - - http://git-wip-us.apache.org/repos/asf/metron/blob/cf4c2ecd/documentation/index.html ---------------------------------------------------------------------- diff --git a/documentation/index.html b/documentation/index.html index 466ed75..aa486b4 100644 --- a/documentation/index.html +++ b/documentation/index.html @@ -211,21 +211,21 @@ <section class="events-section info-block darken" id="releases"> <div class="wrapper downloads"> <div class="text-center"> - <h4>Current Release: 0.3.1</h4> + <h4>Current Release: 0.4.0</h4> </div> <div class="content-960 hover-btn text-center"> <ul> <li> - <a href="http://www.apache.org/dyn/closer.cgi/incubator/metron/0.3.1/apache-metron-0.3.1-incubating.tar.gz"; target="new"> - apache-metron-0.3.1-incubating.tar.gz + <a href="http://www.apache.org/dyn/closer.cgi/metron/0.4.0/apache-metron-0.4.0.tar.gz"; target="new"> + apache-metron-0.4.0.tar.gz </a> - [ <a href="https://dist.apache.org/repos/dist/release/incubator/metron/0.3.1/apache-metron-0.3.1-incubating.tar.gz.asc"; target="new"> + [ <a href="https://dist.apache.org/repos/dist/release/metron/0.4.0/apache-metron-0.4.0.tar.gz.asc"; target="new"> PGP </a>] - [ <a href="https://dist.apache.org/repos/dist/release/incubator/metron/0.3.1/apache-metron-0.3.1-incubating.tar.gz.sha"; target="new"> + [ <a href="https://dist.apache.org/repos/dist/release/metron/0.4.0/apache-metron-0.4.0.tar.gz.sha"; target="new"> SHA512 </a>] - [ <a href="https://dist.apache.org/repos/dist/release/incubator/metron/0.3.1/apache-metron-0.3.1-incubating.tar.gz.md5"; target="new"> + [ <a href="https://dist.apache.org/repos/dist/release/metron/0.4.0/apache-metron-0.4.0.tar.gz.md5"; target="new"> MD5 </a>] [ <a href="/current-book/index.html" target="new"> Book </a>] @@ -239,7 +239,7 @@ <h4>Older Releases</h4> </div> <div class="content-960 hover-btn text-center"> - If you need access to older releases they can be found in the <a href="https://archive.apache.org/dist/incubator/metron/";>release archives</a>. + If you need access to older releases they can be found in the <a href="https://archive.apache.org/dist/metron/";>release archives</a>. </div> </div> </section> http://git-wip-us.apache.org/repos/asf/metron/blob/cf4c2ecd/feed.xml ---------------------------------------------------------------------- diff --git a/feed.xml b/feed.xml index a2812b4..910d107 100644 --- a/feed.xml +++ b/feed.xml @@ -3,11 +3,11 @@ <channel> <title></title> <description></description> - <link>/</link> - <atom:link href="/feed.xml" rel="self" type="application/rss+xml"/> - <pubDate>Sun, 23 Apr 2017 21:17:52 -0400</pubDate> - <lastBuildDate>Sun, 23 Apr 2017 21:17:52 -0400</lastBuildDate> - <generator>Jekyll v2.4.0</generator> + <link>http://localhost:4000/</link> + <atom:link href="http://localhost:4000/feed.xml"; rel="self" type="application/rss+xml"/> + <pubDate>Wed, 05 Jul 2017 11:58:22 -0700</pubDate> + <lastBuildDate>Wed, 05 Jul 2017 11:58:22 -0700</lastBuildDate> + <generator>Jekyll v3.4.5</generator> <item> <title>Debo Dutta joins PPMC</title> @@ -21,9 +21,9 @@ the Metron website.</p> <p>Please join me to welcome Debo.</p> </description> - <pubDate>Fri, 08 Jan 2016 11:23:00 -0500</pubDate> - <link>/news/2016/01/08/debo-committer/</link> - <guid isPermaLink="true">/news/2016/01/08/debo-committer/</guid> + <pubDate>Fri, 08 Jan 2016 08:23:00 -0800</pubDate> + <link>http://localhost:4000/news/2016/01/08/debo-committer/</link> + <guid isPermaLink="true">http://localhost:4000/news/2016/01/08/debo-committer/</guid> <category>team</category> @@ -34,12 +34,12 @@ the Metron website.</p> <title>Metron adopts new logo</title> <description><p>The Metron project has adopted a new logo. We hope you like it.</p> -<p><img src="/img/logo.png" alt="metron logo" title="metron logo" /></p> +<p><img src="http://localhost:4000/img/logo.png" alt="metron logo" title="metron logo" /></p> </description> - <pubDate>Sat, 12 Dec 2015 07:00:00 -0500</pubDate> - <link>/news/2015/12/12/new-logo/</link> - <guid isPermaLink="true">/news/2015/12/12/new-logo/</guid> + <pubDate>Sat, 12 Dec 2015 04:00:00 -0800</pubDate> + <link>http://localhost:4000/news/2015/12/12/new-logo/</link> + <guid isPermaLink="true">http://localhost:4000/news/2015/12/12/new-logo/</guid> <category>project</category> @@ -50,9 +50,9 @@ the Metron website.</p> <title>Metron accepted into Apache Incubator</title> <description><p>Congratulations! Metron accepted into the Apache Incubator.</p> </description> - <pubDate>Sun, 06 Dec 2015 15:48:00 -0500</pubDate> - <link>/news/2015/12/06/metron-incubator/</link> - <guid isPermaLink="true">/news/2015/12/06/metron-incubator/</guid> + <pubDate>Sun, 06 Dec 2015 12:48:00 -0800</pubDate> + <link>http://localhost:4000/news/2015/12/06/metron-incubator/</link> + <guid isPermaLink="true">http://localhost:4000/news/2015/12/06/metron-incubator/</guid> <category>project</category> http://git-wip-us.apache.org/repos/asf/metron/blob/cf4c2ecd/help/index.html ---------------------------------------------------------------------- diff --git a/help/index.html b/help/index.html index d27f442..3b75885 100644 --- a/help/index.html +++ b/help/index.html @@ -151,11 +151,11 @@ <h2 id="mailing-lists">Mailing Lists</h2> <p>The best option is to send email to the user list -<a href="mailto:user@metron.apache.org">user@metron.apache.org</a>, which is for user +<a href="mailto:[email protected]";>[email protected]</a>, which is for user discussions. All of the historic traffic is available in the -<a href="http://mail-archives.apache.org/mod_mbox/incubator-metron-user/";>archive</a>. To +<a href="http://mail-archives.apache.org/mod_mbox/metron-user/";>archive</a>. To subscribe to the user list, please send email to -<a href="mailto:user-subscribe@metron.apache.org">user-subscribe@metron.apache.org</a>.</p> +<a href="mailto:[email protected]";>[email protected]</a>.</p> <h2 id="bug-reports">Bug Reports</h2> @@ -172,7 +172,7 @@ your question.</p> <h2 id="browse-the-code">Browse the code</h2> <p>One of the advantages of open source software is that you can browse the code. -The code is available on <a href="https://github.com/apache/incubator-metron/tree/master";>github</a>.</p> +The code is available on <a href="https://github.com/apache/metron/tree/master";>github</a>.</p> </article> </div> http://git-wip-us.apache.org/repos/asf/metron/blob/cf4c2ecd/index.html ---------------------------------------------------------------------- diff --git a/index.html b/index.html index c9dca83..193f71d 100644 --- a/index.html +++ b/index.html @@ -148,7 +148,7 @@ <div class="v-middle-inner"> <div class="v-middle"> <h1>real-time big data security </h1> - <a href="https://github.com/apache/incubator-metron"; target="_blank"><button type="button" class="button-default">GitHub</button></a> + <a href="https://github.com/apache/metron"; target="_blank"><button type="button" class="button-default">GitHub</button></a> <a href="https://cwiki.apache.org/confluence/display/METRON/Community+Resources"; target="_blank"><button type="button" class="button-default">Community Home</button></a> http://git-wip-us.apache.org/repos/asf/metron/blob/cf4c2ecd/news/2015/12/12/new-logo/index.html ---------------------------------------------------------------------- diff --git a/news/2015/12/12/new-logo/index.html b/news/2015/12/12/new-logo/index.html index fb1671c..752746e 100644 --- a/news/2015/12/12/new-logo/index.html +++ b/news/2015/12/12/new-logo/index.html @@ -185,7 +185,7 @@ <div class="post-content"> <p>The Metron project has adopted a new logo. We hope you like it.</p> -<p><img src="/img/logo.png" alt="metron logo" title="metron logo" /></p> +<p><img src="http://localhost:4000/img/logo.png"; alt="metron logo" title="metron logo" /></p> </div>
![http://localhost:4000/img/logo.png"](http://localhost:4000/img/logo.png"){kind=link}
![http://localhost:4000/img/logo.png"](http://localhost:4000/img/logo.png"){kind=link}