System requirements

Ready to install IBM Industry Solutions Workbench? Before you get started, use the information in this document to determine whether you have sufficient resources to install the service and the required software dependencies for the service.

Hardware resources

HardwareNumber of ServersAvailable VPCsMemory
x86-643+ worker nodes. The nodes must be able to schedule pods16 virtual processor cores (VPCs)64 GB

A dynamic storage provisioner is required to be present on the cluster. The core product has only modest requirements in terms of PVC storage access modes - only ReadWriteOnce (RWO) is required. If you are installing other pre-requirements software onto the same cluster, i.e. MongoDB, kafka, Keycloak, additional access modes might be required.

Note:

Use a storage provider with 500 GB or more of available space for your cluster. Tested providers include AWS EBS volumes, NFS, Portworx and OpenShift Container Storage. Squash must not be enabled on the NFS server, and all nodes in the cluster must have access to mount the NFS server and read/write access.

OpenShift setup

Please make sure you are running one of the following versions:

To set up OpenShift please follow the instructions in the OpenShift documentation.

Warning:

For some preparatory steps a user with the cluster admin role is required. These steps are clearly marked. Once the product is installed this role is no longer required for the users working with IBM Industry Solutions Workbench.

Note:

We strongly recommend hardening the Red Hat Enterprise Linux CoreOS (RHCOS). This prevents attackers from gaining access to the data of an OpenShift container. See also:

Required third-party components

The IBM Industry Solutions Workbench requires the following third-party components with the specified versions. These can be either deployed into the cluster or be deployed separately.

ComponentRequired versionMinimum specifications for worker nodesMinimum storage requirements
MongoDBVersion 6.0Cores: 2, Memory: 4 GB20 GB
Red Hat - AMQ StreamsVersion 2.2
Red Hat Integration - Service Registry OperatorVersion 2.1
Red Hat OpenShift Cluster Logging
Red Hat OpenShift GitOpsVersion 1.12
Red Hat OpenShift PipelinesVersion 1.13
Red Hat Single Sign-On OperatorVersion 7.6
Warning:

Keycloak is only supported with HTTPS mode enabled. It needs proper certificate and hostname setup.

Supported Git providers

Currently, the following Git providers are supported:

  • GitLab self-managed
  • Bitbucket Server
  • GitHub Enterprise
Note:

Of course it is not needed to create a new git provider instance, you can use your existing one. Also, it is not needed that the used git providers run inside the OpenShift cluster, but they can.

Supported Helm chart repositories

A Helm chart repository is required to release your service projects' Helm charts in order to create components, which must meet the following requirements:

  • The chart repository must not be helm-oci based
  • The chart repository must contain an index.yaml file, see Helm Chart Repository.
  • The chart repository must be available from the cluster via HTTPS and has a proper certificate (not self-signed)

Examples for supported Helm Chart Repositories are:

Warning:

Please note, that using Sonatype Nexus as Helm chart repository doesn't support descriptions and icons used in Solution Designer to display components.