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

Update debug to maintenance #252

Merged
merged 3 commits into from
Mar 1, 2024

Conversation

subhamkrai
Copy link
Collaborator

Description of your changes:
maintenance: update debug cmd to maintenance cmd

debug command can be confusing for users so after discussion with
team we are changing it to maintenance command.

mons: update restore-quorum logs and docs

since updating debug to maintenance, it requires
changing in the mons restore command as it used debug mode
or maintenance mode for restoring mons.

Which issue is resolved by this Pull Request:
Resolves #

Checklist:

  • Commit Message Formatting: Commit titles and messages follow guidelines in the developer guide.
  • Reviewed the developer guide on Submitting a Pull Request
  • CI tests has been updated, if necessary.
  • Documentation has been updated, if necessary.
  • Unit tests have been added, if necessary.

Copy link
Member

@travisn travisn left a comment

Choose a reason for hiding this comment

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

Looks good, just a couple nits

docs/mons.md Outdated
Info: The mons to discard are: b a
Info: Are you sure you want to restore the quorum to mon "c"? If so, enter: yes-really-restore
# Info: mon c state is leader
# mon=b, endpoint=192.168.64.168:6789
Copy link
Member

Choose a reason for hiding this comment

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

Do all of these lines have the # prefix? I thought some output lines don't have it.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

# prefix is only to separate output from commands. We don't add # in front of the command output.

Copy link
Member

Choose a reason for hiding this comment

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

I'd suggest if there are commands in the same block with the output, the command would have the $ prefix, while the output is exactly as we see it in the console. I thought this was the pattern for the rook docs, which we could follow here as well.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I have removed # from the output now and slowly going in the future I feel maintaining the long output will become maintenance burden

Copy link
Member

Choose a reason for hiding this comment

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

Yeah let's discuss about long term

@subhamkrai subhamkrai force-pushed the update-debug-to-maintenance branch from 995ed50 to 35d4ded Compare February 28, 2024 05:45
@subhamkrai subhamkrai requested a review from travisn February 28, 2024 05:45
@subhamkrai subhamkrai force-pushed the update-debug-to-maintenance branch from 35d4ded to bc17078 Compare February 28, 2024 05:48
debug command can be confusing for users so after discussion with
team we are changing it to maintenance command.

Signed-off-by: subhamkrai <[email protected]>
@subhamkrai subhamkrai force-pushed the update-debug-to-maintenance branch from bc17078 to 94c521d Compare February 29, 2024 04:14
Copy link
Member

@travisn travisn left a comment

Choose a reason for hiding this comment

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

Just a couple more formatting nits, I'll approve for you to merge after that

docs/mons.md Outdated
Info: Mon quorum was successfully restored to mon c
Info: Only a single mon is currently running
Info: Press Enter to start the operator and expand to full mon quorum again
Error: failed to run command. failed to run command. command terminated with exit code 1%!(EXTRA string=failed to get the status of ceph cluster)
Copy link
Member

Choose a reason for hiding this comment

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

Formatting error in the output

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

updating this fixed the issue

docs/mons.md Outdated
Info: The mons to discard are: b a
Info: Are you sure you want to restore the quorum to mon "c"? If so, enter: yes-really-restore
# Info: mon c state is leader
# mon=b, endpoint=192.168.64.168:6789
Copy link
Member

Choose a reason for hiding this comment

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

Yeah let's discuss about long term

since updating debug to maintenance, it requires
changing in mons restore command as it used debug mode
or maintenance mode for restoring mons.

Signed-off-by: subhamkrai <[email protected]>
let's add 'maintenance' as commitlint title
to make bot happy and also updating ci tests.

Signed-off-by: subhamkrai <[email protected]>
@subhamkrai subhamkrai force-pushed the update-debug-to-maintenance branch from 94c521d to 273b8e5 Compare March 1, 2024 07:46
@subhamkrai subhamkrai merged commit 2862dc9 into rook:master Mar 1, 2024
6 checks passed
@subhamkrai subhamkrai deleted the update-debug-to-maintenance branch March 1, 2024 08:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants