Deploy PSM Health Check

This topic describes how to install and configure PSM Health Check.

Typically, load balancers verify PSM server availability by examining network connectivity to the server alone. The PSM Health Check enables you to determine PSM service availability (health) by querying a dedicated PSM Web Service deployed on each PSM instance.

The PSM Web Service verifies PSM service health of the PSM instance upon request and sends a response to the load balancer.

Prerequisites

  • Web Server (IIS 8.5 or higher) role is installed
  • A valid SSL certificate is installed on the Web Server

Install PSM Health Check

Use a user with administrative privileges to perform this procedure.

To install the Health Check:

  1. From the PSM installation package, copy the HeathCheck folder to the PSM server.

  2. Install Microsoft .NET Core Windows Server Hosting by running dotnet-hosting-2.2.0-win.exe file, included in the HealthCheck folder.

  3. In a PowerShell window, navigate to the HealthCheck folder.

  4. To start the script, run the following command:

     
    ./HealthCheck.ps1

Configure the response mode

You can configure the response mode of the health check web service.

To configure the response mode:

  1. Open the following file:

    C:\Program Files (x86)\CyberArk\PSM\HealthCheck\appsettings.json

  2. Modify the ResponseMode as follows:

    Response Mode

    Description

    Classic

    The health check service responds with 200 (OK) whether the PSM service is healthy or not, but the response body includes PASS or FAIL indicating if the server is healthy.

    CodeBased

    The health check service responds with 200 (OK) when the PSM service is healthy, and 503(Service unavailable) when the service is not healthy.

    HeaderBased

    This mode behaves like the Classic mode, but adds a parameter in the response header called IsHealthy, with a value of either Yes or No.

  3. Restart the IIS service.

Troubleshooting