Changing SQL Retry Settings

The SQL retry settings are found in the app settings configuration files for the Service, WebConsole, WebAgentServices, KeyfactorAPI An API is a set of functions to allow creation of applications. Keyfactor offers the Keyfactor API, which allows third-party software to integrate with the advanced certificate enrollment and management features of Keyfactor Command., and CAConnectorAPI applications and allow you to view or modify the configuration settings related to the connection to the SQL database. Any changes must be made to match for all applications.

Windows Installations Under IIS

The settings for SQL retries are configured in the appsettings.json file in each of the Keyfactor Command program folders Service, WebConsole, WebAgentServices, KeyfactorAPI, and CAConnectorAPI, located by default at:

To update the appsettings.json file for SQL configuration:

1. Navigate to the \Configuration folder on your server for each of the Keyfactor Command program folders.
2. Browse to open the appsettings.json file in a text editor (for example, Notepad) and adjust the values as needed.
3. Save the files.

{
  "SqlRetryConfiguration": {
    "NumberOfTries": "5",
    "DeltaTime": "00:00:00.5",
    "MaxTimeInterval": "00:02:00"
  }
}

Container Installations Under Kubernetes

The configurations from the appsettings.json file can be updated in one of two ways for container installations:

• To update one or two settings, set an environment variable in your custom values file.

• To update a large number of settings or the entire contents of the appsettings.json file, create a ConfigMap containing the appsettings.json file contents and mount it as a volume to replace the existing appsettings.json file.

To set an environment variable for one or two configuration values:

1. On your Kubernetes server, edit your values file to add an additionalEnvironmentVariables section (if one does not already exist) and environment variable names and values for the settings to change. For example, the following shows a portion of the example values file (see Install Keyfactor Command in Containers Under Kubernetes) with the SqlRetryConfiguration_NumberOfTries value set to 6 and the SqlRetryConfiguration_MaxTimeInterval value set to 00:02:30.

   additionalEnvironmentVariables:
     - name: SqlRetryConfiguration_NumberOfTries
       value: '6'
     - name: SqlRetryConfiguration_MaxTimeInterval
       value: '00:02:30'
   
   workloadDefaults:
     volumes:
       - name: root-cas
         configMap:
           name: ca-roots
           items:
             - key: ca-certificates.crt
               path: ca-certificates.crt
   
     volumeMounts:
       - name: root-cas
         mountPath: /etc/pki/tls/certs/ca-bundle.crt   # Common CA bundle path for Command containers
         subPath: ca-certificates.crt    # Source path for your CA bundle may vary

   Note:   Parameters are referenced by full name, including parent parameter A parameter or argument is a value that is passed into a function in an application. name, if applicable. A SQL retry configuration setting would be, for example, SqlRetryConfiguration_NumberOfTries.

2. Load the new values, referencing the deployment name, Namespace, your customized values file, the Helm chart, and version. For example:

   sudo helm upgrade Helm_Deployment_Name --namespace keyfactor-command --values values-local.yaml oci://repo.keyfactor.com/charts/command --version 26.2.1

Configuration Settings

The following table shows the configuration settings for SQL retry available in the Keyfactor Command Service, WebConsole, WebAgentServices, KeyfactorAPI, and CAConnectorAPI appsettings.json files.

Table 78: Appsetting.json file - SQL Retry Parameters