-
Notifications
You must be signed in to change notification settings - Fork 1.9k
[OSDOCS#17598]: Added new module for removing device and device classes for 4.21 #105230
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
base: main
Are you sure you want to change the base?
[OSDOCS#17598]: Added new module for removing device and device classes for 4.21 #105230
Conversation
ae9b28f to
f6eb9a7
Compare
|
🤖 Thu Jan 22 15:39:59 - Prow CI generated the docs preview: |
|
@bjahagir-OpenShift: all tests passed! Full PR test history. Your PR dashboard. DetailsInstructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here. |
|
@qJkee and @mmakwana30 - This is the new PR for addition of new topic Removal of devices and device classes from LVMS. Kindly review. |
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.
Overall looks pretty good. Some suggestions. I assume that this is one of your first/early PRs so nice job.
Make sure that the WARNINGS need to be warnings and not IMPORTANT; I'm not sure how this CR works really. Here's the link to the differences:
https://redhat-documentation.github.io/supplementary-style-guide/#admonitions
You could also do something like make "Removing the device paths in the deviceSelector.paths field" a level 2 subheading under "About removing devices and device classes from a volume group". For example:
= About removing devices and device classes from a volume group
== Removing the device paths in the deviceSelector.paths field
== Removing the deviceClass from the LVMCluster
in the same module. It's kind of up to you. Just an idea.
This will need QE ack before I can merge.
| ==== | ||
| Ensure that the device you want to remove is empty. You can use the `pvdisplay` command to see attributes of physical volumes (PVs) used in LVM | ||
| There is at least one more device specified in the `deviceSelector.paths` field. |
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.
This is a sentence fragment. These types of fragments are OK for prerequisite sections or even as bullet points, but in this WARNING admonition it's a little off. I suggest rewording it slightly and adding bullet points:
| There is at least one more device specified in the `deviceSelector.paths` field. | |
| [WARNING] | |
| ==== | |
| Ensure that the following criteria are met before removing device paths: | |
| * The device that you want to remove is empty. You can use the `pvdisplay` command to view attributes of physical volumes (PVs) used in LVM. | |
| * At least one additional device is specified in the `deviceSelector.paths` field. | |
| ==== |
Note the period at the end of the first sentence, which is missing on line 17.
|
|
||
| [role="_abstract"] | ||
|
|
||
| The `deviceSelector` field in the `LVMCluster` CR contains the configuration to specify the paths to the devices that you can remove from the Logical Volume Manager (LVM) volume group. |
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.
Backspace this line up so that it sits on line 10. I'm not 100% sure how the tagging will work in DITA but just to be safe...
| The `deviceSelector` field in the `LVMCluster` CR contains the configuration to specify the paths to the devices that you can remove from the Logical Volume Manager (LVM) volume group. | |
| [role="_abstract"] | |
| The `deviceSelector` field in the `LVMCluster` CR contains the configuration to specify the paths to the devices that you can remove from the Logical Volume Manager (LVM) volume group. |
| ==== | ||
|
|
||
| You can also remove the deviceClass from the `LVMCluster`. For device class deletion, there is no need to delete `deviceSelector.paths`. |
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.
We generally follow items that are in backticks with nouns. For example:
| You can also remove the deviceClass from the `LVMCluster`. For device class deletion, there is no need to delete `deviceSelector.paths`. | |
| You can also remove the `deviceClass` object from the `LVMCluster` resource. For device class deletion, there is no need to delete `deviceSelector.paths` object. |
|
|
||
| [WARNING] | ||
| ==== | ||
| Ensure that the `deviceClasses.default` is set to `false`. |
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.
Same suggestion as above:
| Ensure that the `deviceClasses.default` is set to `false`. | |
| [WARNING] | |
| ==== | |
| Ensure that the following criteria are met before removing a device class: | |
| * The `deviceClasses.default` field is set to `false`. | |
| * The disks specified in the `deviceSelector.paths` field are empty. | |
| * At least one additional device class is specified in the `storage` field. | |
| ==== |
Version(s):
4.21
Issue:
https://issues.redhat.com/browse/OSDOCS-17598
https://issues.redhat.com/browse/OCPSTRAT-1698
Link to docs preview:
https://105230--ocpdocs-pr.netlify.app/openshift-enterprise/latest/storage/persistent_storage_local/persistent-storage-using-lvms.html#about-removing-devices-deviceclasses-from-a-vg_logical-volume-manager-storage
QE review:
Additional information: