.. http://creativecommons.org/licenses/by/4.0
-Distribution User Manual
-************************
+Policy Distribution User Manual
+*******************************
.. contents::
:depth: 3
.. 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
.. important::
A Build needs Space
- Building distribution requires approximately 1-2 GB of hard disc space, 100 MB for the actual build with full
+ Building distribution requires approximately 1-2 GB of hard disc space, 100 MB for the actual build with full
distribution and around 1 GB for the downloaded dependencies.
.. important::
The build will have created all artifacts required for distribution
installation. The following example show how to change to the target
- directory and how it should look like.
+ directory and how it should look.
+----------------------------------------------------------------------------------------------------------------------------+
| Unix, Cygwin |
.. container:: paragraph
- The right-click on the new created TAR file and extract the actual
+ Then right-click on the new created TAR file and extract the actual
distribution.
|
A distribution engine can be configured to use various combinations
of policy reception handlers, policy decoders and policy forwarders.
- The system is build using a plugin architecture. Each configuration
+ The system is built using a plugin architecture. Each configuration
option is realized by a plugin, which can be loaded and
configured when the engine is started. New plugins can be
added to the system at any time, though to benefit from a
- new plugin an engine will need to be restarted.
+ new plugin, an engine will need to be restarted.
|
.. 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
----------------------------
.. 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
.. container:: paragraph
- Generated policies are forwarded to XACML policy engine.
+ Generated policies are forwarded to policy lifecycle api's for creation & deployment.
.. container:: listingblock
"receptionHandlerConfigurationName":"sdcConfiguration",
"pluginHandlerParameters":{
"policyDecoders":{
- "CsarDecoder":{
- "decoderType":"CsarDecoder",
- "decoderClassName":"org.onap.policy.distribution.reception.decoding.pdpx.PolicyDecoderCsarPdpx",
- "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"
}
}
}
"keystorePassword": "null",
"activeserverTlsAuth": false,
"isFilterinEmptyResources": true,
- "isUseHttpsWithDmaap": false
+ "isUseHttpsWithDmaap": true
}
}
},
"policyDecoderConfigurationParameters":{
- "csarToOptimizationPolicyConfiguration":{
- "parameterClassName":"org.onap.policy.distribution.reception.decoding.pdpx.PolicyDecoderCsarPdpxConfigurationParameterGroup",
+ "toscaPolicyDecoderConfiguration":{
+ "parameterClassName":"org.onap.policy.distribution.reception.decoding.policy.file.PolicyDecoderFileInCsarToPolicyParameterGroup",
"parameters":{
- "policyNamePrefix": "oofCasablanca",
- "onapName": "OOF",
- "version": "1.0",
- "priority": "3",
- "riskType": "Test",
- "riskLevel": "2"
+ "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
}
}
}
Code Review / policy / parent.git / blobdiff