IBM Bluemix DevOps Connect
IBM® Bluemix™ DevOps Connect coordinates communication between UrbanCode Release, UrbanCode Deploy, and the IBM Cloud Services and Bluemix Services.
You can start creating integrations with the pre-installed plug-ins as soon as you register DevOps Connect. DevOps Connect includes the following plug-ins:
- IBM UrbanCode Deploy for Mobile. This plug-in provides UrbanCode Deploy data to UrbanCode Mobile users.
- IBM UrbanCode Release for Mobile. This plug-in provides UrbanCode Release data to UrbanCode Mobile users.
- IBM UrbanCode Deploy for Cloud Reporting. This plug-in provides UrbanCode Deploy data to Continuous Release and Continuous Delivery users.
Integrations run periodically and sync data between your on-prem UrbanCode products and your Bluemix services, such as Continuous Release. Integrations use encrypted SSL connections and store data in encrypted databases. DevOps Connect encrypts the data before it provides it to the Bluemix services. DevOps Connect uses SSL to communicate with the cloud services. The DevOps Connect web-based dashboard also uses SSL.
To register Bluemix DevOps Connect, you must have an IBMid. A Java™ Runtime Environment version 7 or later must be installed on the host system and its location must be included in the system
UrbanCode Release compatibility
DevOps Connect is compatible with UrbanCode Release version 6.2.0 and later.
UrbanCode Deploy and UrbanCode Mobile compatibility
For UrbanCode Mobile compatibility, DevOps Connect is compatible with UrbanCode Deploy version 220.127.116.11 and later.
UrbanCode Deploy and Bluemix services compatibility
All versions of UrbanCode Deploy prior to 6.2.5 require a patch to work with IBM Bluemix services. Patches are available for most UrbanCode Deploy versions. If a patch for your version of UrbanCode Deploy is not available, you can request a patch by contacting IBM support.
Installing the patch for UrbanCode Deploy
- Download the patch for your UrbanCode Deploy version.
- Stop the UrbanCode Deploy server.
- Put the patch file in the
UCD_installation_dir/appdata/patchesfolder. If you renamed the
appdatafolder during installation, use that folder instead.
- Restart the UrbanCode Deploy server.
The DevOps Connect installation file is an executable JAR file. After you download the file, place it on a computer that has access to the products that you want to integrate with, such as UrbanCode Deploy. You start DevOps Connect by running the JAR file.
After DevOps Connect starts, you can use a web browser to access the application’s dashboard. The first time that you run DevOps Connect, you use your IBMid to register it with the Bluemix services. The Bluemix service issues an authentication token that is stored in the
sync.properties file. On Windows, the
sync.properties file and log files are stored in the
\Users\my_directory\.ibm\cloud-sync folder on the computer that hosts DevOps Connect. On Linux, the
sync.properties file is stored in the
/home/my_directory/.ibm/cloud-sync folder. The
/cloud-sync folder is created the first time that you run IBM Bluemix DevOps Connect.
By default, the user that registers DevOps Connect is authorized to use it. An authorized user can authorize other users to use the application. Authorized users can access the DevOps Connect web-based dashboard and install plug-ins and create integrations.
Installing IBM Bluemix DevOps Connect
- Download DevOps Connect from the IBM developerWorks. The downloaded file is an executable JAR file. You run this file to start DevOps Connect.
- Open HTTP port 443 for outgoing traffic to mybluemix.net and bluemix.net.
- Open a command window and start DevOps Connect by pasting and running the script generated by your Bluemix service. If you are not using a Bluemix service, you can start DevOps Connect by entering this command in the command window:
java -jar devops-connect-build_number.jar. For example,
java -jar devops-connect-2.0.868009.jar. DevOps Connect displays start-up messages in the command window.
- Optionally, if you use a proxy, add this command to your Linux startup script:
export _JAVA_OPTIONS="-Dhttps.proxyHost=... -Dhttp.proxyHost=... -Dhttp.proxyPort=80 -Dhttps.proxyPort=80". On Windows, use the
exportcommands instead. For example:
"set _JAVA_OPTIONS=-Dhttps.proxyHost=10.0.0.100 -Dhttps.proxyPort=8800", or
export _JAVA_OPTIONS="-Dhttps.proxyHost=10.0.0.100 -Dhttps.proxyPort=8800". Note, if you use the IBM version of Java, use
- After DevOps Connect starts, use a web browser to access the DevOps Connect dashboard. The default URL is
https://localhost:8443. You can change the port when you start the application. For example, to change the port to
8444, use this command to run the JAR file:
java -Dserver.port=8444 -jar devops-connect-2.0.868009.jar.
- On the registration page, if you are prompted to specify a name for the installation, provide a name. This name identifies the data from your installation.
- Click Register. The first time that you access DevOps Connect, you are prompted to register it.
- On the Sign-in to IBM page, enter your IBMid and password, and then click Sign In. The DevOps Connect dashboard is displayed. You sign in each time you start DevOps Connect.
- Optionally, in the DevOps Connect dashboard, click Settings and then, in the Allowed Users text box, enter the email addresses of users who are authorized to access the DevOps Connect dashboard. Separate addresses with commas. You can use the asterisk (*) wildcard character in the email addresses. For example, the pattern
*@.my_company.comallows any user at
my_company.comwho has an IBMid to access the dashboard. Authorized users can install plug-ins and create integrations.
After you register, DevOps Connect generates a unique ID and saves it in the
sync.ID property in the
sync.properties file. The token that it receives from the Bluemix service is saved in the
sync.token property. The token and ID identify the DevOps Connect instance.
Installing DevOps Connect as a Linux service
To run IBM Bluemix DevOps Connect as a service on Linux, create a symlink from the IBM Bluemix DevOps Connect jar file to the
init.d program. For example:
$ sudo ln -s /var/myapp/cloud-sync-build_number.jar /etc/init.d/myapp. After you configure the application, you can use the standard service commands to manage IBM Bluemix DevOps Connect:
You can use values in the
/home/my_directory/.ibm/cloud-sync/sync.properties file to manage various aspects of IBM Bluemix DevOps Connect. This table describes the available properties.
||Directory where the
||Unique identifier that is used to authenticate IBM Bluemix DevOps Connect to the IBM Bluemix services. This property should not be modified.|
||Optional name for the IBM Bluemix DevOps Connect instance. The name property can be used by IBM Delivery Insights and other IBM Bluemix services that integrate with multiple IBM Bluemix DevOps Connect instances.|
||Unique identifier that is generated by IBM Bluemix services and used to authenticate IBM Bluemix DevOps Connect. This property should not be modified.|
||IBMid of the user who registered IBM Bluemix DevOps Connect. This property should not be modified.|
||Comma-delineated list of users who are authorized to use the IBM Bluemix DevOps Connect dashboard. This property should not be directly modified. Use the dashboard Settings tab to manage authorized users.|
||IBM Bluemix DevOps Connect port number. If you set this property, you do not have to use the command line parameter when you start the application.|
||Proxy host URL. If you use a proxy, set this property and the http
||Proxy port number.|
You can edit the file in any text editor. For example:
Restart DevOps Connect after editing the file.