Installing Jenkins

Prerequisites

Jenkins server prerequisites

For Jenkins to execute the Sage X3 Automated Test Platform pipeline (ATP-RunAutomatedTests) your system must meet the minimum configuration requirements described below.

Category Minimum configuration recommendations
Operating system Windows Server 2016 64-bit
Disk SSD (Solid State Drive)
Memory 16 GB RAM
Processor Intel® Xeon® Processor E5-2686 v4 2.30 GHz
Note - warningSage does not recommend installing the Jenkins application on the same server as Sage X3 or Sage X3 Warehousing applications to ensure the best performance of each application.
Moreover, these applications can require using different versions of Java runtime that are not compliant with each other.

Required software

For the Sage X3 Automated Test Platform library to run your system must include the following software:

  • Azul Zulu or Oracle Java
  • Download and install Java Runtime Environments (JRE):

    • Refer to the prerequisites_atp documentation for more information about the Java Runtime Environment (JRE) compatibility

    Note - informationJava 8 or 11 Runtime Environments (JRE) are supported from Jenkins version 2.164 to versions prior to 2.479.1.
    Note - informationMinimum version 17 of Java Runtime Environment (JRE) is requested for Jenkins version 2.479.1 or later.
  • Node.js

    From Sage X3 Automated Test Platform version 3.2.2 Nodejs doesn't need to be downloaded anymore and installed as a central program on your Jenkins server.

    • Nodejs binary is delivered with Sage X3 Automated Test Platform Library.

    • To know which version of Nodejs is delivered with Sage X3 Automated Test platform, refer to the prerequisites_atp documentation

  • Git

    Download and install the Git version that is compliant with your operating system from: https://git-scm.com/downloads.

Additional requirements

An internet connection is required to be able to download and install third-party components.

Jenkins server installation

Configuring a Jenkins administrator user

Jenkins services must be executed by a Jenkins administrator user. It is recommended to create an administrator user as JenkinsUser, and assign to this user the necessary credentials to run the Jenkins service.

Note - settingsTo complete the following steps you must be connected to the Windows Server with a Windows administrator account.


Follow the steps below to create an administrator user for Jenkins:

Note - tipThere are various ways of creating a Jenkins administrator user, that is, as a local user or attached to a domain. The following steps explain how to create a local administrator user for Jenkins.
  1. Locate the Computer Management app.
  2. Select Local Users and Groups.
  3. Select the Users folder.
  4. Right-click and select New User.
  5. Enter the New User details. Click Create, then Close.
  6. To assign the Jenkins administrator user to the Administrator group:
    1. Right-click the JenkinsService administrator user you have just created.
    2. Click Properties.
    3. Select the Member Of tab, then click Add.
    4. Enter the object names to select: Type Administrators.
    5. Click OK, then Apply.
Note - successClick OK to complete the user group assignment.

  1. To enable the JenkinsService administrator user to log on as a service:
    1. Open the Local Security Policy app.
    2. Expand the Local Policies folder and select the User Rights Assignment folder. Right-click Log on as a service.
    3. Click Properties.
    4. Click Add User or Group.

    5. Complete the following fields, then click OK:

      From this location: Type in the location of the Jenkins server.

      Enter the object names to select: Type in the JenkinsService administrator user.

    6. Click OK, then Apply.
Note - success Click OK. Your Jenkins administrator user is configured.

Installing Jenkins

Note - tip You can download Jenkins directly from jenkins.io: https://www.jenkins.io/.
  1. Open the jenkins.io website: https://www.jenkins.io/.
  2. Click Download.
  3. Choose a Jenkins LTS (Long-Term Support) version to download.
  4. Select the Windows installer.
  5. Note - information A jenkins.msi package is downloaded.
  6. Check that you are connected as an administrator user.
  7. Then follow the instructions given on jenkins.io: https://www.jenkins.io/doc/book/installing/windows/.

    Note - settingsWhen the Service Logon credentials wizard is displayed, select Run service as LocalSystem. Sometimes when you install Jenkins with a domain user, the installation can fail. It is recommended to run the service as a local system instead during the installation and to change it afterward.

Once the wizard indicates that the Jenkins installation is completed, a web page to start the Jenkins service is displayed. When the service is ready it will ask you to type in a Jenkins initial password. Do not type in a password.

Note - warningClose the page to change the Jenkins service user.
Note - dangerDo not type in a Jenkins password at this stage of the installation.

Setting up a Jenkins service user

  1. Open a Services app.

  2. Locate the Jenkins service. Right-click, then click Stop.

  3. Right-click, then click Properties.
  4. Select the Log On tab. Complete the following fields:

    This account: Type in .\[Jenkins administrator user], where [Jenkins administrator user] is the Jenkins administrator user you created previously.

    For more information about creating a Jenkins administrator user, see Configuring a Jenkins administrator user.

    Password / Confirm password

  5. Click Apply, then click OK.
  6. From the Jenkins Services window, right-click, then click Start.

Note - success The Jenkins service is running.

Finalizing the Jenkins installation

  1. Open a browser and navigate to the local host URL (for example: http://localhost:8080).
  2. Follow the displayed instructions, inserting the Jenkins Administrator password where requested.

  3. Click Continue.
  4. Click Install suggested plugin and wait for the suggested plugin to be installed.
  5. Create your first administrator user, then click Save and continue.
  6. Note - warningAvoid using the "@" character in the password otherwise the pipeline creation/update might fail.

  7. If your server can be identified via a Domain Name System (DNS), type in the URL that you will use to connect to Jenkins.

  8. Click Save and finish.
Note - successYour Jenkins server installation is now complete.

To start Jenkins, click Start using Jenkins.