summaryrefslogtreecommitdiffstats
path: root/docs/development/devtools/devtools.rst
AgeCommit message (Collapse)AuthorFilesLines
2023-04-13Update doc CLAMP Automation Composition Smoke TestsFrancescoFioraEst1-2/+2
Update "CLAMP Automation Composition Smoke Tests", and "CLAMP participants (kubernetes, http) Smoke Tests" docs Issue-ID: POLICY-4597 Change-Id: I5093888b5c378efbe14b0f5c71e8c8aaf9dacf10 Signed-off-by: FrancescoFioraEst <francesco.fiora@est.tech>
2023-04-12Restructure devtools folderadheli.tavares1-29/+45
- s3p tests documentation Issue-ID: POLICY-4583 Change-Id: I81fe30f4c083579263db0b9e663953bdc3ecb643 Signed-off-by: adheli.tavares <adheli.tavares@est.tech>
2023-03-01Update S3P documentationwaynedunican1-0/+1
Issue-ID: POLICY-4156 Change-Id: I5d459feebd0c6843784b56e756e30b6e22b9c2d4 Signed-off-by: Wayne Dunican <wayne.dunican@est.tech>
2022-11-16Remove policy parent swagger generation profileliamfallon1-49/+1
This maven profile used the Swagger endpoint to generate the Swagger and then generated a HTML and PDF version using Asciidoc. We now have Swagger as a source artifact so this profile is no longer needed. This commit als fixes the issue with the example for using this profile in the documentation, which references a non-existant link. Issue-ID: POLICY-4431 Change-Id: I970eb392f156662c3bbfb38e978bc46335538925 Signed-off-by: liamfallon <liam.fallon@est.tech>
2022-11-01Fix doc config files and dead linksliamfallon1-6/+3
Documentation config fixed as instructed. Configuration files have been copied from examples provided by the documentation project. Dead links are fixed as well, they cause build fails now. Issue-ID: POLICY-4426 Change-Id: Ied5ca5e5a24f7a625e5b2d94c46d0c2347c68ace Signed-off-by: liamfallon <liam.fallon@est.tech>
2022-09-29Add Strimzi Kafka Setup documentationSirisha_Manchikanti1-0/+12
Issue-ID: POLICY-4134 Signed-off-by: Sirisha_Manchikanti <sirisha.manchikanti@est.tech> Change-Id: I99777042cb32f88610109c2bd557e8782caaca71
2022-05-27Documentation update for OpenSuse imagesdanielhanrahan1-0/+51
Update policy documentation to show how to build and test OpenSuse docker images. Issue-ID: POLICY-4219 Signed-off-by: danielhanrahan <daniel.hanrahan@est.tech> Change-Id: I5b4b5e1661b3157bc40ef6e75d02c108772f3cae
2022-05-05Update CLAMP-SDC pairwise test documentationSirisha_Manchikanti1-0/+2
Issue-ID: POLICY-3741 Signed-off-by: Sirisha_Manchikanti <sirisha.manchikanti@est.tech> Change-Id: I1bb9987100a4122238087bb1443def67025a82c2
2022-04-26smoke tests doc for xacml and droolsjhh1-7/+0
Issue-ID: POLICY-3720 Issue-ID: POLICY-3721 Signed-off-by: jhh <jorge.hernandez-herrero@att.com> Change-Id: I48651d5633d15289efc827c8dcf5bad8671fba4f
2022-04-22Document changes for PAP spring boot migrationa.sreekumar1-0/+14
Change-Id: I0f551169c43fd01cad537dcddebf379e8dd173e8 Issue-ID: POLICY-3861 Signed-off-by: a.sreekumar <ajith.sreekumar@bell.ca>
2022-04-21Document changes for API springboot migrationRashmi Pujar1-2/+17
Issue-ID: POLICY-3925 Signed-off-by: Rashmi Pujar <rashmi.pujar1@bell.ca> Change-Id: Ie517af1fd40c3eafcc758d3fd421a5ce8ca22517
2022-04-12Fix typos in policy docs devtoolslapentafd1-5/+5
Update images names, that were not displaying Issue-ID: POLICY-3941 Signed-off-by: lapentafd <francesco.lapenta@est.tech> Change-Id: I85115478f285028ad02644614bee9c0f7f178206
2022-04-11Updating Clamp documentationadheli.tavares1-1/+1
- update rest apis definitions with renaming of control loop to acm - rename control loop to automation composition - fix a few cross-references missed Issue-ID: POLICY-4063 Change-Id: Ib88074e1d2d08fe38da244b5e1eb2e5783c84a86 Signed-off-by: adheli.tavares <adheli.tavares@est.tech>
2022-04-06Merge "Distribution Smoke Test Documentation"Liam Fallon1-0/+1
2022-04-05Distribution Smoke Test Documentationlapentafd1-0/+1
Issue-ID: POLICY-3722 Signed-off-by: lapentafd <francesco.lapenta@est.tech> Change-Id: I65ebc2d983404714edf34fc642371ed91cb52b71
2022-04-04Rename Controlloop to ACMSirisha_Manchikanti1-1/+1
Issue-ID: POLICY-3941 Signed-off-by: Sirisha_Manchikanti <sirisha.manchikanti@est.tech> Change-Id: Ia3c26392d4eab7f70a14dfed0e9fffebb98989c4
2021-11-15Add document for apex-pdp smoke testRam Krishna Verma1-2/+0
Adding document for apex-pdp smoke testing. Issue-ID: POLICY-3719 Change-Id: Iedbd4624bb7251968f6432c166554b221bc1a217 Signed-off-by: Ram Krishna Verma <ram_krishna.verma@bell.ca>
2021-11-12Add document for policy-pap smoke testRam Krishna Verma1-2/+0
Adding document for policy-pap smoke testing. Issue-ID: POLICY-3718 Change-Id: If60a1c3698c12b2f4d039068366678d7a263a852 Signed-off-by: Ram Krishna Verma <ram_krishna.verma@bell.ca>
2021-11-12Merge "Add document for policy-api smoke test"Ram Krishna Verma1-2/+0
2021-11-11Add document for policy-api smoke testRam Krishna Verma1-2/+0
Adding document for policy-api smoke testing. Issue-ID: POLICY-3717 Change-Id: Icc87a4927cfa84068c354cfaa2115486f4b0caab Signed-off-by: Ram Krishna Verma <ram_krishna.verma@bell.ca>
2021-11-11Add document for policy-cds testingRam Krishna Verma1-0/+2
Adding document for policy-cds testing that includes * creating entities in AAI. * publishing relevant blueprints to CDS. * running tests for apex-pdp * running tests for drools-pdp * deleting blueprints from CDS * deleting entities from AAI Issue-ID: POLICY-3735 Change-Id: Ieddaec9efc0f4241a2bbbbbd02ba1dfc40633da7 Signed-off-by: Ram Krishna Verma <ram_krishna.verma@bell.ca>
2021-10-29Fix documentation warningsliamfallon1-15/+7
Some remaining warnings in the documentaiton build ar fixed. Issue-ID: POLICY-3710 Change-Id: I4d41c3db48d4384cd03f4e9205cf0dcad6f684d4 Signed-off-by: liamfallon <liam.fallon@est.tech>
2021-10-27Merge "Create documentation for policy participant smoke tests"Liam Fallon1-0/+2
2021-10-26Create documentation for policy participant smoke testswaynedunican1-0/+2
Issue-ID: POLICY-3730 Change-Id: I30b06d38aef5f0b4081878cea23f33411d2ff6f3 Signed-off-by: Wayne Dunican <wayne.dunican@est.tech>
2021-10-21Add documentation for CL participants smoke testingrameshiyer271-0/+2
kubernetes, http participants. Issue-ID: POLICY-3729 Signed-off-by: zrrmmua <ramesh.murugan.iyer@est.tech> Change-Id: I7e51950ee37adc1f890f400f066e136bc27816d6
2021-10-21Merge "Add documentation for CLAMP CL pairwise testing"Liam Fallon1-3/+4
2021-10-21Merge "Added doc for smoke testing db-migrator"Liam Fallon1-0/+1
2021-10-21Merge "Add docs for participant intermediary, simulator"Liam Fallon1-1/+4
2021-10-20Add documentation for CLAMP CL pairwise testingrameshiyer271-3/+4
CLAMP - policy core CLMAP - DCAE Issue-ID: POLICY-3740 Signed-off-by: zrrmmua <ramesh.murugan.iyer@est.tech> Change-Id: I0afbac24cffebce3ee0713da9b3e0ca27c8f34d4
2021-10-20Added doc for smoke testing db-migratorktimoney1-0/+1
Issue-ID: POLICY-3724 Change-Id: I7069e52cf7eb6c503b0c2d7cdf13bcfccef35c8e Signed-off-by: ktimoney <kevin.timoney@est.tech>
2021-10-19Add docs for participant intermediary, simulatorSirisha_Manchikanti1-1/+4
This commit contains docs for participant intermediary, participant simulator and respective smoke tests Issue-ID: POLICY-3716 Signed-off-by: Sirisha_Manchikanti <sirisha.manchikanti@est.tech> Change-Id: I72f658d39a3afeab643f680981ab73354418a26c
2021-10-19Added docs for smoke testing the GUIsaul.gill1-1/+3
Added doc for smoke testing the GUI Added images to go together with the docs Added tosca file to be used in tests Issue-ID: POLICY-3725 Change-Id: I91f80ca871f3953e2be1426b17be7e4c9ed5a059 Signed-off-by: saul.gill <saul.gill@est.tech>
2021-10-13ControlLoop S3P test resultsSirisha_Manchikanti1-0/+1
Issue-ID: POLICY-3659 Signed-off-by: Sirisha_Manchikanti <sirisha.manchikanti@est.tech> Change-Id: I1d62b9efe9cb154ce0a8224f32f943ec5d1fffab
2021-10-12Fix warnings in PF documentation generationliamfallon1-0/+61
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-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-19Add profile for generating Swagger documentsliamfallon1-0/+49
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>
2020-05-21Fix last documentation warningsPamela Dragosh1-0/+2
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-04-23Fix documentation errorsPamela Dragosh1-1/+2
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-16Update developer and s3p docsPamela Dragosh1-1166/+50
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>
2019-12-16Document Policy API to create operational policy for CDS actorRashmi Pujar1-0/+1398
- 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