System Requirements

The Keyfactor Universal OrchestratorClosed The Keyfactor Universal Orchestrator, one of Keyfactor's suite of orchestrators, is used to interact with servers and devices for certificate management, run SSL discovery and management tasks, and manage synchronization of certificate authorities in remote forests. With the addition of custom extensions, it can provide certificate management capabilities on a variety of platforms and devices (e.g. Amazon Web Services (AWS) resources, Citrix\NetScaler devices, F5 devices, IIS stores, JKS keystores, PEM stores, and PKCS#12 stores) and execute tasks outside the standard list of certificate management functions. It runs on either Windows or Linux servers or Linux containers. is supported on the following operating systems:

  • Windows Server 2019 or Windows Server 2022
  • Oracle Linux 7 or higher
  • Red Hat Enterprise 7 or higher
  • Ubuntu 16 or higher
Note:  Older versions of the Universal OrchestratorClosed Keyfactor orchestrators perform a variety of functions, including managing certificate stores and SSH key stores. will work with newer versions of Keyfactor Command, but not the other way around (see the Compatibility Matrix). The current version of the Universal Orchestrator requires Keyfactor Command version 10.0 or greater.

The Universal Orchestrator has the following requirements on Windows.

The Universal Orchestrator has the following requirements on Linux.

  • 2GB RAM, 2GHz CPU, 20GB disk space

    For optimal performance when using SSL scanning, the server should have at least 16 logical processors.

  • The following applications are required in order to install the Universal Orchestrator on Linux servers.

    The orchestrator requires the Microsoft .NET Runtime version 6.0 (x64). Information about this is available from Microsoft:

    https://docs.microsoft.com/en-us/dotnet/core/install/linux

    You need only the .NET Runtime (x64), not the ASP.NET Core Runtime, but it won't hurt anything to install both the .NET and ASP.NET Core runtimes as suggested in the Microsoft documentation for installing .NET on Linux.

    For the most part, it can be installed via the OS package manager. The method to complete this varies depending on the Linux operating system. For example, for Ubuntu 20.04, the following commands will install the correct version of .NET:

    wget https://packages.microsoft.com/config/ubuntu/20.04/packages-microsoft-prod.deb
    sudo dpkg -i packages-microsoft-prod.deb
    sudo apt-get update
    sudo apt-get install apt-transport-https
    sudo apt-get install dotnet-runtime-6.0

    You can use the following command to check the .NET version installed on a server (if any):

    dotnet --list-runtimes

    Output from this command will look something like this if you have the correct 6.0 version of the .NET Runtime installed:

    Microsoft.NETCore.App 6.0.6 [/usr/share/dotnet/shared/Microsoft.NETCore.App]

    The orchestrator can only be installed on a Linux server that has jq installed. You can use the following command to check the jq version of a server:

    jq --version

    The orchestrator requires a Linux server that uses the systemd service manager. You can use the following command to test whether a system is running systemd:

    ps -p 1

    The orchestrator can only be installed on a Linux server that is running bash version 4.3 or higher. You can use the following command to check the bash version of a server:

    bash --version

    The orchestrator can only be installed on a Linux server that has curl installed. You can use the following command to check the curl version of a server:

    curl --version

The Universal Orchestrator has the following requirements for Linux containers.

  • 2GB RAM, 2GHz CPU, 20GB disk space

    For optimal performance when using SSL scanning, the server should have at least 16 logical processors.

  • The orchestrator needs a containerization solution in which to run. Keyfactor has tested with Docker and Kubernetes.

Tip:  If you have an existing installation of the Universal Orchestrator using the older Microsoft .NET Runtime version 3.1, you do not need to reinstall the orchestrator to upgrade the .NET version.

To update your existing Universal Orchestrator to the latest .NET version:

  1. On the Universal Orchestrator machine, browse to locate the Orchestrator.runtimeconfig.json file in your installation directory. By default, this is:

    Windows: C:\Program Files\Keyfactor\Keyfactor Orchestrator\Orchestrator.runtimeconfig.json
    Linux: /opt/keyfactor/orchestrator/Orchestrator.runtimeconfig.json

  2. Using a text editor, open the Orchestrator.runtimeconfig.json file for editing and add the following property to the runtimeOptions section:

    "rollForward": "LatestMajor"

    Being sure to add a comma at the end of the previous row, resulting in a final file that looks something like:

    Copy
    {
       "runtimeOptions": {
          "tfm": "netcoreapp3.1",
          "framework": {
             "name": "Microsoft.NETCore.App",
             "version": "3.1.0"
          },
          "rollForward": "LatestMajor"
       }
    }
  3. Save the Orchestrator.runtimeconfig.json file.
  4. Uninstall the Microsoft .NET Runtime version 3.1 (x64) and install the 6.0 version.
  5. Restart the Universal Orchestrator service (see Start the Universal Orchestrator Service).