summaryrefslogtreecommitdiffstats
path: root/docs/xacml
diff options
context:
space:
mode:
authorPamela Dragosh <pdragosh@research.att.com>2020-04-29 08:23:12 -0400
committerPamela Dragosh <pdragosh@research.att.com>2020-05-04 12:24:24 -0400
commitf65c8ff3a2db95038b3d330f0fc639d5efd83484 (patch)
treea38b15ebc7f433ffae52e9c2d55345a628cd936a /docs/xacml
parente0c41c604ac6697f340bf37b137b0ca2f67143eb (diff)
Design/api documentation
Updates and fixes. Issue-ID: POLICY-2500 Change-Id: I2d7a0c78d57edf8bd258f685b12ae31bf6d54735 Signed-off-by: Pamela Dragosh <pdragosh@research.att.com>
Diffstat (limited to 'docs/xacml')
-rw-r--r--docs/xacml/decision-api.rst6
-rw-r--r--docs/xacml/xacml.rst14
2 files changed, 16 insertions, 4 deletions
diff --git a/docs/xacml/decision-api.rst b/docs/xacml/decision-api.rst
index e0d4f446..e475e1dc 100644
--- a/docs/xacml/decision-api.rst
+++ b/docs/xacml/decision-api.rst
@@ -3,9 +3,11 @@
.. _decision-api-label:
Decision API
-#######################
+############
-The Decision API is used by ONAP components that enforce policies and need a decision on which policy to enforce for a specific situation. The Decision API mimics closely the XACML request standard in that it supports a subject, action and resource.
+The Decision API is used by ONAP components that enforce policies and need a decision on which policy to enforce for a
+specific situation. The Decision API mimics closely the XACML request standard in that it supports a subject, action
+and resource.
.. csv-table::
:header: "Field", "Required", "XACML equivalent", "Description"
diff --git a/docs/xacml/xacml.rst b/docs/xacml/xacml.rst
index 1972a43c..f129a017 100644
--- a/docs/xacml/xacml.rst
+++ b/docs/xacml/xacml.rst
@@ -110,9 +110,14 @@ This is an example Decision API payload made to retrieve a decision for a Guard
.. literalinclude:: decision.guard.json
:language: JSON
+.. _xacml-optimization-label:
+
Optimization Policy Types
=========================
-These Policy Types are designed to be used by the OOF Project support several domains including VNF placement in ONAP. The OOF Platform makes a call to the Decision API to request these Policies based on the values specified in the onap.policies.Optimization properties. Each of these properties are treated relative to each other as an "AND". In addition, each value for each property itself is treated as an "OR".
+These Policy Types are designed to be used by the OOF Project support several domains including VNF placement in ONAP.
+The OOF Platform makes a call to the Decision API to request these Policies based on the values specified in the
+onap.policies.Optimization properties. Each of these properties are treated relative to each other as an "AND". In
+addition, each value for each property itself is treated as an "OR".
.. csv-table::
:header: "Policy Type", "Action"
@@ -130,7 +135,12 @@ These Policy Types are designed to be used by the OOF Project support several do
"onap.policies.optimization.resource.Vim_fit", "optimize"
"onap.policies.optimization.resource.VnfPolicy", "optimize"
-The optimization application extends the StdMatchablePolicyTranslator in that the application applies a "closest match" algorithm internally after a XACML decision. This filters the results of the decision to return the one or more policies that match the incoming decision request as close as possible. In addition, there is special consideration for the Subscriber Policy Type. If a decision request contains subscriber context attributes, then internally the application will apply an initial decision to retrieve the scope of the subscriber. The resulting scope attributes are then added into a final internal decision call.
+The optimization application extends the StdMatchablePolicyTranslator in that the application applies a "closest match"
+algorithm internally after a XACML decision. This filters the results of the decision to return the one or more policies
+that match the incoming decision request as close as possible. In addition, there is special consideration for the
+Subscriber Policy Type. If a decision request contains subscriber context attributes, then internally the application
+will apply an initial decision to retrieve the scope of the subscriber. The resulting scope attributes are then added
+into a final internal decision call.
This is an example Decision API payload made to retrieve a decision for an Optimization Policy Type.