Documentation update

guilhemmarchand · Mar 26, 2017 · e29104f · e29104f
1 parent 94a75d5
commit e29104f
Show file tree

Hide file tree

Showing 6 changed files with 232 additions and 0 deletions.
diff --git a/docs/about.rst b/docs/about.rst
@@ -7,3 +7,49 @@ About the TA-nmon, technical addon for Nmon Performance app for Splunk
 * First release was published on starting 2014
 
 * Purposes:
+
+The TA-nmon for the Nmon Performance application for Splunk implements the excellent and powerful nmon binary known as Nigel's performance monitor.
+Originally developed for IBM AIX performance monitoring and analysis, it is now an Open source project that made it available to many other systems.
+It is fully available for any Linux flavor, and thanks to the excellent work of Guy Deffaux, it also available for Solaris 10/11 systems using the sarmon project.
+
+The Nmon Performance monitor application for Splunk will generate performance and inventory data for your servers, and provides a rich number of monitors and tools to manage your AIX / Linux / Solaris systems.
+
+.. image:: img/Octamis_Logo_v3_no_bg.png
+   :alt: Octamis_Logo_v3_no_bg.png
+   :align: right
+   :target: http://www.octamis.com
+
+**Nmon Performance is now associated with Octamis to provide professional solutions for your business, and professional support for the Nmon Performance solution.**
+
+*For more information:*
+
+---------------
+Splunk versions
+---------------
+
+**The TA-nmon is compatible with any version of Splunk Enterprise 6.x and Splunk Universal Forwarder 6.x.**
+
+---------------------
+Index time operations
+---------------------
+
+The application operates index time operation, the PA-nmon add-on must be installed in indexers in order for the application to operate normally.
+
+If there are any Heavy forwarders acting as intermediate forwarders between indexers and Universal Forwarders, the TA-nmon add-on must deployed on the intermediate forwarders to achieve successfully index time extractions.
+
+------------------------------
+About Nmon Performance Monitor
+------------------------------
+
+Nmon Performance Monitor for Splunk is provided in Open Source, you are totally free to use it for personal or professional use without any limitation,
+and you are free to modify sources or participate in the development if you wish.
+
+**Feedback and rating the application will be greatly appreciated.**
+
+* Join the Google group: https://groups.google.com/d/forum/nmon-splunk-app
+
+* App's Github page: https://github.com/guilhemmarchand/nmon-for-splunk
+
+* Videos: https://www.youtube.com/channel/UCGWHd40x0A7wjk8qskyHQcQ
+
+* Gallery: https://flic.kr/s/aHskFZcQBn
diff --git a/docs/index.rst b/docs/index.rst
@@ -29,3 +29,7 @@ Overview:
 
    about
    releasenotes
+   support
+   openissue
+   os_compatibility
+
diff --git a/docs/openissue.rst b/docs/openissue.rst
@@ -0,0 +1,11 @@
+###############################
+Issues and enhancement requests
+###############################
+
+For any bug reporting, or enhancement request about the Nmon Performance application,you can:
+
+* Open a question on Splunk Answers related to the app: https://answers.splunk.com/app/questions/3248.html
+
+* Open an issue on the Git project home page: https://github.com/guilhemmarchand/TA-nmon/issues
+
+* Get in touch by mail: guilhem.marchand@gmail.com
diff --git a/docs/os_compatibility.rst b/docs/os_compatibility.rst
@@ -0,0 +1,83 @@
+###############################
+Operating Systems compatibility
+###############################
+
+**The TA-nmon is compatible with any version of:**
+
+* IBM AIX
+* Linux x86 (32 / 64 bits)
+* Linux PowerPC (32 / 64 bits in LE and BE)
+* Linux on z Systems (s390 / s390x)
+* Linux ARM
+* Solaris 10, Solaris 11 on Sparc and x86
+
+**Here is a non exhaustive list of systems and version that the TA-nmon is been extensively qualified:**
+
+**IBM AIX:**
+
+* IBM AIX 6.1 (IBM POWER 8)
+* IBM AIX 7.1 (IBM POWER 8)
+* IBM AIX 7.2 (IBM POWER 8)
+
+**Linux on IBM PowerPC:**
+
+* SUSE Linux 12.2 LE (IBM POWER 8)
+* RedHat Linux 7.3 LE (IBM POWER 8)
+* SUSE Linux 11.4 BE (IBM POWER 8)
+* Ubuntu 16.04 LTS (IBM POWER 8)
+* Red Hat Linux 6.9 BE (IBM POWER 8)
+
+**Linux x86, 32 bits and 64 bits:**
+
+*Ubuntu:*
+
+* ubuntu-1610-64, ubuntu-1610-32
+* ubuntu-1604-64, ubuntu-1604-32
+* ubuntu-1404-64, ubuntu-1404-32
+* ubuntu-1204-64, ubuntu-1204-32
+
+*Oracle Linux (OL):*
+
+* oraclelinux-73-64
+* oraclelinux-72-64
+* oraclelinux-68-64
+* oraclelinux-67-64
+* oraclelinux-67-32
+
+*CentOS:*
+
+* centos-73-64
+* centos-72-64
+* centos-68-64, centos-68-32
+* centos-67-64, centos-67-32
+
+*Debian:*
+
+* debian-8-64, debian-8-32
+* debian-7-64, debian-7-32
+
+*SUSE Linux Enterprise Server: (SLES)*
+
+* sles11sp3
+* sles12
+* sles12sp1
+
+*OpenSuse:*
+
+* opensuse-13
+
+*Redhat Enterprise (RHEL):*
+
+* rhel5
+* rhel65
+* rhel73
+
+*Fedora:*
+
+* fedora24
+* fedora25
+
+**SOLARIS:**
+
+* solaris-11.3
+* solaris-10
diff --git a/docs/releasenotes.rst b/docs/releasenotes.rst
@@ -5,3 +5,25 @@ Release notes
 ^^^^^^^^^^^^
 Requirements
 ^^^^^^^^^^^^
+
+* Splunk 6.x / Universal Forwarder v6.x and later Only
+
+* Universal Forwarders clients system lacking a Python 2.7.x interpreter requires Perl WITH Time::HiRes module available
+
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+What has been fixed by release
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+========
+V1.3.04:
+========
+
+**This is a major release of the TA-nmon:**
+
+- Major release of technical add-ons v1.3.0: fifo implementation (for AIX and Linux) drastically reduce the CPU and other resources footprint on client servers
+- Extend Nmon data with the nmon_external scripts, just add you own monitor (Shell, Perl, Python, REST... whatever) and extend the content of nmon data to match your needs
+- Customize in a persistent fashion the list of performance monitors to be parsed (using the nmonparser_config.json)
+- Choose between legacy csv and json data generation: you can now choose to generate performance data in json format and prioritize storage over performance and licensing volume
+- Removal of recursive stanza in inputs.conf #21
+- Increase the interval for nmon_cleaning #18
+- Correction of ID identification for PowerLinux)
+- Correction of PowerLinux systems identification
diff --git a/docs/support.rst b/docs/support.rst
@@ -0,0 +1,66 @@
+=======
+Support
+=======
+
+.. _octamis_support:
+
+-----------------------------------------
+Octamis professional support for business
+-----------------------------------------
+
+.. image:: img/Octamis_Logo_v3_no_bg.png
+   :alt: Octamis_Logo_v3_no_bg.png
+   :align: right
+   :target: http://www.octamis.com
+
+**Nmon Performance is now available with professional support contract by Octamis limited.**
+
+*Contact us at:* sales@octamis.com
+
+-----------------
+Community support
+-----------------
+
+**Nmon Performance Monitor for Splunk is provided in Open Source, you are totally free to use it for personal or professional use without any limitation, and you are free to modify sources or participate in the development if you wish.**
+
+This application and all of its components are provided under the Apache 2.0 licence, please remember that it comes with no warranty even if i intend to do my best in helping any people interested in using the App.
+
+**DISCLAIMER:**
+
+Unlike professional services, community support comes in "best effort" with absolutely no warranties.
+
+Companies using this great piece are kindly invited to subscribe for a professional support contract to help us continuing developing the Nmon Performance solution!
+
+++++++
+Github
+++++++
+
+**The Nmon Performance application is hosted on Github at the following location:**
+
+https://github.com/guilhemmarchand/TA-nmon
+
+Use Github to open an issue for errors and bugs to be reported, or to ask for enhancements requests.
+
+You can even provide your own improvements by submitting a pull request.
+
+++++++++++++++
+Splunk Answers
+++++++++++++++
+
+**Splunk has a strong community of active users and Splunk Answers is an important source of information.**
+
+Access previous messages of users or open your own discussion:
+
+https://splunkbase.splunk.com/app/3248
+
+http://answers.splunk.com/answers/app/1753
+
+++++++++++++++++++++
+Google Group Support
+++++++++++++++++++++
+
+**An App dedicated Google Group has been created:**
+
+https://groups.google.com/d/forum/nmon-splunk-app
+
+This is also a great source of support from people using the Application, and you can also (if you subscribe to mailing news) receive important notifications about the App evolution, such as main release announcements.