.. See the License for the specific language governing permissions and
.. limitations under the License.
.. ===============LICENSE_END=========================================================
-===================================================================
-Operations, Administration, and Management (OA&M) Developer's Guide
-===================================================================
+==========================================================================
+Platform Operations, Administration, and Management (OA&M) Developer Guide
+==========================================================================
-The OA&M project is for the processes, activities, tools, and standards involved with operating, administering, managing and maintaining the Acumos platform. The project uses Docker, Docker Compose, shell scripts, and third-party tools such as the Kong API and Elastic Stack.
+
+The OA&M project is for the processes, activities, tools, and standards involved with operating, administering, managing and maintaining the Acumos platform. The project uses Docker, Docker Compose, shell scripts, and third-party tools such as the Kong API and Elastic Stack.
Jira: `https://jira.acumos.org <https://jira.acumos.org>`_ project name: platform-oam
+
Gerrit: git clone https://gerrit.acumos.org/r/platform-oam
.. under the Creative Commons Attribution 4.0 International License (the "License");
.. you may not use this file except in compliance with the License.
.. You may obtain a copy of the License at
-..
+..
.. http://creativecommons.org/licenses/by/4.0
-..
+..
.. This file is distributed on an "AS IS" BASIS,
.. 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.
.. ===============LICENSE_END=========================================================
-=============
-Release Notes
-=============
+
+========================================================================
+Platform Operations, Administration, and Management (OA&M) Release Notes
+========================================================================
Version 0.1, 15 February 2018
=============================
-- ELK Documentation
+- Elastic Stack installation and documentation
.. See the License for the specific language governing permissions and
.. limitations under the License.
.. ===============LICENSE_END=========================================================
+
=====================================================================
Platform Operations, Administration, and Management (OA&M) User Guide
=====================================================================
======================================
One of the functions of (OA&M) for the Acumos platform is to collect and correlate log files from the other platform components in order to support debugging, metrics, alarms, etc. for development and operations purposes. These metrics can reveal issues and potential risks so administrators can take corrective action. To this end, the OA&M component has defined a logging standard to be used by all of those components in order to support correlation. OA&M uses the `Elasticsearch, Logstack, Kibana stack <https://www.elastic.co/elk-stack>`_ and `Filebeat <https://www.elastic.co/products/beats/filebeat>`_ to collect and centralize logs that are generated via the microservices. This guide that describes how to use the Acumos Elastic Stack (formerly known as the ELK Stack).
-Target users
+Target Users
------------
Acumos Platform super admins
All the modules are following the Acumos Logging Guidelines
-Elastic Stack architecture
+Elastic Stack Architecture
--------------------------
+
.. image:: images/elk_stack.png
-Elastic Stack component versions
+Elastic Stack Component Versions
--------------------------------
- elasticsearch 5.5.1
- logstash:5.5.1
- filebeat:6.0.1
-Elastic Stack setup
+Elastic Stack Setup
-------------------
-Elastic Stack installation is automated with Docker Compose. Installation is done on a server separate from where Acumos has been installed.
+Elastic Stack installation is automated with Docker Compose. Installation is done on a server separate from where Acumos has been installed.
Prerequisites
-------------
1. Clone the platform-oam repository
-.. code-block:: bash
-
+.. code:: bash
+
$ git clone https://gerrit.acumos.org/r/platform-oam
-
+
2. The docker-compose.yaml file as well as component directories are located in the elk-stack directory. Each component has a Dockerfile. You need to build the docker-compose file if you are using it for the first time or if you have made changed any Dockerfile or the contents of its build directory.
-.. code-block:: bash
-
- $ docker-compose build
-
-
+.. code:: bash
+
+ $ docker-compose build
+
+
3. Builds, (re)creates, starts, and attaches to containers for Elasticsearch, Logstash, Kibana
-.. code-block:: bash
-
- $ docker-compose up -d
-
-
-4. To stop the running containers without removing them
+.. code:: bash
+
+ $ docker-compose up -d
-.. code-block:: bash
- $ docker-compose stop
-
+4. To stop the running containers without removing them
+
+.. code:: bash
+
+ $ docker-compose stop
+
Filebeat setup steps:
---------------------
Filebeat 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-block:: yaml
+.. code:: yaml
filebeat:
- container_name: filebeat
- image: <filebeat-image-name>
+ container_name: filebeat
+ image: <filebeat-image-name>
volumes:
- <volume-name>:/filebeat-logs
environment:
- LOGSTASH_PORT=5000
-Adding new log:
----------------
+Adding a New Log
+----------------
Filebeat docker is a customized image that depends on filebeat.yml, a configuration layer.
For adding new log under prospectors of filebeat.yml, need to add log location path as it is in <volume-name>.
-.. code-block:: yaml
+.. code:: yaml
filebeat.prospectors:
- input_type: log
paths:
- /filebeat-logs/portal-be/*.log
-
-Elastic Stack user interface tour
----------------------------------
+
+Elastic Stack UI Tour
+---------------------
According to the `Kibana website <https://www.elastic.co/guide/en/kibana/current/introduction.html>`_, Kibana is an open source analytics and visualization platform designed to work with Elasticsearch. You use Kibana to search, view, and interact with data stored in Elasticsearch indices. You can easily perform advanced data analysis and visualize your data in a variety of charts, tables, and maps.
Kibana makes it easy to understand large volumes of data. Its simple, browser-based interface enables you to quickly create queries in real time.
Site admins have access to Elastic Stack's Kibana Dashboard. Login to the dashboard:
-For accessing Acumos elk stack login via Acumos Platform Website.
- .. image:: images/acumos_Sign_In.jpg
+ .. image:: images/acumos_Sign_In.JPG
-
-
-Go to SITE ADMIN monitoring users and click on to Login to Dashboard
+Go to SITE ADMIN -> Monitoring and click on **Login to Dashboard** in the USERS section
- .. image:: images/acumos_site_admin.jpg
+ .. image:: images/acumos_site_admin.jpg
-
Redirects to Loading Kibana visualization platform
-Acumos Kibana dashboard creation steps
-------------------------------------
-Kibana dashboard used to view all the saved visualizations.
+Acumos Kibana Dashboard Creation
+--------------------------------
+
+The Kibana dashboard is used to view all the saved Visualizations.
To create dashboard click on Create a dashboard or On plus sign show in the search bar.
+.. image:: images/kibana_dashboard_1.jpg
-.. image:: images/kibana_dashboard_1.jpg
-
-click on "visit the Visualize app."
+click on Visit the Visualize app
.. image:: images/kibana_dashboard_2.jpg
-click on "Create new a visualization" or "+"(i.e Plus sign) show in the search bar.
+click on "Create a visualization" or "+"(i.e Plus sign) show in the search bar.
.. image:: images/kibana_visualization_1.jpg
.. image:: images/kibana_visualization_2.jpg
-Choose search source as "logstash-*"
+Choose search source as ``logstash-*``
.. image:: images/kibana_visualization_3.jpg
-Click on "Split Slices"
+Click on Split Slices
.. image:: images/kibana_visualization_4.jpg
Select Aggregation as "Terms" and Field as "userAgent.keyword", Click on "Apply changes"
-Note: Elasticsearch aggregations are to extract and process your data.
+Note: Elasticsearch aggregations are to extract and process your data.
.. image:: images/kibana_visualization_5.jpg
Code Review / platform-oam.git / commitdiff