drools documentation redo

[policy/parent.git] / docs / drools / feature_activestdbymgmt.rst

diff --git a/docs/drools/feature_activestdbymgmt.rst b/docs/drools/feature_activestdbymgmt.rst
index a7c3fb9..1ed655c 100644 (file)
--- a/docs/drools/feature_activestdbymgmt.rst
+++ b/docs/drools/feature_activestdbymgmt.rst
@@ -2,25 +2,22 @@
 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
 .. http://creativecommons.org/licenses/by/4.0
 
+.. _feature-asm-label:
+
 **********************************
-Feature: Active/Standby Management 
+Feature: Active/Standby Management
 **********************************
 
 .. contents::
     :depth: 3
 
-Summary
-^^^^^^^
 When the Feature Session Persistence is enabled, there can only be one active/providing service Drools PDP due to the behavior of Drools persistence. The Active/Standby Management Feature controls the selection of the Drools PDP that is providing service. It utilizes its own database and the State Management Feature database in the election algorithm.  All Drools PDP nodes periodically run the election algorithm and, since they all use the same data, all nodes come to the same conclusion with the "elected" node assuming an active/providingservice state.  Thus, the algorithm is distributed and has no single point of failure - assuming the database is configured for high availability.
 
 When the algorithm selects a Drools PDP to be active/providing service the controllers and topic endpoints are unlocked and allowed to process transactions. When a Drools PDP transitions to a hotstandby or coldstandby state, the controllers and topic endpoints are locked, preventing the Drools PDP from handling transactions.
 
 
-Usage
-^^^^^
-
 Enabling and Disabling Feature State Management
------------------------------------------------
+===============================================
 
 The Active/Standby Management Feature is enabled from the command line when logged in as policy after configuring the feature properties file (see Description Details section).  From the command line:
 
@@ -49,7 +46,7 @@ The Drools PDP must be stopped prior to enabling/disabling features and then res
 
 
 Description Details
-^^^^^^^^^^^^^^^^^^^
+~~~~~~~~~~~~~~~~~~~
 
 Election Algorithm
 ------------------
@@ -70,7 +67,7 @@ The Standby State Change Handler (*PMStandbyStateChangeHandler* class) extends t
 Database
 --------
 
-The Active/Standby Feature creates a database named activestandbymanagement with a single table, **droolspdpentity**.  The election handler uses that table to determine which DroolsPDP was/is designated as the active DroolsPDP and which DroolsPDP election handlers are healthy enough to periodically update their status. 
+The Active/Standby Feature creates a database named activestandbymanagement with a single table, **droolspdpentity**.  The election handler uses that table to determine which DroolsPDP was/is designated as the active DroolsPDP and which DroolsPDP election handlers are healthy enough to periodically update their status.
 
 The **droolspdpentity** table has the following columns:
     - **pdpId** - The unique indentifier for the DroolsPDP.  It is the same as the resourceName
@@ -86,19 +83,19 @@ Properties
 The properties are found in the feature-active-standby-management.properties file. In general, the properties are adequately described in the properties file. Parameters which must be replaced prior to usage are indicated thus: ${{parameter to be replaced}}
 
     .. code-block:: bash
-       :caption: feature-active-standby-mangement.properties 
+       :caption: feature-active-standby-mangement.properties
 
         # DB properties
         javax.persistence.jdbc.driver=org.mariadb.jdbc.Driver
         javax.persistence.jdbc.url=jdbc:mariadb://${{SQL_HOST}}:3306/activestandbymanagement
         javax.persistence.jdbc.user=${{SQL_USER}}
         javax.persistence.jdbc.password=${{SQL_PASSWORD}}
-        
+
         # Must be unique across the system
         resource.name=pdp1
-        # Name of the site in which this node is hosted 
+        # Name of the site in which this node is hosted
         site_name=site1
-        
+
         # Needed by DroolsPdpsElectionHandler
         pdp.checkInterval=1500 # The interval in ms between updates of the updatedDate
         pdp.updateInterval=1000 # The interval in ms between executions of the election handler