summaryrefslogtreecommitdiffstats
path: root/docs/apex
AgeCommit message (Collapse)AuthorFilesLines
2022-08-25Update apex-pdp user manualRam Krishna Verma1-2/+28
Updating the apex-pdp user manual to add details about JSON schema support. Issue-ID: POLICY-4298 Change-Id: I1c900cd08f10b30f85370082c77d110655853961 Signed-off-by: Ram Krishna Verma <ram_krishna.verma@bell.ca>
2021-11-11Fix doc errors on case sensitive OSliamfallon2-7/+0
Renaming .PNG to .png to fix documentation build errors on case sensitive OSs Issue-ID: POLICY-3791 Change-Id: I89cc443a7e41bdaa35cf6255d5303295c97fbd9b Signed-off-by: liamfallon <liam.fallon@est.tech>
2021-10-12Fix warnings in PF documentation generationliamfallon1-244/+193
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-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-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-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-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>
2020-10-06Update APEX documentation with the usage of eventNamea.sreekumar1-3/+46
Update APEX documentation on the usage of eventName to avoid duplicate requests. Change-Id: I15e7b95d5d38deff231bf8ebb2b4d867a15ef6bc Issue-ID: POLICY-2856 Signed-off-by: a.sreekumar <ajith.sreekumar@bell.ca>
2020-09-17Documentation changes for APEX standalone support for ToscaPolicya.sreekumar1-33/+29
Change-Id: Ie8936a8f2dcbced6fab804df390e5caa91218c55 Issue-ID: POLICY-2826 Signed-off-by: a.sreekumar <ajith.sreekumar@bell.ca>
2020-09-14Documentation changes for APEX standalone support for ToscaPolicya.sreekumar1-20/+62
Change-Id: I91c1168f7e924904959e9a90d7e8e988a3ceab38 Issue-ID: POLICY-2821 Signed-off-by: a.sreekumar <ajith.sreekumar@bell.ca>
2020-08-21Correct documentation for apex installation testliamfallon1-196/+193
The documentation for the installation test of apex specified that is changed to use the apexApps.sh script rather than the apexEngine.sh script, the apexApps.sh script runs apex with the correct userid of "apexuser". The installation test documentation is corrected to use the -m parameter to point out the model, otherwise the user has to be in $APEX_HOME for the example to run the test. Issue-ID: POLICY-2791 Change-Id: I4d18b5e2c86645183ae65619adf664e7adfefebc Signed-off-by: liamfallon <liam.fallon@est.tech>
2020-07-13Remove redundant apex-pdp documentationliamfallon4-2893/+2
The developer guide and installation guide are amalgamated into the apex policy guide. The informaiton in those documents is redundant. Issue-ID: POLICY-2686 Change-Id: Ib6426aa508bad3206808ff2fb2f3d8b1d3c2bd5f Signed-off-by: liamfallon <liam.fallon@est.tech>
2020-07-13apex policy guide: Frankfurt changesliamfallon1-1790/+1475
Changes introduced in Frankfurt are reflected in the document, especially how to convert Javascript scripts from Nashorn format to Rhino format. Issue-ID: POLICY-2686 Change-Id: I3661fbdd66c4f360c9013a3c7aab81df32133829 Signed-off-by: liamfallon <liam.fallon@est.tech>
2020-07-06REST Plugin and client documentationliamfallon1-334/+132
The documentation for the apex REST Consumer and REST requestor plugins was incomplete. This patch updates the user manual to complete their documentation. The apex-pdp client documentation is also amended to reflect how the client is launched in Frankfurt. Issue-ID: POLICY-2686 Change-Id: I0808f5815cdb3151b2bd290ba73afb2cdc066403 Signed-off-by: liamfallon <liam.fallon@est.tech>
2020-07-02Apex user manual: Frankfurt changesliamfallon2-89/+59
A number of changes in Frankfurt impacted the isntallation and configuration process for apex, especially in standalone mode. Issue-ID: POLICY-2686 Change-Id: Id114416cc73ba3669bcd3a98979e7595e9e1e2ca Signed-off-by: liamfallon <liam.fallon@est.tech>
2020-05-21Fix last documentation warningsPamela Dragosh1-0/+7
Had to add toctree to remove warnings. Do not seem to like the fact that an .rst is referenced via a label. Removed amsterdam controller and added frankfurt controller. Issue-ID: POLICY-2511 Change-Id: I5fb887b3a1d26a543c844d6baa34b3fa0e506f0a Signed-off-by: Pamela Dragosh <pdragosh@research.att.com>
2020-05-01Apex-pdp documentation changed Code to Github Link + fix for errors and warningsaditya.puthuparambil5-5553/+168
Issue-ID: POLICY-2399 Signed-off-by: aditya.puthuparambil <aditya.puthuparambil@est.tech> Change-Id: Ic5cfe700028fa7b27d89fc90f36d1bb8f14f7997
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-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-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>
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 Shah1-42/+46
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-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-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 documentsramverma2-2/+2
Change-Id: I3b5e27c0e7a2ce2112e150dc862d3d080a691a83 Issue-ID: POLICY-1898 Signed-off-by: ramverma <ram.krishna.verma@est.tech>
2019-07-11Fix review comments from previous reviewramverma6-383/+383
Change-Id: Ide96508d2cc616a688d6c1ed524b8317c53aa222 Issue-ID: POLICY-1898 Signed-off-by: ramverma <ram.krishna.verma@est.tech>
2019-07-10Adding apex-pdp & distribution documents to parentramverma39-0/+14066
Change-Id: If8039f68a1669787685d4a7bdc37dec203901062 Issue-ID: POLICY-1898 Signed-off-by: ramverma <ram.krishna.verma@est.tech>