aboutsummaryrefslogtreecommitdiffstats
path: root/docs/clamp/controlloop/design-impl/participants/policy-framework-participant.rst
diff options
context:
space:
mode:
authorliamfallon <liam.fallon@est.tech>2021-10-29 12:00:21 +0100
committerliamfallon <liam.fallon@est.tech>2021-10-29 12:00:25 +0100
commit516e672d3c593ec8e1e642e620b802ba0ad7b65e (patch)
tree07d95fdd75216de8c6f175a58e3dbcc9751ead86 /docs/clamp/controlloop/design-impl/participants/policy-framework-participant.rst
parent802207c3dea71000f23777558d6377cbe133beca (diff)
Fix documentation warnings
Some remaining warnings in the documentaiton build ar fixed. Issue-ID: POLICY-3710 Change-Id: I4d41c3db48d4384cd03f4e9205cf0dcad6f684d4 Signed-off-by: liamfallon <liam.fallon@est.tech>
Diffstat (limited to 'docs/clamp/controlloop/design-impl/participants/policy-framework-participant.rst')
-rw-r--r--docs/clamp/controlloop/design-impl/participants/policy-framework-participant.rst32
1 files changed, 21 insertions, 11 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 99f2981a..56b2844f 100644
--- a/docs/clamp/controlloop/design-impl/participants/policy-framework-participant.rst
+++ b/docs/clamp/controlloop/design-impl/participants/policy-framework-participant.rst
@@ -42,7 +42,7 @@ The PDP Statistics API is used to get statistics for statistics report from the
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 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.
@@ -51,19 +51,29 @@ 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
+#. The Policy Participant reads the Policy Type ID from the policyType property specified for the Control Loop Element.
+
+#. 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 :ref:`controlloop-participant-protocol-label`.
+
+ #. 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.
+
+ #. 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
+#. The Policy Participant reads the Policy ID from the policyId property specified for the Control Loop Element.
+
+#. It checks if a Policy with that Policy ID has been specified in the ToscaServiceTemplateFragment field in the
+ ControLoopElement definition in the ControlLoopUpdate message, :ref:`controlloop-participant-protocol-label`.
+
+ #. 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.
+
+ #. 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