Merge "Create documentation for CLAMP Policy Participant" into istanbul

1 files changed, 64 insertions, 3 deletions

diff --git a/docs/clamp/controlloop/design-impl/participants/policy-framework-participant.rst b/docs/clamp/controlloop/design-impl/participants/policy-framework-participant.rst
index 746dd529..99f2981a 100644
--- a/docs/clamp/controlloop/design-impl/participants/policy-framework-participant.rst
+++ b/docs/clamp/controlloop/design-impl/participants/policy-framework-participant.rst
@@ -2,7 +2,68 @@
 
 .. _clamp-controlloop-policy-framework-participant:
 
-Policy Framework Participant
-############################
+The CLAMP Policy Framework Participant
+######################################
 
-To be completed.
+.. contents::
+    :depth: 3
+
+Control Loop Elements in the Policy Framework Participant are configured using TOSCA metadata defined for the Policy Control Loop Element type.
+
+The Policy Framework participant receives messages through participant-intermediary common code, and handles them by invoking REST APIs towards policy-framework.
+
+For example, When a ControlLoopUpdate message is received by policy participant, it contains full ToscaServiceTemplate describing all components participating in a control loop. When the control loop element state changed from UNINITIALIZED to PASSIVE, the Policy-participant triggers the creation of policy-types and policies in Policy-Framework.
+
+When the state changes from PASSIVE to UNINITIALIZED, Policy-Participant deletes the policies, policy-types by invoking REST APIs towards the policy-framework.
+
+Run Policy Framework Participant command line using Maven
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+mvn spring-boot:run -Dspring-boot.run.arguments="--server.port=8082"
+
+Run Policy Framework Participant command line using Jar
++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+java -jar -Dserver.port=8082 -DtopicServer=localhost target/policy-clamp-participant-impl-policy-6.1.2-SNAPSHOT.jar
+
+Distributing Policies
++++++++++++++++++++++
+
+The Policy Framework participant uses the Policy PAP API to deploy and undeploy policies.
+
+When a Policy Framework Control Loop Element changes from state PASSIVE to state RUNNING, the policy is deployed. When it changes from state RUNNING to state PASSIVE, the policy is undeployed.
+
+The PDP group to which the policy should be deployed is specified in the Control Loop Element metadata, see the Policy Control Loop Element type definition. If the PDP group specified for policy deployment does not exist, an error is reported.
+
+The PAP Policy Status API and Policy Deployment Status API are used to retrieve data to report on the deployment status of policies in Participant Status messages.
+
+The PDP Statistics API is used to get statistics for statistics report from the Policy Framework Participant back to the CLAMP runtime.
+
+Policy Type and Policy References
++++++++++++++++++++++++++++++++++
+
+The Policy Framework uses the policyType and policyId properties defined in the Policy Control Loop Element type references to specify what policy type and policy should be used by a Policy Control Loop Element. 
+
+The Policy Type and Policy specified in the policyType and policyId reference must of course be available in the Policy Framework in order for them to be used in Control Loop instances. In some cases, the Policy Type and/or the Policy may be already loaded in the Policy Framework. In other cases, the Policy Framework participant must load the Policy Type and/or policy.
+
+Policy Type References
+**********************
+
+The Policy Participant uses the following steps for Policy Type References:
+
+    1. The Policy Participant reads the Policy Type ID from the policyType property specified for the Control Loop Element
+    2. It checks if a Policy Type with that Policy Type ID has been specified in the ToscaServiceTemplateFragment field in the ControLoopElement definition in the 
+       ControlLoopUpdate message, see The CLAMP Control Loop Participant Protocol#Messages.
+        a. If the Policy Type has been specified, the Participant stores the Policy Type in the Policy framework. If the Policy Type is successfully stored, execution proceeds, otherwise an error is reported
+        b. If the Policy Type has not been specified, the Participant checks that the Policy Type is already in the Policy framework. If the Policy Type already exists, execution proceeds, otherwise an error is reported
+
+Policy References
+*****************
+
+The Policy Participant uses the following steps for Policy References:
+
+    1. The Policy Participant reads the Policy ID from the policyId property specified for the Control Loop Element
+    2. It checks if a Policy with that Policy ID has been specified in the ToscaServiceTemplateFragment field in the ControLoopElement definition in the 
+       ControlLoopUpdate message, see The CLAMP Control Loop Participant Protocol#Messages.
+        a. If the Policy has been specified, the Participant stores the Policy in the Policy framework. If the Policy is successfully stored, execution proceeds, otherwise an error is reported
+        b. If the Policy has not been specified, the Participant checks that the Policy is already in the Policy framework. If the Policy already exists, execution proceeds, otherwise an error is reported
\ No newline at end of file