Enhance HV-VES documentation
[dcaegen2.git] / docs / sections / healthcheck.rst
1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2 .. http://creativecommons.org/licenses/by/4.0
3
4 HealthCheck
5 ===========
6
7 DCAE Healthcheck .
8
9 OOM Deployment
10 --------------
11
12     In OOM deployments DCAE healthcheck are reported by separate  service - dcae-healthcheck; this is deployment of org.onap.dcaegen2.deployments.healthcheck-container which is built from dcaegen2/deployment repo - healthcheck-container module. The container includes list of deployments done in DCAE  (both via helm charts and Cloudify) for which periodic health check is performed. For helm deployed component - servicename defined is charts are used and for cloudify, the deployments identified in bootstrap are prefixed with release name. The container itself is deployed via helm charts (oom/kubernetes/dcaegen2/charts/dcae-healthcheck). This polls the deployments specified periodically and reports the status. The service can be queried for status as below. 
13     
14 curl dcae-healthcheck    
15 .. code-block:: json    
16
17          
18          
19          {
20             "type": "summary",
21             "count": 11,
22             "ready": 11,
23             "items": [{
24                 "name": "dev-dcaegen2-dcae-cloudify-manager",
25                 "ready": 1,
26                 "unavailable": 0
27             }, {
28                 "name": "dep-config-binding-service",
29                 "ready": 1,
30                 "unavailable": 0
31             }, {
32                 "name": "dep-deployment-handler",
33                 "ready": 1,
34                 "unavailable": 0
35             }, {
36                 "name": "dep-inventory",
37                 "ready": 1,
38                 "unavailable": 0
39             }, {
40                 "name": "dep-service-change-handler",
41                 "ready": 1,
42                 "unavailable": 0
43             }, {
44                 "name": "dep-policy-handler",
45                 "ready": 1,
46                 "unavailable": 0
47             }, {
48                 "name": "dep-dcae-ves-collector",
49                 "ready": 1,
50                 "unavailable": 0
51             }, {
52                 "name": "dep-dcae-tca-analytics",
53                 "ready": 1,
54                 "unavailable": 0
55             }, {
56                 "name": "dep-dcae-prh",
57                 "ready": 1,
58                 "unavailable": 0
59             }, {
60                 "name": "dep-dcae-hv-ves-collector",
61                 "ready": 1,
62                 "unavailable": 0
63             }, {
64                 "name": "dep-dcae-datafile-collector",
65                 "ready": 1,
66                 "unavailable": 0
67             }]
68         }
69         
70         
71
72 Heat Deployment
73 ---------------