Installing on OpenShift using Helm charts
You can install IBM™ UrbanCode Velocity on OpenShift using Helm charts.
See the Software Product Compatibility Reports (SPCR) for the latest system requirements documentation for IBM UrbanCode Velocity. MongoDB storage requirements are found on SPCR and on this page.
- Docker installed on the host system. Note: If you use Docker for Windows, make sure Docker is using Linux-type containers. IBM UrbanCode Velocity does not support Windows-type containers.
- 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.
IBM UrbanCode Velocity supports the following browsers: Chrome, Firefox, and
Edge.Note: These steps are only required if users are using the online installer to push images to an offline docker registry:
Use
pull
command to pull the container images from public repository.$ docker pull public repo
Use
tag
command to tag the public and private repository.$ docker tag public repo private repo
Use
push
command to push container images to private repository.$ docker push private repo
All the container images are retrieved from public to private repository.
In addition to the requirements for all installation scenarios, you need the following items:
- Configured OpenShift client instance. This topic uses Minishift for local instance installations.
- OpenShift command line tool, OC, installed on the client.
- Create an OpenShift project where you can install IBM UrbanCode Velocity.
- Access to the PEM-format certificate and private key that you can use to configure OpenShift routes.
- Create new
velocity-image-secret
if required. - Master node: 2 vCPU, 8 GB RAM, 30 GB storage.
- Other nodes: 1vCPU, 8 GB RAM, 15 GB storage.
The product installation requires an existing MongoDB database for data persistence. With the database, running the IBM UrbanCode Velocity installer produces a Helm chart that is applied to the Kubernetes environment and instantiate the Kubernetes resources that comprise IBM UrbanCode Velocity.
Additionally, you can configure an SSL certificate. If required, you can use Ingress instead of a Route.
To modify default parameters, installation options are configured with the --set
name=value
Helm syntax when creating the Helm release. Optionally, the
values.yaml
file is edited on the extracted Helm chart. Some options are not
exposed as Helm values and must be modified on the Kubernetes resources either by modifying the
extracted Helm chart templates, or patching them after the Helm release is created. For example, to
configure the ephemeral Argo pods for running integrations, you modify the
workflow-controller-configmap
ConfigMap in the
.../templates/configmap-workflow-controller.yaml file.
CustomResourceDefinitions
. If you do not have access, consult your OpenShift
administrator.When all the containers have the status of running
, the installation is complete
and you can access
IBM UrbanCode Velocity at the URL you specified in the Helm chart. You can refresh the status display by using the
following kubectl command: kubectl get pods
. The default admin user name is
admin and the default password is what was specified in the installer.
loglevel
are optional:ALL
DEBUG
INFO
WARN
ERROR
FATAL
OFF
ALL
.