Add license to docs files 79/979/1
authorAimee Ukasick <aimeeu.opensource@gmail.com>
Tue, 20 Feb 2018 16:56:09 +0000 (10:56 -0600)
committerAimee Ukasick <aimeeu.opensource@gmail.com>
Tue, 20 Feb 2018 16:57:57 +0000 (10:57 -0600)
Add license to RST and MD files
Add missing images referenced by developers guide

Issue: ACUMOS-216

Change-Id: I9077a93e496067be35bf030b5de4419c827b752a
Signed-off-by: Aimee Ukasick <aimeeu.opensource@gmail.com>
README.md
docs/Developer_Guide.rst
docs/User_Guide.rst
docs/images/acumosSiteAdminUntitled.png [new file with mode: 0644]
docs/images/elk_stack.png [new file with mode: 0644]
docs/images/loadingKibanaCapture.PNG [new file with mode: 0644]
docs/index.rst
docs/release-notes.rst

index a787c76..f134c92 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,6 +1,23 @@
-# Acumos Platform OAM
-
-This repository holds the .. 
+<!---
+.. ===============LICENSE_START=======================================================
+.. Acumos
+.. ===================================================================================
+.. Copyright (C) 2017-2018 AT&T Intellectual Property & Tech Mahindra. All rights reserved.
+.. ===================================================================================
+.. This Acumos documentation file is distributed by AT&T and Tech Mahindra
+.. 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=========================================================
+-->
+# Acumos Platform Operations, Administration, and Management (OA&M)
 
 Please see the documentation in the "docs" folder.
 
index 785a145..8170d6e 100644 (file)
@@ -1,40 +1,57 @@
-=================\r
-Developer's Guide\r
-=================\r
-\r
-Acumos ELK stack for log analytics\r
-===================================\r
-This guide that describes how to use the Acumos ELK Stack.\r
-\r
-1. Introduction\r
----------------\r
-One of the functions of Operations, Administration, and Management (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. 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. \r
-\r
-       1.1 What is Acumos ELK Stack?\r
-               OAM are the processes, activities, tools, and standards involved with operating, administering, managing and maintaining any system. Collecting Logs of all the micro-services involved can reveal about the system that can mitigate potential risks. There are many ways we can collect logs that are generated via the micro-services. One of them is ELK stack. \r
-               ELK stands for, E- Elasticsearch L- Logstash K-Kibana           \r
-        Note: Filebeats( a lightweight log shipping tools is also used to ship the logs to the servers)\r
-\r
-       1.2 Target Users\r
-               This guide is targeted towards the open source user community that who have access of super site admin.\r
-  \r
-       1.3 Assumptions\r
-               All the module should follow Acumos Log Standards.\r
-\r
-       1.4 ELK-Stack - Backend Architecture\r
-               .. image:: _static/elk_stack.png\r
-\r
-\r
-2. ELK-Stack User Interface A Tour\r
-----------------------------------\r
-Site admin having access to ELK stack Login to dashboard:\r
-\r
-.. image:: _static/acumosSiteAdminUntitled.png\r
-\r
-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.\r
-Kibana makes it easy to understand large volumes of data. Its simple, browser-based interface enables you to quickly create queries in real time.\r
-\r
-For more details visit `Kibana User Guide <https://www.elastic.co/guide/en/kibana/current/index.html/>`_.\r
-\r
-\r
-.. image:: _static/loadingKibanaCapture.PNG\r
+.. ===============LICENSE_START=======================================================
+.. Acumos
+.. ===================================================================================
+.. Copyright (C) 2017-2018 AT&T Intellectual Property & Tech Mahindra. All rights reserved.
+.. ===================================================================================
+.. This Acumos documentation file is distributed by AT&T and Tech Mahindra
+.. 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=========================================================
+=================
+Developer's Guide
+=================
+
+Acumos ELK stack for log analytics
+===================================
+This guide that describes how to use the Acumos ELK Stack.
+
+1. Introduction
+---------------
+One of the functions of Operations, Administration, and Management (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. 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. 
+
+       1.1 What is Acumos ELK Stack?
+               OAM are the processes, activities, tools, and standards involved with operating, administering, managing and maintaining any system. Collecting Logs of all the micro-services involved can reveal about the system that can mitigate potential risks. There are many ways we can collect logs that are generated via the micro-services. One of them is ELK stack. 
+               ELK stands for, E- Elasticsearch L- Logstash K-Kibana           
+        Note: Filebeats( a lightweight log shipping tools is also used to ship the logs to the servers)
+
+       1.2 Target Users
+               This guide is targeted towards the open source user community that who have access of super site admin.
+  
+       1.3 Assumptions
+               All the module should follow Acumos Log Standards.
+
+       1.4 ELK-Stack - Backend Architecture
+               .. image:: images/elk_stack.png
+
+
+2. ELK-Stack User Interface A Tour
+----------------------------------
+Site admin having access to ELK stack Login to dashboard:
+
+.. image:: images/acumosSiteAdminUntitled.png
+
+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.
+
+For more details visit `Kibana User Guide <https://www.elastic.co/guide/en/kibana/current/index.html/>`_.
+
+
+.. image:: images/loadingKibanaCapture.PNG
index e36cd77..744e5f5 100644 (file)
@@ -1,6 +1,23 @@
-=======================\r
-Platform OAM User Guide\r
-=======================\r
-\r
-The Platform OA&M component is not accessed directly by end users.\r
-Please see the `Acumos Portal MarketPlace Users Guide <http://docs.acumos.org/>`_.  \r
+.. ===============LICENSE_START=======================================================
+.. Acumos
+.. ===================================================================================
+.. Copyright (C) 2017-2018 AT&T Intellectual Property & Tech Mahindra. All rights reserved.
+.. ===================================================================================
+.. This Acumos documentation file is distributed by AT&T and Tech Mahindra
+.. 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=========================================================
+=======================
+Platform OAM User Guide
+=======================
+
+The Platform OA&M component is not accessed directly by end users.
+Please see the `Acumos Portal MarketPlace Users Guide <http://docs.acumos.org/>`_.  
diff --git a/docs/images/acumosSiteAdminUntitled.png b/docs/images/acumosSiteAdminUntitled.png
new file mode 100644 (file)
index 0000000..8a4b1e8
Binary files /dev/null and b/docs/images/acumosSiteAdminUntitled.png differ
diff --git a/docs/images/elk_stack.png b/docs/images/elk_stack.png
new file mode 100644 (file)
index 0000000..312e29d
Binary files /dev/null and b/docs/images/elk_stack.png differ
diff --git a/docs/images/loadingKibanaCapture.PNG b/docs/images/loadingKibanaCapture.PNG
new file mode 100644 (file)
index 0000000..64c8780
Binary files /dev/null and b/docs/images/loadingKibanaCapture.PNG differ
index a408bf4..a91a87b 100644 (file)
@@ -1,12 +1,29 @@
-===============================================================================\r
-Acumos Platform Operations, Administration, and Management (OA&M) Documentation\r
-===============================================================================\r
-\r
-.. toctree::\r
-       :maxdepth: 2\r
-\r
-       release-notes\r
-       Developer_Guide\r
-       User_Guide\r
-\r
-* :ref:`search`\r
+.. ===============LICENSE_START=======================================================
+.. Acumos
+.. ===================================================================================
+.. Copyright (C) 2017-2018 AT&T Intellectual Property & Tech Mahindra. All rights reserved.
+.. ===================================================================================
+.. This Acumos documentation file is distributed by AT&T and Tech Mahindra
+.. 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=========================================================
+===============================================================================
+Acumos Platform Operations, Administration, and Management (OA&M) Documentation
+===============================================================================
+
+.. toctree::
+       :maxdepth: 2
+
+       release-notes
+       Developer_Guide
+       User_Guide
+
+* :ref:`search`
index 4a8e906..f25ae55 100644 (file)
@@ -1,8 +1,25 @@
-=============\r
-Release Notes\r
-=============\r
-\r
-Version 0.1, 15 February 2018\r
-=============================\r
-\r
--  ELK Documentation\r
+.. ===============LICENSE_START=======================================================
+.. Acumos
+.. ===================================================================================
+.. Copyright (C) 2017-2018 AT&T Intellectual Property & Tech Mahindra. All rights reserved.
+.. ===================================================================================
+.. This Acumos documentation file is distributed by AT&T and Tech Mahindra
+.. 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
+=============
+
+Version 0.1, 15 February 2018
+=============================
+
+-  ELK Documentation