summaryrefslogtreecommitdiffstats
path: root/docs
AgeCommit message (Collapse)AuthorFilesLines
2020-02-26Migrate policy-parent docsJessica Wagantall5-0/+62
Merging this will create https://onap-policy-parent.readthedocs.io This build will run in parallel to the current docs generation method until we are ready to cut over. Issue-ID: CIMAN-364 Signed-off-by: Jessica Wagantall <jwagantall@linuxfoundation.org> Change-Id: I0c3c58710da92676bf622fb44f102a05daa8b2a0
2020-02-14Fix documents for drools-pdpRam Krishna Verma3-5/+7
Issue-ID: POLICY-2366 Change-Id: I5e832a882fbfd70747242734b2c1eb3a26e795a4 Signed-off-by: Ram Krishna Verma <ram_krishna.verma@bell.ca>
2020-01-28Updating documentation for supported policy type changes during PdpGroup updatea.sreekumar1-2/+9
Change-Id: I9efe9dd118fb0ec1a81fe37deb94fda9a86a9e65 Issue-ID: POLICY-2023 Signed-off-by: a.sreekumar <ajith.sreekumar@est.tech>
2020-01-16Updated API documentation to reflect the addition of version validation featureChenfei Gao5-46/+92
Issue-ID: POLICY-2316 Change-Id: I981f7998926931d4bc2cd6a3bb0781071f768fae Signed-off-by: Chenfei Gao <cgao@research.att.com>
2019-12-17Update PAP docs per review comments.Jim Hahn1-1/+1
Issue-ID: POLICY-2281 Signed-off-by: Jim Hahn <jrh3@att.com> Change-Id: Ia8ddf2dddd3a6cd605efea360cbf47b03bb93c10
2019-12-16Merge "Document Policy API to create operational policy for CDS actor"Pamela Dragosh31-1393/+1569
2019-12-16Document Policy API to create operational policy for CDS actorRashmi Pujar31-1393/+1569
- Restructured the development directory to include devtools, and actors Issue-ID: POLICY-2294 Signed-off-by: Rashmi Pujar <rashmi.pujar@bell.ca> Change-Id: Ifdb1a9f3b8fa4a2ff34a7c8edf29783d2de803b7
2019-12-12Document new PAP REST APIsJim Hahn5-40/+216
Includes the Pdp Group create/update API and the Deployment API. Issue-ID: POLICY-2281 Signed-off-by: Jim Hahn <jrh3@att.com> Change-Id: Ifde0491b029eb377c4f3083c784663df968b9d1b
2019-12-05Document PAP policy notificationsSaryu Shah3-3/+34
Document PAP policy notifications Issue-ID: POLICY-2270 Signed-off-by: Saryu Shah <ss3917@att.com> Change-Id: Ia2106165c3fa30951c36d1050e4db07835458589
2019-12-03Merge "Document Policy to CDS contract"Ram Krishna Verma1-0/+268
2019-12-02Document Policy to CDS contractRashmi Pujar1-0/+268
This contract needs to be respected by a CDS blueprint developer and hence documenting it into the repo. Issue-ID: POLICY-2277 Signed-off-by: Rashmi Pujar <rashmi.pujar@bell.ca> Change-Id: Iece51380b9bd99af1e307c8e6c411b0bc860e7ba
2019-12-01Merge "Fix errors in apex-pdp documentation"Liam Fallon3-24/+24
2019-11-28Fix errors in apex-pdp documentationliamfallon3-24/+24
In order to buid a Docker image, you now need to invoke the "docker profile when buidling apex, this was missing in the documentation. The variable LOG_DIR was renamed logDir in the logback.xml file but this was not reflected in the documentation. Issue-ID: POLICY-2186 Change-Id: I6019f3e6c4dd369b44c0f1e617a427892a2e6ef8 Signed-off-by: liamfallon <liam.fallon@est.tech>
2019-11-25Documentation - wild card suffixes for PDP supported policy typesSaryu Shah3-53/+52
Updated documentation to include wilcard suffixes for PDP supported policy types Issue-ID: POLICY-2247 Signed-off-by: Saryu Shah <ss3917@att.com> Change-Id: Ibbd030d569616b1e7a5b3f1ca0deb3ecf642aea3
2019-11-21override certificate stores documentationjhh1-3/+38
Issue-ID: POLICY-2192 Signed-off-by: jhh <jorge.hernandez-herrero@att.com> Change-Id: Ib65aacfa3e7169135623851f42bc80dde00f545e Signed-off-by: jhh <jorge.hernandez-herrero@att.com>
2019-10-18Updated swagger documentation to reflect abbreviated Monitor decision ↵HOCKLA1-0/+6
results feature (Policy-2126) Issue-ID: POLICY-2166 Change-Id: Ie84f6184801114b1115ae35e34279e98dad83205 Signed-off-by: HOCKLA <ah999m@att.com>
2019-10-15Update api swagger docs to reflect application/yaml supportChenfei Gao7-31/+31
Issue-ID: POLICY-2102 Change-Id: I46c9146d7c35edd1dfdc75b1efc82e89a1b726ef Signed-off-by: Chenfei Gao <cgao@research.att.com>
2019-10-15Merge "Update api documentation to reflect addition of new policy creation ↵Pamela Dragosh2-1/+78
endpoint"
2019-10-14Update security fixes el altoPamela Dragosh1-0/+11
Need to list the fixes we did for security. Issue-ID: POLICY-1982 Change-Id: I4dc7cf2289d45bc63456c422f200b29cc2095149 Signed-off-by: Pamela Dragosh <pdragosh@research.att.com>
2019-10-14Update release notes el alto finalPamela Dragosh1-11/+15
Add the last bugs and known problems in. Fix the date. Issue-ID: POLICY-2156 Change-Id: I17489e7b0fb82a9e18dc5eb2325a159ebc1be75b Signed-off-by: Pamela Dragosh <pdragosh@research.att.com>
2019-10-10Update api documentation to reflect addition of new policy creation endpointChenfei Gao2-1/+78
Issue-ID: POLICY-2157 Change-Id: Iebdf6f27c47b8bfae375845a01ab7dbea225c5a9 Signed-off-by: Chenfei Gao <cgao@research.att.com>
2019-10-03Merge "Add POSTMAN collection and env"Jorge Hernandez4-3/+1080
2019-10-03Fix inaccuracies in apex-pdp user manualliamfallon1-32/+50
- the docker profile should be sued to build the tarball - the apex engine should be run using "sudo su" - the APEX_HOME and APEX_USER environment variables should then be set - debugging defaults to "debug" level rather than "info" level Issue-ID: POLICY-2129 Change-Id: I5df5a021dfda3b51ab6ca1f490aec667139825c5 Signed-off-by: liamfallon <liam.fallon@est.tech>
2019-10-03Add POSTMAN collection and envPamela Dragosh4-3/+1080
Have the offered API's be at a top level that points to the existing API's throughout policy. Add in downloads for example environment and collection for Postman. Issue-ID: POLICY-2114 Change-Id: Ie2edf2f0aacfe7c9bb14c3e9f83f74a8a2a72de6 Signed-off-by: Pamela Dragosh <pdragosh@research.att.com>
2019-10-01Fix links in api docChenfei Gao1-25/+25
Issue-ID: POLICY-2121 Change-Id: I5ea5308afd63e5aeba3ac018c959f24c14c0b961 Signed-off-by: Chenfei Gao <cgao@research.att.com>
2019-09-22Updates to el alto release notes.Saryu Shah1-1/+0
Removed POLICY-1825 from list as that will be done post el alto. Issue-ID: POLICY-2094 Signed-off-by: Saryu Shah <ss3917@att.com> Change-Id: Ia9e427aca7b8ca1332614ac2669853bfc04b4648
2019-09-19El Alto Release NotesSaryu Shah1-25/+53
El Alto Release Notes Issue-ID: POLICY-2094 Signed-off-by: Saryu Shah <ss3917@att.com> Change-Id: I233c044084ea73f5bfaa3f85a5b9f805b12f862f
2019-09-19Replace apex JMeter HTML/JS with PDF reportsliamfallon1-0/+0
The results of the apex JMeter report in result.zip was in the form of HTML/javascript, which generated security issues. This review replaces the contents of result.zip with PDF documents that capture the HTML content. Archive: result.zip Length Date Time Name --------- ---------- ----- ---- 0 2019-09-19 09:52 result/ 206236 2019-09-19 09:45 result/JMeter_0213_Charts_OverTime.pdf 91640 2019-09-19 09:48 result/JMeter_0232_Charts_ResponseTimes.pdf 129132 2019-09-19 09:46 result/JMeter_0221_Charts_Throughput.pdf 135087 2019-09-19 09:44 result/JMeter_0211_Charts_OverTime.pdf 26008 2019-09-19 09:31 result/JMeter_0310_TestTime.pdf 115940 2019-09-19 09:45 result/JMeter_0212_Charts_OverTime.pdf 138760 2019-09-19 09:46 result/JMeter_0222_Charts_Throughput.pdf 76038 2019-09-19 09:48 result/JMeter_0231_Charts_ResponseTimes.pdf 54638 2019-09-19 09:43 result/JMeter_0100_Dashboard.pdf 97078 2019-09-19 09:47 result/JMeter_0223_Charts_Throughput.pdf --------- ------- 1070557 11 files Issue-ID: POLICY-2082 Change-Id: I2fe119f9e9e2b31972bdb4a3376b66aaedbfedf6 Signed-off-by: liamfallon <liam.fallon@est.tech>
2019-09-18Change JMeter result UI to use jquery 3.4.1liamfallon1-0/+0
The JMeter result UI zipped in the APEX stability test results uses JQuery 3.3.1 to render the results. This review changes the JQuery version packaged in JMeter to 3.4.1 to remove security vulnerabilities. Issue-ID: POLICY-2082 Change-Id: Id22cd4888cebe564035ed00705c20eb74fb75a76 Signed-off-by: liamfallon <liam.fallon@est.tech>
2019-09-16Update release version and datePamela Dragosh1-2/+2
Release is 5.0.1 for El Alto - potential date is 9/30. When the release notes are finalized with user stories etc. the date will be done. Issue-ID: POLICY-2099 Change-Id: If98a450282fedd5fc2394917dc9b8c3d7c2f2e46 Signed-off-by: Pamela Dragosh <pdragosh@research.att.com>
2019-09-12Merge "Update api docs to reflect the most recent changes to policytypes"Pamela Dragosh24-1730/+30
2019-09-11Update api docs to reflect the most recent changes to policytypesChenfei Gao24-1730/+30
Issue-ID: POLICY-2073 Change-Id: I67bcd417329231d5297d8f7e9c982b788cb46928 Signed-off-by: Chenfei Gao <cgao@research.att.com>
2019-09-11Merge "Update Decision API and Optimization doc"Jorge Hernandez3-10/+110
2019-09-11Update Decision API and Optimization docPamela Dragosh3-10/+110
More examples for Decision API in the design document and also update the changes for Optimization application in XACML PDP. Issue-ID: POLICY-2071 Change-Id: I0880e40a428dd299c1b4c1f60ccf3f009c53e929 Signed-off-by: Pamela Dragosh <pdragosh@research.att.com>
2019-09-10PDPD Customization Documentationjhh2-2/+47
Issue-ID: POLICY-1371 Signed-off-by: jhh <jorge.hernandez-herrero@att.com> Change-Id: I199f1c5bea5f7cda819f70633be4b4d4d5b6471d
2019-08-30Documentation - added offeredapis.rst in parentSaryu Shah2-0/+18
Added links for the API including legacy. This will be linked in the master API reference page. Issue-ID: POLICY-1984 Signed-off-by: Saryu Shah <ss3917@att.com> Change-Id: Ibab75f6c2077539ca16845053ded880ff05b8dd4
2019-08-26Merge "Documentation : rst formating problem"Liam Fallon2-1/+1
2019-08-23Documentation : rst formating problemSaryu Shah2-1/+1
Fixed formatting in distribution/Distribution-User-Manual.rst and also added missing file drools/Tut_vFW_simulated_onset.JPG Issue-ID: POLICY-1986 Signed-off-by: Saryu Shah <ss3917@att.com> Change-Id: I7709d83ddb23ef3b722d01802c49a449f3b0d80a
2019-08-23Add documentation for stability/performance tests of policy componentsChenfei Gao29-8/+56274
Add s3p documentation for policy-api Add s3p documentation for policy-pap Add s3p documentation for policy-xacml-pdp Add s3p documentation for policy-apex-pdp Issue-ID: POLICY-1993 Change-Id: Id267f2b89316b32e79db11009cb013027058e94a Signed-off-by: Chenfei Gao <cgao@research.att.com>
2019-08-21Update API swagger to reflect the most recent changes to deployed endpointsChenfei Gao2-2/+146
Issue-ID: POLICY-1994 Change-Id: Iab2795ba9cf89cacf467cfa8156fc50685f81059 Signed-off-by: Chenfei Gao <cgao@research.att.com>
2019-08-16Start El Alto Early Drop Release notesPamela Dragosh1-0/+106
Start the release notes - will not be able to finish until Integration testing is complete and all bugs are closed etc. Issue-ID: POLICY-1974 Change-Id: I0e0ce000dba81e2e0c2496c33b7527df74f9ca6d Signed-off-by: Pamela Dragosh <pdragosh@research.att.com>
2019-08-01Add sample requests and responses to PAP docsJim Hahn6-0/+289
Change-Id: I8f2643216bcc8fb2f64dd50296570ab41ea6423c Issue-ID: POLICY-1865 Signed-off-by: Jim Hahn <jrh3@att.com>
2019-07-26Documentation changes for APEX CLI Tosca editora.sreekumar1-0/+97
Change-Id: Icf3f67265e0e5ec9e5f94717441f11e0285e9811 Issue-ID: POLICY-1885 Signed-off-by: a.sreekumar <ajith.sreekumar@est.tech>
2019-07-22add document for POLICY-1742Henry.Sun1-16/+38
Issue-ID: POLICY-1886 Change-Id: I491e9d34868c2dda1c4ed8b354317151590e5a8b Signed-off-by: Henry.Sun <henry.a.sun@est.tech>
2019-07-18APEX User Manual update for POLICY-1743ning.xi1-2/+24
Issue-ID: POLICY-1878 Change-Id: I50103adf4792f994ba9f7346516a3605c9f0b1a5 Signed-off-by: ning.xi <ning.xi@est.tech>
2019-07-11Fixing few documentsramverma5-5/+5
Change-Id: I3b5e27c0e7a2ce2112e150dc862d3d080a691a83 Issue-ID: POLICY-1898 Signed-off-by: ramverma <ram.krishna.verma@est.tech>
2019-07-11Fix review comments from previous reviewramverma7-388/+388
Change-Id: Ide96508d2cc616a688d6c1ed524b8317c53aa222 Issue-ID: POLICY-1898 Signed-off-by: ramverma <ram.krishna.verma@est.tech>
2019-07-10Adding apex-pdp & distribution documents to parentramverma43-0/+14778
Change-Id: If8039f68a1669787685d4a7bdc37dec203901062 Issue-ID: POLICY-1898 Signed-off-by: ramverma <ram.krishna.verma@est.tech>
2019-07-02Add OOM installation notesPamela Dragosh2-6/+94
Missing details Issue-ID: POLICY-1849 Change-Id: Iac1e6e0af4690b55b13a6a19ad56b153b0b66472 Signed-off-by: Pamela Dragosh <pdragosh@research.att.com>
2019-06-28Update release-notes known issuesPamela Dragosh1-1/+1
For bug fix https://jira.onap.org/browse/POLICY-1872 Issue-ID: POLICY-1875 Change-Id: Ica5a251fce507262829d01bb0d49d39fa5c91f51 Signed-off-by: Pamela Dragosh <pdragosh@research.att.com>