Skip to content
This repository has been archived by the owner on Aug 28, 2021. It is now read-only.

Commit

Permalink
documentation update
Browse files Browse the repository at this point in the history
  • Loading branch information
@guilhemmarchand
guilhemmarchand committed Apr 2, 2017
1 parent 3009ee2 commit db8481d
Show file tree
Hide file tree
Showing 5 changed files with 65 additions and 93 deletions.
22 changes: 9 additions & 13 deletions docs/deployment_matrix.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,16 @@ What goes where ?

* **Core App**: This is the full package you download in Splunk Base (tgz archive)

* **PA-nmon**: Available in the resources directory of the Core App (tgz archive)

* **PA-nmon_light**: Available in the resources directory of the Core App (tgz archive)

* **TA-nmon**: Available in the resources directory of the Core App (tgz archive)

**The TA-nmon is also available for download as an independant application in Splunk base:** https://splunkbase.splunk.com/app/3248/
**The TA-nmon is also available for download as an independent application in Splunk base:** https://splunkbase.splunk.com/app/3248/

*NB:**

*NB: The TA-nmon_selfmode is deprecated since version 1.3.0 of the technical addons*
* The TA-nmon_selfmode is deprecated since the unarchive_cmd feature isn't used anymore
* The PA-nmon is deprecated since the TA-nmon operates now in clustered indexers

**Standalone deployment: A single Splunk instance does all**

Expand All @@ -33,7 +34,7 @@ What goes where ?
**Distributed deployment:**

+--------------------------------------------+------------+---------------------------+---------------------+
| Splunk Instance | Core App | PA-nmon (and derived) | TA-nmon |
| Splunk Instance | Core App | PA-nmon_light | TA-nmon |
| (role) | | | |
+============================================+============+===========================+=====================+
| Search head (single instance or clustered) | X | | X (optional) |
Expand All @@ -53,13 +54,8 @@ What goes where ?

**FAQ:**

* What is the difference between the PA-nmon and the TA-nmon ?

*The PA-nmon is the light add-on dedicated for indexers, it is very closed to the TA-nmon, but it is adapted to
be able to automatically generate Nmon performance data for your distributed indexers.
The PA-nmon add-on will be included in the bundle configuration published to indexers by the master node.*
* What is the difference between the PA-nmon_light and the TA-nmon ?

* What is the difference between the PA-nmon and the PA-nmon_light ?
The PA-nmon_light does not contain any binaries, scripts or inputs. It is designed to be installed on indexers. (standalone or clustered)

*The PA-nmon_light does not contain any binaries, scripts or inputs. It is designed to be installed on indexers (standalone or clustered) that must not monitor performance of indexers, such as Splunk Cloud indexer instances.
As such, the PA-nmon_light can be used instead of the PA-nmon to ensure correct event indexing in your deployment.*
This package will define the default "nmon" index and the relevant configuration for indexing time.
Binary file modified docs/img/steps_summary_distributed.png
View file
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
112 changes: 39 additions & 73 deletions docs/installation_distributed.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,15 +15,13 @@ Installation for distributed deployments

* **Core App**: This is the full package you download in Splunk Base (tgz archive)

* **PA-nmon**: Available in the resources directory of the Core App (tgz archive)

* **PA-nmon_light**: Available in the resources directory of the Core App (tgz archive)

* **TA-nmon**: Available in the resources directory of the Core App (tgz archive)

+-----------------------------------+------------+---------------+---------------------+
| Splunk Instance | Core App | PA-nmon | TA-nmon |
| (role) | | (and derived) | |
| Splunk Instance | Core App | PA-nmon_light | TA-nmon |
| (role) | | | |
+===================================+============+===============+=====================+
| Search head (single or clustered) | X | | X (optional) |
+-----------------------------------+------------+---------------+---------------------+
Expand All @@ -38,7 +36,7 @@ Installation for distributed deployments
| Universal Forwarder | | | X |
+-----------------------------------+------------+---------------+---------------------+

*The TA-nmon and PA-nmon provide nmon performance and configuration collection for the host than runs the add-on, which is optional.*
*The TA-nmon provides nmon performance and configuration collection for the host than runs the add-on, which is optional.*

*The PA-nmon_light does not generate any collection, but defines the replicated nmon index and contains index time configuration settings.*

Expand All @@ -50,17 +48,15 @@ Installation for distributed deployments
* Standalone search heads
* Search heads in a sh cluster

*Note: Search heads in sh pooling deployment is a deprecated behavior, and has been replaced advantageously by sh clusters*

.. image:: img/steps_summary_distributed.png
:alt: steps_summary_distributed.png
:align: center

1. Deploying the PA-nmon or PA-nmon_light on indexers
-----------------------------------------------------
1. Deploying the PA-nmon_light and TA-nmon (optional) on indexers
-----------------------------------------------------------------

1.1. Deploying the PA-nmon or PA-nmon_light on clustered indexers
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1.1. Deploying on clustered indexers
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

We will assume your indexers are already operational, in the case of a new installation, remember to activate port receiving to allow the indexer to retrieve data.

Expand All @@ -74,16 +70,16 @@ If required (eg. new installation), this can be easily achieved:
Where 9997 (default) will be the receiving port for Splunk Forwarder connections


Deploying the PA-nmon on clustered indexers
"""""""""""""""""""""""""""""""""""""""""""
Deploying the PA-nmon_light on clustered indexers
"""""""""""""""""""""""""""""""""""""""""""""""""

*ALL THESE ACTION MUST BE DONE ON THE MASTER NODE*

**Remind:**

* If you don't want to collect performance and configuration data from your indexers, deploy the PA-nmon_light
* If you don't want to collect performance and configuration data from your indexers, deploy only the PA-nmon_light

* If you want to collect performance and configuration data from your indexers, deploy the PA-nmon
* If you want to collect performance and configuration data from your indexers, deploy both the PA-nmon_light and TA-nmon

**Download the Application tar.gz archive from:**

Expand All @@ -98,17 +94,17 @@ https://splunkbase.splunk.com/app/1753/

tar -xvzf nmon-performance-monitor-for-unix-and-linux-systems*.tgz

**PA-nmon:**
**TA-nmon: (optional)**

The PA-nmon is a tar.gz archive located in the "resources" of the core Application
The TA-nmon is a tar.gz archive located in the "resources" of the core Application

It must be uncompressed and installed in the Master Node in $SPLUNK_HOME/etc/master_apps/ (where $SPLUNK_HOME refers to the root directory of your Splunk installation)

::

cd /opt/splunk/etc/master/apps

tar -xvzf /tmp/nmon/resources/PA-nmon_1*.tar.gz
tar -xvzf /tmp/nmon/resources/TA-nmon_*.tar.gz

**PA-nmon_light:**

Expand Down Expand Up @@ -147,8 +143,8 @@ Settings --> Indexer Clustering
:alt: cluster1.png
:align: center

1.2. Deploying the PA-nmon on standalone indexers
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1.2. Deploying the PA-nmon_light and TA-nmon (optional) on standalone indexers
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

*ALL THESE ACTION MUST BE DONE FOR EACH STANDALONE INDEXER*

Expand All @@ -166,74 +162,44 @@ Extract the content of the archive on your indexer in a temporary directory, exa

tar -xvzf nmon-performance-monitor-for-unix-and-linux-systems*.tgz

The PA-nmon is a tar.gz archive located in the "resources" of the core Application

It must be uncompressed and installed in the indexer in $SPLUNK_HOME/etc/apps/ (where $SPLUNK_HOME refers to the root directory of Splunk installation)
**Remind:**

::
* If you don't want to collect performance and configuration data from your indexers, deploy only the PA-nmon_light

cd /opt/splunk/etc/apps
* If you want to collect performance and configuration data from your indexers, deploy both the PA-nmon_light and TA-nmon

tar -xvzf /tmp/nmon/resources/PA-nmon*.tar.gz
**TA-nmon: (optional)**

In default configuration, the PA-nmon is able to generate Nmon Performance data. (which is why the PA-nmon contains file inputs and script inputs)
The TA-nmon is a tar.gz archive located in the "resources" of the core Application

*if you don't want this, you can create a local/inputs.conf to deactivate these features:*
It must be uncompressed and installed in the Master Node in $SPLUNK_HOME/etc/master_apps/ (where $SPLUNK_HOME refers to the root directory of your Splunk installation)

::

cd /opt/splunk/etc/apps/PA-nmon

mkdir local

cp -p default/inputs.conf local/

<edit local/inputs.conf>

<replace:>
cd /opt/splunk/etc/apps

disabled = false
tar -xvzf /tmp/nmon/resources/TA-nmon_*.tar.gz

<by:>
**PA-nmon_light:**

disabled = true
The PA-nmon_light is a tar.gz archive located in the "resources" of the core Application

If you want to get Performance data to be generated automatically by the Application on your standalone indexers, you must set a custom configuration of props.conf (only applicable for standalone indexers):
It must be uncompressed and installed in the Master Node in $SPLUNK_HOME/etc/master_apps/ (where $SPLUNK_HOME refers to the root directory of your Splunk installation)

::

cd /opt/splunk/etc/apps/PA-nmon

mkdir local

cp -p default/props.conf local/

<edit local/props.conf>

<replace:>

unarchive_cmd = $SPLUNK_HOME/bin/splunk cmd $SPLUNK_HOME/etc/slave-apps/PA-nmon/bin/nmon2csv.sh

<by:>

unarchive_cmd = $SPLUNK_HOME/bin/splunk cmd $SPLUNK_HOME/etc/apps/PA-nmon/bin/nmon2csv.sh

And:

unarchive_cmd = gunzip | $SPLUNK_HOME/bin/splunk cmd $SPLUNK_HOME/etc/slave-apps/PA-nmon/bin/nmon2csv.sh

By:
cd /opt/splunk/etc/apps

unarchive_cmd = gunzip | $SPLUNK_HOME/bin/splunk cmd $SPLUNK_HOME/etc/apps/nmon/bin/nmon2csv.sh
tar -xvzf /tmp/nmon/resources/PA-nmon_light_*.tar.gz

**Restart the indexer:**

::

splunk restart

2. Deploying the Core App and TA-nmon to search heads
-----------------------------------------------------
2. Deploying the Core App and TA-nmon (optional) to search heads
----------------------------------------------------------------


2.1. Deploying the Nmon Core in a sh cluster
Expand Down Expand Up @@ -274,7 +240,7 @@ The directory has this structure:

Extract the content of the core Application (the tar archive you downloaded from Splunk base) to the "apps" directory.

**Since the release V1.7, the core application does not generate anymore nmon data, if you want to get performance and configuration data from your search heads, extract the content of the TA-nmon addon to the "apps" directory.**
**The core application does not generate nmon data, if you want to get performance and configuration data from your search heads, extract the content of the TA-nmon addon to the "apps" directory.**

::

Expand All @@ -292,8 +258,8 @@ Finally push the configuration bundle to publish the Nmon core application to al



2.2. Deploying the Nmon Core in independent search heads or search heads in sh pooling
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2.2. Deploying the Nmon Core in standalone search heads
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

**For each search head:**

Expand Down Expand Up @@ -329,14 +295,14 @@ Uncompress the content of the tar.gz archive in $SPLUNK_HOME/etc/apps/ (where $S
splunk restart


3. Deploying the TA-nmon
------------------------

3. Deploying the TA-nmon to Heavy or Universal Forwarders
---------------------------------------------------------

The next step is to deploy the TA-nmon in every machine that must be monitored.

The following tutorial asssumes you will be using the Splunk deployment server to publish the TA-nmon package to clients,
but it also totally possible to deply the TA-nmon by any deployment tool of your choice like Pupet or Ansible.
The following tutorial assumes that you will be using the Splunk deployment server to publish the TA-nmon package to clients.

However, any other automation solution (Ansible, Chef, Puppet...) can be used with no issue.

3.1 Preparing the TA-nmon on deployment servers
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Expand Down
4 changes: 2 additions & 2 deletions docs/installation_splunkcloud.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -38,8 +38,8 @@ Step 2: Deploy the PA-nmon_light to indexers
The PA-nmon_light has to be deployed on Splunk inndexers by Splunk Cloud staff.
This package creates the nmon index and embeds all configuration required at indexing time.

Step 3: Deploy the TA-nmon to your Universal Forwarders
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Step 3: Deploy the TA-nmon to Heavy or Universal Forwarders
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

The last step is to deploy the TA-nmon (or derived) to your servers running a Splunk Universal forwarder.

Expand Down
20 changes: 15 additions & 5 deletions docs/installation_standalone.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,15 +14,13 @@ Installation for standalone instance

* **Core App**: This is the full package you download in Splunk Base (tgz archive)

* **PA-nmon**: Available in the resources directory of the Core App (tgz archive)

* **PA-nmon_light**: Available in the resources directory of the Core App (tgz archive)

* **TA-nmon**: Available in the resources directory of the Core App (tgz archive)

+------------------------+------------+---------------+-------------------+
| Splunk Instance | Core App | PA-nmon | TA-nmon |
| (role description) | | (and derived) | |
| Splunk Instance | Core App | PA-nmon_light | TA-nmon |
| (role description) | | | |
+========================+============+===============+===================+
| Standalone | X | | X (optional) |
+------------------------+------------+---------------+-------------------+
Expand Down Expand Up @@ -100,6 +98,19 @@ Generating performance and configuration data

If you are running Splunk on **Linux, AIX or Solaris**, then you can generate Nmon performance data for the local machine running Splunk.

*Replace the PA-nmon_light_XXXX.tgz with current release of the PA-nmon_light:*

::

cd /opt/splunk/etc/apps/
tar -xvf /opt/splunk/etc/apps/nmon/resources/PA-nmon_light_XXXX.tgz

And restart Splunk:

::

/opt/splunk/bin/splunk restart

*Replace the TA-nmon_XXXX.tgz with current release of the TA-nmon:*

::
Expand All @@ -112,4 +123,3 @@ And restart Splunk:
::

/opt/splunk/bin/splunk restart

0 comments on commit db8481d

Please sign in to comment.