Story #6572

[Documentation] Install guide demonstrates how to copy a pipeline from Curoverse Cloud

Added by Brett Smith about 4 years ago. Updated about 4 years ago.

Status:
Resolved
Priority:
Normal
Assigned To:
Radhika Chippada
Category:
Documentation
Target version:
Start date:
08/05/2015
Due date:
% Done:

100%

Estimated time:
(Total: 0.00 h)
Story points:
0.5

Description

Use case: an administrator just went through the install guide, and now they have a nice, shiny new cluster. What do they do with it?

Write a new page at the end of the install guide that describes:
  • How to browse public projects on cloud.curoverse.com to find an interesting pipeline
  • How to copy the selected pipeline project to your own cluster using arv-copy

You don't need to introduce arv-copy itself. Instead, build on top of the user guide written in #5288 to describe how to copy the chosen project or pipeline template specifically.


Subtasks

Task #6910: Review branch: 6572-doc-copy-pipelineResolvedBryan Cosca


Related issues

Related to Arvados - Bug #6606: [Workbench] Provide a GUI interface to arv-copyNew07/13/2015

Related to Arvados - Bug #6873: [Documentation] Copying/Editing a public pipeline to your projectNew08/04/2015

Related to Arvados - Bug #6016: No pipeline to run with docker installNew05/13/2015

Has duplicate Arvados - Feature #6860: [Documentation] Copying a public pipeline from qr1hi to an Arvados private clusterDuplicate08/03/2015

Associated revisions

Revision 209ae806
Added by Radhika Chippada about 4 years ago

closes #6572
Merge branch '6572-doc-copy-pipeline'

History

#1 Updated by Brett Smith about 4 years ago

  • Description updated (diff)
  • Category set to Documentation

#2 Updated by Radhika Chippada about 4 years ago

  • Assigned To set to Radhika Chippada
  • Target version changed from Arvados Future Sprints to 2015-08-19 sprint

#3 Updated by Radhika Chippada about 4 years ago

I noticed an issue as I was writing this document. It is:

From IRC:

radhika
4:44 The user needs current_token to be able to use arv-copy.
We can hard code current anonymous token directly into the documentation.
Which of course is bad if we need to replace it in the future (for security purposes)
I think the user should be able to get it from Workbench. Do we want to add a “Current token” menu option to the Help dropdown when the system is being accessed by an anonymous user?
tomclegg
4:52 I don't think there's any reason not to put it right on the doc page...
4:55 [1] That's no more public than Workbench-when-not-logged-in, [2] If we change it, we can update the docs just as easily as updating the Workbench config?
4:55 I suppose we might forget to update it in the docs, though.
radhika
4:55 I am actually testing if it will work with anon token though.
4:56 I do not think the recursive copying, that requires a repository, would work anyways.
tomclegg
4:56 I wonder whether it makes sense for the API to give out the anon token in the discovery doc.
4:57 (The reason we don't make it "magical" on the API side is to make sure clients can control which token they're using, and keep the auth paths relatively simple. But I don't know if there's any reason we couldn't give one out in the discovery doc.)
4:58 Right, I just mean the SDK & arv-copy could learn how to get an anonymous token if you say --anonymous or something.
radhika
4:59 ah. that sounds good.
tomclegg
4:59 Seems much easier to put it in the docs
radhika
4:59 agree.
tomclegg
4:59 Less steps for the user.
radhika
4:59 for now i will hard code.
4:59 and test if it works or not with anon token.
tomclegg
4:59 Right. If it doesn't we should fix that. :)
5:00 ok. sounds good. thanks.

#4 Updated by Radhika Chippada about 4 years ago

  • Status changed from New to In Progress

#5 Updated by Radhika Chippada about 4 years ago

Tested arv-copy with anonymous token from qr1hi and verified that it works.

#6 Updated by Radhika Chippada about 4 years ago

  • Story points set to 0.5

#7 Updated by Bryan Cosca about 4 years ago

  • Story points deleted (0.5)

"Let's access one such public pipeline and copy to your cluster so" > "Let's access a public pipeline and copy it to your cluster, so"

"use it to create the source qr1hi.conf configuration file." > "use it to create the source qr1hi.conf and dst_cluster.conf configuration file."

I think before you say "Configure the source and destination clusters as described by the Using arv-copy tutorial", you should say something like if you have a Curoverse cloud beta account, you can follow the instructions. If you do not however, please see the "Configuring the source using anonymous access token" part of the documentation. Otherwise, they could get lost in the using arv-copy documentation without realizing they could just use the anonymous access token. Then remove the "On the other hand..." Then I might point again to the arv-copy documentation to setup the dst_cluster config.
(I realize I might make this more confusing but I think the flow is a little weird right now because you tell them to configure the source and destination clusters using the tutorial, and if they go do that without reading the entire paragraph, they will get stuck)

#8 Updated by Bryan Cosca about 4 years ago

  • Story points set to 0.5

#9 Updated by Bryan Cosca about 4 years ago

"Configure source and destination while using anonymous access token for source" -> "Configuring source and destination setup files using anonymous access token"

"Configuring using your access tokens" -> "Configuring source and destination setup files using personal access token"

#10 Updated by Radhika Chippada about 4 years ago

  • Status changed from In Progress to Resolved

Applied in changeset arvados|commit:209ae8068a9952ecf8ae20311719b25f05a3e4cb.

Also available in: Atom PDF