doc/user/tutorials/git-arvados-guide.html.textile.liquid

   1 ---
   2 layout: default
   3 navsection: userguide
   4 title: Working with an Arvados git repository
   5 ...
   6 {% comment %}
   7 Copyright (C) The Arvados Authors. All rights reserved.
   8
   9 SPDX-License-Identifier: CC-BY-SA-3.0
  10 {% endcomment %}
  11
  12 This tutorial describes how to work with a new Arvados git repository. Working with an Arvados git repository is analogous to working with other public git repositories. It will show you how to upload custom scripts to a remote Arvados repository, so you can use it in Arvados pipelines.
  13
  14 {% include 'tutorial_expectations' %}
  15
  16 {% include 'tutorial_git_repo_expectations' %}
  17
  18 {% include 'notebox_begin' %}
  19 For more information about using Git, try
  20 <notextile>
  21 <pre><code>$ <span class="userinput">man gittutorial</span></code></pre>
  22 </notextile> or *"search Google for Git tutorials":http://google.com/#q=git+tutorial*.
  23 {% include 'notebox_end' %}
  24
  25 h2. Cloning an Arvados repository
  26
  27 Before you start using Git, you should do some basic configuration (you only need to do this the first time):
  28
  29 <notextile>
  30 <pre><code>~$ <span class="userinput">git config --global user.name "Your Name"</span>
  31 ~$ <span class="userinput">git config --global user.email $USER@example.com</span></code></pre>
  32 </notextile>
  33
  34 On the Arvados Workbench, click on the dropdown menu icon <span class="fa fa-lg fa-user"></span> <span class="caret"></span> in the upper right corner of the top navigation menu to access the user settings menu, and click on the menu item *Repositories*. In the *Repositories* page, you should see the @$USER/tutorial@ repository listed in the *name* column.  Next to *name* is the column *URL*. Copy the *URL* value associated with your repository.  This should look like <notextile><code>https://git.{{ site.arvados_api_host }}/$USER/tutorial.git</code></notextile>. Alternatively, you can use <notextile><code>git@git.{{ site.arvados_api_host }}:$USER/tutorial.git</code></notextile>
  35
  36 Next, on the Arvados virtual machine, clone your Git repository:
  37
  38 <notextile>
  39 <pre><code>~$ <span class="userinput">cd $HOME</span> # (or wherever you want to install)
  40 ~$ <span class="userinput">git clone https://git.{{ site.arvados_api_host }}/$USER/tutorial.git</span>
  41 Cloning into 'tutorial'...</code></pre>
  42 </notextile>
  43
  44 This will create a Git repository in the directory called @tutorial@ in your home directory. Say yes when prompted to continue with connection.
  45 Ignore any warning that you are cloning an empty repository.
  46
  47 *Note:* If you are prompted for username and password when you try to git clone using this command, you may first need to update your git configuration. Execute the following commands to update your git configuration.
  48
  49 <notextile>
  50 <pre>
  51 <code>~$ <span class="userinput">git config 'credential.https://git.{{ site.arvados_api_host }}/.username' none</span></code>
  52 <code>~$ <span class="userinput">git config 'credential.https://git.{{ site.arvados_api_host }}/.helper' '!cred(){ cat >/dev/null; if [ "$1" = get ]; then echo password=$ARVADOS_API_TOKEN; fi; };cred'</span></code>
  53 </pre>
  54 </notextile>
  55
  56 h2. Creating a git branch in an Arvados repository
  57
  58 Create a git branch named *tutorial_branch* in the *tutorial* Arvados git repository.
  59
  60 <notextile>
  61 <pre><code>~$ <span class="userinput">cd tutorial</span>
  62 ~/tutorial$ <span class="userinput">git checkout -b tutorial_branch</span>
  63 </code></pre>
  64 </notextile>
  65
  66 h2. Adding scripts to an Arvados repository
  67
  68 Arvados crunch scripts need to be added in a *crunch_scripts* subdirectory in the repository. If this subdirectory does not exist, first create it in the local repository and change to that directory:
  69
  70 <notextile>
  71 <pre><code>~/tutorial$ <span class="userinput">mkdir crunch_scripts</span>
  72 ~/tutorial$ <span class="userinput">cd crunch_scripts</span></code></pre>
  73 </notextile>
  74
  75 Next, using @nano@ or your favorite Unix text editor, create a new file called @hash.py@ in the @crunch_scripts@ directory.
  76
  77 notextile. <pre>~/tutorial/crunch_scripts$ <code class="userinput">nano hash.py</code></pre>
  78
  79 Add the following code to compute the MD5 hash of each file in a collection
  80
  81 <notextile> {% code 'tutorial_hash_script_py' as python %} </notextile>
  82
  83 Make the file executable:
  84
  85 notextile. <pre><code>~/tutorial/crunch_scripts$ <span class="userinput">chmod +x hash.py</span></code></pre>
  86
  87 Next, add the file to the git repository.  This tells @git@ that the file should be included on the next commit.
  88
  89 notextile. <pre><code>~/tutorial/crunch_scripts$ <span class="userinput">git add hash.py</span></code></pre>
  90
  91 Next, commit your changes.  All staged changes are recorded into the local git repository:
  92
  93 <notextile>
  94 <pre><code>~/tutorial/crunch_scripts$ <span class="userinput">git commit -m "my first script"</span>
  95 </code></pre>
  96 </notextile>
  97
  98 Finally, upload your changes to the remote repository:
  99
 100 <notextile>
 101 <pre><code>~/tutorial/crunch_scripts$ <span class="userinput">git push origin tutorial_branch</span>
 102 </code></pre>
 103 </notextile>
 104
 105 Although this tutorial shows how to add a python script to Arvados, the same steps can be used to add any of your custom bash, R, or python scripts to an Arvados repository.