X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;f=docs%2Fdistribution%2FDistribution-User-Manual.rst;h=ff7c89d068dd8610464ce65233bfcea0fefe8db3;hb=24063f918df9837c54643377154fee77798d9d03;hp=12f75b9a9a3cff5bebf0428ea5e3012b29ecad60;hpb=3b71c9772e0f86b5cef9840668a36569540a037c;p=policy%2Fparent.git diff --git a/docs/distribution/Distribution-User-Manual.rst b/docs/distribution/Distribution-User-Manual.rst index 12f75b9a..ff7c89d0 100644 --- a/docs/distribution/Distribution-User-Manual.rst +++ b/docs/distribution/Distribution-User-Manual.rst @@ -2,8 +2,8 @@ .. http://creativecommons.org/licenses/by/4.0 -Distribution User Manual -************************ +Policy Distribution User Manual +******************************* .. contents:: :depth: 3 @@ -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 @@ -105,7 +105,7 @@ Build Distribution .. 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:: @@ -175,7 +175,7 @@ Build Distribution 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 | @@ -256,7 +256,7 @@ Install Manually from Archive (Windows, 7Zip, GUI) .. 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. | @@ -362,19 +362,19 @@ Introduction to Distribution Configuration 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 ---------------------------- @@ -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,17 @@ A configuration example "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" } } } @@ -514,39 +514,44 @@ A configuration example ], "consumerGroup": "policy-group", "environmentName": "AUTO", - "keystorePath": "null", - "keystorePassword": "null", + "keyStorePath": "null", + "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": { + "clientName": "policy-api", + "hostname": "policy-api", + "port": 6969, + "useHttps": true, + "userName": "healthcheck", + "password": "zb!XztG34" + }, + "papParameters": { + "clientName": "policy-pap", + "hostname": "policy-pap", + "port": 6969, + "useHttps": true, + "userName": "healthcheck", + "password": "zb!XztG34" + }, + "deployPolicies": true } } }