aboutsummaryrefslogtreecommitdiffstats
path: root/docs
AgeCommit message (Collapse)AuthorFilesLines
2021-07-19Add profile for generating Swagger documentsliamfallon3-9/+219
This commit adds a profile for generating Swagger documents and creating a tarball containing the swagger.json, swagger.html, and swagger.pdf files. The profile is triggered in any module when tsts are enabled (In other words when the skipTests flag is off), and when the following proerty is set: <swagger.generation.phase>post-integration-test</swagger.generation.phase> This profile assumes that a unit test exists that creates the following file: target/swagger/swagger.json If this file does not exist, the build will fail if the profile is invoked. Therefore, to generate the Swagger documentation tarball, a module must set the swagger.generation.phase propety AND have a unit test that generates the swagger.json file. Issue-ID: POLICY-3424 Change-Id: I8ff769e7a28bf0e00969d1bc677fee6908951d8a Signed-off-by: liamfallon <liam.fallon@est.tech>
2021-07-16Document Disable collection of PdpStatisticsadheli.tavares1-2/+18
Issue-ID: POLICY-3459 Change-Id: I108fff4a293ccccff35afbc636c7f04880f0dc3c Signed-off-by: adheli.tavares <adheli.tavares@est.tech>
2021-06-22Add section for policy chainingRam Krishna Verma1-0/+19
Adding section for policy chaining in drools-apps document. Issue-ID: POLICY-3382 Change-Id: Ie8d68c182e12aa2a9739fbd120d57bd8d0db0ca3 Signed-off-by: Ram Krishna Verma <ram_krishna.verma@bell.ca>
2021-06-10Update drools-pdp documentsRam Krishna Verma3-32/+13
* Fixed few broken links * Updated the CSIT links to point to policy/docker * Updated the latest version to Honolulu * Removed legacy operational policy type * Removed frankfurt controller Issue-ID: POLICY-3382 Change-Id: I3eb5d409abc90eb5a52d953051993a3c5f830176 Signed-off-by: Ram Krishna Verma <ram_krishna.verma@bell.ca>
2021-06-01Update PAP documentationwaynedunican1-27/+19
Update documentation to align with PAP-PDP communication changes. PDP_UPDATE message now stores lists of policiesToBeDeployed and policiesToBeUndeployed. Removed any references to the policies field as this has been removed from PDP_UPDATE and added the new lists to the documentation. Issue-ID: POLICY-3339 Change-Id: Ib5bafffdb5ccd4ee5edbf861132b4dd8b088f5e4 Signed-off-by: waynedunican <wayne.dunican@est.tech> Signed-off-by: WayneDunican <wayne.dunican@est.tech>
2021-05-20Update apex-pdp kafka io docsRam Krishna Verma1-21/+95
Adding kafkaProperties to the Kafka IO plugin section. The properties are needed for SSL connectivity between apex-pdp & Kafka server. Issue-ID: POLICY-3197 Change-Id: I41f73f482b2b4f18dbf0989fe9a6fc1dac6ccdd7 Signed-off-by: Ram Krishna Verma <ram_krishna.verma@bell.ca>
2021-04-27Update date for Honolulu release notesJim Hahn1-1/+1
Issue-ID: POLICY-3253 Change-Id: Ie2390861586489096f52dede9add6b27ac6b9b33 Signed-off-by: Jim Hahn <jrh3@att.com>
2021-04-21Update release date in honolulu documentationJim Hahn1-1/+1
Issue-ID: POLICY-3186 Change-Id: Ib173eb6f7179e0490c808a9ac60eacd6bc68a8b3 Signed-off-by: Jim Hahn <jrh3@att.com>
2021-04-20Update Apex-PDP s3p Tests documentationarkadiusz.adamski1-114/+16
- Update test documentation Issue-ID: POLICY-3109 Signed-off-by: arkadiusz.adamski <aadamski@est.tech> Change-Id: I2291aeb976aed54de58a00fdb517b214d77927f0
2021-04-14Update Apex-PDP s3p Test resultsarkadiusz.adamski5-5/+5
- Update stability test results Issue-ID: POLICY-3109 Signed-off-by: arkadiusz.adamski <aadamski@est.tech> Change-Id: I926dae97cbe4d9af246de8f0e6fa840ccd7debd8
2021-04-09Update s3p Test resultsarkadiusz.adamski3-4/+4
- Update performance test results Issue-ID: POLICY-3109 Signed-off-by: arkadiusz.adamski <aadamski@est.tech> Change-Id: Id2deb7f63124e48f1cfcf6c95b47ac71753fbbce
2021-04-06Merge "Documentation changes for PAP S3P testing"Ram Krishna Verma9-16/+16
2021-04-01Documentation changes for PAP S3P testingwaynedunican9-16/+16
Issue-ID: POLICY-3110 Change-Id: I7d2e68f3c73e838f6e0848d02f4eca7ce1327abe Signed-off-by: waynedunican <wayne.dunican@est.tech>
2021-03-31Merge "Results of Xacml Performance tests"Jim Hahn1-5/+64
2021-03-31Results of Xacml Performance testsmkidd1-5/+64
Added changes to documentation to reflect results of performance tests for the S3P tests for Xacml-pdp. Updated values to reflect test results Issue-ID: POLICY-3111 Signed-off-by: mkidd <michael.kidd@est.tech> Change-Id: If8350480f96fbeac5b8c3d0bd7ef60bd97402a94 Signed-off-by: mkidd <michael.kidd@est.tech>
2021-03-31Merge "Distribution S3P tests results"Jim Hahn9-24/+14
2021-03-31Merge "Honululu Api Performance Run Results"Jim Hahn4-8/+48
2021-03-31Merge "Fix rst warnings in apex documentation"Jim Hahn2-4/+5
2021-03-31Fix rst warnings in apex documentationwaynedunican2-4/+5
Issue-ID: POLICY-3132 Change-Id: Ia7a4f136cdaad018ad6ba464ce798ac84ca47185 Signed-off-by: waynedunican <wayne.dunican@est.tech>
2021-03-30Distribution S3P tests resultsadheli.tavares9-24/+14
Issue-ID: POLICY-3113 Change-Id: I70dd8cc1751c28240b11e5c4598c7603e0bb0c46 Signed-off-by: adheli.tavares <adheli.tavares@est.tech>
2021-03-30Fix some broken documentation linksJim Hahn2-7/+7
Issue-ID: POLICY-3164 Change-Id: I994e1043ec4af385a69c977cd3f2264992376a11 Signed-off-by: Jim Hahn <jrh3@att.com>
2021-03-30Honululu Api Performance Run Resultslapentafd4-8/+48
Appending Performance results Issue-ID: POLICY-3112 Change-Id: I50df1aed416916966b2fe8cc1a7783315d221763 Signed-off-by: lapentafd <francesco.lapenta@est.tech>
2021-03-30Merge "s3p stability xacml-pdp documentation"Pamela Dragosh1-56/+25
2021-03-30Merge "Address review comments for release notes"Ajith Sreekumar1-0/+5
2021-03-29s3p stability xacml-pdp documentationjhh1-56/+25
Issue-ID: POLICY-3108 Signed-off-by: jhh <jorge.hernandez-herrero@att.com> Change-Id: I223016a6ef462cb33c2b365837a9bdda9ce075f8
2021-03-29Merge "s3p stability drools-apps documentation"Jorge Hernandez6-34/+78
2021-03-29Address review comments for release notesJim Hahn1-0/+5
Addressed the following review comments from the Honolulu cherry pick: - discuss purging of statistics table - add version upgrades for io.netty & hazelcast Issue-ID: POLICY-3164 Change-Id: I3be02f182b75883a0c3828131742451ce04494c3 Signed-off-by: Jim Hahn <jrh3@att.com>
2021-03-29s3p stability drools-apps documentationjhh6-34/+78
Issue-ID: POLICY-3108 Signed-off-by: jhh <jorge.hernandez-herrero@att.com> Change-Id: I2ed37d0fc8aa458e6a0f7e2a15b9a5008e013e87
2021-03-29Honululu Api Stability Run Resultslapentafd6-4/+5
Issue-ID: POLICY-3112 Change-Id: I3fc0a19a3de17120ba654c1cf9a175514496b1db Signed-off-by: lapentafd <francesco.lapenta@est.tech>
2021-03-26Merge "Add drools no-locking feature documentation"Jorge Hernandez2-0/+39
2021-03-25Add drools no-locking feature documentationjhh2-0/+39
Issue-ID: POLICY-3142 Signed-off-by: jhh <jorge.hernandez-herrero@att.com> Change-Id: I461da8d2b901c38b9bdb9ef2478c474ca96b6691 Signed-off-by: jhh <jorge.hernandez-herrero@att.com>
2021-03-25Update apex-pdp user manualRam Krishna Verma1-1/+1
Removing /bin/bash from apex-pdp standalone installation command as the default entry point has been added in the docker file itself. Issue-ID: POLICY-3062 Change-Id: I38c5ea1854eec29cc809452b02c6c02f3bd4068a Signed-off-by: Ram Krishna Verma <ram_krishna.verma@bell.ca>
2021-03-24Create Honolulu release notesJim Hahn1-1/+130
Issue-ID: POLICY-3152 Change-Id: Iadd78d9f958b9c3b657d250fecb9001c9cade3d9 Signed-off-by: Jim Hahn <jrh3@att.com>
2021-03-22Update CDS doc to remove legacy operational policyRashmi Pujar1-123/+95
Issue-ID: POLICY-3137 Signed-off-by: Rashmi Pujar <rashmi.pujar@bell.ca> Change-Id: Ibe71b0c806f0efa12306133ee48a416657b610dc
2021-02-23Update swagger tags and response codeRam Krishna Verma1-4/+13
Issue-ID: POLICY-2526 Change-Id: I447a0f62b279b42fd10de15d886bcfa3fee07f2e Signed-off-by: Ram Krishna Verma <ram_krishna.verma@bell.ca>
2021-02-22Fixing a formatting issue in PAP Deployment API changes documentationa.sreekumar2-2/+3
Change-Id: I330a1c551a95b7c798cea76cd886bb2afbd064e3 Issue-ID: POLICY-2526 Signed-off-by: a.sreekumar <ajith.sreekumar@bell.ca>
2021-02-19Doc updates for PAP Deployment API changesa.sreekumar7-9/+477
Change-Id: I23b8778c599a0fd3cc659f677018d866a68a2489 Issue-ID: POLICY-2526 Signed-off-by: a.sreekumar <ajith.sreekumar@bell.ca>
2021-01-20Remove css files from apex-pdp s3p resultsliamfallon4-2/+2
The Javascript rendering of the results is removed and replaced with PDF files in the apex_s3p_results.zip file. The directory structure is changed to remove the reference to the Frankfurt release. The link in the rst file is updated to take account of the changed directory strucuture. Issue-ID: POLICY-3002 Change-Id: I1bd3ca46107179059de5167923c44f215796fce4 Signed-off-by: liamfallon <liam.fallon@est.tech>
2020-11-23Update Guilin release date to 12/3 in docsJim Hahn1-1/+1
Issue-ID: POLICY-2902 Change-Id: Ibca0ef5fe0bb73472dfdc51643c1b16f6881cc17 Signed-off-by: Jim Hahn <jrh3@att.com>
2020-11-16Add usecases controller to documentationJim Hahn1-0/+2
Per a previous review comment, added a comment about the usecases controller being reintroduced with the Guilin release. Issue-ID: POLICY-2889 Change-Id: Ie52535e7e5cf653b74c35ba40b9af5ce28befe06 Signed-off-by: Jim Hahn <jrh3@att.com>
2020-11-12Update Policy release notes for GuilinJim Hahn2-86/+210
Also fixed broken headings and nested bullet lists in the 6.0.0 section. Also added extension for swaggerv2doc. Note: the version numbers for the images/artifactss assume there will be one more release of apex-pdp and drools-apps to fix the outstanding bugs. Issue-ID: POLICY-2889 Change-Id: I4749cb621a159e941622c3bd54d9a48d4212d007 Signed-off-by: Jim Hahn <jrh3@att.com>
2020-11-03Merge "Document usecases controller"Pamela Dragosh2-33/+40
2020-11-02Document usecases controllerJim Hahn2-33/+40
The usecases controller replaced the frankfurt controller during the guilin release. The latter will be removed in Honolulu. Updated the documentation to reflect the change. This must be cherry picked into guilin. Issue-ID: POLICY-2821 Change-Id: Ifad02970c2231b7d006f38c6546d099597ec2a4a Signed-off-by: Jim Hahn <jrh3@att.com>
2020-10-30Merge "Update Tutorial Documentation"Jorge Hernandez28-1623/+320
2020-10-29Update Tutorial DocumentationPamela Dragosh28-1623/+320
Point to actual code and remove the eclipse instructions as developers should look elsewhere for these instructions. Adding enforcement tutorial. Issue-ID: POLICY-2876 Change-Id: I793c1fae72f832afe7098be57a94f4929e9deb9a Signed-off-by: Pamela Dragosh <pdragosh@research.att.com>
2020-10-29Merge "S3P Testing Documentation for Apex-PDP"Jorge Hernandez6-228/+56
2020-10-29Merge "update s3p drools-pdp doc"Jorge Hernandez6-146/+11
2020-10-29Merge "Document Distribution S3P results for Guilin-RC0"Ram Krishna Verma15-139/+234
2020-10-29Document Distribution S3P results for Guilin-RC0gregory.hayes15-139/+234
Issue-ID: POLICY-2834 Jira-Link: https://jira.onap.org/browse/POLICY-2834 Signed-off-by: gregory.hayes <gregory.hayes@est.tech> Change-Id: Ie97239662dd0dded72452f7dbc3e0dd4576d6669
2020-10-29S3P Testing Documentation for Apex-PDPwaynedunican6-228/+56
Documentation for stabilty testing for Apex-PDP Issue-ID: POLICY-2831 Change-Id: Ib5fe94618832c4e873ec0bf920a4f0c8d8b55226 Signed-off-by: waynedunican <wayne.dunican@est.tech>