Bug 1674505 - Document known issue with trailing slash in virtctl upload --uploadproxy-url parameter
Summary: Document known issue with trailing slash in virtctl upload --uploadproxy-url ...
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Product: Container Native Virtualization (CNV)
Classification: Red Hat
Component: Documentation
Version: 1.4
Hardware: Unspecified
OS: Unspecified
unspecified
high
Target Milestone: ---
: 1.4
Assignee: Pan Ousley
QA Contact: Irina Gulina
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2019-02-11 13:51 UTC by Adam Litke
Modified: 2019-02-28 16:44 UTC (History)
2 users (show)

Fixed In Version: 1.4
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2019-02-28 16:44:57 UTC
Target Upstream Version:
Embargoed:


Attachments (Terms of Use)

Description Adam Litke 2019-02-11 13:51:12 UTC
Document URL: 

Section Number and Name: 

Describe the issue: 

When specifying the --uploadproxy-url parameter in virtctl upload, if the user adds a trailing slash to the value the operation will fail.  We should document this with a note to the user reminding them to not use a trailing slash.


Suggestions for improvement: Add note as described above

Additional information:

Comment 1 Adam Litke 2019-02-11 13:52:58 UTC
See https://bugzilla.redhat.com/show_bug.cgi?id=1660888 for the original bug.

Comment 2 Pan Ousley 2019-02-12 20:44:14 UTC
Hey Adam, this is the way we have virtctl image-upload documented now:

$ virtctl image-upload --uploadproxy-url=https://$(oc get route cdi-uploadproxy-route -o=jsonpath='{.status.ingress[0].host}') --pvc-name=upload-fedora-pvc --pvc-size=10Gi --image-path=/images/fedora28.qcow2

Do you expect that users will replace the --uploadproxy-url parameter value with a different URL? If not, I don't see how a user would run across the trailing slash issue.

If you expect that some of the time, users will add their own URL, then I can definitely add a Known Issue to the Release Notes (or a note in the procedure itself). Just want to make sure before doing so.

Comment 3 Adam Litke 2019-02-12 21:46:51 UTC
In some situations a user may enter their own URL (hopefully rarely) so I think a Known Issue would still be appropriate.

Comment 4 Pan Ousley 2019-02-12 23:12:46 UTC
I wrote something up: http://file.bos.redhat.com/pousley/021219/knownissues/cnv_release_notes/cnv_release_notes.html

Let me know what you think - thanks!

Comment 5 Adam Litke 2019-02-20 21:03:03 UTC
Looks great!

Comment 6 Pan Ousley 2019-02-20 21:12:08 UTC
Thanks, Adam! Moving to ON_QA.

QE: note that the preview link in comment #4 doesn't include all the Release Notes (it's from Feb 12). Each BZ will likely have a different link.

Comment 7 Irina Gulina 2019-02-21 09:27:36 UTC
Looks good, thanks.

Comment 8 Pan Ousley 2019-02-28 16:44:57 UTC
The requested changes were published in the CNV 1.4 Release Notes: https://docs.openshift.com/container-platform/3.11/cnv_release_notes/cnv_release_notes.html#RN_known_issues


Note You need to log in before you can comment on or make changes to this bug.