summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authormpriyank <priyank.maheshwari@est.tech>2023-11-27 13:53:12 +0000
committermpriyank <priyank.maheshwari@est.tech>2023-11-27 16:53:28 +0000
commit1ae90809b3d3ccdbd0669145d0e4f9f56d7371cd (patch)
treed765c6191fcf63ad33fcc1e6db5f0b7e81a6ae2c /docs
parent605e2ad3d0e612a020d1a3236765e27154132afb (diff)
Expose hazelcast cluster info
- exposing hazelcast cluster and health related rest endpoints to be used in the testware - added test to support it - also added RTD docs Issue-ID: CPS-1980 Change-Id: I926013bee05603a43050b861f677885a2511fffc Signed-off-by: mpriyank <priyank.maheshwari@est.tech>
Diffstat (limited to 'docs')
-rw-r--r--docs/admin-guide.rst12
-rw-r--r--docs/deployment.rst3
2 files changed, 15 insertions, 0 deletions
diff --git a/docs/admin-guide.rst b/docs/admin-guide.rst
index b58e740339..1c4d7455f0 100644
--- a/docs/admin-guide.rst
+++ b/docs/admin-guide.rst
@@ -192,6 +192,18 @@ Prometheus Metrics can be checked at the following endpoint
http://<cps-component-service-name>:8080/actuator/prometheus
+Hazelcast
+---------
+
+Hazelcast cluster state and health check can be seen using the below endpoints
+
+.. code::
+
+ http://<cps-component-service-name>:<member-port>/hazelcast/health
+ http://<cps-component-service-name>:<member-port>/hazelcast/rest/management/cluster/state
+
+See also : :ref:`cps_common_distributed_datastructures`
+
Naming Validation
-----------------
diff --git a/docs/deployment.rst b/docs/deployment.rst
index 59e2adafed..eb5804e5bf 100644
--- a/docs/deployment.rst
+++ b/docs/deployment.rst
@@ -296,6 +296,9 @@ CPS-Core Docker Installation
CPS-Core can also be installed in a docker environment. Latest `docker-compose <https://github.com/onap/cps/blob/master/docker-compose/docker-compose.yml>`_ is included in the repo to start all the relevant services.
The latest instructions are covered in the `README <https://github.com/onap/cps/blob/master/docker-compose/README.md>`_.
+.. Below Label is used by documentation for other CPS components to link here, do not remove even if it gives a warning
+.. _cps_common_distributed_datastructures:
+
CPS-Core and NCMP Distributed Datastructures
============================================