Keyfactor Command Service appsetting.json File

The Service appsettings.json file allows you to view or change the Keyfactor Command Service installation and configuration settings.

Windows Installations Under IIS

To update the appsettings.json file for service configuration:

1. Navigate to the Service\Configuration folder on your server, located by default at:

   C:\Program Files\Keyfactor\Keyfactor Platform\Service\Configuration

2. Browse to open the appsettings.json file in a text editor (e.g. Notepad) and adjust the values as needed as per Table 93: Keyfactor Command Services Configuration Settings and Keyfactor Command Service Automated Tasks.

   

   Figure 460: Appsettings.json File for TimerService Settings

3. Save the file.

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 config map 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 name(s) and value(s) for the setting(s) to change. For example, the following shows a portion of the example values file (see Install Keyfactor Command in Containers Under Kubernetes) with the ConcurrentWorkflows value set to 1200 and the PurgeAuditHistory service job set to false.

   additionalEnvironmentVariables:
     - name: ConcurrentWorkflows
       value: '1200'
     - name: Jobs_PurgeAuditHistory
       value: false
   
   volumes:
     - name: root-cas
       configMap:
         name: ca-roots
         items:
           - key: ca-certificates.crt
             path: ca-certificates.crt
   volumeMounts:
     - name: root-cas
       mountPath: /etc/ssl/certs/ca-certificates.crt
       subPath: ca-certificates.crt

   Note:   Notice that the PurgeAuditHistory parameter A parameter or argument is a value that is passed into a function in an application. is referenced by its full name, including its parent parameter name—Jobs_PurgeAuditHistory. Likewise, 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 1.0.0

To provide the appsettings.json file as a config map:

1. On your Kubernetes server, create an appsettings.json file with the full contents of the file, including the updates you wish to make. For example:

   Copy

   {
     "NLogConfigFile": "NLog_TimerService.config",
     "ExtensionsDirectory": "Extensions",
     "ActiveDirectoryEnforced": true,
     "ConcurrentWorkflows": 1000,
     "MetadataGeneration": {
       "Version": 1,
       "Parallelism": 8,
       "ProgressInterval": "00:07:00"
     },
     "SqlRetryConfiguration": {
       "NumberOfTries": "5",
       "DeltaTime": "00:00:00.5",
       "MaxTimeInterval": "00:02:00"
     },
     "Jobs": {
       "BulkAuditProcessing": true,
       "MetadataGeneration": true,
       "PrivateKeyCleanup": true,
       "PurgeAuditHistory": true,
       "EndpointHistory": true,
       "ReportingCleanup": true,
       "ScheduleSslJobs": true,
       "SuspendedWorkflows": true,
       "SyncTemplates": true,
       "StatsUpdate": true,
       "WorkflowCleanup": true,
       "CAHealth": true,
       "CAThreshold": true,
       "CRL": true,
       "ExpirationAlerts": true,
       "IssuedAlerts": true,
       "PendingAlerts": true,
       "QueryItems": true,
       "Reporting": true,
       "SSHKeyRotationAlerts": true,
       "AgentNotificationAlert": true,
       "CASync": true,
       "CollectionQueryAlerts": true,
       "UndecryptableSecretsSearch": true,
       "CertificateStoreWorkflows": true,
       "KeyRotationWorkflows": true,
       "ExpirationWorkflows": true,
       "RevocationMonitoringWorkflows": true
     }
   }

2. On your Kubernetes server, create a config map containing the appsettings.json file. For example:

   sudo kubectl create configmap appsettings-service --namespace keyfactor-command --from-file=/opt/kyf_command/appsettings.json

3. Edit your values file to add a volume and volumeMount for the config map of the appsettings.json file. For example, the following values file section shows the example root trusts volume (see Install Keyfactor Command in Containers Under Kubernetes) and the appsettings volume.

   volumes:
     - name: root-cas
       configMap:
         name: ca-roots
         items:
           - key: ca-certificates.crt
             path: ca-certificates.crt
     - name: appsettings-service-volume
       configMap:
         name: appsettings-service
   volumeMounts:
     - name: root-cas
       mountPath: /etc/ssl/certs/ca-certificates.crt
       subPath: ca-certificates.crt
     - name: appsettings-service-volume
       mountPath: /app/Configuration/appsettings.json
       subPath: appsettings.json

4. 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 1.0.0

Configuration Settings

The following table shows the configuration settings for the Keyfactor Command Service available in the appsettings.json file.