Introduction

• Device Manager has a support for health check feature.
• It empowers the testers and other users to do health check on the devices before executing any test cases.
• User can easily get the list of devices which are in good state and bring up the devices which are in bad state.
• It reduces the tester time for verifying and getting the devices which are in good state.

Automatic Components

• Device Manager UI - Provides UI interface to config device details and schedule health check
• Device Manager - Manages scheduled details request and trigger executions.
• Automatic Properties - Provides UI Interface to configure device related configurations.

Partner Components

• Health Check Partner Implementation - Manages Health check validation for the selected devices based on the defined health check steps and update the results to the Device manager.

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

Design for Device Health Check Feature in Device manager

Health Check Partner Implementation

Partner can provide there own defined health check implementation project which supports health check executions and update the executions results to device manager . List of need to be implemented as a part of health check executions. Please refer the Device manager API documentation for more details 

Upgrade Device Manager to support Health Check execution

For a partner to upgrade Device Manager to support heath executions need to be done as mentioned below.

Device Manager

For a partner to upgrade the health check support in Device Manager Please follow below steps.

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 Automatics Orchestration 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 Device Manager Deployment. 
4. Verify whether the deployment is done and updated to 1.0.2 version.

Device Manager UI

For a partner to upgrade the health check support in Device Manager UI Please follow below steps.

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 Device Manager UI Deployment. 
3. Verify whether the deployment is done and updated to 1.13 version.

Setup Jenkins Job For Health Check

For a partner to setup health check job in jenkins Please refer Health Check Job Configuration for details steps.

Steps to schedule health check

• Navigate to Configuration Tab in Device Manager UI provide the valid jenkins url , username and password details where health check job is configured.
• Schedule the health check for the list of devices Please refer Schedule Health Check for more details on how to schedule executions for health check.
• On successful scheduling success pop will be seen and dashboard will be updated.