X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;f=docs%2Fdeployment.rst;h=c7504e28b939ddcd7f3f6efc634c4513a16eb516;hb=96c8e88e3750a16fa66d3f16ea0c84c0daf0be8f;hp=7dd4494f277c845b16b263840f9d95d80745a103;hpb=8c0b1b62c1e88f0c0cc547bbf91d9b236839992b;p=cps.git diff --git a/docs/deployment.rst b/docs/deployment.rst index 7dd4494f2..c7504e28b 100644 --- a/docs/deployment.rst +++ b/docs/deployment.rst @@ -1,6 +1,6 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. .. http://creativecommons.org/licenses/by/4.0 -.. Copyright (C) 2021 Nordix Foundation +.. Copyright (C) 2021-2022 Nordix Foundation .. Modifications Copyright (C) 2021 Bell Canada. .. DO NOT CHANGE THIS LABEL FOR RELEASE NOTES - EVEN THOUGH IT GIVES A WARNING @@ -19,11 +19,11 @@ This chart includes different cps components referred as fu .. container:: ulist - - `cps-core `_ - - `cps-temporal `_ - - `ncmp-dmi-plugin `_ + - `cps-core `__ + - `cps-temporal `__ + - `ncmp-dmi-plugin `__ -Please refer to the `OOM documentation `_ on how to install and deploy ONAP. +Please refer to the `OOM documentation `_ on how to install and deploy ONAP. Installing or Upgrading CPS Components ====================================== @@ -197,8 +197,8 @@ Any spring supported property can be configured by providing in ``config.additio | logging.level | Logging level set in cps-core | info | | | | | +---------------------------------------+---------------------------------------------------------------------------------------------------------+-------------------------------+ -| config.useStrimziKafka | If targeting a custom kafka cluster, ie useStrimziKakfa: false, the config.eventPublisher.spring.kafka | true | -| | values must be set. | | +| config.useStrimziKafka | If targeting a custom kafka cluster, ie useStrimziKafka: false, the config.eventPublisher.spring.kafka | true | +| | values below must be set. | | +---------------------------------------+---------------------------------------------------------------------------------------------------------+-------------------------------+ | config.eventPublisher. | Kafka hostname and port | ``:9092`` | | spring.kafka.bootstrap-servers | | | @@ -246,15 +246,12 @@ Any spring supported property can be configured by providing in ``config.additio | config.additional. | Kafka topic to publish to cps-temporal | ``cps.data-updated-events`` | | notification.data-updated.topic | | | +---------------------------------------+---------------------------------------------------------------------------------------------------------+-------------------------------+ -| config.additional. | If notification from cps-core to cps-temporal is enabled or not. | ``true`` | -| notification.data-updated.enabled | If this is set to false, then the config.publisher properties could be skipped. | | -+---------------------------------------+---------------------------------------------------------------------------------------------------------+-------------------------------+ -| config.additional. | Dataspaces to be enabled for publishing events to cps-temporal | ```` | -| notification.data-updated.filters. | | | +| config.additional. | Array of dataspaces to be enabled for publishing events to cps-temporal | [] | +| notification.data-updated.filters. | If left blank CPS-Temporal notification will be sent for all dataspaces | | | enabled-dataspaces | | | +---------------------------------------+---------------------------------------------------------------------------------------------------------+-------------------------------+ -| config.additional. | If notifications should be processed in synchronous or asynchronous manner | ``false`` | -| notification.async.enabled | | | +| config.additional. | If asynchronous messaging, user notifications, and updated event persistence should be enabled | ``true`` | +| notification.data-updated.enabled | | | +---------------------------------------+---------------------------------------------------------------------------------------------------------+-------------------------------+ | config.additional. | Core pool size in asynchronous execution of notification. | ``2`` | | notification.async.executor. | | | @@ -272,7 +269,7 @@ Any spring supported property can be configured by providing in ``config.additio | notification.async.executor. | | | | wait-for-tasks-to-complete-on-shutdown| | | +---------------------------------------+---------------------------------------------------------------------------------------------------------+-------------------------------+ -| config.additional. | Prefix to be added to the thread name in asynchronous execution of notifications. | ``async_`` | +| config.additional. | Prefix to be added to the thread name in asynchronous execution of notifications. | ``Async-`` | | notification.async.executor. | | | | thread-name-prefix | | | +---------------------------------------+---------------------------------------------------------------------------------------------------------+-------------------------------+ @@ -281,6 +278,8 @@ Any spring supported property can be configured by providing in ``config.additio | maximumPoolSize | including both idle and in-use connections. | | +---------------------------------------+---------------------------------------------------------------------------------------------------------+-------------------------------+ +.. _additional-cps-ncmp-customizations: + Additional CPS-NCMP Customizations ================================== +---------------------------------------+---------------------------------------------------------------------------------------------------------+-------------------------------+ @@ -292,8 +291,17 @@ Additional CPS-NCMP Customizations | | | | | | See also :ref:`cps_common_credentials_retrieval`. | | +---------------------------------------+---------------------------------------------------------------------------------------------------------+-------------------------------+ -| config.timers.advised-modules-sync | Specifies the delay in milliseconds in which the module sync watch dog will wake again after finishing. | ``30000`` | -| .sleep-time-ms | | | +| config.ncmp.timers | Specifies the delay in milliseconds in which the module sync watch dog will wake again after finishing. | ``30000`` | +| .advised-modules-sync.sleep-time-ms | | | +| | | | ++---------------------------------------+---------------------------------------------------------------------------------------------------------+-------------------------------+ +| config.ncmp.timers | Specifies the delay in milliseconds in which the retry mechanism watch dog | | +| .locked-modules-sync.sleep-time-ms | will wake again after finishing. | ``300000`` | +| | | | +| | | | ++---------------------------------------+---------------------------------------------------------------------------------------------------------+-------------------------------+ +| config.ncmp.timers | Specifies the delay in milliseconds in which the data sync watch dog will wake again after finishing. | ``30000`` | +| .cm-handle-data-sync.sleep-time-ms | | | | | | | +---------------------------------------+---------------------------------------------------------------------------------------------------------+-------------------------------+