The installation roadmap is a description of the high-level steps for installing UrbanCode™ Velocity.
UrbanCode Velocity is provided in two editions. The Standard Edition (SE) and the free-to-use for 60 days trial
version. Both editions are full featured.
Both editions consist of services and other tools that are stored in Docker containers. You can
install the containers in one of the container orchestrators, such as Docker Compose, Kubernetes, or
any environment that supports the container orchestrators, including bare-metal servers and
cloud-based platforms, such as the environments listed here:
- Windows
- Linux
- MacOS
- OpenShift
Both editions require an access key. You apply the free access key during installation. When you
license the SE version, in addition to you license key, your receive a permanent access key.
If you are evaluating UrbanCode Velocity and are unsure about which versions to install, many users find the Docker Compose installation
process to be easiest because it is the most automated.
In outline, the installation process consists of the following general steps:
- Review the system requirements
The ID that you use to install the
product must be able to make changes to the host environment. The tools required by all installation
scenarios include the following items:
- Docker installed on the host system.
- Internet connection. During installation, files and container images are retrieved from remote
locations. If you are unable to access the internet during installation, you can download the files
beforehand and perform an offline installation.
Note: The installation files used for offline
installation are not the same as those used for internet-connected installation. Ensure that you
download the right file for you installation environment.
- IBM UrbanCode™ Deploy Version 6.2.3 and later.
Although not strictly required, many UrbanCode Velocity features assume integration with UrbanCode Deploy. It doesn't matter which product you install
first.
If you are using an UrbanCode Deploy version prior to V6.2.5, you must install the patch
located at the following website: http://public.dhe.ibm.com/software/products/UrbanCode/plugins/ucsync/patches/ibmucd/. Select from the index the appropriate version that is installed on your
computer.
UrbanCode Velocity can connect to an UrbanCode Deploy server on the same network. If you
install UrbanCode Velocity with Kubernetes, the Kubernetes cluster must be on the same network as the UrbanCode Deploy server.
You can dynamically generate a system requirements report using the
Software Product Compatibility Reports (SPCR) tool.
- Install UrbanCode Velocity for your target environment:
Installing UrbanCode Velocity with Docker Compose.
Installing on Kubernetes.
Installing as an OpenShift application
- Integrate with external tools
After the installation is complete, you can access the
configuration pages to integrate with UrbanCode Deploy and other external tools, such as
Jenkins. Only sample report
data is available until the integration process is complete.
- Authenticate users
After the installation is complete, you can authenticate users. Authenticating
users to access reports is not required. However; until users are authenticated, only the
administrator user has access to reports and product features.