aboutsummaryrefslogtreecommitdiffstats
path: root/docs
AgeCommit message (Collapse)AuthorFilesLines
2022-11-15Query data NCMP-Operational with CPSpathlukegleeson2-6/+7
New GET Endpoint: /v1/ch/{cm-handle}/data/ds/{ncmp-datastore-name}/query?cps-path={CPSPath} Implemented error for {ncmp-datastore-name} other than operational - (Toine) Refactored and renamed (abstract) handler for better re-use Mainly by introducing a separate handler for OperationalQuery Reviewers Toine, Sourabh, Priyank Issue-ID: CPS-1002 Signed-off-by: lukegleeson <luke.gleeson@est.tech> Change-Id: Iaca018869d95d4ce800072431baa190050a6dad0
2022-11-09Fix RTD broken linksmpriyank2-10/+10
- Broken link for logback xml file - Broken link for oom_user_guide Issue-ID: CPS-1378 Change-Id: I071d5ad890c1471b50a43517427eeab27631fd52 Signed-off-by: mpriyank <priyank.maheshwari@est.tech>
2022-10-27Merge "Release Notes Heading Edit"Toine Siebelink1-0/+4
2022-10-27Release Notes Heading Editseanbeirne1-0/+4
Issue-ID: CPS-1321 Signed-off-by: seanbeirne <sean.beirne@est.tech> Change-Id: Id2371a744ae216a5e7b2c1a50c88ad68d5883b5b
2022-10-24[NCMP] Add Basic Auth to OpenAPI DefinitionsJosephKeenan4-0/+22
-Adding basic auth to OpenAPI definitions Issue-ID: CPS-1350 Signed-off-by: JosephKeenan <joseph.keenan@est.tech> Change-Id: Iab677f2abc07eed8c3e2910191b15ba27028ee88
2022-10-18CPS upgradeability doc correctionseanbeirne1-2/+2
Issue-ID: CPS-1312 Signed-off-by: seanbeirne <sean.beirne@est.tech> Change-Id: I5f35dc4a13b1898638246ebb91726c5487cbef57
2022-10-12Release notes updateslukegleeson1-6/+20
Update release 3.1.5 to 3.2.0 Document Upgrade/Downgrade limitations Add CPS endpoint user stories Issue-ID: CPS-1329 Signed-off-by: lukegleeson <luke.gleeson@est.tech> Change-Id: Iaacd6095a8df7639cc276e84ca938e90a7768621
2022-10-05Make CPS/NCMP upgradeablelukegleeson1-1/+1
Liquibase step to add CM Handle Advised state to existing CM Handles Issue-ID: CPS-1312 Signed-off-by: lukegleeson <luke.gleeson@est.tech> Change-Id: I8077e66c64946f6ce092daa96ee40cd935fe0b72
2022-10-05Bump CPS version to 3.1.5-SNAPSHOTmpriyank1-1/+25
- Bumped the version to 3.1.5-snapshot and updated the version properties file Issue-ID: CPS-1325 Change-Id: I61848166b94a5ce14651f2d0fe42e4cc39f5c5e2 Signed-off-by: mpriyank <priyank.maheshwari@est.tech>
2022-10-04Merge "Async External Schema and related Read the doc"Toine Siebelink2-0/+236
2022-10-03Remove NotNull on revision for YangResourceEntitylukegleeson1-0/+1
Issue-ID: CPS-1265 Signed-off-by: lukegleeson <luke.gleeson@est.tech> Change-Id: Icfe4d9881a3aa7d92d5bd17eaaed91bdbce0a203
2022-10-03Swallow kafkaExceptionmpriyank1-1/+1
- swallow the kafka exception if we are unable to send the kafka message due to any reason. - updated release notes as well Issue-ID: CPS-1294 Change-Id: Iaa8ae5b0bc289d819a46b4a95a1382f4ecee66aa Signed-off-by: mpriyank <priyank.maheshwari@est.tech>
2022-09-30Bump CPS to 3.1.4-SNAPSHOTmpriyank1-1/+25
- bumping the cps version from 3.1.3-SNAPSHOT to 3.1.4-SNAPSHOT - Also updated the release notes to accomodate 3.1.4 version changes Issue-ID: CPS-1313 Change-Id: I487ab4301123cce6afb5a4086b8ebca24acf5e14 Signed-off-by: mpriyank <priyank.maheshwari@est.tech>
2022-09-30Async External Schema and related Read the docJosephKeenan2-0/+236
-updated cps-events to include schema and related information for async operations Issue-ID: CPS-1166 Signed-off-by: JosephKeenan <joseph.keenan@est.tech> Change-Id: I1d40b5dd650663c1089119a60304b0490dedb8e1
2022-09-29Disable maven skip deploympriyank1-1/+25
- disabling the maven.deploy.skip to false - disabling the maven.install.skip to false - also added the release notes Issue-ID: CPS-1309 Change-Id: I6047c859b68db0a4b49da7b45bcb6b89535ce153 Signed-off-by: mpriyank <priyank.maheshwari@est.tech>
2022-09-28Prep for 3.1.2 of CPSmpriyank1-1/+25
- updated release notes - bumbed cps version to 3.1.2-SNAPSHOT from 3.1.1-SNAPSHOT Issue-ID: CPS-1304 Change-Id: Ie65f76032b087dffc716e00fa3868f89f165a6b1 Signed-off-by: mpriyank <priyank.maheshwari@est.tech>
2022-09-27Fix security bug in logslukegleeson1-0/+7
When a method with signature containing "AuthPassword" is passed, the value returned is changed to *********** in logs e.g... Execution time of : DmiProperties.getAuthPassword() with argument[s] = *********** ... Legacy code cleaning also included Issue-ID: CPS-1226 Signed-off-by: lukegleeson <luke.gleeson@est.tech> Change-Id: Ic4914eae7e5ed6d361287413d17abfe50a3788ae
2022-09-263.1.1 release notes sectionmpriyank1-0/+24
- CPS release notes section. Issue-ID: CPS-1302 Change-Id: Ie11500a12288f2f1dd6799604a13e839ecff300e Signed-off-by: mpriyank <priyank.maheshwari@est.tech>
2022-09-22Update Release Notes for Kohnlukegleeson3-27/+80
Added Jira tickets completed Updated Log Example in admin guide Updated timer property names for ncmp in deployment guide Issue-ID: CPS-1251 Signed-off-by: lukegleeson <luke.gleeson@est.tech> Change-Id: I20933d7d113bfa57937ec7f13ba3eb0ab6bc675a
2022-09-22Updated release notes with limitation related to cps pathputhuparambil.aditya2-0/+11
Issue-ID: CPS-1179 Signed-off-by: puthuparambil.aditya <aditya.puthuparambil@bell.ca> Change-Id: I9fa7799e5a54b82b280606a14d09ce2256b844f2
2022-09-07Update doc and release notes after endpoint mergebmiklos4-833/+861
- Update generated swagger files according to changes - Add release notes for the parent ticket Issue-ID: CPS-1001 Issue-ID: CPS-1256 Change-Id: I09aaec26971ae89f4588bfc80d2b80cc4778dfc8 Signed-off-by: bmiklos <miklos.baranyak@est.tech>
2022-09-02Update documentation for NCMP inventory openAPIemaclee4-891/+1385
- added JIRA (CPS-1136) to release notes - updated RTD copies of open api documentation for both cps-rest and cps-ncmp-rest - files were updated by copying the generated sources as outlined on https://wiki.onap.org/display/DW/CPS+Release+Process Issue-ID: CPS-1136 Signed-off-by: emaclee <lee.anjella.macabuhay@est.tech> Change-Id: I929e0e774d8a42ad943eaf8a6ccf4e8891da4b77
2022-09-01Adding config for RTDJosephKeenan5-91/+146
-added config to files related to https://gerrit.onap.org/r/c/cps/+/130246/29 Issue-ID: CPS-1237 Signed-off-by: JosephKeenan <joseph.keenan@est.tech> Change-Id: Ia2fe7d2ecf3bb33608139c5fbf1328dc211f5629
2022-09-01Fixing more RTD warningsToineSiebelink1-2/+2
Issue-ID: CPS-1237 Signed-off-by: ToineSiebelink <toine.siebelink@est.tech> Change-Id: Ic2ccad169b9ca96ab1788d2ae33d7ead8180b968
2022-09-01Fixing RTD warningsemaclee8-45/+52
Issue-ID: CPS-1237 Signed-off-by: emaclee <lee.anjella.macabuhay@est.tech> Change-Id: I0f09d6355d23451207d2d937fbda155b1407fb5a
2022-08-31Force py3.8 in tox.iniCédric Ollivier1-4/+4
It allows leveraging on OpenStack Yoga's upper-contraints without any exception. Issue-ID: DOC-782 Signed-off-by: Cédric Ollivier <cedric.ollivier@orange.com> Change-Id: I02b6a9c1595248e5d7e79a4a6ceb2cd38b5cc6ee
2022-08-29Update CM Handle Query RTD with Casing Conventionlukegleeson1-0/+5
Details the casing differences between the response body and CPS Path querying Issue-ID: CPS-1211 Signed-off-by: lukegleeson <luke.gleeson@est.tech> Change-Id: Iec46df1401df4647cd324eea0e0e5f305b5cdbcc
2022-08-19Update Cps Events LCM RTDemaclee1-18/+1
Issue-ID: CPS-1196 Signed-off-by: emaclee <lee.anjella.macabuhay@est.tech> Change-Id: I6f3588e072faba5fd35bbca92990f68dd70322c8
2022-08-09Module Sync, Data Sync, Retry Mechanism RTDDylanB95EST4-4/+60
- Add Documentation for Module Sync, Data Sync, and Retry Mechanism Proccesses for RTD - Update CPS-Core header on the Index to just CPS - Add Cps-NCMP Customizations for retry mechanism and data sync Issue-ID: CPS-1181 Change-Id: Idb76de380e49e42ca337cabcf2708b940e15f46f Signed-off-by: DylanB95EST <dylan.byrne@est.tech>
2022-08-05State Model RTDDylanB95EST1-0/+14
Add Read The Doc documentation for CM-Handle state model Briefly explain all 5 potnetial cm handle states Issue-ID: CPS-1162 Change-Id: Iee52f9c280929337abf4aac2f5c9bbfb1edde30f Signed-off-by: DylanB95EST <dylan.byrne@est.tech>
2022-08-04Document DataStore Sync State(RTD)bmiklos1-0/+10
Added a CM-Handle data sync state description section under Cps-Modelling -> NCMP-Modelling -> Basic Concepts -> Cm Handle Issue-ID: CPS-1164 Change-Id: Ia53a1ccbacda388ec98a3de936af0913edad1c58 Signed-off-by: bmiklos <miklos.baranyak@est.tech>
2022-08-04Query CM Handles RTDlukegleeson6-50/+297
Updates to RTD for CM Handles Querying Removed documented limitation in CPS path which has since been implemeneted Updated dmi-registry file in RTD modeling Issue-ID: CPS-1161 Signed-off-by: lukegleeson <luke.gleeson@est.tech> Change-Id: I19ff09dadb43a46e14844e198278949f059c6e68
2022-07-29LCM events RTDemaclee3-1/+246
Issue-ID: CPS-1165 Signed-off-by: emaclee <lee.anjella.macabuhay@est.tech> Change-Id: Ib6743bc73b260b4345a1bedf0de2ef892a6b3c87
2022-06-30Kafka consumer can not be turned offJosephKeenan1-5/+2
-NOTE: Build will fail until docker-compose version issues on build server are fixed --Ticket raised https://jira.linuxfoundation.org/plugins/servlet/theme/portal/2/IT-24219 -added flag for async -added response if async is triggered without being enabled & associated test -modified to use one global flag for notifications Issue-ID: CPS-1088 Signed-off-by: JosephKeenan <joseph.keenan@est.tech> Change-Id: If9d988b4dcb71bf37c1b1bf9464090782708ffc2
2022-06-15Fix release notesBruno Sakoto1-7/+39
* Add missing 3.0.1 for Jakarta * Review 3.1.0 for Kohn (not released yet) Issue-ID: CPS-1087 Change-Id: Id0ba8246935edff100fb952e9955f462d2313a7e Signed-off-by: Bruno Sakoto <bruno.sakoto@bell.ca>
2022-05-10Watchdog Process-Make ConfigurableDylanB95EST1-9/+19
Make time configurable for the watchdog process. Add documentation outlining this. Issue-ID: CPS-875 Change-Id: I1307c82d02789097efda1ba981eb1fd36c9efc38 Signed-off-by: DylanB95EST <dylan.byrne@est.tech>
2022-05-03Merge "Updated the documentation with limitation of leaf condition"Toine Siebelink1-1/+4
2022-04-29Merge "[STRIMZI] Add strimzi kafka notes"Toine Siebelink2-10/+13
2022-04-28Updated the documentation with limitation of leaf conditionLathish1-1/+4
Issue-ID: CPS-988 Change-Id: I6d02b35b949c62f956b291a86d4abe6e1a70b3ec Signed-off-by: Lathish <lathishbabu.ganesan@est.tech>
2022-04-11Add bounds to sphinx requirementCédric Ollivier1-1/+3
As ONAP was created before Oct 20 2020 in RTD, we must set bounds to enforce a compatible Sphinx version (see manual). Issue-ID: DOC-782 Signed-off-by: Cédric Ollivier <cedric.ollivier@orange.com> Change-Id: I5ed268d592986764bf040690a47c5024692768b7
2022-04-08Refactoring/ Adding Tests for ValidationDylanB95EST2-1/+37
Refactored classes affected by validation Have added tests for anywhere where validation is used Have refactored the parse and sync modules validation to be validated at the public api method Issue-ID: CPS-322 Change-Id: I4989cfd03300fbdca41571d0aa2d0b96978858ba Signed-off-by: DylanB95EST <dylan.byrne@est.tech>
2022-04-05[cps] Fix getResourceDataForPassthroughOperational endpointputhuparambil.aditya1-20/+0
Get endpoint only accepts application/json. Issue-ID: CPS-957 Signed-off-by: puthuparambil.aditya <aditya.puthuparambil@bell.ca> Change-Id: Ifc7426fbcd6073a39554014dc18b2107b6343b16
2022-04-05Merge "Structured Exception details for DMI"Bruno Sakoto1-0/+84
2022-04-04Structured Exception details for DMImpriyank1-0/+84
- Introduced DmiErrorMessage in API docs with 502 Bad Gateway - HttpClientRequestException will be thrown which will be exposed as 502 BAD Gateway for the client from NCMP Issue-ID: CPS-917 Change-Id: Iba8f159e8216bc1f63a9ab86208e5c802437e2e8 Signed-off-by: mpriyank <priyank.maheshwari@est.tech>
2022-03-28Merge "Updated the Documentation with sample yang and json"Toine Siebelink2-15/+138
2022-03-25Updated the Documentation with sample yang and jsonLathish2-15/+138
Issue-ID: CPS-940 Change-Id: I66b2f0cc1007a23498803cca695aa3d19c0eb433 Signed-off-by: Lathish <lathishbabu.ganesan@est.tech>
2022-03-22Update docs to add info on providing additional configRenu Kumari1-2/+7
- Added information on overriding values of spring-supported properties Issue-ID: CPS-918 Signed-off-by: Renu Kumari <renu.kumari@bell.ca> Change-Id: I660cd9ea0c4c73d972f9c1645f5ed28308282fdc
2022-03-15Create primary documentation for Jakarta releaseBruno Sakoto8-415/+1054
* Update release notes * Update openapi documentation * Fix section title hierarchy * Fix admin container directive not found Issue-ID: CPS-935 Signed-off-by: Bruno Sakoto <bruno.sakoto@bell.ca> Change-Id: Iabdc357aa0168c1becafd6de1ac7703ec3bd1afa
2022-03-15[STRIMZI] Add strimzi kafka notesefiacor2-10/+13
Signed-off-by: efiacor <fiachra.corcoran@est.tech> Change-Id: Id85d2708bdb2eb1ddfaa72740a5a9df5599f298b Issue-ID: DMAAP-1681
2022-03-01Create Endpoint For Get Cm Handles By NameDylanB95EST3-168/+855
Create endpoint and implement logic for get cm handle details by cm handle name Issue-ID: CPS-817 Change-Id: I83bd2da9219d13fac715a08b19108028ca6f6751 Signed-off-by: DylanB95EST <dylan.byrne@est.tech>