Skip to end of metadata
Go to start of metadata

This page describes the specific API calls that the Robot Healthcheck Testsuite package does in the background.

It is useful when you don't want to run the Healtcheck script on all of the ONAP components and just to run it in a single ONAP component.

Postman (when reachable externally / outside of the Kubernetes private network) and curl CLI (tested inside the Robot Pod Container, reachable within the Kubernetes private network) were the main tools to run these API calls.

NOTES:

  1. Since some of these URLs where the API calls are being executed on do not have NodePorts associated with the ONAP component's service object, they are only reachable within the private Kubernetes network created as part of the ONAP instantiation. In these cases, the API calls need to be executed in an environment that is part or reachable to the private Kubernetes network that your ONAP instance is in (i.e. accessing the Robot pod container and running curl to make these calls).

  2. At the same time, any externally reachable API call can also be executed in its equivalent internally reachable API call.

  3. For HTTPS requests, SSL certificates are self-signed by default. Therefore, please add argument --insecure in your curl request, or http://blog.getpostman.com/2014/01/28/using-self-signed-certificates-with-postman/ for instructions in Postman.  


List of Robot Healthcheck Requests by Component



AAF Healthchecks


  • Description: AAF Healthcheck consists of multiple healthchecks against AAF sub-components

  • Method: GET

  • Externally Reachable: YES

Main AAF Healthcheck

    • URL: https://{{aaf_ip}}:{{aaf_port}}/authz/perms/user/demo@people.osaaf.org
      • aaf_ip → The externally reachable IP of AAF
      • aaf_port → In Heat-based ONAP, port 8100. In OOM K8S, NodePort 30247

    • Headers
      • User/Password required: demo@people.osaaf.org / demo123456!
      • Accept: application/json (optional)
      • Content-type: application/json (optional)

    • Successful Response (If component is Healthy): 200 OK (partial response ONLY below)


AAF SMS Healthcheck

    • URL: https://{{aaf_ip}}:{{aaf_port}}/v1/sms/healthcheck
      • aaf_ip → The externally reachable IP of AAF
      • aaf_port → In Heat-based ONAP, port 10443. In OOM K8S, NodePort 30243

    • Headers
      • User/Password not required
      • Accept: application/json (optional)
      • Content-type: application/json (optional)

    • Successful Response (If component is Healthy): 200 OK (empty response)


AAI Healthcheck


  • Description: AAI Healthcheck

  • Method: GET

  • Externally Reachable: YES     

  • URL: https://{{aai_ip}}:{{aai_port}}/aai/util/echo?action=long
    • aai_ip → The externally reachable IP of AAI
    • aai_port → In Heat-based ONAP, port 8443. In OOM K8S, NodePort 30233

  • Headers
    • No user/password credentials necessary
    • X-TransactionId: robot-ete
    • X-FromAppId: robot-ete
    • Accept: application/json (optional)
    • Content-type: application/json (optional)

  • Successful Response (If component is Healthy): 200 OK


Application Controller (APPC) Healthcheck


  • Description: APPC Healthcheck consists of a single healthcheck test against the APPC's Service Logic Interpreter (SLI) ODL Karaf feature which is essential for APPC functionality.

  • Method: POST

  • Externally Reachable: YES

  • URL: http://{{appc_ip}}:{{appc_port}}/restconf/operations/SLI-API:healthcheck 
    • appc_ip → The externally reachable IP of APPC
    • appc_port → In Heat-based ONAP, port 8282. In OOM K8S, NodePort 30230

  • Headers
    • No user/password credentials necessary
    • Accept: application/json (optional)
    • Content-type: application/json (optional)

  • Successful Response (If component is Healthy): 200 OK



CLI Healthcheck


  • Description: CLI Healthcheck. Basically checks if the CLI Main HTTP Page is active and available.

  • Method: GET

  • Externally Reachable: YES     

  • URL: http://{{cli_ip}}:{{cli_port}}/
    • cli_ip → The externally reachable IP of CLI
    • cli_port → In Heat-based ONAP, port 8080. In OOM K8S, NodePort 30260

  • Headers
    • No user/password credentials necessary
    • Accept: application/json (optional)
    • Content-type: application/json (optional)

  • Successful Response (If component is Healthy): 200 OK (HTML Page)


CLAMP Healthcheck


  • Description: Runs CLAMP Healthcheck

  • Method for all API calls: GET

  • Externally Reachable: YES 

  • URL: https://{{clamp_ip}}:{{clamp_port}}/restservices/clds/v1/healthcheck
    • clamp_ip → The externally reachable IP of CLAMP
    • clamp_port → In Heat-based ONAP, port 8443. In OOM K8S, NodePort 30258

  • Headers
    • No user/password credentials necessary
    • Accept: application/json (optional)
    • Content-type: application/json (optional)

  • Successful Response (If component is Healthy): 200 OK


DCAE Healthcheck (No default NodePort, so only reachable within internal K8S network)


  • Description: Runs DCAE Healthcheck on each of the DCAE sub-components. If all sub-components are healthy, then the DCAE HC response returns 200 OK. 

  • Method for all API calls: GET

  • URL: https://{{k8s_service_name}}:{{k8s_service_port}}/healthcheck
    • k8s_service_name → dcae-healthcheck.onap
    • k8s_service_port → 80

  • Headers
    • No user/password credentials necessary
    • Accept: application/json (optional)
    • Content-type: application/json (optional)

  • Successful Response (If component is Healthy): 200 OK (11 DCAE sub-components. If all 11 sub-components are in "ready":1 state, then master DCAE healthcheck returns 200 OK).

Below is the formatted JSON response (more legible):

{
"type": "summary",
"count": 11,
"ready": 11,
"items": [
{
"name": "dev-dcaegen2-dcae-cloudify-manager",
"ready": 1,
"unavailable": 0
},
{
"name": "dep-config-binding-service",
"ready": 1,
"unavailable": 0
},
{
"name": "dep-deployment-handler",
"ready": 1,
"unavailable": 0
},
{
"name": "dep-inventory",
"ready": 1,
"unavailable": 0
},
{
"name": "dep-service-change-handler",
"ready": 1,
"unavailable": 0
},
{
"name": "dep-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-datafile-collector",
"ready": 1,
"unavailable": 0
}
]
}


DMaaP Healthchecks


  • Description: DMaaP Healthcheck consists of a number of healthcheck tests on the two DMaaP sub-components: DMaaP Data Router & DMaaP Message Router.

  • Method for all API calls: GET

DMaaP Data Router Healthcheck 

    • URL: http://{{dmaap_ip}}:{{dmaap_dr_port}}/internal/fetchProv
      • dmaap_ip → The externally reachable IP of DMaaP
      • dmaap_dr_port → In Heat-based ONAP, port 8080. In OOM K8S, NodePort 30259

    • Headers
      • No user/password credentials necessary
      • Accept: application/json (optional)
      • Content-type: application/json (optional)

    • Successful Response (If component is Healthy): 200 OK

    • Curl when testing DMaaP DR HC within internal K8S network: 

DMaaP Message Router Healthcheck

    • URL: http://{{dmaap_ip}}:{{dmaap_mr_port}}/topics
      • dmaap_ip → The externally reachable IP of DMaaP
      • dmaap_mr_port → In Heat-based ONAP, port 3904. In OOM K8S, NodePort 30227

    • Headers
      • No user/password credentials necessary
      • Accept: application/json (optional)
      • Content-type: application/json (optional)

    • Successful Response (If component is Healthy): 200 OK (Lists current DMaaP Topics)


    • Curl when testing DMaaP MR HC within internal K8S network: 


Service Ochestrator (SO) Healthchecks


  • Description: SO Healthcheck consists of a number of healthcheck tests on each of the SO sub-components as well as the main SO container itself.

  • Method for all API calls: GET

Main SO Container (API Handler) Healthcheck (externally reachable)

    • URL: http://{{so_ip}}:{{so_port}}/manage/health
      • so_ip → The externally reachable IP of APPC
      • so_port → In Heat-based ONAP, port 8080. In OOM K8S, NodePort 30277

    • Headers
      • No user/password credentials necessary
      • Accept: application/json (optional)
      • Content-type: application/json (optional)

    • Successful Response (If component is Healthy): 200 OK

SO Sub-Components – Containers Healthchecks (No default NodePorts, so only reachable within internal K8S network)

    • URL: http://{{k8s_internal_service_name}}:{{k8s_internal_service_port}}/manage/health
      • k8s_internal_service_name → Name of service endpoint of the sub-component. Choose one of the following (we assume onap is the K8S namespace name):
        • so-sdc-controller.onap→ SO SDC Controller/Handler
        • so-bpmn-infra.onap → SO BPMN Handler
        • so-catalog-db-adapter.onap → SO Catalog DB Adapter
        • so-openstack-adapter.onap → SO OpenStack Adapter
        • so-request-db-adapter.onap → SO Request DB Adapter
        • so-sdnc-adapter.onap → SO SDNC Adapter
        • so-vfc-adapter.onap → SO VFC Adapter
      • k8s_internal_service_port → Port of service endpoint of the sub-component. Choose one of the following:
        • 8085→ SO SDC Controller/Handler
        • 8081 → SO BPMN Handler
        • 8082 → SO Catalog DB Adapter
        • 8087 → SO OpenStack Adapter
        • 8083 → SO Request DB Adapter
        • 8086 → SO SDNC Adapter
        • 8084 → SO VFC Adapter

    • Headers (Key – Value)
      • No user/password credentials necessary
      • Accept – application/json (optional)
      • Content-type – application/json (optional)

    • Successful Response (If component is Healthy): 200 OK


ELK (LOG) Healthchecks


  • Description: LOG Component Healthcheck consists of a number of healthcheck tests on the three components that make up the ELK platform: The ElasticSearch component, the Logstash component, and the Kibana component.

  • Method for all API calls: GET

ElasticSearch (ES) Healthcheck

    • URL: http://{{log_es_ip}}:{{log_es_port}}/
      • log_es_ip → The externally reachable IP of ElasticSearch
      • log_es_port → In Heat-based ONAP, port 9200. In OOM K8S, NodePort 30254

    • Headers
      • No user/password credentials necessary
      • Accept: application/json (optional)
      • Content-type: application/json (optional)

    • Successful Response (If component is Healthy): 200 OK


    • Curl when testing ES HC within internal K8S network: 

Kibana Healthcheck 

    • URL: http://{{log_kb_ip}}:{{log_kb_port}}/
      • log_es_ip → The externally reachable IP of Kibana
      • log_es_port → In Heat-based ONAP, port 5601. In OOM K8S, NodePort 30253

      Headers
      • No user/password credentials necessary
      • Accept: application/json (optional)
      • Content-type: application/json (optional)

    • Successful Response (If component is Healthy): 200 OK


      Curl when testing Kibana HC within internal K8S network: 

Logstash Healthcheck (No default NodePorts, so only reachable within internal K8S network)

    • URL: http://{{logstash_internal_service_name}}:{{logstash_internal_service_port}}/  
      • logstash_internal_service_name → The name of the internal Logtash service (log-logstash)
      • logstash_internal_service_port → The port of the internal Logstash service (9600)

    • Headers
      • No user/password credentials necessary
      • Accept: application/json (optional)
      • Content-type: application/json (optional)

    • Successful Response (If component is Healthy): 200 OK


    • Curl when testing Logstash HC within internal K8S network: 


MSB Healthcheck


  • Description: MSB Healthcheck checks if an MSB HTTP Page is accessible.

  • Method: GET

  • Externally Reachable: YES     

  • URL: http://{{msb_ip}}:{{msb_port}}/
    • msb_ip → The externally reachable IP of MSB
    • msb_port → In Heat-based ONAP, port 80. In OOM K8S, NodePort 30280

  • Headers
    • No user/password credentials necessary
    • Accept: application/json (optional)
    • Content-type: application/json (optional)

  • Successful Response (If component is Healthy): 200 OK (HTML Page)

  • Curl when testing MSB HC within internal K8S network: 


Policy Healthcheck


  • Description: Runs Policy Healthcheck against its sub-components (currently, PDP-D, PDP, and PAP)

  • Method for all API calls: GET

  • Externally Reachable: YES 

  • URL: https://{{[policy_ip}}:{{policy_port}}/healthcheck
    • policy_ip → The externally reachable IP of Policy
    • policy_port → In Heat-based ONAP, port 6969. In OOM K8S, NodePort 30217

  • Headers
    • User/Password required: demo@people.osaaf.org / demo123456!
    • Accept: application/json (optional)
    • Content-type: application/json (optional)

  • Successful Response (If component is Healthy): 200 OK


  • Curl when testing Policy HC within internal K8S network: 


Post Orchestration Model Based Audit (POMBA) Healthchecks


  • Description: POMBA Healthcheck consists of a number of healthcheck tests on the following sub-components: the AAI Context Builder Healthcheck, the SDC Context Builder Healthcheck, and the Network Discovery Context Builder Healthcheck. For more info, please visit the POMBA Wiki.

  • Method for all API calls: GET

POMBA AAI Context Builder Healthcheck (No default NodePorts, so only reachable within internal K8S network)

    • URL: http://{{internal_service_name}}:{{internal_service_port}}/aaicontextbuilder/health
      • internal_service_name → The name of the internal service (pomba-aaictxbuilder)
      • internal_service_port → The port of the internal service (9530)

    • Headers
      • No user/password credentials necessary
      • Accept: application/json (optional)
      • Content-type: application/json (optional)

    • Successful Response (If component is Healthy): 200 OK
      {"status":"UP"}

    • Curl when testing POMBA AAI Context Builder HC within internal K8S network: 

POMBA SDC Context Builder Healthcheck (No default NodePorts, so only reachable within internal K8S network)

    • URL: http://{{internal_service_name}}:{{internal_service_port}}/sdccontextbuilder/health
      • internal_service_name → The name of the internal service (pomba-sdcctxbuilder)
      • internal_service_port → The port of the internal service (9530)

    • Headers
      • No user/password credentials necessary
      • Accept: application/json (optional)
      • Content-type: application/json (optional)

    • Successful Response (If component is Healthy): 200 OK
      {"status":"UP"}

    • Curl when testing POMBA SDC Context Builder HC within internal K8S network: 

POMBA Network Discovery Context Builder Healthcheck (No default NodePorts, so only reachable within internal K8S network)

    • URL: http://{{internal_service_name}}:{{internal_service_port}}/ndcontextbuilder/health
      • internal_service_name → The name of the internal service (pomba-networkdiscoveryctxbuilder)
      • internal_service_port → The port of the internal service (9530)

    • Headers
      • No user/password credentials necessary
      • Accept: application/json (optional)
      • Content-type: application/json (optional)

    • Successful Response (If component is Healthy): 200 OK
      {"status":"UP"}

    • Curl when testing POMBA Network Discovery Context Builder HC within internal K8S network: 
    • curl -k -v -u admin:admin --insecure http://pomba-networkdiscoveryctxbuilder.onap:9530/ndcontextbuilder/health

POMBA Service Decomposition Healthcheck (No default NodePorts, so only reachable within internal K8S network)

    • URL: http://{{internal_service_name}}:{{internal_service_port}}/service-decomposition/health
      • internal_service_name → The name of the internal service (pomba-servicedecomposition)
      • internal_service_port → The port of the internal service (9532)

    • Headers
      • No user/password credentials necessary
      • Accept: application/json (optional)
      • Content-type: application/json (optional)

    • Successful Response (If component is Healthy): 200 OK
      {"status":"UP"}

    • Curl when testing POMBA Service Decomposition HC within internal K8S network: 

POMBA Network Discovery Micro Service Healthcheck (No default NodePorts, so only reachable within internal K8S network)

    • URL: https://{{internal_service_name}}:{{internal_service_port}}/health
      • internal_service_name → The name of the internal service (pomba-networkdiscovery)
      • internal_service_port → The port of the internal service (9531)

    • Headers
      • No user/password credentials necessary
      • Accept: application/json (optional)
      • Content-type: application/json (optional)

    • Successful Response (If component is Healthy): 200 OK
      {"status":"UP"}

    • Curl when testing POMBA Network Discovery Micro Service HC within internal K8S network: 

POMBA Kibana Healthcheck (No default NodePorts, so only reachable within internal K8S network)

    • URL: https://{{internal_service_name}}:{{internal_service_port}}/
      • internal_service_name → The name of the internal service (pomba-kibana)
      • internal_service_port → The port of the internal service (5601)

    • Headers
      • No user/password credentials necessary
      • Accept: application/json (optional)
      • Content-type: application/json (optional)

    • Successful Response (If component is Healthy): 200 OK
      {"status":"UP"}

    • Curl when testing POMBA Kibanna HC within internal K8S network: 

POMBA Elastics Search Healthcheck (No default NodePorts, so only reachable within internal K8S network)

    • URL: http://{{internal_service_name}}:{{internal_service_port}}/
      • internal_service_name → The name of the internal service (pomba-es)
      • internal_service_port → The port of the internal service (9200)

    • Headers
      • No user/password credentials necessary
      • Accept: application/json (optional)
      • Content-type: application/json (optional)

    • Successful Response (If component is Healthy): 200 OK
      {"status":"UP"}

    • Curl when testing POMBA Elastics Search HC within internal K8S network: 

POMBA SDNC Context Builder Healthcheck (No default NodePorts, so only reachable within internal K8S network)

    • URL: http://{{internal_service_name}}:{{internal_service_port}}/sdnccontextbuilder/health
      • internal_service_name → The name of the internal service (pomba-sdncctxbuilder)
      • internal_service_port → The port of the internal service (9530)

    • Headers
      • No user/password credentials necessary
      • Accept: application/json (optional)
      • Content-type: application/json (optional)

    • Successful Response (If component is Healthy): 200 OK
      {"status":"UP"}

    • Curl when testing POMBA SDNC Context Builder HC within internal K8S network: 

POMBA Context Aggregater Healthcheck (No default NodePorts, so only reachable within internal K8S network)

    • URL: http://{{internal_service_name}}:{{internal_service_port}}/health
      • internal_service_name → The name of the internal service (pomba-contextaggregator)
      • internal_service_port → The port of the internal service (9529)

    • Headers
      • No user/password credentials necessary
      • Accept: application/json (optional)
      • Content-type: application/json (optional)

    • Successful Response (If component is Healthy): 200 OK
      {"status":"UP"}

    • Curl when testing POMBA Context Aggregater HC within internal K8S network: 

PORTAL Healthcheck


  • Description: Runs Portal Healtcheck against its sub-components, which currently are the following: Portal Backend (BE), Portal Frontend (FE), and Portal Database (DB).

  • Method for all API calls: GET

  • Externally Reachable: YES 

  • URL: http://{{portal_ip}}:{{portal_port}}/ONAPPORTAL/portalApi/healthCheck
    • portal_ip → The externally reachable IP of Portal
    • portal_port → In Heat-based ONAP, port 8989. In OOM K8S, NodePort 30215

  • Headers
    • No user/password credentials necessary
    • Accept: application/json (optional)
    • Content-type: application/json (optional)

  • Successful Response (If component is Healthy): 200 OK

Below is the formatted JSON response (more legible):

{
"statusCode": 200,
"body": [
{
"healthCheckComponent": "BE",
"healthCheckStatus": "UP",
"version": "",
"description": "OK",
"hostName": "dev-portal-portal-app-6f49bbdf7d-67h5r",
"ipAddress": "10.42.119.162",
"dbClusterStatus": "",
"dbPermissions": ""
},
{
"healthCheckComponent": "FE",
"healthCheckStatus": "UP",
"version": "",
"description": "OK",
"hostName": "",
"ipAddress": "",
"dbClusterStatus": "",
"dbPermissions": ""
},
{
"healthCheckComponent": "DB",
"healthCheckStatus": "UP",
"version": "",
"description": "OK",
"hostName": "",
"ipAddress": "",
"dbClusterStatus": "OK",
"dbPermissions": "OK"
}
]
}



SDC Healthcheck


  • Description: Runs SDC Healthcheck against its sub-components, which currently are the following: SDC BE, SDC ES, SDC Titan, SDC DE (DMaaP), SDC Cassandra, SDC FE, and SDC DCAE.

  • Method for all API calls: GET

  • Externally Reachable: YES 

  • URL: http://{{sdc_ip}}:{{sdc_port}}/sdc1/rest/healthCheck
    • sdc_ip → The externally reachable IP of SDC
    • sdc_port → In Heat-based ONAP, port 8181. In OOM K8S, NodePort 30206

  • Headers
    • No user/password credentials necessary
    • Accept: application/json (optional)
    • Content-type: application/json (optional)

  • Snippet of successful Response (If component is Healthy): 200 OK

Below is the formatted JSON response (more legible):

{
"sdcVersion": "1.3.4",
"siteMode": "unknown",
"componentsInfo": [
{
"healthCheckComponent": "BE",
"healthCheckStatus": "UP",
"version": "1.3.4",
"description": "OK"
},
{
"healthCheckComponent": "TITAN",
"healthCheckStatus": "UP",
"description": "OK"
},
{
"healthCheckComponent": "ES",
"healthCheckStatus": "UP",
"version": "1.3.4",
"description": "OK"
},

{
"healthCheckComponent": "DE",
"healthCheckStatus": "UP"
},

{
"healthCheckComponent": "CASSANDRA",
"healthCheckStatus": "UP",
"description": "OK"
},
{
"healthCheckComponent": "ON_BOARDING",
"healthCheckStatus": "UP",
"version": "1.3.4",
"description": "OK",
"componentsInfo": [
{
"healthCheckComponent": "ZU",
"healthCheckStatus": "UP",
"description": "OK"
},
{
"healthCheckComponent": "BE",
"healthCheckStatus": "UP",
"version": "1.3.4",
"description": "OK"
},
{
"healthCheckComponent": "CAS",
"healthCheckStatus": "UP",
"version": "2.1.17",
"description": "OK"
},
{
"healthCheckComponent": "FE",
"healthCheckStatus": "UP",
"version": "1.3.4",
"description": "OK"
}
]
},
{
"healthCheckComponent": "DCAE",
"healthCheckStatus": "UP",
"version": "1.3.0",
"description": "OK",
"componentsInfo": [
{
"healthCheckComponent": "BE",
"healthCheckStatus": "UP",
"version": "1.3.0",
"description": "OK"
},
{
"healthCheckComponent": "TOSCA_LAB",
"healthCheckStatus": "UP",
"version": "1.3.0",
"description": "OK"
},
{
"healthCheckComponent": "FE",
"healthCheckStatus": "UP",
"description": "OK"
}
]
},
{
"healthCheckComponent": "FE",
"healthCheckStatus": "UP",
"version": "1.3.4",
"description": "OK"
}
]
}




SDNC Healthcheck


  • Description: SDNC Healthcheck consists of a single healthcheck test against the SDNC's Service Logic Interpreter (SLI) ODL Karaf feature which is essential for SDNC functionality.

  • Method: POST

  • Externally Reachable: YES

  • URL: http://{{sdnc_ip}}:{{sdnc_port}}/restconf/operations/SLI-API:healthcheck 
    • sdnc_ip → The externally reachable IP of SDNC
    • sdnc_port → In Heat-based ONAP, port 8282. In OOM K8S, NodePort 30202

  • Headers
    • User/Password required: admin / Kp8bJ4SXszM0WXlhak3eHlcse2gAw84vaoGGmJvUy2U
    • Accept: application/json (optional)
    • Content-type: application/json (optional)

  • Successful Response (If component is Healthy): 200 OK



  • Curl when testing SDNC HC within internal K8S network: 


VID Healthcheck


  • Description: VID Healthcheck.

  • Method: GET

  • Externally Reachable: YES

  • URL: http://{{vid_ip}}:{{vid_port}}/vid/healthCheck 
    • vid_ip → The externally reachable IP of VID
    • vid_port → In Heat-based ONAP, port 8080. In OOM K8S, NodePort 30238

  • Headers
    • No User/Password required.
    • Accept: application/json (optional)
    • Content-type: application/json (optional)

  • Successful Response (If component is Healthy): 200 OK



Holmes Healthchecks


  • Description: Holmes Healthcheck consists of a number of healthcheck tests on its core components (functional modules): Rule Management & Engine Management modules.
    • NOTE: Holmes is an analytics application that is deployed as part of DCAE, and depends on the MSB component to pass Robot healthcheck and for it work successfully since the healthcheck endpoints are created from MSB, not from Holmes resources. For more information, please see this link on Holmes Architecture.

  • Method for all API calls: GET

Holmes Rule Management Healthcheck

    • URL: http://{{msb_ip}}:{{msb_iag_port}}/api/holmes-rule-mgmt/v1/healthcheck
      • msb_ip → The externally reachable IP of the MSB component
      • msb_iag_port → In Heat-based ONAP, port 80. In OOM K8S, NodePort 30280

    • Headers
      • No user/password credentials necessary
      • Accept: application/json (optional)
      • Content-type: application/json (optional)

    • Successful Response (If component is Healthy): 200 OK


    • Curl when testing HC within internal K8S network: 

Holmes Engine Management Healthcheck 

    • URL: http://{{msb_ip}}:{{msb_iag_port}}/api/holmes-engine-mgmt/v1/healthcheck  
      • msb_ip → The externally reachable IP of the MSB component
      • msb_iag_port → In Heat-based ONAP, port 80. In OOM K8S, NodePort 30280

    • Headers
      • No user/password credentials necessary
      • Accept: application/json (optional)
      • Content-type: application/json (optional)

    • Successful Response (If component is Healthy): 200 OK


    • Curl when testing HC within internal K8S network: 



MultiCloud Broker Healthcheck


  • Description: MultiCloud Broker Healthcheck.

  • Method: GET

  • Externally Reachable: YES     

  • URL: http://{{multicloud_ip}}:{{multicloud_port}}/api/multicloud/v0/swagger.json
    • multicloud_ip → The externally reachable IP of MultiCloud
    • multicloud_port → In Heat-based ONAP, port 9001. In OOM K8S, NodePort 30291

  • Headers
    • No user/password credentials necessary
    • Accept: application/json (optional)
    • Content-type: application/json (optional)

  • Successful Response (If component is Healthy): 200 OK (Json String)

  • Curl when testing MultiCloud broker HC within internal K8S network: 


MultiCloud VIO Healthcheck


  • Description: MultiCloud VMware Integrated OpenStack Plugin Healthcheck.

  • Method: GET

  • Externally Reachable: YES     

  • URL: http://{{multicloud_vio_ip}}:{{multicloud_vio_port}}/api/multicloud-vio/v0/swagger.json
    • multicloud_vio_ip → The externally reachable IP of MultiCloud VIO plugin
    • multicloud_vio_port → In Heat-based ONAP, port 9004. In OOM K8S, NodePort 30292

  • Headers
    • No user/password credentials necessary
    • Accept: application/json (optional)
    • Content-type: application/json (optional)

  • Successful Response (If component is Healthy): 200 OK (Json String)

  • Curl when testing MultiCloud broker HC within internal K8S network: 



MultiCloud WindRiver Healthcheck


  • Description: MultiCloud WindRiver Plugin Healthcheck.

  • Method: GET

  • Externally Reachable: YES     

  • URL: http://{{multicloud_windriver_ip}}:{{multicloud_windriver_port}}/api/multicloud-titaniumcloud/v1/swagger.json
    • multicloud_windriver_ip → The externally reachable IP of MultiCloud Wind River plugin
    • multicloud_windriver_port → In Heat-based ONAP, port 9005. In OOM K8S, NodePort 30294

  • Headers
    • No user/password credentials necessary
    • Accept: application/json (optional)
    • Content-type: application/json (optional)

  • Successful Response (If component is Healthy): 200 OK (Json String)

  • Curl when testing MultiCloud Wind River Plugin HC within internal K8S network: 



MultiCloud StarlingX Healthcheck


  • Description: MultiCloud StarlingX Plugin Healthcheck.

  • Method: GET

  • Externally Reachable: YES     

  • URL: http://{{multicloud_starlingx_ip}}:{{multicloud_starlingx_port}}/api/multicloud-starlingx/v0/swagger.json
    • multicloud_starlingx_ip → The externally reachable IP of MultiCloud StarlingX plugin
    • multicloud_starlingx_port → In Heat-based ONAP, port 9005. In OOM K8S, NodePort 30485

  • Headers
    • No user/password credentials necessary
    • Accept: application/json (optional)
    • Content-type: application/json (optional)

  • Successful Response (If component is Healthy): 200 OK (Json String)

  • Curl when testing MultiCloud StarlingX HC within internal K8S network: 


MultiCloud Pike Healthcheck


  • Description: MultiCloud Pike Plugin Healthcheck.

  • Method: GET

  • Externally Reachable: YES     

  • URL: http://{{multicloud_pike_ip}}:{{multicloud_pike_port}}/api/multicloud-pike/v0/swagger.json
    • multicloud_pike_ip → The externally reachable IP of MultiCloud Pike plugin
    • multicloud_pike_port → In Heat-based ONAP, port 9007. In OOM K8S, NodePort 30296

  • Headers
    • No user/password credentials necessary
    • Accept: application/json (optional)
    • Content-type: application/json (optional)

  • Successful Response (If component is Healthy): 200 OK (Json String)

  • Curl when testing MultiCloud Pike HC within internal K8S network: 


MultiCloud Ocata Healthcheck




  • Description: MultiCloud Ocata Plugin Healthcheck.

  • Method: GET

  • Externally Reachable: YES     

  • URL: http://{{multicloud_ocata_ip}}:{{multicloud_ocata_port}}/api/multicloud-ocata/v0/swagger.json
    • multicloud_ocata_ip → The externally reachable IP of MultiCloud Ocata plugin
    • multicloud_ocata_port → In Heat-based ONAP, port 9006. In OOM K8S, NodePort 30293

  • Headers
    • No user/password credentials necessary
    • Accept: application/json (optional)
    • Content-type: application/json (optional)

  • Successful Response (If component is Healthy): 200 OK (Json String)

  • Curl when testing MultiCloud Ocata HC within internal K8S network: 


MultiCloud Lenovo Healthcheck


  • Description: MultiCloud Lenovo Plugin Healthcheck.

  • Method: GET

  • Externally Reachable: YES     

  • URL: http://{{multicloud_lenovo_ip}}:{{multicloud_lenovo_port}}/api/multicloud-thinkcloud/v0/swagger.json
    • multicloud_lenovo_ip → The externally reachable IP of MultiCloud Lenovo plugin
    • multicloud_lenovo_port → In Heat-based ONAP, port 9010. In OOM K8S, NodePort 30486

  • Headers
    • No user/password credentials necessary
    • Accept: application/json (optional)
    • Content-type: application/json (optional)

  • Successful Response (If component is Healthy): 200 OK (Json String)

  • Curl when testing MultiCloud Lenovo Plugin HC within internal K8S network: 


MultiCloud FCAPS Healthcheck


  • Description: MultiCloud Fcaps Plugin Healthcheck.

  • Method: GET

  • Externally Reachable: YES     

  • URL: http://{{multicloud_fcaps_ip}}:{{multicloud_fcaps_port}}/api/multicloud-fcaps/healthcheck
    • multicloud_fcaps_ip → The externally reachable IP of MultiCloud fcaps plugin
    • multicloud_fcaps_port → In Heat-based ONAP, port 9011. In OOM K8S, NodePort 30487

  • Headers
    • No user/password credentials necessary
    • Accept: application/json (optional)
    • Content-type: application/json (optional)

  • Successful Response (If component is Healthy): 200 OK (Json String)

  • Curl when testing MultiCloud fcaps Plugin HC within internal K8S network: