diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/api/swagger/ncmp/openapi-inventory.yaml | 8 | ||||
| -rw-r--r-- | docs/api/swagger/ncmp/openapi.yaml | 12 | ||||
| -rw-r--r-- | docs/deployment.rst | 11 | ||||
| -rw-r--r-- | docs/release-notes.rst | 1 |
4 files changed, 32 insertions, 0 deletions
diff --git a/docs/api/swagger/ncmp/openapi-inventory.yaml b/docs/api/swagger/ncmp/openapi-inventory.yaml index ff9f4ba683..8a6c13ebec 100644 --- a/docs/api/swagger/ncmp/openapi-inventory.yaml +++ b/docs/api/swagger/ncmp/openapi-inventory.yaml @@ -222,6 +222,7 @@ components: updatedCmHandles: - cmHandle: my-cm-handle alternateId: my-alternate-id + dataProducerIdentifier: my-data-producer-identifier publicCmHandleProperties: key: my-property cmHandleProperties: @@ -230,6 +231,7 @@ components: trustLevel: COMPLETE - cmHandle: my-cm-handle alternateId: my-alternate-id + dataProducerIdentifier: my-data-producer-identifier publicCmHandleProperties: key: my-property cmHandleProperties: @@ -239,6 +241,7 @@ components: createdCmHandles: - cmHandle: my-cm-handle alternateId: my-alternate-id + dataProducerIdentifier: my-data-producer-identifier publicCmHandleProperties: key: my-property cmHandleProperties: @@ -247,6 +250,7 @@ components: trustLevel: COMPLETE - cmHandle: my-cm-handle alternateId: my-alternate-id + dataProducerIdentifier: my-data-producer-identifier publicCmHandleProperties: key: my-property cmHandleProperties: @@ -302,6 +306,7 @@ components: example: cmHandle: my-cm-handle alternateId: my-alternate-id + dataProducerIdentifier: my-data-producer-identifier publicCmHandleProperties: key: my-property cmHandleProperties: @@ -334,6 +339,9 @@ components: alternateId: example: my-alternate-id type: string + dataProducerIdentifier: + example: my-data-producer-identifier + type: string required: - cmHandle type: object diff --git a/docs/api/swagger/ncmp/openapi.yaml b/docs/api/swagger/ncmp/openapi.yaml index 9203b6d4ca..da0b0b3f99 100644 --- a/docs/api/swagger/ncmp/openapi.yaml +++ b/docs/api/swagger/ncmp/openapi.yaml @@ -1871,6 +1871,8 @@ components: RestOutputCmHandle: example: cmHandle: my-cm-handle1 + alternateId: my-alternate-id + dataProducerIdentifier: my-data-producer-identifier publicCmHandleProperties: - key: Book Type - key: Book Type @@ -1889,6 +1891,7 @@ components: details: locked due to failure in module sync lastUpdateTime: 2022-12-31T20:30:40.000+0000 trustLevel: COMPLETE + moduleSetTag: my-module-set-tag properties: cmHandle: example: my-cm-handle1 @@ -1906,6 +1909,15 @@ components: description: Current trust level of the relevant CM handle ID. example: COMPLETE type: string + moduleSetTag: + example: my-module-set-tag + type: string + alternateId: + example: my-alternate-id + type: string + dataProducerIdentifier: + example: my-data-producer-identifier + type: string title: CM handle Details type: object CmHandlePublicProperties: diff --git a/docs/deployment.rst b/docs/deployment.rst index c1ee1eb2ea..ba8fcd9347 100644 --- a/docs/deployment.rst +++ b/docs/deployment.rst @@ -12,6 +12,13 @@ CPS Deployment .. contents:: :depth: 2 +Database configuration +====================== +CPS uses PostgreSQL database. As per the `PostgreSQL documentation on resource consumption +<https://www.postgresql.org/docs/current/runtime-config-resource.html#GUC-SHARED-BUFFERS>`_, the *shared_buffers* +parameter should be set between 25% and 40% of total memory. It has a default value of 128 megabytes, so this should be +set appropriately. For example, given a database with 2GB of memory, 512MB is a recommended value. + CPS OOM Charts ============== The CPS kubernetes chart is located in the `OOM repository <https://github.com/onap/oom/tree/master/kubernetes/cps>`_. @@ -255,6 +262,10 @@ Any spring supported property can be configured by providing in ``config.additio | notification.async.executor. | | | | thread-name-prefix | | | +-------------------------------------------+---------------------------------------------------------------------------------------------------------+-------------------------------+ +| config.additional. | Maximum time allowed by the thread pool executor for execution of one of the threads in milliseconds. | ``60000`` | +| notification.async.executor. | | | +| time-out-value-in-ms | | | ++-------------------------------------------+---------------------------------------------------------------------------------------------------------+-------------------------------+ | config.additional. | Specifies number of database connections between database and application. | ``10`` | | spring.datasource.hikari. | This property controls the maximum size that the pool is allowed to reach, | | | maximumPoolSize | including both idle and in-use connections. | | diff --git a/docs/release-notes.rst b/docs/release-notes.rst index e79a188ef5..2202d11391 100644 --- a/docs/release-notes.rst +++ b/docs/release-notes.rst @@ -39,6 +39,7 @@ Release Data Bug Fixes --------- 3.4.7 + - `CPS-2150 <https://jira.onap.org/browse/CPS-2150>`_ Fix for Async task execution failed by TimeoutException. Features -------- |