Added: release/metron/0.4.0/site-book/metron-deployment/amazon-ec2/index.html ============================================================================== --- release/metron/0.4.0/site-book/metron-deployment/amazon-ec2/index.html (added) +++ release/metron/0.4.0/site-book/metron-deployment/amazon-ec2/index.html Wed Jul 5 06:56:42 2017 @@ -0,0 +1,561 @@ +<!DOCTYPE html> +<!-- + | Generated by Apache Maven Doxia at 2017-06-27 + | Rendered using Apache Maven Fluido Skin 1.3.0 +--> +<html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en"> + <head> + <meta charset="UTF-8" /> + <meta name="viewport" content="width=device-width, initial-scale=1.0" /> + <meta name="Date-Revision-yyyymmdd" content="20170627" /> + <meta http-equiv="Content-Language" content="en" /> + <title>Metron – Apache Metron on Amazon EC2</title> + <link rel="stylesheet" href="../../css/apache-maven-fluido-1.3.0.min.css" /> + <link rel="stylesheet" href="../../css/site.css" /> + <link rel="stylesheet" href="../../css/print.css" media="print" /> + + + <script type="text/javascript" src="../../js/apache-maven-fluido-1.3.0.min.js"></script> + + + +<script type="text/javascript">$( document ).ready( function() { $( '.carousel' ).carousel( { interval: 3500 } ) } );</script> + + </head> + <body class="topBarDisabled"> + + + + + <div class="container-fluid"> + <div id="banner"> + <div class="pull-left"> + <a href="http://metron.apache.org/"; id="bannerLeft"> + <img src="../../images/metron-logo.png" alt="Apache Metron" width="148px" height="48px"/> + </a> + </div> + <div class="pull-right"> </div> + <div class="clear"><hr/></div> + </div> + + <div id="breadcrumbs"> + <ul class="breadcrumb"> + + + <li class=""> + <a href="http://www.apache.org"; class="externalLink" title="Apache"> + Apache</a> + </li> + <li class="divider ">/</li> + <li class=""> + <a href="http://metron.apache.org/"; class="externalLink" title="Metron"> + Metron</a> + </li> + <li class="divider ">/</li> + <li class=""> + <a href="../../index.html" title="Documentation"> + Documentation</a> + </li> + <li class="divider ">/</li> + <li class="">Apache Metron on Amazon EC2</li> + + + + <li id="publishDate" class="pull-right">Last Published: 2017-06-27</li> <li class="divider pull-right">|</li> + <li id="projectVersion" class="pull-right">Version: 0.4.0</li> + + </ul> + </div> + + + <div class="row-fluid"> + <div id="leftColumn" class="span3"> + <div class="well sidebar-nav"> + + + <ul class="nav nav-list"> + <li class="nav-header">User Documentation</li> + + <li> + + <a href="../../index.html" title="Metron"> + <i class="icon-chevron-down"></i> + Metron</a> + <ul class="nav nav-list"> + + <li> + + <a href="../../Upgrading.html" title="Upgrading"> + <i class="none"></i> + Upgrading</a> + </li> + + <li> + + <a href="../../metron-analytics/index.html" title="Analytics"> + <i class="icon-chevron-right"></i> + Analytics</a> + </li> + + <li> + + <a href="../../metron-deployment/index.html" title="Deployment"> + <i class="icon-chevron-down"></i> + Deployment</a> + <ul class="nav nav-list"> + + <li> + + <a href="../../metron-deployment/Kerberos-ambari-setup.html" title="Kerberos-ambari-setup"> + <i class="none"></i> + Kerberos-ambari-setup</a> + </li> + + <li> + + <a href="../../metron-deployment/Kerberos-manual-setup.html" title="Kerberos-manual-setup"> + <i class="none"></i> + Kerberos-manual-setup</a> + </li> + + <li class="active"> + + <a href="#"><i class="none"></i>Amazon-ec2</a> + </li> + + <li> + + <a href="../../metron-deployment/packaging/docker/ansible-docker/index.html" title="Ansible-docker"> + <i class="none"></i> + Ansible-docker</a> + </li> + + <li> + + <a href="../../metron-deployment/packaging/docker/rpm-docker/index.html" title="Rpm-docker"> + <i class="none"></i> + Rpm-docker</a> + </li> + + <li> + + <a href="../../metron-deployment/packaging/packer-build/index.html" title="Packer-build"> + <i class="none"></i> + Packer-build</a> + </li> + + <li> + + <a href="../../metron-deployment/roles/index.html" title="Roles"> + <i class="icon-chevron-right"></i> + Roles</a> + </li> + + <li> + + <a href="../../metron-deployment/vagrant/index.html" title="Vagrant"> + <i class="icon-chevron-right"></i> + Vagrant</a> + </li> + </ul> + </li> + + <li> + + <a href="../../metron-docker/index.html" title="Docker"> + <i class="none"></i> + Docker</a> + </li> + + <li> + + <a href="../../metron-interface/metron-config/index.html" title="Config"> + <i class="none"></i> + Config</a> + </li> + + <li> + + <a href="../../metron-interface/metron-rest/index.html" title="Rest"> + <i class="none"></i> + Rest</a> + </li> + + <li> + + <a href="../../metron-platform/index.html" title="Platform"> + <i class="icon-chevron-right"></i> + Platform</a> + </li> + + <li> + + <a href="../../metron-sensors/index.html" title="Sensors"> + <i class="icon-chevron-right"></i> + Sensors</a> + </li> + </ul> + </li> + </ul> + + + + <hr class="divider" /> + + <div id="poweredBy"> + <div class="clear"></div> + <div class="clear"></div> + <div class="clear"></div> + <a href="http://maven.apache.org/"; title="Built by Maven" class="poweredBy"> + <img class="builtBy" alt="Built by Maven" src="../../images/logos/maven-feather.png" /> + </a> + </div> + </div> + </div> + + + <div id="bodyColumn" class="span9" > + + <h1>Apache Metron on Amazon EC2</h1> +<p>This project fully automates the provisioning of Apache Metron on Amazon EC2 infrastructure. Starting with only your Amazon EC2 credentials, this project will create a fully-functioning, end-to-end, multi-node cluster running Apache Metron.</p> +<p>Warning: Amazon will charge for the use of their resources when running Apache Metron. The amount will vary based on the number and size of hosts, along with current Amazon pricing structure. Be sure to stop or terminate all of the hosts instantiated by Apache Metron when not in use to avoid unnecessary charges.</p> +<div class="section"> +<h2><a name="Getting_Started"></a>Getting Started</h2> +<div class="section"> +<h3><a name="Prerequisites"></a>Prerequisites</h3> +<p>The host used to deploy Apache Metron will need the following software tools installed. The following versions are known to work as of the time of this writing, but by no means are these the only working versions.</p> + +<ul> + +<li>Ansible 2.0.0.2 or 2.2.2.0</li> + +<li>Python 2.7.11</li> + +<li>Maven 3.3.9</li> +</ul> +<p>Any platform that supports these tools is suitable, but the following instructions cover only macOS. The easiest means of installing these tools on a Mac is to use the excellent <a class="externalLink" href="http://brew.sh/";>Homebrew</a> project.</p> + +<ol style="list-style-type: decimal"> + +<li> +<p>Install Homebrew by running the following command in a terminal. Refer to the <a class="externalLink" href="http://brew.sh/";>Homebrew</a> home page for the latest installation instructions.</p> + +<div class="source"> +<div class="source"> +<pre> /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)" +</pre></div></div></li> + +<li> +<p>With Homebrew installed, run the following command in a terminal to install all of the required tools.</p> + +<div class="source"> +<div class="source"> +<pre> brew cask install java + brew install maven git +</pre></div></div></li> + +<li> +<p>Install Ansible by following the instructions <a class="externalLink" href="http://docs.ansible.com/ansible/intro_installation.html#latest-releases-via-pip";>here</a>.</p></li> + +<li> +<p>Ensure that a public SSH key is located at <tt>~/.ssh/id_rsa.pub</tt>.</p> + +<div class="source"> +<div class="source"> +<pre> $ cat ~/.ssh/id_rsa.pub + ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQChv5GJxPjR39UJV7VY17ivbLVlxFrH7UHwh1Jsjem4d1eYiAtde5N2y65/HRNxWbhYli9ED8k0/MRP92ejewucEbrPNq5mytPqdC4IvZ98Ln2GbqTDwvlP3T7xa/wYFOpFsOmXXql8216wSrnrS4f3XK7ze34S6/VmY+lsBYnr3dzyj8sG/mexpJgFS/w83mWJV0e/ryf4Hd7P6DZ5fO+nmTXfKNK22ga4ctcnbZ+toYcPL+ODCh8598XCKVo97XjwF5OxN3vl1p1HHguo3cHB4H1OIaqX5mUt59gFIZcAXUME89PO6NUiZDd3RTstpf125nQVkQAHu2fvW96/f037 nick@localhost +</pre></div></div> +<p>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. </p> + +<div class="source"> +<div class="source"> +<pre> ssh-keygen -t rsa +</pre></div></div></li> +</ol></div> +<div class="section"> +<h3><a name="Amazon_Web_Services"></a>Amazon Web Services</h3> +<p>If you already have an Amazon Web Services account that you have used to deploy EC2 hosts, then you should be able to skip the next few steps.</p> + +<ol style="list-style-type: decimal"> + +<li> +<p>Head over to <a class="externalLink" href="http://aws.amazon.com/";>Amazon Web Services</a> and create an account. As part of the account creation process you will need to provide a credit card to cover any charges that may apply.</p></li> + +<li> +<p>Create a set of user credentials through <a class="externalLink" href="https://console.aws.amazon.com/iam/";>Amazon’s Identity and Access Management (IAM) </a> dashboard. On the IAM dashboard menu click “Users” and then “Create New User”. Provide a name and ensure that “Generate an access key for each user” remains checked. Download the credentials and keep them for later use.</p></li> + +<li> +<p>While still in <a class="externalLink" href="https://console.aws.amazon.com/iam/";>Amazon’s Identity and Access Management (IAM) </a> dashboard, click on the user that was previously created. Click the “Permissions” tab and then the “Attach Policy” button. Attach the following policies to the user.</p> + +<ul> + +<li>AmazonEC2FullAccess</li> + +<li>AmazonVPCFullAccess</li> + </ul></li> + +<li> +<p>Apache Metron uses the <a class="externalLink" href="https://aws.amazon.com/marketplace/pp/B00NQAYLWO";>official, open source CentOS 6</a> Amazon Machine Image (AMI). If you have never used this AMI before then you will need to accept Amazon’s terms and conditions. Navigate to the <a class="externalLink" href="https://aws.amazon.com/marketplace/pp/B00NQAYLWO";>web page for this AMI</a> and click the “Continue” button. Choose the “Manual Launch” tab then click the “Accept Software Terms” button.</p></li> +</ol> +<p>Having successfully created your Amazon Web Services account, hopefully you will find that the most difficult tasks are behind us. </p></div> +<div class="section"> +<h3><a name="Deploy_Metron"></a>Deploy Metron</h3> + +<ol style="list-style-type: decimal"> + +<li> +<p>Use the Amazon access key by exporting its values via the shell’s environment. This allows Ansible to authenticate with Amazon EC2. For example:</p> + +<div class="source"> +<div class="source"> +<pre> export AWS_ACCESS_KEY_ID="AKIAI6NRFEO27E5FFELQ" + export AWS_SECRET_ACCESS_KEY="vTDydWJQnAer7OWauUS150i+9Np7hfCXrrVVP6ed" +</pre></div></div> +<p>Notice: You must replace the access key values above with values from your own access key.</p></li> + +<li> +<p>Start the Apache Metron deployment process. When prompted provide a unique name for your Metron environment or accept the default. </p> + +<div class="source"> +<div class="source"> +<pre> $ ./run.sh + Metron Environment [metron-test]: my-metron-env + ... +</pre></div></div> +<p>The process is likely to take between 70-90 minutes. Fortunately, everything is fully automated and you should feel free to grab a coffee.</p></li> +</ol></div> +<div class="section"> +<h3><a name="Explore_Metron"></a>Explore Metron</h3> + +<ol style="list-style-type: decimal"> + +<li> +<p>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.</p> + +<div class="source"> +<div class="source"> +<pre> 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/'" + ] + } +</pre></div></div></li> + +<li> +<p>Each of the provisioned hosts will be accessible from the internet. Connecting to one over SSH as the user <tt>centos</tt> will not require a password as it will authenticate with the pre-defined SSH key. </p> + +<div class="source"> +<div class="source"> +<pre> ssh cen...@ec2-52-91-215-174.compute-1.amazonaws.com +</pre></div></div></li> +</ol></div></div> +<div class="section"> +<h2><a name="Advanced_Usage"></a>Advanced Usage</h2> +<div class="section"> +<h3><a name="Multiple_Environments"></a>Multiple Environments</h3> +<p>This process can support provisioning of multiple, isolated environments. Simply change the <tt>env</tt> settings in <tt>conf/defaults.yml</tt>. For example, you might provision separate development, test, and production environments.</p> + +<div class="source"> +<div class="source"> +<pre>env: metron-test +</pre></div></div></div> +<div class="section"> +<h3><a name="Selective_Provisioning"></a>Selective Provisioning</h3> +<p>To provision only subsets of the entire Metron deployment, Ansible tags can be specified. For example, to only deploy the sensors on an Amazon EC2 environment, run the following command.</p> + +<div class="source"> +<div class="source"> +<pre>ansible-playbook -i ec2.py playbook.yml --tags "ec2,sensors" +</pre></div></div></div> +<div class="section"> +<h3><a name="Custom_SSH_Key"></a>Custom SSH Key</h3> +<p>By default, the playbook will attempt to register your public SSH key <tt>~/.ssh/id_rsa.pub</tt> with each provisioned host. This enables Ansible to communicate with each host using an SSH connection. If would prefer to use another key simply add the path to the public key file to the <tt>key_file</tt> property in <tt>conf/defaults.yml</tt>.</p> +<p>For example, generate a new SSH key for Metron that will be stored at <tt>~/.ssh/my-metron-key</tt>.</p> + +<div class="source"> +<div class="source"> +<pre>$ ssh-keygen -q -f ~/.ssh/my-metron-key +Enter passphrase (empty for no passphrase): +Enter same passphrase again: +</pre></div></div> +<p>Add the path to the newly created SSH public key to <tt>conf/defaults.yml</tt>.</p> + +<div class="source"> +<div class="source"> +<pre>key_file: ~/.ssh/metron-private-key.pub +</pre></div></div></div></div> +<div class="section"> +<h2><a name="Common_Errors"></a>Common Errors</h2> +<div class="section"> +<h3><a name="Error:_unsupported_operation_exception_custom_format_isnt_supported"></a>Error: [unsupported_operation_exception] custom format isn’t supported</h3> +<p>This error might be seen within Metron’s default dashboard in Kibana 4. This occurs when the index templates do not exist for the Snort, Bro or YAF indices in Elasticsearch. </p> +<p>The dashboard expects fields to be of a certain type. If the index templates have not been loaded correctly, the data types for the fields in these indices will be incorrect and the dashboard will display this error.</p> +<div class="section"> +<h4><a name="Solution"></a>Solution</h4> +<p>If you see this error, please report your findings by creating a JIRA or dropping an email to the Metron Users mailing list. Follow these steps to work around the problem.</p> + +<ol style="list-style-type: decimal"> + +<li> +<p>Define which Elasticsearch host to interact with. Any Elasticsearch host should work.</p> + +<div class="source"> +<div class="source"> +<pre>export ES_HOST="http://ec2-52-25-237-20.us-west-2.compute.amazonaws.com:9200" +</pre></div></div></li> + +<li> +<p>Confirm the index templates are in fact missing. </p> + +<div class="source"> +<div class="source"> +<pre>curl -s -XGET $ES_HOST/_template +</pre></div></div></li> + +<li> +<p>Manually load the index templates.</p> + +<div class="source"> +<div class="source"> +<pre>cd metron-deployment +curl -s -XPOST $ES_HOST/_template/bro_index -d @roles/metron_elasticsearch_templates/files/es_templates/bro_index.template +curl -s -XPOST $ES_HOST/_template/snort_index -d @roles/metron_elasticsearch_templates/files/es_templates/snort_index.template +curl -s -XPOST $ES_HOST/_template/yaf_index -d @roles/metron_elasticsearch_templates/files/es_templates/yaf_index.template +</pre></div></div></li> + +<li> +<p>Delete the existing indexes. Only a new index will use the templates defined in the previous step.</p> + +<div class="source"> +<div class="source"> +<pre>curl -s -XDELETE "$ES_HOST/yaf_index*" +curl -s -XDELETE "$ES_HOST/bro_index*" +curl -s -XDELETE "$ES_HOST/snort_index*" +</pre></div></div></li> + +<li> +<p>Open up Kibana and wait for the new indexes to be created. The dashboard should now work.</p></li> +</ol></div></div> +<div class="section"> +<h3><a name="Error:_No_handler_was_ready_to_authenticateCheck_your_credentials"></a>Error: ‘No handler was ready to authenticate…Check your credentials’</h3> + +<div class="source"> +<div class="source"> +<pre>TASK [Define keypair] ********************************************************** +failed: [localhost] => (item=ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDXbcb1AlWsEPP + r9jEFrn0yun3PYNidJ/...da...@hasselhoff.com) => {"failed": true, "item": "ssh-r + sa AAAAB3NzaC1yc2EAAAADAQABAAABAQDXbcb1AlWsEPPr9jEFr... da...@hasselhoff.com", + "msg": "No handler was ready to authenticate. 1 handlers were checked. + ['HmacAuthV4Handler'] Check your credentials"} +</pre></div></div> +<div class="section"> +<h4><a name="Solution_1"></a>Solution 1</h4> +<p>This occurs when Ansible does not have the correct AWS access keys. The following commands must return a valid access key that is defined within Amazon’s <a class="externalLink" href="https://console.aws.amazon.com/iam/";>Identity and Access Management</a> console. </p> + +<div class="source"> +<div class="source"> +<pre>$ echo $AWS_ACCESS_KEY_ID +AKIAI6NRFEO27E5FFELQ + +$ echo $AWS_SECRET_ACCESS_KEY +vTDydWJQnAer7OWauUS150i+9Np7hfCXrrVVP6ed +</pre></div></div></div> +<div class="section"> +<h4><a name="Solution_2"></a>Solution 2</h4> +<p>This error can occur if you have exported the correct AWS access key, but you are using <tt>sudo</tt> to run the Ansible playbook. Do not use the <tt>sudo</tt> command when running the Ansible playbook.</p></div></div> +<div class="section"> +<h3><a name="Error:_OptInRequired:__you_need_to_accept_terms_and_subscribe"></a>Error: ‘OptInRequired: … you need to accept terms and subscribe’</h3> + +<div class="source"> +<div class="source"> +<pre>TASK [metron-test: Instantiate 1 host(s) as sensors,ambari_master,metron,ec2] ** +fatal: [localhost]: FAILED! => {"changed": false, "failed": true, "msg": +"Instance creation failed => OptInRequired: In order to use this AWS Marketplace +product you need to accept terms and subscribe. To do so please visit +http://aws.amazon.com/marketplace/pp?sku=6x5jmcajty9edm3f211pqjfn2"} +to retry, use: --limit @playbook.retry +</pre></div></div> +<div class="section"> +<h4><a name="Solution"></a>Solution</h4> +<p>Apache Metron uses the <a class="externalLink" href="https://aws.amazon.com/marketplace/pp?sku=6x5jmcajty9edm3f211pqjfn2";>official CentOS 6 Amazon Machine Image</a> when provisioning hosts. Amazon requires that you accept certain terms and conditions when using any Amazon Machine Image (AMI). Follow the link provided in the error message to accept the terms and conditions then re-run the playbook. </p></div></div> +<div class="section"> +<h3><a name="Error:_PendingVerification:_Your_account_is_currently_being_verified"></a>Error: ‘PendingVerification: Your account is currently being verified’</h3> + +<div class="source"> +<div class="source"> +<pre>TASK [metron-test: Instantiate 1 host(s) as sensors,ambari_master,metron,ec2] ** +fatal: [localhost]: FAILED! => {"changed": false, "failed": true, "msg": +"Instance creation failed => PendingVerification: Your account is currently +being verified. Verification normally takes less than 2 hours. Until your +account is verified, you may not be able to launch additional instances or +create additional volumes. If you are still receiving this message after more +than 2 hours, please let us know by writing to aws-verificat...@amazon.com. We +appreciate your patience."} +to retry, use: --limit @playbook.retry +</pre></div></div> +<div class="section"> +<h4><a name="Solution"></a>Solution</h4> +<p>This will occur if you are attempting to deploy Apache Metron using a newly created Amazon Web Services account. Follow the advice of the message and wait until Amazon’s verification process is complete. Amazon has some additional <a class="externalLink" href="http://docs.aws.amazon.com/AWSEC2/latest/APIReference/errors-overview.html";>advice for dealing with this error and more</a>.</p> + +<blockquote> +<p>Your account is pending verification. Until the verification process is complete, you may not be able to carry out requests with this account. If you have questions, contact <a class="externalLink" href="http://console.aws.amazon.com/support/home#/";>AWS Support</a>.</p> +</blockquote></div></div> +<div class="section"> +<h3><a name="Error:_Instance_creation_failed__InstanceLimitExceeded"></a>Error: ‘Instance creation failed => InstanceLimitExceeded’</h3> + +<div class="source"> +<div class="source"> +<pre>TASK [metron-test: Instantiate 3 host(s) as search,metron,ec2] ***************** +fatal: [localhost]: FAILED! => {"changed": false, "failed": true, "msg": +"Instance creation failed => InstanceLimitExceeded: You have requested more +instances (11) than your current instance limit of 10 allows for the specified +instance type. Please visit http://aws.amazon.com/contact-us/ec2-request to +request an adjustment to this limit."} +to retry, use: --limit @playbook.retry +</pre></div></div> +<div class="section"> +<h4><a name="Solution"></a>Solution</h4> +<p>This will occur if Apache Metron attempts to deploy more host instances than allowed by your account. The total number of instances required for Apache Metron can be reduced by editing <tt>deployment/amazon-ec/playbook.yml</tt>. Perhaps a better alternative is to request of Amazon that this limit be increased. Amazon has some additional <a class="externalLink" href="http://docs.aws.amazon.com/AWSEC2/latest/APIReference/errors-overview.html";>advice for dealing with this error and more</a>.</p> + +<blockquote> +<p>You’ve reached the limit on the number of instances you can run concurrently. The limit depends on the instance type. For more information, see <a class="externalLink" href="http://aws.amazon.com/ec2/faqs/#How_many_instances_can_I_run_in_Amazon_EC2";>How many instances can I run in Amazon EC2</a>. If you need additional instances, complete the <a class="externalLink" href="https://console.aws.amazon.com/support/home#/case/create?issueType=service-limit-increase&limitType=service-code-ec2-instances";>Amazon EC2 Instance Request Form</a>.</p> +</blockquote></div></div> +<div class="section"> +<h3><a name="Error:_SSH_encountered_an_unknown_error_during_the_connection"></a>Error: ‘SSH encountered an unknown error during the connection’</h3> + +<div class="source"> +<div class="source"> +<pre>TASK [setup] ******************************************************************* +fatal: [ec2-52-26-113-221.us-west-2.compute.amazonaws.com]: UNREACHABLE! => { + "changed": false, "msg": "SSH encountered an unknown error during the + connection. We recommend you re-run the command using -vvvv, which will enable + SSH debugging output to help diagnose the issue", "unreachable": true} +</pre></div></div> +<div class="section"> +<h4><a name="Solution"></a>Solution</h4> +<p>This most often indicates that Ansible cannot connect to the host with the SSH key that it has access to. This could occur if hosts are provisioned with one SSH key, but the playbook is executed subsequently with a different SSH key. The issue can be addressed by either altering the <tt>key_file</tt> variable to point to the key that was used to provision the hosts or by simply terminating all hosts and re-running the playbook.</p></div></div></div> + </div> + </div> + </div> + + <hr/> + + <footer> + <div class="container-fluid"> + <div class="row span12">Copyright © 2017 + <a href="https://www.apache.org";>The Apache Software Foundation</a>. + All Rights Reserved. + + </div> + + + + </div> + </footer> + </body> +</html>
Added: release/metron/0.4.0/site-book/metron-deployment/index.html ============================================================================== --- release/metron/0.4.0/site-book/metron-deployment/index.html (added) +++ release/metron/0.4.0/site-book/metron-deployment/index.html Wed Jul 5 06:56:42 2017 @@ -0,0 +1,499 @@ +<!DOCTYPE html> +<!-- + | Generated by Apache Maven Doxia at 2017-06-27 + | Rendered using Apache Maven Fluido Skin 1.3.0 +--> +<html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en"> + <head> + <meta charset="UTF-8" /> + <meta name="viewport" content="width=device-width, initial-scale=1.0" /> + <meta name="Date-Revision-yyyymmdd" content="20170627" /> + <meta http-equiv="Content-Language" content="en" /> + <title>Metron – Overview</title> + <link rel="stylesheet" href="../css/apache-maven-fluido-1.3.0.min.css" /> + <link rel="stylesheet" href="../css/site.css" /> + <link rel="stylesheet" href="../css/print.css" media="print" /> + + + <script type="text/javascript" src="../js/apache-maven-fluido-1.3.0.min.js"></script> + + + +<script type="text/javascript">$( document ).ready( function() { $( '.carousel' ).carousel( { interval: 3500 } ) } );</script> + + </head> + <body class="topBarDisabled"> + + + + + <div class="container-fluid"> + <div id="banner"> + <div class="pull-left"> + <a href="http://metron.apache.org/"; id="bannerLeft"> + <img src="../images/metron-logo.png" alt="Apache Metron" width="148px" height="48px"/> + </a> + </div> + <div class="pull-right"> </div> + <div class="clear"><hr/></div> + </div> + + <div id="breadcrumbs"> + <ul class="breadcrumb"> + + + <li class=""> + <a href="http://www.apache.org"; class="externalLink" title="Apache"> + Apache</a> + </li> + <li class="divider ">/</li> + <li class=""> + <a href="http://metron.apache.org/"; class="externalLink" title="Metron"> + Metron</a> + </li> + <li class="divider ">/</li> + <li class=""> + <a href="../index.html" title="Documentation"> + Documentation</a> + </li> + <li class="divider ">/</li> + <li class="">Overview</li> + + + + <li id="publishDate" class="pull-right">Last Published: 2017-06-27</li> <li class="divider pull-right">|</li> + <li id="projectVersion" class="pull-right">Version: 0.4.0</li> + + </ul> + </div> + + + <div class="row-fluid"> + <div id="leftColumn" class="span3"> + <div class="well sidebar-nav"> + + + <ul class="nav nav-list"> + <li class="nav-header">User Documentation</li> + + <li> + + <a href="../index.html" title="Metron"> + <i class="icon-chevron-down"></i> + Metron</a> + <ul class="nav nav-list"> + + <li> + + <a href="../Upgrading.html" title="Upgrading"> + <i class="none"></i> + Upgrading</a> + </li> + + <li> + + <a href="../metron-analytics/index.html" title="Analytics"> + <i class="icon-chevron-right"></i> + Analytics</a> + </li> + + <li class="active"> + + <a href="#"><i class="icon-chevron-down"></i>Deployment</a> + <ul class="nav nav-list"> + + <li> + + <a href="../metron-deployment/Kerberos-ambari-setup.html" title="Kerberos-ambari-setup"> + <i class="none"></i> + Kerberos-ambari-setup</a> + </li> + + <li> + + <a href="../metron-deployment/Kerberos-manual-setup.html" title="Kerberos-manual-setup"> + <i class="none"></i> + Kerberos-manual-setup</a> + </li> + + <li> + + <a href="../metron-deployment/amazon-ec2/index.html" title="Amazon-ec2"> + <i class="none"></i> + Amazon-ec2</a> + </li> + + <li> + + <a href="../metron-deployment/packaging/docker/ansible-docker/index.html" title="Ansible-docker"> + <i class="none"></i> + Ansible-docker</a> + </li> + + <li> + + <a href="../metron-deployment/packaging/docker/rpm-docker/index.html" title="Rpm-docker"> + <i class="none"></i> + Rpm-docker</a> + </li> + + <li> + + <a href="../metron-deployment/packaging/packer-build/index.html" title="Packer-build"> + <i class="none"></i> + Packer-build</a> + </li> + + <li> + + <a href="../metron-deployment/roles/index.html" title="Roles"> + <i class="icon-chevron-right"></i> + Roles</a> + </li> + + <li> + + <a href="../metron-deployment/vagrant/index.html" title="Vagrant"> + <i class="icon-chevron-right"></i> + Vagrant</a> + </li> + </ul> + </li> + + <li> + + <a href="../metron-docker/index.html" title="Docker"> + <i class="none"></i> + Docker</a> + </li> + + <li> + + <a href="../metron-interface/metron-config/index.html" title="Config"> + <i class="none"></i> + Config</a> + </li> + + <li> + + <a href="../metron-interface/metron-rest/index.html" title="Rest"> + <i class="none"></i> + Rest</a> + </li> + + <li> + + <a href="../metron-platform/index.html" title="Platform"> + <i class="icon-chevron-right"></i> + Platform</a> + </li> + + <li> + + <a href="../metron-sensors/index.html" title="Sensors"> + <i class="icon-chevron-right"></i> + Sensors</a> + </li> + </ul> + </li> + </ul> + + + + <hr class="divider" /> + + <div id="poweredBy"> + <div class="clear"></div> + <div class="clear"></div> + <div class="clear"></div> + <a href="http://maven.apache.org/"; title="Built by Maven" class="poweredBy"> + <img class="builtBy" alt="Built by Maven" src="../images/logos/maven-feather.png" /> + </a> + </div> + </div> + </div> + + + <div id="bodyColumn" class="span9" > + + <h1>Overview</h1> +<p><a name="Overview"></a></p> +<p>This set of playbooks can be used to deploy an Ambari-managed Hadoop cluster containing Metron services using Ansible. These playbooks target RHEL/CentOS 6.x operating systems.</p> +<p>Installation consists of -</p> + +<ul> + +<li>Building Metron tarballs, RPMs and the Ambari MPack</li> + +<li>Deploying Ambari</li> + +<li>Leveraging Ambari to install: + +<ul> + +<li>The required Hadoop Components</li> + +<li>Core Metron (Parsing, Enrichment, Indexing)</li> + +<li>Elasticsearch</li> + +<li>Kibana</li> + </ul></li> + +<li>Starting All Services</li> +</ul> +<div class="section"> +<h2><a name="Prerequisites"></a>Prerequisites</h2> +<p>The following tools are required to run these scripts:</p> + +<ul> + +<li><a class="externalLink" href="https://maven.apache.org/";>Maven</a></li> + +<li><a class="externalLink" href="https://git-scm.com/";>Git</a></li> + +<li><a class="externalLink" href="http://www.ansible.com/";>Ansible</a> (2.0.0.2 or 2.2.2.0)</li> + +<li><a class="externalLink" href="https://www.docker.com/";>Docker</a> (Docker for Mac on OSX)</li> +</ul> +<p>These scripts depend on two files for configuration:</p> + +<ul> + +<li>hosts - declares which Ansible roles will be run on which hosts</li> + +<li>group_vars/all - various configuration settings needed to install Metron</li> +</ul> +<p>For production use, it is recommended that Metron be installed on an existing cluster managed by Ambari as described in the Installing Management Pack section below.</p></div> +<div class="section"> +<h2><a name="Ambari"></a>Ambari</h2> +<p>The Ambari playbook will install a Hadoop cluster including the Metron Services (Parsing, Enrichment, Indexing). Ambari will also install Elasticsearch and Kibana.</p> +<p>Currently, the playbooks supports building a local development cluster running on one node or deploying to a 10 node cluster on AWS EC2.</p></div> +<div class="section"> +<h2><a name="Vagrant"></a>Vagrant</h2> +<p>There are current two Vagrant modes, full-dev and quick-dev. Full-dev installs the entire Ambari/Metron stack. This is useful in testing out changes to the installation procedure. Quick-dev re-installs the core Metron Services (Parsing, Enrichment, and Indexing)on a pre-built instance. Use quick-dev for testing out changes to core Metron services.</p> +<div class="section"> +<h3><a name="Prerequsities"></a>Prerequsities</h3> + +<ul> + +<li>Install <a class="externalLink" href="https://www.vagrantup.com/";>Vagrant</a> (5.0.16+)</li> + +<li>Install the Hostmanager plugin for vagrant - Run <tt>vagrant plugin install vagrant-hostmanager</tt> on the machine where Vagrant is installed</li> +</ul></div> +<div class="section"> +<h3><a name="Full-Dev"></a>Full-Dev</h3> +<p>Navigate to <tt>metron/metron-deployment/vagrant/full-dev-platform</tt> and run <tt>vagrant up</tt>.</p></div> +<div class="section"> +<h3><a name="Quick-Dev"></a>Quick-Dev</h3> +<p>Navigate to <tt>metron/metron-deployment/vagrant/quick-dev-platform</tt> and run <tt>vagrant up</tt>.</p></div></div> +<div class="section"> +<h2><a name="Ambari_Management_Pack"></a>Ambari Management Pack</h2> +<p>An Ambari Management Pack can be built in order to make the Metron service available on top of an existing stack, rather than needing a direct stack update.</p> +<p>This will set up</p> + +<ul> + +<li>Metron Parsers</li> + +<li>Enrichment</li> + +<li>Indexing</li> + +<li>GeoIP data</li> + +<li>Optional Elasticsearch</li> + +<li>Optional Kibana</li> +</ul> +<div class="section"> +<h3><a name="Prerequisites"></a>Prerequisites</h3> + +<ul> + +<li>A cluster managed by Ambari 2.4.2+</li> + +<li>Metron RPMs available on the cluster in the /localrepo directory. See <a href="#RPM">RPM</a> for further information.</li> + +<li><a class="externalLink" href="https://nodejs.org/en/download/package-manager/";>Node.js</a> repository installed on the Management UI host</li> +</ul></div> +<div class="section"> +<h3><a name="Building_Management_Pack"></a>Building Management Pack</h3> +<p>From <tt>metron-deployment</tt> run</p> + +<div class="source"> +<div class="source"> +<pre>mvn clean package +</pre></div></div> +<p>A tar.gz that can be used with Ambari can be found at <tt>metron-deployment/packaging/ambari/metron-mpack/target/</tt></p></div> +<div class="section"> +<h3><a name="Installing_Management_Pack"></a>Installing Management Pack</h3> +<p>Before installing the mpack, update Storm’s topology.classpath in Ambari to include ‘/etc/hbase/conf:/etc/hadoop/conf’. Restart Storm service.</p> +<p>Place the mpack’s tar.gz onto the node running Ambari Server. From the command line on this node, run</p> + +<div class="source"> +<div class="source"> +<pre>ambari-server install-mpack --mpack=<mpack_location> --verbose +</pre></div></div> +<p>This will make the services available in Ambari in the same manner as any services in a stack, e.g. through Add Services or during cluster install. The Indexing / Parsers/ Enrichment masters should be colocated with a Kafka Broker (to create topics) and HBase client (to create the enrichment and theatintel tables). This colocation is currently not enforced by Ambari, and should be managed by either a Service or Stack advisor as an enhancement.</p> +<p>Several configuration parameters will need to be filled in, and should be pretty self explanatory (primarily a couple of Elasticsearch configs, and the Storm REST URL). Examples are provided in the descriptions on Ambari. Notably, the URL for the GeoIP database that is preloaded (and is prefilled by default) can be set to use a <tt>file:///</tt> location</p> +<p>After installation, a custom action is available in Ambari (where stop / start services are) to install Elasticsearch templates. Similar to this, a custom Kibana action to Load Template is available.</p> +<p>Another custom action is available in Ambari to import Zeppelin dashboards. See the <a href="../metron-platform/metron-indexing/index.html">metron-indexing documentation</a></p> +<div class="section"> +<h4><a name="Offline_installation"></a>Offline installation</h4> +<p>Currently there is only one point that would reach out to the internet during an install. This is the URL for the GeoIP database information.</p> +<p>The RPMs DO NOT reach out to the internet (because there is currently no hosting for them). They look on the local filesystem in <tt>/localrepo</tt>.</p></div></div> +<div class="section"> +<h3><a name="Current_Limitations"></a>Current Limitations</h3> +<p>There are a set of limitations that should be addressed based to improve the current state of the mpacks.</p> + +<ul> + +<li>There is currently no hosting for RPMs remotely. They will have to be built locally.</li> + +<li>Colocation of appropriate services should be enforced by Ambari. See [#Installing Management Pack] for more details.</li> + +<li>Storm’s topology.classpath is not updated with the Metron service install and needs to be updated separately.</li> + +<li>Several configuration parameters used when installing the Metron service could (and should) be grabbed from Ambari. Install will require them to be manually entered.</li> + +<li>Need to handle upgrading Metron</li> +</ul></div></div> +<div class="section"> +<h2><a name="RPM"></a>RPM</h2> +<p>RPMs can be built to install the components in metron-platform. These RPMs are built in a Docker container and placed into <tt>target</tt>.</p> +<p>Components in the RPMs:</p> + +<ul> + +<li>metron-common</li> + +<li>metron-data-management</li> + +<li>metron-elasticsearch</li> + +<li>metron-enrichment</li> + +<li>metron-parsers</li> + +<li>metron-pcap</li> + +<li>metron-solr</li> +</ul> +<div class="section"> +<h3><a name="Prerequisites"></a>Prerequisites</h3> + +<ul> + +<li>Docker. The image detailed in: <tt>metron-deployment/packaging/docker/rpm-docker/README.md</tt> will automatically be built (or rebuilt if necessary).</li> + +<li>Artifacts for metron-platform have been produced. E.g. <tt>mvn clean package -DskipTests</tt> in <tt>metron-platform</tt></li> +</ul> +<p>The artifacts are required because there is a dependency on modules not expressed via Maven (we grab the resulting assemblies, but don’t need the jars). These are</p> + +<ul> + +<li>metron-common</li> + +<li>metron-data-management</li> + +<li>metron-elasticsearch</li> + +<li>metron-enrichment</li> + +<li>metron-indexing</li> + +<li>metron-parsers</li> + +<li>metron-pcap-backend</li> + +<li>metron-solr</li> + +<li>metron-profiler</li> + +<li>metron-config</li> +</ul></div> +<div class="section"> +<h3><a name="Building_RPMs"></a>Building RPMs</h3> +<p>From <tt>metron-deployment</tt> run</p> + +<div class="source"> +<div class="source"> +<pre>mvn clean package -Pbuild-rpms +</pre></div></div> +<p>The output RPM files will land in <tt>target/RPMS/noarch</tt>. They can be installed with the standard</p> + +<div class="source"> +<div class="source"> +<pre>rpm -i <package> +</pre></div></div></div></div> +<div class="section"> +<h2><a name="Kibana_Dashboards"></a>Kibana Dashboards</h2> +<p>The dashboards installed by the Kibana custom action are managed by the dashboard.p file. This file is created by exporting existing dashboards from a running Kibana instance.</p> +<p>To create a new version of the file, make any necessary changes to Kibana (e.g. on quick-dev), and export with the appropriate script.</p> + +<div class="source"> +<div class="source"> +<pre>python packaging/ambari/metron-mpack/src/main/resources/common-services/KIBANA/4.5.1/package/scripts/dashboard/dashboardindex.py \ +$ES_HOST 9200 \ +packaging/ambari/metron-mpack/src/main/resources/common-services/KIBANA/4.5.1/package/scripts/dashboard/dashboard.p -s +</pre></div></div> +<p>Build the Ambari Mpack to get the dashboard updated appropriately.</p> +<p>Once the MPack is installed, run the Kibana service’s action “Load Template” to install dashboards. This will completely overwrite the .kibana in Elasticsearch, so use with caution.</p></div> +<div class="section"> +<h2><a name="Kerberos"></a>Kerberos</h2> +<p>The MPack can allow Metron to be installed and then Kerberized, or installed on top of an already Kerberized cluster. This is done through Ambari’s standard Kerberization setup.</p> +<div class="section"> +<h3><a name="Caveats"></a>Caveats</h3> + +<ul> + +<li>For nodes using a Metron client and a local repo, the repo must exist on all nodes (e.g via createrepo). This repo can be empty; only the main Metron services need the RPMs.</li> + +<li>A Metron client must be installed on each supervisor node in a secured cluster. This is to ensure that the Metron keytab and client_jaas.conf get distributed in order to allow reading and writing from Kafka. + +<ul> + +<li>When Metron is already installed on the cluster, this should be done before Kerberizing.</li> + +<li>When addding Metron to an already Kerberized cluster, ensure that all supervisor nodes receive a Metron client.</li> + </ul></li> + +<li>Storm (and Metron) must be restarted after Metron is installed on an already Kerberized cluster. Several Storm configs get updated, and Metron will be unable to write to Kafka without a restart. + +<ul> + +<li>Kerberizing a cluster with an existing Metron already has restarts of all services during Kerberization, so it’s unneeded.</li> + </ul></li> +</ul> +<p>Instructions for setup on Full Dev can be found at <a href="Kerberos-ambari-setup.html">Kerberos-ambari-setup.md</a>. These instructions reference the manual install instructions.</p></div> +<div class="section"> +<h3><a name="Kerberos_Without_an_MPack"></a>Kerberos Without an MPack</h3> +<p>Using the MPack is preferred, but instructions for Kerberizing manually can be found at <a href="Kerberos-manual-setup.html">Kerberos-manual-setup.md</a>. These instructions are reference by the Ambari Kerberos install instructions and include commands for setting up a KDC.</p></div></div> +<div class="section"> +<h2><a name="TODO"></a>TODO</h2> + +<ul> + +<li>Support Ubuntu deployments</li> +</ul></div> + </div> + </div> + </div> + + <hr/> + + <footer> + <div class="container-fluid"> + <div class="row span12">Copyright © 2017 + <a href="https://www.apache.org";>The Apache Software Foundation</a>. + All Rights Reserved. + + </div> + + + + </div> + </footer> + </body> +</html> Added: release/metron/0.4.0/site-book/metron-deployment/packaging/docker/ansible-docker/index.html ============================================================================== --- release/metron/0.4.0/site-book/metron-deployment/packaging/docker/ansible-docker/index.html (added) +++ release/metron/0.4.0/site-book/metron-deployment/packaging/docker/ansible-docker/index.html Wed Jul 5 06:56:42 2017 @@ -0,0 +1,265 @@ +<!DOCTYPE html> +<!-- + | Generated by Apache Maven Doxia at 2017-06-27 + | Rendered using Apache Maven Fluido Skin 1.3.0 +--> +<html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en"> + <head> + <meta charset="UTF-8" /> + <meta name="viewport" content="width=device-width, initial-scale=1.0" /> + <meta name="Date-Revision-yyyymmdd" content="20170627" /> + <meta http-equiv="Content-Language" content="en" /> + <title>Metron – Overview</title> + <link rel="stylesheet" href="../../../../css/apache-maven-fluido-1.3.0.min.css" /> + <link rel="stylesheet" href="../../../../css/site.css" /> + <link rel="stylesheet" href="../../../../css/print.css" media="print" /> + + + <script type="text/javascript" src="../../../../js/apache-maven-fluido-1.3.0.min.js"></script> + + + +<script type="text/javascript">$( document ).ready( function() { $( '.carousel' ).carousel( { interval: 3500 } ) } );</script> + + </head> + <body class="topBarDisabled"> + + + + + <div class="container-fluid"> + <div id="banner"> + <div class="pull-left"> + <a href="http://metron.apache.org/"; id="bannerLeft"> + <img src="../../../../images/metron-logo.png" alt="Apache Metron" width="148px" height="48px"/> + </a> + </div> + <div class="pull-right"> </div> + <div class="clear"><hr/></div> + </div> + + <div id="breadcrumbs"> + <ul class="breadcrumb"> + + + <li class=""> + <a href="http://www.apache.org"; class="externalLink" title="Apache"> + Apache</a> + </li> + <li class="divider ">/</li> + <li class=""> + <a href="http://metron.apache.org/"; class="externalLink" title="Metron"> + Metron</a> + </li> + <li class="divider ">/</li> + <li class=""> + <a href="../../../../index.html" title="Documentation"> + Documentation</a> + </li> + <li class="divider ">/</li> + <li class="">Overview</li> + + + + <li id="publishDate" class="pull-right">Last Published: 2017-06-27</li> <li class="divider pull-right">|</li> + <li id="projectVersion" class="pull-right">Version: 0.4.0</li> + + </ul> + </div> + + + <div class="row-fluid"> + <div id="leftColumn" class="span3"> + <div class="well sidebar-nav"> + + + <ul class="nav nav-list"> + <li class="nav-header">User Documentation</li> + + <li> + + <a href="../../../../index.html" title="Metron"> + <i class="icon-chevron-down"></i> + Metron</a> + <ul class="nav nav-list"> + + <li> + + <a href="../../../../Upgrading.html" title="Upgrading"> + <i class="none"></i> + Upgrading</a> + </li> + + <li> + + <a href="../../../../metron-analytics/index.html" title="Analytics"> + <i class="icon-chevron-right"></i> + Analytics</a> + </li> + + <li> + + <a href="../../../../metron-deployment/index.html" title="Deployment"> + <i class="icon-chevron-down"></i> + Deployment</a> + <ul class="nav nav-list"> + + <li> + + <a href="../../../../metron-deployment/Kerberos-ambari-setup.html" title="Kerberos-ambari-setup"> + <i class="none"></i> + Kerberos-ambari-setup</a> + </li> + + <li> + + <a href="../../../../metron-deployment/Kerberos-manual-setup.html" title="Kerberos-manual-setup"> + <i class="none"></i> + Kerberos-manual-setup</a> + </li> + + <li> + + <a href="../../../../metron-deployment/amazon-ec2/index.html" title="Amazon-ec2"> + <i class="none"></i> + Amazon-ec2</a> + </li> + + <li class="active"> + + <a href="#"><i class="none"></i>Ansible-docker</a> + </li> + + <li> + + <a href="../../../../metron-deployment/packaging/docker/rpm-docker/index.html" title="Rpm-docker"> + <i class="none"></i> + Rpm-docker</a> + </li> + + <li> + + <a href="../../../../metron-deployment/packaging/packer-build/index.html" title="Packer-build"> + <i class="none"></i> + Packer-build</a> + </li> + + <li> + + <a href="../../../../metron-deployment/roles/index.html" title="Roles"> + <i class="icon-chevron-right"></i> + Roles</a> + </li> + + <li> + + <a href="../../../../metron-deployment/vagrant/index.html" title="Vagrant"> + <i class="icon-chevron-right"></i> + Vagrant</a> + </li> + </ul> + </li> + + <li> + + <a href="../../../../metron-docker/index.html" title="Docker"> + <i class="none"></i> + Docker</a> + </li> + + <li> + + <a href="../../../../metron-interface/metron-config/index.html" title="Config"> + <i class="none"></i> + Config</a> + </li> + + <li> + + <a href="../../../../metron-interface/metron-rest/index.html" title="Rest"> + <i class="none"></i> + Rest</a> + </li> + + <li> + + <a href="../../../../metron-platform/index.html" title="Platform"> + <i class="icon-chevron-right"></i> + Platform</a> + </li> + + <li> + + <a href="../../../../metron-sensors/index.html" title="Sensors"> + <i class="icon-chevron-right"></i> + Sensors</a> + </li> + </ul> + </li> + </ul> + + + + <hr class="divider" /> + + <div id="poweredBy"> + <div class="clear"></div> + <div class="clear"></div> + <div class="clear"></div> + <a href="http://maven.apache.org/"; title="Built by Maven" class="poweredBy"> + <img class="builtBy" alt="Built by Maven" src="../../../../images/logos/maven-feather.png" /> + </a> + </div> + </div> + </div> + + + <div id="bodyColumn" class="span9" > + + <h1>Overview</h1> +<p><a name="Overview"></a></p> +<p>The Metron ansible-docker container is provided in an effort reduce the installation burden of deploying Metron in a live envirionment. It is provisioned with software required to sucessfully run the deployment scripts.</p> +<div class="section"> +<h2><a name="Building_the_Container"></a>Building the Container</h2> + +<ol style="list-style-type: decimal"> + +<li>Install Docker ( <a class="externalLink" href="https://www.docker.com/products/overview";>https://www.docker.com/products/overview</a> )</li> + +<li>Navigate to <project-directory>/metron-deployment/packaging/docker/ansible-docker</li> + +<li>Build the container <tt>docker build -t ansible-docker:2.0.0.2 .</tt></li> +</ol></div> +<div class="section"> +<h2><a name="Using_the_Container"></a>Using the Container</h2> +<p>Full instructions are found on the wiki at <a class="externalLink" href="https://cwiki.apache.org/confluence/pages/viewpage.action?pageId=65144361";>https://cwiki.apache.org/confluence/pages/viewpage.action?pageId=65144361</a></p> +<p>tl;dr:</p> + +<ol style="list-style-type: decimal"> + +<li>docker run -it -v <project-directory>:/root/metron ansible-docker:2.0.0.2 bash</li> + +<li>cd /root/metron</li> + +<li>mvn clean package -DskipTests</li> +</ol></div> + </div> + </div> + </div> + + <hr/> + + <footer> + <div class="container-fluid"> + <div class="row span12">Copyright © 2017 + <a href="https://www.apache.org";>The Apache Software Foundation</a>. + All Rights Reserved. + + </div> + + + + </div> + </footer> + </body> +</html> Added: release/metron/0.4.0/site-book/metron-deployment/packaging/docker/rpm-docker/index.html ============================================================================== --- release/metron/0.4.0/site-book/metron-deployment/packaging/docker/rpm-docker/index.html (added) +++ release/metron/0.4.0/site-book/metron-deployment/packaging/docker/rpm-docker/index.html Wed Jul 5 06:56:42 2017 @@ -0,0 +1,252 @@ +<!DOCTYPE html> +<!-- + | Generated by Apache Maven Doxia at 2017-06-27 + | Rendered using Apache Maven Fluido Skin 1.3.0 +--> +<html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en"> + <head> + <meta charset="UTF-8" /> + <meta name="viewport" content="width=device-width, initial-scale=1.0" /> + <meta name="Date-Revision-yyyymmdd" content="20170627" /> + <meta http-equiv="Content-Language" content="en" /> + <title>Metron – Overview</title> + <link rel="stylesheet" href="../../../../css/apache-maven-fluido-1.3.0.min.css" /> + <link rel="stylesheet" href="../../../../css/site.css" /> + <link rel="stylesheet" href="../../../../css/print.css" media="print" /> + + + <script type="text/javascript" src="../../../../js/apache-maven-fluido-1.3.0.min.js"></script> + + + +<script type="text/javascript">$( document ).ready( function() { $( '.carousel' ).carousel( { interval: 3500 } ) } );</script> + + </head> + <body class="topBarDisabled"> + + + + + <div class="container-fluid"> + <div id="banner"> + <div class="pull-left"> + <a href="http://metron.apache.org/"; id="bannerLeft"> + <img src="../../../../images/metron-logo.png" alt="Apache Metron" width="148px" height="48px"/> + </a> + </div> + <div class="pull-right"> </div> + <div class="clear"><hr/></div> + </div> + + <div id="breadcrumbs"> + <ul class="breadcrumb"> + + + <li class=""> + <a href="http://www.apache.org"; class="externalLink" title="Apache"> + Apache</a> + </li> + <li class="divider ">/</li> + <li class=""> + <a href="http://metron.apache.org/"; class="externalLink" title="Metron"> + Metron</a> + </li> + <li class="divider ">/</li> + <li class=""> + <a href="../../../../index.html" title="Documentation"> + Documentation</a> + </li> + <li class="divider ">/</li> + <li class="">Overview</li> + + + + <li id="publishDate" class="pull-right">Last Published: 2017-06-27</li> <li class="divider pull-right">|</li> + <li id="projectVersion" class="pull-right">Version: 0.4.0</li> + + </ul> + </div> + + + <div class="row-fluid"> + <div id="leftColumn" class="span3"> + <div class="well sidebar-nav"> + + + <ul class="nav nav-list"> + <li class="nav-header">User Documentation</li> + + <li> + + <a href="../../../../index.html" title="Metron"> + <i class="icon-chevron-down"></i> + Metron</a> + <ul class="nav nav-list"> + + <li> + + <a href="../../../../Upgrading.html" title="Upgrading"> + <i class="none"></i> + Upgrading</a> + </li> + + <li> + + <a href="../../../../metron-analytics/index.html" title="Analytics"> + <i class="icon-chevron-right"></i> + Analytics</a> + </li> + + <li> + + <a href="../../../../metron-deployment/index.html" title="Deployment"> + <i class="icon-chevron-down"></i> + Deployment</a> + <ul class="nav nav-list"> + + <li> + + <a href="../../../../metron-deployment/Kerberos-ambari-setup.html" title="Kerberos-ambari-setup"> + <i class="none"></i> + Kerberos-ambari-setup</a> + </li> + + <li> + + <a href="../../../../metron-deployment/Kerberos-manual-setup.html" title="Kerberos-manual-setup"> + <i class="none"></i> + Kerberos-manual-setup</a> + </li> + + <li> + + <a href="../../../../metron-deployment/amazon-ec2/index.html" title="Amazon-ec2"> + <i class="none"></i> + Amazon-ec2</a> + </li> + + <li> + + <a href="../../../../metron-deployment/packaging/docker/ansible-docker/index.html" title="Ansible-docker"> + <i class="none"></i> + Ansible-docker</a> + </li> + + <li class="active"> + + <a href="#"><i class="none"></i>Rpm-docker</a> + </li> + + <li> + + <a href="../../../../metron-deployment/packaging/packer-build/index.html" title="Packer-build"> + <i class="none"></i> + Packer-build</a> + </li> + + <li> + + <a href="../../../../metron-deployment/roles/index.html" title="Roles"> + <i class="icon-chevron-right"></i> + Roles</a> + </li> + + <li> + + <a href="../../../../metron-deployment/vagrant/index.html" title="Vagrant"> + <i class="icon-chevron-right"></i> + Vagrant</a> + </li> + </ul> + </li> + + <li> + + <a href="../../../../metron-docker/index.html" title="Docker"> + <i class="none"></i> + Docker</a> + </li> + + <li> + + <a href="../../../../metron-interface/metron-config/index.html" title="Config"> + <i class="none"></i> + Config</a> + </li> + + <li> + + <a href="../../../../metron-interface/metron-rest/index.html" title="Rest"> + <i class="none"></i> + Rest</a> + </li> + + <li> + + <a href="../../../../metron-platform/index.html" title="Platform"> + <i class="icon-chevron-right"></i> + Platform</a> + </li> + + <li> + + <a href="../../../../metron-sensors/index.html" title="Sensors"> + <i class="icon-chevron-right"></i> + Sensors</a> + </li> + </ul> + </li> + </ul> + + + + <hr class="divider" /> + + <div id="poweredBy"> + <div class="clear"></div> + <div class="clear"></div> + <div class="clear"></div> + <a href="http://maven.apache.org/"; title="Built by Maven" class="poweredBy"> + <img class="builtBy" alt="Built by Maven" src="../../../../images/logos/maven-feather.png" /> + </a> + </div> + </div> + </div> + + + <div id="bodyColumn" class="span9" > + + <h1>Overview</h1> +<p><a name="Overview"></a></p> +<p>The Metron ansible-docker container is provided in an effort reduce the installation burden of deploying Metron in a live envirionment. It is provisioned with software required to sucessfully run the deployment scripts.</p> +<div class="section"> +<h2><a name="Building_the_Container"></a>Building the Container</h2> + +<ol style="list-style-type: decimal"> + +<li>Install Docker ( <a class="externalLink" href="https://www.docker.com/products/overview";>https://www.docker.com/products/overview</a> )</li> + +<li>Navigate to <project-directory>/metron-deployment/packaging/rpm-docker</li> + +<li>Build the container <tt>docker build -t rpm-docker .</tt></li> +</ol></div> + </div> + </div> + </div> + + <hr/> + + <footer> + <div class="container-fluid"> + <div class="row span12">Copyright © 2017 + <a href="https://www.apache.org";>The Apache Software Foundation</a>. + All Rights Reserved. + + </div> + + + + </div> + </footer> + </body> +</html> Added: release/metron/0.4.0/site-book/metron-deployment/packaging/packer-build/index.html ============================================================================== --- release/metron/0.4.0/site-book/metron-deployment/packaging/packer-build/index.html (added) +++ release/metron/0.4.0/site-book/metron-deployment/packaging/packer-build/index.html Wed Jul 5 06:56:42 2017 @@ -0,0 +1,298 @@ +<!DOCTYPE html> +<!-- + | Generated by Apache Maven Doxia at 2017-06-27 + | Rendered using Apache Maven Fluido Skin 1.3.0 +--> +<html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en"> + <head> + <meta charset="UTF-8" /> + <meta name="viewport" content="width=device-width, initial-scale=1.0" /> + <meta name="Date-Revision-yyyymmdd" content="20170627" /> + <meta http-equiv="Content-Language" content="en" /> + <title>Metron – Build Metron Images</title> + <link rel="stylesheet" href="../../../css/apache-maven-fluido-1.3.0.min.css" /> + <link rel="stylesheet" href="../../../css/site.css" /> + <link rel="stylesheet" href="../../../css/print.css" media="print" /> + + + <script type="text/javascript" src="../../../js/apache-maven-fluido-1.3.0.min.js"></script> + + + +<script type="text/javascript">$( document ).ready( function() { $( '.carousel' ).carousel( { interval: 3500 } ) } );</script> + + </head> + <body class="topBarDisabled"> + + + + + <div class="container-fluid"> + <div id="banner"> + <div class="pull-left"> + <a href="http://metron.apache.org/"; id="bannerLeft"> + <img src="../../../images/metron-logo.png" alt="Apache Metron" width="148px" height="48px"/> + </a> + </div> + <div class="pull-right"> </div> + <div class="clear"><hr/></div> + </div> + + <div id="breadcrumbs"> + <ul class="breadcrumb"> + + + <li class=""> + <a href="http://www.apache.org"; class="externalLink" title="Apache"> + Apache</a> + </li> + <li class="divider ">/</li> + <li class=""> + <a href="http://metron.apache.org/"; class="externalLink" title="Metron"> + Metron</a> + </li> + <li class="divider ">/</li> + <li class=""> + <a href="../../../index.html" title="Documentation"> + Documentation</a> + </li> + <li class="divider ">/</li> + <li class="">Build Metron Images</li> + + + + <li id="publishDate" class="pull-right">Last Published: 2017-06-27</li> <li class="divider pull-right">|</li> + <li id="projectVersion" class="pull-right">Version: 0.4.0</li> + + </ul> + </div> + + + <div class="row-fluid"> + <div id="leftColumn" class="span3"> + <div class="well sidebar-nav"> + + + <ul class="nav nav-list"> + <li class="nav-header">User Documentation</li> + + <li> + + <a href="../../../index.html" title="Metron"> + <i class="icon-chevron-down"></i> + Metron</a> + <ul class="nav nav-list"> + + <li> + + <a href="../../../Upgrading.html" title="Upgrading"> + <i class="none"></i> + Upgrading</a> + </li> + + <li> + + <a href="../../../metron-analytics/index.html" title="Analytics"> + <i class="icon-chevron-right"></i> + Analytics</a> + </li> + + <li> + + <a href="../../../metron-deployment/index.html" title="Deployment"> + <i class="icon-chevron-down"></i> + Deployment</a> + <ul class="nav nav-list"> + + <li> + + <a href="../../../metron-deployment/Kerberos-ambari-setup.html" title="Kerberos-ambari-setup"> + <i class="none"></i> + Kerberos-ambari-setup</a> + </li> + + <li> + + <a href="../../../metron-deployment/Kerberos-manual-setup.html" title="Kerberos-manual-setup"> + <i class="none"></i> + Kerberos-manual-setup</a> + </li> + + <li> + + <a href="../../../metron-deployment/amazon-ec2/index.html" title="Amazon-ec2"> + <i class="none"></i> + Amazon-ec2</a> + </li> + + <li> + + <a href="../../../metron-deployment/packaging/docker/ansible-docker/index.html" title="Ansible-docker"> + <i class="none"></i> + Ansible-docker</a> + </li> + + <li> + + <a href="../../../metron-deployment/packaging/docker/rpm-docker/index.html" title="Rpm-docker"> + <i class="none"></i> + Rpm-docker</a> + </li> + + <li class="active"> + + <a href="#"><i class="none"></i>Packer-build</a> + </li> + + <li> + + <a href="../../../metron-deployment/roles/index.html" title="Roles"> + <i class="icon-chevron-right"></i> + Roles</a> + </li> + + <li> + + <a href="../../../metron-deployment/vagrant/index.html" title="Vagrant"> + <i class="icon-chevron-right"></i> + Vagrant</a> + </li> + </ul> + </li> + + <li> + + <a href="../../../metron-docker/index.html" title="Docker"> + <i class="none"></i> + Docker</a> + </li> + + <li> + + <a href="../../../metron-interface/metron-config/index.html" title="Config"> + <i class="none"></i> + Config</a> + </li> + + <li> + + <a href="../../../metron-interface/metron-rest/index.html" title="Rest"> + <i class="none"></i> + Rest</a> + </li> + + <li> + + <a href="../../../metron-platform/index.html" title="Platform"> + <i class="icon-chevron-right"></i> + Platform</a> + </li> + + <li> + + <a href="../../../metron-sensors/index.html" title="Sensors"> + <i class="icon-chevron-right"></i> + Sensors</a> + </li> + </ul> + </li> + </ul> + + + + <hr class="divider" /> + + <div id="poweredBy"> + <div class="clear"></div> + <div class="clear"></div> + <div class="clear"></div> + <a href="http://maven.apache.org/"; title="Built by Maven" class="poweredBy"> + <img class="builtBy" alt="Built by Maven" src="../../../images/logos/maven-feather.png" /> + </a> + </div> + </div> + </div> + + + <div id="bodyColumn" class="span9" > + + <h1>Build Metron Images</h1> +<p>Based on the fantastic <a class="externalLink" href="https://github.com/chef/bento";>Bento</a> project developed by Chef.</p> +<div class="section"> +<h2><a name="Images_Provided"></a>Images Provided</h2> + +<ul> + +<li>base-centos-6.7: Centos 6.7 + HDP. Used in the full-dev-platform Vagrant image</li> + +<li>quick-dev-centos-6.7: Centos 6.7 + HDP + Metron. Used for the quick-dev-platform Vagrant image.</li> +</ul></div> +<div class="section"> +<h2><a name="Prerequisites"></a>Prerequisites</h2> + +<ul> + +<li><a class="externalLink" href="https://www.packer.io/";>Packer</a> 0.12.2</li> + +<li><a class="externalLink" href="https://www.virtualbox.org/";>Virtualbox</a> 5.0.16+ (Tested with 5.0.20)</li> +</ul> +<p>Build Both Images ———————- Navigate to <your-project-directory>/metron-deployment/packer-build Execute bin/bento build</p> +<p>Packer will build both images and export .box files to the ./builds directory.</p> +<p>Build Single Images ———————- Navigate to <i>your-project-directory</i>/metron-deployment/packer-build</p> + +<ul> + +<li>Base Centos (full-dev)</li> +</ul> + +<div class="source"> +<div class="source"> +<pre>bin/bento build base-centos-6.7.json +</pre></div></div> + +<ul> + +<li>Quick Dev</li> +</ul> + +<div class="source"> +<div class="source"> +<pre>bin/bento build quick-dev-centos-6.7.json +</pre></div></div> +<p>Using Your New Box File ———————- Modify the relevant Vagrantfile (full-dev-platform or quick-dev-platform) replacing the lines:</p> + +<div class="source"> +<div class="source"> +<pre><pre><code>config.vm.box = "<i>box_name</i>" +config.ssh.insert_key = true</code></pre> +</pre></div></div> +<p>with</p> + +<div class="source"> +<div class="source"> +<pre><pre></code>config.vm.box = "<i>test_box_name</i>" +config.vm.box = "<i>PathToBoxfile/Boxfilename</i>" +config.ssh.insert_key = true</code></pre> +</pre></div></div> +<p>Launch the image as usual.</p> +<p>Node: Vagrant will cache boxes, you can force Vagrant to reload your box by running <tt>vagrant box remove <i>test_box_name</i></tt> before launching your new image.</p></div> + </div> + </div> + </div> + + <hr/> + + <footer> + <div class="container-fluid"> + <div class="row span12">Copyright © 2017 + <a href="https://www.apache.org";>The Apache Software Foundation</a>. + All Rights Reserved. + + </div> + + + + </div> + </footer> + </body> +</html>
