Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • Device Manager UI 
    • Provides UI interface to config health check parameters and schedule health check for list of devices.
    • Health Check execution status can be seen on the dashboard.
    • UI Support to update or delete the devices to the already scheduled executions is provided.
    • User is provided with option to cancel the execution in scheduled state.
  • Device Manager Manager
    • Manages scheduled details request and update it to DB if the provided request details are valid.
    • List of devices added for each scheduled are restricting to 20 considering the jenkins cannot hold more logs and JVM memory assigned for each jenkins job
    • Handles jenkins requests that need to be triggered on the scheduled execution date and time.
    • Provides the APIs implementation which are required for updating the execution details after each execution from in the health check partner implementation.
  • Health Check Partner Implementation

...

Basic Health Check implementation project is open sourced which provide the support to check device state in good or bad based on SSH connection validation. If SSH connection got failed then device status is updated to bad otherwise set to good on successful connection. Support is provided to read the device connection credentials from the server-config.xml file  file and device manager

Basic Health partner implementation repo url : https://code.rdkcentral.com/r/c/rdk/tools/device-manager-healthCheck-partnerImpl

Partner can provide there own custom health check implementation  which supports health check executions and update the executions results to device manager . List of APIS that need to be invoked as a part of health check implementation so once the executions are done on the jenkins job results can be updated to the device manager. Please refer the Device manager API documentation _Manager_API_Specification_v1.0.docx for more details .

Following diagram shows interaction of Automatics components and Partner Device Manager components in a deployed environment

draw.io Diagram
bordertrue
diagramNameHigh level Helath check design
simpleViewerfalse
width
linksauto
tbstyletop
lboxtrue
diagramWidth904
revision24

Design for Device Health Check Feature in Device manager

...

  1. Upgrade Device Manager to v1.0.2 or above since it contains the latest code changes for Health Check execution. Pull the latest code of Device Manager.
  2. Run the SQL scripts from Device_Manager_DB.sql file present in the Device Manager starting from line number 335. These scripts will help in creating all the new tables that are required for health check execution.
  3. Once after the above changes generate a WAR file of Device Manager  and deploy it in the tomcat server. Deployment can also be done using For Deployment Please refer Device Manager Deployment for detailed steps. 
  4. Verify whether the deployment is done and updated to 1.0.2 version.

...

  1. Upgrade Device Manager UI to v1.13 or above since it contains the latest code changes for Health Check execution. Pull the latest code of Device Manager UI.
  2. Once after the above changes generate a WAR file of Device Manager  and deploy it in the tomcat server. Deployment can also be done using For Deployment Please refer Device Manager UI Deployment for more details. 
  3. Verify whether the deployment is done and updated to 1.13 version.

...