IBM Support

How to configure the Rook-Ceph Toolbox in OpenShift Data Foundation

How To


Summary

This Article includes steps to enable the Rook-Ceph Toolbox pod

Environment

Red Hat Openshift Data Foundation 4.x
IBM Fusion Data Foundation 4.x

Steps

Important: As per ODF / FDF troubleshooting Guide, it is not supported to run Ceph commands in ODF/FDF clusters (unless indicated by the support team or documentation), as it can cause data loss if incorrect commands are executed. 

The rook-ceph toolbox is a pod with common tools used for debugging, testing, and troubleshooting Ceph. 

Option 1: Using the oc patch command:

ODF v4.15 and above 

oc patch storagecluster ocs-storagecluster -n openshift-storage --type json --patch '[{ "op": "replace", "path": "/spec/enableCephTools", "value": true }]'

ODF v4.14 and below

$ oc patch OCSInitialization ocsinit -n openshift-storage --type json --patch  '[{ "op": "replace", "path": "/spec/enableCephTools", "value": true }]'

Option 2: Editing the OCSInitialization ocsinit directly

$ oc edit OCSInitialization ocsinit

Update the spec section to include the following making sure you properly indent:

spec:
  enableCephTools: true

Note: Toggling the value from true to false terminates any running toolbox pod immediately.

Verify whether the toolbox pod is up and running:

$ oc -n openshift-storage get pod -l "app=rook-ceph-tools"

Once the rook-ceph toolbox pod is running, you can rsh to it directly by running:

$ oc rsh $(oc get pods -n openshift-storage -l app=rook-ceph-tools -o name) -n openshift-storage

Run the Ceph command inside the pod:

     sh-4.4$ ceph -s
       cluster:
         id:     e4f12xxx-Redacted-Cluster-ID-yyy8fdcdfe6f
         health: HEALTH_OK

       services:
         mon: 3 daemons, quorum a,b,c (age 69m)
         mgr: a(active, since 68m)
         mds: ocs-storagecluster-cephfilesystem:1 {0=ocs-storagecluster-cephfilesystem-b=up:active} 1 up:standby-replay
         osd: 3 osds: 3 up (since 67m), 3 in (since 67m)

       data:
         pools:   3 pools, 24 pgs
         objects: 96 objects, 99 MiB
         usage:   3.1 GiB used, 3.0 TiB / 3.0 TiB avail
         pgs:     24 active+clean

       io:
         client:   853 B/s rd, 4.3 KiB/s wr, 1 op/s rd, 0 op/s wr

Document Location

Worldwide

Operating System

System x Hardware Options:Red Hat Linux

[{"Type":"MASTER","Line of Business":{"code":"LOB66","label":"Technology Lifecycle Services"},"Business Unit":{"code":"BU070","label":"IBM Infrastructure"},"Product":{"code":"SSSEWFV","label":"Storage Fusion Data Foundation"},"ARM Category":[{"code":"a8m3p000000UoIPAA0","label":"Support Reference Guide"}],"ARM Case Number":"","Platform":[{"code":"PF016","label":"Linux"}],"Version":"All Versions"}]

Document Information

Modified date:
21 December 2025

UID

ibm17104410

Page Feedback