Starting and stopping the Jazz Build Engine

The Jazz™ Build Engine processes build requests, including those based on the IBM® i Command - Jazz Build Engine and IBM i Continuous Load - Jazz Build Engine build templates. Start the build engine from Qshell and stop the build engine by ending the job.

Procedure

  1. From Qshell, navigate to yourinstalldir/jazz/buildsystem/buildengine/eclipse, where yourinstalldir is the Build System Toolkit installation directory.
  2. Type the following command to start the build engine:
    jbe.sh -repository REPOSITORYURI -engineID ENGINENAME -userId USERID -pass PASSWORD -jobName JOBNAME
    For example:
    jbe.sh -repository https://example.com:9444/jazz -engineID MY_ENGINE -userId JOHNDOE -pass pas1wrd1 -jobName MYBLDENG

    The user provided for -userId must be the owner of the build repository workspace specified in whatever build definitions will be processed by this build engine.

    Look for the following text to indicate a successful startup:
    CRCQP3904I:Jazz build engine instance job is 161142/JAZZADM/MYBLDENG.
    CRCQP3906I:Jazz build engine instance process id is 5642.

    If the specified job name is already in use, or if the –jobName option is omitted, the system will generate a job name. Jobs are submitted to the QUSRWRK subsystem to be processed.

    Once you have confirmed that your build engine has successfully started, confirm that it is also able to successfully connect to the Jazz Team Server with the parameters provided. Use Rational® Developer for i or a terminal emulator to open the standard output log file jbeout found at yourinstalldir/jazz/buildsystem/buildengine/eclipse/RTCiLogs/JOBNAME. If there is a problem connecting to the server, an informational message detailing the problem will appear in this log within a few moments of startup. The engine will continuously loop, attempting to connect to the server with the parameters provided, until you end the job. This results in no build requests being processed, and could have harmful side effects such as disabling a profile if a bad password was provided and several unsuccessful logon attempts occur. Check this log any time build requests are not being processed, or any time a build engine shows a status of Warning in the client.

    Other available log files include standard error (jbeerr), the jobname (jobname.txt), process ID (jbepid.txt), and launch parameters (jbelaunch.txt). These can be found along with jbeout in ./RTCiLogs/JOBNAME. You can view the log files using a terminal emulator or Rational Developer for i.
    Note: These files should not be deleted while the build engine is active.

    Tip: If your Jazz Team Server has been configured to use IBM i user profile authentication, it is recommended that you use a dedicated builder user profile. Note that if the password for your user ID is entered incorrectly, your user profile might be disabled.
  3. To stop a build engine, simply end the job. For example, use:
    ENDJOB JOB(MYBLDENG) OPTION(*IMMED)
  4. Optional: To view all build engine usage options, type jbe.sh in Qshell. Notice the –createPasswordFile option, which creates a password file that can be used in lieu of the –pass option when you start the build engine.
  5. Optional: When you are getting started with a build or debugging problems, you might find it useful to run the build engine interactively rather than in a separate job. To start the build engine interactively, use the –interactive option of jbe.sh. For example:
    jbe.sh -repository REPOSITORYURI -engineID ENGINENAME -userId USERID -pass PASSWORD -interactive
    Log files will not be generated in this case. Look for the following text to indicate a successful startup:
    2008-07-01 17:13:13 [Jazz build engine] Running build loop... 2008-07-01 17:13:13 [Jazz build engine] Waiting for request...   
    If there are problems connecting to the Jazz Team Server, informational messages will be displayed in the Qshell window to help you identify the issue. If you run the build interactively, you must leave the Qshell window open for as long as you need the build engine to build. To stop the build engine, press F3 to exit Qshell.

    Remember the following considerations when running the build engine on IBM i:

    • User IDs, passwords, and build engine names are all case-sensitive.
    • When the build engine processes build requests, the builds are executed under the authority of the user profile that was used to start the engine. As a result, it is possible for users to request builds specifying commands they should not have the authority to execute. You can use the Request Build permission to control who is able to request builds. It is not recommended that you grant this permission to everyone.
    • Before running jbe.sh, consider using ls -l to make sure that jbe.sh has x (executable) permission. If it is -rw-rw-rw-, use chmod a+x jbe.sh to make it executable.

video icon Video

Jazz.net channel
Software Education channel

learn icon Courses

IoT Academy
Skills Gateway

ask icon Community

Jazz.net
Jazz.net forums
Jazz.net library

support icon Support

IBM Support Community
Deployment wiki