Merge "user guide demo for monitoring gui"
[policy/parent.git] / docs / drools / feature_clusecases.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: Control Loop Use Cases
7 *******************************
8
9 .. contents::
10     :depth: 3
11
12 Summary
13 ^^^^^^^
14
15 The "controlloop-usecases" feature enables the "usecases" controller in a PDP-D.
16 The "usecases" controller is carried forward from the El Alto release and will be deprecated in favor of the
17 "frankfurt" controller.
18
19 .. note::
20    This feature is disabled by default. Please use the 'frankfurt' feature in lieu of this. We will be renaming the 'frankfurt'
21    controller feature back to use cases in the Guilin release.
22
23 Usage
24 ^^^^^
25
26 The feature is disabled by default.  The lifecycle "enabled" property can be toggled with
27 the "features" command line tool.
28
29     .. code-block:: bash
30        :caption: PDPD Features Command
31
32         policy stop
33
34         features disable controlloop-usecases     # enable/disable toggles the activation of the feature.
35
36         policy start
37
38 End of Document