From 4d1d9830d51d3df59cadaa0ac9c9b004f2cb0d17 Mon Sep 17 00:00:00 2001 From: liamfallon Date: Thu, 30 May 2019 20:53:05 +0000 Subject: Design and Public API documentation completed. The draw.io diagrams are in Gerrit. If the page is ever deleted, they will be lost. They ae now saved in XML format in gerrit. The design documentation links to the examples in github rather than quoting them in the document. General tidy up and cleaning of links, rewording, and reformatting of desgin document. Added missing diagram to the Design document. Updated and tidied up the internal PAP/PDP document. General improvement of documentation. Issue-ID: POLICY-1676 Change-Id: Ie5c9f32693f047beafe14a3e412a32cdf9ed6fde Signed-off-by: liamfallon --- docs/design/images/APIsInPolicyFramework.svg | 2 ++ docs/design/images/PolicyImplPDPSubGroup.svg | 2 ++ 2 files changed, 4 insertions(+) create mode 100644 docs/design/images/APIsInPolicyFramework.svg create mode 100644 docs/design/images/PolicyImplPDPSubGroup.svg (limited to 'docs/design/images') diff --git a/docs/design/images/APIsInPolicyFramework.svg b/docs/design/images/APIsInPolicyFramework.svg new file mode 100644 index 00000000..9c19d751 --- /dev/null +++ b/docs/design/images/APIsInPolicyFramework.svg @@ -0,0 +1,2 @@ + +
Policy Type Design
(Policy Type Design API)
[Not supported by viewer]
PolicyType
TOSCA Artifact
[Not supported by viewer]
Policy Design
(Policy Design API)
Policy Design<br>(Policy Design API)
Done Manually or over Lifecycle API
Done Manually or over Lifecycle API
CLAMP
CLAMP
Other System
Other System
Executable Policy
Preinstalled or created by CLAMP or another system over Policy Design API
[Not supported by viewer]
PolicyImpl
Artifact
[Not supported by viewer]
PolicyTypeImpl
Artifact
<b>PolicyTypeImpl</b><br>Artifact
PAP
PAP
PDPs
PDPs
PDPs
PDPs
PDPs
PDPs
PDPs
PDPs
PDPs
PDPs
PDPs
PDPs
Runtime Administration
(Policy Admin API)
Runtime Administration<br>(Policy Admin API)
Other System
Other System
Policy
GUI
Policy<br>GUI
Policy Type Implementation matches ToscaPolicyType
An XACML,Drools, or
APEX implementation of a Policy Type
[Not supported by viewer]
Policy
TOSCA Artifact
[Not supported by viewer]
SDC
SDC
Other System
Other System
\ No newline at end of file diff --git a/docs/design/images/PolicyImplPDPSubGroup.svg b/docs/design/images/PolicyImplPDPSubGroup.svg new file mode 100644 index 00000000..8987ed22 --- /dev/null +++ b/docs/design/images/PolicyImplPDPSubGroup.svg @@ -0,0 +1,2 @@ + +
PDPGroup
PDPGroup
PDPSubGroup
PDPSubGroup
PDPSubGroup
PDPSubGroup
PDP-X
PDP-X
PDP-X
PDP-X
PDP-A
PDP-A
PDP-A
PDP-A
PDP-A
PDP-A
PDPSubGroup
PDPSubGroup
PDP-D
PDP-D
PDP-D
PDP-D
PDP-D
PDP-D
All PDPs in a PDPSubGroup run the same PolicyImpl
[Not supported by viewer]
The PDP running its PolicyImpl is the unit of scaling
[Not supported by viewer]
A PDPSubGroup is a Kubernetes Deployment
[Not supported by viewer]
PDPs run as Kubernets Pods
[Not supported by viewer]
A PDPGroup groups PDPSubGroup entities together
[Not supported by viewer]
ControlLoop
PDPGroup
ControlLoop<br>PDPGroup
CL_Apex
PDPSubGroup
CL_Apex<br>PDPSubGroup
CL_Guard
PDPSubGroup
CL_Guard<br>PDPSubGroup
PDP-X
PDP-X
PDP-X
PDP-X
PDP-A
PDP-A
PDP-A
PDP-A
PDP-A
PDP-A
CL_Drools
PDPSubGroup
CL_Drools<br>PDPSubGroup
PDP-D
PDP-D
PDP-D
PDP-D
PDP-D
PDP-D
Monitoring
PDPGroup
Monitoring<br>PDPGroup
Monitoring
PDPSubGroup
Monitoring<br>PDPSubGroup
PDP-X
PDP-X
PDP-X
PDP-X
\ No newline at end of file -- cgit