Updated version/date in release notes
[policy/engine.git] / docs / platform / feature_locking.rst
1
2 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
3 .. http://creativecommons.org/licenses/by/4.0
4
5 ****************************
6 Feature: Distributed Locking
7 ****************************
8
9 Summary
10 ^^^^^^^
11
12 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.
13
14 Usage
15 ^^^^^
16
17     .. code-block:: bash
18        :caption: Enable Feature Distributed Locking 
19
20         policy stop
21
22         features enable distributed-locking
23
24     The configuration is located at:
25
26     * $POLICY_HOME/config/feature-distributed-locking.properties
27
28
29     .. code-block:: bash
30        :caption: Start the PDP-D using pooling
31
32         policy start
33
34
35     .. code-block:: bash
36        :caption: Disable the Distributed Locking feature
37
38         policy stop
39         features disable distributed-locking
40         policy start
41
42
43 End of Document
44
45 .. SSNote: Wiki page ref. https://wiki.onap.org/display/DW/Feature+Distributed+Locking
46
47