Skip to main content

Installing

Overview​

Cloud Solution Workbench runs on Red Hat OpenShift or Kubernetes.

The default installation is the design-time workbench (Solution Designer) in the installation namespace, together with an identity provider and a Git provider. Deployment-target namespaces, pipelines, GitOps, Kafka, and related runtime services are only needed if you use Managed Stacks. See Install runtime for Managed Stacks for that topology and the corresponding diagrams.

Third-party requirements​

Cloud Solution Workbench requires different third party components:

  • Git Provider - used as a central source code repository (currently GitLab, GitHub Enterprise, Bitbucket and Gitea are supported)
  • Red Hat build of Keycloak Operator, Keycloak, or Microsoft Entra ID - Open ID Connect / SSO Server for the design environment (one identity provider is required). For Helm values when using Entra ID, see Use Microsoft Entra ID as OIDC provider.

The following components are not required for a default design-time installation. Install them only if you use Managed Stacks:

  • OpenShift Pipelines or Tekton - used to build and deploy service projects
  • OpenShift GitOps or ArgoCD - used to deploy application projects
  • Apache Kafka - to support eventing for projects
  • OpenShift Service Mesh or Istio Service Mesh
  • MongoDB - used to store business data for the projects developed with Cloud Solution Workbench

See Install runtime for Managed Stacks.

ℹ️note

The detailed information on supported versions are listed in the System Requirements

Instructions​

In general, the process consists of these steps:

  1. Check you meet the system requirements. See System Requirements
  2. Decide which services (that you might already run) you want to use or whether you want to install all required dependencies on your cluster during installation of Cloud Solution Workbench. This is suitable for small or PoC type deployments. See Install Third Party Components
  3. Gather all configuration data needed for starting the installation of Cloud Solution Workbench. See Pre-Installation Tasks for details.
  4. Install and configure Cloud Solution Workbench. See Installation Process
  5. After installation of the core product, configure the installed Solution Designer and verify that you can login to Solution Designer. See Post-installation tasks for details.

If you use Managed Stacks (deprecated, off by default), you also need the runtime: additional Helm values, third-party build/deploy services, and k5-project namespaces. See Install runtime for Managed Stacks.

ℹ️note

If required - although not recommended - multiple Cloud Solution Workbench instances can be installed in the same cluster, separated by namespace. A Cloud Solution Workbench installation is required for each namespace. Prior to these installations, ensure that cluster-wide custom resource definitions (CRs) of these product instances do not conflict with each other and that OpenShift routes, which can be configured during installation, are chosen differently to avoid conflicts.