diff options
| author |   halil.cakal <halil.cakal@est.tech> | 2023-09-12 15:32:53 +0100 |
|---|---|---|
| committer | halil.cakal <halil.cakal@est.tech> | 2023-09-15 09:59:30 +0100 |
| commit | 0bdc9430061b680cbd63aeafbd5de9040b6a8a0e (patch) | |
| tree | 4002719e84e4e43797c3b3299b641de0ffd0ffda | |
| parent | b86ef87781764606358ace875ef13f36e39502d0 (diff) | |
Update readthedocs pages with healthcheck API
- Add healthcheck API to read the docs pages
Issue-ID: CPS-1868
Change-Id: I6d57bc26845f9d0dcd4402b4c6f0c087b9be0c5d
Signed-off-by: halil.cakal <halil.cakal@est.tech>
| -rw-r--r-- | docs/architecture.rst | 3 | ||||
| -rw-r--r-- | docs/design.rst | 15 |
2 files changed, 16 insertions, 2 deletions
diff --git a/docs/architecture.rst b/docs/architecture.rst index a7bc974d..622b9c86 100644 --- a/docs/architecture.rst +++ b/docs/architecture.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-2023 Nordix Foundation .. _architecture: DMI-Plugin Architecture @@ -41,6 +41,7 @@ The DMI-Plugin provides following interfaces. * - CPS-NCMP-I-01 - DMI-Plugin Inventory - - Register Plug-in CM-Handles + - Health Check API - REST * - DMI-I-01 - Provides NCMP with xNF data access and module information diff --git a/docs/design.rst b/docs/design.rst index 9326fd3d..27bfdf95 100644 --- a/docs/design.rst +++ b/docs/design.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-2023 Nordix Foundation .. DO NOT CHANGE THIS LABEL FOR RELEASE NOTES - EVEN THOUGH IT GIVES A WARNING .. _design: @@ -38,6 +38,19 @@ and CPS-NCMP using the drop down table in the top right: http://<hostname>:<port>/swagger-ui/index.html?configUrl=/v3/api-docs/swagger-config#/ +Health Check APIs +================= + +The healthcheck URL can be accessed using following URI: + +.. code-block:: bash + + http://<hostname>:<port>/manage/health + +The Health check endpoint is essential for monitoring the status of DMI-Plugins. +CPS is using a Spring Boot pattern here which can easily be configured for any spring boot application. +Springboot provides a built-in Health Check feature through the Spring Boot Actuator module. + Consumed APIs ============= |