Integrating and Running Builds on an External Jenkins Server with Oracle Developer Cloud Service

For this tutorial, you need a Jenkins server configured with Git, Maven, and the Notification plugin. Follow the steps of this section to know how to do that. For more information and configuration options, see the Jenkins documentation.

1. Configure Git and Maven settings in the Manage Jenkins > Global Tool Configuration page of the Jenkins web user interface.

   

2. Install the Notification plugin, if you have not already. The plugin can be installed from the Manage Jenkins > Manage Plugins page.

   

3. Install the Build Authorization Token Root plugin, if you have not already. The plugin can be installed from the Manage Jenkins > Manage Plugins page.

   

In this section, you will create a Jenkins job, configure it to use the Oracle Developer Cloud Service Git repository, add Maven commands as the build step, and then add a post-build step to archive the artifacts.

1. Open the Jenkins Dashboard page and click create new jobs (or New Item) to create a job.

   

2. In the Job wizard, enter the following details:

   • Enter an item name: DevCS_JavaWebApp_Maven

   • Job type: Maven Project

   Click OK.

   

3. In the Description field of the General tab of the Configuration page, enter a description of the job.

   

4. Click the Source Code Management tab.

   

5. In the Source Code Management section, select the Git option.

   

6. In the Source Code Management section, enter the Oracle Developer Cloud Service project Git repository URL.

   

   You can copy the Git repository URL from the Code page of the Oracle Developer Cloud Service project. In the Code page, select the Git repository name in the Repositories list, click HTTP, and then click the Copy icon to copy the repository URL to the clipboard.

   Example:

   

   After entering the URL, you might see an Failed to connect to repository ... error message in Red. It appears because you have not provided the Oracle Developer Cloud Service access credentials.

   

7. To provide the Oracle Developer Cloud Service credentials, next to the Credentials list, click Add and then select Jenkins.

   

   In the Jenkins Credentials Provider dialog, enter the Oracle Developer Cloud Service username and password in Username and Password. Use the default values in other fields.

   

   Click Add when you are done. Back on the Configuration page, the error message will disappear after verifying the credentials.

   

   Note: If you still see the error message, configure the proxy settings of Jenkins. See the Jenkins documentation to know more.

8. Click the Build tab at the top of the page and configure the POM file path and the Maven goals.

   • Root POM: Enter the path of the POM file in the Git repository. You can find the path from the Code page of the Oracle Developer Cloud Service project.

   • Goals and options: Enter clean install as the Maven goals.

   

9. Click the Post-build Actions tab at the top of the page.

   

10. Click the Add post-build action list and select the Archive the artifacts option.

    

11. In the Files to archive field of the Archive the artifacts section, enter HelloWorld/target/*.war (or the path to the generated artifact files) to archive all .war files of the build.

    

12. Click Save.

To configure a Jenkins job to get triggered by a Webhook notification, you must provide a unique authentication token in the job configuration that will be used by the Oracle Developer Cloud Service Webhook. The authentication token is required to trigger a build in the Jenkins server.

1. In the Jenkins web user interface, open the configure page of the DevCS_JavaWebApp_Maven job.

2. Click the Build Triggers tab at the top of the page to navigate to the Build Triggers section.

   

3. In the Build Triggers section, select the Trigger builds remotely (e.g., from scripts) check box, and enter my_auth_token as the authentication token name.

   

   Make sure that the authentication token name is not used in any other job in Jenkins. If it is, then enter a unique token name.

4. Click Save.

The Hudson/Jenkins Build Trigger Webhook is an outgoing Webhook and is used to send notifications to an external Jenkins or Hudson server. In this tutorial, you will create and configure the Webhook to send notifications from Oracle Developer Cloud Service to the Jenkins server you have configured in the above sections. The notification will be sent when the specified Oracle Developer Cloud Service project Git repository is updated.

1. In Oracle Developer Cloud Service web user interface, open the project, and click Administration > Webhooks in the navigation bar.

   

2. In the Webhooks page, click + New Webhook.

   

3. In the Create Webhook page, enter the following details:

• Type: Select Hudson/Jenkins - Build Trigger.

• Name: Enter JenkinsBuildWebHook or any unique name of your choice.

• Build Server URL: Enter the base URL of the Jenkins server.

  For example, if http://my_server:8080/job/DevCS_JavaWebApp_Maven is the URL of the Jenkins job that you created in the above section, then enter http://my_server:8080/ in this field.

• Job Name: Enter DevCS_JavaWebApp_Maven because it was the name of the Jenkins job.

• Build Server Security: Select Build Token Root Plugin as it is the preferred way of triggering builds through Webhooks. The build will be triggered only if the Build Authorization Token Root plugin ins instaled on the Jenskins server.

• Remote Build Token: Enter my_auth_token because it was the token name specified in the Jenkins job.

• Repository: Specify the application's Git repository that will trigger the build on the Jenkins server. Make sure the repository is same as the reposiory that you have specified in the Jenkins job.

Leave other fields with default values and click Done.



4. In the Webhooks page, select the Webhook and click the Test button to test whether the configuration is correct.

   

   If the confguration is correct, the icon before the Webhook name changes to the icon. If required, click the Logs button to see the test logs.

   

The Webhook is now ready to send a notification to the Jenkins server and run a build when any update is pushed the specified Git repository.

The Jenkins Notification Plugin Webhook is an incoming Webhook and is used to receive notifications from an external Jenkins server. In this tutorial, you will create and configure the Webhook to receive notifications from the Jenkins server you have configured in the above sections.

1. In Oracle Developer Cloud Service web user interface, open the project, and click Administration > Webhooks in the navigation bar.

   

2. In the Webhooks page, click + New Webhook.

   

3. In the Create Webhook page, enter the following details.

• Type: Select Jenkins - Notification Plugin.

• Name: Enter JenkinsGetNotification or any other unique name of your choice.

• Base URL: Enter the base URL of the Jenkins server.

  For example, if http://my_server:8080/job/DevCS_JavaWebApp_Maven is the URL of the Jenkins job that you created in the above section, then enter http://my_server:8080/ in this field.

• Track - Ongoing Builds: Select the check box.

Leave other fields with default values and click Done.

The Webhook is now ready to receive notifications from the Jenkins server when a build runs and is complete.

To send notifications to Oracle Developer Cloud Service, you must create and configure an endpoint in the Jenkins job. You can create and configure the endpoint after the Notification plugin is installed in Jenkins. You would also need the Jenkins Notification Webhook URL and provide it in the endpoint.

1. Copy the Jenkins Notification Webhook URL from the Webhooks page.

   In the Oracle Developer Cloud Service Webhooks page, select the JenkinsGetNotification Webhook and copy the value of the URL field.

   

2. In the Jenkins server web user interface, open the configure page of the DevCS_JavaWebApp_Maven job, and click the Job Notifications tab.

   

3. In the Job Notifications section, click Add Endpoint.

   

4. In the URL field of Notification Endpoints, paste the Jenkins Notification Webhook URL that you copied from the Oracle Developer Cloud Service Webhook.

   

   Do not change the default values of other fields. To know more about the fields, see the Jenkins documentation.

5. Click Save.