Installing Health Check Tool

Use Health Check Tool (HCT) to verify your environment meets the configuration and tuning recommendations. By running this tool at different stages of your deployment, you can identify and fix issues.

Follow the instructions in this guide to install, use, and troubleshoot the HCT:

Before you begin

Before you install the Health Check Tool, ensure that your system meets the following requirement:

• Make sure that Java 11 is installed on your system.

To install the HCT

To install the Health Check Tool, complete the following steps:

1. Download the HelixHealthCheck-V25.2.00.zip file from BMC Helix EPD.

2. Extract the file to a temporary directory (for example, /tmp/hct) on the controller node where you will deploy Helix.

3. Update the sample-env-setting.sh file to include the appropriate environment variables. Make sure the values point to the correct locations on your system:

   JAVA_HOME – Specify the path to the installed Java runtime.
   To determine the correct path:

   1. Run which java to locate the Java binary.
   2. Run readlink -f $(which java) to get the full path.
   3. Copy the path up to (but not including) the /bin directory.

   The example value for this parameter is:
   If the Java path is /usr/lib/jvm/java-11-openjdk-amd64/bin/java, then set:

   export JAVA_HOME=/usr/lib/jvm/java-11-openjdk-amd64

   INSTALL_DIR – Specify the path to the directory where the Helix on-prem deployment manager files are extracted.
   The example value for this parameter is:

   export INSTALL_DIR=/root/helix-on-prem-deployment-manager 

   HCT_HOME – Specify the path to the HCT tool directory (only if executing from a location outside the extracted folder).
   The example value for this parameter is:

   export HCT_HOME=/tmp/hct

    

4. Run the following command:

   source sample-env-setting.sh 

Running the Health Check Tool

Run the Health Check Tool at different stages to validate your system and deployment.

Running pre-installation checks

Before you begin the Helix installation, perform a pre-installation check to verify your environment configuration:

cd $HCT_HOME 
./helix-healthcheck.sh preinstall 
# Or 
$HCT_HOME/helix-healthcheck.sh preinstall 

This check validates critical components, such as:

• kubectl or oc availability
• Required binaries and variables
• Hardware and storage setup
• Certificate configurations
• Load balancer and DNS connectivity
• SMTP server setup
• Node health and time synchronization

Important

If the installation fails and the deployment manager deletes the secrets.txt file, recreate the file by following the instructions in the ITOM documentation.Type your information message here.

Running install-time checks

If the installation process becomes unresponsive or fails, run an install-time check:

cd $HCT_HOME 
./helix-healthcheck.sh install 
# Or 
$HCT_HOME/helix-healthcheck.sh install

This check analyzes pod logs and verifies RSSO URL connectivity.

Running post-installation checks

After completing the installation, run a post-installation check to ensure the health of your system:

cd $HCT_HOME 
./helix-healthcheck.sh postinstall 
# Or 
$HCT_HOME/helix-healthcheck.sh postinstall

This check analyzes pod logs and validates the RSSO URL connectivity.

To uninstall HCT

To uninstall the Health Check Tool, delete the extracted directory:

rm -rf /tmp/hct

Support

If you need assistance, contact BMC Helix Customer Support and provide logs from the following directories:

• $HCT_HOME/logs
• $HCT_HOME/reports