summaryrefslogtreecommitdiffstats
path: root/docs/sections/healthcheck.rst
diff options
context:
space:
mode:
authorHansen, Tony (th1395) <th1395@att.com>2023-05-23 21:27:17 +0000
committerHansen, Tony (th1395) <th1395@att.com>2023-05-31 21:01:29 +0000
commit663df2c1b8d9176094a62b00b7e80de096180621 (patch)
tree849841dc428fcfba07d9c39494f95ccd1f25da8a /docs/sections/healthcheck.rst
parentbcd436a1be4fbe2c8ad7ce074d86b94b8ff44f4e (diff)
clean up some sphinx warnings
Change-Id: I8c2d925e8b27b4740227af0be3ab5d6f7153ec38 Signed-off-by: Hansen, Tony (th1395) <th1395@att.com> Issue-ID: DCAEGEN2-3399 Signed-off-by: Hansen, Tony (th1395) <th1395@att.com> Signed-off-by: Vijay Venkatesh Kumar <vv770d@att.com> Signed-off-by: Hansen, Tony (th1395) <th1395@att.com>
Diffstat (limited to 'docs/sections/healthcheck.rst')
-rw-r--r--docs/sections/healthcheck.rst26
1 files changed, 11 insertions, 15 deletions
diff --git a/docs/sections/healthcheck.rst b/docs/sections/healthcheck.rst
index b7ec033f..8622ab4b 100644
--- a/docs/sections/healthcheck.rst
+++ b/docs/sections/healthcheck.rst
@@ -9,18 +9,16 @@ DCAE Health Check
HealthCheck Services
--------------------
-DCAE healthchecks are performed by a separate services.
+DCAE healthchecks are performed by a separate service.
- dcae-ms-healthcheck
-- dcaemod-healthcheck
-
+
These service is packaged into a Docker image (``onap/org.onap.dcaegen2.deployments.healthcheck-container``),
which is built in the ``healthcheck-container`` module in the ``dcaegen2/deployments`` repository.
dcae-ms-healthcheck is deployed along with services enabled under (``oom/kubernetes/dcaegen2-services``)
-dcaemod-healthcheck is deployed along with services enabled under (``oom/kubernetes/dcaemod``)
-These healthcheck container runs as service that exposes a simple Web API. In response to
+This healthcheck container runs as service that exposes a simple Web API. In response to
request, the service checks Kubernetes to verify that all of the expected
DCAE platform and service components are in a ready state.
@@ -33,18 +31,20 @@ The healthcheck service is exposed as a Kubernetes ClusterIP Service named
.. note::
Run the below commands before running "curl dcae-ms-healthcheck"
- * To get the dcae-ms-healthcheck pod name, run following command:
- .. code-block:: bash
+ * To get the dcae-ms-healthcheck pod name, run following command:
+
+.. code-block:: bash
kubectl get pods -n onap | grep dcae-ms-healthcheck
* Then enter in to the shell of the container, run the following command (substituting the pod name retrieved by the previous command):
- .. code-block:: bash
+
+.. code-block:: bash
kubectl exec -it <dcae-ms-healthcheck pod> -n onap bash
-.. code-block:: json
+.. code-block:: bash
$ curl dcae-ms-healthcheck
{
@@ -55,7 +55,7 @@ The healthcheck service is exposed as a Kubernetes ClusterIP Service named
"name": "onap-dcae-hv-ves-collector",
"ready": 1,
"unavailable": 0
- },
+ },
{
"name": "onap-dcae-prh",
"ready": 1,
@@ -77,8 +77,4 @@ The healthcheck service is exposed as a Kubernetes ClusterIP Service named
"unavailable": 0
}
]
- }
-
-
-The dcaemod-healthcheck service is also exposed as a Kubernetes ClusterIP Service named
-`dcaemod-healthcheck`. The service can be queried similar to `dcae-ms-healthcheck`
+ }