aboutsummaryrefslogtreecommitdiffstats
path: root/docs/platform/feature_locking.rst
diff options
context:
space:
mode:
authorJorge Hernandez <jh1730@att.com>2018-05-15 19:05:29 +0000
committerGerrit Code Review <gerrit@onap.org>2018-05-15 19:05:29 +0000
commitd274c95ba876f5bff40118f870c1f93afada57a7 (patch)
tree962c84b74acdf2a66a9a3c44b873bebc9a3a6852 /docs/platform/feature_locking.rst
parentccea7de6a0739463073ba8b1a5387f3ba24953bd (diff)
parent97ff534fdf663ba97a4ba02fec6ef4d2c9368081 (diff)
Merge "SRM, Locking, Pooling documentation"
Diffstat (limited to 'docs/platform/feature_locking.rst')
-rw-r--r--docs/platform/feature_locking.rst47
1 files changed, 47 insertions, 0 deletions
diff --git a/docs/platform/feature_locking.rst b/docs/platform/feature_locking.rst
new file mode 100644
index 000000000..1236c93f2
--- /dev/null
+++ b/docs/platform/feature_locking.rst
@@ -0,0 +1,47 @@
+
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+****************************
+Feature: Distributed Locking
+****************************
+
+Summary
+^^^^^^^
+
+The Distributed Locking Feature provides locking of resources across a pool of PDP-D hosts. The list of locks is maintained in a database, where each record includes a resource identifier, an owner identifier, and an expiration time. Typically, a drools application will unlock the resource when it's operation completes. However, if it fails to do so, then the resource will be automatically released when the lock expires, thus preventing a resource from becoming permanently locked.
+
+Usage
+^^^^^
+
+ .. code-block:: bash
+ :caption: Enable Feature Distributed Locking
+
+ policy stop
+
+ features enable distributed-locking
+
+ The configuration is located at:
+
+ * $POLICY_HOME/config/feature-distributed-locking.properties
+
+
+ .. code-block:: bash
+ :caption: Start the PDP-D using pooling
+
+ policy start
+
+
+ .. code-block:: bash
+ :caption: Disable the Distributed Locking feature
+
+ policy stop
+ features disable distributed-locking
+ policy start
+
+
+End of Document
+
+.. SSNote: Wiki page ref. https://wiki.onap.org/display/DW/Feature+Distributed+Locking
+
+