openshift-docs icon indicating copy to clipboard operation
openshift-docs copied to clipboard

CNV#28092: Added procedure to run storage checkup

Open sjhala-ccs opened this issue 1 year ago • 17 comments
trafficstars

Version(s): 4.15+

Issue: CNV-28092

Link to docs preview: https://73695--ocpdocs-pr.netlify.app/openshift-enterprise/latest/virt/monitoring/virt-running-cluster-checkups#virt-checking-storage-configuration_virt-running-cluster-checkups

QE review:

  • [ ] QE has approved this change.

sjhala-ccs avatar Mar 25 '24 15:03 sjhala-ccs

@sjhala-ccs: This pull request references CNV-28092 which is a valid jira issue.

Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the story to target the "4.16.0" version, but no target version was set.

In response to this:

Version(s): 4.15+

Issue: CNV-28092

Link to docs preview:

QE review:

  • [ ] QE has approved this change.

Instructions 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 openshift-eng/jira-lifecycle-plugin repository.

openshift-ci-robot avatar Mar 25 '24 15:03 openshift-ci-robot

@sjhala-ccs: This pull request references CNV-28092 which is a valid jira issue.

Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the story to target the "4.16.0" version, but no target version was set.

In response to this:

Version(s): 4.15+

Issue: CNV-28092

Link to docs preview:

QE review:

  • [ ] QE has approved this change.

Instructions 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 openshift-eng/jira-lifecycle-plugin repository.

openshift-ci-robot avatar Mar 25 '24 15:03 openshift-ci-robot

@sjhala-ccs: No Jira issue is referenced in the title of this pull request. To reference a jira issue, add 'XYZ-NNN:' to the title of this pull request and request another refresh with /jira refresh.

In response to this:

Version(s): 4.15+

Issue: CNV-28092

Link to docs preview:

QE review:

  • [ ] QE has approved this change.

Instructions 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 openshift-eng/jira-lifecycle-plugin repository.

openshift-ci-robot avatar Mar 25 '24 15:03 openshift-ci-robot

🤖 Wed May 22 11:47:34 - Prow CI generated the docs preview:

https://73695--ocpdocs-pr.netlify.app/openshift-dedicated/latest/virt/monitoring/virt-monitoring-overview.html https://73695--ocpdocs-pr.netlify.app/openshift-enterprise/latest/virt/monitoring/virt-monitoring-overview.html https://73695--ocpdocs-pr.netlify.app/openshift-enterprise/latest/virt/monitoring/virt-running-cluster-checkups.html https://73695--ocpdocs-pr.netlify.app/openshift-rosa/latest/virt/monitoring/virt-monitoring-overview.html

ocpdocs-previewbot avatar Mar 25 '24 15:03 ocpdocs-previewbot

/retest

sjhala-ccs avatar Mar 25 '24 20:03 sjhala-ccs

/retest

sjhala-ccs avatar Mar 26 '24 13:03 sjhala-ccs

@arnongilboa Can you please review again?

sjhala-ccs avatar Apr 23 '24 17:04 sjhala-ccs

/lgtm

arnongilboa avatar Apr 30 '24 12:04 arnongilboa

/remove-label peer-review-needed

/label peer-review-in-progress

dfitzmau avatar Apr 30 '24 15:04 dfitzmau

Hi @sjhala-ccs . Nice work. I added comments inline. Some will need to be addressed before the merge review can take a look. Such as: Steps documented outside a procedure subheading and the YAML colouring.

dfitzmau avatar Apr 30 '24 16:04 dfitzmau

/remove-label peer-review-in-progress

/label peer-review-done

As all my comments are resolved, I'll take it that the red text under the data: segment for the Example output config map (success) is expected? Also the steps at the start of the "Running a storage checkup" section are intended (although they should belong in their own procedure)?

dfitzmau avatar May 07 '24 08:05 dfitzmau

As all my comments are resolved, I'll take it that the red text under the data: segment for the Example output config map (success) is expected? Also the steps at the start of the "Running a storage checkup" section are intended (although they should belong in their own procedure)?

@dfitzmau I pushed the updates incorporating your review comments. As mentioned in my responses to your comments, I have removed the steps at the start of the procedure. I also added the subs="attributes+", but the color issue is still not resolved.

sjhala-ccs avatar May 07 '24 14:05 sjhala-ccs

spec.timeout: 10m

Hi @sjhala-ccs . I checked the other examples and it looks like values for the data parameter do render in red, so all is good here. Please ignore the YAML color query. When I check the preview link, I still see:

Screenshot from 2024-05-07 15-42-25

dfitzmau avatar May 07 '24 14:05 dfitzmau

spec.timeout: 10m

Hi @sjhala-ccs . I checked the other examples and it looks like values for the data parameter do render in red, so all is good here. Please ignore the YAML color query. When I check the preview link, I still see:

Screenshot from 2024-05-07 15-42-25

These steps could be dropped as this is arleady what's happening in the procedure. Given the short size of the module, I do not think summarizing the steps in the opening section of the module is necessary.

dfitzmau avatar May 07 '24 14:05 dfitzmau

These steps could be dropped as this is arleady what's happening in the procedure. Given the short size of the module, I do not think summarizing the steps in the opening section of the module is necessary.

I only added the storage checkup procedure as part of this PR. I have removed the summary steps from that procedure.

sjhala-ccs avatar May 07 '24 15:05 sjhala-ccs

@sjhala-ccs: all tests passed!

Full PR test history. Your PR dashboard.

Instructions 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.

openshift-ci[bot] avatar May 22 '24 11:05 openshift-ci[bot]

/lgtm

duyanyan avatar May 22 '24 13:05 duyanyan

/cherrypick enterprise-4.15

sjhala-ccs avatar May 22 '24 14:05 sjhala-ccs

/cherrypick enterprise-4.16

sjhala-ccs avatar May 22 '24 14:05 sjhala-ccs

@sjhala-ccs: new pull request created: #76351

In response to this:

/cherrypick enterprise-4.15

Instructions 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.

@sjhala-ccs: new pull request created: #76352

In response to this:

/cherrypick enterprise-4.16

Instructions 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.