summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorRam Krishna Verma <ram_krishna.verma@bell.ca>2020-04-22 18:07:26 -0400
committerRam Krishna Verma <ram_krishna.verma@bell.ca>2020-04-22 18:07:31 -0400
commitefa0bc72fe511e53a4446367fc3e75da68e55f44 (patch)
tree4efb453f360e1dc160282376554072db228e2826
parent3602c18a581fd99b12fb8ef298d581bc39225b65 (diff)
policy/distribution document updates
Issue-ID: POLICY-2515 Change-Id: I0a5845ea83af9a7b9bdaaf8016efcf11814243c3 Signed-off-by: Ram Krishna Verma <ram_krishna.verma@bell.ca>
-rw-r--r--docs/distribution/Distribution-Introduction.rst4
-rw-r--r--docs/distribution/Distribution-User-Manual.rst70
2 files changed, 46 insertions, 28 deletions
diff --git a/docs/distribution/Distribution-Introduction.rst b/docs/distribution/Distribution-Introduction.rst
index c7759a30..9be38957 100644
--- a/docs/distribution/Distribution-Introduction.rst
+++ b/docs/distribution/Distribution-Introduction.rst
@@ -10,7 +10,7 @@ Introduction to Policy Distribution
The main job of policy distribution component is to receive
incoming notifications, download artifacts, decode policies
from downloaded artifacts & forward the decoded policies to
- all configured policy engines.
+ all configured policy forwarders.
|
@@ -23,7 +23,7 @@ Introduction to Policy Distribution
are downloaded using SDC client library.The downloaded CSAR is
then given to the configured policy decoder for decoding and
generating policies. The generated policies are then forwarded
- to all configured policy engines. Related distribution status
+ to all configured policy forwarders. Related distribution status
is sent to SDC at each step (download/deploy/done) during the
entire flow.
diff --git a/docs/distribution/Distribution-User-Manual.rst b/docs/distribution/Distribution-User-Manual.rst
index 02fffcd1..f9868055 100644
--- a/docs/distribution/Distribution-User-Manual.rst
+++ b/docs/distribution/Distribution-User-Manual.rst
@@ -25,11 +25,11 @@ Installation Requirements
.. container:: ulist
- Downloaded distribution: JAVA runtime environment
- (JRE, Java 8 or later, Distribution is tested with the
+ (JRE, Java 11, Distribution is tested with the
OpenJDK)
- Building from source: JAVA development kit (JDK,
- Java 8 or later, Distribution is tested with the OpenJDK)
+ Java 11, Distribution is tested with the OpenJDK)
- Sufficient rights to install Distribution on the system
@@ -373,8 +373,8 @@ Introduction to Distribution Configuration
.. container:: paragraph
The distribution already comes with sdc reception handler,
- file reception handler, xacml policy decoder, file in csar policy decoder,
- xacml policy forwarder, apex policy forwarder.
+ file reception handler, hpa optimization policy decoder, file in csar policy decoder,
+ policy lifecycle api forwarder.
General Configuration Format
----------------------------
@@ -447,7 +447,7 @@ A configuration example
.. container:: paragraph
- The following example loads HPA use case related plug-ins.
+ The following example loads HPA use case & general tosca policy related plug-ins.
.. container:: paragraph
@@ -456,7 +456,7 @@ A configuration example
.. container:: paragraph
- Generated policies are forwarded to XACML policy engine.
+ Generated policies are forwarded to policy lifecycle api's for creation & deployment.
.. container:: listingblock
@@ -479,17 +479,22 @@ A configuration example
"receptionHandlerConfigurationName":"sdcConfiguration",
"pluginHandlerParameters":{
"policyDecoders":{
- "CsarDecoder":{
- "decoderType":"CsarDecoder",
- "decoderClassName":"org.onap.policy.distribution.reception.decoding.pdpx.PolicyDecoderCsarPdpx",
+ "HpaDecoder":{
+ "decoderType":"HpaDecoder",
+ "decoderClassName":"org.onap.policy.distribution.reception.decoding.hpa.PolicyDecoderCsarHpa",
"decoderConfigurationName": "csarToOptimizationPolicyConfiguration"
+ },
+ "ToscaPolicyDecoder":{
+ "decoderType":"ToscaPolicyDecoder",
+ "decoderClassName":"org.onap.policy.distribution.reception.decoding.policy.file.PolicyDecoderFileInCsarToPolicy",
+ "decoderConfigurationName": "toscaPolicyDecoderConfiguration"
}
},
"policyForwarders":{
- "PAPEngineForwarder":{
- "forwarderType":"PAPEngine",
- "forwarderClassName":"org.onap.policy.distribution.forwarding.xacml.pdp.XacmlPdpPolicyForwarder",
- "forwarderConfigurationName": "xacmlPdpConfiguration"
+ "LifeCycleApiForwarder":{
+ "forwarderType":"LifeCycleAPI",
+ "forwarderClassName":"org.onap.policy.distribution.forwarding.lifecycle.api.LifecycleApiPolicyForwarder",
+ "forwarderConfigurationName": "lifecycleApiConfiguration"
}
}
}
@@ -518,13 +523,13 @@ A configuration example
"keystorePassword": "null",
"activeserverTlsAuth": false,
"isFilterinEmptyResources": true,
- "isUseHttpsWithDmaap": false
+ "isUseHttpsWithDmaap": true
}
}
},
"policyDecoderConfigurationParameters":{
"csarToOptimizationPolicyConfiguration":{
- "parameterClassName":"org.onap.policy.distribution.reception.decoding.pdpx.PolicyDecoderCsarPdpxConfigurationParameterGroup",
+ "parameterClassName":"org.onap.policy.distribution.reception.decoding.hpa.PolicyDecoderCsarHpaParameters",
"parameters":{
"policyNamePrefix": "oofCasablanca",
"onapName": "OOF",
@@ -533,20 +538,33 @@ A configuration example
"riskType": "Test",
"riskLevel": "2"
}
+ },
+ "toscaPolicyDecoderConfiguration":{
+ "parameterClassName":"org.onap.policy.distribution.reception.decoding.policy.file.PolicyDecoderFileInCsarToPolicyParameterGroup",
+ "parameters":{
+ "policyFileName": "tosca_policy",
+ "policyTypeFileName": "tosca_policy_type"
+ }
}
},
"policyForwarderConfigurationParameters":{
- "xacmlPdpConfiguration":{
- "parameterClassName":"org.onap.policy.distribution.forwarding.xacml.pdp.XacmlPdpPolicyForwarderParameterGroup",
- "parameters":{
- "useHttps": false,
- "hostname": "pdp",
- "port": 8081,
- "userName": "testpdp",
- "password": "alpha123",
- "clientAuth": "cHl0aG9uOnRlc3Q=",
- "isManaged": true,
- "pdpGroup": "pdpGroup"
+ "lifecycleApiConfiguration": {
+ "parameterClassName": "org.onap.policy.distribution.forwarding.lifecycle.api.LifecycleApiForwarderParameters",
+ "parameters": {
+ "apiParameters": {
+ "hostName": "policy-api",
+ "port": 6969,
+ "userName": "healthcheck",
+ "password": "zb!XztG34"
+ },
+ "papParameters": {
+ "hostName": "policy-pap",
+ "port": 6969,
+ "userName": "healthcheck",
+ "password": "zb!XztG34"
+ },
+ "isHttps": true,
+ "deployPolicies": true
}
}
}