summaryrefslogtreecommitdiffstats
path: root/docs/clamp
AgeCommit message (Collapse)AuthorFilesLines
2023-04-04Update Policy Offered APIslapentafd1-3/+16
Swagger documentation rendered in ReDoc webpage. The html page is generated during the Sphinx build. The sphinx.builders.linkcheck reports as false positives the links that are generated dynamically, such as with the sphinxcontrib-redoc extension. Issue-ID: POLICY-4581 Change-Id: I9b720b961332689b144d5fe9d8be82be436d1c16 Signed-off-by: lapentafd <francesco.lapenta@est.tech>
2023-03-27Adding new state and system diagrams/pagessaul.gill109-123/+1023
Added images for state diagrams Added images for system level dialogues diagrams Added puml for state diagrams Added puml for system level dialogues diagrams Added page content with diagrams Updated page links Issue-ID: POLICY-4598 Change-Id: Ife009a94f6b0b378fb565bdc097dba251ea74596 Signed-off-by: saul.gill <saul.gill@est.tech>
2022-11-01Fix doc config files and dead linksliamfallon3-686/+5
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-10-05Update ACM documentation for Kohn releaserameshiyer279-1054/+940
Removed participant simulator and k8s ppnt standalone endpoints. Updated REST endpoints of ACM Issue-ID: POLICY-4382 Signed-off-by: zrrmmua <ramesh.murugan.iyer@est.tech> Change-Id: Ib31253952a32b33b2e193293b0b1775fcb35054b
2022-06-07Merge "Documented and Tested API & PAP form Istanbul to Jakarta"Liam Fallon11-7/+224
2022-06-03Merge "Fix type version in all tosca_service_template"Liam Fallon2-24/+23
2022-06-03Documented and Tested API & PAP form Istanbul to Jakartabrunomilitzer11-7/+224
Issue-ID: POLICY-4221 Issue-ID: POLICY-4222 Change-Id: Icca5521045c24908642ca32362f45dcf32825407 Signed-off-by: brunomilitzer <bruno.militzer@est.tech>
2022-06-02Fix type version in all tosca_service_templateFrancescoFioraEst2-24/+23
Issue-ID: POLICY-4229 Change-Id: I18d523c07685db35bffc9d97321fdfed3b9c37e9 Signed-off-by: FrancescoFioraEst <francesco.fiora@est.tech>
2022-05-23Documented Upgrade from Istanbul to Jakartabrunomilitzer4-0/+1851
Issue-ID: POLICY-4107 Change-Id: Ifd624a8dc15b8bcb3c12f91e2c548ffa6a3eb386 Signed-off-by: brunomilitzer <bruno.militzer@est.tech>
2022-04-21Fix some blocks and cross-reference not loading correctlyadheli.tavares1-15/+12
Issue-ID: POLICY-3941 Change-Id: I846063e84f33366634b61f06482e9d73ca0eb5c7 Signed-off-by: adheli.tavares <adheli.tavares@est.tech>
2022-04-13Removed reference from Control Loop of Design Implementationbrunomilitzer6-197/+197
Issue-ID: POLICY-4060 Change-Id: Ia02e6501a1ec7be6b851c7ea90bb561818af8522 Signed-off-by: brunomilitzer <bruno.militzer@est.tech>
2022-04-13Updating clamp documentationadheli.tavares33-82/+85
- rename control loop to acm on system level dialogues - update uml images with acm naming Issue-ID: POLICY-4066 Change-Id: Ia4db7a25967e9e2de424180c31154bedf1851eae Signed-off-by: adheli.tavares <adheli.tavares@est.tech>
2022-04-11Instructions how to run the front end guibrunomilitzer25-1/+319
Including in this review is POLICY-3364 and POLICY-4083 Issue-ID: POLICY-4077 Change-Id: Ie0cef143d7ee5ad6a607aecac06cfe2dff9aa0ec Signed-off-by: brunomilitzer <bruno.militzer@est.tech>
2022-04-11Updating Clamp documentationadheli.tavares18-2174/+2048
- 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-07Merge "Update participant documentation"Liam Fallon8-101/+101
2022-04-07Merge "Updating Clamp documentation"Liam Fallon21-477/+488
2022-04-07Merge "Removed Control Loop from definition-controlloops"Liam Fallon12-273/+276
2022-04-06Updating Clamp documentationadheli.tavares21-477/+488
- rename of control loop references for acm on clamp API protocol - update of images with renamed references Issue-ID: POLICY-4063 Change-Id: Iabaa2889a8a44497120ce828d000da24a7ff5415 Signed-off-by: adheli.tavares <adheli.tavares@est.tech>
2022-04-06Merge "Rename Controlloop to ACM"Liam Fallon7-0/+468
2022-04-06Update participant documentationwaynedunican8-101/+101
Issue-ID: POLICY-4061 Change-Id: If22d8c14d82c34a407fb3394118aa327feabf7a3 Signed-off-by: Wayne Dunican <wayne.dunican@est.tech>
2022-04-05Removed Control Loop from definition-controlloopsbrunomilitzer12-273/+276
Issue-ID: POLICY-4059 Change-Id: I81489e379dc505fd5b148f8ab422177f9461cc20 Signed-off-by: brunomilitzer <bruno.militzer@est.tech>
2022-04-03Rename Controlloop to ACMSirisha_Manchikanti7-0/+468
Issue-ID: POLICY-3941 Signed-off-by: Sirisha_Manchikanti <sirisha.manchikanti@est.tech> Change-Id: Ie705f214ef89cbdbd6ba210d67d244683164d200
2022-04-01Update documentation for runtimeFrancescoFioraEst5-258/+258
Update documentation for rename clamp-controlloop-runtime to clamp-runtime-acm Issue-ID: POLICY-4065 Change-Id: Ice91b6227c6609bb839747d551368d6bbfd74a86 Signed-off-by: FrancescoFioraEst <francesco.fiora@est.tech>
2022-03-31Reestructuring the clamp doc treeadheli.tavares106-79721/+12
Issue-ID: POLICY-3941 Change-Id: I116742a732789a2737a00250849914aa30ad2fbf Signed-off-by: adheli.tavares <adheli.tavares@est.tech>
2022-01-27Remove DCAE/CDS participant referencesliamfallon3-29/+8
Demove references to the DCAE and CDS participants from the documentaiton. The DCAE participant is replaced by the Kubernetes participant Teh CDS participant is not developed yet. Issue-ID: POLICY-3866 Change-Id: I67aa14f730653289ea1f8960a1788100e57f8123 Signed-off-by: liamfallon <liam.fallon@est.tech>
2021-10-29Fix documentation warningsliamfallon2-12/+23
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-21Merge "Create documentation for CLAMP Policy Participant"Liam Fallon1-3/+64
2021-10-21Merge "Added documentation for Control Loop GUI"Liam Fallon7-3/+136
2021-10-21Merge "Add documentation for CL participants"Liam Fallon7-12/+1314
2021-10-21Merge "Docs for Clamp controlloop-runtime"Liam Fallon1-1/+247
2021-10-21Added documentation for Control Loop GUIsaul.gill7-3/+136
Added design/implementation docs for GUI Added overview of related components Added sample scenario flows Issue-ID: POLICY-3712 Change-Id: Ie5190323c01ad46f8d8c865d7c7c2943dcccacd7 Signed-off-by: saul.gill <saul.gill@est.tech>
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-20Docs for Clamp controlloop-runtimeFrancescoFioraEst1-1/+247
Issue-ID: POLICY-3711 Change-Id: Ie53eb4b9b1a9793718d7240980516053bbea430a Signed-off-by: FrancescoFioraEst <francesco.fiora@est.tech>
2021-10-19Create documentation for CLAMP Policy Participantwaynedunican1-3/+64
Issue-ID: POLICY-3715 Change-Id: Ia8937e9cdeb37e48190ff25256f7cd73aabc827c Signed-off-by: Wayne Dunican <wayne.dunican@est.tech>
2021-10-19Add docs for participant intermediary, simulatorSirisha_Manchikanti3-2/+609
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-13ControlLoop S3P test resultsSirisha_Manchikanti1-1/+1
Issue-ID: POLICY-3659 Signed-off-by: Sirisha_Manchikanti <sirisha.manchikanti@est.tech> Change-Id: I1d62b9efe9cb154ce0a8224f32f943ec5d1fffab
2021-10-12Fix warnings in PF documentation generationliamfallon5-14/+79293
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-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-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-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-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-21Adding Control loop automation management docs.adheli.tavares7-2/+454
Issue-ID: POLICY-3363 Change-Id: Id0cea8baa3c50662fb320ba1db3db65e42b9183c Signed-off-by: adheli.tavares <adheli.tavares@est.tech>
2021-09-14Add CLAMP/Controlloop doc placeholderliamfallon3-0/+27
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>