diff options
author | aditya.puthuparambil <aditya.puthuparambil@est.tech> | 2020-04-07 14:18:55 +0100 |
---|---|---|
committer | aditya.puthuparambil <aditya.puthuparambil@est.tech> | 2020-04-08 15:30:26 +0100 |
commit | 5a847723f3cf5339caaaa9c7fd608ad9afa49b96 (patch) | |
tree | f064ca505fa171ff3a95d45a15b5ad00f7384f8f /docs/apex | |
parent | 935358b4bfcf551ec780a4f6342032ac2a00376d (diff) |
Apex-pdp documentation conversion for DecisionMaker example
Issue-ID: POLICY-2399
Signed-off-by: aditya.puthuparambil <aditya.puthuparambil@est.tech>
Change-Id: I9fc825bc1010a53a159572656957d899d9a52aa9
Diffstat (limited to 'docs/apex')
-rw-r--r-- | docs/apex/APEX-DecisionMakerExample.rst | 107 | ||||
-rw-r--r-- | docs/apex/APEX-Policy-Examples.rst | 5 | ||||
-rw-r--r-- | docs/apex/apex.rst | 1 |
3 files changed, 110 insertions, 3 deletions
diff --git a/docs/apex/APEX-DecisionMakerExample.rst b/docs/apex/APEX-DecisionMakerExample.rst new file mode 100644 index 00000000..9bd6a564 --- /dev/null +++ b/docs/apex/APEX-DecisionMakerExample.rst @@ -0,0 +1,107 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + +.. _apex-DecisionMakerExample: + +APEX Examples Decision Maker +**************************** + + .. container:: sectionbody + + Click on the link to find the contents of each file to generate the Decision Maker Example. + + .. container:: ulist + + - |apexConfigRESTClient_link| + - |apexConfigRESTServer_link| + - |answerInitiationEvent_link| + - |makeDecision_Client_link| + - |makeDecision_Server_link| + - |makeDecisionExtraMode_Client_link| + - |makeDecisionExtraMode_Server_link| + + - APEX Model (Policies) + + - |answerInitTask_link| + - |ditheringAnswerTask_link| + - |makeDecisionStateTSL_link| + - |optimisticAnswerTask_link| + - |pessimisticAnswerTask_link| + - |randomAnswerTask_link| + - |roundRobinAnswerTask_link| + + + .. container:: + :name: footer-text + + 2.3.0-SNAPSHOT + Last updated 2020-04-08 16:04:24 IST + +.. |File > New to create a new Policy Model| image:: images/mfp/MyFirstPolicy_P1_newPolicyModel1.png +.. |Create a new Policy Model| image:: images/mfp/MyFirstPolicy_P1_newPolicyModel2.png +.. |ONAP| image:: ../../../images/logos.png + :class: builtBy + :target: http://www.onap.org/ +.. |apexConfigRESTClient_link| raw:: html + + <a href="https://github.com/onap/policy-apex-pdp/blob/master/examples/examples-decisionmaker/src/main/resources/examples/config/DecisionMaker/ApexConfigRESTClient.json" target="_blank">APEX Configuration: Rest Client</a> +.. |apexConfigRESTServer_link| raw:: html + + <a href="https://github.com/onap/policy-apex-pdp/blob/master/examples/examples-decisionmaker/src/main/resources/examples/config/DecisionMaker/ApexConfigRESTServer.json" target="_blank">APEX Configuration: Rest Server</a> + +.. |answerInitiationEvent_link| raw:: html + + <a href="https://github.com/onap/policy-apex-pdp/blob/master/examples/examples-decisionmaker/src/main/resources/examples/config/DecisionMaker/AnswerInitiationEvent.json" target="_blank">Initiation Event</a> + +.. |makeDecision_Client_link| raw:: html + + <a href="https://github.com/onap/policy-apex-pdp/blob/master/examples/examples-decisionmaker/src/main/resources/examples/html/DecisionMaker/MakeDecision_Client.html" target="_blank">HTML Client</a> + +.. |makeDecision_Server_link| raw:: html + + <a href="https://github.com/onap/policy-apex-pdp/blob/master/examples/examples-decisionmaker/src/main/resources/examples/html/DecisionMaker/MakeDecision_Server.html" target="_blank">HTML Server</a> + +.. |makeDecisionExtraMode_Client_link| raw:: html + + <a href="https://github.com/onap/policy-apex-pdp/blob/master/examples/examples-decisionmaker/src/main/resources/examples/html/DecisionMaker/MakeDecisionExtraMode_Client.html" target="_blank">HTML Client: Extra Mode</a> + +.. |makeDecisionExtraMode_Server_link| raw:: html + + <a href="https://github.com/onap/policy-apex-pdp/blob/master/examples/examples-decisionmaker/src/main/resources/examples/html/DecisionMaker/MakeDecisionExtraMode_Server.html" target="_blank">HTML Server: Extra Mode</a> + +.. |apexConfigRESTServer_link| raw:: html + + <a href="https://github.com/onap/policy-apex-pdp/blob/master/examples/examples-decisionmaker/src/main/resources/examples/config/DecisionMaker/ApexConfigRESTServer.json" target="_blank">APEX Configuration: Rest Server</a> + +.. |answerInitTask_link| raw:: html + + <a href="https://github.com/onap/policy-apex-pdp/blob/master/examples/examples-decisionmaker/src/main/resources/logic/AnswerInitTask.js" target="_blank">Task Logic: Answer Init</a> + +.. |ditheringAnswerTask_link| raw:: html + + <a href="https://github.com/onap/policy-apex-pdp/blob/master/examples/examples-decisionmaker/src/main/resources/logic/DitheringAnswerTask.js" target="_blank">Task Logic: Dithering Answer</a> + +.. |makeDecisionStateTSL_link| raw:: html + + <a href="https://github.com/onap/policy-apex-pdp/blob/master/examples/examples-decisionmaker/src/main/resources/logic/MakeDecisionStateTSL.js" target="_blank">Task Selection Logic: Make Decision State</a> + +.. |optimisticAnswerTask_link| raw:: html + + <a href="https://github.com/onap/policy-apex-pdp/blob/master/examples/examples-decisionmaker/src/main/resources/logic/OptimisticAnswerTask.js" target="_blank">Task Logic: Optimistic Answer</a> + +.. |pessimisticAnswerTask_link| raw:: html + + <a href="https://github.com/onap/policy-apex-pdp/blob/master/examples/examples-decisionmaker/src/main/resources/logic/PessimisticAnswerTask.js" target="_blank">Task Logic: Pessimistic Answer</a> + +.. |randomAnswerTask_link| raw:: html + + <a href="https://github.com/onap/policy-apex-pdp/blob/master/examples/examples-decisionmaker/src/main/resources/logic/RandomAnswerTask.js" target="_blank">Task Logic: Random Answer</a> + +.. |roundRobinAnswerTask_link| raw:: html + + <a href="https://github.com/onap/policy-apex-pdp/blob/master/examples/examples-decisionmaker/src/main/resources/logic/RoundRobinAnswerTask.js" target="_blank">Task Logic: RoundRobin Answer</a> + + + + + diff --git a/docs/apex/APEX-Policy-Examples.rst b/docs/apex/APEX-Policy-Examples.rst index 579f9160..cb8fa8d3 100644 --- a/docs/apex/APEX-Policy-Examples.rst +++ b/docs/apex/APEX-Policy-Examples.rst @@ -70,8 +70,7 @@ Decision Maker .. container:: ulist - - `Decision Maker on APEX - site <https://ericsson.github.io/apex-docs/modules/examples/examples-decisionmaker/index.html>`__ + - :ref:`Decision Maker on APEX site <apex-DecisionMakerExample>` .. container:: :name: footer @@ -80,4 +79,4 @@ Decision Maker :name: footer-text 2.3.0-SNAPSHOT - Last updated 2020-04-03 16:04:24 GMT
\ No newline at end of file + Last updated 2020-04-08 16:04:24 GMT
\ No newline at end of file diff --git a/docs/apex/apex.rst b/docs/apex/apex.rst index 4e257a17..cc196bce 100644 --- a/docs/apex/apex.rst +++ b/docs/apex/apex.rst @@ -13,3 +13,4 @@ Policy APEX PDP Engine APEX-Developer-Guide.rst APEX-Install-Guide.rst APEX-OnapPf-Guide.rst + APEX-Policy-Examples.rst
\ No newline at end of file |