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

OSDOCS#8067: Add the Backup and restore topic map from OCP to ROSA

Open tmalove opened this issue 1 year ago • 18 comments
trafficstars

**This PR ports OCP content to ROSA. Most of the changes are the conditioning of links or paragraphs.

Version(s): 4.15+

Issue: OSDOCS-8067

Link to docs preview:

  • https://68901--ocpdocs-pr.netlify.app/openshift-rosa/latest/backup_and_restore/ (Updated 03/22/2024)

QE review:

  • [ ] QE has approved this change.

Additional information: This PR is a part of the OCP content porting to ROSA docs.

tmalove avatar Dec 04 '23 21:12 tmalove

🤖 Wed Jul 24 17:50:35 - Prow CI generated the docs preview:

https://68901--ocpdocs-pr.netlify.app/openshift-dedicated/latest/backup_and_restore/control_plane_backup_and_restore/backing-up-etcd.html https://68901--ocpdocs-pr.netlify.app/openshift-dedicated/latest/backup_and_restore/install-oadp-rosa-sts.html https://68901--ocpdocs-pr.netlify.app/openshift-enterprise/latest/backup_and_restore/application_backup_and_restore/backing_up_and_restoring/backing-up-applications.html https://68901--ocpdocs-pr.netlify.app/openshift-enterprise/latest/backup_and_restore/application_backup_and_restore/installing/about-installing-oadp.html https://68901--ocpdocs-pr.netlify.app/openshift-enterprise/latest/backup_and_restore/control_plane_backup_and_restore/backing-up-etcd.html https://68901--ocpdocs-pr.netlify.app/openshift-enterprise/latest/backup_and_restore/graceful-cluster-restart.html https://68901--ocpdocs-pr.netlify.app/openshift-rosa/latest/backup_and_restore/control_plane_backup_and_restore/backing-up-etcd.html https://68901--ocpdocs-pr.netlify.app/openshift-rosa/latest/backup_and_restore/install-oadp-rosa-sts.html https://68901--ocpdocs-pr.netlify.app/openshift-rosa/latest/welcome/about-hcp.html

ocpdocs-previewbot avatar Dec 05 '23 20:12 ocpdocs-previewbot

@xiaojiey Will you have someone from QE assigned to review this PR? Thanks!

tmalove avatar Dec 15 '23 16:12 tmalove

@amastbau @PrasadJoshi12 should be right person. Could you please take a look? Thanks.

xiaojiey avatar Dec 18 '23 05:12 xiaojiey

PR LGTM

@tmalove There are some features such as FSB and DataMover which are not supported in case of ROSA. Shall we open a Jira card for adding not supported warnings under that sections ?

Now we will have two different sections in ROSA doc. This might need a fix, what do you think ? https://68901--ocpdocs-pr.netlify.app/openshift-rosa/latest/welcome/ Backing up and restoring application Backup and Restore

PrasadJoshi12 avatar Dec 18 '23 05:12 PrasadJoshi12

PR LGTM

@tmalove There are some features such as FSB and DataMover which are not supported in case of ROSA. Shall we open a Jira card for adding not supported warnings under that sections ?

Now we will have two different sections in ROSA doc. This might need a fix, what do you think ? 68901--ocpdocs-pr.netlify.app/openshift-rosa/latest/welcome Backing up and restoring application Backup and Restore

Thanks for your input @PrasadJoshi12 , For the 2 features (FSB and DataMover), I agree that you should open a ticket for consideration of adding this to the B&R section after discussion and testing. There might be a reason why they shouldn't be included, but we'll have to wait for that decision. In the meantime, I will remove the references to these features because they are not supported now. As for the 2 sections, I asked about this too and while the newly ported content is more inclusive, the existing Backing up and restoring application section has some ROSA-specific information that needs to remain in the docs. We will see about incorporating the sections.

tmalove avatar Jan 03 '24 18:01 tmalove

PR LGTM @tmalove There are some features such as FSB and DataMover which are not supported in case of ROSA. Shall we open a Jira card for adding not supported warnings under that sections ? Now we will have two different sections in ROSA doc. This might need a fix, what do you think ? 68901--ocpdocs-pr.netlify.app/openshift-rosa/latest/welcome Backing up and restoring application Backup and Restore

Thanks for your input @PrasadJoshi12 , For the 2 features (FSB and DataMover), I agree that you should open a ticket for consideration of adding this to the B&R section after discussion and testing. There might be a reason why they shouldn't be included, but we'll have to wait for that decision. In the meantime, I will remove the references to these features because they are not supported now. As for the 2 sections, I asked about this too and while the newly ported content is more inclusive, the existing Backing up and restoring application section has some ROSA-specific information that needs to remain in the docs. We will see about incorporating the sections.

@PrasadJoshi12 After talking with the docs team, I will incorporate the existing 'Backing up and restoring application' section into the proposed section. Stay tuned for a preview. Thanks.

tmalove avatar Jan 15 '24 19:01 tmalove

/retest

tmalove avatar Jan 15 '24 19:01 tmalove

/retest

tmalove avatar Jan 18 '24 14:01 tmalove

/test validate-asciidoc

tmalove avatar Jan 18 '24 15:01 tmalove

/retest

tmalove avatar Jan 18 '24 17:01 tmalove

/test validate-asciidoc

tmalove avatar Jan 18 '24 17:01 tmalove

@PrasadJoshi12 I removed the content for 'Data Mover'. If or when the team decides that it is supported in ROSA, we can easily add it to the docs page. Thanks!

@arendej For your review

tmalove avatar Jan 30 '24 01:01 tmalove

/retest

tmalove avatar Jan 30 '24 01:01 tmalove

/retest

tmalove avatar Jan 30 '24 01:01 tmalove

/retest

tmalove avatar Jan 30 '24 17:01 tmalove

@tmalove Overview sections links are not working, can you please take a look ?

Screenshot from 2024-02-19 11-24-30

PrasadJoshi12 avatar Feb 19 '24 05:02 PrasadJoshi12

For your review: @arendej @bchandra-ocp @PrasadJoshi12 cc: @karanthshashank @AndrewJones-RH

Thanks for your review @PrasadJoshi12 !

tmalove avatar Mar 22 '24 15:03 tmalove

QE ack received. Request review from Dev: @arendej @bchandra-ocp cc: @AndrewJones-RH @karanthshashank Thanks!

tmalove avatar Mar 27 '24 13:03 tmalove

/retest

tmalove avatar Apr 02 '24 20:04 tmalove

/retest

tmalove avatar Apr 29 '24 22:04 tmalove

Hi, your review is requested for this 'Back up and restore section'. For the first preview link, the 'Back up and restore' link in the table is not active for now, everything else is ready. @arendej @bchandra-ocp cc: @AndrewJones-RH @karanthshashank

@PrasadJoshi12 You approved this PR in March, but want to add you for your information.

Thanks!

tmalove avatar May 07 '24 16:05 tmalove

/retest

tmalove avatar May 23 '24 17:05 tmalove

/retest-required

tmalove avatar May 23 '24 19:05 tmalove

@rh-wadhwani the request for SRE is to verify that the content in the preview link (in the top section) is valid for ROSA. The procedures do not have to be verified because QE has already given an ack.

tmalove avatar May 28 '24 04:05 tmalove

/retest

tmalove avatar Jun 06 '24 18:06 tmalove

PR needs rebase.

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-merge-robot avatar Dec 04 '24 21:12 openshift-merge-robot

@tmalove: The following tests failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name Commit Details Required Rerun command
ci/prow/validate-asciidoc 14b0443da92526dcc25694fdac06810f96fb97fa link true /test validate-asciidoc
ci/prow/validate-portal 14b0443da92526dcc25694fdac06810f96fb97fa link true /test validate-portal

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 Dec 04 '24 21:12 openshift-ci[bot]

The update for the topic map has been completed in another PR.

tmalove avatar Jan 22 '25 19:01 tmalove