diff options
24 files changed, 1283 insertions, 610 deletions
diff --git a/docs/architecture/architecture.rst b/docs/architecture/architecture.rst index b1c66d16..727cb6c9 100644 --- a/docs/architecture/architecture.rst +++ b/docs/architecture/architecture.rst @@ -8,13 +8,9 @@ Architecture Abstract -This document describes the ONAP Policy Framework. It lays out the -architecture of the framework and specifies the APIs provided to other -components that interwork with the framework. It describes the -implementation of the framework, mapping out the components, software -structure, and execution ecosystem of the framework. It goes on to -provide examples that illustrate how to write, deploy, and run policies -of various types using the framework. +This document describes the ONAP Policy Framework. It lays out the architecture of the framework and shows the APIs +provided to other components that interwork with the framework. It describes the implementation of the framework, +mapping out the components, software structure, and execution ecosystem of the framework. .. contents:: :depth: 6 @@ -22,746 +18,593 @@ of various types using the framework. 1. Overview =========== -The ONAP Policy Framework is a comprehensive policy design, deployment, -and execution environment. The Policy Framework is the decision -making component in `an ONAP -system <https://www.onap.org/wp-content/uploads/sites/20/2018/11/ONAP_CaseSolution_Architecture_112918FNL.pdf>`__. -It allows you to specify, deploy, and execute the governance of the -features and functions in your ONAP system, be they closed loop, -orchestration, or more traditional open loop use case implementations. -The Policy Framework is the component that is the source of truth for -all policy decisions. - -One of the most important goals of the Policy Framework is to support -Policy Driven Operational Management during the execution of ONAP -control loops at run time. In addition, use case implementations such as -orchestration and control benefit from the ONAP policy Framework because -they can use the capabilities of the framework to manage and execute -their policies rather than embedding the decision making in their -applications. - -The Policy Framework is deployment agnostic, the Policy Framework -manages Policy Execution (in PDPs) and Enforcement (in PEPs) regardless -of how the PDPs and PEPs are deployed. This allows policy execution and -enforcement can be deployed in a manner that meets the performance -requirements of a given application or use case. In one deployment, -policy execution could be deployed in a separate executing entity in a -Docker container. In another, policy execution could be co-deployed with -an application to increase performance. An example of co-deployment is the -Drools PDP Control Loop image, which is a Docker image that combines the ONAP -Drools use case application and dependencies with the Drools PDP engine. - -The ONAP Policy Framework architecture separates policies from the -platform that is supporting them. The framework supports development, -deployment, and execution of any type of policy in ONAP. The Policy -Framework is metadata (model) driven so that policy development, -deployment, and execution is as flexible as possible and can support -modern rapid development ways of working such as DevOps. A metadata -driven approach also allows the amount of programmed support required -for policies to be reduced or ideally eliminated. - -We have identified five capabilities as being essential for the -framework: - -1. Most obviously, the framework must be capable of being triggered by - an event or invoked, and making decisions at run time. - -2. It must be deployment agnostic; capable of managing policies for - various Policy Decision Points (PDPs) or policy engines. - -3. It must be metadata driven, allowing policies to be deployed, - modified, upgraded, and removed as the system executes. - -4. It must provide a flexible model driven policy design approach for - policy type programming and specification of policies. - -5. It must be extensible, allowing straightforward integration of new - PDPs, policy formats, and policy development environments. - -Another important aim of the architecture of a model driven policy -framework is that it enables much more flexible policy specification. -The ONAP Policy Framework complies with the -`TOSCA <http://docs.oasis-open.org/tosca/TOSCA-Simple-Profile-YAML/v1.1/TOSCA-Simple-Profile-YAML-v1.1.pdf>`__ -modelling approach for policies, see the :ref:`TOSCA Policy Primer <tosca-label>` for more -information on how policies are modeled in TOSCA. - -1. A Policy Type is a general implementation of a policy for a feature. - For example, a Policy Type could be written to manage Service Level - Agreements for VPNs. The Policy Type is designed by a domain expert, - who specifies the parameters, triggers, and actions that the Policy - Type will have. The implementation (the logic, rules, and tasks of - the Policy Type) is implemented by a skilled policy developer in - consultation with domain experts. - - 1. For example, the VPN Policy Type is used to create VPN policies - for a bank network, a car dealership network, or a university with - many campuses. - - 2. In ONAP, specific ONAP Policy Types are used to create specific - policies that drive the ONAP Platform and Components. - -2. A Policy is created by configuring a Policy Type with parameters. For - example, the SLA values in the car dealership VPN policy for a - particular dealership are configured with values appropriate for the - expected level of activity in that dealership. - -For more detailed information on designing Policy Types and developing an -implementation for that policy type, see :ref:`Policy Design and Development <design-label>`. - -The ONAP Policy Framework for building, configuring and deploying PDPs -is extendable. It allows the use of ONAP PDPs as is, the extension of -ONAP PDPs, and lastly provides the capability for users to create and -deploy their own PDPs. The ONAP Policy Framework provides distributed -policy management for **all** policies in ONAP at run time. Not only -does this provide unified policy access and version control, it provides -life cycle control for policies and allows detection of conflicts across -all policies running in an ONAP installation. +The ONAP Policy Framework is a comprehensive policy design, deployment, and execution environment. The Policy Framework +is the decision making component in `an ONAP system +<https://www.onap.org/wp-content/uploads/sites/20/2018/11/ONAP_CaseSolution_Architecture_112918FNL.pdf>`__. +It allows you to specify, deploy, and execute the governance of the features and functions in your ONAP system, be they +closed loop, orchestration, or more traditional open loop use case implementations. The Policy Framework is the +component that is the source of truth for all policy decisions. + +One of the most important goals of the Policy Framework is to support Policy Driven Operational Management during the +execution of ONAP control loops at run time. In addition, use case implementations such as orchestration and control +benefit from the ONAP policy Framework because they can use the capabilities of the framework to manage and execute +their policies rather than embedding the decision making in their applications. + +The Policy Framework is deployment agnostic, it manages Policy Execution (in PDPs) and Enforcement (in PEPs) regardless +of how the PDPs and PEPs are deployed. This allows policy execution and enforcement can be deployed in a manner that +meets the performance requirements of a given application or use case. In one deployment, policy execution could be +deployed in a separate executing entity in a Docker container. In another, policy execution could be co-deployed with +an application to increase performance. An example of co-deployment is the Drools PDP Control Loop image, which is a +Docker image that combines the ONAP Drools use case application and dependencies with the Drools PDP engine. + +The ONAP Policy Framework architecture separates policies from the platform that is supporting them. The framework +supports development, deployment, and execution of any type of policy in ONAP. The Policy Framework is metadata (model) +driven so that policy development, deployment, and execution is as flexible as possible and can support modern rapid +development ways of working such as DevOps. A metadata driven approach also allows the amount of programmed support +required for policies to be reduced or ideally eliminated. + +We have identified five capabilities as being essential for the framework: + +1. Most obviously, the framework must be capable of being triggered by an event or invoked, and making decisions at run + time. + +2. It must be deployment agnostic; capable of managing policies for various Policy Decision Points (PDPs) or policy + engines. + +3. It must be metadata driven, allowing policies to be deployed, modified, upgraded, and removed as the system executes. + +4. It must provide a flexible model driven policy design approach for policy type programming and specification of + policies. + +5. It must be extensible, allowing straightforward integration of new PDPs, policy formats, and policy development + environments. + +Another important aim of the architecture of a model driven policy framework is that it enables much more flexible +policy specification. The ONAP Policy Framework complies with the `TOSCA +<http://docs.oasis-open.org/tosca/TOSCA-Simple-Profile-YAML/v1.1/TOSCA-Simple-Profile-YAML-v1.1.pdf>`__ modelling +approach for policies, see the :ref:`TOSCA Policy Primer <tosca-label>` for more information on how policies are modeled +in TOSCA. + +1. A Policy Type is a general implementation of a policy for a feature. For example, a Policy Type could be written to + manage Service Level Agreements for VPNs. The Policy Type is designed by a domain expert, who specifies the + parameters, triggers, and actions that the Policy Type will have. The implementation (the logic, rules, and tasks of + the Policy Type) is implemented by a skilled policy developer in consultation with domain experts. + + a. For example, the VPN Policy Type is used to create VPN policies for a bank network, a car dealership network, or a + university with many campuses. + + b. In ONAP, specific ONAP Policy Types are used to create specific policies that drive the ONAP Platform and + Components. + +2. A Policy is created by configuring a Policy Type with parameters. For example, the SLA values in the car dealership + VPN policy for a particular dealership are configured with values appropriate for the expected level of activity in + that dealership. + +For more detailed information on designing Policy Types and developing an implementation for that policy type, see +:ref:`Policy Design and Development <design-label>`. + +The ONAP Policy Framework for building, configuring and deploying PDPs is extendable. It allows the use of ONAP PDPs as +is, the extension of ONAP PDPs, and lastly provides the capability for users to create and deploy their own PDPs. The +ONAP Policy Framework provides distributed policy management for **all** policies in ONAP at run time. Not only does +this provide unified policy access and version control, it provides life cycle control for policies and allows detection +of conflicts across all policies running in an ONAP installation. 2. Architecture =============== -The diagram below shows the architecture of the ONAP Policy Framework at -its highest level. +The diagram below shows the architecture of the ONAP Policy Framework at its highest level. .. image:: images/highest.png -The *PolicyDevelopment* component implements the functionality for -development of policy types and policies. *PolicyAdministration* is -responsible for the deployment life cycle of policies as well as -interworking with the mechanisms required to orchestrate the nodes and -containers on which policies run. *PolicyAdministration* is also -responsible for the administration of policies at run time; ensuring -that policies are available to users, that policies are executing -correctly, and that the state and status of policies is monitored. -*PolicyExecution* is the set of PDPs running in the ONAP system and is -responsible for making policy decisions and for managing the -administrative state of the PDPs as directed -by \ *PolicyAdministration.* - -*PolicyDevelopment* creates policy artifacts and supporting information -in the policy database. \ *PolicyAdministration* reads those artifacts -and the supporting information from the policy database whilst deploying -policy artifacts. Once the policy artifacts are deployed, -*PolicyAdministration* handles the run-time management of the PDPs on -which the policies are running. *PolicyDevelopment* interacts with ONAP -design time components, and has no programmatic interface with -*PolicyAdministration*, *PolicyExecution* or any other run-time ONAP -components. - -The diagram below shows a more detailed view of the architecture, as -inspired by `RFC-2753 <https://tools.ietf.org/html/rfc2753>`__ and -`RFC-3198 <https://tools.ietf.org/html/rfc3198>`__. +The *PolicyDevelopment* component implements the functionality for development of policy types and policies. +*PolicyAdministration* is responsible for the deployment life cycle of policies as well as interworking with the +mechanisms required to orchestrate the nodes and containers on which policies run. *PolicyAdministration* is also +responsible for the administration of policies at run time; ensuring that policies are available to users, that policies +are executing correctly, and that the state and status of policies is monitored. *PolicyExecution* is the set of PDPs +running in the ONAP system and is responsible for making policy decisions and for managing the administrative state of +the PDPs as directed by \ *PolicyAdministration.* + +*PolicyDevelopment* creates policy artifacts and supporting information in the policy database. \ *PolicyAdministration* +reads those artifacts and the supporting information from the policy database whilst deploying policy artifacts. Once +the policy artifacts are deployed, *PolicyAdministration* handles the run-time management of the PDPs on which the +policies are running. *PolicyDevelopment* interacts with ONAP design time components, and has no programmatic interface +with *PolicyAdministration*, *PolicyExecution* or any other run-time ONAP components. + +The diagram below shows a more detailed view of the architecture, as inspired by +`RFC-2753 <https://tools.ietf.org/html/rfc2753>`__ and `RFC-3198 <https://tools.ietf.org/html/rfc3198>`__. .. image:: images/detailed.png -*PolicyDevelopment* provides a -`CRUD <https://en.wikipedia.org/wiki/Create,_read,_update_and_delete>`__ -API for policy types and policies. The policy types and policy artifacts -and their metadata (Information about policies, policy types, and their -interrelations ) are stored in the *PolicyDB*. The *PolicyDevGUI*, -PolicyDistribution, and other applications such as *CLAMP* can use the -*PolicyDevelopment* API to create, update, and delete policy types and -policies. +*PolicyDevelopment* provides a `CRUD <https://en.wikipedia.org/wiki/Create,_read,_update_and_delete>`__ API for policy +types and policies. The policy types and policy artifacts and their metadata (Information about policies, policy types, +and their interrelations) are stored in the *PolicyDB*. The *PolicyDevGUI*, PolicyDistribution, and other applications +such as *CLAMP* can use the *PolicyDevelopment* API to create, update, and delete policy types and policies. *PolicyAdministration* has two important functions: -- Management of the life cycle of PDPs in an ONAP installation. PDPs - register with *PolicyAdministration* when they come up. - *PolicyAdministration* handles the allocation of PDPs to a PDP Groups - and PDP Subgroups, so that they can be managed as microservices in - Kubernetes. - -- Management of the deployment of policies to PDPs in an ONAP - installation. *PolicyAdministration* gives each PDP group a set of - domain policies to execute. +- Management of the life cycle of PDPs in an ONAP installation. PDPs register with *PolicyAdministration* when they come + up. *PolicyAdministration* handles the allocation of PDPs to a PDP Groups and PDP Subgroups, so that they can be + managed as microservices in Kubernetes. -*PolicyAdministration* handles PDPs and policy allocation to PDPs using -asynchronous messaging over DMaaP. +- Management of the deployment of policies to PDPs in an ONAP installation. *PolicyAdministration* gives each PDP group + a set of domain policies to execute. -*PolicyAdministation* provides three APIs: +*PolicyAdministration* handles PDPs and policy allocation to PDPs using asynchronous messaging over DMaaP. It provides +three APIs: -- a CRUD API for policy groups and subgroups +- a CRUD API for policy groups and subgroups -- an API that allows the allocation of policies PDP groups and - subgroups to be controlled +- an API that allows the allocation of policies PDP groups and subgroups to be controlled -- an API allows policy execution to be managed, showing the status of - policy execution on PDP Groups, subgroups, and individual PDPs as - well as the life cycle state of PDPs +- an API allows policy execution to be managed, showing the status of policy execution on PDP Groups, subgroups, and + individual PDPs as well as the life cycle state of PDPs -*PolicyExecution* is the set of running PDPs that are executing -policies, logically partitioned into PDP groups and subgroups. +*PolicyExecution* is the set of running PDPs that are executing policies, logically partitioned into PDP groups and +subgroups. .. image:: images/execution.png -The figure above shows how *PolicyExecution* looks at run time with PDPs -running in Kubernetes. A *PDPGroup* is a purely logical construct that -collects all the PDPs that are running policies for a particular domain -together. A *PDPSubGroup* is a group of PDPs of the same type that are -running the same policies. *A PDPSubGroup* is deployed as a Kubernetes -`Deployment <https://kubernetes.io/docs/concepts/workloads/controllers/deployment/>`__. -PDPs are defined as Kubernetes -`Pods <https://kubernetes.io/docs/concepts/workloads/pods/pod/>`__. At -run time, the actual number of PDPs in each *PDPSubGroup* is specified -in the configuration of the *Deployment* of that *PDPSubGroup* in -Kubernetes. This structuring of PDPs is required because, in order to -simplify deployment and scaling of PDPs in Kubernetes, we gather all the -PDPs of the same type that are running the same policies together for -deployment. - -For example, assume we have policies for the SON (Self Organizing -Network) and ACPE (Advanced Customer Premises Service) domains. For SON, -we have XACML, Drools, and APEX policies, and for ACPE we have XACML and -Drools policies. The table below shows the resulting\ *PDPGroup*, -*PDPSubGroup*, and PDP allocations: - -============= ================ ========================= ========================================================================== ================ -**PDP Group** **PDP Subgroup** **Kubernetes Deployment** **Kubernetes Deployment Strategy** **PDPs in Pods** -============= ================ ========================= ========================================================================== ================ -SON SON-XACML SON-XACML-Dep Always 2, be geo redundant 2 PDP-X -\ SON-Drools SON-Drools-Dep At Least 4, scale up on 70% load, scale down on 40% load, be geo-redundant >= 4 PDP-D -\ SON-APEX SON-APEX-Dep At Least 3, scale up on 70% load, scale down on 40% load, be geo-redundant >= 3 PDP-A -ACPE ACPE-XACML ACPE-XACML-Dep Always 2 2 PDP-X -\ ACPE-Drools ACPE-Drools-Dep At Least 2, scale up on 80% load, scale down on 50% load >=2 PDP-D -============= ================ ========================= ========================================================================== ================ - -For more details on *PolicyAdministration* API's and management of *PDPGroup* and *PDPSubGroup*, -see the documentation for :ref:`Policy Administration Point (PAP) Architecture <pap-label>`. +The figure above shows how *PolicyExecution* looks at run time with PDPs running in Kubernetes. A *PDPGroup* is a purely +logical construct that collects all the PDPs that are running policies for a particular domain together. A *PDPSubGroup* +is a group of PDPs of the same type that are running the same policies. *A PDPSubGroup* is deployed as a Kubernetes +`Deployment <https://kubernetes.io/docs/concepts/workloads/controllers/deployment/>`__. PDPs are defined as Kubernetes +`Pods <https://kubernetes.io/docs/concepts/workloads/pods/pod/>`__. At run time, the actual number of PDPs in each +*PDPSubGroup* is specified in the configuration of the *Deployment* of that *PDPSubGroup* in Kubernetes. This +structuring of PDPs is required because, in order to simplify deployment and scaling of PDPs in Kubernetes, we gather +all the PDPs of the same type that are running the same policies together for deployment. + +For example, assume we have policies for the SON (Self Organizing Network) and ACPE (Advanced Customer Premises Service) +domains. For SON,we have XACML, Drools, and APEX policies, and for ACPE we have XACML and Drools policies. The table +below shows the resulting \ *PDPGroup*, *PDPSubGroup*, and PDP allocations: + +============= ================ ========================= ======================================== ================ +**PDP Group** **PDP Subgroup** **Kubernetes Deployment** **Kubernetes Deployment Strategy** **PDPs in Pods** +============= ================ ========================= ======================================== ================ +SON SON-XACML SON-XACML-Dep Always 2, be geo redundant 2 PDP-X +\ SON-Drools SON-Drools-Dep At Least 4, scale up on 70% load, >= 4 PDP-D + scale down on 40% load, be geo-redundant +\ SON-APEX SON-APEX-Dep At Least 3, scale up on 70% load, scale >= 3 PDP-A + down on 40% load, be geo-redundant +ACPE ACPE-XACML ACPE-XACML-Dep Always 2 2 PDP-X +\ ACPE-Drools ACPE-Drools-Dep At Least 2, scale up on 80% load, scale >=2 PDP-D + down on 50% load +============= ================ ========================= ======================================== ================ + +For more details on *PolicyAdministration* APIs and management of *PDPGroup* and *PDPSubGroup*, see the documentation +for :ref:`Policy Administration Point (PAP) Architecture <pap-label>`. 2.1 Policy Framework Object Model --------------------------------- -This section describes the structure of and relations between the main -concepts in the Policy Framework. This model is implemented as a common -model and is used by *PolicyDevelopment*, *PolicyDeployment,* and -*PolicyExecution.* +This section describes the structure of and relations between the main concepts in the Policy Framework. This model is +implemented as a common model and is used by *PolicyDevelopment*, *PolicyDeployment,* and *PolicyExecution.* .. image:: images/objectmodel1.png -The UML class diagram above shows the portion of the Policy Framework -Object Model that applies to *PolicyDeployment* and *PolicyExecution.* +The UML class diagram above shows the portion of the Policy Framework Object Model that applies to *PolicyDeployment* +and *PolicyExecution.* .. image:: images/objectmodel2.png -The UML class diagram above shows the portion of the Policy Framework -Object Model that applies to *PolicyDevelopment* and *PolicyDeployment.* +The UML class diagram above shows the portion of the Policy Framework Object Model that applies to *PolicyDevelopment* +and *PolicyDeployment.* 2.2 Policy Design Architecture ------------------------------ -This section describes the architecture of the model driven system used -to develop policy types and to create concrete policies using policy -types. The output of Policy Design is deployment-ready artifacts and -Policy metadata in the Policy Framework database. +This section describes the architecture of the model driven system used to develop policy types and to create concrete +policies using policy types. The output of Policy Design is deployment-ready artifacts and Policy metadata in the Policy +Framework database. -Policies that are expressed via natural language or a model require some -development work ahead of time for them to be translated into concrete -runtime policies. Some Policy Domains will be setup and available in the -platform during startup such as Control Loop Operational Policy Models, -OOF placement Models, DCAE microservice models. Policy type +Policies that are expressed via natural language or a model require some development work ahead of time for them to be +translated into concrete runtime policies. Some Policy Domains will be set up and available in the platform during +startup such as Control Loop Operational Policy Models, OOF placement Models, DCAE microservice models. Policy type implementation development is done by an experienced developer. 2.2.1 Policy Type Design ^^^^^^^^^^^^^^^^^^^^^^^^ -Policy Type Design is the task of creating policy types that capture the -generic and vendor independent aspects of a policy for a particular -domain use case. The policy type implementation specifies the model -information, rules, and tasks that a policy type requires to generate -concrete policies. - -All policy types must implement the ONAP Policy Framework *PolicyType* -interface. This interface allows \ *PolicyDevelopment* to manage policy -types and to generate policies from these policy types in a uniform way -regardless of the domain that the policy type is addressing or the PDP -technology that will execute the policy. The interface is used by -*PolicyDevelopment* to determine the PDP technology of the policy type, -the structure, type, and definition of the model information that must -be supplied to the policy type to generate a concrete policy. - -A \ *PolicyTypeImpl* is developed for a certain type of PDP (for example -XACML oriented for decision policies or Drools rules oriented for ECA -policies). The design environment and tool chain for a policy type is -specific for the type of policy being designed. - -The \ *PolicyTypeImpl* implementation (or raw policy) is the -specification of the specific rules or tasks, the flow of the policy, -its internal states and data structures and other relevant information. -A *PolicyTyp*\ e\ *Impl* is specific to a PDP technology, that is XACML, -Drools, or APEX. *A PolicyTypeImpl* can be specific to a particular -policy type, it can be more general, providing the implementation of a -class of policy types, or the same policy type may have many +Policy Type Design is the task of creating policy types that capture the generic and vendor independent aspects of a +policy for a particular domain use case. The policy type implementation specifies the model information, rules, and +tasks that a policy type requires to generate concrete policies. + +All policy types must implement the ONAP Policy Framework *PolicyType* interface. This interface allows +*PolicyDevelopment* to manage policy types and to generate policies from these policy types in a uniform way regardless +of the domain that the policy type is addressing or the PDP technology that will execute the policy. The interface is +used by *PolicyDevelopment* to determine the PDP technology of the policy type, the structure, type, and definition of +the model information that must be supplied to the policy type to generate a concrete policy. + +A *PolicyTypeImpl* is developed for a certain type of PDP (for example XACML oriented for decision policies or Drools +rules oriented for ECA policies). The design environment and tool chain for a policy type is specific for the type of +policy being designed. + +The *PolicyTypeImpl* implementation (or raw policy) is the specification of the specific rules or tasks, the flow of +the policy, its internal states and data structures and other relevant information. A *PolicyTypeImpl* is specific to a +PDP technology, that is XACML, Drools, or APEX. *A PolicyTypeImpl* can be specific to a particular policy type, it can +be more general, providing the implementation of a class of policy types, or the same policy type may have many implementations. -*PolicyDevelopment* provides the RESTful `Policy Design -API <https://wiki.onap.org/display/DW/Policy+Design+and+API+Flow+for+Model+Driven+Control+Loop+-+Draft>`__, -which allows other components to query policy types and policy type -implementations, to determine the model information, rules, or tasks -that they require, to specialize policy flow, and to generate policies -from policy types. This API is used by the ONAP Policy Framework and -other components such as \ *PolicyDistribution* to create policies from +*PolicyDevelopment* provides the RESTful :ref:`Policy Design API <design-label>` which allows other components to query +policy types and policy type implementations, to determine the model information, rules, or tasks that they require, to +specialize policy flow, and to generate policies from policy types. This API is used by the ONAP Policy Framework and +other components such as \ *PolicyDistribution* to create policies from policy types. + +Consider a policy type created for managing faults on vCPE equipment in a vendor independent way. The policy type +captures the generic logic required to manage the faults and specifies the vendor specific information that must be +supplied to the type for specific vendor vCPE VFs. The actual vCPE policy that is used for managing particular vCPE +equipment is created by setting the parameters specified in the policy type together with the specific modeled +information, rules and tasks in the policy type implementation for that vendor model of vCPE. + +2.2.1.1 Generating Policy Types +""""""""""""""""""""""""""""""" + +It is possible to generate policy types using MDD (Model Driven Development) techniques. Policy types are expressed +using a DSL (Domain Specific Language) or a policy specification environment for a particular application domain. For +example, policy types for specifying SLAs could be expressed in a SLA DSL and policy types for managing SON features +could be generated from a visual SON management tool. The ONAP Policy framework provides an API that allows tool chains +to create policy types. SDC uses this approach for generating Policy Types in the Policy Framework, see the +:ref:`Policy Design and Development <design-label>` page. + +The SDC GUI supports several types of policies that can be captured at design time. DCAE micro service configuration +policies can be onboarded via the DCAE-DS (DCAE Design Studio). + + +.. image:: images/PolicyTypeDesign.svg + +The GUI implementation in another ONAP component such as SDC DCAE-DS uses the *API_User* API to create and edit ONAP policy types. -Consider a policy type created for managing faults on vCPE equipment in -a vendor independent way. The policy type captures the generic logic -required to manage the faults and specifies the vendor specific -information that must be supplied to the type for specific vendor vCPE -VFs. The actual vCPE policy that is used for managing particular vCPE -equipment is created by setting the parameters specified in the policy -type together with the specific modeled information, rules and tasks in -the policy type implementation for that vendor model of vCPE. - -2.2.2 Generating Policy Types -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -It is possible to generate policy types using MDD (Model Driven -Development) techniques. Policy types are expressed using a DSL (Domain -Specific Language) or a policy specification environment for a -particular application domain. For example, policy types for specifying -SLAs could be expressed in a SLA DSL and policy types for managing SON -features could be generated from a visual SON management tool. The ONAP -Policy framework provides an API that allows tool chains to create -policy types. SDC uses this approach for generating Policy Types in the -Policy Framework, see the `Model driven Control Loop -Design <file://localhost/display/DW/Model+driven+Control+Loop+Design>`__ -page. - -The SDC GUI supports several types of policies that can be captured at -design time. DCAE micro service configuration policies can be onboarded -via the DCAE-DS (DCAE Design Studio). - -The GUI implementation in another ONAP component such as SDC DCAE-DS -uses the *API_User* API to create and edit ONAP policy types. - -2.2.1.1 Programming Policy Type Implementations +2.2.1.2 Programming Policy Type Implementations """"""""""""""""""""""""""""""""""""""""""""""" -For skilled developers, the most straightforward way to create a policy -type is to program it. Programming a policy type might simply mean -creating and editing text files, thus manually creating the TOSCA Policy -Type Yaml file and the policy type implementation for the policy type. +For skilled developers, the most straightforward way to create a policy type is to program it. Programming a policy type +might simply mean creating and editing text files, thus manually creating the TOSCA Policy Type YAML file and the policy +type implementation for the policy type. -A more formal approach is preferred. For policy type implementations, -programmers use a specific Eclipse project type for developing each type -of implementation, a Policy Type Implementation SDK. The project is -under source control in git. This Eclipse project is structured -correctly for creating implementations for a specific type of PDP. It -includes the correct POM files for generating the policy type -implementation and has editors and perspectives that aid programmers in -their work +A more formal approach is preferred. For policy type implementations, programmers use a specific Eclipse project type +for developing each type of implementation, a Policy Type Implementation SDK. The project is under source control in +git. This Eclipse project is structured correctly for creating implementations for a specific type of PDP. It includes +the correct POM files for generating the policy type implementation and has editors and perspectives that aid +programmers in their work 2.2.2 Policy Design ^^^^^^^^^^^^^^^^^^^ -The *PolicyCreation* function of *PolicyDevelopment* creates policies -from a policy type. The information expressed during policy type design -is used to parameterize a policy type to create an executable policy. A -service designer and/or operations team can use tooling that reads the -TOSCA Policy Type specifications to express and capture a policy at its -highest abstraction level. Alternatively, the parameter for the policy -can be expressed in a raw JSON or YAML file and posted over the policy -design API described on the `Model driven Control Loop -Design <file://localhost/display/DW/Model+driven+Control+Loop+Design>`__ -page. - -A number of mechanisms for policy creation are supported in ONAP. The -process in *PolicyDevelopment* for creating a policy is the same for all -mechanisms. The most general mechanism for creating a policy is using -the RESTful *Policy Design API*, which provides a full interface to the -policy creation support of *PolicyDevelopment*. This API may be -exercised directly using utilities such as *curl*. \ *PolicyDevelopment* -provides a command line tool that is a loose wrapper around the API. It -also provides a general purpose Policy GUI in the ONAP Portal for policy -creation, which again is a general purpose wrapper around the policy -creation API. The Policy GUI can interpret any TOSCA Model ingested and -flexibly presents a GUI for a user to create policies from. The -development of these mechanisms will be phased over a number of ONAP -releases. - -A number of ONAP components use policy in manners which are specific to -their particular needs. The manner in which the policy creation process -is triggered and the way in which information required to create a -policy is specified and accessed is specialized for these ONAP -components. - -The following subsections outline the mechanisms for policy creation and -modification supported by the ONAP Policy Framework. +The *PolicyCreation* function of *PolicyDevelopment* creates policies from a policy type. The information expressed +during policy type design is used to parameterize a policy type to create an executable policy. A service designer +and/or operations team can use tooling that reads the TOSCA Policy Type specifications to express and capture a policy +at its highest abstraction level. Alternatively, the parameter for the policy can be expressed in a raw JSON or YAML +file and posted over the policy design API described on the :ref:`Policy Design and Development <design-label>` page. + +A number of mechanisms for policy creation are supported in ONAP. The process in *PolicyDevelopment* for creating a +policy is the same for all mechanisms. The most general mechanism for creating a policy is using the RESTful +*Policy Design API*, which provides a full interface to the policy creation support of *PolicyDevelopment*. This API may +be exercised directly using utilities such as *curl*. *PolicyDevelopment* provides a command line tool that is a loose +wrapper around the API. It also provides a general purpose Policy GUI in the ONAP Portal for policy creation, which +again is a general purpose wrapper around the policy creation API. The Policy GUI can interpret any TOSCA Model that has +been loaded into it and flexibly presents a GUI for a user to create policies from. The development of these mechanisms +will be phased over a number of ONAP releases. + +A number of ONAP components use policy in manners which are specific to their particular needs. The manner in which the +policy creation process is triggered and the way in which information required to create a policy is specified and +accessed is specialized for these ONAP components. + +The following subsections outline the mechanisms for policy creation and modification supported by the ONAP Policy +Framework. 2.2.2.1 Policy Design in the ONAP Policy Framework """""""""""""""""""""""""""""""""""""""""""""""""" -Policy creation in *PolicyDevelopment* follows the general sequence -shown in the sequence diagram below. An *API_USER* is any component that -wants to create a policy from a policy type. *PolicyDevelopment* -supplies a REST interface that exposes the API and also provides a -command line tool and general purpose client that wraps the API. - -A *PolicyDevAPIUser* first gets a reference to and the metadata for the -Policy type for the policy they want to work on from -*PolicyDevelopment*. \ *PolicyDevelopment* reads the metadata and -artifact for the policy type from the database. The *API_User* then asks -for a reference and the metadata for the policy. \ *PolicyDevelopment* -looks up the policy in the database. If the policy already -exists, \ *PolicyDevelopment* reads the artifact and returns the -reference of the existing policy to the \ *PolicyDevAPIUser* with the -metadata for the existing policy. If the policy does not -exist, \ *PolicyDevelopment* creates and new reference and metadata and -returns that to the \ *API_User*. - -The \ *PolicyDevAPIUser* may now proceed with a policy specification -session, where the parameters are set for the policy using the policy -type specification. Once the \ *PolicyDevAPIUser* is happy that the -policy is completely and correctly specified, it -requests \ *PolicyDevelopment* to create the -policy. \ *PolicyDevelopment* creates the policy, stores the created -policy artifact and its metadata in the database. +Policy creation in *PolicyDevelopment* follows the general sequence shown in the sequence diagram below. An *API_USER* +is any component that wants to create a policy from a policy type. *PolicyDevelopment* supplies a REST interface that +exposes the API and also provides a command line tool and general purpose client that wraps the API. + +.. image:: images/PolicyDesign.svg + +An *API_User* first gets a reference to and the metadata for the Policy type for the policy they want to work on from +*PolicyDevelopment*. *PolicyDevelopment* reads the metadata and artifact for the policy type from the database. The +*API_User* then asks for a reference and the metadata for the policy. *PolicyDevelopment* looks up the policy in the +database. If the policy already exists, *PolicyDevelopment* reads the artifact and returns the reference of the existing +policy to the *API_User* with the metadata for the existing policy. If the policy does not exist, *PolicyDevelopment* +creates and new reference and metadata and returns that to the *API_User*. + +The *API_User* may now proceed with a policy specification session, where the parameters are set for the policy using +the policy type specification. Once the *API_User* is happy that the policy is completely and correctly specified, it +requests *PolicyDevelopment* to create the policy. *PolicyDevelopment* creates the policy, stores the created policy +artifact and its metadata in the database. 2.2.2.2 Model Driven VF (Virtual Function) Policy Design via VNF SDK Packaging """""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" -VF vendors express policies such as SLA, Licenses, hardware placement, -run-time metric suggestions, etc. These details are captured within the -VNF SDK and uploaded into the SDC Catalog. The `SDC Distribution -APIs <file://localhost/display/DW/SDC+API>`__ are used to interact with -SDC. For example, SLA and placement policies may be captured via TOSCA -specification. License policies can be captured via TOSCA or an XACML -specification. Run-time metric vendor recommendations can be captured -via VES Standard specification. - -The sequence diagram below is a high level view of SDC-triggered -concrete policy generation for some arbitrary entity *EntityA*. The -parameters to create a policy are read from a TOSCA Policy specification -read from a CSAR received from SDC. - -*PolicyDesign* uses the *PolicyDistribution* component for managing -SDC-triggered policy creation and update requests. *PolicyDistribution* -is an *API_User*, it uses the Policy Design API for policy creation and -update. It reads the information it needs to populate the policy type -from a TOSCA specification in a CSAR received from SDC and then uses +VF vendors express policies such as SLA, Licenses, hardware placement, run-time metric suggestions, etc. These details +are captured within the VNF SDK and uploaded into the SDC Catalog. The `SDC Distribution APIs +<https://wiki.onap.org/display/DW/SDC+Distribution+client+AID>`__ are used to interact with SDC. For example, SLA and +placement policies may be captured via TOSCA specification. License policies can be captured via TOSCA or an XACML +specification. Run-time metric vendor recommendations can be captured via the VES Standard specification. + +The sequence diagram below is a high level view of SDC-triggered concrete policy generation for some arbitrary entity +*EntityA*. The parameters to create a policy are read from a TOSCA Policy specification read from a CSAR received from +SDC. + +.. image:: images/ModelDrivenPolicyDesign.svg + +*PolicyDesign* uses the *PolicyDistribution* component for managing SDC-triggered policy creation and update requests. +*PolicyDistribution* is an *API_User*, it uses the Policy Design API for policy creation and update. It reads the +information it needs to populate the policy type from a TOSCA specification in a CSAR received from SDC and then uses this information to automatically generate a policy. -Note that SDC provides a wrapper for the SDC API as a Java Client and -also provides a TOSCA parser. See `Policy Platform - SDC Service -Distribution Software -Architecture <file://localhost/display/DW/Policy+Platform+-+SDC+Service+Distribution+Software+Architecture>`__ +Note that SDC provides a wrapper for the SDC API as a Java Client and also provides a TOSCA parser. See the +documentation for the `Policy Distribution Component +<https://docs.onap.org/en/latest/submodules/policy/distribution.git/docs/index.html>`__. -In Step 4 above, the \ *PolicyDesign* must download the CSAR file. If -the policy is to be composed from the TOSCA definition, it must also -parse the TOSCA definition. +In Step 4 above, the \ *PolicyDesign* must download the CSAR file. If the policy is to be composed from the TOSCA +definition, it must also parse the TOSCA definition. -In Step 9 above, the \ *PolicyDesign* must send back/publish status -events to SDC such as DOWNLOAD_OK, DOWNLOAD_ERROR, DEPLOY_OK, -DEPLOY_ERROR, NOTIFIED. +In Step 11 above, the \ *PolicyDesign* must send back/publish status events to SDC such as DOWNLOAD_OK, DOWNLOAD_ERROR, +DEPLOY_OK, DEPLOY_ERROR, NOTIFIED. 2.2.2.3 Scripted Model Driven Policy Design """"""""""""""""""""""""""""""""""""""""""" -Service policies such as optimization and placement policies can be -specified as a TOSCA Policy at design time. These policies use a TOSCA -Policy Type specification as their schemas. Therefore, scripts can be -used to create TOSCA policies using TOSCA Policy Types. +Service policies such as optimization and placement policies can be specified as a TOSCA Policy at design time. These +policies use a TOSCA Policy Type specification as their schemas. Therefore, scripts can be used to create TOSCA policies +using TOSCA Policy Types. -One straightforward way of generating policies from Policy types is to -use directives specified in a script file. The command line utility is -an *API_User*. The script reads directives from a file. For each -directive, it reads the policy type using the Policy Type API, and uses -the parameters of the directive to create a TOSCA Policy. It then uses -the Policy API to create the policy. +.. image:: images/ScriptedPolicyDesign.svg + +One straightforward way of generating policies from Policy types is to use directives specified in a script file. The +command line utility is an *API_User*. The script reads directives from a file. For each directive, it reads the policy +type using the Policy Type API, and uses the parameters of the directive to prepare a TOSCA Policy. It then uses the +Policy API to create the policy. 2.2.3 Policy Design Process ^^^^^^^^^^^^^^^^^^^^^^^^^^^ -All policy types must be certified as being fit for deployment prior to -run time deployment. In the case of design-time via the SDC application, -it is assumed the lifecycle being implemented by SDC will suffice for -any policy types that are declared within the ONAP Service CSAR. For -other policy types and policy type implementations, the lifecycle -associated with software development process will suffice. Since policy -types and their implementations will be designed and implemented using -software development best practices, they can be utilized and configured -for various environments (eg. development, testing, production) as -desired. +All policy types must be certified as being fit for deployment prior to run time deployment. Where design is executed +using the SDC application, it is assumed the life cycle being implemented by SDC certifies any policy types that +are declared within the ONAP Service CSAR. For other policy types and policy type implementations, the life cycle +associated with the applied software development process suffices. Since policy types and their implementations are +designed and implemented using software development best practices, they can be utilized and configured for various +environments (eg. development, testing, production) as desired. 2.3 Policy Runtime Architecture ------------------------------- -The Policy Framework Platform components are themselves designed as -micro services that are easy to configure and deploy via Docker images -and K8S both supporting resiliency and scalability if required. PAPs and -PDPs are deployed by the underlying ONAP management infrastructure and -are designed to comply with the ONAP interfaces for deploying -containers. - -The PAPs keep track of PDPs, support the deployment of PDP groups and -the deployment of a policy set across those PDP groups. A PAP is -stateless in a RESTful sense. Therefore, if there is more than one PAP -deployed, it does not matter which PAP a user contacts to handle a -request. The PAP uses the database (persistent storage) to keep track of -ongoing sessions with clients. Policy management on PDPs is the -responsibility of PAPs; management of policy sets or policies by any -other manner is not permitted. - -In the ONAP Policy Framework, the interfaces to the PDP are designed to -be as streamlined as possible. Because the PDP is the main unit of -scalability in the Policy Framework, the PF is designed to allow PDPs in -a PDP group to arbitrarily appear and disappear and for policy -consistency across all PDPs in a PDP group to be easily maintained. -Therefore, PDPs have just two interfaces; an interface that users can -use to execute policies and interface to the PAP for administration, -life cycle management and monitoring. The PAP is responsible for -controlling the state across the PDPs in a PDP group. The PAP interacts -with the Policy database and transfers policy sets to PDPs, and may -cache the policy sets for PDP groups. - -See also Sectino 2 of the `Policy Design and API Flow for Model Driven -Control -Loop <file://localhost/display/DW/Policy+Design+and+API+Flow+for+Model+Driven+Control+Loop>`__ -page, where the mechanisms for PDP Deployment and Registration with PAP -are explained. +The Policy Framework Platform components are themselves designed as microservices that are easy to configure and deploy +via Docker images and K8S both supporting resiliency and scalability if required. PAPs and PDPs are deployed by the +underlying ONAP management infrastructure and are designed to comply with the ONAP interfaces for deploying containers. + +The PAPs keep track of PDPs, support the deployment of PDP groups and the deployment of a *policy set* across those PDP +groups. A PAP is stateless in a RESTful sense. Therefore, if there is more than one PAP deployed, it does not matter +which PAP a user contacts to handle a request. The PAP uses the database (persistent storage) to keep track of ongoing +sessions with clients. Policy management on PDPs is the responsibility of PAPs; management of policy sets or policies by +any other manner is not permitted. + +In the ONAP Policy Framework, the interfaces to the PDP are designed to be as streamlined as possible. Because the PDP +is the main unit of scalability in the Policy Framework, the framework is designed to allow PDPs in a PDP group to +arbitrarily appear and disappear and for policy consistency across all PDPs in a PDP group to be easily maintained. +Therefore, PDPs have just two interfaces; an interface that users can use to execute policies and interface to the PAP +for administration, life cycle management and monitoring. The PAP is responsible for controlling the state across the +PDPs in a PDP group. The PAP interacts with the Policy database and transfers policy sets to PDPs, and may cache the +policy sets for PDP groups. + +See also Section 2 of the :ref:`Policy Design and Development <design-label>` page, where the mechanisms for PDP +Deployment and Registration with PAP are explained. 2.3.1 Policy Framework Services ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -The ONAP Policy Framework follows the architectural approach for micro -services recommended by the `ONAP Architecture +The ONAP Policy Framework follows the architectural approach for microservices recommended by the `ONAP Architecture Subcommittee <https://wiki.onap.org/display/DW/Architecture+Subcommittee>`__. -The ONAP Policy Framework defines `Kubernetes -Services <https://kubernetes.io/docs/concepts/services-networking/service/>`__ -to manage the life cycle of Policy Framework executable components at -runtime. A Kubernetes service allows, among other parameters, the -number of instances (pods in Kubernetes terminology) that should be -deployed for a particular service to be specified and a common endpoint -for that service to be defined. Once the service is started in -Kubernetes, Kubernetes ensures that the specified number of instances is -always kept running. As requests are received on the common endpoint, -they are distributed across the service instances. More complex call -distribution and instance deployment strategies may be used; please see -the `Kubernetes -Services <https://kubernetes.io/docs/concepts/services-networking/service/>`__ -documentation for those details. - -If, for example, a service called *policy-pdpd-control-loop* is defined -that runs 5 PDP-D instances. The service has the end point -*https://policy-pdpd-control-loop.onap/<service-specific-path>*. When -the service is started, Kubernetes spins up 5 PDP-Ds. Calls to the end -point *https://policy-pdpd-control-loop.onap/<service-specific-path>* -are distributed across the 5 PDP-D instances. Note that the *.onap* part -of the service endpoint is the namespace being used and is specified for -the full ONAP Kubernetes installation. +The ONAP Policy Framework defines `Kubernetes Services +<https://kubernetes.io/docs/concepts/services-networking/service/>`__ to manage the life cycle of Policy Framework +executable components at runtime. A Kubernetes service allows, among other parameters, the number of instances (*pods* +in Kubernetes terminology) that should be deployed for a particular service to be specified and a common endpoint for +that service to be defined. Once the service is started in Kubernetes, Kubernetes ensures that the specified number of +instances is always kept running. As requests are received on the common endpoint, they are distributed across the +service instances. More complex call distribution and instance deployment strategies may be used; please see the +`Kubernetes Services <https://kubernetes.io/docs/concepts/services-networking/service/>`__ documentation for those +details. + +If, for example, a service called *policy-pdpd-control-loop* is defined that runs 5 PDP-D instances. The service has the +end point *https://policy-pdpd-control-loop.onap/<service-specific-path>*. When the service is started, Kubernetes spins +up 5 PDP-Ds. Calls to the end point *https://policy-pdpd-control-loop.onap/<service-specific-path>* are distributed +across the 5 PDP-D instances. Note that the *.onap* part of the service endpoint is the namespace being used and is +specified for the full ONAP Kubernetes installation. The following services will be required for the ONAP Policy Framework: -================ ============================== =============================================================================================================================================================================================================================================================== +================ ============================== ======================================================================= **Service** **Endpoint** **Description** -================ ============================== =============================================================================================================================================================================================================================================================== -PAP https://policy-pap The PAP service, used for policy administration and deployment. See `Policy Design and API Flow for Model Driven Control Loop <file://localhost/display/DW/Policy+Design+and+API+Flow+for+Model+Driven+Control+Loop>`__ for details of the API for this service -PDP-X-\ *domain* https://policy-pdpx-\ *domain* A PDP service is defined for each PDP group. A PDP group is identified by the domain on which it operates. - - For example, there could be two PDP-X domains, one for admission policies for ONAP proper and another for admission policies for VNFs of operator *Supacom*. Two PDP-X services are defined: - +================ ============================== ======================================================================= +PAP https://policy-pap The PAP service, used for policy administration and deployment. See + :ref:`Policy Design and Development <design-label>` for details of the + API for this service +PDP-X-\ *domain* https://policy-pdpx-\ *domain* A PDP service is defined for each PDP group. A PDP group is identified + by the domain on which it operates. + + For example, there could be two PDP-X domains, one for admission + policies for ONAP proper and another for admission policies for VNFs of + operator *Supacom*. Two PDP-X services are defined: + | https://policy-pdpx-onap | https://policy-pdpx-\ *supacom* PDP-D-\ *domain* https://policy-pdpd-\ *domain* PDP-A-\ *domain* https://policy-pdpa-\ *domain* -================ ============================== =============================================================================================================================================================================================================================================================== +================ ============================== ======================================================================= -There is one and only one PAP service, which handles policy deployment, -administration, and monitoring for all policies in all PDPs and PDP -groups in the system. There are multiple PDP services, one PDP service -for each domain for which there are policies. +There is one and only one PAP service, which handles policy deployment, administration, and monitoring for all policies +in all PDPs and PDP groups in the system. There are multiple PDP services, one PDP service for each domain for which +there are policies. 2.3.2 The Policy Framework Information Structure ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -The following diagram captures the relationship between Policy Framework -concepts at run time. +The following diagram captures the relationship between Policy Framework concepts at run time. + +.. image:: images/RuntimeRelationships.svg -There is a one to one relationship between a PDP SubGroup, a Kubernetes -PDP service, and the set of policies assigned to run in the PDP -subgroup. Each PDP service runs a single PDP subgroup with multiple -PDPs, which executes a specific Policy Set containing a number of -policies that have been assigned to that PDP subgroup. Having and -maintaining this principle makes policy deployment and administration -much more straightforward than it would be if complex relationships +There is a one to one relationship between a PDP SubGroup, a Kubernetes PDP service, and the set of policies assigned to +run in the PDP subgroup. Each PDP service runs a single PDP subgroup with multiple PDPs, which executes a specific +Policy Set containing a number of policies that have been assigned to that PDP subgroup. Having and maintaining this +principle makes policy deployment and administration much more straightforward than it would be if complex relationships between PDP services, PDP subgroups, and policy sets. -The topology of the PDPs and their policy sets is held in the Policy -Framework database and is administered by the PAP service. +The topology of the PDPs and their policy sets is held in the Policy Framework database and is administered by the PAP service. -The diagram above gives an indicative structure of the run time topology -information in the Policy Framework database. Note that -the \ *PDP_SUBGROUP_STATE* and \ *PDP_STATE* fields hold state -information for life cycle management of PDP groups and PDPs. +.. image:: images/PolicyDatabase.svg + +The diagram above gives an indicative structure of the run time topology information in the Policy Framework database. +Note that the *PDP_SUBGROUP_STATE* and *PDP_STATE* fields hold state information for life cycle management of PDP groups +and PDPs. 2.3.3 Startup, Shutdown and Restart ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -This section describes the interactions between Policy Framework -components themselves and with other ONAP components at startup, -shutdown and restart. +This section describes the interactions between Policy Framework components themselves and with other ONAP components at +startup, shutdown and restart. 2.3.3.1 PAP Startup and Shutdown """""""""""""""""""""""""""""""" The sequence diagram below shows the actions of the PAP at startup. -The PAP is the run time point of coordination for the ONAP Policy -Framework. When it is started, it initializes itself using data from the -database. It then waits for periodic PDP status updates and for -administration requests. +.. image:: images/PAPStartStop.svg + +The PAP is the run time point of coordination for the ONAP Policy Framework. When it is started, it initializes itself +using data from the database. It then waits for periodic PDP status updates and for administration requests. -PAP shutdown is trivial. On receipt or a shutdown request, the PAP -completes or aborts any ongoing operations and shuts down gracefully. +PAP shutdown is trivial. On receipt or a shutdown request, the PAP completes or aborts any ongoing operations and shuts +down gracefully. 2.3.3.2 PDP Startup and Shutdown """""""""""""""""""""""""""""""" -The sequence diagram below shows the actions of the PDP at startup. See -also Section 4 of the `Policy Design and API Flow for Model Driven -Control -Loop <file://localhost/display/DW/Policy+Design+and+API+Flow+for+Model+Driven+Control+Loop>`__ -page for the API used to implement this sequence. +The sequence diagram below shows the actions of the PDP at startup. See also Section 4 of the +:ref:`Policy Design and Development <design-label>` page for the API used to implement this sequence. -At startup, the PDP initializes itself. At this point it is in PASSIVE -mode. The PDP begins sending periodic Status messages to the PAP. +.. image:: images/PDPStartStop.svg -The first Status message initializes the process of loading the correct -Policy Set on the PDP in the PAP. +At startup, the PDP initializes itself. At this point it is in PASSIVE mode. The PDP begins sending periodic Status +messages to the PAP. The first Status message initializes the process of loading the correct Policy Set on the PDP in +the PAP. -On receipt or a shutdown request, the PDP completes or aborts any -ongoing policy executions and shuts down gracefully. +On receipt or a shutdown request, the PDP completes or aborts any ongoing policy executions and shuts down gracefully. 2.3.4 Policy Execution ^^^^^^^^^^^^^^^^^^^^^^ -Policy execution is the execution of a policy in a PDP. Policy -enforcement occurs in the component that receives a policy decision. +Policy execution is the execution of a policy in a PDP. Policy enforcement occurs in the component that receives a +policy decision. -Policy execution can be *synchronous* or *asynchronous*. In -*synchronous* policy execution, the component requesting a policy -decision requests a policy decision and waits for the result. The PDP-X -and PDP-A use synchronous policy execution. In *asynchronous* policy -execution, the component that requests a policy decision does not wait -for the decision. Indeed, the decision may be passed to another -component. The PDP-D and PDP-A use asynchronous policy execution. +.. image:: images/PolicyExecution.svg -Policy execution is carried out using the current life cycle mode of -operation of the PDP. While the actual implementation of the mode may -vary somewhat between PDPs of different types, the principles below hold -true for all PDP types: +Policy execution can be *synchronous* or *asynchronous*. In *synchronous* policy execution, the component requesting a +policy decision requests a policy decision and waits for the result. The PDP-X and PDP-A implement synchronous policy +execution. In *asynchronous* policy execution, the component that requests a policy decision does not wait for the +decision. Indeed, the decision may be passed to another component. The PDP-D and PDP-A implement asynchronous polic +execution. -================== =========================================================================================================================================================================================================================================================================================================================== +Policy execution is carried out using the current life cycle mode of operation of the PDP. While the actual +implementation of the mode may vary somewhat between PDPs of different types, the principles below hold true for all +PDP types: + +================== ===================================================================================================== **Lifecycle Mode** **Behaviour** -================== =========================================================================================================================================================================================================================================================================================================================== +================== ===================================================================================================== PASSIVE MODE Policy execution is always rejected irrespective of PDP type. ACTIVE MODE Policy execution is executed in the live environment by the PDP. -SAFE MODE Policy execution proceeds, but changes to domain state or context are not carried out. The PDP returns an indication that it is running in SAFE mode together with the action it would have performed if it was operating in ACTIVE mode. The PDP type and the policy types it is running must support SAFE mode operation. -TEST MODE Policy execution proceeds and changes to domain and state are carried out in a test or sandbox environment. The PDP returns an indication it is running in TEST mode together with the action it has performed on the test environment. The PDP type and the policy types it is running must support TEST mode operation. -================== =========================================================================================================================================================================================================================================================================================================================== +SAFE MODE Policy execution proceeds, but changes to domain state or context are not carried out. The PDP + returns an indication that it is running in SAFE mode together with the action it would have + performed if it was operating in ACTIVE mode. The PDP type and the policy types it is running must + support SAFE mode operation. +TEST MODE Policy execution proceeds and changes to domain and state are carried out in a test or sandbox + environment. The PDP returns an indication it is running in TEST mode together with the action it has + performed on the test environment. The PDP type and the policy types it is running must support TEST + mode operation. +================== ===================================================================================================== 2.3.5 Policy Lifecycle Management ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -Policy lifecycle management manages the deployment and life cycle of -policies in PDP groups at run time. Policy sets can be deploy at run -time without restarting PDPs or stopping policy execution. PDPs preserve -state for minor/patch version upgrades and rollbacks. +Policy lifecycle management manages the deployment and life cycle of policies in PDP groups at run time. Policy sets can +be deployed at run time without restarting PDPs or stopping policy execution. PDPs preserve state for minor/patch +version upgrades and rollbacks. 2.3.5.1 Load/Update Policies on PDP """"""""""""""""""""""""""""""""""" -The sequence diagram below shows how policies are loaded or updated on a -PDP. +The sequence diagram below shows how policies are loaded or updated on a PDP. + +.. image:: images/DownloadPoliciesToPDP.svg -This sequence can be initiated in two ways; from the PDP or from a user -action. +This sequence can be initiated in two ways; from the PDP or from a user action. -1. A PDP sends regular status update messages to the PAP. If this - message indicates that the PDP has no policies or outdated policies - loaded, then this sequence is initiated +1. A PDP sends regular status update messages to the PAP. If this message indicates that the PDP has no policies or + outdated policies loaded, then this sequence is initiated 2. A user may explicitly trigger this sequence to load policies on a PDP -The PAP controls the entire process. The PAP reads the current PDP -metadata and the required policy and policy set artifacts from the -database. It then builds the policy set for the PDP. Once the policies -are ready, the PAP sets the mode of the PDP to PASSIVE. The Policy Set -is transparently passed to the PDP by the PAP. The PDP loads all the -policies in the policy set including any models, rules, tasks, or flows -in the policy set in the policy implementations. +The PAP controls the entire process. The PAP reads the current PDP metadata and the required policy and policy set +artifacts from the database. It then builds the policy set for the PDP. Once the policies are ready, the PAP sets the +mode of the PDP to PASSIVE. The Policy Set is transparently passed to the PDP by the PAP. The PDP loads all the policies +in the policy set including any models, rules, tasks, or flows in the policy set in the policy implementations. + +Once the Policy Set is loaded, the PAP orders the PDP to enter the life cycle mode that has been specified for it +(ACTIVE/SAFE/TEST). The PDP begins to execute policies in the specified mode (see section 2.3.4). -Once the Policy Set is loaded, the PAP orders the PDP to enter the life -cycle mode that has been specified for it (ACTIVE/SAFE/TEST). The PDP -beings to execute policies in the specified mode (see section 2.3.4). +.. _policy-rollout: 2.3.5.2 Policy Rollout """""""""""""""""""""" -A policy set steps through a number of life cycle modes when it is -rolled out. - -The user defines the set of policies for a PDP group. It is deployed to -a PDP group and is initially in PASSIVE mode. The user sets the PDP -Group into TEST mode. The policies are run in a test or sandboxed -environment for a period of time. The test results are passed back to -the user. The user may revert the policy set to PASSIVE mode a number of -times and upgrade the policy set during test operation. - -When the user is satisfied with policy set execution and when quality -criteria have been reached for the policy set, the PDP group is set to -run in SAFE mode. In this mode, the policies run on the actual target -environment but do not actually exercise any actions or change any -context in the target environment. Again, as in TEST mode, the operator -may decide to revert back to TEST mode or even PASSIVE mode if issues -arise with a policy set. - -Finally, when the user is satisfied with policy set execution and when -quality criteria have been reached, the PDP group is set into ACTIVE -state and the policy set executes on the target environment. The results -of target operation are reported. The PDP group can be reverted to SAFE, -TEST, or even PASSIVE mode at any time if problems arise. +A policy set steps through a number of life cycle modes when it is rolled out. + +.. image:: images/PolicyRollout.svg + +The user defines the set of policies for a PDP group. It is deployed to a PDP group and is initially in PASSIVE mode. +The user sets the PDP Group into TEST mode. The policies are run in a test or sandboxed environment for a period of +time. The test results are passed back to the user. The user may revert the policy set to PASSIVE mode a number of times +and upgrade the policy set during test operation. + +When the user is satisfied with policy set execution and when quality criteria have been reached for the policy set, the +PDP group is set to run in SAFE mode. In this mode, the policies run on the target environment but do not actually +exercise any actions or change any context in the target environment. Again, as in TEST mode, the operator may decide to +revert back to TEST mode or even PASSIVE mode if issues arise with a policy set. + +Finally, when the user is satisfied with policy set execution and when quality criteria have been reached, the PDP group +is set into ACTIVE state and the policy set executes on the target environment. The results of target operation are +reported. The PDP group can be reverted to SAFE, TEST, or even PASSIVE mode at any time if problems arise. 2.3.5.3 Policy Upgrade and Rollback """"""""""""""""""""""""""""""""""" -There are a number of approaches for managing policy upgrade and -rollback. - -The most straightforward approach is to use the approach described in -section 2.2.5.2 for upgrading and rolling back policy sets. In order to -upgrade a policy set, one follows the process in 2.2.5.2 with the new -policy set version. For rollback, one follows the process in section -2.2.5.2 with the older policy set, most probably setting the old policy -set into ACTIVE mode immediately. The advantage of this approach is that -the approach is straightforward. The obvious disadvantage is that the -PDP group is not executing on the target environment while the new -policy set is in PASSIVE, TEST, and SAFE mode. - -A second manner to tackle upgrade and rollback is to use a spare-wheel -approach. An special upgrade PDP group service is set up as a K8S -service in parallel with the active one during the upgrade procedure. -The spare wheel service is used to execute the process described in -section 2.2.5.2. When the time comes to activate the policy set, the -references for the active and spare wheel services are simply swapped. -The advantage of this approach is that the down time during upgrade is -minimized, the spare wheel PDP group can be abandoned at any time -without affecting the in service PDP group, and the upgrade can be -rolled back easily for a period simply by preserving the old service for -a time. The disadvantage is that this approach is more complex than the -first approach. - -A third approach is to have two policy sets running in each PDP, an -active set and a standby set. However such an approach would increase -the complexity of implementation in PDPs significantly. +There are a number of approaches for managing policy upgrade and rollback. + +The most straightforward approach is to use the approach described in section :ref:`policy-rollout` for upgrading and +rolling back policy sets. In order to upgrade a policy set, one follows the process in :ref:`policy-rollout` with the +new policy set version. For rollback, one follows the process in :ref:`policy-rollout` with the older policy set, most +probably setting the old policy set into ACTIVE mode immediately. The advantage of this approach is that the approach is +straightforward. The obvious disadvantage is that the PDP group is not executing on the target environment while the new +policy set is in PASSIVE, TEST, and SAFE mode. + +A second manner to tackle upgrade and rollback is to use a spare-wheel approach. An special upgrade PDP group service is +set up as a K8S service in parallel with the active one during the upgrade procedure. The spare wheel service is used to +execute the process described in :ref:`policy-rollout`. When the time comes to activate the policy set, the references +for the active and spare wheel services are simply swapped. The advantage of this approach is that the down time during +upgrade is minimized, the spare wheel PDP group can be abandoned at any time without affecting the in service PDP group, +and the upgrade can be rolled back easily for a period simply by preserving the old service for a time. The disadvantage +is that this approach is more complex and uses more resources than the first approach. + +A third approach is to have two policy sets running in each PDP, an active set and a standby set. However such an +approach would increase the complexity of implementation in PDPs significantly. 2.3.6 Policy Monitoring ^^^^^^^^^^^^^^^^^^^^^^^ -PDPs provide a periodic report of their status to the PAP. All PDPs -report using a standard reporting format that is extended to provide -information for specific PDP types. PDPs provide at least the -information below: +PDPs provide a periodic report of their status to the PAP. All PDPs report using a standard reporting format that is +extended to provide information for specific PDP types. PDPs provide at least the information below: ===================== =============================================================================== **Field** **Description** @@ -779,39 +622,36 @@ RealTimeInfo Real time information on running policies. 2.3.7 PEP Registration and Enforcement Guidelines ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -In ONAP there are several applications outside the Policy Framework that -enforce policy decisions based on models provided to the Policy -Framework. These applications are considered Policy Enforcement Engines -(PEP) and roles will be provided to those applications using AAF/CADI to -ensure only those applications can make calls to the Policy Decision -API's. Some example PEP's are: DCAE, OOF, and SDNC. +In ONAP there are several applications outside the Policy Framework that enforce policy decisions based on models +provided to the Policy Framework. These applications are considered Policy Enforcement Engines (PEP) and roles will be +provided to those applications using AAF/CADI to ensure only those applications can make calls to the Policy Decision +APIs. Some example PEPs are: DCAE, OOF, and SDNC. -See Section 3.4 of the `Policy Design and API Flow for Model Driven -Control -Loop <file://localhost/display/DW/Policy+Design+and+API+Flow+for+Model+Driven+Control+Loop>`__ +See Section 3.4 of the :ref:`Policy Design and Development <design-label>` for more information on the Decision APIs. 3. APIs Provided by the Policy Framework ======================================== -See the `Policy Design and API Flow for Model Driven Control -Loop <file://localhost/display/DW/Policy+Design+and+API+Flow+for+Model+Driven+Control+Loop>`__ -page. +See the :ref:`Policy Design and Development <design-label>` page. 4. Terminology ============== -================================= ========================================================================================================================================================= +================================= ================================================================================== PAP (Policy Administration Point) A component that administers and manages policies -================================= ========================================================================================================================================================= +================================= ================================================================================== PDP (Policy Deployment Point) A component that executes a policy artifact (One or many?) PDP_<> A specific type of PDP PDP Group A group of PDPs that execute the same set of policies Policy Development The development environment for policies -Policy Type A generic prototype definition of a type of policy in TOSCA, see the `TOSCA Policy Primer <file://localhost/display/DW/TOSCA+Policy+Primer>`__ -Policy An executable policy defined in TOSCA and created using a Policy Type, see the `TOSCA Policy Primer <file://localhost/display/DW/TOSCA+Policy+Primer>`__ -Policy Set A set of policies that are deployed on a PDP group. One and only one Policy Set is deployed on a PDP group -================================= ========================================================================================================================================================= +Policy Type A generic prototype definition of a type of policy in TOSCA, see the + :ref:`TOSCA Policy Primer <tosca-label>` +Policy An executable policy defined in TOSCA and created using a Policy Type, see the + :ref:`TOSCA Policy Primer <tosca-label>` +Policy Set A set of policies that are deployed on a PDP group. One and only one Policy Set is + deployed on a PDP group +================================= ================================================================================== End of Document diff --git a/docs/architecture/images/DownloadPoliciesToPDP.svg b/docs/architecture/images/DownloadPoliciesToPDP.svg new file mode 100644 index 00000000..26993eb9 --- /dev/null +++ b/docs/architecture/images/DownloadPoliciesToPDP.svg @@ -0,0 +1,55 @@ +<?xml version="1.0" encoding="UTF-8" standalone="no"?><svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" contentScriptType="application/ecmascript" contentStyleType="text/css" height="888px" preserveAspectRatio="none" style="width:736px;height:888px;" version="1.1" viewBox="0 0 736 888" width="736px" zoomAndPan="magnify"><defs><filter height="300%" id="f1p7etc9mad84n" width="300%" x="-1" y="-1"><feGaussianBlur result="blurOut" stdDeviation="2.0"/><feColorMatrix in="blurOut" result="blurOut2" type="matrix" values="0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 .4 0"/><feOffset dx="4.0" dy="4.0" in="blurOut2" result="blurOut3"/><feBlend in="SourceGraphic" in2="blurOut3" mode="normal"/></filter></defs><g><text fill="#000000" font-family="sans-serif" font-size="14" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="200" x="269.5" y="22.9951">Download Policies to PDP</text><rect fill="#FFFFFF" filter="url(#f1p7etc9mad84n)" height="28" style="stroke: #A80036; stroke-width: 1.0;" width="10" x="359" y="289.0625"/><rect fill="#FFFFFF" filter="url(#f1p7etc9mad84n)" height="35.1328" style="stroke: #A80036; stroke-width: 1.0;" width="10" x="612" y="382.3281"/><rect fill="#FFFFFF" filter="url(#f1p7etc9mad84n)" height="90.2031" style="stroke: #000000; stroke-width: 2.0;" width="637.5" x="13" y="133.5938"/><rect fill="#FFFFFF" height="43.9375" style="stroke: none; stroke-width: 1.0;" width="637.5" x="13" y="179.8594"/><rect fill="#FFFFFF" filter="url(#f1p7etc9mad84n)" height="315.3359" style="stroke: #000000; stroke-width: 2.0;" width="319" x="331.5" y="439.4609"/><rect fill="#FFFFFF" height="104.3359" style="stroke: none; stroke-width: 1.0;" width="319" x="331.5" y="546.125"/><rect fill="#FFFFFF" height="104.3359" style="stroke: none; stroke-width: 1.0;" width="319" x="331.5" y="650.4609"/><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 5.0,5.0;" x1="42" x2="42" y1="116.5938" y2="800.9297"/><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 5.0,5.0;" x1="104" x2="104" y1="116.5938" y2="800.9297"/><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 5.0,5.0;" x1="363.5" x2="363.5" y1="116.5938" y2="800.9297"/><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 5.0,5.0;" x1="541" x2="541" y1="116.5938" y2="800.9297"/><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 5.0,5.0;" x1="616.5" x2="616.5" y1="116.5938" y2="800.9297"/><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacingAndGlyphs" textLength="32" x="23" y="113.292">User</text><ellipse cx="42" cy="43.2969" fill="#FEFECE" filter="url(#f1p7etc9mad84n)" rx="8" ry="8" style="stroke: #A80036; stroke-width: 2.0;"/><path d="M42,51.2969 L42,78.2969 M29,59.2969 L55,59.2969 M42,78.2969 L29,93.2969 M42,78.2969 L55,93.2969 " fill="none" filter="url(#f1p7etc9mad84n)" style="stroke: #A80036; stroke-width: 2.0;"/><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacingAndGlyphs" textLength="32" x="23" y="812.9248">User</text><ellipse cx="42" cy="826.2266" fill="#FEFECE" filter="url(#f1p7etc9mad84n)" rx="8" ry="8" style="stroke: #A80036; stroke-width: 2.0;"/><path d="M42,834.2266 L42,861.2266 M29,842.2266 L55,842.2266 M42,861.2266 L29,876.2266 M42,861.2266 L55,876.2266 " fill="none" filter="url(#f1p7etc9mad84n)" style="stroke: #A80036; stroke-width: 2.0;"/><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacingAndGlyphs" textLength="60" x="71" y="113.292">PolicyDB</text><path d="M86,64.2969 C86,54.2969 104,54.2969 104,54.2969 C104,54.2969 122,54.2969 122,64.2969 L122,90.2969 C122,100.2969 104,100.2969 104,100.2969 C104,100.2969 86,100.2969 86,90.2969 L86,64.2969 " fill="#FEFECE" filter="url(#f1p7etc9mad84n)" style="stroke: #000000; stroke-width: 1.5;"/><path d="M86,64.2969 C86,74.2969 104,74.2969 104,74.2969 C104,74.2969 122,74.2969 122,64.2969 " fill="none" style="stroke: #000000; stroke-width: 1.5;"/><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacingAndGlyphs" textLength="60" x="71" y="812.9248">PolicyDB</text><path d="M86,826.2266 C86,816.2266 104,816.2266 104,816.2266 C104,816.2266 122,816.2266 122,826.2266 L122,852.2266 C122,862.2266 104,862.2266 104,862.2266 C104,862.2266 86,862.2266 86,852.2266 L86,826.2266 " fill="#FEFECE" filter="url(#f1p7etc9mad84n)" style="stroke: #000000; stroke-width: 1.5;"/><path d="M86,826.2266 C86,836.2266 104,836.2266 104,836.2266 C104,836.2266 122,836.2266 122,826.2266 " fill="none" style="stroke: #000000; stroke-width: 1.5;"/><rect fill="#FEFECE" filter="url(#f1p7etc9mad84n)" height="30.2969" style="stroke: #A80036; stroke-width: 1.5;" width="41" x="341.5" y="81.2969"/><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacingAndGlyphs" textLength="27" x="348.5" y="101.292">PAP</text><rect fill="#FEFECE" filter="url(#f1p7etc9mad84n)" height="30.2969" style="stroke: #A80036; stroke-width: 1.5;" width="41" x="341.5" y="799.9297"/><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacingAndGlyphs" textLength="27" x="348.5" y="819.9248">PAP</text><rect fill="#FEFECE" filter="url(#f1p7etc9mad84n)" height="30.2969" style="stroke: #A80036; stroke-width: 1.5;" width="62" x="508" y="81.2969"/><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacingAndGlyphs" textLength="48" x="515" y="101.292">DMaaP</text><rect fill="#FEFECE" filter="url(#f1p7etc9mad84n)" height="30.2969" style="stroke: #A80036; stroke-width: 1.5;" width="62" x="508" y="799.9297"/><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacingAndGlyphs" textLength="48" x="515" y="819.9248">DMaaP</text><rect fill="#FEFECE" filter="url(#f1p7etc9mad84n)" height="30.2969" style="stroke: #A80036; stroke-width: 1.5;" width="43" x="593.5" y="81.2969"/><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacingAndGlyphs" textLength="29" x="600.5" y="101.292">PDP</text><rect fill="#FEFECE" filter="url(#f1p7etc9mad84n)" height="30.2969" style="stroke: #A80036; stroke-width: 1.5;" width="43" x="593.5" y="799.9297"/><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacingAndGlyphs" textLength="29" x="600.5" y="819.9248">PDP</text><rect fill="#FFFFFF" filter="url(#f1p7etc9mad84n)" height="28" style="stroke: #A80036; stroke-width: 1.0;" width="10" x="359" y="289.0625"/><rect fill="#FFFFFF" filter="url(#f1p7etc9mad84n)" height="35.1328" style="stroke: #A80036; stroke-width: 1.0;" width="10" x="612" y="382.3281"/><path d="M13,133.5938 L77,133.5938 L77,140.5938 L67,150.5938 L13,150.5938 L13,133.5938 " fill="#EEEEEE" style="stroke: #000000; stroke-width: 1.0;"/><rect fill="none" height="90.2031" style="stroke: #000000; stroke-width: 2.0;" width="637.5" x="13" y="133.5938"/><text fill="#000000" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="19" x="28" y="146.6606">alt</text><text fill="#000000" font-family="sans-serif" font-size="11" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="86" x="92" y="145.8042">[PDP Startup]</text><polygon fill="#A80036" points="375,167.8594,365,171.8594,375,175.8594,371,171.8594" style="stroke: #A80036; stroke-width: 1.0;"/><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 2.0,2.0;" x1="369" x2="616" y1="171.8594" y2="171.8594"/><text fill="#000000" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="9" x="381" y="166.7935">1</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="216" x="394" y="166.7935">Send Status (initial status) to PAP</text><line style="stroke: #000000; stroke-width: 1.0; stroke-dasharray: 2.0,2.0;" x1="13" x2="650.5" y1="180.8594" y2="180.8594"/><text fill="#000000" font-family="sans-serif" font-size="11" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="178" x="18" y="191.0698">[Update Request from User]</text><polygon fill="#A80036" points="352,211.7969,362,215.7969,352,219.7969,356,215.7969" style="stroke: #A80036; stroke-width: 1.0;"/><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 2.0,2.0;" x1="42" x2="358" y1="215.7969" y2="215.7969"/><text fill="#000000" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="9" x="49" y="210.731">2</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="148" x="62" y="210.731">Update Policies on PDP</text><polygon fill="#A80036" points="115,247.9297,105,251.9297,115,255.9297,111,251.9297" style="stroke: #A80036; stroke-width: 1.0;"/><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 2.0,2.0;" x1="109" x2="363" y1="251.9297" y2="251.9297"/><text fill="#000000" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="9" x="121" y="246.8638">3</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="223" x="134" y="246.8638">Read PDP metadata and Policy Set</text><line style="stroke: #A80036; stroke-width: 1.0;" x1="369" x2="411" y1="281.0625" y2="281.0625"/><line style="stroke: #A80036; stroke-width: 1.0;" x1="411" x2="411" y1="281.0625" y2="294.0625"/><line style="stroke: #A80036; stroke-width: 1.0;" x1="370" x2="411" y1="294.0625" y2="294.0625"/><polygon fill="#A80036" points="380,290.0625,370,294.0625,380,298.0625,376,294.0625" style="stroke: #A80036; stroke-width: 1.0;"/><text fill="#000000" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="9" x="376" y="275.9966">4</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="150" x="389" y="275.9966">Prepare for PDP update</text><polygon fill="#A80036" points="605,349.1953,615,353.1953,605,357.1953,609,353.1953" style="stroke: #A80036; stroke-width: 1.0;"/><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 2.0,2.0;" x1="364" x2="611" y1="353.1953" y2="353.1953"/><text fill="#000000" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="9" x="371" y="348.1294">5</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="171" x="384" y="348.1294">Set PDP mode as PASSIVE</text><polygon fill="#A80036" points="600,378.3281,610,382.3281,600,386.3281,604,382.3281" style="stroke: #A80036; stroke-width: 1.0;"/><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 2.0,2.0;" x1="364" x2="606" y1="382.3281" y2="382.3281"/><text fill="#000000" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="9" x="371" y="377.2622">6</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="216" x="384" y="377.2622">Transfer Policy Set Policies to PDP</text><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 2.0,2.0;" x1="622" x2="664" y1="416.4609" y2="416.4609"/><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 2.0,2.0;" x1="664" x2="664" y1="416.4609" y2="429.4609"/><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 2.0,2.0;" x1="617" x2="664" y1="429.4609" y2="429.4609"/><polygon fill="#A80036" points="627,425.4609,617,429.4609,627,433.4609,623,429.4609" style="stroke: #A80036; stroke-width: 1.0;"/><text fill="#000000" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="9" x="629" y="411.395">7</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="82" x="642" y="411.395">Load Policies</text><path d="M331.5,439.4609 L395.5,439.4609 L395.5,446.4609 L385.5,456.4609 L331.5,456.4609 L331.5,439.4609 " fill="#EEEEEE" style="stroke: #000000; stroke-width: 1.0;"/><rect fill="none" height="315.3359" style="stroke: #000000; stroke-width: 2.0;" width="319" x="331.5" y="439.4609"/><text fill="#000000" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="19" x="346.5" y="452.5278">alt</text><text fill="#000000" font-family="sans-serif" font-size="11" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="190" x="410.5" y="451.6714">[PDP Mode should be ACTIVE]</text><polygon fill="#A80036" points="605,473.7266,615,477.7266,605,481.7266,609,477.7266" style="stroke: #A80036; stroke-width: 1.0;"/><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 2.0,2.0;" x1="364" x2="611" y1="477.7266" y2="477.7266"/><text fill="#000000" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="9" x="371" y="472.6606">8</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="161" x="384" y="472.6606">Set PDP mode as ACTIVE</text><rect fill="#FFFFFF" filter="url(#f1p7etc9mad84n)" height="55.3984" style="stroke: #000000; stroke-width: 2.0;" width="125" x="590.5" y="485.7266"/><polygon fill="#EEEEEE" points="590.5,485.7266,656.5,485.7266,656.5,492.7266,646.5,502.7266,590.5,502.7266,590.5,485.7266" style="stroke: #000000; stroke-width: 2.0;"/><text fill="#000000" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="21" x="603.5" y="499.7935">ref</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="117" x="596.5" y="518.7935">Execute Policies in</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="84" x="596.5" y="533.9263">ACTIVE Mode</text><line style="stroke: #000000; stroke-width: 1.0; stroke-dasharray: 2.0,2.0;" x1="331.5" x2="650.5" y1="547.125" y2="547.125"/><text fill="#000000" font-family="sans-serif" font-size="11" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="177" x="336.5" y="557.3354">[PDP Mode should be SAFE]</text><polygon fill="#A80036" points="605,578.0625,615,582.0625,605,586.0625,609,582.0625" style="stroke: #A80036; stroke-width: 1.0;"/><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 2.0,2.0;" x1="364" x2="611" y1="582.0625" y2="582.0625"/><text fill="#000000" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="9" x="371" y="576.9966">9</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="158" x="384" y="576.9966">Set PDP mode as SAFE r</text><rect fill="#FFFFFF" filter="url(#f1p7etc9mad84n)" height="55.3984" style="stroke: #000000; stroke-width: 2.0;" width="125" x="590.5" y="590.0625"/><polygon fill="#EEEEEE" points="590.5,590.0625,656.5,590.0625,656.5,597.0625,646.5,607.0625,590.5,607.0625,590.5,590.0625" style="stroke: #000000; stroke-width: 2.0;"/><text fill="#000000" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="21" x="603.5" y="604.1294">ref</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="117" x="596.5" y="623.1294">Execute Policies in</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="72" x="596.5" y="638.2622">SAFE Mode</text><line style="stroke: #000000; stroke-width: 1.0; stroke-dasharray: 2.0,2.0;" x1="331.5" x2="650.5" y1="651.4609" y2="651.4609"/><text fill="#000000" font-family="sans-serif" font-size="11" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="177" x="336.5" y="661.6714">[PDP Mode should be TEST]</text><polygon fill="#A80036" points="605,682.3984,615,686.3984,605,690.3984,609,686.3984" style="stroke: #A80036; stroke-width: 1.0;"/><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 2.0,2.0;" x1="364" x2="611" y1="686.3984" y2="686.3984"/><text fill="#000000" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="18" x="371" y="681.3325">10</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="147" x="393" y="681.3325">Set PDP mode as TEST</text><rect fill="#FFFFFF" filter="url(#f1p7etc9mad84n)" height="55.3984" style="stroke: #000000; stroke-width: 2.0;" width="125" x="590.5" y="694.3984"/><polygon fill="#EEEEEE" points="590.5,694.3984,656.5,694.3984,656.5,701.3984,646.5,711.3984,590.5,711.3984,590.5,694.3984" style="stroke: #000000; stroke-width: 2.0;"/><text fill="#000000" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="21" x="603.5" y="708.4653">ref</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="117" x="596.5" y="727.4653">Execute Policies in</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="70" x="596.5" y="742.5981">TEST Mode</text><polygon fill="#A80036" points="115,778.9297,105,782.9297,115,786.9297,111,782.9297" style="stroke: #A80036; stroke-width: 1.0;"/><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 2.0,2.0;" x1="109" x2="363" y1="782.9297" y2="782.9297"/><text fill="#000000" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="18" x="121" y="777.8638">11</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="144" x="143" y="777.8638">Update PDP metadata</text><!-- +@startuml
+title Download Policies to PDP
+
+actor User
+database PolicyDB
+participant PAP
+participant DMaaP
+participant PDP
+
+autonumber
+
+alt PDP Startup
+ PDP - -> PAP: Send Status (initial status) to PAP
+else Update Request from User
+ User - -> PAP : Update Policies on PDP
+end
+
+PAP - -> PolicyDB: Read PDP metadata and Policy Set
+PAP -> PAP: Prepare for PDP update
+activate PAP
+deactivate PAP
+
+PAP - -> PDP: Set PDP mode as PASSIVE
+
+PAP - -> PDP: Transfer Policy Set Policies to PDP
+
+activate PDP
+PDP - -> PDP: Load Policies
+deactivate PDP
+
+alt PDP Mode should be ACTIVE
+ PAP - -> PDP : Set PDP mode as ACTIVE
+ ref over PDP: Execute Policies in\nACTIVE Mode
+else PDP Mode should be SAFE
+ PAP - -> PDP : Set PDP mode as SAFE
+ ref over PDP: Execute Policies in\nSAFE Mode
+else PDP Mode should be TEST
+ PAP - -> PDP : Set PDP mode as TEST
+ ref over PDP: Execute Policies in\nTEST Mode
+end
+
+PAP - -> PolicyDB: Update PDP metadata
+@enduml
+ +PlantUML version 1.2019.07beta1(Unknown compile time) +(GPL source distribution) +Java Runtime: Java(TM) SE Runtime Environment +JVM: Java HotSpot(TM) 64-Bit Server VM +Java Version: 1.7.0_25-b15 +Operating System: Linux +Default Encoding: UTF-8 +Language: en +Country: US +--></g></svg>
\ No newline at end of file diff --git a/docs/architecture/images/ModelDrivenPolicyDesign.svg b/docs/architecture/images/ModelDrivenPolicyDesign.svg new file mode 100644 index 00000000..7a42f346 --- /dev/null +++ b/docs/architecture/images/ModelDrivenPolicyDesign.svg @@ -0,0 +1,46 @@ +<?xml version="1.0" encoding="UTF-8" standalone="no"?><svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" contentScriptType="application/ecmascript" contentStyleType="text/css" height="600px" preserveAspectRatio="none" style="width:879px;height:600px;" version="1.1" viewBox="0 0 879 600" width="879px" zoomAndPan="magnify"><defs><filter height="300%" id="f1tpd2l713nu6j" width="300%" x="-1" y="-1"><feGaussianBlur result="blurOut" stdDeviation="2.0"/><feColorMatrix in="blurOut" result="blurOut2" type="matrix" values="0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 .4 0"/><feOffset dx="4.0" dy="4.0" in="blurOut2" result="blurOut3"/><feBlend in="SourceGraphic" in2="blurOut3" mode="normal"/></filter></defs><g><text fill="#000000" font-family="sans-serif" font-size="14" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="213" x="334" y="22.9951">Model Driven Policy Design</text><rect fill="#ADD8E6" height="555.3125" style="stroke: #A80036; stroke-width: 1.0;" width="443" x="419" y="34.2969"/><text fill="#000000" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="94" x="593.5" y="46.3638">PolicyDesign</text><rect fill="#FFFFFF" filter="url(#f1tpd2l713nu6j)" height="153.7969" style="stroke: #A80036; stroke-width: 1.0;" width="10" x="486" y="334.0859"/><rect fill="#FFFFFF" filter="url(#f1tpd2l713nu6j)" height="76.5313" style="stroke: #000000; stroke-width: 2.0;" width="455" x="413" y="354.0859"/><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 5.0,5.0;" x1="32" x2="32" y1="105.0234" y2="535.0156"/><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 5.0,5.0;" x1="255" x2="255" y1="105.0234" y2="535.0156"/><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 5.0,5.0;" x1="491" x2="491" y1="105.0234" y2="535.0156"/><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 5.0,5.0;" x1="805" x2="805" y1="105.0234" y2="535.0156"/><rect fill="#FEFECE" filter="url(#f1tpd2l713nu6j)" height="30.2969" style="stroke: #A80036; stroke-width: 1.5;" width="44" x="8" y="69.7266"/><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacingAndGlyphs" textLength="30" x="15" y="89.7217">SDC</text><rect fill="#FEFECE" filter="url(#f1tpd2l713nu6j)" height="30.2969" style="stroke: #A80036; stroke-width: 1.5;" width="44" x="8" y="534.0156"/><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacingAndGlyphs" textLength="30" x="15" y="554.0107">SDC</text><rect fill="#FEFECE" filter="url(#f1tpd2l713nu6j)" height="30.2969" style="stroke: #A80036; stroke-width: 1.5;" width="62" x="222" y="69.7266"/><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacingAndGlyphs" textLength="48" x="229" y="89.7217">DMaaP</text><rect fill="#FEFECE" filter="url(#f1tpd2l713nu6j)" height="30.2969" style="stroke: #A80036; stroke-width: 1.5;" width="62" x="222" y="534.0156"/><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacingAndGlyphs" textLength="48" x="229" y="554.0107">DMaaP</text><rect fill="#FEFECE" filter="url(#f1tpd2l713nu6j)" height="46.5938" style="stroke: #A80036; stroke-width: 1.5;" width="132" x="423" y="53.4297"/><text fill="#000000" font-family="sans-serif" font-size="14" font-style="italic" lengthAdjust="spacingAndGlyphs" textLength="78" x="450" y="74.4297">«API_User»</text><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacingAndGlyphs" textLength="118" x="430" y="90.7266">PolicyDistribution</text><rect fill="#FEFECE" filter="url(#f1tpd2l713nu6j)" height="46.5938" style="stroke: #A80036; stroke-width: 1.5;" width="132" x="423" y="534.0156"/><text fill="#000000" font-family="sans-serif" font-size="14" font-style="italic" lengthAdjust="spacingAndGlyphs" textLength="78" x="450" y="555.0156">«API_User»</text><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacingAndGlyphs" textLength="118" x="430" y="571.3125">PolicyDistribution</text><rect fill="#FEFECE" filter="url(#f1tpd2l713nu6j)" height="30.2969" style="stroke: #A80036; stroke-width: 1.5;" width="102" x="752" y="69.7266"/><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacingAndGlyphs" textLength="88" x="759" y="89.7217">PolicyDesign</text><rect fill="#FEFECE" filter="url(#f1tpd2l713nu6j)" height="30.2969" style="stroke: #A80036; stroke-width: 1.5;" width="102" x="752" y="534.0156"/><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacingAndGlyphs" textLength="88" x="759" y="554.0107">PolicyDesign</text><rect fill="#FFFFFF" filter="url(#f1tpd2l713nu6j)" height="153.7969" style="stroke: #A80036; stroke-width: 1.0;" width="10" x="486" y="334.0859"/><polygon fill="#A80036" points="266,147.2891,256,151.2891,266,155.2891,262,151.2891" style="stroke: #A80036; stroke-width: 1.0;"/><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 2.0,2.0;" x1="260" x2="490" y1="151.2891" y2="151.2891"/><text fill="#000000" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="9" x="272" y="138.6567">1</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="199" x="285" y="131.0903">Subscribe for SDC Notifications</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="133" x="285" y="146.2231">on Entries of Interest</text><polygon fill="#A80036" points="243,176.4219,253,180.4219,243,184.4219,247,180.4219" style="stroke: #A80036; stroke-width: 1.0;"/><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 2.0,2.0;" x1="32" x2="249" y1="180.4219" y2="180.4219"/><text fill="#000000" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="9" x="39" y="175.356">2</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="186" x="52" y="175.356">New Entry of Interest: EntityA</text><polygon fill="#A80036" points="479,205.5547,489,209.5547,479,213.5547,483,209.5547" style="stroke: #A80036; stroke-width: 1.0;"/><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 2.0,2.0;" x1="255" x2="485" y1="209.5547" y2="209.5547"/><text fill="#000000" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="9" x="262" y="204.4888">3</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="186" x="275" y="204.4888">New Entry of Interest: EntityA</text><polygon fill="#A80036" points="43,234.6875,33,238.6875,43,242.6875,39,238.6875" style="stroke: #A80036; stroke-width: 1.0;"/><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 2.0,2.0;" x1="37" x2="490" y1="238.6875" y2="238.6875"/><text fill="#000000" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="9" x="49" y="233.6216">4</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="412" x="62" y="233.6216">Download CSAR for EntityA that holds TOSCA Policy Specification</text><polygon fill="#A80036" points="793,263.8203,803,267.8203,793,271.8203,797,267.8203" style="stroke: #A80036; stroke-width: 1.0;"/><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 2.0,2.0;" x1="491" x2="799" y1="267.8203" y2="267.8203"/><text fill="#000000" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="9" x="498" y="262.7544">5</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="131" x="511" y="262.7544">Get Policy Reference</text><polygon fill="#A80036" points="502,292.9531,492,296.9531,502,300.9531,498,296.9531" style="stroke: #A80036; stroke-width: 1.0;"/><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 2.0,2.0;" x1="496" x2="804" y1="296.9531" y2="296.9531"/><text fill="#000000" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="9" x="508" y="291.8872">6</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="243" x="521" y="291.8872">Return Policy Reference and Metadata</text><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 2.0,2.0;" x1="491" x2="538" y1="321.0859" y2="321.0859"/><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 2.0,2.0;" x1="538" x2="538" y1="321.0859" y2="334.0859"/><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 2.0,2.0;" x1="497" x2="538" y1="334.0859" y2="334.0859"/><polygon fill="#A80036" points="507,330.0859,497,334.0859,507,338.0859,503,334.0859" style="stroke: #A80036; stroke-width: 1.0;"/><text fill="#000000" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="9" x="503" y="316.02">7</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="287" x="516" y="316.02">Create Policy Editing and Generation Session</text><path d="M413,354.0859 L490,354.0859 L490,361.0859 L480,371.0859 L413,371.0859 L413,354.0859 " fill="#EEEEEE" style="stroke: #000000; stroke-width: 1.0;"/><rect fill="none" height="76.5313" style="stroke: #000000; stroke-width: 2.0;" width="455" x="413" y="354.0859"/><text fill="#000000" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="32" x="428" y="367.1528">loop</text><polygon fill="#A80036" points="793,418.6172,803,422.6172,793,426.6172,797,422.6172" style="stroke: #A80036; stroke-width: 1.0;"/><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 2.0,2.0;" x1="496" x2="799" y1="422.6172" y2="422.6172"/><text fill="#000000" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="9" x="503" y="402.4185">8</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="199" x="516" y="387.2856">Use Policy Type specification to</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="148" x="516" y="402.4185">read Policy Parameters</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="215" x="516" y="417.5513">from TOSCA specification in CSAR</text><polygon fill="#A80036" points="793,454.75,803,458.75,793,462.75,797,458.75" style="stroke: #A80036; stroke-width: 1.0;"/><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 2.0,2.0;" x1="496" x2="799" y1="458.75" y2="458.75"/><text fill="#000000" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="9" x="503" y="453.6841">9</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="83" x="516" y="453.6841">Create Policy</text><polygon fill="#A80036" points="502,483.8828,492,487.8828,502,491.8828,498,487.8828" style="stroke: #A80036; stroke-width: 1.0;"/><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 2.0,2.0;" x1="496" x2="804" y1="487.8828" y2="487.8828"/><text fill="#000000" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="18" x="508" y="482.8169">10</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="137" x="530" y="482.8169">Policy Creation Result</text><polygon fill="#A80036" points="43,513.0156,33,517.0156,43,521.0156,39,517.0156" style="stroke: #A80036; stroke-width: 1.0;"/><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 2.0,2.0;" x1="37" x2="490" y1="517.0156" y2="517.0156"/><text fill="#000000" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="18" x="49" y="511.9497">11</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="190" x="71" y="511.9497">Notify SDC of operation result</text><!-- +@startuml
+title Model Driven Policy Design
+
+participant SDC
+participant DMaaP
+
+box "PolicyDesign" #LightBlue
+ participant PolicyDistribution << API_User >>
+ participant PolicyDesign
+end box
+
+autonumber
+
+PolicyDistribution - -> DMaaP : Subscribe for SDC Notifications\non Entries of Interest
+SDC - -> DMaaP : New Entry of Interest: EntityA
+DMaaP - -> PolicyDistribution : New Entry of Interest: EntityA
+
+PolicyDistribution - -> SDC : Download CSAR for EntityA that holds TOSCA Policy Specification
+
+PolicyDistribution - -> PolicyDesign : Get Policy Reference
+PolicyDesign - -> PolicyDistribution : Return Policy Reference and Metadata
+PolicyDistribution - -> PolicyDistribution : Create Policy Editing and Generation Session
+
+activate PolicyDistribution
+loop
+ PolicyDistribution - -> PolicyDesign : Use Policy Type specification to\nread Policy Parameters\nfrom TOSCA specification in CSAR
+end
+
+PolicyDistribution - -> PolicyDesign : Create Policy
+PolicyDesign - -> PolicyDistribution : Policy Creation Result
+deactivate PolicyDistribution
+
+PolicyDistribution - -> SDC : Notify SDC of operation result
+@enduml
+ +PlantUML version 1.2019.07beta1(Unknown compile time) +(GPL source distribution) +Java Runtime: Java(TM) SE Runtime Environment +JVM: Java HotSpot(TM) 64-Bit Server VM +Java Version: 1.7.0_25-b15 +Operating System: Linux +Default Encoding: UTF-8 +Language: en +Country: US +--></g></svg>
\ No newline at end of file diff --git a/docs/architecture/images/PAPStartStop.svg b/docs/architecture/images/PAPStartStop.svg new file mode 100644 index 00000000..817b5857 --- /dev/null +++ b/docs/architecture/images/PAPStartStop.svg @@ -0,0 +1,34 @@ +<?xml version="1.0" encoding="UTF-8" standalone="no"?><svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" contentScriptType="application/ecmascript" contentStyleType="text/css" height="501px" preserveAspectRatio="none" style="width:382px;height:501px;" version="1.1" viewBox="0 0 382 501" width="382px" zoomAndPan="magnify"><defs><filter height="300%" id="f1djzk8zozdiog" width="300%" x="-1" y="-1"><feGaussianBlur result="blurOut" stdDeviation="2.0"/><feColorMatrix in="blurOut" result="blurOut2" type="matrix" values="0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 .4 0"/><feOffset dx="4.0" dy="4.0" in="blurOut2" result="blurOut3"/><feBlend in="SourceGraphic" in2="blurOut3" mode="normal"/></filter></defs><g><text fill="#000000" font-family="sans-serif" font-size="14" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="213" x="85.75" y="22.9951">PAP Startup and Shutdown</text><rect fill="#FFFFFF" filter="url(#f1djzk8zozdiog)" height="28" style="stroke: #A80036; stroke-width: 1.0;" width="10" x="123.5" y="192.9922"/><rect fill="#FFFFFF" filter="url(#f1djzk8zozdiog)" height="168.1953" style="stroke: #000000; stroke-width: 2.0;" width="153" x="96" y="242.9922"/><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 5.0,5.0;" x1="30" x2="30" y1="95.5938" y2="428.1875"/><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 5.0,5.0;" x1="128" x2="128" y1="95.5938" y2="428.1875"/><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 5.0,5.0;" x1="343.5" x2="343.5" y1="95.5938" y2="428.1875"/><rect fill="#FEFECE" filter="url(#f1djzk8zozdiog)" height="30.2969" style="stroke: #A80036; stroke-width: 1.5;" width="41" x="8" y="60.2969"/><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacingAndGlyphs" textLength="27" x="15" y="80.292">K8S</text><rect fill="#FEFECE" filter="url(#f1djzk8zozdiog)" height="30.2969" style="stroke: #A80036; stroke-width: 1.5;" width="41" x="8" y="427.1875"/><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacingAndGlyphs" textLength="27" x="15" y="447.1826">K8S</text><rect fill="#FEFECE" filter="url(#f1djzk8zozdiog)" height="30.2969" style="stroke: #A80036; stroke-width: 1.5;" width="41" x="106" y="60.2969"/><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacingAndGlyphs" textLength="27" x="113" y="80.292">PAP</text><rect fill="#FEFECE" filter="url(#f1djzk8zozdiog)" height="30.2969" style="stroke: #A80036; stroke-width: 1.5;" width="41" x="106" y="427.1875"/><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacingAndGlyphs" textLength="27" x="113" y="447.1826">PAP</text><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacingAndGlyphs" textLength="60" x="310.5" y="92.292">PolicyDB</text><path d="M325.5,43.2969 C325.5,33.2969 343.5,33.2969 343.5,33.2969 C343.5,33.2969 361.5,33.2969 361.5,43.2969 L361.5,69.2969 C361.5,79.2969 343.5,79.2969 343.5,79.2969 C343.5,79.2969 325.5,79.2969 325.5,69.2969 L325.5,43.2969 " fill="#FEFECE" filter="url(#f1djzk8zozdiog)" style="stroke: #000000; stroke-width: 1.5;"/><path d="M325.5,43.2969 C325.5,53.2969 343.5,53.2969 343.5,53.2969 C343.5,53.2969 361.5,53.2969 361.5,43.2969 " fill="none" style="stroke: #000000; stroke-width: 1.5;"/><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacingAndGlyphs" textLength="60" x="310.5" y="440.1826">PolicyDB</text><path d="M325.5,453.4844 C325.5,443.4844 343.5,443.4844 343.5,443.4844 C343.5,443.4844 361.5,443.4844 361.5,453.4844 L361.5,479.4844 C361.5,489.4844 343.5,489.4844 343.5,489.4844 C343.5,489.4844 325.5,489.4844 325.5,479.4844 L325.5,453.4844 " fill="#FEFECE" filter="url(#f1djzk8zozdiog)" style="stroke: #000000; stroke-width: 1.5;"/><path d="M325.5,453.4844 C325.5,463.4844 343.5,463.4844 343.5,463.4844 C343.5,463.4844 361.5,463.4844 361.5,453.4844 " fill="none" style="stroke: #000000; stroke-width: 1.5;"/><rect fill="#FFFFFF" filter="url(#f1djzk8zozdiog)" height="28" style="stroke: #A80036; stroke-width: 1.0;" width="10" x="123.5" y="192.9922"/><polygon fill="#A80036" points="116.5,122.7266,126.5,126.7266,116.5,130.7266,120.5,126.7266" style="stroke: #A80036; stroke-width: 1.0;"/><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 2.0,2.0;" x1="30.5" x2="122.5" y1="126.7266" y2="126.7266"/><text fill="#000000" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="9" x="37.5" y="121.6606">1</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="61" x="50.5" y="121.6606">Start PAP</text><polygon fill="#A80036" points="331.5,151.8594,341.5,155.8594,331.5,159.8594,335.5,155.8594" style="stroke: #A80036; stroke-width: 1.0;"/><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 2.0,2.0;" x1="128.5" x2="337.5" y1="155.8594" y2="155.8594"/><text fill="#000000" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="9" x="135.5" y="150.7935">2</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="104" x="148.5" y="150.7935">Read Initial Data</text><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 2.0,2.0;" x1="133.5" x2="175.5" y1="184.9922" y2="184.9922"/><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 2.0,2.0;" x1="175.5" x2="175.5" y1="184.9922" y2="197.9922"/><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 2.0,2.0;" x1="134.5" x2="175.5" y1="197.9922" y2="197.9922"/><polygon fill="#A80036" points="144.5,193.9922,134.5,197.9922,144.5,201.9922,140.5,197.9922" style="stroke: #A80036; stroke-width: 1.0;"/><text fill="#000000" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="9" x="140.5" y="179.9263">3</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="188" x="153.5" y="179.9263">Initialize Policy Administration</text><path d="M96,242.9922 L173,242.9922 L173,249.9922 L163,259.9922 L96,259.9922 L96,242.9922 " fill="#EEEEEE" style="stroke: #000000; stroke-width: 1.0;"/><rect fill="none" height="168.1953" style="stroke: #000000; stroke-width: 2.0;" width="153" x="96" y="242.9922"/><text fill="#000000" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="32" x="111" y="256.0591">loop</text><text fill="#000000" font-family="sans-serif" font-size="11" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="56" x="188" y="255.2026">[forever]</text><rect fill="#FFFFFF" filter="url(#f1djzk8zozdiog)" height="70.5313" style="stroke: #000000; stroke-width: 2.0;" width="108" x="103" y="260.125"/><polygon fill="#EEEEEE" points="103,260.125,169,260.125,169,267.125,159,277.125,103,277.125,103,260.125" style="stroke: #000000; stroke-width: 2.0;"/><text fill="#000000" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="21" x="116" y="274.1919">ref</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="76" x="109" y="293.1919">Wait for and</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="75" x="109" y="308.3247">Handle PDP</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="100" x="109" y="323.4575">Status Updates</text><rect fill="#FFFFFF" filter="url(#f1djzk8zozdiog)" height="70.5313" style="stroke: #000000; stroke-width: 2.0;" width="112" x="103" y="335.6563"/><polygon fill="#EEEEEE" points="103,335.6563,169,335.6563,169,342.6563,159,352.6563,103,352.6563,103,335.6563" style="stroke: #000000; stroke-width: 2.0;"/><text fill="#000000" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="21" x="116" y="349.7231">ref</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="76" x="109" y="368.7231">Wait for and</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="45" x="109" y="383.856">Handle</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="104" x="109" y="398.9888">Admin Requests</text><!-- +@startuml
+title PAP Startup and Shutdown
+
+participant K8S
+participant PAP
+database PolicyDB
+
+autonumber
+
+K8S - -> PAP : Start PAP
+
+PAP - -> PolicyDB : Read Initial Data
+PAP - -> PAP : Initialize Policy Administration
+
+activate PAP
+deactivate PAP
+
+loop forever
+ ref over PAP: Wait for and\nHandle PDP\nStatus Updates
+ ref over PAP: Wait for and\nHandle\nAdmin Requests
+end
+@enduml
+ +PlantUML version 1.2019.07beta1(Unknown compile time) +(GPL source distribution) +Java Runtime: Java(TM) SE Runtime Environment +JVM: Java HotSpot(TM) 64-Bit Server VM +Java Version: 1.7.0_25-b15 +Operating System: Linux +Default Encoding: UTF-8 +Language: en +Country: US +--></g></svg>
\ No newline at end of file diff --git a/docs/architecture/images/PDPStartStop.svg b/docs/architecture/images/PDPStartStop.svg new file mode 100644 index 00000000..c19c8c31 --- /dev/null +++ b/docs/architecture/images/PDPStartStop.svg @@ -0,0 +1,32 @@ +<?xml version="1.0" encoding="UTF-8" standalone="no"?><svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" contentScriptType="application/ecmascript" contentStyleType="text/css" height="276px" preserveAspectRatio="none" style="width:426px;height:276px;" version="1.1" viewBox="0 0 426 276" width="426px" zoomAndPan="magnify"><defs><filter height="300%" id="fofq1pac5scpv" width="300%" x="-1" y="-1"><feGaussianBlur result="blurOut" stdDeviation="2.0"/><feColorMatrix in="blurOut" result="blurOut2" type="matrix" values="0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 .4 0"/><feOffset dx="4.0" dy="4.0" in="blurOut2" result="blurOut3"/><feBlend in="SourceGraphic" in2="blurOut3" mode="normal"/></filter></defs><g><text fill="#000000" font-family="sans-serif" font-size="14" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="213" x="107.5" y="22.9951">PDP Startup and Shutdown</text><rect fill="#FFFFFF" filter="url(#fofq1pac5scpv)" height="46.2656" style="stroke: #000000; stroke-width: 2.0;" width="319" x="96" y="172.9922"/><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 5.0,5.0;" x1="30" x2="30" y1="68.5938" y2="236.2578"/><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 5.0,5.0;" x1="129" x2="129" y1="68.5938" y2="236.2578"/><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 5.0,5.0;" x1="196" x2="196" y1="68.5938" y2="236.2578"/><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 5.0,5.0;" x1="382" x2="382" y1="68.5938" y2="236.2578"/><rect fill="#FEFECE" filter="url(#fofq1pac5scpv)" height="30.2969" style="stroke: #A80036; stroke-width: 1.5;" width="41" x="8" y="33.2969"/><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacingAndGlyphs" textLength="27" x="15" y="53.292">K8S</text><rect fill="#FEFECE" filter="url(#fofq1pac5scpv)" height="30.2969" style="stroke: #A80036; stroke-width: 1.5;" width="41" x="8" y="235.2578"/><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacingAndGlyphs" textLength="27" x="15" y="255.2529">K8S</text><rect fill="#FEFECE" filter="url(#fofq1pac5scpv)" height="30.2969" style="stroke: #A80036; stroke-width: 1.5;" width="43" x="106" y="33.2969"/><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacingAndGlyphs" textLength="29" x="113" y="53.292">PDP</text><rect fill="#FEFECE" filter="url(#fofq1pac5scpv)" height="30.2969" style="stroke: #A80036; stroke-width: 1.5;" width="43" x="106" y="235.2578"/><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacingAndGlyphs" textLength="29" x="113" y="255.2529">PDP</text><rect fill="#FEFECE" filter="url(#fofq1pac5scpv)" height="30.2969" style="stroke: #A80036; stroke-width: 1.5;" width="62" x="163" y="33.2969"/><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacingAndGlyphs" textLength="48" x="170" y="53.292">DMaaP</text><rect fill="#FEFECE" filter="url(#fofq1pac5scpv)" height="30.2969" style="stroke: #A80036; stroke-width: 1.5;" width="62" x="163" y="235.2578"/><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacingAndGlyphs" textLength="48" x="170" y="255.2529">DMaaP</text><rect fill="#FEFECE" filter="url(#fofq1pac5scpv)" height="30.2969" style="stroke: #A80036; stroke-width: 1.5;" width="41" x="360" y="33.2969"/><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacingAndGlyphs" textLength="27" x="367" y="53.292">PAP</text><rect fill="#FEFECE" filter="url(#fofq1pac5scpv)" height="30.2969" style="stroke: #A80036; stroke-width: 1.5;" width="41" x="360" y="235.2578"/><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacingAndGlyphs" textLength="27" x="367" y="255.2529">PAP</text><polygon fill="#A80036" points="117.5,95.7266,127.5,99.7266,117.5,103.7266,121.5,99.7266" style="stroke: #A80036; stroke-width: 1.0;"/><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 2.0,2.0;" x1="30.5" x2="123.5" y1="99.7266" y2="99.7266"/><text fill="#000000" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="9" x="37.5" y="94.6606">1</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="62" x="50.5" y="94.6606">Start PDP</text><polygon fill="#A80036" points="370.5,124.8594,380.5,128.8594,370.5,132.8594,374.5,128.8594" style="stroke: #A80036; stroke-width: 1.0;"/><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 2.0,2.0;" x1="129.5" x2="376.5" y1="128.8594" y2="128.8594"/><text fill="#000000" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="9" x="136.5" y="123.7935">2</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="216" x="149.5" y="123.7935">Send Status (initial status) to PAP</text><polygon fill="#A80036" points="140.5,153.9922,130.5,157.9922,140.5,161.9922,136.5,157.9922" style="stroke: #A80036; stroke-width: 1.0;"/><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 2.0,2.0;" x1="134.5" x2="381.5" y1="157.9922" y2="157.9922"/><text fill="#000000" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="9" x="146.5" y="152.9263">3</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="175" x="159.5" y="152.9263">Download Policy Set to PDP</text><path d="M96,172.9922 L173,172.9922 L173,179.9922 L163,189.9922 L96,189.9922 L96,172.9922 " fill="#EEEEEE" style="stroke: #000000; stroke-width: 1.0;"/><rect fill="none" height="46.2656" style="stroke: #000000; stroke-width: 2.0;" width="319" x="96" y="172.9922"/><text fill="#000000" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="32" x="111" y="186.0591">loop</text><text fill="#000000" font-family="sans-serif" font-size="11" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="56" x="188" y="185.2026">[forever]</text><polygon fill="#A80036" points="370.5,207.2578,380.5,211.2578,370.5,215.2578,374.5,211.2578" style="stroke: #A80036; stroke-width: 1.0;"/><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 2.0,2.0;" x1="129.5" x2="376.5" y1="211.2578" y2="211.2578"/><text fill="#000000" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="9" x="136.5" y="206.1919">4</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="125" x="149.5" y="206.1919">Send Status to PAP</text><!-- +@startuml
+title PDP Startup and Shutdown
+
+participant K8S
+participant PDP
+participant DMaaP
+participant PAP
+
+autonumber
+
+K8S - -> PDP : Start PDP
+
+PDP - -> PAP: Send Status (initial status) to PAP
+
+PAP - -> PDP: Download Policy Set to PDP
+
+loop forever
+ PDP - -> PAP: Send Status to PAP
+end
+@enduml
+ +PlantUML version 1.2019.07beta1(Unknown compile time) +(GPL source distribution) +Java Runtime: Java(TM) SE Runtime Environment +JVM: Java HotSpot(TM) 64-Bit Server VM +Java Version: 1.7.0_25-b15 +Operating System: Linux +Default Encoding: UTF-8 +Language: en +Country: US +--></g></svg>
\ No newline at end of file diff --git a/docs/architecture/images/PolicyDatabase.svg b/docs/architecture/images/PolicyDatabase.svg new file mode 100644 index 00000000..ba4ad107 --- /dev/null +++ b/docs/architecture/images/PolicyDatabase.svg @@ -0,0 +1,62 @@ +<?xml version="1.0" encoding="UTF-8" standalone="no"?><svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" contentScriptType="application/ecmascript" contentStyleType="text/css" height="526px" preserveAspectRatio="none" style="width:559px;height:526px;" version="1.1" viewBox="0 0 559 526" width="559px" zoomAndPan="magnify"><defs><filter height="300%" id="f1gtwiqou403ds" width="300%" x="-1" y="-1"><feGaussianBlur result="blurOut" stdDeviation="2.0"/><feColorMatrix in="blurOut" result="blurOut2" type="matrix" values="0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 .4 0"/><feOffset dx="4.0" dy="4.0" in="blurOut2" result="blurOut3"/><feBlend in="SourceGraphic" in2="blurOut3" mode="normal"/></filter></defs><g><text fill="#000000" font-family="sans-serif" font-size="18" lengthAdjust="spacingAndGlyphs" textLength="239" x="164" y="16.708">Indicative Database Layout</text><!--class PDP_SUBGROUP--><rect fill="#FEFECE" filter="url(#f1gtwiqou403ds)" height="129.6328" id="PDP_SUBGROUP" style="stroke: #A80036; stroke-width: 1.5;" width="159" x="14" y="228.9531"/><ellipse cx="41.6" cy="244.9531" fill="#FFAAAA" rx="11" ry="11" style="stroke: #A80036; stroke-width: 1.0;"/><path d="M42.0375,242.4844 L42.0375,249 L43.1625,249 C43.6156,249 43.7563,249.0313 43.9125,249.1563 C44.1469,249.3281 44.2719,249.5781 44.2719,249.8594 C44.2719,250.1406 44.1313,250.4375 43.8656,250.5781 C43.7563,250.6563 43.4906,250.7031 43.1625,250.7031 L39.225,250.7031 C38.8344,250.7031 38.6156,250.6563 38.4594,250.5313 C38.2406,250.375 38.1,250.1094 38.1,249.8594 C38.1,249.5625 38.2563,249.2813 38.5063,249.125 C38.6625,249.0156 38.7875,249 39.225,249 L40.3344,249 L40.3344,242.4844 L38.5063,242.4844 L38.5063,244.0781 C38.5063,244.5313 38.475,244.6719 38.3656,244.8438 C38.1938,245.0625 37.9438,245.1875 37.6625,245.1875 C37.3813,245.1875 37.0844,245.0469 36.9281,244.7813 C36.85,244.6406 36.8188,244.4688 36.8188,244.0781 L36.8188,240.7969 L45.5844,240.7969 L45.5844,244.0781 C45.5844,244.5469 45.5688,244.6719 45.4281,244.8438 C45.2563,245.0625 45.0063,245.1875 44.7406,245.1875 C44.4438,245.1875 44.1625,245.0313 44.0063,244.7813 C43.9125,244.6406 43.8813,244.4688 43.8813,244.0781 L43.8813,242.4844 Z "/><text fill="#000000" font-family="sans-serif" font-size="12" lengthAdjust="spacingAndGlyphs" textLength="99" x="58.4" y="249.1074">PDP_SUBGROUP</text><line style="stroke: #A80036; stroke-width: 1.5;" x1="15" x2="172" y1="260.9531" y2="260.9531"/><text fill="#000000" font-family="sans-serif" font-size="11" lengthAdjust="spacingAndGlyphs" text-decoration="underline" textLength="109" x="20" y="275.1636">PDP_SUBGROUP_ID</text><text fill="#000000" font-family="sans-serif" font-size="11" lengthAdjust="spacingAndGlyphs" textLength="129" x="20" y="287.9683">PDP_SUBGROUP_NAME</text><text fill="#000000" font-family="sans-serif" font-size="11" lengthAdjust="spacingAndGlyphs" textLength="147" x="20" y="300.7729">PDP_SUBGROUP_VERSION</text><text fill="#000000" font-family="sans-serif" font-size="11" lengthAdjust="spacingAndGlyphs" textLength="56" x="20" y="313.5776">PDP_TYPE</text><text fill="#000000" font-family="sans-serif" font-size="11" lengthAdjust="spacingAndGlyphs" textLength="138" x="20" y="326.3823">PDP_SERVICE_ENDPOINT</text><text fill="#000000" font-family="sans-serif" font-size="11" lengthAdjust="spacingAndGlyphs" textLength="85" x="20" y="339.187">POLICY_SET_ID</text><text fill="#000000" font-family="sans-serif" font-size="11" lengthAdjust="spacingAndGlyphs" textLength="134" x="20" y="351.9917">PDP_SUBGROUP_STATE</text><!--class PDP--><rect fill="#FEFECE" filter="url(#f1gtwiqou403ds)" height="129.6328" id="PDP" style="stroke: #A80036; stroke-width: 1.5;" width="165" x="81" y="32.9531"/><ellipse cx="146.75" cy="48.9531" fill="#FFAAAA" rx="11" ry="11" style="stroke: #A80036; stroke-width: 1.0;"/><path d="M147.1875,46.4844 L147.1875,53 L148.3125,53 C148.7656,53 148.9063,53.0313 149.0625,53.1563 C149.2969,53.3281 149.4219,53.5781 149.4219,53.8594 C149.4219,54.1406 149.2813,54.4375 149.0156,54.5781 C148.9063,54.6563 148.6406,54.7031 148.3125,54.7031 L144.375,54.7031 C143.9844,54.7031 143.7656,54.6563 143.6094,54.5313 C143.3906,54.375 143.25,54.1094 143.25,53.8594 C143.25,53.5625 143.4063,53.2813 143.6563,53.125 C143.8125,53.0156 143.9375,53 144.375,53 L145.4844,53 L145.4844,46.4844 L143.6563,46.4844 L143.6563,48.0781 C143.6563,48.5313 143.625,48.6719 143.5156,48.8438 C143.3438,49.0625 143.0938,49.1875 142.8125,49.1875 C142.5313,49.1875 142.2344,49.0469 142.0781,48.7813 C142,48.6406 141.9688,48.4688 141.9688,48.0781 L141.9688,44.7969 L150.7344,44.7969 L150.7344,48.0781 C150.7344,48.5469 150.7188,48.6719 150.5781,48.8438 C150.4063,49.0625 150.1563,49.1875 149.8906,49.1875 C149.5938,49.1875 149.3125,49.0313 149.1563,48.7813 C149.0625,48.6406 149.0313,48.4688 149.0313,48.0781 L149.0313,46.4844 Z "/><text fill="#000000" font-family="sans-serif" font-size="12" lengthAdjust="spacingAndGlyphs" textLength="25" x="167.25" y="53.1074">PDP</text><line style="stroke: #A80036; stroke-width: 1.5;" x1="82" x2="245" y1="64.9531" y2="64.9531"/><text fill="#000000" font-family="sans-serif" font-size="11" lengthAdjust="spacingAndGlyphs" text-decoration="underline" textLength="39" x="87" y="79.1636">PDP_ID</text><text fill="#000000" font-family="sans-serif" font-size="11" lengthAdjust="spacingAndGlyphs" textLength="59" x="87" y="91.9683">PDP_NAME</text><text fill="#000000" font-family="sans-serif" font-size="11" lengthAdjust="spacingAndGlyphs" textLength="77" x="87" y="104.7729">PDP_VERSION</text><text fill="#000000" font-family="sans-serif" font-size="11" lengthAdjust="spacingAndGlyphs" textLength="56" x="87" y="117.5776">PDP_TYPE</text><text fill="#000000" font-family="sans-serif" font-size="11" lengthAdjust="spacingAndGlyphs" textLength="85" x="87" y="130.3823">PDP_ENDPOINT</text><text fill="#000000" font-family="sans-serif" font-size="11" lengthAdjust="spacingAndGlyphs" textLength="109" x="87" y="143.187">PDP_SUBGROUP_ID</text><text fill="#000000" font-family="sans-serif" font-size="11" lengthAdjust="spacingAndGlyphs" textLength="153" x="87" y="155.9917">POLICY_SET_ID PDP_STATE</text><!--class POLICY_SET--><rect fill="#FEFECE" filter="url(#f1gtwiqou403ds)" height="78.4141" id="POLICY_SET" style="stroke: #A80036; stroke-width: 1.5;" width="135" x="160" y="430.4531"/><ellipse cx="189.85" cy="446.4531" fill="#FFAAAA" rx="11" ry="11" style="stroke: #A80036; stroke-width: 1.0;"/><path d="M190.2875,443.9844 L190.2875,450.5 L191.4125,450.5 C191.8656,450.5 192.0063,450.5313 192.1625,450.6563 C192.3969,450.8281 192.5219,451.0781 192.5219,451.3594 C192.5219,451.6406 192.3813,451.9375 192.1156,452.0781 C192.0063,452.1563 191.7406,452.2031 191.4125,452.2031 L187.475,452.2031 C187.0844,452.2031 186.8656,452.1563 186.7094,452.0313 C186.4906,451.875 186.35,451.6094 186.35,451.3594 C186.35,451.0625 186.5063,450.7813 186.7563,450.625 C186.9125,450.5156 187.0375,450.5 187.475,450.5 L188.5844,450.5 L188.5844,443.9844 L186.7563,443.9844 L186.7563,445.5781 C186.7563,446.0313 186.725,446.1719 186.6156,446.3438 C186.4438,446.5625 186.1938,446.6875 185.9125,446.6875 C185.6313,446.6875 185.3344,446.5469 185.1781,446.2813 C185.1,446.1406 185.0688,445.9688 185.0688,445.5781 L185.0688,442.2969 L193.8344,442.2969 L193.8344,445.5781 C193.8344,446.0469 193.8188,446.1719 193.6781,446.3438 C193.5063,446.5625 193.2563,446.6875 192.9906,446.6875 C192.6938,446.6875 192.4125,446.5313 192.2563,446.2813 C192.1625,446.1406 192.1313,445.9688 192.1313,445.5781 L192.1313,443.9844 Z "/><text fill="#000000" font-family="sans-serif" font-size="12" lengthAdjust="spacingAndGlyphs" textLength="70" x="207.15" y="450.6074">POLICY_SET</text><line style="stroke: #A80036; stroke-width: 1.5;" x1="161" x2="294" y1="462.4531" y2="462.4531"/><text fill="#000000" font-family="sans-serif" font-size="11" lengthAdjust="spacingAndGlyphs" text-decoration="underline" textLength="85" x="166" y="476.6636">POLICY_SET_ID</text><text fill="#000000" font-family="sans-serif" font-size="11" lengthAdjust="spacingAndGlyphs" textLength="105" x="166" y="489.4683">POLICY_SET_NAME</text><text fill="#000000" font-family="sans-serif" font-size="11" lengthAdjust="spacingAndGlyphs" textLength="123" x="166" y="502.2729">POLICY_SET_VERSION</text><!--class POLICY_TYPE_IMPL--><rect fill="#FEFECE" filter="url(#f1gtwiqou403ds)" height="91.2188" id="POLICY_TYPE_IMPL" style="stroke: #A80036; stroke-width: 1.5;" width="170" x="346.5" y="423.9531"/><ellipse cx="374.1" cy="439.9531" fill="#FFAAAA" rx="11" ry="11" style="stroke: #A80036; stroke-width: 1.0;"/><path d="M374.5375,437.4844 L374.5375,444 L375.6625,444 C376.1156,444 376.2563,444.0313 376.4125,444.1563 C376.6469,444.3281 376.7719,444.5781 376.7719,444.8594 C376.7719,445.1406 376.6313,445.4375 376.3656,445.5781 C376.2563,445.6563 375.9906,445.7031 375.6625,445.7031 L371.725,445.7031 C371.3344,445.7031 371.1156,445.6563 370.9594,445.5313 C370.7406,445.375 370.6,445.1094 370.6,444.8594 C370.6,444.5625 370.7563,444.2813 371.0063,444.125 C371.1625,444.0156 371.2875,444 371.725,444 L372.8344,444 L372.8344,437.4844 L371.0063,437.4844 L371.0063,439.0781 C371.0063,439.5313 370.975,439.6719 370.8656,439.8438 C370.6938,440.0625 370.4438,440.1875 370.1625,440.1875 C369.8813,440.1875 369.5844,440.0469 369.4281,439.7813 C369.35,439.6406 369.3188,439.4688 369.3188,439.0781 L369.3188,435.7969 L378.0844,435.7969 L378.0844,439.0781 C378.0844,439.5469 378.0688,439.6719 377.9281,439.8438 C377.7563,440.0625 377.5063,440.1875 377.2406,440.1875 C376.9438,440.1875 376.6625,440.0313 376.5063,439.7813 C376.4125,439.6406 376.3813,439.4688 376.3813,439.0781 L376.3813,437.4844 Z "/><text fill="#000000" font-family="sans-serif" font-size="12" lengthAdjust="spacingAndGlyphs" textLength="110" x="390.9" y="444.1074">POLICY_TYPE_IMPL</text><line style="stroke: #A80036; stroke-width: 1.5;" x1="347.5" x2="515.5" y1="455.9531" y2="455.9531"/><text fill="#000000" font-family="sans-serif" font-size="11" lengthAdjust="spacingAndGlyphs" text-decoration="underline" textLength="122" x="352.5" y="470.1636">POLICY_TYPE_IMPL_ID</text><text fill="#000000" font-family="sans-serif" font-size="11" lengthAdjust="spacingAndGlyphs" textLength="77" x="352.5" y="482.9683">POLICY_NAME</text><text fill="#000000" font-family="sans-serif" font-size="11" lengthAdjust="spacingAndGlyphs" textLength="95" x="352.5" y="495.7729">POLICY_VERSION</text><text fill="#000000" font-family="sans-serif" font-size="11" lengthAdjust="spacingAndGlyphs" textLength="158" x="352.5" y="508.5776">PDP_TYPE POLICY_ARTIFACT</text><!--class POLICY_SET_TO_POLICY_TYPE_IMPL--><rect fill="#FEFECE" filter="url(#f1gtwiqou403ds)" height="65.6094" id="POLICY_SET_TO_POLICY_TYPE_IMPL" style="stroke: #A80036; stroke-width: 1.5;" width="240" x="300.5" y="260.4531"/><ellipse cx="315.5" cy="276.4531" fill="#FFAAAA" rx="11" ry="11" style="stroke: #A80036; stroke-width: 1.0;"/><path d="M315.9375,273.9844 L315.9375,280.5 L317.0625,280.5 C317.5156,280.5 317.6563,280.5313 317.8125,280.6563 C318.0469,280.8281 318.1719,281.0781 318.1719,281.3594 C318.1719,281.6406 318.0313,281.9375 317.7656,282.0781 C317.6563,282.1563 317.3906,282.2031 317.0625,282.2031 L313.125,282.2031 C312.7344,282.2031 312.5156,282.1563 312.3594,282.0313 C312.1406,281.875 312,281.6094 312,281.3594 C312,281.0625 312.1563,280.7813 312.4063,280.625 C312.5625,280.5156 312.6875,280.5 313.125,280.5 L314.2344,280.5 L314.2344,273.9844 L312.4063,273.9844 L312.4063,275.5781 C312.4063,276.0313 312.375,276.1719 312.2656,276.3438 C312.0938,276.5625 311.8438,276.6875 311.5625,276.6875 C311.2813,276.6875 310.9844,276.5469 310.8281,276.2813 C310.75,276.1406 310.7188,275.9688 310.7188,275.5781 L310.7188,272.2969 L319.4844,272.2969 L319.4844,275.5781 C319.4844,276.0469 319.4688,276.1719 319.3281,276.3438 C319.1563,276.5625 318.9063,276.6875 318.6406,276.6875 C318.3438,276.6875 318.0625,276.5313 317.9063,276.2813 C317.8125,276.1406 317.7813,275.9688 317.7813,275.5781 L317.7813,273.9844 Z "/><text fill="#000000" font-family="sans-serif" font-size="12" lengthAdjust="spacingAndGlyphs" textLength="208" x="329.5" y="280.6074">POLICY_SET_TO_POLICY_TYPE_IMPL</text><line style="stroke: #A80036; stroke-width: 1.5;" x1="301.5" x2="539.5" y1="292.4531" y2="292.4531"/><text fill="#000000" font-family="sans-serif" font-size="11" lengthAdjust="spacingAndGlyphs" textLength="85" x="306.5" y="306.6636">POLICY_SET_ID</text><text fill="#000000" font-family="sans-serif" font-size="11" lengthAdjust="spacingAndGlyphs" textLength="122" x="306.5" y="319.4683">POLICY_TYPE_IMPL_ID</text><!--link PDP_SUBGROUP to POLICY_SET--><path d="M174.5,334.4531 C234.481,334.4531 106.065,464.4321 154.271,472.5558 " fill="none" id="PDP_SUBGROUP-POLICY_SET" style="stroke: #A80036; stroke-width: 1.0;"/><polygon fill="#A80036" points="159.5,472.9531,150.8287,468.2832,154.5144,472.5745,150.223,476.2602,159.5,472.9531" style="stroke: #A80036; stroke-width: 1.0;"/><!--link PDP to PDP_SUBGROUP--><path d="M80.5,138.9531 C68.9359,138.9531 75.7976,154.8931 81.5,164.9531 C105.572,207.4211 149.789,182.2821 173.5,224.9531 C182.599,241.3281 193.005,266.2131 179.49,270.7351 " fill="none" id="PDP-PDP_SUBGROUP" style="stroke: #A80036; stroke-width: 1.0;"/><polygon fill="#A80036" points="174.5,271.4531,183.9776,274.1317,179.4491,270.7416,182.8392,266.2131,174.5,271.4531" style="stroke: #A80036; stroke-width: 1.0;"/><!--link PDP to POLICY_SET--><path d="M247.5,150.9531 C270.915,150.9531 269.455,337.0881 274.5,359.9531 C285.116,408.0621 343.124,468.2926 301.736,472.6966 " fill="none" id="PDP-POLICY_SET" style="stroke: #A80036; stroke-width: 1.0;"/><polygon fill="#A80036" points="296.5,472.9531,305.6857,476.506,301.494,472.7074,305.2926,468.5157,296.5,472.9531" style="stroke: #A80036; stroke-width: 1.0;"/><!--link POLICY_SET_TO_POLICY_TYPE_IMPL to POLICY_SET--><path d="M299.5,302.4531 C225.635,302.4531 364.889,464.4048 301.846,472.6289 " fill="none" id="POLICY_SET_TO_POLICY_TYPE_IMPL-POLICY_SET" style="stroke: #A80036; stroke-width: 1.0;"/><polygon fill="#A80036" points="296.5,472.9531,305.7258,476.4006,301.4908,472.6503,305.2412,468.4153,296.5,472.9531" style="stroke: #A80036; stroke-width: 1.0;"/><!--link POLICY_SET_TO_POLICY_TYPE_IMPL to POLICY_TYPE_IMPL--><path d="M541.5,314.4531 C547.738,314.4531 544.026,323.3071 540.5,328.4531 C486.617,407.0961 398.417,339.9991 346.5,419.9531 C336.407,435.496 326.992,460.6467 340.535,465.2258 " fill="none" id="POLICY_SET_TO_POLICY_TYPE_IMPL-POLICY_TYPE_IMPL" style="stroke: #A80036; stroke-width: 1.0;"/><polygon fill="#A80036" points="345.5,465.9531,337.1744,460.6916,340.5527,465.2288,336.0155,468.6072,345.5,465.9531" style="stroke: #A80036; stroke-width: 1.0;"/><!-- +@startuml
+title Indicative Database Layout
+
+hide methods
+hide stereotypes
+
+class PDP_SUBGROUP << (T,#FFAAAA) >> {
+ <u>PDP_SUBGROUP_ID</u>
+ PDP_SUBGROUP_NAME
+ PDP_SUBGROUP_VERSION
+ PDP_TYPE
+ PDP_SERVICE_ENDPOINT
+ POLICY_SET_ID
+ PDP_SUBGROUP_STATE
+}
+
+class PDP << (T,#FFAAAA) >> {
+ <u>PDP_ID</u>
+ PDP_NAME
+ PDP_VERSION
+ PDP_TYPE
+ PDP_ENDPOINT
+ PDP_SUBGROUP_ID
+ POLICY_SET_ID PDP_STATE
+}
+
+class POLICY_SET << (T,#FFAAAA) >> {
+ <u>POLICY_SET_ID</u>
+ POLICY_SET_NAME
+ POLICY_SET_VERSION
+}
+
+class POLICY_TYPE_IMPL << (T,#FFAAAA) >> {
+ <u>POLICY_TYPE_IMPL_ID</u>
+ POLICY_NAME
+ POLICY_VERSION
+ PDP_TYPE POLICY_ARTIFACT
+}
+
+class POLICY_SET_TO_POLICY_TYPE_IMPL << (T,#FFAAAA) >> {
+ POLICY_SET_ID
+ POLICY_TYPE_IMPL_ID
+}
+
+PDP_SUBGROUP::POLICY_SET_ID - -> POLICY_SET::POLICY_SET_ID
+PDP::PDP_SUBGROUP_ID - -> PDP_SUBGROUP::PDP_SUBGROUP_ID
+PDP::POLICY_SET_ID - -> POLICY_SET::POLICY_SET_ID
+POLICY_SET_TO_POLICY_TYPE_IMPL::POLICY_SET_ID - -> POLICY_SET::POLICY_SET_ID
+POLICY_SET_TO_POLICY_TYPE_IMPL::POLICY_TYPE_IMPL_ID - -> POLICY_TYPE_IMPL::POLICY_TYPE_IMPL_ID
+@enduml
+ +PlantUML version 1.2019.07beta1(Unknown compile time) +(GPL source distribution) +Java Runtime: Java(TM) SE Runtime Environment +JVM: Java HotSpot(TM) 64-Bit Server VM +Java Version: 1.7.0_25-b15 +Operating System: Linux +Default Encoding: UTF-8 +Language: en +Country: US +--></g></svg>
\ No newline at end of file diff --git a/docs/architecture/images/PolicyDesign.svg b/docs/architecture/images/PolicyDesign.svg new file mode 100644 index 00000000..79ae900e --- /dev/null +++ b/docs/architecture/images/PolicyDesign.svg @@ -0,0 +1,49 @@ +<?xml version="1.0" encoding="UTF-8" standalone="no"?><svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" contentScriptType="application/ecmascript" contentStyleType="text/css" height="726px" preserveAspectRatio="none" style="width:810px;height:726px;" version="1.1" viewBox="0 0 810 726" width="810px" zoomAndPan="magnify"><defs><filter height="300%" id="f10yhti0u2ghcu" width="300%" x="-1" y="-1"><feGaussianBlur result="blurOut" stdDeviation="2.0"/><feColorMatrix in="blurOut" result="blurOut2" type="matrix" values="0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 .4 0"/><feOffset dx="4.0" dy="4.0" in="blurOut2" result="blurOut3"/><feBlend in="SourceGraphic" in2="blurOut3" mode="normal"/></filter></defs><g><text fill="#000000" font-family="sans-serif" font-size="14" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="105" x="353.5" y="22.9951">Policy Design</text><rect fill="#ADD8E6" height="681.5234" style="stroke: #A80036; stroke-width: 1.0;" width="371" x="422" y="34.2969"/><text fill="#000000" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="94" x="560.5" y="46.3638">PolicyDesign</text><rect fill="#FFFFFF" filter="url(#f10yhti0u2ghcu)" height="28" style="stroke: #A80036; stroke-width: 1.0;" width="10" x="57" y="419.8594"/><rect fill="#FFFFFF" filter="url(#f10yhti0u2ghcu)" height="30" style="stroke: #A80036; stroke-width: 1.0;" width="10" x="474" y="537.2578"/><rect fill="#FFFFFF" filter="url(#f10yhti0u2ghcu)" height="90.2031" style="stroke: #000000; stroke-width: 2.0;" width="529" x="13" y="278.3906"/><rect fill="#FFFFFF" height="43.9375" style="stroke: none; stroke-width: 1.0;" width="529" x="13" y="324.6563"/><rect fill="#FFFFFF" filter="url(#f10yhti0u2ghcu)" height="163.6641" style="stroke: #000000; stroke-width: 2.0;" width="786" x="13" y="469.8594"/><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 5.0,5.0;" x1="62" x2="62" y1="115.7266" y2="650.5234"/><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 5.0,5.0;" x1="479" x2="479" y1="115.7266" y2="650.5234"/><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 5.0,5.0;" x1="756" x2="756" y1="115.7266" y2="650.5234"/><rect fill="#FEFECE" filter="url(#f10yhti0u2ghcu)" height="30.2969" style="stroke: #A80036; stroke-width: 1.5;" width="74" x="23" y="80.4297"/><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacingAndGlyphs" textLength="60" x="30" y="100.4248">API_User</text><rect fill="#FEFECE" filter="url(#f10yhti0u2ghcu)" height="30.2969" style="stroke: #A80036; stroke-width: 1.5;" width="74" x="23" y="649.5234"/><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacingAndGlyphs" textLength="60" x="30" y="669.5186">API_User</text><rect fill="#FEFECE" filter="url(#f10yhti0u2ghcu)" height="30.2969" style="stroke: #A80036; stroke-width: 1.5;" width="102" x="426" y="80.4297"/><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacingAndGlyphs" textLength="88" x="433" y="100.4248">PolicyDesign</text><rect fill="#FEFECE" filter="url(#f10yhti0u2ghcu)" height="30.2969" style="stroke: #A80036; stroke-width: 1.5;" width="102" x="426" y="649.5234"/><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacingAndGlyphs" textLength="88" x="433" y="669.5186">PolicyDesign</text><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacingAndGlyphs" textLength="60" x="723" y="112.4248">PolicyDB</text><path d="M738,63.4297 C738,53.4297 756,53.4297 756,53.4297 C756,53.4297 774,53.4297 774,63.4297 L774,89.4297 C774,99.4297 756,99.4297 756,99.4297 C756,99.4297 738,99.4297 738,89.4297 L738,63.4297 " fill="#FEFECE" filter="url(#f10yhti0u2ghcu)" style="stroke: #000000; stroke-width: 1.5;"/><path d="M738,63.4297 C738,73.4297 756,73.4297 756,73.4297 C756,73.4297 774,73.4297 774,63.4297 " fill="none" style="stroke: #000000; stroke-width: 1.5;"/><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacingAndGlyphs" textLength="60" x="723" y="662.5186">PolicyDB</text><path d="M738,675.8203 C738,665.8203 756,665.8203 756,665.8203 C756,665.8203 774,665.8203 774,675.8203 L774,701.8203 C774,711.8203 756,711.8203 756,711.8203 C756,711.8203 738,711.8203 738,701.8203 L738,675.8203 " fill="#FEFECE" filter="url(#f10yhti0u2ghcu)" style="stroke: #000000; stroke-width: 1.5;"/><path d="M738,675.8203 C738,685.8203 756,685.8203 756,685.8203 C756,685.8203 774,685.8203 774,675.8203 " fill="none" style="stroke: #000000; stroke-width: 1.5;"/><rect fill="#FFFFFF" filter="url(#f10yhti0u2ghcu)" height="28" style="stroke: #A80036; stroke-width: 1.0;" width="10" x="57" y="419.8594"/><rect fill="#FFFFFF" filter="url(#f10yhti0u2ghcu)" height="30" style="stroke: #A80036; stroke-width: 1.0;" width="10" x="474" y="537.2578"/><polygon fill="#A80036" points="467,142.8594,477,146.8594,467,150.8594,471,146.8594" style="stroke: #A80036; stroke-width: 1.0;"/><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 2.0,2.0;" x1="62" x2="473" y1="146.8594" y2="146.8594"/><text fill="#000000" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="9" x="69" y="141.7935">1</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="165" x="82" y="141.7935">Get Policy Type Reference</text><polygon fill="#A80036" points="744,171.9922,754,175.9922,744,179.9922,748,175.9922" style="stroke: #A80036; stroke-width: 1.0;"/><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 2.0,2.0;" x1="479" x2="750" y1="175.9922" y2="175.9922"/><text fill="#000000" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="9" x="486" y="170.9263">2</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="240" x="499" y="170.9263">Get Policy Type Artifact and Metadata</text><polygon fill="#A80036" points="73,201.125,63,205.125,73,209.125,69,205.125" style="stroke: #A80036; stroke-width: 1.0;"/><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 2.0,2.0;" x1="67" x2="478" y1="205.125" y2="205.125"/><text fill="#000000" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="9" x="79" y="200.0591">3</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="277" x="92" y="200.0591">Return Policy Type Reference and Metadata</text><polygon fill="#A80036" points="467,230.2578,477,234.2578,467,238.2578,471,234.2578" style="stroke: #A80036; stroke-width: 1.0;"/><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 2.0,2.0;" x1="62" x2="473" y1="234.2578" y2="234.2578"/><text fill="#000000" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="9" x="69" y="229.1919">4</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="224" x="82" y="229.1919">Get Policy Reference and Metadata</text><polygon fill="#A80036" points="744,259.3906,754,263.3906,744,267.3906,748,263.3906" style="stroke: #A80036; stroke-width: 1.0;"/><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 2.0,2.0;" x1="479" x2="750" y1="263.3906" y2="263.3906"/><text fill="#000000" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="9" x="486" y="258.3247">5</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="128" x="499" y="258.3247">Get Policy Metadata</text><path d="M13,278.3906 L77,278.3906 L77,285.3906 L67,295.3906 L13,295.3906 L13,278.3906 " fill="#EEEEEE" style="stroke: #000000; stroke-width: 1.0;"/><rect fill="none" height="90.2031" style="stroke: #000000; stroke-width: 2.0;" width="529" x="13" y="278.3906"/><text fill="#000000" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="19" x="28" y="291.4575">alt</text><text fill="#000000" font-family="sans-serif" font-size="11" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="141" x="92" y="290.6011">[Policy Artifact exists]</text><polygon fill="#A80036" points="73,312.6563,63,316.6563,73,320.6563,69,316.6563" style="stroke: #A80036; stroke-width: 1.0;"/><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 2.0,2.0;" x1="67" x2="478" y1="316.6563" y2="316.6563"/><text fill="#000000" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="9" x="79" y="311.5903">6</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="243" x="92" y="311.5903">Return Policy Reference and Metadata</text><line style="stroke: #000000; stroke-width: 1.0; stroke-dasharray: 2.0,2.0;" x1="13" x2="542" y1="325.6563" y2="325.6563"/><text fill="#000000" font-family="sans-serif" font-size="11" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="194" x="18" y="335.8667">[Policy Artifact does not exist]</text><polygon fill="#A80036" points="73,356.5938,63,360.5938,73,364.5938,69,360.5938" style="stroke: #A80036; stroke-width: 1.0;"/><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 2.0,2.0;" x1="67" x2="478" y1="360.5938" y2="360.5938"/><text fill="#000000" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="9" x="79" y="355.5278">7</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="319" x="92" y="355.5278">Return New Policy Reference and Empty Metadata</text><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 2.0,2.0;" x1="67" x2="109" y1="411.8594" y2="411.8594"/><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 2.0,2.0;" x1="109" x2="109" y1="411.8594" y2="424.8594"/><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 2.0,2.0;" x1="68" x2="109" y1="424.8594" y2="424.8594"/><polygon fill="#A80036" points="78,420.8594,68,424.8594,78,428.8594,74,424.8594" style="stroke: #A80036; stroke-width: 1.0;"/><text fill="#000000" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="9" x="74" y="399.2271">8</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="240" x="87" y="391.6606">Policy Editing and Generation Session</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="223" x="87" y="406.7935">to get Policy Parameters from user</text><path d="M13,469.8594 L90,469.8594 L90,476.8594 L80,486.8594 L13,486.8594 L13,469.8594 " fill="#EEEEEE" style="stroke: #000000; stroke-width: 1.0;"/><rect fill="none" height="163.6641" style="stroke: #000000; stroke-width: 2.0;" width="786" x="13" y="469.8594"/><text fill="#000000" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="32" x="28" y="482.9263">loop</text><polygon fill="#A80036" points="467,504.125,477,508.125,467,512.125,471,508.125" style="stroke: #A80036; stroke-width: 1.0;"/><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 2.0,2.0;" x1="62" x2="473" y1="508.125" y2="508.125"/><text fill="#000000" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="9" x="69" y="503.0591">9</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="182" x="82" y="503.0591">Use Policy Type specification</text><polygon fill="#A80036" points="462,533.2578,472,537.2578,462,541.2578,466,537.2578" style="stroke: #A80036; stroke-width: 1.0;"/><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 2.0,2.0;" x1="62" x2="468" y1="537.2578" y2="537.2578"/><text fill="#000000" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="18" x="69" y="532.1919">10</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="371" x="91" y="532.1919">Create Policy PolicyDesign --> PolicyDesign : Create Policy</text><polygon fill="#A80036" points="744,592.3906,754,596.3906,744,600.3906,748,596.3906" style="stroke: #A80036; stroke-width: 1.0;"/><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 2.0,2.0;" x1="479" x2="750" y1="596.3906" y2="596.3906"/><text fill="#000000" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="18" x="486" y="591.3247">11</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="215" x="508" y="591.3247">Save Policy Artifact and Metadata</text><polygon fill="#A80036" points="73,621.5234,63,625.5234,73,629.5234,69,625.5234" style="stroke: #A80036; stroke-width: 1.0;"/><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 2.0,2.0;" x1="67" x2="478" y1="625.5234" y2="625.5234"/><text fill="#000000" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="18" x="79" y="620.4575">12</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="137" x="101" y="620.4575">Policy Creation Result</text><!-- +@startuml
+title Policy Design
+
+participant API_User
+box "PolicyDesign" #LightBlue
+ participant PolicyDesign
+ database PolicyDB
+end box
+
+autonumber
+
+API_User - -> PolicyDesign : Get Policy Type Reference
+PolicyDesign - -> PolicyDB : Get Policy Type Artifact and Metadata
+PolicyDesign - -> API_User : Return Policy Type Reference and Metadata
+API_User - -> PolicyDesign : Get Policy Reference and Metadata
+PolicyDesign - -> PolicyDB : Get Policy Metadata
+
+alt Policy Artifact exists
+ PolicyDesign - -> API_User : Return Policy Reference and Metadata
+else Policy Artifact does not exist
+ PolicyDesign - -> API_User : Return New Policy Reference and Empty Metadata
+end
+
+API_User - -> API_User : Policy Editing and Generation Session\nto get Policy Parameters from user
+
+activate API_User
+deactivate API_User
+
+loop
+ API_User - -> PolicyDesign : Use Policy Type specification
+ API_User - -> PolicyDesign : Create Policy PolicyDesign - -> PolicyDesign : Create Policy
+ activate PolicyDesign
+ deactivate PolicyDesign
+ PolicyDesign - -> PolicyDB : Save Policy Artifact and Metadata
+ PolicyDesign - -> API_User : Policy Creation Result
+end
+@enduml
+ +PlantUML version 1.2019.07beta1(Unknown compile time) +(GPL source distribution) +Java Runtime: Java(TM) SE Runtime Environment +JVM: Java HotSpot(TM) 64-Bit Server VM +Java Version: 1.7.0_25-b15 +Operating System: Linux +Default Encoding: UTF-8 +Language: en +Country: US +--></g></svg>
\ No newline at end of file diff --git a/docs/architecture/images/PolicyExecution.svg b/docs/architecture/images/PolicyExecution.svg new file mode 100644 index 00000000..c9b2f7f6 --- /dev/null +++ b/docs/architecture/images/PolicyExecution.svg @@ -0,0 +1,34 @@ +<?xml version="1.0" encoding="UTF-8" standalone="no"?><svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" contentScriptType="application/ecmascript" contentStyleType="text/css" height="324px" preserveAspectRatio="none" style="width:424px;height:324px;" version="1.1" viewBox="0 0 424 324" width="424px" zoomAndPan="magnify"><defs><filter height="300%" id="fso0gk0egkro" width="300%" x="-1" y="-1"><feGaussianBlur result="blurOut" stdDeviation="2.0"/><feColorMatrix in="blurOut" result="blurOut2" type="matrix" values="0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 .4 0"/><feOffset dx="4.0" dy="4.0" in="blurOut2" result="blurOut3"/><feBlend in="SourceGraphic" in2="blurOut3" mode="normal"/></filter></defs><g><text fill="#000000" font-family="sans-serif" font-size="14" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="128" x="148.5" y="22.9951">Policy Execution</text><rect fill="#FFFFFF" filter="url(#fso0gk0egkro)" height="62.2656" style="stroke: #A80036; stroke-width: 1.0;" width="10" x="373.5" y="123.8594"/><rect fill="#FFFFFF" filter="url(#fso0gk0egkro)" height="29.1328" style="stroke: #A80036; stroke-width: 1.0;" width="10" x="373.5" y="230.0625"/><rect fill="#FFFFFF" filter="url(#fso0gk0egkro)" height="181.6016" style="stroke: #000000; stroke-width: 2.0;" width="399" x="13" y="85.5938"/><rect fill="#FFFFFF" height="73.0703" style="stroke: none; stroke-width: 1.0;" width="399" x="13" y="194.125"/><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 5.0,5.0;" x1="76" x2="76" y1="68.5938" y2="284.1953"/><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 5.0,5.0;" x1="191" x2="191" y1="68.5938" y2="284.1953"/><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 5.0,5.0;" x1="378" x2="378" y1="68.5938" y2="284.1953"/><rect fill="#FEFECE" filter="url(#fso0gk0egkro)" height="30.2969" style="stroke: #A80036; stroke-width: 1.5;" width="102" x="23" y="33.2969"/><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacingAndGlyphs" textLength="88" x="30" y="53.292">REQUESTOR</text><rect fill="#FEFECE" filter="url(#fso0gk0egkro)" height="30.2969" style="stroke: #A80036; stroke-width: 1.5;" width="102" x="23" y="283.1953"/><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacingAndGlyphs" textLength="88" x="30" y="303.1904">REQUESTOR</text><rect fill="#FEFECE" filter="url(#fso0gk0egkro)" height="30.2969" style="stroke: #A80036; stroke-width: 1.5;" width="101" x="139" y="33.2969"/><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacingAndGlyphs" textLength="87" x="146" y="53.292">RESPONDEE</text><rect fill="#FEFECE" filter="url(#fso0gk0egkro)" height="30.2969" style="stroke: #A80036; stroke-width: 1.5;" width="101" x="139" y="283.1953"/><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacingAndGlyphs" textLength="87" x="146" y="303.1904">RESPONDEE</text><rect fill="#FEFECE" filter="url(#fso0gk0egkro)" height="30.2969" style="stroke: #A80036; stroke-width: 1.5;" width="43" x="355" y="33.2969"/><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacingAndGlyphs" textLength="29" x="362" y="53.292">PDP</text><rect fill="#FEFECE" filter="url(#fso0gk0egkro)" height="30.2969" style="stroke: #A80036; stroke-width: 1.5;" width="43" x="355" y="283.1953"/><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacingAndGlyphs" textLength="29" x="362" y="303.1904">PDP</text><rect fill="#FFFFFF" filter="url(#fso0gk0egkro)" height="62.2656" style="stroke: #A80036; stroke-width: 1.0;" width="10" x="373.5" y="123.8594"/><rect fill="#FFFFFF" filter="url(#fso0gk0egkro)" height="29.1328" style="stroke: #A80036; stroke-width: 1.0;" width="10" x="373.5" y="230.0625"/><path d="M13,85.5938 L77,85.5938 L77,92.5938 L67,102.5938 L13,102.5938 L13,85.5938 " fill="#EEEEEE" style="stroke: #000000; stroke-width: 1.0;"/><rect fill="none" height="181.6016" style="stroke: #000000; stroke-width: 2.0;" width="399" x="13" y="85.5938"/><text fill="#000000" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="19" x="28" y="98.6606">alt</text><text fill="#000000" font-family="sans-serif" font-size="11" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="163" x="92" y="97.8042">[Synchronous Invocation]</text><polygon fill="#A80036" points="361.5,119.8594,371.5,123.8594,361.5,127.8594,365.5,123.8594" style="stroke: #A80036; stroke-width: 1.0;"/><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 2.0,2.0;" x1="76" x2="367.5" y1="123.8594" y2="123.8594"/><text fill="#000000" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="9" x="83" y="118.7935">1</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="91" x="96" y="118.7935">Execute Policy</text><polygon fill="#FBFB77" filter="url(#fso0gk0egkro)" points="61,136.8594,90,136.8594,100,147.8594,90,159.8594,61,159.8594,51,147.8594,61,136.8594" style="stroke: #A80036; stroke-width: 1.0;"/><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="25" x="63" y="152.9263">wait</text><polygon fill="#A80036" points="87,182.125,77,186.125,87,190.125,83,186.125" style="stroke: #A80036; stroke-width: 1.0;"/><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 2.0,2.0;" x1="81" x2="377.5" y1="186.125" y2="186.125"/><text fill="#000000" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="9" x="93" y="181.0591">2</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="145" x="106" y="181.0591">Policy Execution Result</text><line style="stroke: #000000; stroke-width: 1.0; stroke-dasharray: 2.0,2.0;" x1="13" x2="412" y1="195.125" y2="195.125"/><text fill="#000000" font-family="sans-serif" font-size="11" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="170" x="18" y="205.3354">[Asynchronous Invocation]</text><polygon fill="#A80036" points="361.5,226.0625,371.5,230.0625,361.5,234.0625,365.5,230.0625" style="stroke: #A80036; stroke-width: 1.0;"/><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 2.0,2.0;" x1="76" x2="367.5" y1="230.0625" y2="230.0625"/><text fill="#000000" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="9" x="83" y="224.9966">3</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="91" x="96" y="224.9966">Execute Policy</text><polygon fill="#A80036" points="202.5,255.1953,192.5,259.1953,202.5,263.1953,198.5,259.1953" style="stroke: #A80036; stroke-width: 1.0;"/><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 2.0,2.0;" x1="196.5" x2="377.5" y1="259.1953" y2="259.1953"/><text fill="#000000" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="9" x="208.5" y="254.1294">4</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="145" x="221.5" y="254.1294">Policy Execution Result</text><!-- +@startuml
+title Policy Execution
+
+participant REQUESTOR
+participant RESPONDEE
+participant PDP
+
+autonumber
+
+alt Synchronous Invocation
+ REQUESTOR - -> PDP: Execute Policy
+ activate PDP
+ hnote over REQUESTOR : wait
+ PDP - -> REQUESTOR: Policy Execution Result
+ deactivate PDP
+else Asynchronous Invocation
+ REQUESTOR - -> PDP: Execute Policy
+ activate PDP
+ PDP - -> RESPONDEE: Policy Execution Result
+ deactivate PDP
+end
+@enduml
+ +PlantUML version 1.2019.07beta1(Unknown compile time) +(GPL source distribution) +Java Runtime: Java(TM) SE Runtime Environment +JVM: Java HotSpot(TM) 64-Bit Server VM +Java Version: 1.7.0_25-b15 +Operating System: Linux +Default Encoding: UTF-8 +Language: en +Country: US +--></g></svg>
\ No newline at end of file diff --git a/docs/architecture/images/PolicyRollout.svg b/docs/architecture/images/PolicyRollout.svg new file mode 100644 index 00000000..1c0b21c9 --- /dev/null +++ b/docs/architecture/images/PolicyRollout.svg @@ -0,0 +1,53 @@ +<?xml version="1.0" encoding="UTF-8" standalone="no"?><svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" contentScriptType="application/ecmascript" contentStyleType="text/css" height="803px" preserveAspectRatio="none" style="width:737px;height:803px;" version="1.1" viewBox="0 0 737 803" width="737px" zoomAndPan="magnify"><defs><filter height="300%" id="f1f2g3wl1bqly4" width="300%" x="-1" y="-1"><feGaussianBlur result="blurOut" stdDeviation="2.0"/><feColorMatrix in="blurOut" result="blurOut2" type="matrix" values="0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 .4 0"/><feOffset dx="4.0" dy="4.0" in="blurOut2" result="blurOut3"/><feBlend in="SourceGraphic" in2="blurOut3" mode="normal"/></filter></defs><g><text fill="#000000" font-family="sans-serif" font-size="14" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="105" x="317.25" y="22.9951">Policy Rollout</text><rect fill="#FFFFFF" filter="url(#f1f2g3wl1bqly4)" height="62.3984" style="stroke: #000000; stroke-width: 2.0;" width="349" x="377.5" y="162.7266"/><rect fill="#FFFFFF" filter="url(#f1f2g3wl1bqly4)" height="46.2656" style="stroke: #000000; stroke-width: 2.0;" width="349" x="377.5" y="268.2578"/><rect fill="#FFFFFF" filter="url(#f1f2g3wl1bqly4)" height="46.2656" style="stroke: #000000; stroke-width: 2.0;" width="349" x="377.5" y="415.9219"/><rect fill="#FFFFFF" filter="url(#f1f2g3wl1bqly4)" height="46.2656" style="stroke: #000000; stroke-width: 2.0;" width="349" x="377.5" y="563.5859"/><rect fill="#FFFFFF" filter="url(#f1f2g3wl1bqly4)" height="75.3984" style="stroke: #000000; stroke-width: 2.0;" width="713.5" x="13" y="623.8516"/><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 5.0,5.0;" x1="42" x2="42" y1="116.5938" y2="716.25"/><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 5.0,5.0;" x1="409.5" x2="409.5" y1="116.5938" y2="716.25"/><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 5.0,5.0;" x1="692.5" x2="692.5" y1="116.5938" y2="716.25"/><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacingAndGlyphs" textLength="32" x="23" y="113.292">User</text><ellipse cx="42" cy="43.2969" fill="#FEFECE" filter="url(#f1f2g3wl1bqly4)" rx="8" ry="8" style="stroke: #A80036; stroke-width: 2.0;"/><path d="M42,51.2969 L42,78.2969 M29,59.2969 L55,59.2969 M42,78.2969 L29,93.2969 M42,78.2969 L55,93.2969 " fill="none" filter="url(#f1f2g3wl1bqly4)" style="stroke: #A80036; stroke-width: 2.0;"/><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacingAndGlyphs" textLength="32" x="23" y="728.2451">User</text><ellipse cx="42" cy="741.5469" fill="#FEFECE" filter="url(#f1f2g3wl1bqly4)" rx="8" ry="8" style="stroke: #A80036; stroke-width: 2.0;"/><path d="M42,749.5469 L42,776.5469 M29,757.5469 L55,757.5469 M42,776.5469 L29,791.5469 M42,776.5469 L55,791.5469 " fill="none" filter="url(#f1f2g3wl1bqly4)" style="stroke: #A80036; stroke-width: 2.0;"/><rect fill="#FEFECE" filter="url(#f1f2g3wl1bqly4)" height="30.2969" style="stroke: #A80036; stroke-width: 1.5;" width="41" x="387.5" y="81.2969"/><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacingAndGlyphs" textLength="27" x="394.5" y="101.292">PAP</text><rect fill="#FEFECE" filter="url(#f1f2g3wl1bqly4)" height="30.2969" style="stroke: #A80036; stroke-width: 1.5;" width="41" x="387.5" y="715.25"/><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacingAndGlyphs" textLength="27" x="394.5" y="735.2451">PAP</text><rect fill="#FEFECE" filter="url(#f1f2g3wl1bqly4)" height="30.2969" style="stroke: #A80036; stroke-width: 1.5;" width="43" x="669.5" y="81.2969"/><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacingAndGlyphs" textLength="29" x="676.5" y="101.292">PDP</text><rect fill="#FEFECE" filter="url(#f1f2g3wl1bqly4)" height="30.2969" style="stroke: #A80036; stroke-width: 1.5;" width="43" x="669.5" y="715.25"/><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacingAndGlyphs" textLength="29" x="676.5" y="735.2451">PDP</text><polygon fill="#A80036" points="398,143.7266,408,147.7266,398,151.7266,402,147.7266" style="stroke: #A80036; stroke-width: 1.0;"/><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 2.0,2.0;" x1="42" x2="404" y1="147.7266" y2="147.7266"/><text fill="#000000" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="9" x="49" y="142.6606">1</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="203" x="62" y="142.6606">Create Policy Set for PDP Group</text><path d="M377.5,162.7266 L454.5,162.7266 L454.5,169.7266 L444.5,179.7266 L377.5,179.7266 L377.5,162.7266 " fill="#EEEEEE" style="stroke: #000000; stroke-width: 1.0;"/><rect fill="none" height="62.3984" style="stroke: #000000; stroke-width: 2.0;" width="349" x="377.5" y="162.7266"/><text fill="#000000" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="32" x="392.5" y="175.7935">loop</text><text fill="#000000" font-family="sans-serif" font-size="11" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="109" x="469.5" y="174.937">[over PDP Group]</text><rect fill="#FFFFFF" filter="url(#f1f2g3wl1bqly4)" height="40.2656" style="stroke: #000000; stroke-width: 2.0;" width="331" x="384.5" y="179.8594"/><polygon fill="#EEEEEE" points="384.5,179.8594,450.5,179.8594,450.5,186.8594,440.5,196.8594,384.5,196.8594,384.5,179.8594" style="stroke: #000000; stroke-width: 2.0;"/><text fill="#000000" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="21" x="397.5" y="193.9263">ref</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="209" x="447.5" y="212.9263">PAP downloads Policy Set to PDP</text><polygon fill="#A80036" points="398,249.2578,408,253.2578,398,257.2578,402,253.2578" style="stroke: #A80036; stroke-width: 1.0;"/><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 2.0,2.0;" x1="42" x2="404" y1="253.2578" y2="253.2578"/><text fill="#000000" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="9" x="49" y="248.1919">2</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="180" x="62" y="248.1919">Set PDP Group in Test Mode</text><path d="M377.5,268.2578 L454.5,268.2578 L454.5,275.2578 L444.5,285.2578 L377.5,285.2578 L377.5,268.2578 " fill="#EEEEEE" style="stroke: #000000; stroke-width: 1.0;"/><rect fill="none" height="46.2656" style="stroke: #000000; stroke-width: 2.0;" width="349" x="377.5" y="268.2578"/><text fill="#000000" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="32" x="392.5" y="281.3247">loop</text><text fill="#000000" font-family="sans-serif" font-size="11" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="109" x="469.5" y="280.4683">[over PDP Group]</text><polygon fill="#A80036" points="681,302.5234,691,306.5234,681,310.5234,685,306.5234" style="stroke: #A80036; stroke-width: 1.0;"/><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 2.0,2.0;" x1="410" x2="687" y1="306.5234" y2="306.5234"/><text fill="#000000" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="9" x="417" y="301.4575">3</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="143" x="430" y="301.4575">Set PDP in TEST mode</text><polygon fill="#A80036" points="421,338.6563,411,342.6563,421,346.6563,417,342.6563" style="stroke: #A80036; stroke-width: 1.0;"/><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 2.0,2.0;" x1="415" x2="692" y1="342.6563" y2="342.6563"/><text fill="#000000" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="9" x="427" y="337.5903">4</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="118" x="440" y="337.5903">Report test results</text><polygon fill="#A80036" points="53,367.7891,43,371.7891,53,375.7891,49,371.7891" style="stroke: #A80036; stroke-width: 1.0;"/><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 2.0,2.0;" x1="47" x2="409" y1="371.7891" y2="371.7891"/><text fill="#000000" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="9" x="59" y="366.7231">5</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="203" x="72" y="366.7231">Report consolidated test results</text><polygon fill="#A80036" points="398,396.9219,408,400.9219,398,404.9219,402,400.9219" style="stroke: #A80036; stroke-width: 1.0;"/><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 2.0,2.0;" x1="42" x2="404" y1="400.9219" y2="400.9219"/><text fill="#000000" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="9" x="49" y="395.856">6</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="182" x="62" y="395.856">Set PDP Group in Safe Mode</text><path d="M377.5,415.9219 L454.5,415.9219 L454.5,422.9219 L444.5,432.9219 L377.5,432.9219 L377.5,415.9219 " fill="#EEEEEE" style="stroke: #000000; stroke-width: 1.0;"/><rect fill="none" height="46.2656" style="stroke: #000000; stroke-width: 2.0;" width="349" x="377.5" y="415.9219"/><text fill="#000000" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="32" x="392.5" y="428.9888">loop</text><text fill="#000000" font-family="sans-serif" font-size="11" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="109" x="469.5" y="428.1323">[over PDP Group]</text><polygon fill="#A80036" points="681,450.1875,691,454.1875,681,458.1875,685,454.1875" style="stroke: #A80036; stroke-width: 1.0;"/><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 2.0,2.0;" x1="410" x2="687" y1="454.1875" y2="454.1875"/><text fill="#000000" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="9" x="417" y="449.1216">7</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="145" x="430" y="449.1216">Set PDP in SAFE mode</text><polygon fill="#A80036" points="421,486.3203,411,490.3203,421,494.3203,417,490.3203" style="stroke: #A80036; stroke-width: 1.0;"/><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 2.0,2.0;" x1="415" x2="692" y1="490.3203" y2="490.3203"/><text fill="#000000" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="9" x="427" y="485.2544">8</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="226" x="440" y="485.2544">Report safe mode operation results</text><polygon fill="#A80036" points="53,515.4531,43,519.4531,53,523.4531,49,519.4531" style="stroke: #A80036; stroke-width: 1.0;"/><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 2.0,2.0;" x1="47" x2="409" y1="519.4531" y2="519.4531"/><text fill="#000000" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="9" x="59" y="514.3872">9</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="311" x="72" y="514.3872">Report consolidated safe mode operation results</text><polygon fill="#A80036" points="398,544.5859,408,548.5859,398,552.5859,402,548.5859" style="stroke: #A80036; stroke-width: 1.0;"/><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 2.0,2.0;" x1="42" x2="404" y1="548.5859" y2="548.5859"/><text fill="#000000" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="18" x="49" y="543.52">10</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="192" x="71" y="543.52">Set PDP Group in Active Mode</text><path d="M377.5,563.5859 L454.5,563.5859 L454.5,570.5859 L444.5,580.5859 L377.5,580.5859 L377.5,563.5859 " fill="#EEEEEE" style="stroke: #000000; stroke-width: 1.0;"/><rect fill="none" height="46.2656" style="stroke: #000000; stroke-width: 2.0;" width="349" x="377.5" y="563.5859"/><text fill="#000000" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="32" x="392.5" y="576.6528">loop</text><text fill="#000000" font-family="sans-serif" font-size="11" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="109" x="469.5" y="575.7964">[over PDP Group]</text><polygon fill="#A80036" points="681,597.8516,691,601.8516,681,605.8516,685,601.8516" style="stroke: #A80036; stroke-width: 1.0;"/><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 2.0,2.0;" x1="410" x2="687" y1="601.8516" y2="601.8516"/><text fill="#000000" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="18" x="417" y="596.7856">11</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="151" x="439" y="596.7856">Set PDP in Active mode</text><path d="M13,623.8516 L90,623.8516 L90,630.8516 L80,640.8516 L13,640.8516 L13,623.8516 " fill="#EEEEEE" style="stroke: #000000; stroke-width: 1.0;"/><rect fill="none" height="75.3984" style="stroke: #000000; stroke-width: 2.0;" width="713.5" x="13" y="623.8516"/><text fill="#000000" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="32" x="28" y="636.9185">loop</text><text fill="#000000" font-family="sans-serif" font-size="11" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="56" x="105" y="636.062">[forever]</text><polygon fill="#A80036" points="421,658.1172,411,662.1172,421,666.1172,417,662.1172" style="stroke: #A80036; stroke-width: 1.0;"/><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 2.0,2.0;" x1="415" x2="692" y1="662.1172" y2="662.1172"/><text fill="#000000" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="18" x="427" y="657.0513">12</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="237" x="449" y="657.0513">Report active mode operation results</text><polygon fill="#A80036" points="53,687.25,43,691.25,53,695.25,49,691.25" style="stroke: #A80036; stroke-width: 1.0;"/><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 2.0,2.0;" x1="47" x2="409" y1="691.25" y2="691.25"/><text fill="#000000" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="18" x="59" y="686.1841">13</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="322" x="81" y="686.1841">Report consolidated active mode operation results</text><!-- +@startuml
+title Policy Rollout
+
+actor User
+participant PAP
+participant PDP
+
+autonumber
+User - -> PAP: Create Policy Set for PDP Group
+
+loop over PDP Group
+ ref over PAP, PDP: PAP downloads Policy Set to PDP
+end
+
+User - -> PAP: Set PDP Group in Test Mode
+
+loop over PDP Group
+ PAP - -> PDP: Set PDP in TEST mode
+end
+
+PDP - -> PAP: Report test results
+PAP - -> User: Report consolidated test results
+
+User - -> PAP: Set PDP Group in Safe Mode
+loop over PDP Group
+ PAP - -> PDP: Set PDP in SAFE mode
+end
+
+PDP - -> PAP: Report safe mode operation results
+PAP - -> User: Report consolidated safe mode operation results
+
+User - -> PAP: Set PDP Group in Active Mode
+loop over PDP Group
+ PAP - -> PDP: Set PDP in Active mode
+end
+
+loop forever
+ PDP - -> PAP: Report active mode operation results
+ PAP - -> User: Report consolidated active mode operation results
+end
+@enduml
+ +PlantUML version 1.2019.07beta1(Unknown compile time) +(GPL source distribution) +Java Runtime: Java(TM) SE Runtime Environment +JVM: Java HotSpot(TM) 64-Bit Server VM +Java Version: 1.7.0_25-b15 +Operating System: Linux +Default Encoding: UTF-8 +Language: en +Country: US +--></g></svg>
\ No newline at end of file diff --git a/docs/architecture/images/PolicyTypeDesign.svg b/docs/architecture/images/PolicyTypeDesign.svg new file mode 100644 index 00000000..fda281c1 --- /dev/null +++ b/docs/architecture/images/PolicyTypeDesign.svg @@ -0,0 +1,38 @@ +<?xml version="1.0" encoding="UTF-8" standalone="no"?><svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" contentScriptType="application/ecmascript" contentStyleType="text/css" height="482px" preserveAspectRatio="none" style="width:706px;height:482px;" version="1.1" viewBox="0 0 706 482" width="706px" zoomAndPan="magnify"><defs><filter height="300%" id="f1u2ra6ywuerh9" width="300%" x="-1" y="-1"><feGaussianBlur result="blurOut" stdDeviation="2.0"/><feColorMatrix in="blurOut" result="blurOut2" type="matrix" values="0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 .4 0"/><feOffset dx="4.0" dy="4.0" in="blurOut2" result="blurOut3"/><feBlend in="SourceGraphic" in2="blurOut3" mode="normal"/></filter></defs><g><text fill="#000000" font-family="sans-serif" font-size="14" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="149" x="279" y="22.9951">Policy Type Design</text><rect fill="#ADD8E6" height="437.0234" style="stroke: #A80036; stroke-width: 1.0;" width="148" x="387" y="34.2969"/><text fill="#000000" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="94" x="414" y="46.3638">PolicyDesign</text><rect fill="#FFFFFF" filter="url(#f1u2ra6ywuerh9)" height="28" style="stroke: #A80036; stroke-width: 1.0;" width="10" x="66" y="305.4609"/><rect fill="#FFFFFF" filter="url(#f1u2ra6ywuerh9)" height="90.2031" style="stroke: #000000; stroke-width: 2.0;" width="528" x="13" y="179.125"/><rect fill="#FFFFFF" height="43.9375" style="stroke: none; stroke-width: 1.0;" width="528" x="13" y="225.3906"/><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 5.0,5.0;" x1="71" x2="71" y1="88.7266" y2="416.7266"/><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 5.0,5.0;" x1="461" x2="461" y1="88.7266" y2="416.7266"/><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 5.0,5.0;" x1="660" x2="660" y1="88.7266" y2="416.7266"/><rect fill="#FEFECE" filter="url(#f1u2ra6ywuerh9)" height="46.5938" style="stroke: #A80036; stroke-width: 1.5;" width="92" x="23" y="37.1328"/><text fill="#000000" font-family="sans-serif" font-size="14" font-style="italic" lengthAdjust="spacingAndGlyphs" textLength="78" x="30" y="58.1328">«API_User»</text><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacingAndGlyphs" textLength="66" x="36" y="74.4297">DCAE_DS</text><rect fill="#FEFECE" filter="url(#f1u2ra6ywuerh9)" height="46.5938" style="stroke: #A80036; stroke-width: 1.5;" width="92" x="23" y="415.7266"/><text fill="#000000" font-family="sans-serif" font-size="14" font-style="italic" lengthAdjust="spacingAndGlyphs" textLength="78" x="30" y="436.7266">«API_User»</text><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacingAndGlyphs" textLength="66" x="36" y="453.0234">DCAE_DS</text><rect fill="#FEFECE" filter="url(#f1u2ra6ywuerh9)" height="30.2969" style="stroke: #A80036; stroke-width: 1.5;" width="136" x="391" y="53.4297"/><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacingAndGlyphs" textLength="122" x="398" y="73.4248">PolicyTypeDesign</text><rect fill="#FEFECE" filter="url(#f1u2ra6ywuerh9)" height="30.2969" style="stroke: #A80036; stroke-width: 1.5;" width="136" x="391" y="415.7266"/><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacingAndGlyphs" textLength="122" x="398" y="435.7217">PolicyTypeDesign</text><rect fill="#FEFECE" filter="url(#f1u2ra6ywuerh9)" height="30.2969" style="stroke: #A80036; stroke-width: 1.5;" width="74" x="621" y="53.4297"/><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacingAndGlyphs" textLength="60" x="628" y="73.4248">PolicyDB</text><rect fill="#FEFECE" filter="url(#f1u2ra6ywuerh9)" height="30.2969" style="stroke: #A80036; stroke-width: 1.5;" width="74" x="621" y="415.7266"/><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacingAndGlyphs" textLength="60" x="628" y="435.7217">PolicyDB</text><rect fill="#FFFFFF" filter="url(#f1u2ra6ywuerh9)" height="28" style="stroke: #A80036; stroke-width: 1.0;" width="10" x="66" y="305.4609"/><polygon fill="#A80036" points="449,115.8594,459,119.8594,449,123.8594,453,119.8594" style="stroke: #A80036; stroke-width: 1.0;"/><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 2.0,2.0;" x1="71" x2="455" y1="119.8594" y2="119.8594"/><text fill="#000000" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="9" x="78" y="114.7935">1</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="258" x="91" y="114.7935">Get Policy Type Reference and Metadata</text><polygon fill="#A80036" points="648,160.125,658,164.125,648,168.125,652,164.125" style="stroke: #A80036; stroke-width: 1.0;"/><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 2.0,2.0;" x1="461" x2="654" y1="164.125" y2="164.125"/><text fill="#000000" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="9" x="468" y="151.4927">2</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="162" x="481" y="143.9263">Get Policy Type Metadata</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="74" x="481" y="159.0591">and Artifact</text><path d="M13,179.125 L77,179.125 L77,186.125 L67,196.125 L13,196.125 L13,179.125 " fill="#EEEEEE" style="stroke: #000000; stroke-width: 1.0;"/><rect fill="none" height="90.2031" style="stroke: #000000; stroke-width: 2.0;" width="528" x="13" y="179.125"/><text fill="#000000" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="19" x="28" y="192.1919">alt</text><text fill="#000000" font-family="sans-serif" font-size="11" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="176" x="92" y="191.3354">[Policy Type Artifact exists]</text><polygon fill="#A80036" points="82,213.3906,72,217.3906,82,221.3906,78,217.3906" style="stroke: #A80036; stroke-width: 1.0;"/><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 2.0,2.0;" x1="76" x2="460" y1="217.3906" y2="217.3906"/><text fill="#000000" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="9" x="88" y="212.3247">3</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="277" x="101" y="212.3247">Return Policy Type Reference and Metadata</text><line style="stroke: #000000; stroke-width: 1.0; stroke-dasharray: 2.0,2.0;" x1="13" x2="541" y1="226.3906" y2="226.3906"/><text fill="#000000" font-family="sans-serif" font-size="11" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="194" x="18" y="236.6011">[Policy Artifact does not exist]</text><polygon fill="#A80036" points="82,257.3281,72,261.3281,82,265.3281,78,261.3281" style="stroke: #A80036; stroke-width: 1.0;"/><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 2.0,2.0;" x1="76" x2="460" y1="261.3281" y2="261.3281"/><text fill="#000000" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="9" x="88" y="256.2622">4</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="353" x="101" y="256.2622">Return New Policy Type Reference and Empty Metadata</text><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 2.0,2.0;" x1="76" x2="118" y1="297.4609" y2="297.4609"/><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 2.0,2.0;" x1="118" x2="118" y1="297.4609" y2="310.4609"/><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 2.0,2.0;" x1="77" x2="118" y1="310.4609" y2="310.4609"/><polygon fill="#A80036" points="87,306.4609,77,310.4609,87,314.4609,83,310.4609" style="stroke: #A80036; stroke-width: 1.0;"/><text fill="#000000" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="9" x="83" y="292.395">5</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="274" x="96" y="292.395">Policy Type Editing and Generation Session</text><polygon fill="#A80036" points="449,365.5938,459,369.5938,449,373.5938,453,369.5938" style="stroke: #A80036; stroke-width: 1.0;"/><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 2.0,2.0;" x1="71" x2="455" y1="369.5938" y2="369.5938"/><text fill="#000000" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="9" x="78" y="364.5278">6</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="210" x="91" y="364.5278">Create Policy Type and Metadata</text><polygon fill="#A80036" points="82,394.7266,72,398.7266,82,402.7266,78,398.7266" style="stroke: #A80036; stroke-width: 1.0;"/><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 2.0,2.0;" x1="76" x2="460" y1="398.7266" y2="398.7266"/><text fill="#000000" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="9" x="88" y="393.6606">7</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="154" x="101" y="393.6606">Policy Generation Result</text><!-- +@startuml
+title Policy Type Design
+
+participant DCAE_DS <<API_User >>
+box "PolicyDesign" #LightBlue
+ participant PolicyTypeDesign
+end box
+autonumber
+
+DCAE_DS - -> PolicyTypeDesign : Get Policy Type Reference and Metadata
+PolicyTypeDesign - -> PolicyDB : Get Policy Type Metadata\nand Artifact
+
+alt Policy Type Artifact exists
+ PolicyTypeDesign - -> DCAE_DS : Return Policy Type Reference and Metadata
+else Policy Artifact does not exist
+ PolicyTypeDesign - -> DCAE_DS : Return New Policy Type Reference and Empty Metadata
+end
+
+DCAE_DS - -> DCAE_DS : Policy Type Editing and Generation Session
+
+activate DCAE_DS
+deactivate DCAE_DS
+
+DCAE_DS - -> PolicyTypeDesign : Create Policy Type and Metadata
+PolicyTypeDesign - -> DCAE_DS : Policy Generation Result
+@enduml
+ +PlantUML version 1.2019.07beta1(Unknown compile time) +(GPL source distribution) +Java Runtime: Java(TM) SE Runtime Environment +JVM: Java HotSpot(TM) 64-Bit Server VM +Java Version: 1.7.0_25-b15 +Operating System: Linux +Default Encoding: UTF-8 +Language: en +Country: US +--></g></svg>
\ No newline at end of file diff --git a/docs/architecture/images/RuntimeRelationships.svg b/docs/architecture/images/RuntimeRelationships.svg new file mode 100644 index 00000000..cb1d66c7 --- /dev/null +++ b/docs/architecture/images/RuntimeRelationships.svg @@ -0,0 +1,27 @@ +<?xml version="1.0" encoding="UTF-8" standalone="no"?><svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" contentScriptType="application/ecmascript" contentStyleType="text/css" height="464px" preserveAspectRatio="none" style="width:382px;height:464px;" version="1.1" viewBox="0 0 382 464" width="382px" zoomAndPan="magnify"><defs><filter height="300%" id="f1j1xcr4r55ehk" width="300%" x="-1" y="-1"><feGaussianBlur result="blurOut" stdDeviation="2.0"/><feColorMatrix in="blurOut" result="blurOut2" type="matrix" values="0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 .4 0"/><feOffset dx="4.0" dy="4.0" in="blurOut2" result="blurOut3"/><feBlend in="SourceGraphic" in2="blurOut3" mode="normal"/></filter></defs><g><text fill="#000000" font-family="sans-serif" font-size="18" lengthAdjust="spacingAndGlyphs" textLength="368" x="2" y="16.708">Runtime Relationships between Concepts</text><rect fill="#FEFECE" filter="url(#f1j1xcr4r55ehk)" height="33.9688" style="stroke: #A80036; stroke-width: 1.5;" width="101" x="169.5" y="28.9531"/><text fill="#000000" font-family="sans-serif" font-size="12" lengthAdjust="spacingAndGlyphs" textLength="87" x="176.5" y="42.0918">PDPSubGroup</text><line style="stroke: #A80036; stroke-width: 1.5;" x1="170.5" x2="269.5" y1="46.9219" y2="46.9219"/><rect fill="#FEFECE" filter="url(#f1j1xcr4r55ehk)" height="33.9688" style="stroke: #A80036; stroke-width: 1.5;" width="84" x="178" y="169.9531"/><text fill="#000000" font-family="sans-serif" font-size="12" lengthAdjust="spacingAndGlyphs" textLength="70" x="185" y="183.0918">PDPService</text><line style="stroke: #A80036; stroke-width: 1.5;" x1="179" x2="261" y1="187.9219" y2="187.9219"/><rect fill="#FEFECE" filter="url(#f1j1xcr4r55ehk)" height="33.9688" style="stroke: #A80036; stroke-width: 1.5;" width="70" x="130" y="287.4531"/><text fill="#000000" font-family="sans-serif" font-size="12" lengthAdjust="spacingAndGlyphs" textLength="56" x="137" y="300.5918">PolicySet</text><line style="stroke: #A80036; stroke-width: 1.5;" x1="131" x2="199" y1="305.4219" y2="305.4219"/><rect fill="#FEFECE" filter="url(#f1j1xcr4r55ehk)" height="33.9688" style="stroke: #A80036; stroke-width: 1.5;" width="39" x="202.5" y="419.9531"/><text fill="#000000" font-family="sans-serif" font-size="12" lengthAdjust="spacingAndGlyphs" textLength="25" x="209.5" y="433.0918">PDP</text><line style="stroke: #A80036; stroke-width: 1.5;" x1="203.5" x2="240.5" y1="437.9219" y2="437.9219"/><rect fill="#FEFECE" filter="url(#f1j1xcr4r55ehk)" height="33.9688" style="stroke: #A80036; stroke-width: 1.5;" width="74" x="26" y="419.9531"/><text fill="#000000" font-family="sans-serif" font-size="12" lengthAdjust="spacingAndGlyphs" textLength="60" x="33" y="433.0918">PolicyImpl</text><line style="stroke: #A80036; stroke-width: 1.5;" x1="27" x2="99" y1="437.9219" y2="437.9219"/><!--link PDPSubGroup to PDPService--><path d="M220,63.1701 C220,89.9541 220,143.1231 220,169.8391 " fill="none" id="PDPSubGroup-PDPService" style="stroke: #A80036; stroke-width: 1.0;"/><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="54" x="223.5" y="106.02">Lifecycle</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="59" x="221" y="121.1528">Managed</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="16" x="242.5" y="136.2856">By</text><polygon fill="#000000" points="246,145.3516,249,151.3516,252,145.3516,246,145.3516" style="stroke: #000000; stroke-width: 1.0;"/><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="8" x="210.725" y="83.1417">1</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="8" x="210.675" y="158.7798">1</text><!--link PDPService to PDP--><path d="M232.746,203.9601 C238.629,212.3681 244.971,223.1511 248,233.9531 C266.72,300.7111 265.638,322.9011 248,389.9531 C245.2,400.5991 239.312,411.3719 233.846,419.8134 " fill="none" id="PDPService-PDP" style="stroke: #A80036; stroke-width: 1.0;"/><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="58" x="262" y="294.02">Manages</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="54" x="264" y="309.1528">Lifecycle</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="14" x="284" y="324.2856">Of</text><polygon fill="#000000" points="286.5,333.3516,289.5,339.3516,292.5,333.3516,286.5,333.3516" style="stroke: #000000; stroke-width: 1.0;"/><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="8" x="227.5338" y="223.8648">1</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="7" x="229.6106" y="408.7456">*</text><!--link PDPService to PolicySet--><path d="M196.343,204.0821 C186.794,211.9201 176.702,222.1941 171,233.9531 C162.809,250.8431 162.337,272.7591 163.24,287.4221 " fill="none" id="PDPService-PolicySet" style="stroke: #A80036; stroke-width: 1.0;"/><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="58" x="172" y="247.02">Executes</text><polygon fill="#000000" points="196.5,256.0859,199.5,262.0859,202.5,256.0859,196.5,256.0859" style="stroke: #000000; stroke-width: 1.0;"/><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="8" x="179.5273" y="224.0257">1</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="8" x="153.332" y="276.3903">1</text><!--link PolicySet to PDP--><path d="M162.702,321.6261 C160.943,339.3451 160.36,368.1435 171,389.9531 C177.849,403.9916 191.043,415.7079 202.295,423.8026 " fill="none" id="PolicySet-PDP" style="stroke: #A80036; stroke-width: 1.0;"/><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="58" x="172" y="371.02">Executes</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="18" x="192" y="386.1528">On</text><polygon fill="#000000" points="196.5,395.2188,199.5,401.2188,202.5,395.2188,196.5,395.2188" style="stroke: #000000; stroke-width: 1.0;"/><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="8" x="152.6945" y="341.5837">1</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="7" x="187.6083" y="414.0562">*</text><!--link PolicySet to PolicyImpl--><path d="M129.911,320.8371 C113.7586,329.5641 95.6397,341.9671 84,357.9531 C70.5446,376.4323 65.7102,403.0015 63.9734,419.8668 " fill="none" id="PolicySet-PolicyImpl" style="stroke: #A80036; stroke-width: 1.0;"/><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="56" x="85" y="378.52">Contains</text><polygon fill="#000000" points="108.5,387.5859,111.5,393.5859,114.5,387.5859,108.5,387.5859" style="stroke: #000000; stroke-width: 1.0;"/><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="8" x="113.8485" y="319.7533">1</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="7" x="56.1365" y="408.8167">*</text><!-- +@startuml
+title Runtime Relationships between Concepts
+
+object PDPSubGroup
+object PDPService
+object PolicySet
+object PDP
+object PolicyImpl
+
+PDPSubGroup "1" - - "1" PDPService : > Lifecycle\nManaged\nBy
+PDPService "1" - - "*" PDP : > Manages\nLifecycle\nOf
+PDPService "1" - - "1" PolicySet : > Executes
+PolicySet "1" - - "*" PDP : > Executes\nOn
+PolicySet "1" - - "*" PolicyImpl : > Contains
+@enduml
+ +PlantUML version 1.2019.07beta1(Unknown compile time) +(GPL source distribution) +Java Runtime: Java(TM) SE Runtime Environment +JVM: Java HotSpot(TM) 64-Bit Server VM +Java Version: 1.7.0_25-b15 +Operating System: Linux +Default Encoding: UTF-8 +Language: en +Country: US +--></g></svg>
\ No newline at end of file diff --git a/docs/architecture/images/ScriptedPolicyDesign.svg b/docs/architecture/images/ScriptedPolicyDesign.svg new file mode 100644 index 00000000..e94a4dbb --- /dev/null +++ b/docs/architecture/images/ScriptedPolicyDesign.svg @@ -0,0 +1,39 @@ +<?xml version="1.0" encoding="UTF-8" standalone="no"?><svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" contentScriptType="application/ecmascript" contentStyleType="text/css" height="448px" preserveAspectRatio="none" style="width:752px;height:448px;" version="1.1" viewBox="0 0 752 448" width="752px" zoomAndPan="magnify"><defs><filter height="300%" id="f1p7i2pae4gg2k" width="300%" x="-1" y="-1"><feGaussianBlur result="blurOut" stdDeviation="2.0"/><feColorMatrix in="blurOut" result="blurOut2" type="matrix" values="0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 .4 0"/><feOffset dx="4.0" dy="4.0" in="blurOut2" result="blurOut3"/><feBlend in="SourceGraphic" in2="blurOut3" mode="normal"/></filter></defs><g><text fill="#000000" font-family="sans-serif" font-size="14" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="176" x="289.25" y="22.9951">Scripted Policy Design</text><rect fill="#ADD8E6" height="403.0859" style="stroke: #A80036; stroke-width: 1.0;" width="264" x="471.5" y="34.2969"/><text fill="#000000" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="94" x="556.5" y="46.3638">PolicyDesign</text><rect fill="#FFFFFF" filter="url(#f1p7i2pae4gg2k)" height="274.0625" style="stroke: #A80036; stroke-width: 1.0;" width="10" x="66" y="98.7266"/><rect fill="#FFFFFF" filter="url(#f1p7i2pae4gg2k)" height="260.0625" style="stroke: #000000; stroke-width: 2.0;" width="728.5" x="13" y="105.7266"/><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 5.0,5.0;" x1="71" x2="71" y1="88.7266" y2="382.7891"/><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 5.0,5.0;" x1="412.5" x2="412.5" y1="88.7266" y2="382.7891"/><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 5.0,5.0;" x1="545.5" x2="545.5" y1="88.7266" y2="382.7891"/><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 5.0,5.0;" x1="678.5" x2="678.5" y1="88.7266" y2="382.7891"/><rect fill="#FEFECE" filter="url(#f1p7i2pae4gg2k)" height="46.5938" style="stroke: #A80036; stroke-width: 1.5;" width="92" x="23" y="37.1328"/><text fill="#000000" font-family="sans-serif" font-size="14" font-style="italic" lengthAdjust="spacingAndGlyphs" textLength="78" x="30" y="58.1328">«API_User»</text><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacingAndGlyphs" textLength="39" x="49.5" y="74.4297">Script</text><rect fill="#FEFECE" filter="url(#f1p7i2pae4gg2k)" height="46.5938" style="stroke: #A80036; stroke-width: 1.5;" width="92" x="23" y="381.7891"/><text fill="#000000" font-family="sans-serif" font-size="14" font-style="italic" lengthAdjust="spacingAndGlyphs" textLength="78" x="30" y="402.7891">«API_User»</text><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacingAndGlyphs" textLength="39" x="49.5" y="419.0859">Script</text><rect fill="#FEFECE" filter="url(#f1p7i2pae4gg2k)" height="30.2969" style="stroke: #A80036; stroke-width: 1.5;" width="97" x="364.5" y="49.4297"/><rect fill="#FEFECE" filter="url(#f1p7i2pae4gg2k)" height="30.2969" style="stroke: #A80036; stroke-width: 1.5;" width="97" x="360.5" y="53.4297"/><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacingAndGlyphs" textLength="83" x="367.5" y="73.4248">DirectiveFile</text><rect fill="#FEFECE" filter="url(#f1p7i2pae4gg2k)" height="30.2969" style="stroke: #A80036; stroke-width: 1.5;" width="97" x="364.5" y="381.7891"/><rect fill="#FEFECE" filter="url(#f1p7i2pae4gg2k)" height="30.2969" style="stroke: #A80036; stroke-width: 1.5;" width="97" x="360.5" y="385.7891"/><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacingAndGlyphs" textLength="83" x="367.5" y="405.7842">DirectiveFile</text><rect fill="#FEFECE" filter="url(#f1p7i2pae4gg2k)" height="30.2969" style="stroke: #A80036; stroke-width: 1.5;" width="136" x="475.5" y="53.4297"/><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacingAndGlyphs" textLength="122" x="482.5" y="73.4248">PolicyTypeDesign</text><rect fill="#FEFECE" filter="url(#f1p7i2pae4gg2k)" height="30.2969" style="stroke: #A80036; stroke-width: 1.5;" width="136" x="475.5" y="381.7891"/><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacingAndGlyphs" textLength="122" x="482.5" y="401.7842">PolicyTypeDesign</text><rect fill="#FEFECE" filter="url(#f1p7i2pae4gg2k)" height="30.2969" style="stroke: #A80036; stroke-width: 1.5;" width="102" x="625.5" y="53.4297"/><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacingAndGlyphs" textLength="88" x="632.5" y="73.4248">PolicyDesign</text><rect fill="#FEFECE" filter="url(#f1p7i2pae4gg2k)" height="30.2969" style="stroke: #A80036; stroke-width: 1.5;" width="102" x="625.5" y="381.7891"/><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacingAndGlyphs" textLength="88" x="632.5" y="401.7842">PolicyDesign</text><rect fill="#FFFFFF" filter="url(#f1p7i2pae4gg2k)" height="274.0625" style="stroke: #A80036; stroke-width: 1.0;" width="10" x="66" y="98.7266"/><path d="M13,105.7266 L90,105.7266 L90,112.7266 L80,122.7266 L13,122.7266 L13,105.7266 " fill="#EEEEEE" style="stroke: #000000; stroke-width: 1.0;"/><rect fill="none" height="260.0625" style="stroke: #000000; stroke-width: 2.0;" width="728.5" x="13" y="105.7266"/><text fill="#000000" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="32" x="28" y="118.7935">loop</text><polygon fill="#A80036" points="401,139.9922,411,143.9922,401,147.9922,405,143.9922" style="stroke: #A80036; stroke-width: 1.0;"/><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 2.0,2.0;" x1="76" x2="407" y1="143.9922" y2="143.9922"/><text fill="#000000" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="9" x="83" y="138.9263">1</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="217" x="96" y="138.9263">Read next directive from script file</text><polygon fill="#A80036" points="533.5,169.125,543.5,173.125,533.5,177.125,537.5,173.125" style="stroke: #A80036; stroke-width: 1.0;"/><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 2.0,2.0;" x1="76" x2="539.5" y1="173.125" y2="173.125"/><text fill="#000000" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="9" x="83" y="168.0591">2</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="185" x="96" y="168.0591">Read Policy Type for directive</text><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 2.0,2.0;" x1="76" x2="118" y1="202.2578" y2="202.2578"/><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 2.0,2.0;" x1="118" x2="118" y1="202.2578" y2="215.2578"/><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 2.0,2.0;" x1="77" x2="118" y1="215.2578" y2="215.2578"/><polygon fill="#A80036" points="87,211.2578,77,215.2578,87,219.2578,83,215.2578" style="stroke: #A80036; stroke-width: 1.0;"/><text fill="#000000" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="9" x="83" y="197.1919">3</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="223" x="96" y="197.1919">Prepare TOSCA Policy for coreation</text><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 2.0,2.0;" x1="76" x2="118" y1="244.3906" y2="244.3906"/><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 2.0,2.0;" x1="118" x2="118" y1="244.3906" y2="257.3906"/><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 2.0,2.0;" x1="77" x2="118" y1="257.3906" y2="257.3906"/><polygon fill="#A80036" points="87,253.3906,77,257.3906,87,261.3906,83,257.3906" style="stroke: #A80036; stroke-width: 1.0;"/><text fill="#000000" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="9" x="83" y="239.3247">4</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="264" x="96" y="239.3247">Read parameters from script file directive</text><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 2.0,2.0;" x1="76" x2="118" y1="286.5234" y2="286.5234"/><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 2.0,2.0;" x1="118" x2="118" y1="286.5234" y2="299.5234"/><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 2.0,2.0;" x1="77" x2="118" y1="299.5234" y2="299.5234"/><polygon fill="#A80036" points="87,295.5234,77,299.5234,87,303.5234,83,299.5234" style="stroke: #A80036; stroke-width: 1.0;"/><text fill="#000000" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="9" x="83" y="281.4575">5</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="305" x="96" y="281.4575">Set Parameters in TOSCA Policy being prepared</text><polygon fill="#A80036" points="666.5,324.6563,676.5,328.6563,666.5,332.6563,670.5,328.6563" style="stroke: #A80036; stroke-width: 1.0;"/><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 2.0,2.0;" x1="76" x2="672.5" y1="328.6563" y2="328.6563"/><text fill="#000000" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="9" x="83" y="323.5903">6</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="83" x="96" y="323.5903">Create Policy</text><polygon fill="#A80036" points="87,353.7891,77,357.7891,87,361.7891,83,357.7891" style="stroke: #A80036; stroke-width: 1.0;"/><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 2.0,2.0;" x1="81" x2="677.5" y1="357.7891" y2="357.7891"/><text fill="#000000" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="9" x="93" y="352.7231">7</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="132" x="106" y="352.7231">Policy creation result</text><!-- +@startuml
+title Scripted Policy Design
+
+participant Script <<API_User >>
+collections DirectiveFile
+
+box "PolicyDesign" #LightBlue
+ participant PolicyTypeDesign
+ participant PolicyDesign
+end box
+
+autonumber
+
+activate Script
+
+loop
+ Script - -> DirectiveFile : Read next directive from script file
+ Script - -> PolicyTypeDesign : Read Policy Type for directive
+ Script - -> Script : Prepare TOSCA Policy for coreation
+ Script - -> Script : Read parameters from script file directive
+ Script - -> Script : Set Parameters in TOSCA Policy being prepared
+ Script - -> PolicyDesign : Create Policy
+ PolicyDesign - -> Script : Policy creation result
+end
+
+deactivate Script
+@enduml
+ +PlantUML version 1.2019.07beta1(Unknown compile time) +(GPL source distribution) +Java Runtime: Java(TM) SE Runtime Environment +JVM: Java HotSpot(TM) 64-Bit Server VM +Java Version: 1.7.0_25-b15 +Operating System: Linux +Default Encoding: UTF-8 +Language: en +Country: US +--></g></svg>
\ No newline at end of file diff --git a/docs/architecture/plantuml/DownloadPoliciesToPDP.puml b/docs/architecture/plantuml/DownloadPoliciesToPDP.puml new file mode 100644 index 00000000..ceab8ab5 --- /dev/null +++ b/docs/architecture/plantuml/DownloadPoliciesToPDP.puml @@ -0,0 +1,45 @@ +@startuml + +title Download Policies to PDP + +actor User +database PolicyDB +participant PAP +participant DMaaP +participant PDP + +autonumber + +alt PDP Startup + PDP --> PAP: Send Status (initial status) to PAP +else Update Request from User + User --> PAP : Update Policies on PDP +end + +PAP --> PolicyDB: Read PDP metadata and Policy Set +PAP -> PAP: Prepare for PDP update +activate PAP +deactivate PAP + +PAP --> PDP: Set PDP mode as PASSIVE + +PAP --> PDP: Transfer Policy Set Policies to PDP + +activate PDP +PDP --> PDP: Load Policies +deactivate PDP + +alt PDP Mode should be ACTIVE + PAP --> PDP : Set PDP mode as ACTIVE + ref over PDP: Execute Policies in\nACTIVE Mode +else PDP Mode should be SAFE + PAP --> PDP : Set PDP mode as SAFE + ref over PDP: Execute Policies in\nSAFE Mode +else PDP Mode should be TEST + PAP --> PDP : Set PDP mode as TEST + ref over PDP: Execute Policies in\nTEST Mode +end + +PAP --> PolicyDB: Update PDP metadata + +@enduml
\ No newline at end of file diff --git a/docs/architecture/plantuml/ModelDrivenPolicyDesign.puml b/docs/architecture/plantuml/ModelDrivenPolicyDesign.puml new file mode 100644 index 00000000..31142b0b --- /dev/null +++ b/docs/architecture/plantuml/ModelDrivenPolicyDesign.puml @@ -0,0 +1,36 @@ +@startuml + +title Model Driven Policy Design + +participant SDC +participant DMaaP + +box "PolicyDesign" #LightBlue + participant PolicyDistribution << API_User >> + participant PolicyDesign +end box + +autonumber + +PolicyDistribution --> DMaaP : Subscribe for SDC Notifications\non Entries of Interest +SDC --> DMaaP : New Entry of Interest: EntityA +DMaaP --> PolicyDistribution : New Entry of Interest: EntityA + +PolicyDistribution --> SDC : Download CSAR for EntityA that holds TOSCA Policy Specification + +PolicyDistribution --> PolicyDesign : Get Policy Reference +PolicyDesign --> PolicyDistribution : Return Policy Reference and Metadata +PolicyDistribution --> PolicyDistribution : Create Policy Editing and Generation Session + +activate PolicyDistribution +loop + PolicyDistribution --> PolicyDesign : Use Policy Type specification to\nread Policy Parameters\nfrom TOSCA specification in CSAR +end + +PolicyDistribution --> PolicyDesign : Create Policy +PolicyDesign --> PolicyDistribution : Policy Creation Result +deactivate PolicyDistribution + +PolicyDistribution --> SDC : Notify SDC of operation result + +@enduml
\ No newline at end of file diff --git a/docs/architecture/plantuml/PAPStartStop.puml b/docs/architecture/plantuml/PAPStartStop.puml new file mode 100644 index 00000000..cffed84e --- /dev/null +++ b/docs/architecture/plantuml/PAPStartStop.puml @@ -0,0 +1,24 @@ +@startuml + +title PAP Startup and Shutdown + +participant K8S +participant PAP +database PolicyDB + +autonumber + +K8S --> PAP : Start PAP + +PAP --> PolicyDB : Read Initial Data +PAP --> PAP : Initialize Policy Administration + +activate PAP +deactivate PAP + +loop forever + ref over PAP: Wait for and\nHandle PDP\nStatus Updates + ref over PAP: Wait for and\nHandle\nAdmin Requests +end + +@enduml
\ No newline at end of file diff --git a/docs/architecture/plantuml/PDPStartStop.puml b/docs/architecture/plantuml/PDPStartStop.puml new file mode 100644 index 00000000..d55f6d1d --- /dev/null +++ b/docs/architecture/plantuml/PDPStartStop.puml @@ -0,0 +1,22 @@ +@startuml + +title PDP Startup and Shutdown + +participant K8S +participant PDP +participant DMaaP +participant PAP + +autonumber + +K8S --> PDP : Start PDP + +PDP --> PAP: Send Status (initial status) to PAP + +PAP --> PDP: Download Policy Set to PDP + +loop forever + PDP --> PAP: Send Status to PAP +end + +@enduml
\ No newline at end of file diff --git a/docs/architecture/plantuml/PolicyDatabase.puml b/docs/architecture/plantuml/PolicyDatabase.puml new file mode 100644 index 00000000..3597324e --- /dev/null +++ b/docs/architecture/plantuml/PolicyDatabase.puml @@ -0,0 +1,54 @@ +@startuml + +title Indicative Database Layout + +!define table(x) class x << (T,#FFAAAA) >> +!define primary_key(x) <u>x</u> +hide methods +hide stereotypes + +table(PDP_SUBGROUP) { + primary_key(PDP_SUBGROUP_ID) + PDP_SUBGROUP_NAME + PDP_SUBGROUP_VERSION + PDP_TYPE + PDP_SERVICE_ENDPOINT + POLICY_SET_ID + PDP_SUBGROUP_STATE +} + +table(PDP) { + primary_key(PDP_ID) + PDP_NAME + PDP_VERSION + PDP_TYPE + PDP_ENDPOINT + PDP_SUBGROUP_ID + POLICY_SET_ID PDP_STATE +} + +table(POLICY_SET) { + primary_key(POLICY_SET_ID) + POLICY_SET_NAME + POLICY_SET_VERSION +} + +table(POLICY_TYPE_IMPL) { + primary_key(POLICY_TYPE_IMPL_ID) + POLICY_NAME + POLICY_VERSION + PDP_TYPE POLICY_ARTIFACT +} + +table(POLICY_SET_TO_POLICY_TYPE_IMPL) { + POLICY_SET_ID + POLICY_TYPE_IMPL_ID +} + +PDP_SUBGROUP::POLICY_SET_ID --> POLICY_SET::POLICY_SET_ID +PDP::PDP_SUBGROUP_ID --> PDP_SUBGROUP::PDP_SUBGROUP_ID +PDP::POLICY_SET_ID --> POLICY_SET::POLICY_SET_ID +POLICY_SET_TO_POLICY_TYPE_IMPL::POLICY_SET_ID --> POLICY_SET::POLICY_SET_ID +POLICY_SET_TO_POLICY_TYPE_IMPL::POLICY_TYPE_IMPL_ID --> POLICY_TYPE_IMPL::POLICY_TYPE_IMPL_ID + +@enduml
\ No newline at end of file diff --git a/docs/architecture/plantuml/PolicyDesign.puml b/docs/architecture/plantuml/PolicyDesign.puml new file mode 100644 index 00000000..f844809e --- /dev/null +++ b/docs/architecture/plantuml/PolicyDesign.puml @@ -0,0 +1,39 @@ +@startuml + +title Policy Design + +participant API_User +box "PolicyDesign" #LightBlue + participant PolicyDesign + database PolicyDB +end box + +autonumber + +API_User --> PolicyDesign : Get Policy Type Reference +PolicyDesign --> PolicyDB : Get Policy Type Artifact and Metadata +PolicyDesign --> API_User : Return Policy Type Reference and Metadata +API_User --> PolicyDesign : Get Policy Reference and Metadata +PolicyDesign --> PolicyDB : Get Policy Metadata + +alt Policy Artifact exists + PolicyDesign --> API_User : Return Policy Reference and Metadata +else Policy Artifact does not exist + PolicyDesign --> API_User : Return New Policy Reference and Empty Metadata +end + +API_User --> API_User : Policy Editing and Generation Session\nto get Policy Parameters from user + +activate API_User +deactivate API_User + +loop + API_User --> PolicyDesign : Use Policy Type specification + API_User --> PolicyDesign : Create Policy PolicyDesign --> PolicyDesign : Create Policy + activate PolicyDesign + deactivate PolicyDesign + PolicyDesign --> PolicyDB : Save Policy Artifact and Metadata + PolicyDesign --> API_User : Policy Creation Result +end + +@enduml
\ No newline at end of file diff --git a/docs/architecture/plantuml/PolicyExecution.puml b/docs/architecture/plantuml/PolicyExecution.puml new file mode 100644 index 00000000..a06fdf5f --- /dev/null +++ b/docs/architecture/plantuml/PolicyExecution.puml @@ -0,0 +1,24 @@ +@startuml + +title Policy Execution + +participant REQUESTOR +participant RESPONDEE +participant PDP + +autonumber + +alt Synchronous Invocation + REQUESTOR --> PDP: Execute Policy + activate PDP + hnote over REQUESTOR : wait + PDP --> REQUESTOR: Policy Execution Result + deactivate PDP +else Asynchronous Invocation + REQUESTOR --> PDP: Execute Policy + activate PDP + PDP --> RESPONDEE: Policy Execution Result + deactivate PDP +end + +@enduml
\ No newline at end of file diff --git a/docs/architecture/plantuml/PolicyRollout.puml b/docs/architecture/plantuml/PolicyRollout.puml new file mode 100644 index 00000000..40c0960f --- /dev/null +++ b/docs/architecture/plantuml/PolicyRollout.puml @@ -0,0 +1,43 @@ +@startuml + +title Policy Rollout + +actor User +participant PAP +participant PDP + +autonumber +User --> PAP: Create Policy Set for PDP Group + +loop over PDP Group + ref over PAP, PDP: PAP downloads Policy Set to PDP +end + +User --> PAP: Set PDP Group in Test Mode + +loop over PDP Group + PAP --> PDP: Set PDP in TEST mode +end + +PDP --> PAP: Report test results +PAP --> User: Report consolidated test results + +User --> PAP: Set PDP Group in Safe Mode +loop over PDP Group + PAP --> PDP: Set PDP in SAFE mode +end + +PDP --> PAP: Report safe mode operation results +PAP --> User: Report consolidated safe mode operation results + +User --> PAP: Set PDP Group in Active Mode +loop over PDP Group + PAP --> PDP: Set PDP in Active mode +end + +loop forever + PDP --> PAP: Report active mode operation results + PAP --> User: Report consolidated active mode operation results +end + +@enduml
\ No newline at end of file diff --git a/docs/architecture/plantuml/PolicyTypeDesign.puml b/docs/architecture/plantuml/PolicyTypeDesign.puml new file mode 100644 index 00000000..92d3c0ca --- /dev/null +++ b/docs/architecture/plantuml/PolicyTypeDesign.puml @@ -0,0 +1,28 @@ +@startuml + +title Policy Type Design + +participant DCAE_DS <<API_User >> +box "PolicyDesign" #LightBlue + participant PolicyTypeDesign +end box +autonumber + +DCAE_DS --> PolicyTypeDesign : Get Policy Type Reference and Metadata +PolicyTypeDesign --> PolicyDB : Get Policy Type Metadata\nand Artifact + +alt Policy Type Artifact exists + PolicyTypeDesign --> DCAE_DS : Return Policy Type Reference and Metadata +else Policy Artifact does not exist + PolicyTypeDesign --> DCAE_DS : Return New Policy Type Reference and Empty Metadata +end + +DCAE_DS --> DCAE_DS : Policy Type Editing and Generation Session + +activate DCAE_DS +deactivate DCAE_DS + +DCAE_DS --> PolicyTypeDesign : Create Policy Type and Metadata +PolicyTypeDesign --> DCAE_DS : Policy Generation Result + +@enduml
\ No newline at end of file diff --git a/docs/architecture/plantuml/RuntimeRelationships.puml b/docs/architecture/plantuml/RuntimeRelationships.puml new file mode 100644 index 00000000..f206b885 --- /dev/null +++ b/docs/architecture/plantuml/RuntimeRelationships.puml @@ -0,0 +1,17 @@ +@startuml + +title Runtime Relationships between Concepts + +object PDPSubGroup +object PDPService +object PolicySet +object PDP +object PolicyImpl + +PDPSubGroup "1" -- "1" PDPService : > Lifecycle\nManaged\nBy +PDPService "1" -- "*" PDP : > Manages\nLifecycle\nOf +PDPService "1" -- "1" PolicySet : > Executes +PolicySet "1" -- "*" PDP : > Executes\nOn +PolicySet "1" -- "*" PolicyImpl : > Contains + +@enduml
\ No newline at end of file diff --git a/docs/architecture/plantuml/ScriptedPolicyDesign.puml b/docs/architecture/plantuml/ScriptedPolicyDesign.puml new file mode 100644 index 00000000..e9702174 --- /dev/null +++ b/docs/architecture/plantuml/ScriptedPolicyDesign.puml @@ -0,0 +1,29 @@ +@startuml + +title Scripted Policy Design + +participant Script <<API_User >> +collections DirectiveFile + +box "PolicyDesign" #LightBlue + participant PolicyTypeDesign + participant PolicyDesign +end box + +autonumber + +activate Script + +loop + Script --> DirectiveFile : Read next directive from script file + Script --> PolicyTypeDesign : Read Policy Type for directive + Script --> Script : Prepare TOSCA Policy for coreation + Script --> Script : Read parameters from script file directive + Script --> Script : Set Parameters in TOSCA Policy being prepared + Script --> PolicyDesign : Create Policy + PolicyDesign --> Script : Policy creation result +end + +deactivate Script + +@enduml
\ No newline at end of file diff --git a/docs/design/design.rst b/docs/design/design.rst index ad91834a..e8a4cacc 100644 --- a/docs/design/design.rst +++ b/docs/design/design.rst @@ -10,6 +10,9 @@ Policy Design and Development .. contents:: :depth: 3 +This document provides examples that illustrate how to write, deploy, and run policies +of various types using the framework. + The figure below shows the Artifacts (Blue) in the ONAP Policy Framework, the Activities (Yellow) that manipulate them, and important components (Pink) that interact with them. |
