Configure a Jenkins adapter

Configure the Jenkins adapter to notify TeamForge Orchestrate when builds complete.

Before you start configuration, make sure that you have installed the Jenkins plug-in using the web or console interface. The TeamForge Orchestrate Jenkins adapter has a system configuration as well as job level configurations. The system configuration sets defaults to be used by subsequently configured job level configurations.
Important: When a job configuration is copied in Jenkins, the source association key is not carried over. You must add a corresponding build source in TeamForge Orchestrate, and enter the source association key while configuring the new job.

Configuring an individual Jenkins job

  1. As a privileged Orchestrate user, edit (or add) the relevant Build source you wish to associate with this Jenkins job.

    Manage Sources > Toggle Build > Edit the Source

  2. On the Edit Source screen, locate the section titled "Adapter Configuration Information" and copy all values; these values are used later in the configuration process.
  3. As a privileged Jenkins user, locate the job that must report build data to TeamForge Orchestrate and navigate to its configuration page.
  4. Add a post-build action to Notify TeamForge Orchestrate when a build completes.
  5. Populate the Server URL field. Copy and paste the Queue Server value from the Edit Source screen in TeamForge Orchestrate. Please ensure to include the "ampq" protocol and the port information.
  6. Populate the Server Username and Server Password fields. Copy and paste the queue username and password value from the Edit Source screen in TeamForge Orchestrate.
  7. Populate the Build source association key field. Copy and paste the source association key value from the Edit Source screen in TeamForge Orchestrate. For more on association keys, see Source association keys.
  8. Save the job configuration.
  9. Run a build to test the new configuration and verify configuration. Information and errors will be reported to your Jenkins log and to the build console.

Configuring global default Jenkins settings

  1. Obtain build adapter configuration from any existing build source.

    Manage Sources > Toggle Build > Edit the Source

  2. On the Edit Source screen, locate the section titled "Adapter Configuration Information" and copy all values; these values are used later in the configuration process.
  3. As a privileged Jenkins user, navigate to Manage Jenkins > Configure System screen on the target Jenkins server.
  4. On the Jenkins configuration page, find the TeamForge Orchestrate section.
    1. Populate the Server URL field. Copy and paste the Queue Server value from the Edit Source screen in TeamForge Orchestrate. Please ensure to include the "ampq" protocol and the port information.
    2. Populate the Server Username and Server Password fields. Copy and paste the queue username and password value from the Edit Source screen in TeamForge Orchestrate.
  5. Save the system configuration.