doc/user/tutorials/tutorial-submit-job.html.textile.liquid

   1 ---
   2 layout: default
   3 navsection: userguide
   4 navmenu: Tutorials
   5 title: "Running on an Arvados cluster"
   6 ...
   7 {% comment %}
   8 Copyright (C) The Arvados Authors. All rights reserved.
   9
  10 SPDX-License-Identifier: CC-BY-SA-3.0
  11 {% endcomment %}
  12
  13 {% include 'pipeline_deprecation_notice' %}
  14
  15 This tutorial demonstrates how to create a pipeline to run your crunch script on an Arvados cluster.  Cluster jobs can scale out to multiple nodes, and use @git@ and @docker@ to store the complete system snapshot required to achieve reproducibilty.
  16
  17 {% include 'tutorial_expectations' %}
  18
  19 This tutorial uses @$USER@ to denote your username.  Replace @$USER@ with your user name in all the following examples.
  20
  21 Also, this tutorial uses the @tutorial@ arvados repository created in "Adding a new arvados repository":add-new-repository.html as the example repository.
  22
  23 h2. Clone Arvados repository
  24
  25 Please clone the *tutorial* repository using the instructions from "Working with Arvados git repository":git-arvados-guide.html, if you have not yet cloned already.
  26
  27 h2. Creating a Crunch script
  28
  29 Start by entering the @tutorial@ directory created by @git clone@. Next, create a subdirectory called @crunch_scripts@ and change to that directory:
  30
  31 <notextile>
  32 <pre><code>>~$ <span class="userinput">cd tutorial</span>
  33 ~/tutorial$ <span class="userinput">mkdir crunch_scripts</span>
  34 ~/tutorial$ <span class="userinput">cd crunch_scripts</span></code></pre>
  35 </notextile>
  36
  37 Next, using @nano@ or your favorite Unix text editor, create a new file called @hash.py@ in the @crunch_scripts@ directory.
  38
  39 notextile. <pre>~/tutorial/crunch_scripts$ <code class="userinput">nano hash.py</code></pre>
  40
  41 Add the following code to compute the MD5 hash of each file in a collection (if you already completed "Writing a Crunch script":tutorial-firstscript.html you can just copy the @hash.py@ file you created previously.)
  42
  43 <notextile> {% code 'tutorial_hash_script_py' as python %} </notextile>
  44
  45 Make the file executable:
  46
  47 notextile. <pre><code>~/tutorial/crunch_scripts$ <span class="userinput">chmod +x hash.py</span></code></pre>
  48
  49 Next, add the file to the staging area.  This tells @git@ that the file should be included on the next commit.
  50
  51 notextile. <pre><code>~/tutorial/crunch_scripts$ <span class="userinput">git add hash.py</span></code></pre>
  52
  53 Next, commit your changes.  All staged changes are recorded into the local git repository:
  54
  55 <notextile>
  56 <pre><code>~/tutorial/crunch_scripts$ <span class="userinput">git commit -m "my first script"</span>
  57 [master (root-commit) 27fd88b] my first script
  58  1 file changed, 45 insertions(+)
  59  create mode 100755 crunch_scripts/hash.py</code></pre>
  60 </notextile>
  61
  62 Finally, upload your changes to the Arvados server:
  63
  64 <notextile>
  65 <pre><code>~/tutorial/crunch_scripts$ <span class="userinput">git push origin master</span>
  66 Counting objects: 4, done.
  67 Compressing objects: 100% (2/2), done.
  68 Writing objects: 100% (4/4), 682 bytes, done.
  69 Total 4 (delta 0), reused 0 (delta 0)
  70 To git@git.qr1hi.arvadosapi.com:$USER/tutorial.git
  71  * [new branch]      master -> master</code></pre>
  72 </notextile>
  73
  74 h2. Create a pipeline template
  75
  76 Next, create a new template using @arv create pipeline_template@:
  77
  78 <notextile>
  79 <pre><code>~$ <span class="userinput">arv create pipeline_template</span></code></pre>
  80 </notextile>
  81
  82 In the editor, enter the following template:
  83
  84 <notextile> {% code 'tutorial_submit_job' as javascript %} </notextile>
  85
  86 * @"repository"@ is the name of a git repository to search for the script version.  You can access a list of available git repositories on the Arvados Workbench in the *Repositories* page using the <span class="fa fa-lg fa-user"></span> <span class="caret"></span> top navigation menu icon.
  87 * @"script_version"@ specifies the version of the script that you wish to run.  This can be in the form of an explicit Git revision hash, a tag, or a branch (in which case it will use the HEAD of the specified branch).  Arvados logs the script version that was used in the run, enabling you to go back and re-run any past job with the guarantee that the exact same code will be used as was used in the previous run.
  88 * @"script"@ specifies the filename of the script to run.  Crunch expects to find this in the @crunch_scripts/@ subdirectory of the Git repository.
  89 * @"runtime_constraints"@ describes the runtime environment required to run the job.  These are described in the "job record schema":{{site.baseurl}}/api/methods/jobs.html
  90
  91 h2. Running your pipeline
  92
  93 Your new pipeline template should appear at the top of the Workbench "pipeline&nbsp;templates":{{site.arvados_workbench_host}}/pipeline_templates page.  You can run your pipeline "using Workbench":tutorial-workflow-workbench.html or the "command line.":{{site.baseurl}}/user/topics/running-pipeline-command-line.html
  94
  95 For more information and examples for writing pipelines, see the "pipeline template reference":{{site.baseurl}}/api/methods/pipeline_templates.html