metron-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From l...@apache.org
Subject metron git commit: METRON-1502 Upgrade Doxia plugin to 1.8 (justinleet) closes apache/metron#974
Date Tue, 17 Apr 2018 17:33:58 GMT
Repository: metron
Updated Branches:
  refs/heads/master 08252f59b -> daf543b10


METRON-1502 Upgrade Doxia plugin to 1.8 (justinleet) closes apache/metron#974


Project: http://git-wip-us.apache.org/repos/asf/metron/repo
Commit: http://git-wip-us.apache.org/repos/asf/metron/commit/daf543b1
Tree: http://git-wip-us.apache.org/repos/asf/metron/tree/daf543b1
Diff: http://git-wip-us.apache.org/repos/asf/metron/diff/daf543b1

Branch: refs/heads/master
Commit: daf543b10423c2cfc2b740e39647ef4eb3863872
Parents: 08252f5
Author: justinleet <justinjleet@gmail.com>
Authored: Tue Apr 17 13:32:23 2018 -0400
Committer: leet <leet@apache.org>
Committed: Tue Apr 17 13:32:23 2018 -0400

----------------------------------------------------------------------
 metron-deployment/amazon-ec2/README.md          |  88 +++++-----
 metron-deployment/packaging/ambari/README.md    | 168 +++++++++----------
 .../packaging/packer-build/README.md            |   2 +-
 metron-interface/metron-rest/README.md          |  56 +++----
 metron-platform/metron-enrichment/README.md     |   2 +-
 metron-sensors/pycapa/README.md                 |  84 +++++-----
 site-book/pom.xml                               |   4 +-
 .../src-resources/templates/site.xml.template   |   6 +-
 8 files changed, 206 insertions(+), 204 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/metron/blob/daf543b1/metron-deployment/amazon-ec2/README.md
----------------------------------------------------------------------
diff --git a/metron-deployment/amazon-ec2/README.md b/metron-deployment/amazon-ec2/README.md
index 73a3d70..b2efc9e 100644
--- a/metron-deployment/amazon-ec2/README.md
+++ b/metron-deployment/amazon-ec2/README.md
@@ -46,39 +46,39 @@ Any platform that supports these tools is suitable, but the following
instructio
 
 1. Install Homebrew by running the following command in a terminal.  Refer to the  [Homebrew](http://brew.sh/)
home page for the latest installation instructions.
 
-  ```
-  /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
-  ```
+    ```
+    /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
+    ```
 
 2. With Homebrew installed, run the following command in a terminal to install all of the
required tools and dependencies.
 
-  ```
-  brew update
-  brew tap caskroom/versions
-  brew cask install java8 vagrant virtualbox
-  brew install maven git node
-  ```
+    ```
+    brew update
+    brew tap caskroom/versions
+    brew cask install java8 vagrant virtualbox
+    brew install maven git node
+    ```
 
 3. Install Ansible by following the instructions [here](http://docs.ansible.com/ansible/intro_installation.html#latest-releases-via-pip).
 
 4. Ensure that a public SSH key is located at `~/.ssh/id_rsa.pub`.
 
-  ```
-  $ cat ~/.ssh/id_rsa.pub
-  ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQChv5GJxPjR39UJV7VY17ivbLVlxFrH7UHwh1Jsjem4d1eYiAtde5N2y65/HRNxWbhYli9ED8k0/MRP92ejewucEbrPNq5mytPqdC4IvZ98Ln2GbqTDwvlP3T7xa/wYFOpFsOmXXql8216wSrnrS4f3XK7ze34S6/VmY+lsBYnr3dzyj8sG/mexpJgFS/w83mWJV0e/ryf4Hd7P6DZ5fO+nmTXfKNK22ga4ctcnbZ+toYcPL+ODCh8598XCKVo97XjwF5OxN3vl1p1HHguo3cHB4H1OIaqX5mUt59gFIZcAXUME89PO6NUiZDd3RTstpf125nQVkQAHu2fvW96/f037
nick@localhost
-  ```
+    ```
+    $ cat ~/.ssh/id_rsa.pub
+    ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQChv5GJxPjR39UJV7VY17ivbLVlxFrH7UHwh1Jsjem4d1eYiAtde5N2y65/HRNxWbhYli9ED8k0/MRP92ejewucEbrPNq5mytPqdC4IvZ98Ln2GbqTDwvlP3T7xa/wYFOpFsOmXXql8216wSrnrS4f3XK7ze34S6/VmY+lsBYnr3dzyj8sG/mexpJgFS/w83mWJV0e/ryf4Hd7P6DZ5fO+nmTXfKNK22ga4ctcnbZ+toYcPL+ODCh8598XCKVo97XjwF5OxN3vl1p1HHguo3cHB4H1OIaqX5mUt59gFIZcAXUME89PO6NUiZDd3RTstpf125nQVkQAHu2fvW96/f037
nick@localhost
+    ```
 
-  If this file does not exist, run the following command at a terminal and accept all defaults.
 Only the public key, not the private key, will be uploaded to Amazon and configured on each
host to enable SSH connectivity.  While it is possible to create and use an alternative key
those details will not be covered.  
+    If this file does not exist, run the following command at a terminal and accept all defaults.
 Only the public key, not the private key, will be uploaded to Amazon and configured on each
host to enable SSH connectivity.  While it is possible to create and use an alternative key
those details will not be covered.  
 
-  ```
-  ssh-keygen -t rsa
-  ```
+    ```
+    ssh-keygen -t rsa
+    ```
 
 5. Ensure the JAVA_HOME environment variable is set
 
-   ```
-   export JAVA_HOME="/Library/Java/JavaVirtualMachines/jdk1.8.0_162.jdk/Contents/Home"
-   ```
+    ```
+    export JAVA_HOME="/Library/Java/JavaVirtualMachines/jdk1.8.0_162.jdk/Contents/Home"
+    ```
 
    Notice: You must replace the path with the installed JDK version path
 
@@ -103,20 +103,20 @@ Having successfully created your Amazon Web Services account, hopefully
you will
 
 1. Use the Amazon access key by exporting its values via the shell's environment.  This allows
Ansible to authenticate with Amazon EC2.  For example:
 
-  ```
-  export AWS_ACCESS_KEY_ID="AKIAI6NRFEO27E5FFELQ"
-  export AWS_SECRET_ACCESS_KEY="vTDydWJQnAer7OWauUS150i+9Np7hfCXrrVVP6ed"
-  ```
+    ```
+    export AWS_ACCESS_KEY_ID="AKIAI6NRFEO27E5FFELQ"
+    export AWS_SECRET_ACCESS_KEY="vTDydWJQnAer7OWauUS150i+9Np7hfCXrrVVP6ed"
+    ```
 
   Notice: You must replace the access key values above with values from your own access key.
 
 2. Start the Apache Metron deployment process.  When prompted provide a unique name for your
Metron environment or accept the default.  
 
-  ```
-  $ ./run.sh
-  Metron Environment [metron-test]: my-metron-env
-  ...
-  ```
+    ```
+    $ ./run.sh
+    Metron Environment [metron-test]: my-metron-env
+    ...
+    ```
 
   The process is likely to take between 70-90 minutes.  Fortunately, everything is fully
automated and you should feel free to grab a coffee.
 
@@ -124,24 +124,24 @@ Having successfully created your Amazon Web Services account, hopefully
you will
 
 1. After the deployment has completed successfully, a message like the following will be
displayed.  Navigate to the specified resources to explore your newly minted Apache Metron
environment.
 
-  ```
-  TASK [debug] *******************************************************************
-  ok: [localhost] => {
-      "Success": [
-          "Apache Metron deployed successfully",
-          "   Metron  @  http://ec2-52-37-255-142.us-west-2.compute.amazonaws.com:5000",
-          "   Ambari  @  http://ec2-52-37-225-202.us-west-2.compute.amazonaws.com:8080",
-          "   Sensors @  ec2-52-37-225-202.us-west-2.compute.amazonaws.com on tap0",
-          "For additional information, see https://metron.apache.org/'"
-      ]
-  }
-  ```
+    ```
+    TASK [debug] *******************************************************************
+    ok: [localhost] => {
+        "Success": [
+            "Apache Metron deployed successfully",
+            "   Metron  @  http://ec2-52-37-255-142.us-west-2.compute.amazonaws.com:5000",
+            "   Ambari  @  http://ec2-52-37-225-202.us-west-2.compute.amazonaws.com:8080",
+            "   Sensors @  ec2-52-37-225-202.us-west-2.compute.amazonaws.com on tap0",
+            "For additional information, see https://metron.apache.org/'"
+        ]
+    }
+    ```
 
 2. Each of the provisioned hosts will be accessible from the internet. Connecting to one
over SSH as the user `centos` will not require a password as it will authenticate with the
pre-defined SSH key.  
 
-  ```
-  ssh centos@ec2-52-91-215-174.compute-1.amazonaws.com
-  ```
+    ```
+    ssh centos@ec2-52-91-215-174.compute-1.amazonaws.com
+    ```
 
 Advanced Usage
 --------------

http://git-wip-us.apache.org/repos/asf/metron/blob/daf543b1/metron-deployment/packaging/ambari/README.md
----------------------------------------------------------------------
diff --git a/metron-deployment/packaging/ambari/README.md b/metron-deployment/packaging/ambari/README.md
index 52c7570..410c403 100644
--- a/metron-deployment/packaging/ambari/README.md
+++ b/metron-deployment/packaging/ambari/README.md
@@ -107,14 +107,14 @@ by Ambari:
 
 ## Adding a new property
 1. Add the property to the appropriate `*-env.xml` file found in `METRON.CURRENT/configuration`.
-  ```
+    ```
     <property>
         <name>new_property</name>
         <description>New Property description</description>
         <value>Default Value</value>
         <display-name>New Property Pretty Name</display-name>
     </property>
-  ```
+    ```
 The appropriate `*-env.xml` file should be selected based on which component depends on the
property. This allows Ambari to accurately restart only the affected components when the property
is changed. If a property is in `metron-env.xml`, Ambari will prompt you to restart all Metron
components.
 
 2. Add the property to the `metron_theme.json` file found in `METRON.CURRENT/themes` if the
property was added to a component-specific `*-env.xml` file (`metron-parsers-env.xml` for
example) and not `metron-env.xml`.
@@ -122,28 +122,28 @@ This is necessary for the property to be displayed in the correct tab
of the Met
 
 3. Reference the property in `METRON.CURRENT/package/scriptes/params/params_linux.py`, unless
it will be used in Ambari's status command. It will be stored in a variable. The name doesn't
have to match, but it's preferred that it does.
 Make sure to use replace `metron-env` the correct `*-env` file, as noted above.
-  ```
-  new_property = config['configurations']['metron-env']['new_property']
-  ```
-If this property will be used in the status command, instead make this change in `METRON.CURRENT/package/scriptes/params/status_params.py`.
-Afterwards, in `params_linux.py`, reference the new property:
-  ```
-  new_property = status_params.new_property
-  ```
-This behavior is because Ambari doesn't send all parameters to the status, so it needs to
be explicitly provided. Also note that status_params.py parameters are not automatically pulled
into the params_linux.py namespace, so we explicitly choose the variables to include.
+    ```
+    new_property = config['configurations']['metron-env']['new_property']
+    ```
+  If this property will be used in the status command, instead make this change in `METRON.CURRENT/package/scriptes/params/status_params.py`.
+  Afterwards, in `params_linux.py`, reference the new property:
+    ```
+    new_property = status_params.new_property
+    ```
+  This behavior is because Ambari doesn't send all parameters to the status, so it needs
to be explicitly provided. Also note that status_params.py parameters are not automatically
pulled into the params_linux.py namespace, so we explicitly choose the variables to include.
  See https://docs.python.org/2/howto/doanddont.html#at-module-level for more info.
 
 4. Ambari master services can then import the params:
 
-  ```
-  from params import params
-  env.set_params(params)
-  ```
+    ```
+    from params import params
+    env.set_params(params)
+    ```
 
 5. The `*_commands.py` files receive the params as an input from the master services. Once
this is done, they can be accessed via the variable we set above:
-  ```
-  self.__params.new_property
-  ```
+    ```
+    self.__params.new_property
+    ```
 
 
 ### Env file property walkthrough
@@ -391,9 +391,9 @@ The steps to update, for anything affecting an Ambari agent node, e.g.
setup scr
 1. Edit the file(s) with your changes. The ambari-agent file must be edited, but generally
better to update both for consistency.
 1. Restart the Ambari Agent to get the cache to pick up the modified file
 
-  ```
-  ambari-agent restart
-  ```
+    ```
+    ambari-agent restart
+    ```
 1. Start Metron through Ambari if it was stopped.
 
 ### Reinstalling the mpack
@@ -402,18 +402,18 @@ After we've modified files in Ambari and the mpack is working, it is
a good idea
 1. Stop Metron through Ambari and remove the Metron service
 1. Rebuild the mpack on your local machine and deploy it to Vagrant, ensuring that all changes
made directly to files in Ambari were also made in your local environment
 
-  ```
-  cd metron-deployment
-  mvn clean package
-  scp packaging/ambari/metron-mpack/target/metron_mpack-0.4.0.0.tar.gz root@node1:~
-  ```
+    ```
+    cd metron-deployment
+    mvn clean package
+    scp packaging/ambari/metron-mpack/target/metron_mpack-0.4.0.0.tar.gz root@node1:~
+    ```
 1. Log in to Vagrant, deploy the mpack and restart Ambari
 
-  ```
-  ssh root@node1
-  ambari-server install-mpack --mpack=metron_mpack-0.4.0.0.tar.gz --verbose --force
-  ambari-server restart
-  ```
+    ```
+    ssh root@node1
+    ambari-server install-mpack --mpack=metron_mpack-0.4.0.0.tar.gz --verbose --force
+    ambari-server restart
+    ```
 1. Install the mpack through Ambari as you normally would
 
 1. The same steps can be followed for Elasticsearch and Kibana by similary deploying the
ES MPack located in elasticsearch-mpack/target.
@@ -454,21 +454,21 @@ The `security_enabled` param is already made available, along with appropriate
k
 * Write scripts to be idempotent. The pattern currently used is to write a file out when
a task is finished, e.g. setting up ACLs or tables.
 For example, when indexing is configured, a file is written out and checked based on a property.
 
-  ```
-  def set_configured(self):
-      File(self.__params.indexing_configured_flag_file,
-           content="",
-           owner=self.__params.metron_user,
-           mode=0755)
-  ```
-This is checked in the indexing master
-
-  ```
-  if not commands.is_configured():
-      commands.init_kafka_topics()
-      commands.init_hdfs_dir()
-      commands.set_configured()
-  ```
+    ```
+    def set_configured(self):
+        File(self.__params.indexing_configured_flag_file,
+             content="",
+             owner=self.__params.metron_user,
+             mode=0755)
+    ```
+  This is checked in the indexing master
+
+    ```
+    if not commands.is_configured():
+        commands.init_kafka_topics()
+        commands.init_hdfs_dir()
+        commands.set_configured()
+    ```
 
 * Ensure ACLs are properly managed. This includes Kafka and HBase. Often this involves a
config file written out as above because this isn't idempotent!
   * Make sure to `kinit` as the correct user for setting up ACLs in a secured cluster. This
is usually kafka for Kafka and hbase for HBase.
@@ -515,22 +515,22 @@ The main steps for upgrading a service are split into add-on and common
services
 
 1. Update metainfo.xml
 
-   Change the version number and package name in `metron/metron-deployment/packaging/ambari/metron-mpack/src/main/resources/common-services/ELASTICSEARCH/${YOUR_VERSION_NUMBER_HERE}/metainfo.xml`,
e.g.
-
-   ```
-   <version>5.6.2</version>
-   ...
-   <osSpecifics>
-       <osSpecific>
-           <osFamily>any</osFamily>
-           <packages>
-               <package>
-                   <name>elasticsearch-5.6.2</name>
-               </package>
-           </packages>
-       </osSpecific>
-   </osSpecifics>
-   ```
+    Change the version number and package name in `metron/metron-deployment/packaging/ambari/metron-mpack/src/main/resources/common-services/ELASTICSEARCH/${YOUR_VERSION_NUMBER_HERE}/metainfo.xml`,
e.g.
+
+    ```
+    <version>5.6.2</version>
+    ...
+    <osSpecifics>
+        <osSpecific>
+            <osFamily>any</osFamily>
+            <packages>
+                <package>
+                    <name>elasticsearch-5.6.2</name>
+                </package>
+            </packages>
+        </osSpecific>
+    </osSpecifics>
+    ```
 
 #### Update Add-on Services
 
@@ -560,14 +560,14 @@ The main steps for upgrading a service are split into add-on and common
services
 
 1. Update metainfo.xml
 
-   Change the version number in `metron/metron-deployment/packaging/ambari/metron-mpack/src/main/resources/addon-services/ELASTICSEARCH/${YOUR_VERSION_NUMBER_HERE}/metainfo.xml`.
-   Also make sure to update the "extends" version to point to the updated common-services
version, e.g.
+  Change the version number in `metron/metron-deployment/packaging/ambari/metron-mpack/src/main/resources/addon-services/ELASTICSEARCH/${YOUR_VERSION_NUMBER_HERE}/metainfo.xml`.
+  Also make sure to update the "extends" version to point to the updated common-services
version, e.g.
 
-   ```
-   <name>ELASTICSEARCH</name>
-   <version>5.6.2</version>
-   <extends>common-services/ELASTICSEARCH/5.6.2</extends>
-   ```
+    ```
+    <name>ELASTICSEARCH</name>
+    <version>5.6.2</version>
+    <extends>common-services/ELASTICSEARCH/5.6.2</extends>
+    ```
 
 #### Update mpack.json
 
@@ -610,16 +610,16 @@ The main steps for upgrading a service are split into add-on and common
services
 
    Change the version number and package name in `metron/metron-deployment/packaging/ambari/metron-mpack/src/main/resources/common-services/KIBANA/${YOUR_VERSION_NUMBER_HERE}/metainfo.xml`,
e.g.
 
-   ```
-   <version>5.6.2</version>
-   ...
-   <packages>
-       ...
-       <package>
-           <name>kibana-5.6.2</name>
-       </package>
-   </packages>
-   ```
+    ```
+    <version>5.6.2</version>
+    ...
+    <packages>
+        ...
+        <package>
+            <name>kibana-5.6.2</name>
+        </package>
+    </packages>
+    ```
 
 #### Update Add-on Services
 
@@ -659,11 +659,11 @@ The main steps for upgrading a service are split into add-on and common
services
 
    Change the version number in `metron/metron-deployment/packaging/ambari/metron-mpack/src/main/resources/addon-services/KIBANA/${YOUR_VERSION_NUMBER_HERE}/metainfo.xml`.
    Also make sure to update the "extends" version to point to the updated common-services
version, e.g.
-   ```
-   <name>KIBANA</name>
-   <version>5.6.2</version>
-   <extends>common-services/KIBANA/5.6.2</extends>
-   ```
+    ```
+    <name>KIBANA</name>
+    <version>5.6.2</version>
+    <extends>common-services/KIBANA/5.6.2</extends>
+    ```
 
 #### Update mpack.json
 

http://git-wip-us.apache.org/repos/asf/metron/blob/daf543b1/metron-deployment/packaging/packer-build/README.md
----------------------------------------------------------------------
diff --git a/metron-deployment/packaging/packer-build/README.md b/metron-deployment/packaging/packer-build/README.md
index 8cb5ff5..ee05299 100644
--- a/metron-deployment/packaging/packer-build/README.md
+++ b/metron-deployment/packaging/packer-build/README.md
@@ -40,7 +40,7 @@ Build Single Images
 ----------------------
  Navigate to *your-project-directory*/metron-deployment/packer-build
  * Base Centos (full-dev)
- ```
+```
 bin/bento build base-centos-6.7.json
 ```
 

http://git-wip-us.apache.org/repos/asf/metron/blob/daf543b1/metron-interface/metron-rest/README.md
----------------------------------------------------------------------
diff --git a/metron-interface/metron-rest/README.md b/metron-interface/metron-rest/README.md
index 08cd6be..c928d8f 100644
--- a/metron-interface/metron-rest/README.md
+++ b/metron-interface/metron-rest/README.md
@@ -815,19 +815,19 @@ Request and Response objects are JSON formatted.  The JSON schemas are
available
       * sensorType - The sensor type
       * patch - An array of [RFC 6902](https://tools.ietf.org/html/rfc6902) patches.
     * Example adding a field called `project` with value `metron` to the `bro` message with
UUID of `000-000-0000` :
-  ```
-  {
-     "guid" : "000-000-0000",
-     "sensorType" : "bro",
-     "patch" : [
-      {
-                "op": "add"
-               , "path": "/project"
-               , "value": "metron"
-      }
-              ]
-   }
-  ```
+        ```
+        {
+           "guid" : "000-000-0000",
+           "sensorType" : "bro",
+           "patch" : [
+            {
+                      "op": "add"
+                     , "path": "/project"
+                     , "value": "metron"
+            }
+                    ]
+         }
+        ```
   * Returns:
     * 200 - nothing
     * 404 - document not found
@@ -839,21 +839,21 @@ Request and Response objects are JSON formatted.  The JSON schemas are
available
       * guid - The Patch UUID
       * sensorType - The sensor type
       * replacement - A Map representing the replaced document
-    * Example replacing a `bro` message with guid of `000-000-0000`
-```
-   {
-     "guid" : "000-000-0000",
-     "sensorType" : "bro",
-     "replacement" : {
-       "source:type": "bro",
-       "guid" : "bro_index_2017.01.01.01:1",
-       "ip_src_addr":"192.168.1.2",
-       "ip_src_port": 8009,
-       "timestamp":200,
-       "rejected":false
-      }
-   }
-```
+    * Example replacing a `bro` message with guid of `000-000-0000` :
+        ```
+        {
+          "guid" : "000-000-0000",
+          "sensorType" : "bro",
+          "replacement" : {
+            "source:type": "bro",
+            "guid" : "bro_index_2017.01.01.01:1",
+            "ip_src_addr":"192.168.1.2",
+            "ip_src_port": 8009,
+            "timestamp":200,
+            "rejected":false
+          }
+        }
+        ```
   * Returns:
     * 200 - Current user
 

http://git-wip-us.apache.org/repos/asf/metron/blob/daf543b1/metron-platform/metron-enrichment/README.md
----------------------------------------------------------------------
diff --git a/metron-platform/metron-enrichment/README.md b/metron-platform/metron-enrichment/README.md
index aa6fc99..cbf8ee8 100644
--- a/metron-platform/metron-enrichment/README.md
+++ b/metron-platform/metron-enrichment/README.md
@@ -364,7 +364,7 @@ Let's adjust the configurations for the Squid topology to annotate the
messages
 
 * Edit the squid enrichment configuration at `$METRON_HOME/config/zookeeper/enrichments/squid.json`
(this file will not exist, so create a new one) to add some new fields based on stellar queries:

 
- ```
+```
 {
   "enrichment" : {
     "fieldMap": {

http://git-wip-us.apache.org/repos/asf/metron/blob/daf543b1/metron-sensors/pycapa/README.md
----------------------------------------------------------------------
diff --git a/metron-sensors/pycapa/README.md b/metron-sensors/pycapa/README.md
index ab4389f..7e688a8 100644
--- a/metron-sensors/pycapa/README.md
+++ b/metron-sensors/pycapa/README.md
@@ -46,20 +46,20 @@ General notes on the installation of Pycapa.
 
 1. 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.
 
-   ```
-   yum -y install "@Development tools" python-devel libpcap-devel
-   ```
+    ```
+    yum -y install "@Development tools" python-devel libpcap-devel
+    ```
 
 1. Install Librdkafka at your chosen $PREFIX.
 
-   ```
-   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
-   ```
+    ```
+    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
+    ```
 
 1. Add Librdkafka to the dynamic library load path.
 
@@ -186,24 +186,24 @@ $ pycapa --producer \
 
 Consume 10 packets and create a libpcap-compliant pcap file.
 
-  ```
-  $ 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
-  ```
+    ```
+    $ 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
+    ```
 
 #### Example 5
 
@@ -280,19 +280,19 @@ The probe can be used in a Kerberized environment.  Follow these additional
step
   * `sasl.kerberos.keytab`
   * `sasl.kerberos.principal`
 
-  ```
-  $ 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 sasl.kerberos.principal=metron-metron@METRONEXAMPLE.COM
-  INFO:root:Connecting to Kafka; {'sasl.kerberos.principal': 'metron-metron@METRONEXAMPLE.COM',
'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
-  ```
+        ```
+        $ 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 sasl.kerberos.principal=metron-metron@METRONEXAMPLE.COM
+        INFO:root:Connecting to Kafka; {'sasl.kerberos.principal':   'metron-metron@METRONEXAMPLE.COM',
'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
+        ```
 
 FAQs
 ====

http://git-wip-us.apache.org/repos/asf/metron/blob/daf543b1/site-book/pom.xml
----------------------------------------------------------------------
diff --git a/site-book/pom.xml b/site-book/pom.xml
index 3731c4a..1408542 100644
--- a/site-book/pom.xml
+++ b/site-book/pom.xml
@@ -71,12 +71,12 @@
             <plugin>
               <groupId>org.apache.maven.plugins</groupId>
               <artifactId>maven-site-plugin</artifactId>
-              <version>3.4</version>
+              <version>3.7</version>
               <dependencies>
 		<dependency>
                   <groupId>org.apache.maven.doxia</groupId>
                   <artifactId>doxia-module-markdown</artifactId>
-                  <version>1.6</version>
+                  <version>1.8</version>
 		</dependency>
               </dependencies>
               <executions>

http://git-wip-us.apache.org/repos/asf/metron/blob/daf543b1/site-book/src/site/src-resources/templates/site.xml.template
----------------------------------------------------------------------
diff --git a/site-book/src/site/src-resources/templates/site.xml.template b/site-book/src/site/src-resources/templates/site.xml.template
index 8523562..0ddf2cc 100644
--- a/site-book/src/site/src-resources/templates/site.xml.template
+++ b/site-book/src/site/src-resources/templates/site.xml.template
@@ -23,7 +23,7 @@
     <skin>
         <groupId>org.apache.maven.skins</groupId>
         <artifactId>maven-fluido-skin</artifactId>
-        <version>1.3.0</version>
+        <version>1.7</version>
     </skin>
 
     <custom>
@@ -47,9 +47,11 @@
 
     <body>
         <head>
+          <![CDATA[
             <script type="text/javascript">
-                $( document ).ready( function() { $( '.carousel' ).carousel( { interval:
3500 } ) } );
+              $( document ).ready( function() { $( '.carousel' ).carousel( { interval: 3500
} ) } );
             </script>
+          ]]>
         </head>
 
         <breadcrumbs position="left">


Mime
View raw message