This release of IBM UrbanCode Velocity is a maintenance release and includes bug fixes. This release is recommended for all customers.


On the Pipeline page, when you click the overflow menu on any environment except Input, you can select Override Inventory to manually modify and update a pipeline.


On the Releases page, an overall performance improvement is achieved for page loading. Functionally, the dialog box below the calendar now lists only events versus releases and events.


General performance improvements across the entire product.


Regardless of the global permissions assigned to a user, you can modify your own password for the following conditions:

  • Your User type is Local.
  • Click Settings > Authorization > Users and then click the overflow menu and select Change password.


Corrected the security issues including the following:


The following table is a cumulative list of fixes in the 2.5.2 version.

On the Value streams page, if there is a back end query running for 60 seconds that does not return to the front end no longer monitoring for a response, the VSM page does not crash and display the There was a problem loading this workflow. The system is experiencing a problem right now. Try again later. message.
On the Pipeline page, when you perform the following:

  • Click Add application and add a Jenkins integration with a long Application name.
  • On the Jenkins app for the Input environment, click the overflow menu and select Create version.
  • In the Create version window, resolved UI positioning errors of the application and job selection screens on the pipeline.
On the Pipeline page, when you perform the following:

  • With exception to the Input environment, click the required release link under an environment in the pipeline.
  • The deployment plan detail page opens.
  • Resolved issues where Jenkins tasks were restarting due to parallelization of prior tasks.
On the Pipeline page, improved performance for initial loading of pipeline page.
On the Pipeline page, on any environment except Input, when you click the overflow menu and select Override Inventory, this function is operating properly without the page crashing.
On the Releases page, when you perform the following:

  • In the Release activities table, click on a release.
  • For the required deployment plan, click the overflow menu and select Edit this plan.
  • In the Edit deployment plan window, when you click the Team drop-down, the field is populated correctly with the associated teams.
On the Releases page, when you perform the following:

  • In the Release activities table, click on a release.
  • Click the Create deployment plan button and create and save a deployment.
  • Click the deployment plan created in the previous step.
  • Click the Create task button and create several Jenkins tasks.
  • Schedule deployment in five minutes.
  • For the created deployment plan containing the Jenkins tasks, click the Complete task, Fail task, and Skip task icons to confirm the aforementioned states. When the START TIME occurs, it is ignored because the deployment plan is in progress.
When you click Settings > Authorization > Teams and perform the following:

  • Select a team containing more than 25 members.
  • In the Items per page drop-down, select 100.
  • Click the overflow menu and select Assign roles.
  • In the Edit member window select a Role and click Save. After saving, the page size correctly reverts to 100 items per page.
When you click Settings > Calendar, the Calendar page works correctly.
Fixed various console errors including property types, missing typename, and treatment of English as a non-default language.

Plan and prepare

For supported platforms and requirements you can dynamically generate a system requirements report using the Software Product Compatibility Reports (SPCR) tool.

Install the server

There are two option to obtaining the installation package: online installer and offline installer. Both options require a master license key, which can be acquired from IBM Passport Advantage.

Online installer

The online installer option for installing the product requires an internet connection for the entire process. It requires minimum storage for the downloaded package. The downloaded image contains only the Helm charts used to pull the product Docker images from a GitHub location. This is our recommended installation method.

Download the online installer package depending on the platform, the product is being installed.

After the download completes, start the executable file to begin the install process.

Offline installer

Use the offline installer to install Velocity without internet connection. You will still need internet connection at some point to download the installer itself. Once downloaded, the installer will include all containers needed to successfully install the product. For this reason, the offline installer is larger than the online installer and will require more time/bandwidth and disk space when downloading.

The installation package is available from IBM Fix Central. Search and select the installation package appropriate for the installation platform.

After downloading the installation package, decompress the contents into two directories: one for Kubernetes and the other for Docker Compose. See the documentation section on installation for instructions about how to install the server.

A product license key is required to install the product. To obtain a key, you must agree to the terms and conditions provided on Passport Advantage.


To learn more about UrbanCode Velocity, see documentation.

For help installing or using UrbanCode Velocity, post your questions in the UrbanCode forums. Tag your question with velocity.

To suggest an enhancement to the product, visit the RFE Community

Get support

For information from support, including FAQs, visit the IBM Support portal. You can configure the support portal to view information about specific products.


MongoDB Version 3.6 end of support

The MongoDB version 3.6 has reached end of life and all MongoDB 3.6 instances must be upgraded to MongoDB 4.0 for IBM UrbanCode Velocity 2.3.0 to start. This upgrade applies only if you are running UrbanCode Velocity in a Docker Compose environment.

If you are upgrading or have ever upgraded from a UrbanCode Velocity version prior to v1.4.5, which was released in March 2020, you must migrate your MongoDB. The procedure to complete is described in the following table. The procedure depends on several items.

Scenario 1 Scenario 2 Scenario 3
IBM UrbanCode Velocity version 1.4.4 or earlier Upgraded from 1.4.4 or earlier to a version between 1.4.5 to 2.2.4 New installation of 1.4.5 or higher
MongoDB version 3.4 3.6 3.6
MongoDB compatibility flag version 3.4 3.4 3.6
Solution A Upgrade to version 2.2.5, then to 2.3.0 Upgrade to version 2.2.5, then to 2.3.0 Upgrade directly to version 2.3.0
Solution B N/A Run MongoDB command:

db.adminCommand( { setFeatureCompatibilityVersion: 3.6 } )

to set compatibility flag to version 3.6

Solution C Contact support. Contact support. N/A

Upgrade information

Starting in 2.4.1

When upgrading from an IBM UrbanCode version prior to 2.4.0 for Kubernetes and OpenShift upgrades, you are required to perform a Helm uninstall and install prior to performing a full installation of version 2.4.x.

For Docker Compose upgrades of IBM UrbanCode Velocity with a default certificate replaced with a custom certificate, the installer tracks the latter certificate and reads the associated files from the directory location.

Starting in 2.4.0

When upgrading from an IBM UrbanCode version prior to 2.4.0 for Kubernetes and OpenShift upgrades, you are required to perform a Helm uninstall and install prior to performing a full installation of version 2.4.x.

Starting in 2.1.0

The Jenkins UrbanCode Velocity plug-in is now prerequisite and must be installed. The allows for running Jenkins jobs as a part of a deployment plan in UrbanCode Velocity. Version 2.1.0 of the plug-in is required. For more information about the plugin, see the Jenkins website.

Starting in 2.0.0

Starting in UrbanCode Velocity v2.0.0, the MongoDB server 3.4 is no longer supported. UrbanCode Velocity v2.0.0 supports MongoDB server versions: 3.6, 4.0, and 4.2. For more information about out of service MongoDB server versions, see Mongo website.

  • Docker Compose installations automatically upgrade to 3.6.
  • Helm installations require manual upgrade or installation of the MongoDB server to 3.6 or later.
  • New Helm installations use MongoDB 4.2 according to the Helm chart.

1.5.1 Improves Upgrade Support for all Prior Versions

All versions can be directly upgraded to 1.5.1 or later. Helm upgrades from 1.4.5 and 1.5.0 avoid previous complications. Velocity 1.5.1 also fixes an old issue that required versions older than 1.2.6 to upgrade to 1.2.6 before upgrading further.

NOTE: Helm upgrades from versions prior to 1.5.0 still require helm delete --purge

Starting in 1.5.0

Starting with v1.5.0, we have added and modified some Helm Selectors to adhere with best practices. Therefore, running the helm upgrade command from a previous version of UrbanCode Velocity will fail. All upgrades from a version prior to v.1.5.0 to v1.5.0 or later will require a Helm purge as described below.

  1. Delete your currently installed release with helm delete --purge , where is the name of your current UrbanCode velocity release.
  2. Follow the normal install directions with all previous name and values from your previous release.

Note: Your Mongo database will be not be modified as it is maintained outside of the installation.

Starting in 1.4.5

In v1.4.5, the distributed version of MongoDB was upgraded from v3.4 to v3.6. Docker Compose installs will see the upgrade happen automatically. Other Docker platforms, such as: OpenShift and Kubernetes will need to manually upgrade their MongoDB instance. MongoDB v3.4 is still supported as of the release of v1.4.5. However, MongoDB v3.4 has been End of Life by Mongo, so we recommend customers upgrade at their earliest convenience.

Going forward, when our shipped version of MongoDB is upgrade, we continue to support the prior version of MongoDB, but deprecate the version before that. For example, when the shipped version of MongoDB is upgrade to v4.0, support is continued for v3.6 and and v3.4 is deprecated. We estimate that this will require two MongoDB upgrades per year, which should not force our Enterprise Docker Platform users to upgrade their MongoDB image more than once a year.