summaryrefslogtreecommitdiffstats
path: root/docs
AgeCommit message (Collapse)AuthorFilesLines
2021-10-20Add documentation for CL participantsrameshiyer277-12/+1314
- http, kubernetes participants Issue-ID: POLICY-3714 Signed-off-by: zrrmmua <ramesh.murugan.iyer@est.tech> Change-Id: I6725eac99f135299b18367e51b354f55415858b1
2021-10-12Fix warnings in PF documentation generationliamfallon16-276/+79576
Geeneration of documents in the Policy Framework issued many warnings, for example missing links, hanging references, unreferenced pages and missing swagger, as well as bad formatting for code blocks. This commit cleans up all the warnings. Issue-ID: POLICY-3337 Change-Id: I20db6ff76cfb58a603317f5faf20c7479b77c13b Signed-off-by: liamfallon <liam.fallon@est.tech>
2021-10-08Add old CLAMP release notes for tracabilityliamfallon2-0/+515
THe old CLAMP release notes should be kept in the CLAMP hierarchy of the POLICY/CLAMP documentation for tracability and for reference. Issue-ID: POLICY-3337 Change-Id: I59a530f05d04cae22fa20b0d7fa8ec6a70be9b32 Signed-off-by: liamfallon <liam.fallon@est.tech>
2021-10-08Merge "Restructure CLAMP documentation tree"Liam Fallon29-700/+944
2021-10-07Merge "Docs for PDP-PAP interaction"Ram Krishna Verma4-273/+592
2021-10-07Restructure CLAMP documentation treeliamfallon29-700/+944
Restructured and refactored the CLAMP documentation - Introduced a hierarchical structure to the documentaiton - Added a tree for builtin and TOSCA CLAMP - Cleaned up formatting - Added documentation for participants - Added placeholders for missing particioant, control loop runtime, and control loop GUI documentation - Fixed some hanging references Issue-ID: POLICY-3363 Change-Id: I3933be08af3984f2bb4e08707a8c5b5b454f540c Signed-off-by: liamfallon <liam.fallon@est.tech>
2021-10-07Merge "add clamp doc"Liam Fallon27-3/+407
2021-10-07Docs for PDP-PAP interactiona.sreekumar4-273/+592
Change-Id: I10bd0a7c3df39d7f2fa6d13eaa947f172c98f578 Issue-ID: POLICY-3264 Signed-off-by: a.sreekumar <ajith.sreekumar@bell.ca>
2021-10-07add clamp docosgn422w27-3/+407
add clamp doc into policy parent tree Issue-ID: POLICY-3337 Change-Id: I72534b2ee2d70a4271c64965d7163ef828f53928 Signed-off-by: osgn422w <gervais-martial.ngueko@intl.att.com>
2021-10-07Merge "Added documentation for policy db-migrator"Liam Fallon2-17/+326
2021-10-06Added documentation for policy db-migratorktimoney2-17/+326
Issue-ID: POLICY-3690 Change-Id: Icb1d0b931043f67a357fc8e5fc6c24a440c08f19 Signed-off-by: ktimoney <kevin.timoney@est.tech>
2021-10-04Merge "Document removal of xacml-pdp API limitation"Jorge Hernandez1-0/+4
2021-09-30Document removal of xacml-pdp API limitationliamfallon1-0/+4
In the Honolulu Maintenance release the decision API is always running In Istanbul the: REST server is always running (i.e., the port is always responsive), but the decision API is enabled/disabled by PDP-STATE-CHANGE messages from PAP. Jim Hahn asked me to document this. Issue-ID: POLICY-3556 Change-Id: I6eee0b2f3d1e03b09dda7e14e3fa528826dc0d2b Signed-off-by: liamfallon <liam.fallon@est.tech>
2021-09-29Rest API for Control Loop documentation.adheli.tavares8-1/+2580
Issue-ID: POLICY-3363 Change-Id: I1a69e163df2710b8b44f86195f228b44cd0d1d48 Signed-off-by: adheli.tavares <adheli.tavares@est.tech>
2021-09-29Control Loop Participant Protocol documentation.adheli.tavares13-13/+480
- removing yaml code files for Defining CL Issue-ID: POLICY-3363 Change-Id: I79ae349bb966d35256f117f6a17bc06f18c2afda Signed-off-by: adheli.tavares <adheli.tavares@est.tech>
2021-09-27Defining Control Loops documentation.adheli.tavares7-2/+305
Issue-ID: POLICY-3363 Change-Id: I11cc75800a78c67295d7286804158786ffd4e651 Signed-off-by: adheli.tavares <adheli.tavares@est.tech>
2021-09-27Update policy release notesRam Krishna Verma1-2/+0
Updating policy release notes to remove multi-tenancy from Guilin release as we don't support it yet. Issue-ID: POLICY-3493 Change-Id: Ie55d978757680634988dabb23184d66bca9a8f91 Signed-off-by: Ram Krishna Verma <ram_krishna.verma@bell.ca>
2021-09-27Update libs for sphinx and LF docs theme to match.adheli.tavares2-70/+9
Sphinx bump to 4.2.x didn't match LF theme for docs, so other libs needed to be adapted. Refer to commit /doc/+/124461 Issue-ID: POLICY-3363 Change-Id: Icfcf23725a7777ccaf10a28c0b7ad3bffc8d9f97 Signed-off-by: adheli.tavares <adheli.tavares@est.tech>
2021-09-22System Level Dialogues for CL docs.adheli.tavares24-39/+248
- added a new page for system level dialogues - fixed few missed hyperlinks on controlloops main page Issue-ID: POLICY-3363 Change-Id: Iccc1a1493f594ed8f7d55da247d637567abff4ec Signed-off-by: adheli.tavares <adheli.tavares@est.tech>
2021-09-22Update cds actor documentRam Krishna Verma1-7/+7
Updating the cds actor document to use -u <user:password> than -H Authorization header with base64 encoded user/password. Issue-ID: POLICY-3157 Change-Id: Id31df5a95b7b4861d05365fbb9c361df773bbf90 Signed-off-by: Ram Krishna Verma <ram_krishna.verma@bell.ca>
2021-09-21Adding Control loop automation management docs.adheli.tavares8-3/+455
Issue-ID: POLICY-3363 Change-Id: Id0cea8baa3c50662fb320ba1db3db65e42b9183c Signed-off-by: adheli.tavares <adheli.tavares@est.tech>
2021-09-14Merge "Add CLAMP/Controlloop doc placeholder"Liam Fallon4-0/+28
2021-09-14Add CLAMP/Controlloop doc placeholderliamfallon4-0/+28
For M4, the structure of new documentation must be in place. This review brings in the documentation structure for the CLAMP and TOSCA ControlLoop documentation. Issue-ID: POLICY-3595 Change-Id: I64b3ba05ebd51b8a86334df4adb36c91a42a0bc6 Signed-off-by: liamfallon <liam.fallon@est.tech>
2021-09-13Update distribution user manualRam Krishna Verma1-5/+8
Issue-ID: POLICY-3493 Change-Id: I2dae46c5b7ae54a47db33b2189552429ade24fdf Signed-off-by: Ram Krishna Verma <ram_krishna.verma@bell.ca>
2021-09-02Merge "Document multi-cluster support"Liam Fallon7-0/+79
2021-09-01Document multi-cluster supportJim Hahn7-0/+79
Updated per review comment: - specify PDP removal frequency - indicate that it's experimental Issue-ID: POLICY-3494 Change-Id: Ia3085c984b95415090e245d2ff7cd966c154064f Signed-off-by: Jim Hahn <jrh3@att.com>
2021-08-31Update xacml version in honolulu release notesJim Hahn1-1/+1
Issue-ID: POLICY-3556 Change-Id: I2e38f6b5988c056794b46b7ab9396b29ce50bd78 Signed-off-by: Jim Hahn <jrh3@att.com>
2021-08-30Document xacml-pdp REST server for honoluluJim Hahn1-0/+10
Add documentation for Honolulu Maintenance Release regarding xacml-pdp always being active. Issue-ID: POLICY-3556 Change-Id: Ib509d3d9e4cbd7f8e85199b735da0556745dc89b Signed-off-by: Jim Hahn <jrh3@att.com>
2021-08-16Fix drools no-locking feature documentationa.sreekumar1-0/+2
Change-Id: If11e14ab98b8eeaeb4cbf4f19daa15efe3f674a1 Issue-ID: POLICY-3114 Signed-off-by: a.sreekumar <ajith.sreekumar@bell.ca>
2021-08-11Document Honolulu Maintenance ReleaseJim Hahn1-0/+49
Note: the date will need to be updated once it has been determined. Issue-ID: POLICY-3532 Change-Id: I78e4fb3b5b9bb8c6aa004ecf60bb3eca40d42c79 Signed-off-by: Jim Hahn <jrh3@att.com>
2021-08-09Update docs for audit & statistics api'sRam Krishna Verma3-19/+107
Update docs for audit & statistics api's to keep them in sync with the recent code changes in pap. Issue-ID: POLICY-3528 Change-Id: I4ba8f5aacf0a0d63a727bee533e829bca9bab55b Signed-off-by: Ram Krishna Verma <ram_krishna.verma@bell.ca>
2021-07-29Fix document for policy audit api'sRam Krishna Verma1-4/+4
Issue-ID: POLICY-3340 Change-Id: I2b0aa4c368dee3cb6641bed33a8d3be6323b457d Signed-off-by: Ram Krishna Verma <ram_krishna.verma@bell.ca>
2021-07-28Add document for policy audit api'sRam Krishna Verma3-0/+529
Adding section for policy audit api's in pap. Issue-ID: POLICY-3340 Change-Id: I33b572372a5279ef03bc48b62d524dfd15c49c28 Signed-off-by: Ram Krishna Verma <ram_krishna.verma@bell.ca>
2021-07-26APEX doc updates for multiple output supporta.sreekumar2-16/+169
Change-Id: I1867c7ecc5405e972401a9ed647b7ff71ba2a88e Issue-ID: POLICY-3512 Signed-off-by: a.sreekumar <ajith.sreekumar@bell.ca>
2021-07-21Update xacml docs returning attributesDragosh, Pamela (pd1248)2-5/+5
Update the documentation to refer to examples and tutorials regarding the use of attributes along with obligations and advice. Issue-ID: POLICY-2865 Change-Id: I048b2e19f9ca4fdbf50e18d2b64299023b4af2bb Signed-off-by: Dragosh, Pamela (pd1248) <pd1248@att.com>
2021-07-20Document how to run the DMaaP simulator locallyliamfallon1-0/+44
Issue-ID: POLICY-3424 Change-Id: Iee6b3dd3cb0cb9aca28846e596286c287d8b645f Signed-off-by: liamfallon <liam.fallon@est.tech>
2021-07-20Merge "Add profile for generating Swagger documents"Liam Fallon3-9/+219
2021-07-20Merge "Add documentation on excluding xacml applications"Ajith Sreekumar1-0/+13
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-19Add documentation on excluding xacml applicationsDragosh, Pamela (pd1248)1-0/+13
Issue-ID: POLICY-3326 Change-Id: If097e1f85f0e7b9d85bcff678c14ffa1644db407 Signed-off-by: Dragosh, Pamela (pd1248) <pd1248@att.com>
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