aboutsummaryrefslogtreecommitdiffstats
path: root/docs/clamp/acm
diff options
context:
space:
mode:
authorsaul.gill <saul.gill@est.tech>2023-03-31 11:14:39 +0100
committerLiam Fallon <liam.fallon@est.tech>2023-03-31 11:40:46 +0000
commitfc7c9c15fe46289eda93004c9dd765d84d43b541 (patch)
tree14e062ad9ad4b8385fcc89bc14b1b25a19de52b3 /docs/clamp/acm
parenta174cadc174377c9c38df860d7e37b5799067bc7 (diff)
Updating doc for policy participant
State terminology updates Fixed broken links Removed conf.yaml Issue-ID: POLICY-4611 Change-Id: I6edb567fccf192e953495c48f5b1abe348df433e Signed-off-by: saul.gill <saul.gill@est.tech>
Diffstat (limited to 'docs/clamp/acm')
-rw-r--r--docs/clamp/acm/design-impl/participants/policy-framework-participant.rst10
1 files changed, 6 insertions, 4 deletions
diff --git a/docs/clamp/acm/design-impl/participants/policy-framework-participant.rst b/docs/clamp/acm/design-impl/participants/policy-framework-participant.rst
index 9ce120c0..3ebdae5c 100644
--- a/docs/clamp/acm/design-impl/participants/policy-framework-participant.rst
+++ b/docs/clamp/acm/design-impl/participants/policy-framework-participant.rst
@@ -12,9 +12,9 @@ Automation Composition Elements in the Policy Framework Participant are configur
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 AutomationCompositionUpdate message is received by policy participant, it contains full ToscaServiceTemplate describing all components participating in an automation composition. When the automation composition element state changed from UNINITIALIZED to PASSIVE, the Policy-participant triggers the creation of policy-types and policies in Policy-Framework.
+For example, When a PARTICIPANT_UPDATE message is received by policy participant prompted by a PRIME, it contains the Automation Composition Element Definitions from the Tosca Service Template that was commissioned. An Automation Composition Instance can then be created from the commissioned definitions. When the automation composition instance element state changed from UNDEPLOYED to DEPLOYED, the Policy-participant receives a AUTOMATION_COMPOSITION_DEPLOY message, which 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.
+When the state changes from DEPLOYED to UNDEPLOYED, Policy-Participant deletes the policies, policy-types by invoking REST APIs towards the policy-framework.
Run Policy Framework Participant command line using Maven
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++
@@ -31,7 +31,9 @@ Distributing Policies
The Policy Framework participant uses the Policy PAP API to deploy and undeploy policies.
-When a Policy Framework Automation Composition Element changes from state UNINITIALISED to state PASSIVE, the policy is deployed. When it changes from state PASSIVE to state UNINITIALISED, the policy is undeployed.
+When a Policy Framework Automation Composition Element changes from state UNDEPLOYED to state DEPLOYED, the policy is deployed. When it changes from state DEPLOYED to state UNDEPLOYED, the policy is undeployed.
+
+For more complete detail of the state machines please go to the state machines page :ref:`acm-states-label`.
The PDP group to which the policy should be deployed is specified in the Automation Composition Element metadata, see the Policy Automation Composition Element type definition. If the PDP group specified for policy deployment does not exist, an error is reported.
@@ -76,4 +78,4 @@ The Policy Participant uses the following steps for Policy References:
successfully stored, execution proceeds, otherwise an error is reported.
#. 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
+ the Policy already exists, execution proceeds, otherwise an error is reported.