Skip to content

TELCODOCS-1932: Implement post-GA SME feedback #78439

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 1 commit into from
Aug 6, 2024
Merged

TELCODOCS-1932: Implement post-GA SME feedback #78439

merged 1 commit into from
Aug 6, 2024

Conversation

@amolnar-gh
Copy link
Contributor

@amolnar-gh amolnar-gh commented Jul 3, 2024 •
edited
Loading

Version(s): 4.16, 4.17

Issue: https://issues.redhat.com/browse/TELCODOCS-1932

Link to docs preview:

QE review:

  • QE has approved this change.

Additional information:

@openshift-ci-robot openshift-ci-robot added the jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. label Jul 3, 2024
@openshift-ci-robot
Copy link

openshift-ci-robot commented Jul 3, 2024 •
edited by openshift-ci bot
Loading

@amolnar-rh: This pull request references TElCODOCS-1707 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.17.0" version, but no target version was set.

In response to this:

Version(s): 4.16, 4.17

Issue: https://issues.redhat.com/browse/TELCODOCS-1707

Link to docs preview:

QE review:

  • QE has approved this change.

Additional information:

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 openshift-ci bot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Jul 3, 2024
amolnar-gh
amolnar-gh commented Jul 3, 2024
View reviewed changes
@ocpdocs-previewbot
Copy link

ocpdocs-previewbot commented Jul 3, 2024 •
edited
Loading

🤖 Tue Aug 06 14:45:56 - Prow CI generated the docs preview:

https://78439--ocpdocs-pr.netlify.app/openshift-enterprise/latest/edge_computing/image_based_upgrade/cnf-image-based-upgrade-base.html
https://78439--ocpdocs-pr.netlify.app/openshift-enterprise/latest/edge_computing/image_based_upgrade/cnf-understanding-image-based-upgrade.html
https://78439--ocpdocs-pr.netlify.app/openshift-enterprise/latest/edge_computing/image_based_upgrade/preparing_for_image_based_upgrade/cnf-image-based-upgrade-generate-seed.html
https://78439--ocpdocs-pr.netlify.app/openshift-enterprise/latest/edge_computing/image_based_upgrade/preparing_for_image_based_upgrade/cnf-image-based-upgrade-shared-container-partition.html
https://78439--ocpdocs-pr.netlify.app/openshift-enterprise/latest/edge_computing/image_based_upgrade/ztp-image-based-upgrade.html

@openshift-ci-robot
Copy link

openshift-ci-robot commented Jul 4, 2024 •
edited by openshift-ci bot
Loading

@amolnar-rh: This pull request references TElCODOCS-1707 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.17.0" version, but no target version was set.

In response to this:

Version(s): 4.16, 4.17

Issue: https://issues.redhat.com/browse/TELCODOCS-1932

Link to docs preview:

QE review:

  • QE has approved this change.

Additional information:

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.

@amolnar-gh amolnar-gh changed the title TElCODOCS-1707: Implement post-GA SME feedback TELCODOCS-1932: Implement post-GA SME feedback Jul 4, 2024
@openshift-ci-robot
Copy link

openshift-ci-robot commented Jul 4, 2024 •
edited by openshift-ci bot
Loading

@amolnar-rh: This pull request references TELCODOCS-1932 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 bug to target the "4.17.0" version, but no target version was set.

In response to this:

Version(s): 4.16, 4.17

Issue: https://issues.redhat.com/browse/TELCODOCS-1932

Link to docs preview:

QE review:

  • QE has approved this change.

Additional information:

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.

@amolnar-gh amolnar-gh mentioned this pull request Jul 4, 2024
Closed
1 task
@amolnar-gh amolnar-gh force-pushed the TELCODOCS-1707-post-ga-feedback branch from ae7437d to 89e43d0 Compare July 4, 2024 14:26
@openshift-merge-robot openshift-merge-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Jul 13, 2024
@amolnar-gh amolnar-gh force-pushed the TELCODOCS-1707-post-ga-feedback branch from 89e43d0 to e4dbe26 Compare July 18, 2024 10:18
@openshift-merge-robot openshift-merge-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Jul 18, 2024
@amolnar-gh amolnar-gh force-pushed the TELCODOCS-1707-post-ga-feedback branch 4 times, most recently from 597bd22 to 862dc0f Compare July 19, 2024 12:33
Missxiaoguo
Missxiaoguo reviewed Jul 19, 2024
View reviewed changes
@amolnar-gh amolnar-gh force-pushed the TELCODOCS-1707-post-ga-feedback branch from 862dc0f to 13c6158 Compare July 19, 2024 12:59
@Missxiaoguo
Copy link

Missxiaoguo commented Jul 19, 2024

/lgtm

@openshift-ci openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. label Jul 19, 2024
mpmaruthu
mpmaruthu reviewed Jul 22, 2024
View reviewed changes
@openshift-ci openshift-ci bot removed the lgtm Indicates that a PR is ready to be merged. label Jul 22, 2024
@openshift-ci
Copy link

openshift-ci bot commented Jul 22, 2024

New changes are detected. LGTM label has been removed.

@openshift-ci-robot
Copy link

openshift-ci-robot commented Jul 22, 2024 •
edited by openshift-ci bot
Loading

@amolnar-rh: This pull request references TELCODOCS-1932 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 bug to target the "4.17.0" version, but no target version was set.

In response to this:

Version(s): 4.16, 4.17

Issue: https://issues.redhat.com/browse/TELCODOCS-1932

Link to docs preview:

QE review:

  • QE has approved this change.

Additional information:

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.

@amolnar-gh
Copy link
Contributor Author

amolnar-gh commented Jul 22, 2024

/label peer-review-needed

@openshift-ci openshift-ci bot added the peer-review-needed Signifies that the peer review team needs to review this PR label Jul 22, 2024
@abrennan89 abrennan89 added peer-review-in-progress Signifies that the peer review team is reviewing this PR and removed peer-review-needed Signifies that the peer review team needs to review this PR labels Jul 22, 2024
@abrennan89 abrennan89 self-requested a review July 22, 2024 15:22
@abrennan89 abrennan89 added this to the Continuous Release milestone Jul 22, 2024
abrennan89
abrennan89 reviewed Jul 22, 2024
View reviewed changes
Copy link
Contributor

@abrennan89 abrennan89 left a comment

Choose a reason for hiding this comment

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

A couple of comments / suggestions

modules/cnf-image-based-upgrade-backup-guide.adoc Outdated
There are two local storage implementations for {sno}:

Local Storage Operator (LSO):: The {lcao} backs up and restores the required artifacts, including `LocalVolumes` and their associated `StorageClasses`. You must exclude the `persistentVolumes` resource in the application `Backup` CR.
Local Storage Operator (LSO):: The {lcao} automatically backs up and restores the required artifacts, including `LocalVolumes` and their associated `StorageClasses`. You must exclude the `persistentVolumes` resource in the application `Backup` CR.
Copy link
Contributor

@abrennan89 abrennan89 Jul 22, 2024

Choose a reason for hiding this comment

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

Suggested change
Local Storage Operator (LSO):: The {lcao} automatically backs up and restores the required artifacts, including `LocalVolumes` and their associated `StorageClasses`. You must exclude the `persistentVolumes` resource in the application `Backup` CR.
Local Storage Operator (LSO):: The {lcao} automatically backs up and restores the required artifacts, including `LocalVolume` resources and their associated `StorageClass` resources. You must exclude the `PersistentVolumes` resource in the application `Backup` CR.

I think "LocalVolume resources" and "StorageClass resources" should be formatted this way, per https://github.com/openshift/openshift-docs/blob/main/contributing_to_docs/doc_guidelines.adoc#object-references:
image

Also, I think PersistentVolumes should be capitalized, per other references, for example: https://kubernetes.io/docs/concepts/storage/persistent-volumes/#reserving-a-persistentvolume and https://docs.openshift.com/container-platform/4.16/storage/persistent_storage/persistent_storage_local/persistent-storage-local.html#local-create-cr-manual_persistent-storage-local

Copy link
Contributor Author

@amolnar-gh amolnar-gh Jul 24, 2024

Choose a reason for hiding this comment

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

Re capitalization:
I'm not sure that in the Backup/Restore CRs you need to capitalize the resource names. Here's where the examples are from: https://github.com/openshift-kni/lifecycle-agent/blob/main/docs/backuprestore-with-oadp.md#application-backup-and-restore-crs

@Missxiaoguo Could you please take a look and confirm whether we need to capitalize in this case?

Copy link

@Missxiaoguo Missxiaoguo Jul 26, 2024

Choose a reason for hiding this comment

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

The resources in the Backup/Restore CR could be either capitalized or not. For example, all of these should work.

  names:
    kind: LocalVolume
    plural: localvolumes
    singular: localvolume

modules/cnf-image-based-upgrade-seed-image-config.adoc Outdated
|No
|====
. Dual-stack networking is not supported in this release.
. If the seed cluster is installed in a disconnected environment, the target clusters must be installed in a disconnected environment too.
Copy link
Contributor

@abrennan89 abrennan89 Jul 22, 2024

Choose a reason for hiding this comment

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

Suggested change
. If the seed cluster is installed in a disconnected environment, the target clusters must be installed in a disconnected environment too.
. If the seed cluster is installed in a disconnected environment, the target clusters must also be installed in a disconnected environment.

Suggested wording update

@abrennan89 abrennan89 added peer-review-done Signifies that the peer review team has reviewed this PR and removed peer-review-in-progress Signifies that the peer review team is reviewing this PR labels Jul 22, 2024
Missxiaoguo
Missxiaoguo reviewed Jul 26, 2024
View reviewed changes
modules/cnf-image-based-upgrade-backup-guide.adoc Outdated
There are two local storage implementations for {sno}:

Local Storage Operator (LSO):: The {lcao} backs up and restores the required artifacts, including `LocalVolumes` and their associated `StorageClasses`. You must exclude the `persistentVolumes` resource in the application `Backup` CR.
Local Storage Operator (LSO):: The {lcao} automatically backs up and restores the required artifacts, including `localvolume` resources and their associated `StorageClass` resources. You must exclude the `persistentVolumes` resource in the application `Backup` CR.
Copy link

@Missxiaoguo Missxiaoguo Jul 26, 2024

Choose a reason for hiding this comment

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

I think we want to change persistentVolumes to persistentvolumes in the backup CR example

Suggested change
Local Storage Operator (LSO):: The {lcao} automatically backs up and restores the required artifacts, including `localvolume` resources and their associated `StorageClass` resources. You must exclude the `persistentVolumes` resource in the application `Backup` CR.
Local Storage Operator (LSO):: The {lcao} automatically backs up and restores the required artifacts, including `localvolume` resources and their associated `StorageClass` resources. You must exclude the `persistentvolumes` resource in the application `Backup` CR.

@amolnar-gh
Copy link
Contributor Author

amolnar-gh commented Aug 6, 2024

/label merge-review-needed

@openshift-ci openshift-ci bot added the merge-review-needed Signifies that the merge review team needs to review this PR label Aug 6, 2024
@skopacz1 skopacz1 added the merge-review-in-progress Signifies that the merge review team is reviewing this PR label Aug 6, 2024
@amolnar-gh amolnar-gh force-pushed the TELCODOCS-1707-post-ga-feedback branch from be51d0c to c88c0fb Compare August 6, 2024 14:34
skopacz1
skopacz1 approved these changes Aug 6, 2024
View reviewed changes
Copy link
Contributor

@skopacz1 skopacz1 left a comment

Choose a reason for hiding this comment

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

Merge review LGTM

@openshift-ci
Copy link

openshift-ci bot commented Aug 6, 2024

@amolnar-rh: 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.

@skopacz1 skopacz1 merged commit 1fd4ebb into openshift:main Aug 6, 2024
@skopacz1
Copy link
Contributor

skopacz1 commented Aug 6, 2024

/cherrypick enterprise-4.16

@skopacz1
Copy link
Contributor

skopacz1 commented Aug 6, 2024

/cherrypick enterprise-4.17

@openshift-cherrypick-robot openshift-cherrypick-robot mentioned this pull request Aug 6, 2024
Merged
@openshift-cherrypick-robot
Copy link

openshift-cherrypick-robot commented Aug 6, 2024

@skopacz1: new pull request created: #80075

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.

@openshift-cherrypick-robot openshift-cherrypick-robot mentioned this pull request Aug 6, 2024
Merged
@openshift-cherrypick-robot
Copy link

openshift-cherrypick-robot commented Aug 6, 2024

@skopacz1: new pull request created: #80076

In response to this:

/cherrypick enterprise-4.17

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.

@skopacz1 skopacz1 removed merge-review-in-progress Signifies that the merge review team is reviewing this PR merge-review-needed Signifies that the merge review team needs to review this PR labels Aug 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@abrennan89 abrennan89 abrennan89 left review comments

@skopacz1 skopacz1 skopacz1 approved these changes

+3 more reviewers

@Missxiaoguo Missxiaoguo Missxiaoguo left review comments

@ocpdocs-vale-bot ocpdocs-vale-bot ocpdocs-vale-bot left review comments

@mpmaruthu mpmaruthu mpmaruthu approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

@Missxiaoguo Missxiaoguo

Labels

branch/enterprise-4.16 branch/enterprise-4.17 jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. peer-review-done Signifies that the peer review team has reviewed this PR size/M Denotes a PR that changes 30-99 lines, ignoring generated files.

Projects

None yet

Milestone

Continuous Release

Development

Successfully merging this pull request may close these issues.

10 participants

@amolnar-gh @openshift-ci-robot @ocpdocs-previewbot @Missxiaoguo @mpmaruthu @skopacz1 @openshift-cherrypick-robot @abrennan89 @ocpdocs-vale-bot @openshift-merge-robot