Wazi for Dev Spaces requirements

Supported platforms

OpenShift® Container Platform

Platform Architecture
OpenShift Container Platform 4.10 - 4.13 AMD64 and Intel 64 (x86_64)
OpenShift Container Platform 4.10 - 4.13 IBM Z (s390x)

Prerequisites

Before you install IBM Wazi for Dev Spaces, ensure that the following prerequisites are met. Ensure that you have the latest version of the following tools. If you previously installed these tools, check the versions and update if necessary.

  • Ensure that you have a connection to a Red Hat® OpenShift Container Platform (OCP) cluster, and that you have cluster-admin permissions.

  • For increased security and user/admin account support, set up an OpenShift OAuth identity provider.

  • To enable dynamic storage provisioning, configure a default storage class for the Red Hat OpenShift cluster. The default storage class will be used when creating an instance of IBM® Wazi for Dev Spaces.

Resources Required

  • Make sure that you understand all of the prerequisites and requirements before you start your installation to ensure that your installation goes as smoothly as possible. For more information about setting up Red Hat® OpenShift® Container Platform, see Setting up your Red Hat OpenShift Container Platform cluster. For more information about planning your deployment and implementation, see Planning.

  • The default resource requirements for IBM Wazi for Dev Spaces Containers are listed as follows:

    Purpose Pod name Container names Memory limit Memory request CPU limit CPU request
    IBM Wazi for Dev Spaces Operator wazi-devspaces-operator wazi-devspaces-operator 256 MiB 64 MiB 500 m 100 m
    IBM Wazi Dev Spaces Server wazi-devspaces wazi-devspaces 1 GiB 512 MiB 1000 m 100 m
    IBM Wazi for Dev Spaces Dashboard wazi-devspaces-dashboard wazi-devspaces-dashboard 256 MiB 32 MiB 500 m 100 m
    OpenShift Dev Spaces Gateway devspaces-gateway traefik 4 GiB 128 MiB 1000 m 100 m
    OpenShift Dev Spaces Gateway devspaces-gateway configbump 256 MiB 64 MiB 500 m 50 m
    OpenShift Dev Spaces Gateway devspaces-gateway oauth-proxy 512 MiB 64 MiB 500 m 100 m
    OpenShift Dev Spaces Gateway devspaces-gateway kube-rbac-proxy 512 MiB 64 MiB 500 m 100 m
    Wazi Devfile registry devfile-registry devfile-registry 500 MiB 32 MiB 256 m 100 m
    Wazi Plugin registry plugin-registry plugin-registry 4 GiB 512 MiB 500 m 100 m
    Dev Workspace Controller Manager devworkspace-controller-manager devworkspace-controller 1 GiB 100 MiB 1000 m 250 m
    Dev Workspace Controller Manager devworkspace-controller-manager kube-rbac-proxy N/A N/A N/A N/A
    Dev Workspace webhook server devworkspace-webhook-server webhook-server 300 MiB 20 MiB 200 m 100 m
    Dev Workspace Operator Catalog devworkspace-operator-catalog registry-server N/A 50 MiB N/A 10 m
    Dev Workspace webhook server devworkspace-webhook-server webhook-server 300 MiB 20 MiB 200 m 100 m
    Dev Workspace webhook server devworkspace-webhook-server kube-rbac-proxy N/A N/A N/A N/A
    Wazi Development Container workspace wazi 4Gib 256 Mib 500 m 30 m
    Wazi Development Container workspace che-gateway 256 Mib 64 Mib 500 m 50 m

  • It is recommended that the resource allocation on the cluster should be the sum of all the individual container memory (Approx. 17.5 GiB Memory) and CPU limits (8000 m) for a user uisng the Default IBM Wazi for Dev Spaces tile.

Note: See Calculating Dev Spaces Requirements for more information about:

  • Resource allocation required for Dev Spaces components

  • How to calculate the resource requirements based on a sample devfile

Storage

The storage configuration must satisfy your sizing requirements. Different IBM Cloud Paks have different storage needs. For more information, see Storage considerations.

Important: You must define storage classes in Red Hat OpenShift Container Platform and set your storage configuration to satisfy your sizing requirements. Most IBM Cloud Paks require both a persistent volume in ReadWriteMany (RWX) mode, and be deployed into persistent volume in ReadWriteOnce (RWO) mode. Recommended storage providers might include:

  • IBM Storage Suite for IBM Cloud Paks

    • Red Hat OpenShift Data Foundation 4.x (formerly Red Hat OpenShift Container Storage), from version 4.2 or higher

    • IBM Cloud Block storage and IBM Cloud File storage

    • File storage from IBM Spectrum Fusion/Scale (ideal for RWX)

    • Block storage from IBM Spectrum Virtualize, FlashSystem, or DS8K

  • Portworx Storage, version 2.5.5 or above

  • Amazon Elastic File Storage (EFS) for RWX mode access

If object storage is used, the following storage provider must be validated across all relevant capabilities:

  • Object storage from IBM Cloud Object Storage or Red Hat Ceph

  • Amazon Cloud Object Storage (S3)

Note: To learn more about configuring storage for IBM Wazi for Dev Spaces, see the Red Hat Documentation.

A storage strategy describes how a workspace uses persistent volume claims (PVCs) and persistent volumes (PVs). Storage is for workspace data, such as projects workspace logs, or additional volumes defined by a user. This volume can be requested by the user using the Devfile. The different storage strategies are listed as follows:

Storage strategies:

Storage strategy name Per-user Per-workspace Ephemeral
PV count One per user One per workspace N/A Non persistent storage
Default yes no no
Limitations All workspaces PVCs in one volume Each workspace is given its own individual PVC N/A

Notes:

  • I/O speeds vary depending on Storage Classes configured in the environment.

  • To learn more about configuring persistent volumes using the Devfile, click here.