-
Notifications
You must be signed in to change notification settings - Fork 118
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Troubleshooting: Verify BMO and Ironic healthy #490
Troubleshooting: Verify BMO and Ironic healthy #490
Conversation
Signed-off-by: Lennart Jern <lennart.jern@est.tech>
6a0118a
to
b0357a5
Compare
/cc @dtantsur |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nit.
b0357a5
to
f06cb29
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
/lgtm
@@ -0,0 +1,72 @@ | |||
# Troubleshooting | |||
|
|||
## Verify that Ironic and Baremetal Operator are healthy |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Honestly, I liked the FAQ format where each title is how a user would google it. Like, what would prompt an operator to look at this section you're adding?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sure, I also like that format, but I know also that an unhealthy Ironic or BMO could show itself in probably dozens of ways. It is more of a sanity check and something I would expect to direct users to when they are having issues that are hard to pinpoint. So I think it is important to have this somewhere. If you want, we can split this into troubleshooting and FAQ maybe?
f06cb29
to
14edab6
Compare
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 <lennart.jern@est.tech>
14edab6
to
7526890
Compare
/cc @elfosardo @dtantsur |
/approve I have some doubts about the format, but the new text is a clear improvement, so let's merge it. |
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: dtantsur The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
/lgtm
Add section on how to verify that BMO and Ironic are healthy as well as
example output for both healthy and unhealthy examples.
I also moved the troubleshooting doc to the top level. My reasoning for this is that users may not know at what level an error is. They need a single place to search instead of first having to figure out if the issue belongs under BMO or CAPM3 or something else.
Part of #435