Debugging Jenkins integration with Deployment Manger Issues
The Jenkins task in Deployment Manager can be used to run tasks which are not directly supported by Deployment Manager, for example, to run Selenium tests or run any Pipeline Script or Performance tests.You can find more information about configuring Jenkins here Configuring Jenkins.
Below are few common issues which you might face when you configure and run Jenkins task in Deployment Manager.
Authentication Issues (401 Error):
Problem: Jenkins task fails with the error “Reason: the server responded with a HTTP 401 code, indication an authorization problem”
Solution:
- The common reason for this failure is with Authentication profile configured in Pipeline Settings under External orchestration server tab. Please recheck the Authentication Profile and rerun the diagnostics to validate the connection.
- You can also view Deployment logs to get complete logs for further troubleshooting.
Build is not Parameterized (500 Error):
Problem: Jenkins task fails with the error “Reason: the HTTP response code of 500 indicated a server error. The response data may contain a reason”
Solution:
- The most common reason for this failure message is Deployment Manager requires the Jenkins Job to be Parameterized.
- Please follow steps 5 and 6 from Configuring Jenkins to make Jenkins job parameterized. You should have BuildID and CallBackURL as parameters.
- You can also view Deployment logs to get complete logs for further troubleshooting.
Unable to reach Jenkins server:
Problem: Jenkins task fails with the error “Connect to xx.xxx.xxx.xx failed: Connection refused”
Solution:
- The most common reason for this failure message is Deployment Manager Orchestrator is unable to reach Jenkins Server because for wrong URL or port number.
- To fix this please ensure that you have entered correct URL in External orchestrator tab under Pipeline Settings.
- Please ensure that you have whitelist Jenkins server to the Orchestrator environment if you are on cloud.
- Please rerun the Diagnose Pipeline to Validate the connection to Jenkins Server.
Resource does not exist (404 Error):
Problem: Jenkins task fails with the error “the server responded with a HTTP 404 code, indicating that resource does not exist “
Solution:
- The most common reason for this failure message is Deployment Manager Orchestrator is unable to find the Job configured in Jenkins Tasks.
- To fix this please ensure that you have entered the correct Job name in Jenkins task.
No valid crumb was included in the request (404 Error):
Problem: Jenkins task fails with the error “403 No valid crumb was included in the request
Solution:
- The most common reason for this error when we enable CSRF and valid crumb is not sent from Deployment Manager.
- Support for Jenkins CSRF is provided in Deployment Manager starting 4.4 , you can upgrade to latest version of Deployment Manager by downloading latest version from https://community.pega.com/marketplace/components/deployment-manager.
TATA Consultancy Services Ltd
GB
Hi Gowtham,
I have gone through the Configure Jenkins section, as per the guide step-4 require creating a free style jenkins project. But in our projects we have already testing pipelines (multi branch type instead of free style project) created by devops team. I want to re-use the same testing pipelines and call them from PEGA DM by making the configurations mentioned in the guide.
Can you let me know if PEGA DM supports invoking the Multibrach jenkins pipeline? if yes what configuration changes are required to the multibranch jenkins pipeline? Thank you, Surendra.PV
Pegasystems Inc.
IN
Hi Surendra,
Yes, you can use multi-branch pipelines as well with deployment manager. Make sure you are triggering the appropriate branch pipeline from deployment manager Jenkins task and also ensure the call back is coded into the pipeline script to do the call back on either completion or failure of the triggered job.
Regards,
Anil
TATA Consultancy Services Ltd
GB
Hi Anil,
Do you have any reference for the mulit-branch pipeline job that takes in params i.e. BuildId and CallbackURL, Auth Token , Bindings etc. and gets called from Deployment Mgr?
The version of jenkins on which we are working is 2.249.1
Pegasystems Inc.
IN
Hi Surendra,
I don't have a reference at the moment, but we can publish something in the future(no estimated time). But as long as the connectivity is established, things should work. Deployment Manager uses the Jenkins REST API to trigger the jobs. So as long as remote trigger of jobs is enabled and configured on Jenkins it should work. If you are running into specific issues, raise a support ticket and we will look into it.
Regards,
Anil
TATA Consultancy Services Ltd
GB
Hi Anil,
I am getting the below error when executing the task from PEGA DM. (I am using the PEGA Deployment manager version 4.7)
HTTP ERROR 403 No valid crumb was included in the request
Any idea how to fix this?
Pegasystems Inc.
IN
Hi Surendra,
Make sure, the authentication profile that you have used to connect to Jenkins is correct and can login to the Jenkins. Depending on the Jenkins version you should use API token as the password in the auth profile.
If you are still running into issues, please create a support ticket with relevant logs.
Regards,
Anil