aboutsummaryrefslogtreecommitdiffstats
path: root/docs
AgeCommit message (Collapse)AuthorFilesLines
10 daysRealistic Examples: NCMP Open API and Docsourabh_sourabh2-135/+62
- Updated resourceIdentifier query parameter to align with GNBDUFunctionConfig structure. - Added examples for querying all GNBDUFunctions, specific gNB IDs, and sub-resources like RIM-RS reporting configurations. Issue-ID: CPS-2483 Change-Id: Ibdd93f51debdd797e8cc809774b703c342052559 Signed-off-by: sourabh_sourabh <sourabh.sourabh@est.tech>
2025-02-05Update deployment docs with minimum requirementsdanielhanrahan1-3/+13
- Add minimum CPU and Memory Requirements for NCMP to the deployment documentation, for both 20K and 50K use-cases. - Updated recommended heap allocation to 70%, based on analysis of JVM Process Memory metric in Grafana. Issue-ID: CPS-2584 Signed-off-by: danielhanrahan <daniel.hanrahan@est.tech> Change-Id: Idb056eabf7529f1bc2288a3e07975f080f413c3f
2025-01-30Remove deprecated Rest endpoints for hazelcast healthmpriyank1-14/+0
- removing the hazelcast cluster rest health check endpoints Issue-ID: CPS-2612 Change-Id: I01ad0e4b4d8ad99ce7a6e4e4dc0f0a8272d39227 Signed-off-by: mpriyank <priyank.maheshwari@est.tech>
2025-01-29Bump CPS-NCMP to 3.6.1-SNAPSHOTmpriyank1-1/+24
Issue-ID: CPS-2610 Change-Id: I289fcbdc2df1de6d369cc6e01bdad26ec174b08f Signed-off-by: mpriyank <priyank.maheshwari@est.tech>
2025-01-29Release notes update for 3.6.0mpriyank1-0/+3
Issue-ID: CPS-2610 Change-Id: Iaa0997bb20acabb69933afa61618ff3d48f1c88f Signed-off-by: mpriyank <priyank.maheshwari@est.tech>
2025-01-29Address sonar violations related to hazelcastmpriyank1-0/+2
- Supressing warning caused by deprecation of RestApiConfig in hazelcast 5.5 community version , which will be removed in 6.0 so created https://lf-onap.atlassian.net/browse/CPS-2599 to address the issues - Other sonar fixes Issue-ID: CPS-2594 Change-Id: I2e95cd851eae74d8bbb4535cfbaed1dc1ef89543 Signed-off-by: mpriyank <priyank.maheshwari@est.tech>
2025-01-28Merge "RTD Updates for Policy Executor Integration"Sourabh Sourabh3-157/+89
2025-01-27RTD Updates for Policy Executor IntegrationToineSiebelink3-157/+89
- Updated page describing Policy Executor feature - Updated deployment page, added config parameters for Policy Executor - Corrected release note: Jira for Policy Executor should not have been included before - Clean up release note: removed redundant version mentioning - Clean up tables on deployment page: removed redundant empty lines Issue-ID: CPS-2443 Change-Id: I5750868b6c29e9de29cd08521b8efffff4f37eaf Signed-off-by: ToineSiebelink <toine.siebelink@est.tech>
2025-01-24Less logging during registrationdanielhanrahan1-1/+1
During investigation of CPS-2576 bug, stack traces were added to log output (by logging the exception object). This produces massive log output during registration, since all CM-handles fail to sync and go to LOCKED state initially due to initial DMI delay. This patch logs exception details at warning level but not stacktrace Issue-ID: CPS-2576 Signed-off-by: danielhanrahan <daniel.hanrahan@est.tech> Change-Id: Ibb55991e75c058e9f4983bd876285b48917ee28e
2025-01-24RTD supporting heapdump and threaddump exposurempriyank1-0/+10
- actuator endpoint now have support for heapdump via /actuator/heapdump and the dump will be downloaded on the machine - threaddump is available on /actuator/threddump and will be available as response text Issue-ID: CPS-2453 Change-Id: I263b39478bb953c70b2ffca09760c18d7e50da91 Signed-off-by: mpriyank <priyank.maheshwari@est.tech>
2025-01-23Merge "Add DB Clean-up to CPS Rest Interface"Daniel Hanrahan11-63/+157
2025-01-23Add DB Clean-up to CPS Rest InterfaceToineSiebelink11-63/+157
- add dataspace filter to module cleanup impl - updated integration test to only delete orphaned modules in relevant dataspaces (this also fixes CPS-2571) - improved labels on admin controller test - add dataspaces/../clean rest endpoint for cps core - added 'Regular Maintenance' section to RTD Admin Guide - consistent spelling of 'CM Handle' in RTD Docs Issue-ID: CPS-2554 Change-Id: Ica70c3495758f073eaac9eeeadcc0e1be2c8cc1c Signed-off-by: ToineSiebelink <toine.siebelink@est.tech>
2025-01-22[Docs]: Add RTD documentation for ServiceConfig properties and ↵sourabh_sourabh1-29/+68
WebClientConfiguration context - Added detailed RTD documentation for the ServiceConfig class properties, including connection pooling, timeout settings, and memory management. - Documented the context and usage of WebClientConfiguration, explaining its role in configuring HTTP client behavior for services like Policy Executor and DMI. - Included example configurations and best practices for tuning HTTP client performance. - Improved clarity and accessibility of ServiceConfig-related configuration for future developers and administrators. Issue-ID: CPS-2565 Change-Id: I84e612b2f56293c453884e341a516f55b2bb6b81 Signed-off-by: sourabh_sourabh <sourabh.sourabh@est.tech>
2025-01-17Moved impl package out from api packageleventecsanyi1-30/+20
- refactored cps service packages and the architecture test Issue-ID: CPS-2543 Change-Id: I0fab54cebd157b19ff6105b7d4b6d8265a1af485 Signed-off-by: leventecsanyi <levente.csanyi@est.tech>
2025-01-16One SchemaSet per moduleSetTagToineSiebelink1-5/+2
- Registration: create and upgrade cases. - Handle moduleSetTag deletion (all orphans) for testware - Unit tests updated - additional logging of details for upgrade scenarios - Integration Tests updated - Remove cache for module sets being processed - Removed DbCleaner (startup) - Removed redundant methods in NCMP Inventory for deleting schema set(s) - Removed validation check for all schema set interactions - Updated some schema set tests to use special characters previously not allowed - Checked integration test scenarios for upgrades with and without tags: all scenarios covered! TODO - REST endpoint to remove orphaned schema set data, separate story: CPS-2554 - Investigate exception handling regarding DuplicateYangResourceException: CPS-2555 Issue-ID: CPS-2540 Signed-off-by: ToineSiebelink <toine.siebelink@est.tech> Change-Id: Iaa59cbdb86b7a4a8044624829bc002506ff40cc7
2025-01-10Realistic Examples: NCMP Open API and Docsourabh_sourabh3-177/+242
- Updated resourceIdentifier query parameter to align with GNBDUFunctionConfig structure. - Introduced hierarchical notation (parent=..., child=...) for precise resource identification. - Added examples for querying all GNBDUFunctions, specific gNB IDs, and sub-resources like RIM-RS reporting configurations. Issue-ID: CPS-2483 Change-Id: I215944a45c754e43f61948464c5c8793c22e41c8 Signed-off-by: sourabh_sourabh <sourabh.sourabh@est.tech>
2025-01-09docs config files for oslo release v2thmsdt2-5/+0
Issue-ID: DOC-826 Change-Id: I6f27294301724feb46b737094c95175a17c33dfc Signed-off-by: thmsdt <thomas.kulik@telekom.de>
2024-12-20Update docs related to lockmpriyank1-1/+3
- added the distributed lock in the documentation as well - updated the log level to debug to refrain printing every iteration of the scheduler Issue-ID: CPS-2479 Change-Id: Ieeeff46168d70aca6f423e82bda15a12d6c405a5 Signed-off-by: mpriyank <priyank.maheshwari@est.tech>
2024-12-19RTD docs for async use casempriyank2-1/+7
- Documented the suggestion to tune the kafka parameter for the case when client provides a non existent topic for the async batch usecase. Issue-ID: CPS-2069 Change-Id: I93e1b3006c901b6b4fc3a61df16d3cb82e6c9906 Signed-off-by: mpriyank <priyank.maheshwari@est.tech>
2024-12-12Implementation of Data validation feature in CPS APIsRudrangi Anupriya1-10/+46
Added support to validate JSON/XML data without the need of persisting it in the database. - added "dryRunInQuery" flag as a new query parameter in update/Replace/Add APIs - added new method as part of CpsDataService layer to perform data validation Issue-ID: CPS-2516 Change-Id: I87bb33dd6021567d0fac606d5c4b0168d107311c Signed-off-by: Rudrangi Anupriya <ra00745022@techmahindra.com>
2024-12-10Policy Executor API Review Board CommentsToineSiebelink1-191/+178
- Implemented Guild review comments in API - Updated Stub to reflect new API and 'support' all operations - Updated production code to use new API - Updated Semi-Integration Tests Issue-ID: CPS-2479 Change-Id: Ibe307b0d859312b534009a384e9f71e1ea2affe0 Signed-off-by: ToineSiebelink <toine.siebelink@est.tech>
2024-12-03Added performance section and updated api versionmpriyank4-7/+11
- Added a performance section to the release notes - Populated the correct info.version for NCMP and CPS Rest interfaces Issue-ID: CPS-2537 Change-Id: Iae07da57fc45100b4d250fcfb86a95079869b221 Signed-off-by: mpriyank <priyank.maheshwari@est.tech>
2024-11-29Bump CPS to 3.5.6-SNAPSHOTegernug1-1/+32
Issue-ID: CPS-2488 Change-Id: Ib17e4283de959ec4aab3c68bb3ba8018a10a10b2 Signed-off-by: egernug <gerard.nugent@est.tech>
2024-11-29Merge "Update release notes for OSLO"Daniel Hanrahan2-1/+15
2024-11-29Update release notes for OSLOmpriyank2-1/+15
- Added release notes for the features that were delivered in 3.5.5 version of CPS Issue-ID: CPS-2488 Change-Id: I31e863430a5aff41814bed0a4d39ef8546b8e617 Signed-off-by: mpriyank <priyank.maheshwari@est.tech>
2024-11-28XML content support on Replace list contentRudrangi Anupriya1-0/+19
Here to bring Support for XML Response Entity in Replace List content - Add ContentTypeInheadr in cpsData.yml to support application/xml - Add contentTypeInHeader parameter to accept xml in DataRestController.java - Modify the code return xml Data - written testcase for above changes made Issue-ID: CPS-2411 Change-Id: Ibb7ffb66ccdd03703266123c6d5c2eade0e7cb4a Signed-off-by: Rudrangi Anupriya <ra00745022@techmahindra.com>
2024-11-22Make Content-Type header default to JSON for CPS APIsdanielhanrahan1-7/+14
Recent changes for XML support have made Content-Type header mandatory, where before it was not. This change makes CPS default to JSON if Content-Type is not specified. Issue-ID: CPS-2517 Signed-off-by: danielhanrahan <daniel.hanrahan@est.tech> Change-Id: Ic3718bfe7aedd6fe9dbd978f520179b184c9c932
2024-11-20Update error response for ncmp endpointsseanbeirne2-9/+9
Issue-ID: CPS-2386 Change-Id: I0d1f09cff202e055be255b365fc2271a5ee43b37 Signed-off-by: seanbeirne <sean.beirne@est.tech>
2024-11-20Revert "Update error response for ncmp endpoints"ToineSiebelink2-9/+9
This reverts commit 7e6fee9321e4f13cc4a0d81f83fc3693309cb5d7. Reason for revert: This patch is causing blocking issues at ESH see CPS-2509 Issue-ID: CPS-2509 Change-Id: Ie1bd26ccca4abcac09faf35e2b97491dab32b14d Signed-off-by: ToineSiebelink <toine.siebelink@est.tech>
2024-11-18Merge "Update documentation to reflect changes made to rest endpoints"Priyank Maheshwari2-5/+16
2024-11-18Update documentation to reflect changes made to rest endpointsseanbeirne2-5/+16
Issue-ID: CPS-2505 Change-Id: I503960e3b093a0e83754132db49cae1aa48690e9 Signed-off-by: seanbeirne <sean.beirne@est.tech>
2024-11-18Merge "Update error response for ncmp endpoints"Priyank Maheshwari2-9/+9
2024-11-18Update error response for ncmp endpointsseanbeirne2-9/+9
Issue-ID: CPS-2386 Change-Id: Ib4f37858f5f107e350a13e4bf7ed93493864ce60 Signed-off-by: seanbeirne <sean.beirne@est.tech>
2024-11-17XML content support for only cps Query v2Rudrangi Anupriya1-0/+18
Here to bring Support for XML Response Entity in query data nodes - Add ContentTypeInheadr in cpsQueryV2.yml to support application/xml - Add contentTypeInHeader parameter to accept xml in QueryRestController.java - Implement logic to convert data to xml - written testcase for above changes made Issue-ID: CPS-2359 Change-Id: Ieb7eeb66ccbb03703626132c6d5c2eade0e7cb4b Signed-off-by: Rudrangi Anupriya <ra00745022@techmahindra.com>
2024-11-15Merge "Support alternate Id interface for ncmp inventory /ch/cmhandles endpoint"Priyank Maheshwari2-13/+21
2024-11-13Support alternate Id interface for ncmp inventory /ch/cmhandles endpointseanbeirne2-13/+21
Issue-ID: CPS-2481 Change-Id: I8a200495be1afb9a4f256127f886bed78c77f653 Signed-off-by: seanbeirne <sean.beirne@est.tech>
2024-11-11Merge "CM Data Notifications RTD"Toine Siebelink2-4/+104
2024-11-11Merge "Support Alternate-Id for CPS-E05 data batch interface"Priyank Maheshwari2-9/+9
2024-11-11CM Data Notifications RTDmpriyank2-4/+104
- Added RTD for CM Data Notifications and left a note about the key usage. Issue-ID: CPS-2436 Change-Id: Id1592c85009b945d1785350d54ae8884fcc8bebd Signed-off-by: mpriyank <priyank.maheshwari@est.tech>
2024-11-05Support Alternate-Id for CPS-E05 data batch interfaceseanbeirne2-9/+9
Issue-ID: CPS-2274 Change-Id: I75163bc7943fca5cbbe8c24601a2dfc184a9e6cc Signed-off-by: seanbeirne <sean.beirne@est.tech>
2024-11-05XML content support on get a nodeRudrangi Anupriya3-15/+80
Here to bring Support for XML Response Entity In GET A NODE - Made changes in components.yml to support contentType as application/xml - Add ContentTypeInheadr in cpsDataV2.yml to support application/xml - Add contentTypeInHeader parameter to accept xml in DataRestController.java - Implemented Logic to convert DataMaps To XML Data - written testcase for above changes made Issue-ID: CPS-2280 Change-Id: Ibe7ffb66ccbb03703626132c6d5c2eade0e7ab4b Signed-off-by: Rudrangi Anupriya <ra00745022@techmahindra.com>
2024-11-01[Module Sync] Log state changes after persistencedanielhanrahan2-3/+40
Currently, module sync will output messages such as: "cm-handle-1 is now in READY state" before the state change is persisted to the DB. If an exception occurs, the new state may not be persisted, which makes debugging hard due to misleading log entries. This commit moves the logging to the LCM state handler immediately after the change is persisted. - Move logging of state changes to LcmEventsCmHandleStateHandler. - Remove unused code in LcmEventsCmHandleStateHandler. - Add tests of state change logging. - Update the main test showing the bug to instead show expected behaviour, but disable test for now using @Ignore. Issue-ID: CPS-2474 Signed-off-by: danielhanrahan <daniel.hanrahan@est.tech> Change-Id: I58646af6df95e07e69ca525744713a7c01c25e41
2024-10-24Remove note about TBDMT from DocumentationToineSiebelink1-8/+0
Issue-ID: CPS-2433 Change-Id: Ia791cd7214eec08d2209469b82f56a04de42868c Signed-off-by: ToineSiebelink <toine.siebelink@est.tech>
2024-10-24Update deployment docs for load balancer configdanielhanrahan1-0/+6
Issue-ID: CPS-2415 Signed-off-by: danielhanrahan <daniel.hanrahan@est.tech> Change-Id: I27be67ec9e71e4c6006ef80aa78152f9d1784958
2024-10-17Release Stage 7 for 3.5.4seanbeirne1-2/+29
Issue-ID: CPS-2457 Change-Id: Id9a267c587f16f3fb5edb558b33cd0003864ed93 Signed-off-by: seanbeirne <sean.beirne@est.tech>
2024-10-17Release notes and documentation updates for 3.5.4danielhanrahan6-22/+11
- Release notes update - Update openapi info.version to 3.5.4 - Update scheduled-tasks docs to reflect changes in retry mechanism - Update deployment docs to update configurable timer parameters - Remove unused locked-module-sync.sleep-time-ms Issue-ID: CPS-2457 Signed-off-by: danielhanrahan <daniel.hanrahan@est.tech> Change-Id: Ieb559bbfe348848c4b8669410861edfeeb6c9bf3
2024-10-16Merge "Update documentation related to hazelcast"Toine Siebelink2-9/+7
2024-10-16Update documentation related to hazelcastmpriyank2-9/+7
- removed old entries of data structures which are removed now. - updated the documentation to correctly reflect our infrastructure startegy related to hazelcast. - fixed few NB comments on the merged patch. Issue-ID: CPS-2408 Change-Id: Id7ce4ac695ad94742490ac5d2be89cd23ffda3e5 Signed-off-by: mpriyank <priyank.maheshwari@est.tech>
2024-10-15Add missing duplication test in integration test suiteToineSiebelink1-0/+19
- Added test for ModuleSerive.createSchemaSetFromModules() - Unintendedly Updated one swagger file in docs because 1) DT team forgot to update the relevant file 2) Gers committed pom update to automatically update swagger files 3) I ran 'mvn install' Issue-ID: CPS-2399 Change-Id: I33261c32bbca58ff21aff3cde9588617199f104c Signed-off-by: ToineSiebelink <toine.siebelink@est.tech>
2024-10-15add documentaiton for cps-and-ncmp deploymenthalil.cakal1-2/+12
- the optimum percentage of the JVM allocation documented - remove anchorDataCache from the documentation since no more used Issue-ID: CPS-2180 Change-Id: Ie1b8c43136a38f8da5a865493bed1df030a497d6 Signed-off-by: halil.cakal <halil.cakal@est.tech>