Support for Context Albums across policy sets in Apex
POLICY-4765: Support for Context Albums across policy sets in ApexClosed
Description
apex-pdp has a concept of global context but doesn't have a mechanism for declaring and sharing context across policy sets in the same JVM.
If policies are deployed independently they should be able to share context between them.
Technically this should not be an issue in the Apex,but currently there is no way of declaring and/or passing a reference to the context hashmaps between apex engines.
In this story we investigate and implement this improvement.
Investigation
Procedure
Spin up docker-compose environment for testing
Create two policies that share a context album
Deploy both policies
Determine is Policy A can access context modified by Policy B
Steps
Modify DecisionMaker Policy
Split into two seperate policies:
One which contains the answer logic
One which contains the decision logic
Deploy both policies in single Apex engine
Policy A and Policy B will both share the AnswerAlbum Context
Set the answers using Policy A which contains the logic to set the answers. Policy B does not contain this logic.
Make a decision using Policy B. This will choose an answer from the AnswerAlbum.
Step | Description | Result |
---|---|---|
Modify DecisionMaker Policy |
|
DecisionMakerAnswerPolicy#-------------------------------------------------------------------------------
# ============LICENSE_START=======================================================
# Copyright (C) 2016-2018 Ericsson. All rights reserved.
# ================================================================================
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
# SPDX-License-Identifier: Apache-2.0
# ============LICENSE_END=========================================================
#-------------------------------------------------------------------------------
model create name=DecisionMakerPolicyModel
schema create name=SimpleStringType flavour=Java schema=java.lang.String
schema create name=SimpleIntegerType flavour=Java schema=java.lang.Integer
album create name=AnswerAlbum scope=policy writable=true schemaName=SimpleStringType
album create name=LastAnswerAlbum scope=policy writable=true schemaName=SimpleIntegerType
event create name=AnswerEvent nameSpace=org.onap.policy.apex.domains.decisionmaker source=DCAE target=apex
event parameter create name=AnswerEvent parName=a0 schemaName=SimpleStringType
event parameter create name=AnswerEvent parName=a1 schemaName=SimpleStringType
event parameter create name=AnswerEvent parName=a2 schemaName=SimpleStringType
event parameter create name=AnswerEvent parName=a3 schemaName=SimpleStringType
event parameter create name=AnswerEvent parName=a4 schemaName=SimpleStringType
event parameter create name=AnswerEvent parName=a5 schemaName=SimpleStringType
event parameter create name=AnswerEvent parName=a6 schemaName=SimpleStringType
task create name=AnswerInitTask
task inputfield create name=AnswerInitTask fieldName=a0 schemaName=SimpleStringType
task inputfield create name=AnswerInitTask fieldName=a1 schemaName=SimpleStringType
task inputfield create name=AnswerInitTask fieldName=a2 schemaName=SimpleStringType
task inputfield create name=AnswerInitTask fieldName=a3 schemaName=SimpleStringType
task inputfield create name=AnswerInitTask fieldName=a4 schemaName=SimpleStringType
task inputfield create name=AnswerInitTask fieldName=a5 schemaName=SimpleStringType
task inputfield create name=AnswerInitTask fieldName=a6 schemaName=SimpleStringType
task outputfield create name=AnswerInitTask fieldName=a0 schemaName=SimpleStringType
task outputfield create name=AnswerInitTask fieldName=a1 schemaName=SimpleStringType
task outputfield create name=AnswerInitTask fieldName=a2 schemaName=SimpleStringType
task outputfield create name=AnswerInitTask fieldName=a3 schemaName=SimpleStringType
task outputfield create name=AnswerInitTask fieldName=a4 schemaName=SimpleStringType
task outputfield create name=AnswerInitTask fieldName=a5 schemaName=SimpleStringType
task outputfield create name=AnswerInitTask fieldName=a6 schemaName=SimpleStringType
task contextref create name=AnswerInitTask albumName=AnswerAlbum
task contextref create name=AnswerInitTask albumName=LastAnswerAlbum
task logic create name=AnswerInitTask logicFlavour=JAVASCRIPT logic=LS
#MACROFILE:"src/main/resources/logic/AnswerInitTask.js"
LE
policy create name=AnswerInitPolicy template=freestyle firstState=AnswerInitState
policy state create name=AnswerInitPolicy stateName=AnswerInitState triggerName=AnswerEvent defaultTaskName=AnswerInitTask
policy state output create name=AnswerInitPolicy stateName=AnswerInitState outputName=AnswerInitOutput eventName=AnswerEvent
policy state taskref create name=AnswerInitPolicy stateName=AnswerInitState taskName=AnswerInitTask outputType=DIRECT outputName=AnswerInitOutput
validate
DecisionMakerDecisionPolicy #-------------------------------------------------------------------------------
# ============LICENSE_START=======================================================
# Copyright (C) 2016-2018 Ericsson. All rights reserved.
# ================================================================================
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
# SPDX-License-Identifier: Apache-2.0
# ============LICENSE_END=========================================================
#-------------------------------------------------------------------------------
model create name=DecisionMakerPolicyModelTwo
schema create name=SimpleStringType flavour=Java schema=java.lang.String
schema create name=SimpleIntegerType flavour=Java schema=java.lang.Integer
album create name=AnswerAlbum scope=policy writable=true schemaName=SimpleStringType
album create name=LastAnswerAlbum scope=policy writable=true schemaName=SimpleIntegerType
event create name=MakeDecisionEvent nameSpace=org.onap.policy.apex.domains.decisionmaker source=DCAE target=apex
event parameter create name=MakeDecisionEvent parName=mode schemaName=SimpleStringType
event create name=DecisionEvent nameSpace=org.onap.policy.apex.domains.decisionmaker source=DCAE target=apex
event parameter create name=DecisionEvent parName=decision schemaName=SimpleStringType
task create name=RandomAnswerTask
task inputfield create name=RandomAnswerTask fieldName=mode schemaName=SimpleStringType
task outputfield create name=RandomAnswerTask fieldName=decision schemaName=SimpleStringType
task contextref create name=RandomAnswerTask albumName=AnswerAlbum
task logic create name=RandomAnswerTask logicFlavour=JAVASCRIPT logic=LS
#MACROFILE:"src/main/resources/logic/RandomAnswerTask.js"
LE
task create name=PessimisticAnswerTask
task inputfield create name=PessimisticAnswerTask fieldName=mode schemaName=SimpleStringType
task outputfield create name=PessimisticAnswerTask fieldName=decision schemaName=SimpleStringType
task contextref create name=PessimisticAnswerTask albumName=AnswerAlbum
task logic create name=PessimisticAnswerTask logicFlavour=JAVASCRIPT logic=LS
#MACROFILE:"src/main/resources/logic/PessimisticAnswerTask.js"
LE
task create name=OptimisticAnswerTask
task inputfield create name=OptimisticAnswerTask fieldName=mode schemaName=SimpleStringType
task outputfield create name=OptimisticAnswerTask fieldName=decision schemaName=SimpleStringType
task contextref create name=OptimisticAnswerTask albumName=AnswerAlbum
task logic create name=OptimisticAnswerTask logicFlavour=JAVASCRIPT logic=LS
#MACROFILE:"src/main/resources/logic/OptimisticAnswerTask.js"
LE
task create name=DitheringAnswerTask
task inputfield create name=DitheringAnswerTask fieldName=mode schemaName=SimpleStringType
task outputfield create name=DitheringAnswerTask fieldName=decision schemaName=SimpleStringType
task contextref create name=DitheringAnswerTask albumName=AnswerAlbum
task logic create name=DitheringAnswerTask logicFlavour=JAVASCRIPT logic=LS
#MACROFILE:"src/main/resources/logic/DitheringAnswerTask.js"
LE
task create name=RoundRobinAnswerTask
task inputfield create name=RoundRobinAnswerTask fieldName=mode schemaName=SimpleStringType
task outputfield create name=RoundRobinAnswerTask fieldName=decision schemaName=SimpleStringType
task contextref create name=RoundRobinAnswerTask albumName=AnswerAlbum
task contextref create name=RoundRobinAnswerTask albumName=LastAnswerAlbum
task logic create name=RoundRobinAnswerTask logicFlavour=JAVASCRIPT logic=LS
#MACROFILE:"src/main/resources/logic/RoundRobinAnswerTask.js"
LE
policy create name=DecisionMakerPolicy template=freestyle firstState=MakeDecisionState
policy state create name=DecisionMakerPolicy stateName=MakeDecisionState triggerName=MakeDecisionEvent defaultTaskName=RandomAnswerTask
policy state output create name=DecisionMakerPolicy stateName=MakeDecisionState outputName=DecisionFinalOutput eventName=DecisionEvent
policy state taskref create name=DecisionMakerPolicy stateName=MakeDecisionState taskName=RandomAnswerTask outputType=DIRECT outputName=DecisionFinalOutput
policy state taskref create name=DecisionMakerPolicy stateName=MakeDecisionState taskName=PessimisticAnswerTask outputType=DIRECT outputName=DecisionFinalOutput
policy state taskref create name=DecisionMakerPolicy stateName=MakeDecisionState taskName=OptimisticAnswerTask outputType=DIRECT outputName=DecisionFinalOutput
policy state taskref create name=DecisionMakerPolicy stateName=MakeDecisionState taskName=DitheringAnswerTask outputType=DIRECT outputName=DecisionFinalOutput
policy state taskref create name=DecisionMakerPolicy stateName=MakeDecisionState taskName=RoundRobinAnswerTask outputType=DIRECT outputName=DecisionFinalOutput
policy state selecttasklogic create name=DecisionMakerPolicy stateName=MakeDecisionState logicFlavour=JAVASCRIPT logic=LS
#MACROFILE:"src/main/resources/logic/MakeDecisionStateTSL.js"
LE
validate
|
Other Changes |
|
ApexConfig.json{
"engineServiceParameters": {
"name": "MyApexEngine",
"version": "0.0.1",
"id": 45,
"instanceCount": 4,
"deploymentPort": 12345,
"engineParameters": {
"executorParameters": {
"JAVASCRIPT": {
"parameterClassName": "org.onap.policy.apex.plugins.executor.javascript.JavascriptExecutorParameters"
}
}
}
},
"eventInputParameters": {
"RESTConsumerTwo": {
"carrierTechnologyParameters": {
"carrierTechnology": "RESTSERVER",
"parameterClassName": "org.onap.policy.apex.plugins.event.carrier.restserver.RestServerCarrierTechnologyParameters",
"parameters": {
"standalone": true,
"host": "0.0.0.0",
"port": 23325
}
},
"eventProtocolParameters": {
"eventProtocol": "JSON"
},
"synchronousMode": true,
"synchronousPeer": "RESTProducerTwo",
"synchronousTimeout": 500
}
},
"eventOutputParameters": {
"logProducerTwo": {
"carrierTechnologyParameters": {
"carrierTechnology": "FILE",
"parameters": {
"fileName": "/tmp/EventsOutTwo.json"
}
},
"eventProtocolParameters": {
"eventProtocol": "JSON"
}
},
"RESTProducerTwo": {
"carrierTechnologyParameters":{
"carrierTechnology" : "RESTSERVER",
"parameterClassName" : "org.onap.policy.apex.plugins.event.carrier.restserver.RestServerCarrierTechnologyParameters"
},
"eventProtocolParameters":{
"eventProtocol" : "JSON"
},
"synchronousMode" : true,
"synchronousPeer" : "RESTConsumerTwo",
"synchronousTimeout" : 500
}
}
}
ToscaTemplate.json
MakeDecision_server.html
pom.xml
|
Deploy both policies | Deploy both policies on single Apex instance |
Result
|
Set Answers (Policy A) | Use Policy A to set the answers | Logs
|
Make Decision (Policy B) | Use Policy B to select an answer | Result
Result
Result
Result
|
|
|
|
Conclusion
Apex-pdp engine is capable of sharing context across separate policy sets running in the same apex-pdp engine.
No further changes are required.