From 265546fa55b74b9e79ff40a310dc75f0be358ced Mon Sep 17 00:00:00 2001 From: Branislav Malo Date: Tue, 10 Sep 2024 10:56:45 +0200 Subject: [PATCH] Fix healtcheck documentation. Updated the output for the health check using the RPC implementation. Signed-off-by: Branislav Malo Signed-off-by: Branislav Malo --- .../rpc_health/readme.md | 25 ++++++++----------- 1 file changed, 10 insertions(+), 15 deletions(-) diff --git a/frinx-uniconfig/user-guide/uniconfig-operations/uniconfig-node-manager/rpc_health/readme.md b/frinx-uniconfig/user-guide/uniconfig-operations/uniconfig-node-manager/rpc_health/readme.md index fcbe72a4c..d963a4bb5 100644 --- a/frinx-uniconfig/user-guide/uniconfig-operations/uniconfig-node-manager/rpc_health/readme.md +++ b/frinx-uniconfig/user-guide/uniconfig-operations/uniconfig-node-manager/rpc_health/readme.md @@ -13,24 +13,16 @@ curl --location --request POST 'http://localhost:8181/rests/operations/uniconfig --header 'Content-Type: application/json' ``` -**Response if database persistence is disabled:** - -```json RPC Response, Status: 200 -{ - "output": { - "healthy": true, - "message": "DB persistence is disabled" - } -} -``` - **Response if database persistence is enabled and the database connection is valid:** ```json RPC Response, Status: 200 { "output": { - "healthy": true, - "message": "DB connection is alive" + "status": "UP", + "details": { + "state": "ACCEPTING_TRAFFIC", + "reason": "The application is ready to receive traffic and DB connection is alive" + } } } ``` @@ -40,8 +32,11 @@ curl --location --request POST 'http://localhost:8181/rests/operations/uniconfig ```json RPC Response, Status: 200 { "output": { - "healthy": false, - "message": "Error connecting to DB" + "status": "DOWN", + "details": { + "state": "ACCEPTING_TRAFFIC", + "reason": "Error connecting to DB" + } } } ```