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

OADP-566 Document data mover workflow

Open sbeskin-redhat opened this issue 3 years ago • 2 comments

OADP-566 Document data mover workflow

Resolves: https://issues.redhat.com/browse/OADP-566

OADP 1.1.0

Preview:

sbeskin-redhat avatar Aug 01 '22 10:08 sbeskin-redhat

@sbeskin-redhat few additional points:

  • is it mentioned anywhere else that the DataMover is a tech-preview feature? if not, we should mention it somewhere
  • please also mention that currently GCS bucket is not supported for DataMover
  • @shubham-pampattiwar, @savitharaghunathan should the docs also address ReplicationSource/ReplicationDestination?

mperetzred avatar Aug 17 '22 09:08 mperetzred

  • @shubham-pampattiwar, @savitharaghunathan should the docs also address ReplicationSource/ReplicationDestination?

@mperetzred : IMO since these CRs are created and the lifecycle is managed by the volsnap controller, I dont think we need to mention ReplicationSource/ReplicationDestination CRs in the doc. @shubham-pampattiwar @eemcmullan WDYT?

savitharaghunathan avatar Aug 17 '22 11:08 savitharaghunathan

@sbeskin-redhat added small change request, otherwise lgtm

mperetzred avatar Aug 24 '22 12:08 mperetzred

@RichardHoch Please review this PR

sbeskin-redhat avatar Aug 24 '22 15:08 sbeskin-redhat

@sbeskin-redhat A few small comments -- also try to figure out why your Travis build failed. Look at the Checks tab of the PR. If that doesn't help, ask someone on the peer review squad for assistance.

RichardHoch avatar Aug 25 '22 11:08 RichardHoch

@RichardHoch Thank you! I know why the build failed, I just haven't figured out what to do about it. It's not in my part.

sbeskin-redhat avatar Aug 25 '22 14:08 sbeskin-redhat

@RichardHoch I've made the corrections you requested. Please take a look now.

sbeskin-redhat avatar Aug 29 '22 07:08 sbeskin-redhat

@sbeskin-redhat There's one 1.1 that needs to be changed to 1.1.0, aside from that this is ready for OCP peer review. LGTM.

RichardHoch avatar Aug 29 '22 08:08 RichardHoch

This is not a full review, but a few things jump out at me in an initial pass. I recommend fixing these issues while you investigate your Travis build errors and before you reqeust a review. Please reach out if you have questions.

  • Specify the version(s) of OpenShift your PR applies to in the first comment of the PR.
  • Line breaks:
    • You need a line break between lines 27 and 28
    • Delete the extra line here and here
    • Add a line break here and here
    • Check for other instances of inconsistencies in the mark up in regards to line breaks
  • Refer to the repo guidelines on code blocks for terminal commands. In particular:
    • start CLI command blocks with a $
    • [source,terminal]
    • Use proper lead-in sentences for commands
  • You can use a tech preview snippet for you TP admonition
  • Please don't stack admonitions: ISG

michaelryanpeter avatar Aug 29 '22 18:08 michaelryanpeter

@kalexand-rh I've fixed the problem. Is there anything else?

sbeskin-redhat avatar Aug 30 '22 19:08 sbeskin-redhat

@michaelryanpeter I've made the changes you requested.

sbeskin-redhat avatar Aug 31 '22 07:08 sbeskin-redhat

Thanks for making the updates. I have added it to my queue, and will give it a full peer review today.

michaelryanpeter avatar Aug 31 '22 10:08 michaelryanpeter

@michaelryanpeter Thank you! There is some urgency to this PR as the OADP 1.1.0 GA is scheduled for tomorrow.

sbeskin-redhat avatar Aug 31 '22 15:08 sbeskin-redhat

Heard.

Reviews still take time. I assure you I am working on your PR.

michaelryanpeter avatar Aug 31 '22 16:08 michaelryanpeter

@RichardHoch, does this need to be part of the OADP release push?

kalexand-rh avatar Aug 31 '22 20:08 kalexand-rh

Friendly reminder to squash your commits if you want this merged tomorrow

michaelryanpeter avatar Aug 31 '22 20:08 michaelryanpeter

@michaelryanpeter Squashed

sbeskin-redhat avatar Aug 31 '22 21:08 sbeskin-redhat

@kalexand-rh yes, this is part of the merge push.

RichardHoch avatar Sep 01 '22 12:09 RichardHoch

Given the number of known mistakes in the CLI commands, we need QE reapproval before we can move forwrad on the merge.

michaelryanpeter avatar Sep 01 '22 16:09 michaelryanpeter

/hold

michaelryanpeter avatar Sep 01 '22 16:09 michaelryanpeter

The build looks good. There are still some typos in the oc get commands, where there is no space between -ojsonpath and no closing quotes to the end.

I will lift the hold once the PR is reapproved by QE. Every instance I could find in the docs repo for oc get ... -o jsonpath= uses single quotes instead of double quotes. Perhaps it does not matter, but with so many typos in commands, it is important to verify.

Please squash your commits.

After GA, please make a follow up PR to fix the user supplied variables that use a dash instead of an underscore.

michaelryanpeter avatar Sep 01 '22 17:09 michaelryanpeter

@michaelryanpeter I've fixed the typos and underscores and squashed the commits.

sbeskin-redhat avatar Sep 01 '22 18:09 sbeskin-redhat

@mperetzred The OCP reviewer found some errors (typos?) in commands. Please verify the corrections.

sbeskin-redhat avatar Sep 04 '22 06:09 sbeskin-redhat

@sbeskin-redhat Thanks for asking for a re-approval from QE.

I am removing the hold, since I am not on the peer review squad this week and won't be checking GitHub as regularly. I don't want to block a merge once the PR has been verified.

/unhold

michaelryanpeter avatar Sep 06 '22 14:09 michaelryanpeter

@sbeskin-redhat @michaelryanpeter could you please explain what requires QE re-approval? The thread is too long, and I can't check the changes since my last review since the commits where squashed...

mperetzred avatar Sep 13 '22 06:09 mperetzred

Here are the changes. They are all in commands:

[image: image.png]

[image: image.png]

[image: image.png]

[image: image.png]

On Tue, Sep 13, 2022 at 9:42 AM Maya Peretz @.***> wrote:

@sbeskin-redhat https://github.com/sbeskin-redhat @michaelryanpeter https://github.com/michaelryanpeter could you please explain what requires QE re-approval? The thread is too long, and I can't check the changes since my last review since the commits where squashed...

— Reply to this email directly, view it on GitHub https://github.com/openshift/openshift-docs/pull/48619#issuecomment-1244968083, or unsubscribe https://github.com/notifications/unsubscribe-auth/ATJEI5KTHAA7OGPJXVONFMLV6AO3JANCNFSM55HDXK4A . You are receiving this because you were mentioned.Message ID: @.***>

-- *Sasha Beskin (*סשה בסקין) He/His/Him Technical Writer Red Hat Migration and Modernization Solutions Red Hat http://redhat.com Israel

https://static.redhat.com/libs/redhat/brand-assets/2/corp/logo--200.png https://static.redhat.com/libs/redhat/brand-assets/2/corp/logo--200.png @.***

sbeskin-redhat avatar Sep 13 '22 14:09 sbeskin-redhat

@sbeskin-redhat I don't see what are these images. Anyway, it seems to me from @michaelryanpeter's comments that the changes are semantics/format/typos changes; these kind of issues don't require QE verification and should be as part of peer review.

mperetzred avatar Sep 14 '22 10:09 mperetzred

The typos were in the CLI commands, so they were not about semantics or formatting. That is why QE verification was requested.

For example, $ oc get route <route_name> -n <app_ns> -ojsonpath="{.spec.host} was used several times in the doc. I made a comment on what I suspect the command should be: $ oc get route <route_name> -n <app_ns> -o jsonpath="{.spec.host}". Since I am not certain that is the correct command (examples in other parts of the documentation use single quotes instead of double quotes) it seemed prudent to request re-verification.

@kalexand-rh: Looping you in for awareness.

michaelryanpeter avatar Sep 16 '22 14:09 michaelryanpeter

@mperetzred: If you would please verify that $ oc get route <route_name> -n <app_ns> -o jsonpath="{.spec.host}" is correct, I think that we can move forward.

@sbeskin-redhat: Please squash your commits when you are ready to request a merge.

michaelryanpeter avatar Sep 16 '22 14:09 michaelryanpeter

@mperetzred: If you would please verify that $ oc get route <route_name> -n <app_ns> -o jsonpath="{.spec.host}" is correct, I think that we can move forward.

Hi @michaelryanpeter I executed this command, it worked fine.

$  oc get route console -n openshift-console -o jsonpath="{.spec.host}"
console-openshift-console.apps.oadp-19420.0923-i99.qe.rhcloud.com

PrasadJoshi12 avatar Sep 23 '22 07:09 PrasadJoshi12