aboutsummaryrefslogtreecommitdiffstats
path: root/docs
AgeCommit message (Collapse)AuthorFilesLines
2020-04-23Fix documentation errorsPamela Dragosh12-98/+189
This also updates the XACML PDP documentation. Issue-ID: POLICY-2500 Change-Id: Ice086fa39040fbee899652faa0a079192a122f03 Signed-off-by: Pamela Dragosh <pdragosh@research.att.com>
2020-04-17Architecture doc update completeliamfallon1-7/+28
Please check the bridging text added to address a comment by Pam in a previous review on the bridging between the concept of a policy type implementation and an application. Issue-ID: POLICY-2500 Change-Id: I40bceef2c0fc0afb9f785fa302f26956b0a2a047 Signed-off-by: liamfallon <liam.fallon@est.tech>
2020-04-17Merge "Update developer and s3p docs"Liam Fallon7-1167/+1270
2020-04-16Update developer and s3p docsPamela Dragosh7-1167/+1270
Add in policy/gui and re-org the repo build order. Add doc and links on how to setup mariadb and the simulators. Move s3p documentation into individual rst. Issue-ID: POLICY-2500 Change-Id: I8c781817cbfb13b55e6225cf86143bb67fca5f70 Signed-off-by: Pamela Dragosh <pdragosh@research.att.com>
2020-04-14Architecture Sections 2.1 and 2.2liamfallon7-80/+83
Issue-ID: POLICY-2399 Change-Id: I36b87c94cb7149c3c5e510f3fead88c41d09cec6 Signed-off-by: liamfallon <liam.fallon@est.tech>
2020-04-14Merge "Outline PDP-D new policy types in design doc."Pamela Dragosh1-10/+46
2020-04-13Outline PDP-D new policy types in design doc.jhh1-10/+46
Issue-ID: POLICY-2149 Signed-off-by: jhh <jorge.hernandez-herrero@att.com> Change-Id: I88bfe43a207c85d7da277397dad9c8c0b3efa6db Signed-off-by: jhh <jorge.hernandez-herrero@att.com>
2020-04-09Architecture documentation section 2 (Part)liamfallon7-54/+44
Issue-ID: POLICY-2399 Change-Id: I051e1cfda6767152c0abd7e35de982efb64b2dd9 Signed-off-by: liamfallon <liam.fallon@est.tech>
2020-04-09Merge "Architecture documentation Section 1"Pamela Dragosh2-14/+60
2020-04-08Automation adds policy-parent-architecture.rstLF Jenkins CI1-0/+1
Issue-ID: CIMAN-376 Change-Id: Ice8d4f88ee16086ea37dead71c13c4d6ad27c4c9 Signed-off-by: lf-jobbuilder <releng+lf-jobbuilder@linuxfoundation.org>
2020-04-08Automation adds policy-parent-offeredapis.rstLF Jenkins CI1-0/+1
Issue-ID: CIMAN-376 Change-Id: I2f4c8eb059a4e32957648cc3ecac4827e8f6d3e5 Signed-off-by: lf-jobbuilder <releng+lf-jobbuilder@linuxfoundation.org>
2020-04-08Architecture documentation Section 1liamfallon2-14/+60
Issue-ID: POLICY-2399 Change-Id: I0050f457c2803299cb7f63fba00f676c2a7bb884 Signed-off-by: liamfallon <liam.fallon@est.tech>
2020-04-08Merge "Automation adds release-notes.rst"Jessica Wagantall1-3/+4
2020-04-08Merge "Apex-pdp documentation conversion for DecisionMaker example"Pamela Dragosh3-3/+110
2020-04-08Automation adds release-notes.rstLF Jenkins CI1-3/+4
Add _release_notes hook to allow automation. Fix non valid release notes characters in content. Issue-ID: CIMAN-376 Change-Id: I74656c29321aa7120c40c4fe437f5a45040df978 Signed-off-by: lf-jobbuilder <releng+lf-jobbuilder@linuxfoundation.org>
2020-04-08Apex-pdp documentation conversion for DecisionMaker exampleaditya.puthuparambil3-3/+110
Issue-ID: POLICY-2399 Signed-off-by: aditya.puthuparambil <aditya.puthuparambil@est.tech> Change-Id: I9fc825bc1010a53a159572656957d899d9a52aa9
2020-04-07Automation adds index.rstLF Jenkins CI1-0/+1
Issue-ID: CIMAN-376 Change-Id: Ia8f9fca2ae12194437bea5c3741e10eb2fd43aad Signed-off-by: lf-jobbuilder <releng+lf-jobbuilder@linuxfoundation.org>
2020-04-06Apex-pdp documentation conversion from .adoc to .rstaditya.puthuparambil21-76/+5747
Issue-ID: POLICY-2424 Signed-off-by: aditya.puthuparambil <aditya.puthuparambil@est.tech> Change-Id: Ic72f5cabe74d389ebafbcc8008525ef0831bd9b4
2020-04-02Merge "Update drools tutorials documentation"Ram Krishna Verma31-69/+488
2020-04-02Update drools tutorials documentationPeyton Puckett31-69/+488
Issue-ID: POLICY-2399 Change-Id: I9756a660f80348eb69b217e6f1de6bad7a7b6f00 Signed-off-by: Peyton Puckett <peyton.puckett@att.com>
2020-04-01Release notes structurePamela Dragosh1-0/+81
To be filled in by RC2, but we have the structure in place and this verifies the project release tag for RC0 task to be completed. Issue-ID: POLICY-2395 Change-Id: I407ead5a1927f5148629867a3b50588c1e21d05d Signed-off-by: Pamela Dragosh <pdragosh@research.att.com>
2020-03-27Fixing error in policy-api readthedocs pagea.sreekumar1-0/+1
Change-Id: Id8c0db99d9c9437a82bface507cbc9d257ecd4b6 Issue-ID: POLICY-2399 Signed-off-by: a.sreekumar <ajith.sreekumar@est.tech>
2020-03-20Merge "Updated documentation for Frankfurt changes to api and xacml-pdp"Pamela Dragosh6-691/+930
2020-03-20Updated documentation for Frankfurt changes to api and xacml-pdpChenfei Gao6-691/+930
Issue-ID: POLICY-2412 Change-Id: I3a3d6ed436e307ef20b2a41c7512478cb9c09e2f Signed-off-by: Chenfei Gao <cgao@research.att.com>
2020-03-19APEX Documentation changes for Frankfurt releasea.sreekumar3-101/+332
Change-Id: Idb7f768f04269a25222ed649e2e59973286aefbc Issue-ID: POLICY-2424 Signed-off-by: a.sreekumar <ajith.sreekumar@est.tech>
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>