metron-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From anandsubbu <...@git.apache.org>
Subject [GitHub] metron pull request #869: METRON-1362 Improve Metron Deployment README
Date Tue, 02 Jan 2018 18:03:15 GMT
Github user anandsubbu commented on a diff in the pull request:

    https://github.com/apache/metron/pull/869#discussion_r159280034
  
    --- Diff: metron-deployment/README.md ---
    @@ -15,178 +15,132 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied.
     See the License for the specific language governing permissions and
     limitations under the License.
     -->
    -# Overview
    -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.
    -
    -Installation consists of -
    -- Building Metron tarballs, RPMs and the Ambari MPack
    -- Deploying Ambari
    -- Leveraging Ambari to install:
    -  * The required Hadoop Components
    -  * Core Metron (Parsing, Enrichment, Indexing)
    -  * Elasticsearch
    -  * Kibana
    -- Starting All Services
    -
    -## Prerequisites
    -The following tools are required to run these scripts:
    -
    -- [Maven](https://maven.apache.org/)
    -- [Git](https://git-scm.com/)
    -- [Ansible](http://www.ansible.com/) (2.0.0.2 or 2.2.2.0)
    -- [Docker](https://www.docker.com/) (Docker for Mac on OSX)
    -
    -These scripts depend on two files for configuration:
    -
    -- hosts - declares which Ansible roles will be run on which hosts
    -- group_vars/all - various configuration settings needed to install Metron
    -
    -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.
    -## Ambari
    -The Ambari playbook will install a Hadoop cluster including the Metron Services (Parsing,
Enrichment, Indexing). Ambari will also install Elasticsearch and Kibana.
    -
    -Currently, the playbooks supports building a local development cluster running on one
node or deploying to a 10 node cluster on AWS EC2.
    -
    -## Vagrant
    -There is a development environment based on Vagrant that is referred to as "Full Dev".
 This installs the entire Ambari/Metron stack. This is useful in testing out changes to the
installation procedure.
    -
    -### Prerequsities
    -- Install [Vagrant](https://www.vagrantup.com/) (5.0.16+)
    -- Install the Hostmanager plugin for vagrant - Run `vagrant plugin install vagrant-hostmanager`
on the machine where Vagrant is
    -installed
    -
    -### Full-Dev
    -Navigate to `metron/metron-deployment/vagrant/full-dev-platform` and run `vagrant up`.
    -
    -## Ambari Management Pack
    -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.
    -
    -This will set up
    -- Metron Parsers
    -- Enrichment
    -- Indexing
    -- GeoIP data
    -- Optional Elasticsearch
    -- Optional Kibana
    -
    -### Prerequisites
    +This project contains a variety of tools for deploying Apache Metron.  Please refer to
the following sections for more information on the best way to deploy Metron in your environment.
    +
    + * [How do I deploy Metron on a single VM?](#how-do-i-deploy-metron-on-a-single-vm)
    + * [How do I deploy Metron on a large cluster with Ambari?](#how-do-i-deploy-metron-on-a-large-cluster-with-ambari)
    + * [How do I build RPM packages?](#how-do-i-build-rpm-packages)
    + * [How do I build DEB packages?](#how-do-i-build-deb-packages)
    + * [How do I deploy Metron within AWS?](#how-do-i-deploy-metron-within-aws)
    +
    +## How do I deploy Metron on a single VM?
    +
    +#### Who is this for?
    +
    +If you are new to Metron and just want to explore the functionality that it offers, this
is good place to start.  If you are a developer building on Metron, then this is also a great
way to test out your changes.
    +
    +#### What does this do?
    +
    +This option will deploy Metron on a virtual machine running on your computer.  This is
often referred to as the "Full Dev" environment.  
    +
    +#### How do I do it?
    +Follow these [instructions to deploy Metron on a single VM](vagrant/full-dev-platform/README.md).
    +
    +#### Where can I get more information?
    +* [Full Dev Platform](vagrant/full-dev-platform)
    +
    +## How do I deploy Metron on a large cluster with Ambari?
    +
    +#### Who is this for?
    +
    +If you want to see how Metron can really scale by deploying it on your own hardware,
or even in your own cloud-based environment, this is the best option for you.
    +
    +#### What does this do?
    +
    +This creates a Management Pack (MPack) extension for [Apache Ambari](https://ambari.apache.org/)
that simplifies the provisioning, managing and monitoring of Metron on large clusters.  This
allows you to easily install Metron on a large cluster using a simple, guided process.  This
also allows you to monitor cluster health and even secure your cluster with kerberos.
    +
    +#### How do I do it?
    +
    +##### Prerequisites
    +
     - A cluster managed by Ambari 2.4.2+
    -- Metron RPMs available on the cluster in the /localrepo directory.  See [RPMs](#rpms)
for further information.
    -- [Node.js](https://nodejs.org/en/download/package-manager/) repository installed on
the Management UI host
    +- Installable Metron packages (either RPMs or DEBs) available on the cluster, by default,
in the `/localrepo` directory.  
    +- A [Node.js](https://nodejs.org/en/download/package-manager/) repository installed on
the host running the Management and Alarm UI.
    +
    +##### How do I build the Mpack?
    +
    +```
    +cd metron-deployment
    +mvn clean package -Pmpack
    +```
     
    -### Building Management Pack
    -From `metron-deployment` run
    +This results in the Mpack being produced at the following location.
     ```
    -mvn clean package
    +metron-deployment/packaging/ambari/metron-mpack/target/metron_mpack-0.4.2.0.tar.gz
    --- End diff --
    
    Hi @nickwallen , would it be better to note the version like `metron_mpack-x.x.x.x.tar.gz`
instead of 0.4.2.0 so we need not have to update the README over releases? 


---

Mime
View raw message