From fdc2aecddb41894d6c40836d82300b4ada6d9e60 Mon Sep 17 00:00:00 2001 From: Timoses Date: Thu, 26 May 2022 16:40:34 +0200 Subject: [PATCH] docs: improve Upgrade Health verification page * Make "Status Output" command directly usable on a copy-and-paste basis * Link to 'Rook toolbox' which can be helpful if somebody does not have a toolbox running Signed-off-by: Timoses --- Documentation/Upgrade/health-verification.md | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/Documentation/Upgrade/health-verification.md b/Documentation/Upgrade/health-verification.md index 15475c148..ecbca6ae2 100644 --- a/Documentation/Upgrade/health-verification.md +++ b/Documentation/Upgrade/health-verification.md @@ -26,12 +26,16 @@ kubectl -n $ROOK_CLUSTER_NAMESPACE get pods ### **Status Output** -The Rook toolbox contains the Ceph tools that can give you status details of the cluster with the +The [Rook toolbox](../Troubleshooting/ceph-toolbox.md) contains the Ceph tools that can give you status details of the cluster with the `ceph status` command. Let's look at an output sample and review some of the details: ```console -$ TOOLS_POD=$(kubectl -n $ROOK_CLUSTER_NAMESPACE get pod -l "app=rook-ceph-tools" -o jsonpath='{.items[*].metadata.name}') -$ kubectl -n $ROOK_CLUSTER_NAMESPACE exec -it $TOOLS_POD -- ceph status +TOOLS_POD=$(kubectl -n $ROOK_CLUSTER_NAMESPACE get pod -l "app=rook-ceph-tools" -o jsonpath='{.items[*].metadata.name}') +kubectl -n $ROOK_CLUSTER_NAMESPACE exec -it $TOOLS_POD -- ceph status +``` + +The output should look similar to the following: +``` cluster: id: a3f4d647-9538-4aff-9fd1-b845873c3fe9 health: HEALTH_OK