Completely revamped documentation for Centreon DSM

README.md

@@ -0,0 +1,35 @@
+# Centreon DSM
+
+Centreon Dynamic Services Management (DSM) is an extension to manage alarms in
+a similar fashion to an event logs system.
+
+
+## Installation
+
+    yum install centreon-dsm-client centreon-dsm-server
+
+
+## DSM Client Usage
+
+ - Usage after release 2.0.
+
+		/usr/share/centreon/bin/dsmclient.pl {--help|{--Host <hostname>|--host-id <host-id>} [--pool-prefix <pool-prefix>] [--id <id>] [--time <timerequest>] --status <status> [--output <output>]}
+			--help               Help
+			-H|--Host            The hostname or IP address of the host linked to trap services
+			--host-id            The ID that represents a certain host in the database
+			--pool-prefix        The pool-prefix of a slot pool linked to a host
+			-i|--id              ID (a string built to match a specific alarm)
+			-o|--output          The output message to display in Service Comment
+			-s|--status          The statuses recognized by the engine are 0 = OK; 1 = WARNING; 2 = CRITICAL; 3 = UNKNOWN
+			-t|--time            The time epoch for the trap request
+			-m|--macro           List of macros and their values that need to be updated
+
+
+ - Usage before revision 34: deprecated.
+
+		./dsmclient.pl hostname timerequest output
+			hostname            The hostname with trap services
+			timerequest         The time epoch for the trap request
+			output              The output to display in service comment
+
+In this version, the status was always CRITICAL.

bin/dsmclient.pl

@@ -219,7 +219,7 @@ =head1 OPTIONS
 
 =item B<--pool-prefix>
 
-Slots to used for the host. If not set, we used the first pool of slots.
+Slot pool prefix linked to the host. If not set, the first pool of slots will be used.
 
 =back
 
@@ -228,5 +228,3 @@ =head1 DESCRIPTION
 B<dsmclient.pl>.
 
 =cut
-
-

doc/en/administration.rst

@@ -6,8 +6,8 @@ Administration
 Advanced configuration
 **********************
 
-It is possible to overwrite default configuration of the module by creating/editing the
-**/etc/centreon/centreon_dsmd.pm** file: ::
+It is possible to overwrite the default configuration of the module by
+creating/editing the **/etc/centreon/centreon_dsmd.pm** file: ::
 
     %centreon_dsmd_config = (
         # which user will send action to Centcore
@@ -23,24 +23,25 @@ It is possible to overwrite default configuration of the module by creating/edit
         # duration in seconds to keep locks
         clean_locks_keep_stored => 3600,
     );
-    
+
     1;
 
 *************
 Purging cache
 *************
 
-All actions performed by the DSMD engine are logged in the database
-**centreon_storage**. A cron is provided to delete the data based on retention.
+All actions performed by the DSM daemon are logged in the database
+**centreon_storage**. A cron job is provided to delete the data based on
+retention.
 
-To modify the retention period, by default **180 days**, you can create/edit the 
-**/etc/centreon/centreon_dsm_purge.pm** file: ::
+To modify the retention period - by default **180 days** - you can create/edit
+the **/etc/centreon/centreon_dsm_purge.pm** file: ::
 
     %centreon_dsm_purge_config = (
         # period in days
         history_time => 180,
     );
-    
+
     1;
 
 To modify the hour of the cron job, you can edit the **/etc/cron.d/centreon-dsm**
@@ -49,6 +50,5 @@ file: ::
     #####################################
     # Centreon DSM
     #
-
-    30 22 * * * root /usr/share/centreon/www/modules/centreon-dsm//cron/centreon_dsm_purge.pl --config='/etc/centreon/conf.pm' --severity=error >> /var/log/centreon/centreon_dsm_purge.log 2>&1
 
+    30 22 * * * root /usr/share/centreon/www/modules/centreon-dsm//cron/centreon_dsm_purge.pl --config='/etc/centreon/conf.pm' --severity=error >> /var/log/centreon/centreon_dsm_purge.log 2>&1

doc/en/installation.rst

@@ -6,21 +6,22 @@ Installation
 On a central server
 ===================
 
-This part is to install **Centreon DSM** on a central server. Centreon DSM server
-and client will be installed on the main server.
+These instructions apply when installing the **Centreon DSM** extension on a
+central server. The Centreon DSM server and client packages must be installed on
+the main server.
 
-Run the command::
+Install the packages running the command::
 
-    # yum install centreon-dsm-server centreon-dsm-client
+    # yum install centreon-dsm
 
-After installing the rpm, you have to finish the module installation through the
-web frontend. Go to **dministration > Extensions > Manager** menu and search
-**dsm**:
+After installing the packages, you have to finish the installation of the module
+through the web-based GUI. Go to **Administration > Extensions > Manager** menu
+and search **dsm**:
 
 .. image:: /_static/installation/module-setup.png
    :align: center
 
-Your Centreon DSM Module is now installed.
+Your Centreon DSM module is now installed.
 
 .. image:: /_static/installation/module-setup-finished.png
    :align: center
@@ -29,12 +30,28 @@ Your Centreon DSM Module is now installed.
 On a poller
 ===========
 
-This part is to install **Centreon DSM** on a poller. Only client will be
-installed.
+These instructions apply when installing the **Centreon DSM** extension on a
+poller. Only the Centreon DSM client package must be installed on the poller.
 
-Run the command::
+Install the package running the command:
+
+::
 
     # yum install centreon-dsm-client
 
-You now have to create an access from the poller to the DBMS server on the
-**centreon_storage** database.
+You now have to configure MariaDB in order to enable the poller to connect to
+the central server databases **centreon** and **centreon_storage** using the
+user **centreon**.
+
+In order to do that, you have to connect to your MariaDB instance with the
+**root** user and issue the following commands:
+
+::
+
+  $ GRANT SELECT ON `centreon`.`*` TO 'centreon'@'POLLER_IP';
+  $ GRANT SELECT, INSERT, UPDATE ON `centreon_storage`.`*` TO 'centreon'@'POLLER_IP';
+
+Now, from your poller, try to connect to the central server with the MySQL
+client using the **centreon** user. If you have problems to configure the
+connection to MariaDB, please refer to the database documentation:
+https://mariadb.com/kb/en/grant/

doc/en/upgrade/from_1.x.rst

@@ -1,14 +1,18 @@
 .. _install_from_packages:
 
-===============
-From 1.x to 2.x
-===============
+==========================
+From 1.x to 2.x (or newer)
+==========================
 
 *****************
 From RPM packages
 *****************
 
-Merethis provides RPM for its products through CES. Open source products are freely available from our repository.
+Centreon provides RPM packages for its products through the Centreon open source
+version available free of charge in our repository.
+
+These packages have been successfully tested in version 7.x CentOS and Red Hat
+environments.
 
 ****************
 Centreon upgrade
@@ -17,26 +21,27 @@ Centreon upgrade
 Upgrade a central server
 ------------------------
 
-This part is a how to upgrade a **Centreon DSM** for a central server. 
+These instructions apply when upgrading the Centreon DSM extension on a
+central server. The Centreon DSM server and client packages must be installed on
+the main server.
 
-Centreon DSM server and client will be installed on the main server. 
+The version 1.x of Centreon DSM doesn't contain a server and a client: the
+client embeds the intelligence and the server is just a cron task.
 
-The version 1.x of Centreon DSM doesn't contain a server and a client: the client embed the intelligence and the server is just a cron task. 
+This organization was a problem due to a number of reasons. That's why this
+module completely changed with this new major version.
 
-This organization was a problem due of load problems. That's why we completely change this module. That's why this version is a major version.
+To upgrade, run the following command:
 
-To upgrade run the following command::
+::
 
   $ yum upgrade centreon-dsm-server centreon-dsm-client
 
 
-After installing the rpm, you have to finish the module installation via the web frontend. Go on:
-
-::
-
- Administration > Modules 
+After installing the RPM packages, you have to finish the module installation
+via the web-based GUI. Go to **Administration > Modules**.
 
-Install the Centreon-DSM module.
+Install the Centreon DSM module.
 
 .. image:: /_static/installation/module-setup.png
    :align: center
@@ -46,52 +51,61 @@ Your Centreon DSM Module is now installed.
 .. image:: /_static/installation/module-setup-finished.png
    :align: center
 
-In order to migrate the trap configuration, you have to change all specific commands configured on your specific traps.
-On each specific commands rename the following path: 
+In order to migrate the trap configuration, you have to change all the commands
+configured in each trap.
+For each command, replace the following path:
 
 ::
 
-  /usr/share/centreon/bin/snmpTrapDyn.pl 
+  /usr/share/centreon/bin/snmpTrapDyn.pl
 
-by 
+by
 
 ::
 
   /usr/share/centreon/bin/dsmclient.pl
 
-All parameters are the same.
+The other parameters remain the same.
 
 
-Install a poller
+Upgrade a poller
 ----------------
 
-This part is a howto install Centreon DSM on a poller. Only client will be installed on a poller.
+These instructions apply when upgrading the **Centreon DSM** extension on a
+poller. Only the Centreon DSM client package must be installed on the poller.
 
-To install centreon DSM, run the following commands:
+To upgrade Centreon DSM, run the following commands:
 
 ::
 
   $ yum erase centreon-dsm
   $ yum install centreon-dsm-client
 
-You have now to configure MySQL access in order that your poller is enable to connect to central server with the centreon user to the centreon and centreon_storage database.
+You now have to configure MariaDB in order to enable the poller to connect to
+the central server databases **centreon** and **centreon_storage** using the
+user **centreon**.
 
-In order to do that, connect you on MySQL with root user and launch the following request:
+In order to do that, you have to connect to your MariaDB instance with the
+**root** user and issue the following commands:
 
 ::
 
   $ GRANT SELECT ON `centreon`.`*` TO 'centreon'@'POLLER_IP';
   $ GRANT SELECT, INSERT, UPDATE ON `centreon_storage`.`*` TO 'centreon'@'POLLER_IP';
 
-Now, from your poller, try to connect with MySQL client. If you have problem to configure MySQL connection,
-please refer to the database documentation: http://dev.mysql.com/doc/refman/5.5/en/grant.html
+Now, from your poller, try to connect to the central server with the MySQL
+client using the **centreon** user. If you have problems to configure the
+connection to MariaDB, please refer to the database documentation:
+https://mariadb.com/kb/en/grant/
 
 
 Base configuration of pollers
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-The communication between a poller and a central server is by MySQL. DSM Client need to have access to MySQL server in order to store new alarms.
+The communication between a poller and the central server uses the MySQL
+client/server protocol. The DSM client needs to have access to the central MySQL
+server in order to store new alarms.
 
 .. note::
-   The new trap system **centreontrapd** doesn't need an access to the database but Centreon-DSM does.
-
+   The new trap system **centreontrapd** doesn't need access to the database but
+   Centreon DSM does.