Updated user-guide and release-notes 78/1778/3
authorAMIT M <am00474504@techmahindra.com>
Mon, 7 May 2018 10:28:42 +0000 (15:58 +0530)
committerAimee Ukasick <aimeeu.opensource@gmail.com>
Mon, 7 May 2018 16:39:03 +0000 (16:39 +0000)
Updated the documentation for Metricbeat setup

Change-Id: If9bc3b452627aac51d434677d288c46b72f5dce6
Issue-ID: ACUMOS-516
Signed-off-by: AMIT M <am00474504@techmahindra.com>
docs/release-notes.rst
docs/user-guide.rst

index df2602a..222793f 100644 (file)
 Platform Operations, Administration, and Management (OA&M) Release Notes
 ========================================================================
 
+Version 1.0.0, 7 May 2018
+=========================
+
+- Increase the ES,LS memory size and made it configurable (ACUMOS-669)
+- Added docker volume to persist acumos elasticsearch data (ACUMOS-669)
+- Added Metricbeat setup, it collects metrics of CPU, Memory, docker container information of acumos platform (ACUMOS-669)
+- Updated Elastic Stack installation steps
+
 Version 0.1, 15 February 2018
 =============================
 
index 206a8a0..e53e240 100644 (file)
@@ -48,6 +48,7 @@ Elastic Stack Component Versions
 - kibana:5.5.1
 - logstash:5.5.1
 - filebeat:6.0.1
+- metricbeat:6.2.4
 
 Elastic Stack Setup
 -------------------
@@ -112,6 +113,33 @@ Add the configuration below to the docker-compose where the Acumos is installed.
                 - LOGSTASH_PORT=5000
 
 
+Metricbeat setup steps:
+-----------------------
+Metricbeat should be installed as an agent on the servers on which Acumos is running.
+Add the configuration below to the docker-compose where the Acumos is installed. 
+
+.. code:: yaml
+
+   metricbeat:
+       image: <metricbeat-image-name>
+       network_mode: host
+       volumes:
+       #Mount the docker, filesystem to enable Metricbeat to monitor the host rather than the Metricbeat container.
+         - /proc:/hostfs/proc:ro
+         - /sys/fs/cgroup:/hostfs/sys/fs/cgroup:ro
+         - /:/hostfs:ro
+         - /var/run:/var/run:rw
+         - /var/run/docker.sock:/var/run/docker.sock
+       command: metricbeat -e -strict.perms=false -system.hostfs=/hostfs
+       environment:
+         - SHIPPER_NAME=DOCKY
+         - ELASTICSEARCH_HOST=<elk-stack-host-hostname>
+         - ELASTICSEARCH_PORT=9200
+         - PROCS=.*
+         - PERIOD=10s
+         - SHIPPER_NAME=super-app
 Adding a New Log
 ----------------
 Filebeat docker is a customized image that depends on filebeat.yml, a configuration layer. 
@@ -207,7 +235,7 @@ Click on "Dashboard", On the below screen created dashboard can be viewed namely
 .. image:: images/kibana_dashboard_8.jpg
 
 Acumos Kibana Dashboard Save
---------------------------------
+----------------------------
 
 Click on "Management", On the below screen click on save object.