Authors:

Eli Mesika

Oved Ourfali

Feature pages are design documents that developers have created while collaborating on oVirt.

Most of them are outdated, but provide historical design context.

They are not user documentation and should not be treated as such.

Documentation is available here.

Entity Health Status

Adding External Health Status to oVirt Entities

Summary

Provide a mechanism to set entity health status which will be displayed in the UI as follows

OK
Info
Warning
Error
Failure

The Health Status field will be returned as part of the retrieved entity when a call to display the entity is done using the REST API.

The main use-case for this new status is to provide plugins / external systems the ability to trigger issues, and allow the administrator to clearly see there is an issue through the UI

It will first be supported on hosts and storage domains.

Owner

Name: Eli Mesika
Email: emesika@redhat.com

Current status

Currently oVirt provides only an internal status of the host which is controlled internally by oVirt In order to see problems on an entity, the administrator should go and select each entity and then look in the relevant plug-in sub-tab for the entity. There is no visual marker for indicating problems on the entity that were reported by an external system

Use Case

An external system indicates a problem on an entity instance and wants to set its health status such that this status is displayed and visible immediately to the application administrator in the entity main view without any need to drill-down to each and every entity. The administrator will see in the main grid that there is an issue, and pressing on the specific entity he will either be able to look at the events sub-tab to understand what the issue is, or look at custom sub-tab provided by the plugin (if there is indeed a plugin in this specific use-case).

Detailed Description

The goal is to enable to add each entity a Health Status field which can be set and retrieved using the REST API The UI should include this field for each such entity main view and displayed it graphically with the appropriate color according to the reported status

This will be achieved by adding a Health Status field to each relevant entity which can be set by a command on the entity instance The command parameters should have parameters that enables oVirt to generate an implicit External Event for the status transition

For the first phase the supported entities will be : Host and Storage Domain vds_dynamic and storage_domain_dynamic tables will have an addition health column DB Facade objects, BEs and tests will be updated accordingly

on REST API those entities will retrieve the health as well , for example a GET on

<dir> /api/82d9f776-12cf-437a-b686-5958d09f9eb4 results with :

 <host id=................>
           ......
           ......
     <external_status>
       <state>ok</state>
   </external_status>
  </host>

Setting the status for a entity will be done via the External Events mechanism with an additional external_status element from the Status API type under the entity For example

 <event>
   <description>The heat of the host is above 30 Oc</description>
   <severity>warning</severity>
   <origin>HP Openview</origin>
   <custom_id>1</custom_id>
   <flood_rate>30</flood_rate>
  <host id="50bf66ec-38df-47f1-a737-95d46e8d35fc" >
  <external_status>
       <state>warning</state>
   </external_status>
  </host>
 </event>

Another example for storage domains and when the external status and the event severity is different

<event>
  <description>No space left on device</description>
  <severity>error</severity>
  <origin>XXX</origin>
  <custom_id>11</custom_id>
  <flood_rate>30</flood_rate>
  <storage_domain id="949c21d6-1e65-4f1a-9442-4def1ccaf11a">
   <external_status>
      <state>failure</state>
  </external_status>
  </storage_domain>
</event>

external_status field will be represented with a new seprate enum containing the values :

   OK
   INFO
   WARNING
   ERROR
   FAILURE

Search Engine

The new external_status field will be available as a search field for the entity main view

Benefit to oVirt

Enabeling to see problems that were reported by external systems in the entity main view at the point in time those problems occur