Skip to content

Commit f06cb29

Browse files
committed
Add troubleshooting BMO/Ironic healthy
Add section on how to verify that BMO and Ironic are healthy as well as example output for both healthy and unhealthy examples. Signed-off-by: Lennart Jern <[email protected]>
1 parent 0df8a0d commit f06cb29

File tree

1 file changed

+41
-1
lines changed

1 file changed

+41
-1
lines changed

docs/user-guide/src/troubleshooting.md

+41-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,45 @@
11
# Troubleshooting
22

3+
## Verify that Ironic and Baremetal Operator are healthy
4+
5+
There is no point continuing before you have verified that the controllers are
6+
healthy. A "standard" deployment will have Ironic and Baremetal Operator running
7+
in the `baremetal-operator-system` namespace. Check that the containers are
8+
running, not restarting or crashing:
9+
10+
```bash
11+
kubectl -n baremetal-operator-system get pods
12+
```
13+
14+
Note: If you deploy Ironic outside of Kubernetes you will need to check on it in
15+
a different way.
16+
17+
Healthy example output:
18+
19+
```text
20+
NAME READY STATUS RESTARTS AGE
21+
baremetal-operator-controller-manager-85b896f688-j27g5 1/1 Running 0 5m13s
22+
ironic-6bcdcb99f8-6ldlz 3/3 Running 1 (2m2s ago) 5m15s
23+
```
24+
25+
(There has been one restart, but it is not constantly restarting.)
26+
27+
Unhealthy example output:
28+
29+
```text
30+
NAME READY STATUS RESTARTS AGE
31+
baremetal-operator-controller-manager-85b896f688-j27g5 1/1 Running 0 3m35s
32+
ironic-6bcdcb99f8-6ldlz 1/3 Running 1 (24s ago) 3m37s
33+
```
34+
35+
### Waiting for IP
36+
37+
Make sure to check the logs also since Ironic may be stuck on "waiting for IP".
38+
39+
```bash
40+
kubectl -n baremetal-operator-system logs deploy/ironic
41+
```
42+
343
## Host is stuck in cleaning, how do I delete it?
444

545
First and foremost, avoid using forced deletion, otherwise you'll have [a
@@ -18,7 +58,7 @@ it does not finish.
1858
1959
## MAC address conflict on registration
2060
21-
If you force deletion of a host after registration, BareMetal Operator will not
61+
If you force deletion of a host after registration, Baremetal Operator will not
2262
be able to delete the corresponding record from Ironic. If you try to enroll
2363
the same host again, you will see the following error:
2464

0 commit comments

Comments
 (0)