-
Notifications
You must be signed in to change notification settings - Fork 23
docs: Add instructions for Ceph shutdown #1831
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
Conversation
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.
Summary of Changes
Hello @Alex-Welsh, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
This pull request enhances the control-plane-operation.rst
documentation by providing detailed instructions for safely shutting down a Ceph cluster. The update addresses a previous sparsity in the guide, offering a clear, step-by-step process to assist clients with planned full system shutdowns. The changes aim to ensure data integrity and smooth operation during maintenance periods by outlining critical pre-shutdown checks and proper shutdown sequences.
Highlights
- Ceph Shutdown Documentation: Added a comprehensive, step-by-step guide for safely shutting down a Ceph cluster, including checks for cluster health, stopping clients, setting the
noout
flag, and the order of node shutdown. - Updated External Reference: Replaced an outdated Red Hat documentation link with a more relevant blog post from croit.io on Ceph shutdown best practices.
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command>
or @gemini-code-assist <command>
. Below is a summary of the supported commands.
Feature | Command | Description |
---|---|---|
Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/
folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
Footnotes
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
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.
Code Review
This pull request adds much-needed documentation for shutting down a Ceph cluster. The instructions are a good start. I've provided a few suggestions to improve clarity and correctness. Specifically, I've pointed out a small typo, recommended adding the explicit command for setting the noout
flag for better usability, and highlighted a critical omission regarding the need to unset the noout
flag during startup to ensure the cluster returns to a healthy state. Addressing these points will make the documentation more complete and safer for operators.
2fb968f
to
ebce613
Compare
ebce613
to
fad4f9b
Compare
fad4f9b
to
722cc7e
Compare
fee72cd
to
5670f0d
Compare
Co-authored-by: Matt Crees <mattc@stackhpc.com> Co-authored-by: Piotr Parczewski <19818516+cityofships@users.noreply.github.com>
5670f0d
to
66588b8
Compare
Client has a full shutdown coming up, which they are handling themselves. Most of the guide is fine but the Ceph section was quite sparse.
Renderd outupt:
