The WebAgentServices appsettings.json configuration file allows you to change default orchestrator
Keyfactor orchestrators perform a variety of functions, including managing certificate stores and SSH key stores. API 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. installation configuration settings.
Windows Installations Under IIS
To update the appsettings.json file:
-
Navigate to the WebAgentServices\Configuration folder on your server, located by default at:
C:\Program Files\Keyfactor\Keyfactor Platform\WebAgentServices\Configuration - Browse to open the appsettings.json file in a text editor (e.g. Notepad) and adjust the values as needed.
- Save the files.
Figure 456: Sample WebAgentServices Appsettings.json 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:
-
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 MaxRequestSizeKb value set to 3000.
additionalEnvironmentVariables: - name: MaxRequestSizeKb value: '3000' 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.crtNote: 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. -
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:
-
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{
"ActiveDirectoryEnforced": true,
"ClientCertificateAuthentication": {
"Enabled": false,
"CheckAuthCertificateRevocationStatus": true,
"DaysBeforeExpirationError": 30,
"DaysBeforeExpirationWarning": 180,
"AlwaysUseHeaderCertificate": false,
"AuthenticationHeaderName": null
},
"ExtensionsDirectory": "Extensions",
"MaxRequestSizeKb": "3000",
"NLogConfigFile": "Configuration\\NLog_Orchestrators.config",
"SqlRetryConfiguration": {
"NumberOfTries": "5",
"DeltaTime": "00:00:00.5",
"MaxTimeInterval": "00:02:00"
}
} -
On your Kubernetes server, create a config map containing the appsettings.json file. For example:
sudo kubectl create configmap appsettings-agentapi --namespace keyfactor-command --from-file=/opt/kyf_command/appsettings.json -
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-agentapi-volume configMap: name: appsettings-agentapi volumeMounts: - name: root-cas mountPath: /etc/ssl/certs/ca-certificates.crt subPath: ca-certificates.crt - name: appsettings-agentapi-volume mountPath: /app/Configuration/appsettings.json subPath: appsettings.json -
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 OrchestratorAPI application available in the appsettings.json file.
Table 89: Appsetting.json File Parameters - WebAgentServices
| Setting | Description |
|---|---|
| Active Directory Enforced | A Boolean that indicates whether Active Directory authentication is in use for the Keyfactor Command server. This should be set to false if you are not using Active Directory. An IIS reset will be required to apply this setting if you change it. |
| Client Certificate Authentication |
Configuration settings for client certificate authentication. These values are not used for container installations under Kubernetes. |
| Extensions Directory |
Enter the file path to the extensions to be loaded by the extension loader (for registration handler, workflow step, etc... support). For Windows installations under IIS, this is a subdirectory of the WebAgentServices directory. The default value is Extensions. This translates to, for example, for Windows installations under IIS: C:\Program Files\Keyfactor\Keyfactor Platform\WebAgentServices\Extensions
Container installations under Kubernetes: /app/Configuration/Extensions
|
| Max Request Size Kb | This application setting is only used for the CA synchronizations managed with a Keyfactor Universal Orchestrator. It is used to configure the CA synchronization batch size. The default is 5000. |
| NLog Config File |
Enter the file path to the NLog_Orchestrators.config file as a subdirectory of the WebAgentServices directory. The default is: Configuration\\NLog_Orchestrators.config
This translates to, for example: C:\Program Files\Keyfactor\Keyfactor Platform\WebAgentServices\Configuration\NLog_Orchestrators.config
This value is not used for container installations under Kubernetes. |
| Sql Retry Configuration | SQL retry settings (seeKeyfactor Command Changing SQL Retry Settings for more information). |