If you use IBM Urbancode Deploy (as uDeploy is now called) at all, you will notice its simplicity. And rightly so as a deployment automation tool should not re-invent the way deployment automation is done. Urbancode Deploy simply organizes and collects deployment processes and steps. Once a deployment is successful, any good deployment automation solution should be able to repeat that deployment over and over again with no trouble.
On the other hand, the integrations with other tools, both as a consumer and a producer, provide the real value. And a valuable part of Urbancode Deploy’s integration capabilities is its REST API. There are 3 ways to get information about the API.
1) The documentation – this is unfortunately not your best bet. It is out of date and lacks a lot of necessary detail.
2) The Application WADL file – it does exists in the uDeploy server folder structure. But it is hard to decipher and also leaves out the json details.
3) Browser development tools – This is the method that has been the most successful for me. I use Chrome and its developer tools allow you to see the network traffic occuring as you navigate the uDeploy web pages. The uDeploy user interface heavily utilizes the REST API. But capturing the network traffic as you navigate, you can see the specific rest calls that are occuring and examine the json payload both in and out.
I sought to build something that exercises the uDeploy REST API. What I came up with is an example of how you can solve a common uDeploy requirement. The process of onboarding an application to uDeploy involves many mouse clicks and an understanding of how to navigate the user interface. As I said above, the concepts are easy once you understand them, but to onboard thousands of applications does not scale if you use the user interface. Plus you must train people on how to get their applications into uDeploy.
So I built a small website that captures some basic information about an application, its components, and its environments, and does the bulk of the setup work in uDeploy via the REST APIs. I wanted to be able to capture the information in a way that a development team would understand yet not need to know anything about uDeploy and its structure.
You can see a demo of this sample application at this link: http://www.youtube.com/watch?v=qr3bdCJykEk.
I would welcome any feedback.