You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@metron.apache.org by ce...@apache.org on 2016/06/24 20:57:51 UTC
[53/66] [abbrv] incubator-metron git commit: METRON-244 Fix Metron
documentation (nickwallen) closes apache/incubator-metron#164
METRON-244 Fix Metron documentation (nickwallen) closes apache/incubator-metron#164
Project: http://git-wip-us.apache.org/repos/asf/incubator-metron/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-metron/commit/4978085f
Tree: http://git-wip-us.apache.org/repos/asf/incubator-metron/tree/4978085f
Diff: http://git-wip-us.apache.org/repos/asf/incubator-metron/diff/4978085f
Branch: refs/heads/master
Commit: 4978085f61bf7586aecee202784449195ff76b8e
Parents: 72559d1
Author: nickwallen <ni...@nickallen.org>
Authored: Tue Jun 21 14:09:31 2016 -0400
Committer: Nick Allen <ni...@nickallen.org>
Committed: Tue Jun 21 14:09:31 2016 -0400
----------------------------------------------------------------------
metron-deployment/amazon-ec2/README.md | 8 ++--
metron-deployment/roles/monit/README.md | 62 ++++++++++++++++++++++++++++
2 files changed, 66 insertions(+), 4 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-metron/blob/4978085f/metron-deployment/amazon-ec2/README.md
----------------------------------------------------------------------
diff --git a/metron-deployment/amazon-ec2/README.md b/metron-deployment/amazon-ec2/README.md
index e3c784b..18475df 100644
--- a/metron-deployment/amazon-ec2/README.md
+++ b/metron-deployment/amazon-ec2/README.md
@@ -162,7 +162,7 @@ export ES_HOST="http://ec2-52-25-237-20.us-west-2.compute.amazonaws.com:9200"
(2) Confirm the index templates are in fact missing.
```
-curl -s -XPOST $ES_HOST/_template
+curl -s -XGET $ES_HOST/_template
```
(3) Manually load the index templates.
@@ -176,9 +176,9 @@ curl -s -XPOST $ES_HOST/_template/yaf_index -d @roles/metron_elasticsearch_templ
(4) Delete the existing indexes. Only a new index will use the templates defined in the previous step.
```
-curl -s -XDELETE "$ES_HOST/_template/yaf_index*"
-curl -s -XDELETE "$ES_HOST/_template/bro_index*"
-curl -s -XDELETE "$ES_HOST/_template/snort_index*"
+curl -s -XDELETE "$ES_HOST/yaf_index*"
+curl -s -XDELETE "$ES_HOST/bro_index*"
+curl -s -XDELETE "$ES_HOST/snort_index*"
```
(5) Open up Kibana and wait for the new indexes to be created. The dashboard should now work.
http://git-wip-us.apache.org/repos/asf/incubator-metron/blob/4978085f/metron-deployment/roles/monit/README.md
----------------------------------------------------------------------
diff --git a/metron-deployment/roles/monit/README.md b/metron-deployment/roles/monit/README.md
new file mode 100644
index 0000000..3ce8717
--- /dev/null
+++ b/metron-deployment/roles/monit/README.md
@@ -0,0 +1,62 @@
+# Monit Integration
+
+This role will leverage Monit as a process watchdog to manage sensors, topologies, and core services.
+
+* Monit can be used to start, stop, or check status of any of the sensors or topologies.
+* When monitoring is enabled (on by default) if a process dies, it will be restarted.
+* The Monit web interface is exposed at http://hostname:2812.
+* The web interface username and password is defined by the `monit_user` and `monit_password` variables. These default to `admin`/`monit`.
+* Monit CLI tools can also be used to simplify the process of managing Metron components.
+* The post-deployment report for Amazon-EC2 provides links to Monit's web interface labeled as 'Sensor Status' and 'Topology Status.'
+
+ ```
+ ok: [localhost] => {
+ "Success": [
+ "Apache Metron deployed successfully",
+ " Metron @ http://ec2-52-39-143-62.us-west-2.compute.amazonaws.com:5000",
+ " Ambari @ http://ec2-52-39-4-93.us-west-2.compute.amazonaws.com:8080",
+ " Sensor Status @ http://ec2-52-39-4-93.us-west-2.compute.amazonaws.com:2812",
+ " Topology Status @ http://ec2-52-39-130-62.us-west-2.compute.amazonaws.com:2812",
+ "For additional information, see https://metron.incubator.apache.org/'"
+ ]
+ }
+ ```
+
+## Usage
+
+
+Start all Metron components
+
+```
+monit start all
+```
+
+Stop all Metron components
+
+```
+monit stop all
+```
+
+Start an individual Metron component
+
+```
+monit start bro-parser
+```
+
+Start all components required to ingest Bro data
+
+```
+monit -g bro start
+```
+
+Start all parsers
+
+```
+monit -g parsers start
+```
+
+What is running?
+
+```
+monit summary
+```