diff options
| -rw-r--r-- | docs/admin-guide.rst | 43 | ||||
| -rw-r--r-- | docs/cps-events.rst | 28 | ||||
| -rw-r--r-- | docs/cps-path.rst | 2 | ||||
| -rw-r--r-- | docs/cps-scheduled-processes.rst | 3 | ||||
| -rw-r--r-- | docs/deployment.rst | 10 | ||||
| -rwxr-xr-x | docs/design.rst | 2 | ||||
| -rw-r--r-- | docs/modeling.rst | 4 | ||||
| -rw-r--r-- | docs/ncmp-cmhandle-querying.rst | 5 |
8 files changed, 52 insertions, 45 deletions
diff --git a/docs/admin-guide.rst b/docs/admin-guide.rst index 1bc7f4ff38..0d7c398e10 100644 --- a/docs/admin-guide.rst +++ b/docs/admin-guide.rst @@ -33,17 +33,17 @@ CPS Log pattern .. code-block:: java <pattern> - { - "timestamp" : "%timestamp", // 2022-01-28 18:39:17.768 - "severity": "%level", // DEBUG - "service": "${springAppName}", // cps-application - "trace": "${TraceId}", // e17da1571e518c59 - "span": "${SpanId}", // e17da1571e518c59 - "pid": "${PID}", //11128 - "thread": "%thread", //tp1901272535-29 - "class": "%logger{40}", .// o.onap.cps.aop.CpsLoggingAspectService - "rest": "%message" // Execution time ... - } + { + "timestamp" : "%timestamp", // 2022-01-28 18:39:17.768 + "severity": "%level", // DEBUG + "service": "${springAppName}", // cps-application + "trace": "${TraceId}", // e17da1571e518c59 + "span": "${SpanId}", // e17da1571e518c59 + "pid": "${PID}", //11128 + "thread": "%thread", //tp1901272535-29 + "class": "%logger{40}", .// o.onap.cps.aop.CpsLoggingAspectService + "rest": "%message" // Execution time ... + } </pattern> Change logging level @@ -63,6 +63,7 @@ Change logging level "effectiveLevel": "INFO" } + - Curl command 2. Change logging level of "logging.level.org.onap.cps" to "DEBUG" .. note:: @@ -92,6 +93,7 @@ Change logging level "effectiveLevel": "DEBUG" } + Location of log files --------------------- By default, Spring Boot will only log to the console and will not write log files. @@ -135,6 +137,7 @@ Logging & Diagnostics General Guidelines ------------------ + CPS-Core logs are sent to `STDOUT` in order to leverage the Kubernetes logging architecture. These logs are available using the following command: @@ -152,15 +155,15 @@ loggers log level Logger configuration is provided as a chart resource : - +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | cps-component-service-name | logback.xml location | - +================================+=================================================================================================================================+ - | cps-core | `logback.xml <https://github.com/onap/oom/blob/master/kubernetes/cps/components/cps-core/resources/config/logback.xml>`_ | - +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | cps-temporal | `logback.xml <https://github.com/onap/oom/blob/master/kubernetes/cps/components/cps-temporal/resources/config/logback.xml>`_ | - +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | ncmp-dmi-plugin | Not yet applicable to DMI-Plugin | - +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ + +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ + | cps-component-service-name | logback.xml location | + +================================+==================================================================================================================================+ + | cps-core | `logback.xml <https://github.com/onap/oom/blob/master/kubernetes/cps/components/cps-core/resources/config/logback.xml>`__ | + +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ + | cps-temporal | `logback.xml <https://github.com/onap/oom/blob/master/kubernetes/cps/components/cps-temporal/resources/config/logback.xml>`__ | + +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ + | ncmp-dmi-plugin | Not yet applicable to DMI-Plugin | + +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ .. Below Label is used by documentation for other CPS components to link here, do not remove even if it gives a warning .. _cps_common_monitoring: diff --git a/docs/cps-events.rst b/docs/cps-events.rst index 34b5a5f669..dce1a30feb 100644 --- a/docs/cps-events.rst +++ b/docs/cps-events.rst @@ -19,11 +19,11 @@ Overview -------- LCM events for CM Handles are published when a CM Handle is created, deleted or another change in the cm handle state occurs. - **3 possible event types:** + **3 possible event types:** - * Create - * Update - * Delete + * Create + * Update + * Delete LCM Event Schema ---------------- @@ -40,16 +40,16 @@ Events header .. code-block:: json - { - "eventId" : "00001", - "eventCorrelationId : "cmhandle-001", - "eventTime" : "2021-11-16T16:42:25-04:00", - "eventSource" : "org.onap.ncmp", - "eventType" : "org.onap.ncmp.cmhandle-lcm-event.create", - "eventSchema" : "org.onap.ncmp:cmhandle-lcm-event", - "eventSchemaVersion" : "1.0" - "event": .... - } + { + "eventId" : "00001", + "eventCorrelationId : "cmhandle-001", + "eventTime" : "2021-11-16T16:42:25-04:00", + "eventSource" : "org.onap.ncmp", + "eventType" : "org.onap.ncmp.cmhandle-lcm-event.create", + "eventSchema" : "org.onap.ncmp:cmhandle-lcm-event", + "eventSchemaVersion" : "1.0" + "event": .... + } Events payload ^^^^^^^^^^^^^^ diff --git a/docs/cps-path.rst b/docs/cps-path.rst index db754c5f8a..44662d893c 100644 --- a/docs/cps-path.rst +++ b/docs/cps-path.rst @@ -3,7 +3,7 @@ .. Copyright (C) 2021-2022 Nordix Foundation .. DO NOT CHANGE THIS LABEL FOR RELEASE NOTES - EVEN THOUGH IT GIVES A WARNING -.. _design: +.. _path: CPS Path diff --git a/docs/cps-scheduled-processes.rst b/docs/cps-scheduled-processes.rst index 01fe66aae4..032b4b143b 100644 --- a/docs/cps-scheduled-processes.rst +++ b/docs/cps-scheduled-processes.rst @@ -3,7 +3,8 @@ .. Copyright (C) 2022 Nordix Foundation .. DO NOT CHANGE THIS LABEL FOR RELEASE NOTES - EVEN THOUGH IT GIVES A WARNING -.. cpsScheduledProcesses: + +.. _cpsScheduledProcesses: CPS Scheduled Processes diff --git a/docs/deployment.rst b/docs/deployment.rst index 11cf77f870..9c9a9ff7c4 100644 --- a/docs/deployment.rst +++ b/docs/deployment.rst @@ -19,9 +19,9 @@ This chart includes different cps components referred as <cps-component-name> fu .. container:: ulist - - `cps-core <https://github.com/onap/oom/tree/master/kubernetes/cps/components/cps-core>`_ - - `cps-temporal <https://github.com/onap/oom/tree/master/kubernetes/cps/components/cps-temporal>`_ - - `ncmp-dmi-plugin <https://github.com/onap/oom/tree/master/kubernetes/cps/components/ncmp-dmi-plugin>`_ + - `cps-core <https://github.com/onap/oom/tree/master/kubernetes/cps/components/cps-core>`__ + - `cps-temporal <https://github.com/onap/oom/tree/master/kubernetes/cps/components/cps-temporal>`__ + - `ncmp-dmi-plugin <https://github.com/onap/oom/tree/master/kubernetes/cps/components/ncmp-dmi-plugin>`__ Please refer to the `OOM documentation <https://docs.onap.org/projects/onap-oom/en/latest/oom_user_guide.html>`_ on how to install and deploy ONAP. @@ -246,11 +246,11 @@ 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. | Dataspaces to be enabled for publishing events to cps-temporal | ```` | +| config.additional. | Dataspaces to be enabled for publishing events to cps-temporal | | | notification.data-updated.filters. | | | | enabled-dataspaces | | | +---------------------------------------+---------------------------------------------------------------------------------------------------------+-------------------------------+ -| config.additional. | If asynchronous messaging, user notifications, and updated event persistence should be enabled | ``true`` | +| config.additional. | If asynchronous messaging, user notifications, and updated event persistence should be enabled | ``true`` | | notification.enabled | | | +---------------------------------------+---------------------------------------------------------------------------------------------------------+-------------------------------+ | config.additional. | Core pool size in asynchronous execution of notification. | ``2`` | diff --git a/docs/design.rst b/docs/design.rst index 7a52255afd..7381759372 100755 --- a/docs/design.rst +++ b/docs/design.rst @@ -76,4 +76,4 @@ NCMP CM Handle Querying ======================= The CM Handle searches endpoints can be used to query for CM Handles or CM Handle IDs. -This endpoint is described in detail in :doc:`ncmp-cmhandle-querying`.
\ No newline at end of file +This endpoint is described in detail in :doc:`ncmp-cmhandle-querying`. diff --git a/docs/modeling.rst b/docs/modeling.rst index bc1019abe7..aa5bbc98cf 100644 --- a/docs/modeling.rst +++ b/docs/modeling.rst @@ -56,6 +56,7 @@ Data Querying - **CPS Path** is used to query data nodes. + .. toctree:: :maxdepth: 1 @@ -122,8 +123,9 @@ Basic Concepts Querying CM Handles - **CM Handle Searches Endpoints** are used to query CM Handles. + .. toctree:: :maxdepth: 1 ncmp-cmhandle-querying.rst - cps-processes.rst
\ No newline at end of file + cps-scheduled-processes.rst diff --git a/docs/ncmp-cmhandle-querying.rst b/docs/ncmp-cmhandle-querying.rst index 0145c11b17..9b54aafaed 100644 --- a/docs/ncmp-cmhandle-querying.rst +++ b/docs/ncmp-cmhandle-querying.rst @@ -37,7 +37,8 @@ Currently this endpoint allows three criteria to be query on: Not all request body combinations have been validated and as such request bodies which do not conform to the structure as documented here can produce results in which all CM Handles are returned. Casing conventions: 'camelCasing' and 'kebab-casing' --------------------------------------------------- +---------------------------------------------------- + .. note:: By convention REST JSON return bodies use 'camelCasing'. By convention field names in yang modelled data use 'kebab-casing'. Therefore some inconsistencies can be seen in the JSON use in CPS REST interfaces. For CM Handle related endpoints we return data in 'camelCasing'. But for *cmHandleWithCpsPath*, the query is accessing yang modelled field names and as such needs to use 'kebab-casing'. Therefore the dmi-registry field names should be referenced when using the *cmHandleWithCpsPath* condition: :doc:`modeling` @@ -157,4 +158,4 @@ The *cmHandleWithCpsPath* condition allows any data of the CM Handle to be queri ] } ] - }
\ No newline at end of file + } |