Skip to content
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

Merged
merged 2 commits into from
Mar 19, 2025

Conversation

lentzi90
Copy link
Member

@lentzi90 lentzi90 commented Dec 13, 2024

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

Signed-off-by: Lennart Jern <lennart.jern@est.tech>
@metal3-io-bot metal3-io-bot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Dec 13, 2024
@lentzi90 lentzi90 force-pushed the lentzi90/troubleshooting branch from 6a0118a to b0357a5 Compare December 13, 2024 14:05
@lentzi90
Copy link
Member Author

/cc @dtantsur

@lentzi90 lentzi90 mentioned this pull request Dec 13, 2024
6 tasks
Copy link
Member

@tuminoid tuminoid left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit.

@lentzi90 lentzi90 force-pushed the lentzi90/troubleshooting branch from b0357a5 to f06cb29 Compare December 16, 2024 10:57
@lentzi90 lentzi90 requested a review from tuminoid January 13, 2025 12:29
Copy link
Member

@tuminoid tuminoid left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/lgtm

@metal3-io-bot metal3-io-bot added the lgtm Indicates that a PR is ready to be merged. label Jan 14, 2025
@@ -0,0 +1,72 @@
# Troubleshooting

## Verify that Ironic and Baremetal Operator are healthy
Copy link
Member

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?

Copy link
Member Author

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?

@lentzi90 lentzi90 force-pushed the lentzi90/troubleshooting branch from f06cb29 to 14edab6 Compare January 14, 2025 11:34
@metal3-io-bot metal3-io-bot removed the lgtm Indicates that a PR is ready to be merged. label Jan 14, 2025
@lentzi90 lentzi90 requested review from dtantsur and tuminoid January 22, 2025 06:33
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>
@lentzi90 lentzi90 force-pushed the lentzi90/troubleshooting branch from 14edab6 to 7526890 Compare February 14, 2025 06:46
@lentzi90 lentzi90 requested a review from dtantsur March 7, 2025 13:53
@tuminoid
Copy link
Member

/cc @elfosardo @dtantsur
Have we agreed how its going going to be setup?

@metal3-io-bot metal3-io-bot requested a review from elfosardo March 14, 2025 11:07
@dtantsur
Copy link
Member

/approve

I have some doubts about the format, but the new text is a clear improvement, so let's merge it.

@metal3-io-bot
Copy link
Contributor

[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 /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@metal3-io-bot metal3-io-bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Mar 19, 2025
Copy link
Member

@Rozzii Rozzii left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/lgtm

@metal3-io-bot metal3-io-bot added the lgtm Indicates that a PR is ready to be merged. label Mar 19, 2025
@metal3-io-bot metal3-io-bot merged commit 137f300 into metal3-io:main Mar 19, 2025
8 checks passed
@metal3-io-bot metal3-io-bot deleted the lentzi90/troubleshooting branch March 19, 2025 14:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. lgtm Indicates that a PR is ready to be merged. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants