Hardware requirements and recommendations for foundational services

Before you install your product, review the system requirements for installing the foundational services.

Some services have dependency on other services. You must consider the service and its dependencies when you estimate the hardware requirements. For more information about the service dependencies, see Dependencies of the IBM Cloud Pak foundational services. For any high availability (HA) configuration that is required for a service, see Configuring high availability for foundational services.

Sizing for foundational services

Based on your cluster requirement, you can pick a deployment profile and enable it during installation. IBM Cloud Pak foundational services provides starterset, large, medium, and small deployment profiles. For more information about these profiles, see Table 1. Deployment profiles.

You can set the profile during installation or upgrade.

The default profile is starterset. Before you install foundational services, you can change the profile to small, medium, or large, as required. You can scale up a profile anytime after installation. However, scaling down a profile can be done only if no other Cloud Pak has requested for a larger size. For example, if you install with a medium profile and another Cloud Pak specifies a medium or large profile then attempt to scale down to size small, the profile remains as medium. You would be able to scale down to small only if there are no other Cloud Pak with medium or large size.

If you are upgrading your cluster from a previous release, the default profile setting is as-is, which retains the previous hardware settings. If required, you can change the profile to small, medium, or large. If your cluster supported production workloads in the previous release, it can continue the support with the as-is profile.

For each profile, the total CPU and memory requirement for all services together is provided in Table 2.

Note: While the default profile is starterset, the starterset profile is not recommended for production usage.

Deployment profiles

Profile Description Scaling Minimum number of worker nodes
Starterset For environments that are used by a single department with only few users. This profile is for first-time users and useful for proof of concept (POC). - Supports up to 10 users simultaneously accessing an application
- Does not provide HA and failover
1
Small For environments that are used by a single department with a small number of users; useful for application development. - Supports up to 10 users simultaneously accessing an application
- Supports failover
- StatefulSet provides HA
1
Medium For environments that are used by a single department and by limited users. - Supports up to 100 users simultaneously accessing an application
- Supports HA and failover
- Provides at least two replicas of most services, if configuring failover
3
Large For environments that are shared by multiple departments and users. - Supports more than 100 users simultaneously accessing an application
- Supports HA and failover
- Provides three or more replicas of each service, depending upon the workload
5

Considerations for a small profile

In the small profile, Kubernetes provides a failover capability to the stateless services. The Kubernetes scheduler reschedules pods if required: for example, if the node on which the pod was scheduled goes down. If the Kubernetes scheduler impacts any service pod that was already scheduled, you can manually schedule the pod in another node or restart the impacted service.

If you choose a small profile as your production environment, consider these implications when a service pod is rescheduled:

Hardware requirement

Table 2 provides the total hardware requirement of the profiles across all worker nodes in your cluster. For capacity planning, consider the CPU request and memory limit.

The CPU request is the minimum number of cores that must be available when a service is created. The memory request is the minimum amount of memory that must be available when a service is created.

You can use templates to update the hardware requirements of the services that you are installing.

Platform Profile CPU Request (cores) CPU Limit (cores) Memory Request (GB) Memory Limit (GB)
Linux x86_64 Large 11 52 32 59
Linux x86_64 Medium 8 36 21 38
Linux x86_64 Small 6 23 12 19
Linux on Power (ppc64le) Large 13 67 41 69
Linux on Power (ppc64le) Medium 8 47 24 43
Linux on Power (ppc64le) Small 5 28 11 21
Linux on IBM Z and LinuxONE Large 13 61 42 58
Linux on IBM Z and LinuxONE Medium 7 42 24 34
Linux on IBM Z and LinuxONE Small 5 24 11 15

Hardware requirement of individual services including the hardware requirement of their dependencies is provided in the following topics:

Platform UI framework hardware requirements

If you are planning to install the Platform UI framework (ibm-zen-operator), there are additional minimum hardware requirements.

The following table shows the minimum requirements for the Platform UI framework:

Component Memory CPU (cores)
Platform UI 4 Gi 1.7

Db2 Operator hardware requirements

If you are planning to install the Db2 Operator (ibm-db2u-operator), there are additional minimum hardware requirements.

The following table shows the minimum requirements for the software and operators that are installed with the Db2 Operator:

Component Memory CPU (cores)
Operator 512 Mi 0.5
Db2 6 Gi 2.5

Events service hardware requirements

If you are planning to install the Events Operator (ibm-events-operator) for the Events service, there are additional minimum hardware requirements.

The following table shows the minimum requirements for the software and operators that are installed with the Events Operator:

Component Memory CPU (cores)
Kafka (per replica) 1 Gi 1
Zookeeper (per replica) 1 Gi 1
Cluster Operator 1 Gi 1
Entity Operator - Topic Operator 1 Gi 1
Entity Operator - User Operator 1 Gi 1
Entity Operator - Transport Layer Security (TLS) Sidecar 128 Mi 0.5

User Data Services (UDS) Operator hardware requirements

If you are planning to install the User Data Services Operator (ibm-user-data-srvices-operator), there are additional minimum hardware requirements.

The following table shows the minimum requirements for the software and operators that are installed with the User Data Services Operator:

Pod name CPU Request (MilliCores) CPU Limit (MilliCores) RAM Request (MiB) RAM Limit (MiB)
event-api 150 300 600 1000
event-reader 150 300 600 1000
store-api 150 300 600 1000
reverse-proxy 100 100 100 100
postgres 100 200 500 1000
scheduler 250 500 600 1000
submodule 150 250 150 250
submodule-scheduler 250 500 600 1000

IBM API Catalog service hardware requirements

If you are planning to install the IBM API Catalog service (ibm-apicatalog-operator), the following table shows the additional minimum hardware requirements for each profile:

Profile CPU Request (cores) CPU Limit (cores) Memory Request (GB) Memory Limit (GB) Persistent Volume (default value in Gi)
Small or starterset 1.85 2.3 2 2.8 50
Medium 5.55 6.9 6 8.42 150
Large 5.55 10.05 6 9.88 150

Business Teams Service (BTS) hardware requirements

If you are planning to install the Business Teams Service (ibm-bts-operator), the following table shows the minimum hardware requirements:

Component Memory CPU (cores)
Business Teams Service 4 Gi on each node
  • 1 master node with 4 CPUs 5 GB
  • 1 infrastructure node with 4 CPUs
  • 1 infrastructure node with 4 CPUs