#################
Deployment Matrix
#################

What goes where ?
-----------------

Application stack components
++++++++++++++++++++++++++++

+--------------------------------------------+--------------------------------------------------------------+--------------------------------+
| Component name                             |                     Purpose                                  |   Installation                 |
|                                            |                                                              |                                |
+============================================+==============================================================+================================+
| metricator-for-nmon                        | Front-user core application                                  | Search Heads                   |
+--------------------------------------------+--------------------------------------------------------------+--------------------------------+
| SA-metricator-for-nmon                     | Support Add-on for index-time configurations                 | Indexers                       |
+--------------------------------------------+--------------------------------------------------------------+--------------------------------+
| TA-metricator-for-nmon                     | Technical Add-on for metrics and inventory generation        | Each monitored server          |
+--------------------------------------------+--------------------------------------------------------------+--------------------------------+
| TA-metricator-hec-for-nmon                 | Technical Add-on for metrics and inventory generation        | Each monitored server          |
+--------------------------------------------+--------------------------------------------------------------+--------------------------------+
| DA-ITSI-METRICATOR-NMON                    | ITSI module for Nmon Metricator                              | ITSI search head(s)            |
+--------------------------------------------+--------------------------------------------------------------+--------------------------------+

**ONLY** one technical addon must be deployed on the same host, **BUT** you can mix any both types of addons in your deployment.

Splunk Standalone deployment
++++++++++++++++++++++++++++

**A standalone Splunk installation means that all the Splunk roles are performed by the same instance, most likely for testing and development purposes.**

+--------------------------------------------+---------------------+------------------------+-------------------------+
| Splunk roles                               | metricator-for-nmon | SA-metricator-for-nmon |  TA-metricator-*        |
+============================================+=====================+========================+=========================+
| Standalone                                 |     X               |    X (optional)        |    X (optional)         |
+--------------------------------------------+---------------------+------------------------+-------------------------+

*The Technical Add-ons provide performance and configuration collection for the host than runs the add-on, which is optional*

**If running ITSI in a standalone server, the ITSI module must be deployed as well.**

Distributed deployment
++++++++++++++++++++++

**A Splunk distributed deployment is a Splunk infrastructure where specific Splunk roles are dedicated to specific instances.**

*For more information:*
http://docs.splunk.com/Documentation/Splunk/latest/Deploy/Indexercluster

The Metricator is fully compatible with any kind of Splunk distributed deployment.

+----------------------+---------------------+----------------------------+-----------------------------+
| Splunk roles         | metricator-for-nmon | SA-metricator-for-nmon     |  TA-metricator-*            |
+======================+=====================+============================+=============================+
| Search head          |   X                 |                            |    X (optional)             |
+----------------------+---------------------+----------------------------+-----------------------------+
| Indexer              |                     |  X                         |    X (optional)             |
+----------------------+---------------------+----------------------------+-----------------------------+
| Master node          |                     |                            |    X (optional)             |
+----------------------+---------------------+----------------------------+-----------------------------+
| Deployment server    |                     |                            |    X (optional)             |
+----------------------+---------------------+----------------------------+-----------------------------+
| Heavy Forwarder      |                     | X (if TA is not installed) |    X                        |
+----------------------+---------------------+----------------------------+-----------------------------+
| Universal Forwarder  |                     |                            |    X                        |
+----------------------+---------------------+----------------------------+-----------------------------+

*The Technical Add-on provides performance and configuration collection for the host than runs the add-on, which is optional*

**If running ITSI, the ITSI module must be deployed on all ITSI search heads:**

+----------------------+-------------------------+
| Splunk roles         | DA-ITSI-METRICATOR-NMON |
+======================+=========================+
| ITSI Search head(s)  |   X                     |
+----------------------+-------------------------+

**Additional notes about ITSI:**

* On the ITSI search head(s), only the ITSI module is mandatory required
* If ITSI is running in a Search Head Cluster (SHC), the module must be deployed by the SHC deployer along with other ITSI components
* The Splunk Web Metricator application can be as well deployed on the ITSI search heads without affecting the module, but this is not required