diff options
Diffstat (limited to 'docs/sections/healthcheck.rst')
| -rw-r--r-- | docs/sections/healthcheck.rst | 158 |
1 files changed, 64 insertions, 94 deletions
diff --git a/docs/sections/healthcheck.rst b/docs/sections/healthcheck.rst index b85a1dea..b7ec033f 100644 --- a/docs/sections/healthcheck.rst +++ b/docs/sections/healthcheck.rst @@ -5,110 +5,80 @@ DCAE Health Check ================= -OOM Deployment --------------- -In OOM deployments, DCAE healthchecks are performed by a separate service--dcae-healthcheck. -This service is packaged into a Docker image (``onap/org.onap.dcaegen2.deployments.healthcheck-container``), + +HealthCheck Services +-------------------- + +DCAE healthchecks are performed by a separate services. + +- 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. -The service is deployed with a Helm chart (``oom/kubernetes/dcaegen2/charts/dcae-healthcheck``) -when DCAE is deployed using OOM. +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``) -The dcae-healthcheck container runs a service that exposes a simple Web API. In response to +These 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. The service -has a fixed list of platform and service components that are normally deployed when DCAE is -first installed, including components deployed with Helm charts and -components deployed using Cloudify blueprints. In addition, the healthcheck -service tracks and checks components that are deployed dynamically using Cloudify -blueprints after the initial DCAE installation. +DCAE platform and service components are in a ready state. + +The service has a fixed list service components identified by json file - `expected-components.json <https://github.com/onap/oom/blob/master/kubernetes/dcaegen2-services/resources/expected-components.json>`_ +; these are normally deployed when dcaegen2-services is installed. In addition, the healthcheck service also tracks and checks components that are deployed dynamically after the initial DCAE installation. The healthcheck service is exposed as a Kubernetes ClusterIP Service named -`dcae-healthcheck`. The service can be queried for status as shown below. +`dcae-ms-healthcheck`. The service can be queried for status as shown below. .. note:: - Run the below commands before running "curl dcae-healthcheck" + Run the below commands before running "curl dcae-ms-healthcheck" + + * 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 + + kubectl exec -it <dcae-ms-healthcheck pod> -n onap bash - * To get the dcae-healthcheck pod name, run this: kubectl get pods -n onap | grep dcae-healthcheck - * Then enter in to the shell of the container, run this: kubectl exec -it <dcae-healthcheck pod> -n onap bash .. code-block:: json - $ curl dcae-healthcheck + $ curl dcae-ms-healthcheck { - "type": "summary", - "count": 14, - "ready": 14, - "items": [ - { - "name": "dev-dcaegen2-dcae-cloudify-manager", - "ready": 1, - "unavailable": 0 - }, - { - "name": "dev-dcaegen2-dcae-config-binding-service", - "ready": 1, - "unavailable": 0 - }, - { - "name": "dev-dcaegen2-dcae-inventory-api", - "ready": 1, - "unavailable": 0 - }, - { - "name": "dev-dcaegen2-dcae-servicechange-handler", - "ready": 1, - "unavailable": 0 - }, - { - "name": "dev-dcaegen2-dcae-deployment-handler", - "ready": 1, - "unavailable": 0 - }, - { - "name": "dev-dcaegen2-dcae-policy-handler", - "ready": 1, - "unavailable": 0 - }, - { - "name": "dep-dcae-ves-collector", - "ready": 1, - "unavailable": 0 - }, - { - "name": "dep-dcae-tca-analytics", - "ready": 1, - "unavailable": 0 - }, - { - "name": "dep-dcae-prh", - "ready": 1, - "unavailable": 0 - }, - { - "name": "dep-dcae-hv-ves-collector", - "ready": 1, - "unavailable": 0 - }, - { - "name": "dep-dcae-dashboard", - "ready": 1, - "unavailable": 0 - }, - { - "name": "dep-dcae-snmptrap-collector", - "ready": 1, - "unavailable": 0 - }, - { - "name": "dep-holmes-engine-mgmt", - "ready": 1, - "unavailable": 0 - }, - { - "name": "dep-holmes-rule-mgmt", - "ready": 1, - "unavailable": 0 - } - ] - } + "type": "summary", + "count": 5, + "ready": 5, + "items": [{ + "name": "onap-dcae-hv-ves-collector", + "ready": 1, + "unavailable": 0 + }, + { + "name": "onap-dcae-prh", + "ready": 1, + "unavailable": 0 + }, + { + "name": "onap-dcae-tcagen2", + "ready": 1, + "unavailable": 0 + }, + { + "name": "onap-dcae-ves-collector", + "ready": 1, + "unavailable": 0 + }, + { + "name": "onap-dcae-ves-openapi-manager", + "ready": 1, + "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` |