Skip to content

Commit 4ed4c04

Browse files
committed
docs: clean topics section of ceph troubleshooting guide
The topics section of the ceph common problems troubleshooting guide contained many subsection entries for symptoms, investigation and solution. Apart from not having working links, these subsection entries don't add any real value: They are well visible within the overarching section and in the toc on the right side. This change cleans the toc by removing these unnecessary subsection entries. This also reduces the number of nonexisting anchor messages of make docs-build from 50 to 18. Signed-off-by: Michael Adam <obnox@samba.org>
1 parent 9af029d commit 4ed4c04

1 file changed

Lines changed: 4 additions & 46 deletions

File tree

Documentation/Troubleshooting/ceph-common-issues.md

Lines changed: 4 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -10,66 +10,24 @@ title: Ceph Common Issues
1010

1111
- [Troubleshooting Techniques](#troubleshooting-techniques)
1212
- [Ceph Tools](#ceph-tools)
13-
- [Tools in the Rook Toolbox](#tools-in-the-rook-toolbox)
14-
- [Ceph Commands](#ceph-commands)
13+
- [Tools in the Rook Toolbox](#tools-in-the-rook-toolbox)
14+
- [Ceph Commands](#ceph-commands)
1515
- [Cluster failing to service requests](#cluster-failing-to-service-requests)
16-
- [Symptoms](#symptoms)
17-
- [Investigation](#investigation)
18-
- [Solution](#solution)
1916
- [Monitors are the only pods running](#monitors-are-the-only-pods-running)
20-
- [Symptoms](#symptoms-1)
21-
- [Investigation](#investigation-1)
22-
- [Operator fails to connect to the mon](#operator-fails-to-connect-to-the-mon)
23-
- [Solution](#solution-1)
24-
- [Failing mon pod](#failing-mon-pod)
25-
- [Solution](#solution-2)
2617
- [PVCs stay in pending state](#pvcs-stay-in-pending-state)
27-
- [Symptoms](#symptoms-2)
28-
- [Investigation](#investigation-2)
29-
- [Confirm if there are OSDs](#confirm-if-there-are-osds)
30-
- [OSD Prepare Logs](#osd-prepare-logs)
31-
- [CSI Driver](#csi-driver)
32-
- [Operator unresponsiveness](#operator-unresponsiveness)
33-
- [Solution](#solution-3)
3418
- [OSD pods are failing to start](#osd-pods-are-failing-to-start)
35-
- [Symptoms](#symptoms-3)
36-
- [Investigation](#investigation-3)
37-
- [Solution](#solution-4)
3819
- [OSD pods are not created on my devices](#osd-pods-are-not-created-on-my-devices)
39-
- [Symptoms](#symptoms-4)
40-
- [Investigation](#investigation-4)
41-
- [Solution](#solution-5)
4220
- [Node hangs after reboot](#node-hangs-after-reboot)
43-
- [Symptoms](#symptoms-5)
44-
- [Investigation](#investigation-5)
45-
- [Solution](#solution-6)
4621
- [Using multiple shared filesystem (CephFS) is attempted on a kernel version older than 4.7](#using-multiple-shared-filesystem-cephfs-is-attempted-on-a-kernel-version-older-than-47)
47-
- [Symptoms](#symptoms-6)
48-
- [Solution](#solution-7)
4922
- [Set debug log level for all Ceph daemons](#set-debug-log-level-for-all-ceph-daemons)
5023
- [Activate log to file for a particular Ceph daemon](#activate-log-to-file-for-a-particular-ceph-daemon)
5124
- [A worker node using RBD devices hangs up](#a-worker-node-using-rbd-devices-hangs-up)
52-
- [Symptoms](#symptoms-7)
53-
- [Investigation](#investigation-6)
54-
- [Solution](#solution-8)
5525
- [Too few PGs per OSD warning is shown](#too-few-pgs-per-osd-warning-is-shown)
56-
- [Symptoms](#symptoms-8)
57-
- [Solution](#solution-9)
5826
- [LVM metadata can be corrupted with OSD on LV-backed PVC](#lvm-metadata-can-be-corrupted-with-osd-on-lv-backed-pvc)
59-
- [Symptoms](#symptoms-9)
60-
- [Solution](#solution-10)
6127
- [OSD prepare job fails due to low aio-max-nr setting](#osd-prepare-job-fails-due-to-low-aio-max-nr-setting)
6228
- [Unexpected partitions created](#unexpected-partitions-created)
63-
- [Symptoms](#symptoms-10)
64-
- [Solution](#solution-11)
65-
- [Recover from corruption (v1.6.0-v1.6.7)](#recover-from-corruption-v160-v167)
6629
- [Operator environment variables are ignored](#operator-environment-variables-are-ignored)
67-
- [Symptoms](#symptoms-11)
68-
- [Investigation](#investigation-7)
69-
- [Solution](#solution-12)
7030
- [The cluster is in an unhealthy state or fails to configure when LimitNOFILE=infinity in containerd](#the-cluster-is-in-an-unhealthy-state-or-fails-to-configure-when-limitnofileinfinity-in-containerd)
71-
- [Symptoms](#symptoms-12)
72-
- [Solution](#solution-13)
7331

7432

7533
Many of these problem cases are hard to summarize down to a short phrase that adequately describes the problem. Each problem will start with a bulleted list of symptoms. Keep in mind that all symptoms may not apply depending on the configuration of Rook. If the majority of the symptoms are seen there is a fair chance you are experiencing that problem.
@@ -94,15 +52,15 @@ After you verify the basic health of the running pods, next you will want to run
9452
* Other artifacts:
9553
* The monitors that are expected to be in quorum: `kubectl -n <cluster-namespace> get configmap rook-ceph-mon-endpoints -o yaml | grep data`
9654

97-
#### Tools in the Rook Toolbox
55+
### Tools in the Rook Toolbox
9856

9957
The [rook-ceph-tools pod](ceph-toolbox.md) provides a simple environment to run Ceph tools. Once the pod is up and running, connect to the pod to execute Ceph commands to evaluate that current state of the cluster.
10058

10159
```console
10260
kubectl -n rook-ceph exec -it $(kubectl -n rook-ceph get pod -l "app=rook-ceph-tools" -o jsonpath='{.items[*].metadata.name}') -- bash
10361
```
10462

105-
#### Ceph Commands
63+
### Ceph Commands
10664

10765
Here are some common commands to troubleshoot a Ceph cluster:
10866

0 commit comments

Comments
 (0)