Toolbox
The Rook toolbox is a container with common tools used for rook debugging and testing. The toolbox is based on CentOS, so more tools of your choosing can be easily installed with yum
.
The toolbox can be run in two modes:
- Interactive: Start a toolbox pod where you can connect and execute Ceph commands from a shell
- One-time job: Run a script with Ceph commands and collect the results from the job log
Hint
Before running the toolbox you should have a running Rook cluster deployed (see the Quickstart Guide).
Interactive Toolbox¶
The rook toolbox can run as a deployment in a Kubernetes cluster where you can connect and run arbitrary Ceph commands.
Launch the rook-ceph-tools pod:
Wait for the toolbox pod to download its container and get to the running
state:
Once the rook-ceph-tools pod is running, you can connect to it with:
All available tools in the toolbox are ready for your troubleshooting needs.
Example:
ceph status
ceph osd status
ceph df
rados df
When you are done with the toolbox, you can remove the deployment:
Toolbox Job¶
If you want to run Ceph commands as a one-time operation and collect the results later from the logs, you can run a script as a Kubernetes Job. The toolbox job will run a script that is embedded in the job spec. The script has the full flexibility of a bash script.
In this example, the ceph status
command is executed when the job is created. Create the toolbox job:
After the job completes, see the results of the script: