documentation update

guilhemmarchand · Mar 31, 2017 · 218f6b5 · 218f6b5
1 parent 41dfb7d
commit 218f6b5
Show file tree

Hide file tree

Showing 3 changed files with 34 additions and 1 deletion.
diff --git a/docs/index.rst b/docs/index.rst
@@ -53,6 +53,7 @@ Deployment and configuration:
    :maxdepth: 2
 
    deployment
+   upgrade
    external
    json_indexing
 

diff --git a/docs/releasenotes.rst b/docs/releasenotes.rst
@@ -27,9 +27,11 @@ V1.3.09:
 - Fix: Removal of recursive stanza in inputs.conf #21
 - Fix: Increase the interval for nmon_cleaning #18
 - Fix: Various corrections for Powerlinux (serial number identification, binaries and architecture identification)
+- Fix: AIX rpm lib messages at nmon_helper.sh startup #22
+- Various: deprecation of the TA-nmon_selfmode (now useless since the new release does use anymore the unarchive_cmd feature)
 
 ==================
 Previous releases:
 ==================
 
-**Please refer to Nmon core release notes:** http://nmon-for-splunk.readthedocs.io/en/latest/knownissues.html
+**Please refer to:** http://nmon-for-splunk.readthedocs.io/en/latest/knownissues.html
diff --git a/docs/upgrade.rst b/docs/upgrade.rst
@@ -0,0 +1,30 @@
+#######
+Upgrade
+#######
+
+Upgrading the TA-nmon is nothing more than reproducing the initial installation steps, basically uncompressing the content of the TA-nmon tgz archive.
+
+**Please refer to the installation documentations:**
+
+* Standalone deployment: http://nmon-for-splunk.readthedocs.io/en/latest/installation_standalone.html
+
+* Distributed deployment: http://nmon-for-splunk.readthedocs.io/en/latest/installation_distributed.html
+
+* Splunk Cloud deployment: http://nmon-for-splunk.readthedocs.io/en/latest/installation_splunkcloud.html
+
+**Additional information:**
+
+The TA-nmon has an internal procedure that will cache the "/bin" directory from::
+
+    $SPLUNK_HOME/etc/apps/TA-nmon/bin
+
+To::
+
+    $SPLUNK_HOME/var/log/nmon/bin
+
+This procedure is useful because:
+
+* A deployment made the Splunk deployment server starts by first completely removing the entire TA-nmon removing, this would let running nmon processes orphan (for Linux and Solaris)
+* In Search Head Cluster, a constantly running nmon process with the application directory would generate an error during the bundle publication
+
+The cache directory will be updated every time the "app.conf" files in the application directory differs from the version in cache, and is operated by the "bin/nmon_helper.sh" script.