[ARVADOS] created: 6196d3280c04dabf2f347a55ed5d034e6bf5aa39
git at public.curoverse.com
git at public.curoverse.com
Mon Jul 13 13:12:50 EDT 2015
at 6196d3280c04dabf2f347a55ed5d034e6bf5aa39 (commit)
commit 6196d3280c04dabf2f347a55ed5d034e6bf5aa39
Author: bryan <bcosc at bcosc-VirtualBox.(none)>
Date: Mon Jul 13 13:02:58 2015 -0400
Ready for review
diff --git a/doc/user/topics/arv-copy.html.textile.liquid b/doc/user/topics/arv-copy.html.textile.liquid
index 150fc0c..8987c68 100644
--- a/doc/user/topics/arv-copy.html.textile.liquid
+++ b/doc/user/topics/arv-copy.html.textile.liquid
@@ -44,11 +44,11 @@ h3. How to copy a pipeline template or pipeline instance
{% include 'arv_copy_expectations' %}
-We will use the uuid @cluster1-p5p6p-abcd123efghi45jkl@ as an example pipeline template/instance, and @samplegitrepo/samplename.git@ as an example git repo.
+We will use the uuid @cluster1-p5p6p-abcd123efghi45jkl@ as an example pipeline template or instance, and @samplegitrepo/samplename.git@ as an example git repo.
<notextile>
<pre><code>~$ <span class="userinput">arv-copy --src cluster1 --dst cluster2 --dst-git-repo samplegitrepo/samplename cluster1-p5p6p-abcd123efghi45jkl</span>
</code></pre>
</notextile>
-New branches in the destination git repo will be created for each branch used in the pipeline template. For example, if your source branch was named branch_name, your new branch will be named git_git_cluster1_arvadosapi_com_reponame_git_branch_name.
+New branches in the destination git repo will be created for each branch used in the pipeline template. For example, if your source branch was named branch_name, your new branch will be named @git_git_cluster1_arvadosapi_com_reponame_git_branch_name at .
commit becec5efdb1a5e031f20d30393dcccf87232118d
Author: bryan <bcosc at bcosc-VirtualBox.(none)>
Date: Mon Jul 13 13:00:10 2015 -0400
changed formatting of cluster1 and cluster2
diff --git a/doc/user/topics/arv-copy.html.textile.liquid b/doc/user/topics/arv-copy.html.textile.liquid
index 8a55cc1..150fc0c 100644
--- a/doc/user/topics/arv-copy.html.textile.liquid
+++ b/doc/user/topics/arv-copy.html.textile.liquid
@@ -13,7 +13,7 @@ h2. Arv-copy
@arv-copy@ allows users to copy collections, pipeline templates, and pipeline instances, including all their dependencies from one cluster to another.
-For example, lets copy from "cluster1" to "cluster2". The names "cluster1" and "cluster2" are interchangable with any cluster name.
+For example, lets copy from *cluster1* to *cluster2*. The names *cluster1* and *cluster2* are interchangable with any cluster name.
In order for the clusters to be able to communicate with each other, you must create custom configuration files for both clusters. First, go to your Manage Account page in Workbench and copy the @ARVADOS_API_HOST@ and @ARVADOS_API_TOKEN@ in both of your clusters. Then, create two configuration files, one for each cluster. The names of the files is very important, they must match the cluster names.
@@ -30,7 +30,7 @@ h3. How to copy a collection
First, select the uuid of the collection you want to copy from the source cluster. The uuid can be found inside of a collection in the top left box, or from the URL bar (the part after @collections/...@)
-Now copy the collection from cluster1 to cluster2. We will use the uuid cluster1-4zz18-1234567890abcde as an example.
+Now copy the collection from *cluster1* to *cluster2*. We will use the uuid @cluster1-4zz18-1234567890abcde@ as an example.
<notextile>
<pre><code>~$ <span class="userinput">arv-copy --src cluster1 --dst cluster2 cluster1-4zz18-1234567890abcde</span>
cluster1-4zz18-1234567890abcde: 100M / 100M 100.0%
@@ -44,11 +44,7 @@ h3. How to copy a pipeline template or pipeline instance
{% include 'arv_copy_expectations' %}
-When copying a pipeline template or pipeline instance recursively (copying all dependencies in the template/instance) you must have a git repository in the destination cluster.
-
-If you do not have a repository created, you can follow the documentation here: (Point to #6014)
-
-We will use the uuid cluster1-p5p6p-abcd123efghi45jkl as an example pipeline template/instance, and samplegitrepo/samplename.git as an example git repo.
+We will use the uuid @cluster1-p5p6p-abcd123efghi45jkl@ as an example pipeline template/instance, and @samplegitrepo/samplename.git@ as an example git repo.
<notextile>
<pre><code>~$ <span class="userinput">arv-copy --src cluster1 --dst cluster2 --dst-git-repo samplegitrepo/samplename cluster1-p5p6p-abcd123efghi45jkl</span>
commit 0581bd67385a585beb2d6ee5392ce7cf9d526873
Author: bryan <bcosc at bcosc-VirtualBox.(none)>
Date: Mon Jul 13 12:56:40 2015 -0400
changed arv-copy expectations and moved around words in the html file
diff --git a/doc/user/topics/arv-copy.html.textile.liquid b/doc/user/topics/arv-copy.html.textile.liquid
index 5a6b3d5..8a55cc1 100644
--- a/doc/user/topics/arv-copy.html.textile.liquid
+++ b/doc/user/topics/arv-copy.html.textile.liquid
@@ -1,7 +1,7 @@
---
layout: default
navsection: userguide
-title: "Using arv-copy"
+title: "Using Arv-copy"
...
@@ -15,7 +15,7 @@ h2. Arv-copy
For example, lets copy from "cluster1" to "cluster2". The names "cluster1" and "cluster2" are interchangable with any cluster name.
-First, you must custom configuration files for both clusters. Go to your Manage Account page in Workbench and copy the @ARVADOS_API_HOST@ and @ARVADOS_API_TOKEN@ in both of your clusters. Then, create two configuration files, one for each cluster. The names of the files is very important, they must match the cluster names.
+In order for the clusters to be able to communicate with each other, you must create custom configuration files for both clusters. First, go to your Manage Account page in Workbench and copy the @ARVADOS_API_HOST@ and @ARVADOS_API_TOKEN@ in both of your clusters. Then, create two configuration files, one for each cluster. The names of the files is very important, they must match the cluster names.
<notextile>
<pre><code>~$ <span class="userinput">cd ~/.config/arvados</span>
@@ -26,13 +26,9 @@ First, you must custom configuration files for both clusters. Go to your Manage
</code></pre>
</notextile>
-Once you have your config files ready, you can start copying!
-
-Here are some examples:
-
h3. How to copy a collection
-First, copy the uuid of the collection you want to copy from the cluster you want to copy from. The uuid can be found inside of a collection in the top left box, or from the URL bar (the part after @collections/...@)
+First, select the uuid of the collection you want to copy from the source cluster. The uuid can be found inside of a collection in the top left box, or from the URL bar (the part after @collections/...@)
Now copy the collection from cluster1 to cluster2. We will use the uuid cluster1-4zz18-1234567890abcde as an example.
<notextile>
@@ -52,7 +48,7 @@ When copying a pipeline template or pipeline instance recursively (copying all d
If you do not have a repository created, you can follow the documentation here: (Point to #6014)
-Once you have your repository created, you can copy your pipeline template/instance. We will use the uuid cluster1-p5p6p-abcd123efghi45jkl as an example, and samplegitrepo/samplename.git as an example git repo.
+We will use the uuid cluster1-p5p6p-abcd123efghi45jkl as an example pipeline template/instance, and samplegitrepo/samplename.git as an example git repo.
<notextile>
<pre><code>~$ <span class="userinput">arv-copy --src cluster1 --dst cluster2 --dst-git-repo samplegitrepo/samplename cluster1-p5p6p-abcd123efghi45jkl</span>
commit e3ab22d08738c5aedb3e021e47959c1548f62ead
Author: bryan <bcosc at bcosc-VirtualBox.(none)>
Date: Mon Jul 13 12:47:12 2015 -0400
changed formatting and added words
diff --git a/doc/user/topics/arv-copy.html.textile.liquid b/doc/user/topics/arv-copy.html.textile.liquid
index ae72df8..5a6b3d5 100644
--- a/doc/user/topics/arv-copy.html.textile.liquid
+++ b/doc/user/topics/arv-copy.html.textile.liquid
@@ -1,7 +1,7 @@
---
layout: default
navsection: userguide
-title: "How arv-copy works"
+title: "Using arv-copy"
...
@@ -9,27 +9,23 @@ This tutorial describes how to copy Arvados objects from one cluster to another
{% include 'tutorial_expectations' %}
-Also note that they must work from a machine with an SSH key that is allowed to access both clusters (required to copy git repositories).
-
h2. Arv-copy
@arv-copy@ allows users to copy collections, pipeline templates, and pipeline instances, including all their dependencies from one cluster to another.
-Suppose we want to copy from one cloud cluster to another. For example cluster "one" to cluster "two". The names "one" and "two" are interchangable with any cluster name.
+For example, lets copy from "cluster1" to "cluster2". The names "cluster1" and "cluster2" are interchangable with any cluster name.
-First we have to make configuration files for both clusters.
+First, you must custom configuration files for both clusters. Go to your Manage Account page in Workbench and copy the @ARVADOS_API_HOST@ and @ARVADOS_API_TOKEN@ in both of your clusters. Then, create two configuration files, one for each cluster. The names of the files is very important, they must match the cluster names.
<notextile>
<pre><code>~$ <span class="userinput">cd ~/.config/arvados</span>
-~$ <span class="userinput">echo "ARVADOS_API_HOST=one.arvadosapi.com" >> one.conf</span>
-~$ <span class="userinput">echo "ARVADOS_API_TOKEN=123456789abcdefghijkl" >> one.conf</span>
-~$ <span class="userinput">echo "ARVADOS_API_HOST=two.arvadosapi.com" >> two.conf</span>
-~$ <span class="userinput">echo "ARVADOS_API_TOKEN=987654321lkjihgfedcba" >> two.conf</span>
+~$ <span class="userinput">echo "ARVADOS_API_HOST=cluster1.arvadosapi.com" >> cluster1.conf</span>
+~$ <span class="userinput">echo "ARVADOS_API_TOKEN=123456789abcdefghijkl" >> cluster1.conf</span>
+~$ <span class="userinput">echo "ARVADOS_API_HOST=cluster2.arvadosapi.com" >> cluster2.conf</span>
+~$ <span class="userinput">echo "ARVADOS_API_TOKEN=987654321lkjihgfedcba" >> cluster2.conf</span>
</code></pre>
</notextile>
-Your ARVADOS_API_TOKEN can be found in the manage accounts page in Workbench under Current Token.
-
Once you have your config files ready, you can start copying!
Here are some examples:
@@ -38,34 +34,29 @@ h3. How to copy a collection
First, copy the uuid of the collection you want to copy from the cluster you want to copy from. The uuid can be found inside of a collection in the top left box, or from the URL bar (the part after @collections/...@)
-Now copy the collection from cluster one to cluster two. We will use the uuid one-4zz18-1234567890abcde as an example.
-<notextile>
-<pre><code>~$ <span class="userinput">arv-copy --src one --dst two one-4zz18-1234567890abcde</span>
-</code></pre>
-</notextile>
-
-The output should be like this:
-
+Now copy the collection from cluster1 to cluster2. We will use the uuid cluster1-4zz18-1234567890abcde as an example.
<notextile>
-<pre><code>
-one-4zz18-1234567890abcde: 100M / 100M 100.0%
-arvados.arv-copy[1234] INFO: Success: created copy with uuid two-4zz18-8765943210cdbae
+<pre><code>~$ <span class="userinput">arv-copy --src cluster1 --dst cluster2 cluster1-4zz18-1234567890abcde</span>
+cluster1-4zz18-1234567890abcde: 100M / 100M 100.0%
+arvados.arv-copy[1234] INFO: Success: created copy with uuid cluster2-4zz18-8765943210cdbae
</code></pre>
</notextile>
-The collection will be placed in your home project in the destination cluster. If you want to place your collection inside of a pre-created project, you can specify the project you want it to be in using the tag @--project-uuid@
+The collection will be placed in your home project in the destination cluster. If you want to place your collection inside of a pre-created project, you can specify the project you want it to be in using the tag @--project-uuid@ followed by the project uuid.
h3. How to copy a pipeline template or pipeline instance
+{% include 'arv_copy_expectations' %}
+
When copying a pipeline template or pipeline instance recursively (copying all dependencies in the template/instance) you must have a git repository in the destination cluster.
If you do not have a repository created, you can follow the documentation here: (Point to #6014)
-Once you have your repository created, you can copy your pipeline template/instance. We will use the uuid one-p5p6p-abcd123efghi45jkl as an example, and samplegitrepo/samplename.git as an example git repo.
+Once you have your repository created, you can copy your pipeline template/instance. We will use the uuid cluster1-p5p6p-abcd123efghi45jkl as an example, and samplegitrepo/samplename.git as an example git repo.
<notextile>
-<pre><code>~$ <span class="userinput">arv-copy --src one --dst two --dst-git-repo samplegitrepo/samplename.git one-p5p6p-abcd123efghi45jkl</span>
+<pre><code>~$ <span class="userinput">arv-copy --src cluster1 --dst cluster2 --dst-git-repo samplegitrepo/samplename cluster1-p5p6p-abcd123efghi45jkl</span>
</code></pre>
</notextile>
-New branches in the destination git repo will be created for each branch used in the pipeline template. For example, if your source branch was named branch_name, your new branch will be named git_git_one_arvadosapi_com_reponame_git_branch_name.
+New branches in the destination git repo will be created for each branch used in the pipeline template. For example, if your source branch was named branch_name, your new branch will be named git_git_cluster1_arvadosapi_com_reponame_git_branch_name.
commit 5b311db10a1f745d2b7018f4fd1ce462550f1bc6
Author: bryan <bcosc at bcosc-VirtualBox.(none)>
Date: Mon Jul 13 11:41:12 2015 -0400
Added documentation for copying collections and pipeline templates and instances
diff --git a/doc/user/topics/arv-copy.html.textile.liquid b/doc/user/topics/arv-copy.html.textile.liquid
index 815225b..ae72df8 100644
--- a/doc/user/topics/arv-copy.html.textile.liquid
+++ b/doc/user/topics/arv-copy.html.textile.liquid
@@ -1,8 +1,71 @@
---
layout: default
navsection: userguide
-title: "Using arv-copy with Arvados"
+title: "How arv-copy works"
...
-woo
+This tutorial describes how to copy Arvados objects from one cluster to another by using @arv-copy at .
+
+{% include 'tutorial_expectations' %}
+
+Also note that they must work from a machine with an SSH key that is allowed to access both clusters (required to copy git repositories).
+
+h2. Arv-copy
+
+ at arv-copy@ allows users to copy collections, pipeline templates, and pipeline instances, including all their dependencies from one cluster to another.
+
+Suppose we want to copy from one cloud cluster to another. For example cluster "one" to cluster "two". The names "one" and "two" are interchangable with any cluster name.
+
+First we have to make configuration files for both clusters.
+
+<notextile>
+<pre><code>~$ <span class="userinput">cd ~/.config/arvados</span>
+~$ <span class="userinput">echo "ARVADOS_API_HOST=one.arvadosapi.com" >> one.conf</span>
+~$ <span class="userinput">echo "ARVADOS_API_TOKEN=123456789abcdefghijkl" >> one.conf</span>
+~$ <span class="userinput">echo "ARVADOS_API_HOST=two.arvadosapi.com" >> two.conf</span>
+~$ <span class="userinput">echo "ARVADOS_API_TOKEN=987654321lkjihgfedcba" >> two.conf</span>
+</code></pre>
+</notextile>
+
+Your ARVADOS_API_TOKEN can be found in the manage accounts page in Workbench under Current Token.
+
+Once you have your config files ready, you can start copying!
+
+Here are some examples:
+
+h3. How to copy a collection
+
+First, copy the uuid of the collection you want to copy from the cluster you want to copy from. The uuid can be found inside of a collection in the top left box, or from the URL bar (the part after @collections/...@)
+
+Now copy the collection from cluster one to cluster two. We will use the uuid one-4zz18-1234567890abcde as an example.
+<notextile>
+<pre><code>~$ <span class="userinput">arv-copy --src one --dst two one-4zz18-1234567890abcde</span>
+</code></pre>
+</notextile>
+
+The output should be like this:
+
+<notextile>
+<pre><code>
+one-4zz18-1234567890abcde: 100M / 100M 100.0%
+arvados.arv-copy[1234] INFO: Success: created copy with uuid two-4zz18-8765943210cdbae
+</code></pre>
+</notextile>
+
+The collection will be placed in your home project in the destination cluster. If you want to place your collection inside of a pre-created project, you can specify the project you want it to be in using the tag @--project-uuid@
+
+h3. How to copy a pipeline template or pipeline instance
+
+When copying a pipeline template or pipeline instance recursively (copying all dependencies in the template/instance) you must have a git repository in the destination cluster.
+
+If you do not have a repository created, you can follow the documentation here: (Point to #6014)
+
+Once you have your repository created, you can copy your pipeline template/instance. We will use the uuid one-p5p6p-abcd123efghi45jkl as an example, and samplegitrepo/samplename.git as an example git repo.
+
+<notextile>
+<pre><code>~$ <span class="userinput">arv-copy --src one --dst two --dst-git-repo samplegitrepo/samplename.git one-p5p6p-abcd123efghi45jkl</span>
+</code></pre>
+</notextile>
+
+New branches in the destination git repo will be created for each branch used in the pipeline template. For example, if your source branch was named branch_name, your new branch will be named git_git_one_arvadosapi_com_reponame_git_branch_name.
commit 6e3e3c5c11a673f2347876368993da9a3715d8f3
Author: bryan <bcosc at bcosc-VirtualBox.(none)>
Date: Fri Jul 10 15:43:48 2015 -0400
Change _config.yaml to point to arv-copy.html.textile.liquid
diff --git a/doc/_config.yml b/doc/_config.yml
index 48a6a01..2430c96 100644
--- a/doc/_config.yml
+++ b/doc/_config.yml
@@ -41,6 +41,7 @@ navbar:
- user/tutorials/tutorial-keep-get.html.textile.liquid
- user/tutorials/tutorial-keep-mount.html.textile.liquid
- user/topics/keep.html.textile.liquid
+ - user/topics/arv-copy.html.textile.liquid
- Run a pipeline on the command line:
- user/topics/running-pipeline-command-line.html.textile.liquid
- user/topics/arv-run.html.textile.liquid
diff --git a/doc/user/topics/arv-copy.html.textile.liquid b/doc/user/topics/arv-copy.html.textile.liquid
new file mode 100644
index 0000000..815225b
--- /dev/null
+++ b/doc/user/topics/arv-copy.html.textile.liquid
@@ -0,0 +1,8 @@
+---
+layout: default
+navsection: userguide
+title: "Using arv-copy with Arvados"
+...
+
+
+woo
-----------------------------------------------------------------------
hooks/post-receive
--
More information about the arvados-commits
mailing list