Linux - Native Job Engine Setup

    Linux - Native Job Engine Setup


    Article summary

    The Native job engine is utilised for connecting to local resources within an organisation’s infrastructure. This can be used from a Cloud or On-Premise Quality Modeller deployment.

    This article covers installing the job engine to a Linux environment / native environment.

    1. Prerequisites

    • Install .NET 6 - Below are commands for Ubuntu Linux. We recommend following the official Microsoft guide for other distributions.
    sudo apt-get update
    
    sudo apt-get install -y dotnet-sdk-6.0

     Verify dotnet has installed correctly, and available on the system path.

    verify – dotnet -version
    • Download the Job server (request download link from Curiosity)

    (Optional) If running automation

    • Chrome web browser
    • Install JDK - 1.8
    sudo apt-get install openjdk-8-jdk

    Verify Java is installed and available on the path.

    java -version

     We also recommend setting the JAVA_HOME environment variable.

    sudo update-alternatives --config java
    
    export JAVA_HOME=/path/to/java/home
    • Install Maven
    sudo apt-get update
    
    sudo apt-get install maven

    Verify maven is installed and available on the path.

    mvn -version

     2. Installation 

    Firstly, let’s install the job engine and configure connectivity to your Quality Modeller instance.

    1 – Download the package and unzip it to your chosen location.

    unzip modellerjobengine.zip

    2 – Edit KafkaJobEngine.Net5.dll.config. This is an xml file which defines the configuration settings for the JobEngine service.

    You will need to change the following values for your instance of modeller;

    • APIEndpoint – The URL of the API endpoint
    • TDMAPIEndpoint – The URL of the TDM API endpoint. Typically, this is the same as the APIEndpoint.
    • MetaAPIEndpoint – The URL of the Meta API Endpoint. Typically, this is the same as the APIEndpoint.
    • APIKey – The API Key to use for authentication against the selected workspace.
    • KafkaEndpoint – The kafka URL.
    • MavenLocation – Maven location
    • DotNetLocation – Dotnet location
    • MachineKey – A unique machine key for the workspace.

    3 – Once configured head to the root folder and run the instance

    dotnet KafkaJobEngine.Net5.dll

    4 - On initial execution if all has been successful a command window will be displayed which shows the KafkaJobEngine running. If there are any errors, they will be displayed in the console window. Below shows a successful series of messages.

    3. Verify Connectivity

    Next, we will verify the job engine has connectivity to the modeller instance. Navigate to Profile, and then select Automation Servers from the menu.

    The job engine should be displayed under the Workspace Servers page.

    4. Install as a Service

    The job engine is now up and running whenever you run the executable. Next, we will install the job engine as a service. This will mean that you do not need to run the executable directly,

    Head to the Linux folder, in the ServiceScripts package. Here you will need to edit the modeller_job_engine.service to match the installation location of the relevant packages. Once configured you can run the shell scripts to install, start, stop, and review the status of the service.